Class SaplingTransactionViewer

Allows to retrieve and decrypt sapling transactions using on a viewing key

Param: inMemoryViewingKey

Holds the sapling viewing key

Param: saplingContractId

Address of the sapling contract or sapling id if the smart contract contains multiple sapling states

Param: readProvider

Allows to read data from the blockchain

Index

Constructors

constructor

Methods

getBalance getIncomingAndOutgoingTransactions getIncomingAndOutgoingTransactionsRaw

Constructors

constructor

new SaplingTransactionViewer(
    inMemoryViewingKey: InMemoryViewingKey,
    saplingContractId: SaplingContractId,
    readProvider: TzReadProvider,
): SaplingTransactionViewer
Parameters
- inMemoryViewingKey: InMemoryViewingKey
- saplingContractId: SaplingContractId
- readProvider: TzReadProvider
Returns SaplingTransactionViewer
- Defined in packages/taquito-sapling/src/sapling-tx-viewer/sapling-transaction-viewer.ts:29

Methods

getBalance

getBalance(): Promise<BigNumber>
Retrieve the unspent balance associated with the configured viewing key and sapling state

Returns Promise<BigNumber>
the balance in mutez represented as a BigNumber
- Defined in packages/taquito-sapling/src/sapling-tx-viewer/sapling-transaction-viewer.ts:45

getIncomingAndOutgoingTransactions

getIncomingAndOutgoingTransactions(): Promise<
SaplingIncomingAndOutgoingTransaction,
>
Retrieve all the incoming and outgoing decoded transactions associated with the configured viewing key

Returns Promise<SaplingIncomingAndOutgoingTransaction>
- Defined in packages/taquito-sapling/src/sapling-tx-viewer/sapling-transaction-viewer.ts:110

getIncomingAndOutgoingTransactionsRaw

getIncomingAndOutgoingTransactionsRaw(): Promise<
    {
        incoming: {
            isSpent: boolean;
            memo: Uint8Array;
            paymentAddress: Uint8Array;
            position: number;
            randomCommitmentTrapdoor: Uint8Array;
            value: Uint8Array;
        }[];
        outgoing: Omit<Input, "position">[];
    },
>
Retrieve all the incoming and outgoing transactions associated with the configured viewing key. The response properties are in Uint8Array format; use the getIncomingAndOutgoingTransactions method for readable properties

Returns Promise<
    {
        incoming: {
            isSpent: boolean;
            memo: Uint8Array;
            paymentAddress: Uint8Array;
            position: number;
            randomCommitmentTrapdoor: Uint8Array;
            value: Uint8Array;
        }[];
        outgoing: Omit<Input, "position">[];
    },
>
- Defined in packages/taquito-sapling/src/sapling-tx-viewer/sapling-transaction-viewer.ts:72

Class SaplingTransactionViewer

Param: inMemoryViewingKey

Param: saplingContractId

Param: readProvider

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SaplingTransactionViewer

Methods

getBalance

Returns Promise<BigNumber>

getIncomingAndOutgoingTransactions

Returns Promise<SaplingIncomingAndOutgoingTransaction>

getIncomingAndOutgoingTransactionsRaw

Settings

On This Page

Class SaplingTransactionViewer

Param: inMemoryViewingKey

Param: saplingContractId

Param: readProvider

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SaplingTransactionViewer

Methods

getBalance

Returns Promise<BigNumber>

getIncomingAndOutgoingTransactions

Returns Promise<SaplingIncomingAndOutgoingTransaction>

getIncomingAndOutgoingTransactionsRaw

Returns Promise< { incoming: { isSpent: boolean; memo: Uint8Array; paymentAddress: Uint8Array; position: number; randomCommitmentTrapdoor: Uint8Array; value: Uint8Array; }[]; outgoing: Omit<Input, "position">[]; },>

Settings

On This Page

Returns Promise<
{
incoming: {
isSpent: boolean;
memo: Uint8Array;
paymentAddress: Uint8Array;
position: number;
randomCommitmentTrapdoor: Uint8Array;
value: Uint8Array;
}[];
outgoing: Omit<Input, "position">[];
},
>