Class BaseTransactionRequestAbstract

constructor

• new BaseTransactionRequest(baseTransactionRequest?): BaseTransactionRequest

• Constructor for initializing a base transaction request.

  Parameters

  • baseTransactionRequest: BaseTransactionRequestLike = {}

    Optional object containing properties to initialize the transaction request.

  Returns BaseTransactionRequest

inputs

Optionalmaturity

maxFee

outputs

Optionaltip

Abstracttype

OptionalwitnessLimit

witnesses

addAccountWitnesses

• addAccountWitnesses(account): Promise<BaseTransactionRequest>

• Helper function to add an external signature to the transaction.

  Parameters

  • account: Account | Account[]

    The account/s to sign to the transaction.

  Returns Promise<BaseTransactionRequest>

  The transaction with the signature witness added.

addChangeOutput

• addChangeOutput(to, assetId): void

• Adds a change output to the transaction.

  Parameters

  • to: AddressLike

    Address of the owner.
  • assetId: BytesLike

    Asset ID of coin.

  Returns void

addCoinInput

• addCoinInput(coin): void

• Adds a single coin input to the transaction and a change output for the related assetId, if one it was not added yet.

  Parameters

  • coin: Coin

    Coin resource.

  Returns void

addCoinOutput

• addCoinOutput(to, amount, assetId): BaseTransactionRequest

• Adds a coin output to the transaction.

  Parameters

  • to: AddressLike

    Address of the owner.
  • amount: BigNumberish

    Amount of coin.
  • assetId: BytesLike

    Asset ID of coin.

  Returns BaseTransactionRequest

addCoinOutputs

• addCoinOutputs(to, quantities): BaseTransactionRequest

• Adds multiple coin outputs to the transaction.

  Parameters

  • to: AddressLike

    Address of the destination.
  • quantities: CoinQuantityLike[]

    Quantities of coins.

  Returns BaseTransactionRequest

addMessageInput

• addMessageInput(message): void

• Adds a single message input to the transaction and a change output for the asset against the message

  Parameters

  • message: Message | MessageCoin

    Message resource.

  Returns void

addResource

• addResource(resource): BaseTransactionRequest

• Adds a single resource to the transaction by adding a coin/message input and a change output for the related assetId, if one it was not added yet.

  Parameters

  • resource: Resource

    The resource to add.

  Returns BaseTransactionRequest

  This transaction.

addResources

• addResources(resources): BaseTransactionRequest

• Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.

  Parameters

  • resources: readonly Resource[]

    The resources to add.

  Returns BaseTransactionRequest

  This transaction.

byteLength

• byteLength(): number

• Returns number

calculateMaxGas

• calculateMaxGas(chainInfo, minGas): BN

• Parameters

  • chainInfo: ChainInfo
  • minGas: BN

  Returns BN

fundWithFakeUtxos

• fundWithFakeUtxos(quantities, baseAssetId, resourcesOwner?): BaseTransactionRequest

• Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.

  Parameters

  • quantities: CoinQuantity[]

    CoinQuantity Array.
  • baseAssetId: string

    The base asset to fund the transaction.
  • OptionalresourcesOwner: AbstractAddress

  Returns BaseTransactionRequest

  Deprecated

  • This method is deprecated and will be removed in future versions. Please use Account.generateFakeResources along with this.addResources instead.

getChangeOutputs

• getChangeOutputs(): ChangeTransactionRequestOutput[]

• Gets the change outputs for a transaction.

  Returns ChangeTransactionRequestOutput[]

  The change outputs.

getCoinInputs

• getCoinInputs(): CoinTransactionRequestInput[]

• Gets the coin inputs for a transaction.

  Returns CoinTransactionRequestInput[]

  The coin inputs.

getCoinOutputs

• getCoinOutputs(): CoinTransactionRequestOutput[]

• Gets the coin outputs for a transaction.

  Returns CoinTransactionRequestOutput[]

  The coin outputs.

getCoinOutputsQuantities

• getCoinOutputsQuantities(): CoinQuantity[]

• Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.

  Returns CoinQuantity[]

  CoinQuantity array.

AbstractgetTransactionId

• getTransactionId(chainId): string

• Gets the Transaction Request by hashing the transaction.

  Parameters

  • chainId: number

    The chain ID.

  Returns string

  • A hash of the transaction, which is the transaction ID.

removeWitness

• removeWitness(index): void

• Parameters

  • index: number

  Returns void

toJSON

• toJSON(): any

• Return the minimum amount in native coins required to create a transaction.

  Returns any

  The transaction as a JSON object.

AbstracttoTransaction

• toTransaction():
      | TransactionScript
      | TransactionCreate
      | TransactionUpgrade
      | TransactionUpload
      | TransactionBlob

• Returns
      | TransactionScript
      | TransactionCreate
      | TransactionUpgrade
      | TransactionUpload
      | TransactionBlob

toTransactionBytes

• toTransactionBytes(): Uint8Array

• Converts the transaction request to a byte array.

  Returns Uint8Array

  The transaction bytes.

updatePredicateGasUsed

• updatePredicateGasUsed(inputs): void

• Parameters

  • inputs: TransactionRequestInput[]

  Returns void

updateWitness

• updateWitness(index, witness): void

• Updates an existing witness without any side effects.

  Parameters

  • index: number

    The index of the witness to update.
  • witness: BytesLike

    The new witness.

  Returns void

  Throws

  If the witness does not exist.

updateWitnessByOwner

• updateWitnessByOwner(address, signature): void

• Updates the witness for a given owner and signature.

  Parameters

  • address: string | AbstractAddress

    The address to get the coin input witness index for.
  • signature: BytesLike

    The signature to update the witness with.

  Returns void

StaticgetPolicyMeta

• getPolicyMeta(req): {
      policies: Policy[];
      policyTypes: number;
  }

• Parameters

  • req: BaseTransactionRequest

  Returns {
      policies: Policy[];
      policyTypes: number;
  }

  • policies: Policy[]

  • policyTypes: number