Docs
chromia.com

Type Alias

TransactionBuilder

On this page
type TransactionBuilder = {
    add: (
        operation: Operation,
        config?: OperationConfig,
    ) => TransactionBuilder;
    addSigners: (...keyStores: FtKeyStore[]) => TransactionBuilder;
    build: () => Promise<SignedTransaction>;
    buildAndSend: () => Web3PromiEvent<
        TransactionWithReceipt,
        { built: SignedTransaction; sent: Buffer },
    >;
    buildAndSendWithAnchoring: () => Web3PromiEvent<
        AnchoringTransactionWithReceipt,
        { built: SignedTransaction; confirmed: TransactionReceipt; sent: Buffer },
    >;
    session: IClient;
}

Properties

add

add: (operation: Operation, config?: OperationConfig) => TransactionBuilder

Adds an operation to include in the final transaction

Type Declaration

    • (operation: Operation, config?: OperationConfig): TransactionBuilder

    • Parameters

      • operation: Operation

        the operation to add to the transaction

      • Optionalconfig: OperationConfig

        a configuration object that will be used for this operation when building the transaction

      Returns TransactionBuilder

      an instance of the transaction builder object

addSigners

addSigners: (...keyStores: FtKeyStore[]) => TransactionBuilder

Add key stores that will also be included as signers to this transaction. If build is called, the key stores will also be used to sign the transaction

Type Declaration

build

build: () => Promise<SignedTransaction>

Builds a transaction containing the previously added transactions, as well as any authorization operations as needed, and signs it using the same key handlers that were used to authorize the operations, as well as any explicitly added key handlers.

Type Declaration

    • (): Promise<SignedTransaction>

    • Returns Promise<SignedTransaction>

      A promised containing the signed transaction

buildAndSend

buildAndSend: () => Web3PromiEvent<
    TransactionWithReceipt,
    { built: SignedTransaction; sent: Buffer },
>

Build the transaction and submits it to the blockchain.

Will emit events when the transaction is built, and when it is sent (containing the transaction RID).

Will return when transaction is included in a block (confirmed), or is rejected.

Type Declaration

    • (): Web3PromiEvent<
    TransactionWithReceipt,
    { built: SignedTransaction; sent: Buffer },
>

    • Returns Web3PromiEvent<
          TransactionWithReceipt,
          { built: SignedTransaction; sent: Buffer },
      >

      an object containing the signed transaction and its receipt

buildAndSendWithAnchoring

buildAndSendWithAnchoring: () => Web3PromiEvent<
    AnchoringTransactionWithReceipt,
    { built: SignedTransaction; confirmed: TransactionReceipt; sent: Buffer },
>

Build the transaction, submits it to the blockchain and wait until it has been anchored in cluster and system anchoring chains.

Will emit events when the transaction is built, when it is sent (containing the transaction RID), and when it is included in a block (confirmed).

Will trigger any registered OnAnchoredHandlers before returning.

Type Declaration

    • (): Web3PromiEvent<
    AnchoringTransactionWithReceipt,
    { built: SignedTransaction; confirmed: TransactionReceipt; sent: Buffer },
>

    • Returns Web3PromiEvent<
          AnchoringTransactionWithReceipt,
          { built: SignedTransaction; confirmed: TransactionReceipt; sent: Buffer },
      >

      an object containing the signed transaction and its receipt

session

session: IClient