TransactionClient | Node.js bindings for DAML

Allows clients to read transactions from the ledger.

Hierarchy

TransactionClient

Index

Methods

getFlatTransactionByEventId

getFlatTransactionByEventId(requestObject: GetTransactionByEventIdRequest): Promise<GetFlatTransactionResponse>
getFlatTransactionByEventId(requestObject: GetTransactionByEventIdRequest, callback: Callback<GetFlatTransactionResponse>): ClientCancellableCall

- Defined in src/client/TransactionClient.ts:43
Lookup a transaction by the ID of an event that appears within it.

Returns NOT_FOUND if no such transaction exists.

Parameters
- requestObject: GetTransactionByEventIdRequest
Returns Promise<GetFlatTransactionResponse>
- Defined in src/client/TransactionClient.ts:44
Parameters
- requestObject: GetTransactionByEventIdRequest
- callback: Callback<GetFlatTransactionResponse>
Returns ClientCancellableCall

getFlatTransactionById

getFlatTransactionById(requestObject: GetTransactionByIdRequest): Promise<GetFlatTransactionResponse>
getFlatTransactionById(requestObject: GetTransactionByIdRequest, callback: Callback<GetFlatTransactionResponse>): ClientCancellableCall

- Defined in src/client/TransactionClient.ts:59
Lookup a transaction by the ID of an event that appears within it.

Returns NOT_FOUND if no such transaction exists.

Parameters
- requestObject: GetTransactionByIdRequest
Returns Promise<GetFlatTransactionResponse>
- Defined in src/client/TransactionClient.ts:60
Parameters
- requestObject: GetTransactionByIdRequest
- callback: Callback<GetFlatTransactionResponse>
Returns ClientCancellableCall

getLedgerEnd

getLedgerEnd(): Promise<GetLedgerEndResponse>
getLedgerEnd(callback: Callback<GetLedgerEndResponse>): ClientCancellableCall

- Defined in src/client/TransactionClient.ts:27
Get the current ledger end.

Subscriptions started with the returned offset will serve transactions created after this RPC was called.

Returns Promise<GetLedgerEndResponse>
- Defined in src/client/TransactionClient.ts:28
Parameters
- callback: Callback<GetLedgerEndResponse>
Returns ClientCancellableCall

getTransactionByEventId

getTransactionByEventId(requestObject: GetTransactionByEventIdRequest): Promise<GetTransactionResponse>
getTransactionByEventId(requestObject: GetTransactionByEventIdRequest, callback: Callback<GetTransactionResponse>): ClientCancellableCall

- Defined in src/client/TransactionClient.ts:35
Lookup a transaction by the ID of an event that appears within it.

Returns NOT_FOUND if no such transaction exists.

Parameters
- requestObject: GetTransactionByEventIdRequest
Returns Promise<GetTransactionResponse>
- Defined in src/client/TransactionClient.ts:36
Parameters
- requestObject: GetTransactionByEventIdRequest
- callback: Callback<GetTransactionResponse>
Returns ClientCancellableCall

getTransactionById

getTransactionById(requestObject: GetTransactionByIdRequest): Promise<GetTransactionResponse>
getTransactionById(requestObject: GetTransactionByIdRequest, callback: Callback<GetTransactionResponse>): ClientCancellableCall

- Defined in src/client/TransactionClient.ts:51
Lookup a transaction by its ID.

Returns NOT_FOUND if no such transaction exists.

Parameters
- requestObject: GetTransactionByIdRequest
Returns Promise<GetTransactionResponse>
- Defined in src/client/TransactionClient.ts:52
Parameters
- requestObject: GetTransactionByIdRequest
- callback: Callback<GetTransactionResponse>
Returns ClientCancellableCall

getTransactionTrees

getTransactionTrees(requestObject: GetTransactionsRequest): ClientReadableObjectStream<GetTransactionTreesResponse>

- Defined in src/client/TransactionClient.ts:72
Read the ledger's complete transaction stream for a set of parties.

This call is a future extension point and is currently not supported.

Parameters
- requestObject: GetTransactionsRequest
Returns ClientReadableObjectStream<GetTransactionTreesResponse>

getTransactions

getTransactions(requestObject: GetTransactionsRequest): ClientReadableObjectStream<GetTransactionsResponse>

- Defined in src/client/TransactionClient.ts:65
Read the ledger's filtered transaction stream for a set of parties.

Parameters
- requestObject: GetTransactionsRequest
Returns ClientReadableObjectStream<GetTransactionsResponse>

Hierarchy

Index

Methods

Methods

getFlatTransactionByEventId

Parameters

requestObject: GetTransactionByEventIdRequest

Returns Promise<GetFlatTransactionResponse>

Parameters

requestObject: GetTransactionByEventIdRequest

callback: Callback<GetFlatTransactionResponse>

Returns ClientCancellableCall

getFlatTransactionById

Parameters

requestObject: GetTransactionByIdRequest

Returns Promise<GetFlatTransactionResponse>

Parameters

requestObject: GetTransactionByIdRequest

callback: Callback<GetFlatTransactionResponse>

Returns ClientCancellableCall

getLedgerEnd

Returns Promise<GetLedgerEndResponse>

Parameters

callback: Callback<GetLedgerEndResponse>

Returns ClientCancellableCall

getTransactionByEventId

Parameters

requestObject: GetTransactionByEventIdRequest

Returns Promise<GetTransactionResponse>

Parameters

requestObject: GetTransactionByEventIdRequest

callback: Callback<GetTransactionResponse>

Returns ClientCancellableCall

getTransactionById

Parameters

requestObject: GetTransactionByIdRequest

Returns Promise<GetTransactionResponse>

Parameters

requestObject: GetTransactionByIdRequest

callback: Callback<GetTransactionResponse>

Returns ClientCancellableCall

getTransactionTrees

Parameters

requestObject: GetTransactionsRequest

Returns ClientReadableObjectStream<GetTransactionTreesResponse>

getTransactions

Parameters

requestObject: GetTransactionsRequest

Returns ClientReadableObjectStream<GetTransactionsResponse>