Type alias TransactionBuilder

Type declaration

• add: ((operation, config?) => TransactionBuilder)

  Adds an operation to include in the final transaction

  Returns

  an instance of the transaction builder object

  • • (operation, config?): TransactionBuilder

    • Parameters

      • operation: Operation

        the operation to add to the transaction
      • Optional config: OperationConfig

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

      Returns TransactionBuilder

• addSigners: ((...keyStores) => 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

  Returns

  an instance of the transaction builder object

  • • (...keyStores): TransactionBuilder

    • Parameters

      • Rest ...keyStores: FtKeyStore[]

        the key stores to use for signing

      Returns TransactionBuilder

• 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.

  Returns

  A promised containing the signed transaction

  • • (): Promise<SignedTransaction>

    • Returns Promise<SignedTransaction>

• 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.

  Returns

  an object containing the signed transaction and its receipt

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

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

• buildAndSendWithAnchoring: (() => Web3PromiEvent<TransactionWithReceipt, {
      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.

  Returns

  an object containing the signed transaction and its receipt

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

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

• session: IClient