ZcashShieldedService

SIP Protocol API Reference v0.7.0

---

SIP Protocol API Reference / ZcashShieldedService

Class: ZcashShieldedService

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5334

Zcash Shielded Transaction Service

Provides high-level operations for Zcash shielded transactions with SIP Protocol integration.

Constructors

Constructor

new ZcashShieldedService(config): ZcashShieldedService

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5340

Parameters

config

ZcashShieldedServiceConfig

Returns

ZcashShieldedService

Accessors

rpcClient

Get Signature

get rpcClient(): ZcashRPCClient

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5495

Get underlying RPC client for advanced operations

Returns

ZcashRPCClient

---

currentAccount

Get Signature

get currentAccount(): number

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5499

Get current account number

Returns

number

Methods

initialize()

initialize(): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5346

Initialize the service

Creates an account if needed and retrieves the default address.

Returns

Promise<void>

---

getAddress()

getAddress(): string

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5354

Get the default shielded address

Returns

string

---

generateNewAddress()

generateNewAddress(): Promise<string>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5360

Generate a new diversified address for the account

Each address is unlinkable but controlled by the same account.

Returns

Promise<string>

---

validateAddress()

validateAddress(address): Promise<ZcashAddressInfo>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5364

Validate an address

Parameters

address

string

Returns

Promise<ZcashAddressInfo>

---

isShieldedAddress()

isShieldedAddress(address): Promise<boolean>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5368

Check if an address is a shielded address

Parameters

address

string

Returns

Promise<boolean>

---

getBalance()

getBalance(minConf?): Promise<ShieldedBalance>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5372

Get shielded balance summary

Parameters

minConf?

number

Returns

Promise<ShieldedBalance>

---

sendShielded()

sendShielded(params): Promise<ShieldedSendResult>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5379

Send a shielded transaction

Parameters

params

ShieldedSendParams

Send parameters

Returns

Promise<ShieldedSendResult>

Send result with txid

---

sendWithPrivacy()

sendWithPrivacy(to, amount, privacyLevel, memo?): Promise<ShieldedSendResult>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5385

Send shielded transaction with SIP integration

Higher-level method that handles privacy level mapping.

Parameters

to

string

amount

number

privacyLevel

PrivacyLevel

memo?

string

Returns

Promise<ShieldedSendResult>

---

getReceivedNotes()

getReceivedNotes(minConf?, onlySpendable?): Promise<ReceivedNote[]>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5392

Get received notes (incoming shielded transactions)

Parameters

minConf?

number

Minimum confirmations

onlySpendable?

boolean

Only return spendable notes

Returns

Promise<ReceivedNote[]>

---

getPendingNotes()

getPendingNotes(): Promise<ReceivedNote[]>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5396

Get pending (unconfirmed) incoming transactions

Returns

Promise<ReceivedNote[]>

---

waitForNote()

waitForNote(predicate, timeout?, pollInterval?): Promise<ReceivedNote>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5404

Wait for incoming note with specific criteria

Parameters

predicate

(note) => boolean

Function to match the expected note

timeout?

number

Timeout in ms

pollInterval?

number

Poll interval in ms

Returns

Promise<ReceivedNote>

---

exportViewingKey()

exportViewingKey(address?): Promise<ExportedViewingKey>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5411

Export viewing key for an address

The viewing key allows monitoring incoming transactions without spending capability.

Parameters

address?

string

Returns

Promise<ExportedViewingKey>

---

importViewingKey()

importViewingKey(viewingKey, rescan?, startHeight?): Promise<void>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5417

Import viewing key for monitoring

Allows monitoring transactions to an address without spending.

Parameters

viewingKey

string

rescan?

"yes" | "no" | "whenkeyisnew"

startHeight?

number

Returns

Promise<void>

---

exportForCompliance()

exportForCompliance(): Promise<{ viewingKey: ExportedViewingKey; privacyLevel: PrivacyLevel; disclaimer: string; }>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5423

Export viewing key for compliance/audit

Specifically for SIP COMPLIANT privacy level.

Returns

Promise<{ viewingKey: ExportedViewingKey; privacyLevel: PrivacyLevel; disclaimer: string; }>

---

getOperationStatus()

getOperationStatus(operationId): Promise<ZcashOperation | null>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5431

Get status of an operation

Parameters

operationId

string

Returns

Promise<ZcashOperation | null>

---

listPendingOperations()

listPendingOperations(): Promise<ZcashOperation[]>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5435

List all pending operations

Returns

Promise<ZcashOperation[]>

---

getBlockHeight()

getBlockHeight(): Promise<number>

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5439

Get current block height

Returns

Promise<number>

---

isTestnet()

isTestnet(): boolean

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5443

Check if connected to testnet

Returns

boolean

---

estimateFee()

estimateFee(recipients?, inputs?): number

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5476

Estimate transaction fee based on ZIP-317 conventional fee

The ZIP-317 fee is calculated as: fee = marginal_fee * max(grace_actions, logical_actions)

For shielded transactions:

• Each Sapling spend = 1 logical action
• Each Sapling output = 1 logical action
• Each Orchard action = 1 logical action (covers both spend and output)

Parameters

recipients?

number

Number of recipients (outputs)

inputs?

number

Estimated number of input notes (default: 1)

Returns

number

Estimated fee in ZEC

Example

// Estimate fee for 1 recipient
const fee = service.estimateFee(1)

// Estimate fee for 3 recipients with 2 input notes
const fee = service.estimateFee(3, 2)

---

getMinimumFee()

getMinimumFee(): number

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:5482

Get minimum fee for a shielded transaction

Returns

number

Minimum fee in ZEC (ZIP-317 with grace actions)