Class: BaseTransactionRequest
@fuel-ts/account.BaseTransactionRequest
Abstract class to define the functionalities of a transaction request transaction request.
Hierarchy
BaseTransactionRequest
Implements
BaseTransactionRequestLike
Constructors
constructor
• new BaseTransactionRequest(baseTransactionRequest?
): BaseTransactionRequest
Constructor for initializing a base transaction request.
Parameters
Name | 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:116
Properties
gasPrice
• gasPrice: BN
Gas price for transaction
Implementation of
BaseTransactionRequestLike.gasPrice
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:97
inputs
• inputs: TransactionRequestInput
[] = []
List of inputs
Implementation of
BaseTransactionRequestLike.inputs
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:105
maturity
• maturity: number
Block until which tx cannot be included
Implementation of
BaseTransactionRequestLike.maturity
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:99
maxFee
• Optional
maxFee: BN
The maximum fee payable by this transaction using BASE_ASSET.
Implementation of
BaseTransactionRequestLike.maxFee
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:101
outputs
• outputs: TransactionRequestOutput
[] = []
List of outputs
Implementation of
BaseTransactionRequestLike.outputs
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:107
type
• Abstract
type: TransactionType
Type of the transaction
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:95
witnessLimit
• Optional
witnessLimit: BN
The maximum amount of witness data allowed for the transaction
Implementation of
BaseTransactionRequestLike.witnessLimit
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:103
witnesses
• witnesses: BytesLike
[] = []
List of witnesses
Implementation of
BaseTransactionRequestLike.witnesses
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:109
Methods
addAccountWitnesses
▸ addAccountWitnesses(account
): Promise
<BaseTransactionRequest
>
Helper function to add an external signature to the transaction.
Parameters
Name | 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:277
addChangeOutput
▸ addChangeOutput(to
, assetId?
): void
Adds a change output to the transaction.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
to | AddressLike | undefined | Address of the owner. |
assetId | BytesLike | BaseAssetId | Asset ID of coin. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:533
addCoinInput
▸ 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.
Parameters
Name | Type | Description |
---|---|---|
coin | Coin | Coin resource. |
predicate? | Predicate <InputValue []> | Predicate bytes. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:353
addCoinOutput
▸ addCoinOutput(to
, amount
, assetId?
): BaseTransactionRequest
Adds a coin output to the transaction.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
to | AddressLike | undefined | Address of the owner. |
amount | BigNumberish | undefined | Amount of coin. |
assetId | BytesLike | BaseAssetId | Asset ID of coin. |
Returns
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:497
addCoinOutputs
▸ addCoinOutputs(to
, quantities
): BaseTransactionRequest
Adds multiple coin outputs to the transaction.
Parameters
Name | 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:514
addMessageInput
▸ 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.
Parameters
Name | Type | Description |
---|---|---|
message | MessageCoin | Message resource. |
predicate? | Predicate <InputValue []> | Predicate bytes. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:395
addPredicateResource
▸ addPredicateResource(resource
, predicate
): BaseTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
Parameters
Name | Type |
---|---|
resource | Resource |
predicate | Predicate <InputValue []> |
Returns
This transaction.
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:467
addPredicateResources
▸ addPredicateResources(resources
, predicate
): BaseTransactionRequest
Adds multiple predicate coin/message inputs to the transaction and change outputs from the related assetIds.
Parameters
Name | Type | Description |
---|---|---|
resources | Resource [] | The resources to add. |
predicate | Predicate <InputValue []> | - |
Returns
This transaction.
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:484
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
Name | Type | Description |
---|---|---|
resource | Resource | The resource to add. |
Returns
This transaction.
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:437
addResources
▸ addResources(resources
): BaseTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
Parameters
Name | Type | Description |
---|---|---|
resources | readonly Resource [] | The resources to add. |
Returns
This transaction.
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:454
calculateMaxGas
▸ calculateMaxGas(chainInfo
, minGas
): BN
Parameters
Name | Type |
---|---|
chainInfo | ChainInfo |
minGas | BN |
Returns
BN
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:578
fundWithFakeUtxos
▸ fundWithFakeUtxos(quantities
, resourcesOwner?
): void
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
Parameters
Name | Type | Description |
---|---|---|
quantities | CoinQuantity [] | CoinQuantity Array. |
resourcesOwner? | AbstractAddress | - |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:600
getBaseTransaction
▸ 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:167
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:315
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:293
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:304
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:640
getTransactionId
▸ getTransactionId(chainId
): string
Gets the Transaction Request by hashing the transaction.
Parameters
Name | 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:656
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:664
toTransaction
▸ toTransaction(): TransactionCreate
| TransactionScript
Returns
TransactionCreate
| TransactionScript
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:186
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:193
updatePredicateInputs
▸ updatePredicateInputs(inputs
): void
Parameters
Name | Type |
---|---|
inputs | TransactionRequestInput [] |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:668
updateWitness
▸ updateWitness(index
, witness
): void
Updates an existing witness without any side effects.
Throws
If the witness does not exist.
Parameters
Name | Type | Description |
---|---|---|
index | number | The index of the witness to update. |
witness | BytesLike | The new witness. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:264
updateWitnessByOwner
▸ updateWitnessByOwner(address
, signature
): void
Updates the witness for a given owner and signature.
Parameters
Name | 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:249
getPolicyMeta
▸ getPolicyMeta(req
): Object
Parameters
Name | Type |
---|---|
req | BaseTransactionRequest |
Returns
Object
Name | Type |
---|---|
policies | Policy [] |
policyTypes | number |
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:134