Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
BaseTransactionRequest

Icon LinkClass: BaseTransactionRequest

@fuel-ts/providers .BaseTransactionRequest

Abstract class to define the functionalities of a transaction request transaction request.

Icon LinkHierarchy

Icon LinkImplements

  • BaseTransactionRequestLike

Icon LinkConstructors

Icon Linkconstructor

new BaseTransactionRequest(baseTransactionRequest?): BaseTransactionRequest

Constructor for initializing a base transaction request.

Icon LinkParameters

NameTypeDescription
baseTransactionRequestBaseTransactionRequestLikeOptional object containing properties to initialize the transaction request.

Icon LinkReturns

BaseTransactionRequest

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:111 Icon Link

Icon LinkProperties

Icon LinkgasPrice

gasPrice: BN

Gas price for transaction

Icon LinkImplementation of

BaseTransactionRequestLike.gasPrice

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:92 Icon Link


Icon Linkinputs

inputs: TransactionRequestInput [] = []

List of inputs

Icon LinkImplementation of

BaseTransactionRequestLike.inputs

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:100 Icon Link


Icon Linkmaturity

maturity: number

Block until which tx cannot be included

Icon LinkImplementation of

BaseTransactionRequestLike.maturity

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:94 Icon Link


Icon LinkmaxFee

Optional maxFee: BN

The maximum fee payable by this transaction using BASE_ASSET.

Icon LinkImplementation of

BaseTransactionRequestLike.maxFee

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:96 Icon Link


Icon Linkoutputs

outputs: TransactionRequestOutput [] = []

List of outputs

Icon LinkImplementation of

BaseTransactionRequestLike.outputs

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:102 Icon Link


Icon Linktype

Abstract type: TransactionType

Type of the transaction

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:90 Icon Link


Icon LinkwitnessLimit

Optional witnessLimit: BN

The maximum amount of witness data allowed for the transaction

Icon LinkImplementation of

BaseTransactionRequestLike.witnessLimit

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:98 Icon Link


Icon Linkwitnesses

witnesses: BytesLike[] = []

List of witnesses

Icon LinkImplementation of

BaseTransactionRequestLike.witnesses

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:104 Icon Link

Icon LinkMethods

Icon LinkaddChangeOutput

addChangeOutput(to, assetId?): void

Adds a change output to the transaction.

Icon LinkParameters

NameTypeDefault valueDescription
toAddressLike undefinedAddress of the owner.
assetIdBytesLikeBaseAssetIdAsset ID of coin.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:498 Icon Link


Icon LinkaddCoinInput

addCoinInput(coin, predicate?): void

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

Icon LinkParameters

NameTypeDescription
coinCoin Coin resource.
predicate?AbstractPredicatePredicate bytes.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:316 Icon Link


Icon LinkaddCoinOutput

addCoinOutput(to, amount, assetId?): BaseTransactionRequest

Adds a coin output to the transaction.

Icon LinkParameters

NameTypeDefault valueDescription
toAddressLike undefinedAddress of the owner.
amountBigNumberishundefinedAmount of coin.
assetIdBytesLikeBaseAssetIdAsset ID of coin.

Icon LinkReturns

BaseTransactionRequest

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:462 Icon Link


Icon LinkaddCoinOutputs

addCoinOutputs(to, quantities): BaseTransactionRequest

Adds multiple coin outputs to the transaction.

Icon LinkParameters

NameTypeDescription
toAddressLike Address of the destination.
quantitiesCoinQuantityLike []Quantities of coins.

Icon LinkReturns

BaseTransactionRequest

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:479 Icon Link


Icon LinkaddMessageInput

addMessageInput(message, predicate?): void

Adds a single message input to the transaction and a change output for the baseAssetId, if one it was not added yet.

Icon LinkParameters

NameTypeDescription
messageMessageCoin Message resource.
predicate?AbstractPredicatePredicate bytes.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:359 Icon Link


Icon LinkaddPredicateResource

addPredicateResource(resource, predicate): BaseTransactionRequest

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

Icon LinkParameters

NameType
resourceResource
predicateAbstractPredicate

Icon LinkReturns

BaseTransactionRequest

This transaction.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:432 Icon Link


Icon LinkaddPredicateResources

addPredicateResources(resources, predicate): BaseTransactionRequest

Adds multiple predicate coin/message inputs to the transaction and change outputs from the related assetIds.

Icon LinkParameters

NameTypeDescription
resourcesResource []The resources to add.
predicateAbstractPredicate-

Icon LinkReturns

BaseTransactionRequest

This transaction.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:449 Icon Link


Icon LinkaddResource

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.

Icon LinkParameters

NameTypeDescription
resourceResource The resource to add.

Icon LinkReturns

BaseTransactionRequest

This transaction.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:402 Icon Link


Icon LinkaddResources

addResources(resources): BaseTransactionRequest

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

Icon LinkParameters

NameTypeDescription
resourcesreadonly Resource []The resources to add.

Icon LinkReturns

BaseTransactionRequest

This transaction.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:419 Icon Link


Icon LinkcalculateMaxGas

calculateMaxGas(chainInfo, minGas): BN

Icon LinkParameters

NameType
chainInfoChainInfo
minGasBN

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:543 Icon Link


Icon LinkfundWithFakeUtxos

fundWithFakeUtxos(quantities): void

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

Icon LinkParameters

NameTypeDescription
quantitiesCoinQuantity []CoinQuantity Array.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:565 Icon Link


Icon LinkgetBaseTransaction

getBaseTransaction(): ToBaseTransactionResponse

Method to obtain the base transaction details.

Icon LinkReturns

ToBaseTransactionResponse

The base transaction details.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:162 Icon Link


Icon LinkgetChangeOutputs

getChangeOutputs(): ChangeTransactionRequestOutput []

Gets the change outputs for a transaction.

Icon LinkReturns

ChangeTransactionRequestOutput []

The change outputs.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:278 Icon Link


Icon LinkgetCoinInputs

getCoinInputs(): CoinTransactionRequestInput []

Gets the coin inputs for a transaction.

Icon LinkReturns

CoinTransactionRequestInput []

The coin inputs.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:256 Icon Link


Icon LinkgetCoinOutputs

getCoinOutputs(): CoinTransactionRequestOutput []

Gets the coin outputs for a transaction.

Icon LinkReturns

CoinTransactionRequestOutput []

The coin outputs.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:267 Icon Link


Icon LinkgetCoinOutputsQuantities

getCoinOutputsQuantities(): CoinQuantity []

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

Icon LinkReturns

CoinQuantity []

CoinQuantity array.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:612 Icon Link


Icon LinkgetTransactionId

getTransactionId(chainId): string

Gets the Transaction Request by hashing the transaction.

Icon LinkParameters

NameTypeDescription
chainIdnumberThe chain ID.

Icon LinkReturns

string

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

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:628 Icon Link


Icon LinktoJSON

toJSON(): any

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

Icon LinkReturns

any

The transaction as a JSON object.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:636 Icon Link


Icon LinktoTransaction

toTransaction(): TransactionScript | TransactionCreate

Icon LinkReturns

TransactionScript | TransactionCreate

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:181 Icon Link


Icon LinktoTransactionBytes

toTransactionBytes(): Uint8Array

Converts the transaction request to a byte array.

Icon LinkReturns

Uint8Array

The transaction bytes.

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:188 Icon Link


Icon LinkupdateWitness

updateWitness(index, witness): void

Updates an existing witness without any side effects.

Throws

If the witness does not exist.

Icon LinkParameters

NameTypeDescription
indexnumberThe index of the witness to update.
witnessBytesLikeThe new witness.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:244 Icon Link


Icon LinkupdateWitnessByOwner

updateWitnessByOwner(address, signature): void

Updates the witness for a given owner and signature.

Icon LinkParameters

NameTypeDescription
addressstring | AbstractAddress The address to get the coin input witness index for.
signatureBytesLikeThe signature to update the witness with.

Icon LinkReturns

void

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:229 Icon Link


Icon LinkgetPolicyMeta

getPolicyMeta(req): Object

Icon LinkParameters

Icon LinkReturns

Object

NameType
policiesPolicy[]
policyTypesnumber

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:129 Icon Link