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