@fuel-ts/account v0.94.2 • Docs
abstract BaseTransactionRequest Abstract class to define the functionalities of a transaction request transaction request.
BaseTransactionRequestLike new BaseTransactionRequest(
baseTransactionRequest):BaseTransactionRequest
Constructor for initializing a base transaction request.
• baseTransactionRequest: BaseTransactionRequestLike = {}
Optional object containing properties to initialize the transaction request.
packages/account/src/providers/transaction-request/transaction-request.ts:124
inputs:
TransactionRequestInput[] =[]
List of inputs
BaseTransactionRequestLike.inputs
packages/account/src/providers/transaction-request/transaction-request.ts:113
optionalmaturity:number
Block until which tx cannot be included
BaseTransactionRequestLike.maturity
packages/account/src/providers/transaction-request/transaction-request.ts:107
maxFee:
BN
The maximum fee payable by this transaction using BASE_ASSET.
BaseTransactionRequestLike.maxFee
packages/account/src/providers/transaction-request/transaction-request.ts:109
outputs:
TransactionRequestOutput[] =[]
List of outputs
BaseTransactionRequestLike.outputs
packages/account/src/providers/transaction-request/transaction-request.ts:115
optionaltip:BN
Gas price for transaction
BaseTransactionRequestLike.tip
packages/account/src/providers/transaction-request/transaction-request.ts:105
abstracttype:TransactionType
Type of the transaction
packages/account/src/providers/transaction-request/transaction-request.ts:103
optionalwitnessLimit:BN
The maximum amount of witness data allowed for the transaction
BaseTransactionRequestLike.witnessLimit
packages/account/src/providers/transaction-request/transaction-request.ts:111
witnesses:
BytesLike[] =[]
List of witnesses
BaseTransactionRequestLike.witnesses
packages/account/src/providers/transaction-request/transaction-request.ts:117
addAccountWitnesses(
account):Promise<BaseTransactionRequest>
Helper function to add an external signature to the transaction.
• account: Account | Account []
The account/s to sign to the transaction.
Promise<BaseTransactionRequest >
The transaction with the signature witness added.
packages/account/src/providers/transaction-request/transaction-request.ts:286
addChangeOutput(
to,assetId):void
Adds a change output to the transaction.
• to: AddressLike
Address of the owner.
• assetId: BytesLike
Asset ID of coin.
void
packages/account/src/providers/transaction-request/transaction-request.ts:508
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.
• coin: Coin
Coin resource.
void
packages/account/src/providers/transaction-request/transaction-request.ts:360
addCoinOutput(
to,amount,assetId):BaseTransactionRequest
Adds a coin output to the transaction.
• to: AddressLike
Address of the owner.
• amount: BigNumberish
Amount of coin.
• assetId: BytesLike
Asset ID of coin.
packages/account/src/providers/transaction-request/transaction-request.ts:472
addCoinOutputs(
to,quantities):BaseTransactionRequest
Adds multiple coin outputs to the transaction.
• to: AddressLike
Address of the destination.
• quantities: CoinQuantityLike []
Quantities of coins.
packages/account/src/providers/transaction-request/transaction-request.ts:489
addMessageInput(
message):void
Adds a single message input to the transaction and a change output for the asset against the message
• message: MessageCoin
Message resource.
void
packages/account/src/providers/transaction-request/transaction-request.ts:401
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.
• resource: Resource
The resource to add.
This transaction.
packages/account/src/providers/transaction-request/transaction-request.ts:442
addResources(
resources):BaseTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
• resources: readonly Resource []
The resources to add.
This transaction.
packages/account/src/providers/transaction-request/transaction-request.ts:459
byteLength():
number
number
packages/account/src/providers/transaction-request/transaction-request.ts:696
calculateMaxGas(
chainInfo,minGas):BN
• chainInfo: ChainInfo
• minGas: BN
BN
packages/account/src/providers/transaction-request/transaction-request.ts:556
fundWithFakeUtxos(
quantities,baseAssetId,resourcesOwner?):BaseTransactionRequest
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
• quantities: CoinQuantity []
CoinQuantity Array.
• baseAssetId: string
The base asset to fund the transaction.
• resourcesOwner?: AbstractAddress
packages/account/src/providers/transaction-request/transaction-request.ts:583
protectedgetBaseTransaction():ToBaseTransactionResponse
Method to obtain the base transaction details.
ToBaseTransactionResponse
The base transaction details.
packages/account/src/providers/transaction-request/transaction-request.ts:176
getChangeOutputs():
ChangeTransactionRequestOutput[]
Gets the change outputs for a transaction.
ChangeTransactionRequestOutput []
The change outputs.
packages/account/src/providers/transaction-request/transaction-request.ts:324
getCoinInputs():
CoinTransactionRequestInput[]
Gets the coin inputs for a transaction.
CoinTransactionRequestInput []
The coin inputs.
packages/account/src/providers/transaction-request/transaction-request.ts:302
getCoinOutputs():
CoinTransactionRequestOutput[]
Gets the coin outputs for a transaction.
CoinTransactionRequestOutput []
The coin outputs.
packages/account/src/providers/transaction-request/transaction-request.ts:313
getCoinOutputsQuantities():
CoinQuantity[]
Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.
CoinQuantity []
CoinQuantity array.
packages/account/src/providers/transaction-request/transaction-request.ts:634
abstractgetTransactionId(chainId):string
Gets the Transaction Request by hashing the transaction.
• chainId: number
The chain ID.
string
packages/account/src/providers/transaction-request/transaction-request.ts:650
removeWitness(
index):void
• index: number
void
packages/account/src/providers/transaction-request/transaction-request.ts:662
toJSON():
any
Return the minimum amount in native coins required to create a transaction.
any
The transaction as a JSON object.
packages/account/src/providers/transaction-request/transaction-request.ts:658
abstracttoTransaction():TransactionScript|TransactionCreate|TransactionBlob
TransactionScript | TransactionCreate | TransactionBlob
packages/account/src/providers/transaction-request/transaction-request.ts:195
toTransactionBytes():
Uint8Array
Converts the transaction request to a byte array.
Uint8Array
The transaction bytes.
packages/account/src/providers/transaction-request/transaction-request.ts:202
updatePredicateGasUsed(
inputs):void
• inputs: TransactionRequestInput []
void
packages/account/src/providers/transaction-request/transaction-request.ts:676
updateWitness(
index,witness):void
Updates an existing witness without any side effects.
• index: number
The index of the witness to update.
• witness: BytesLike
The new witness.
void
If the witness does not exist.
packages/account/src/providers/transaction-request/transaction-request.ts:273
updateWitnessByOwner(
address,signature):void
Updates the witness for a given owner and signature.
• address: string | AbstractAddress
The address to get the coin input witness index for.
• signature: BytesLike
The signature to update the witness with.
void
packages/account/src/providers/transaction-request/transaction-request.ts:258
staticgetPolicyMeta(req):object
• req: BaseTransactionRequest
object
policies:
Policy[]
policyTypes:
number
packages/account/src/providers/transaction-request/transaction-request.ts:142