@fuel-ts/providers .BaseTransactionRequest
Abstract class to define the functionalities of a transaction request transaction request.
BaseTransactionRequest
BaseTransactionRequestLike • new BaseTransactionRequest(baseTransactionRequest?): BaseTransactionRequest
Constructor for initializing a base transaction request.
| Name | Type | Description |
|---|---|---|
baseTransactionRequest | BaseTransactionRequestLike | Optional object containing properties to initialize the transaction request. |
packages/providers/src/transaction-request/transaction-request.ts:111
• gasPrice: BN
Gas price for transaction
BaseTransactionRequestLike.gasPrice
packages/providers/src/transaction-request/transaction-request.ts:92
• inputs: TransactionRequestInput [] = []
List of inputs
BaseTransactionRequestLike.inputs
packages/providers/src/transaction-request/transaction-request.ts:100
• maturity: number
Block until which tx cannot be included
BaseTransactionRequestLike.maturity
packages/providers/src/transaction-request/transaction-request.ts:94
• Optional maxFee: BN
The maximum fee payable by this transaction using BASE_ASSET.
BaseTransactionRequestLike.maxFee
packages/providers/src/transaction-request/transaction-request.ts:96
• outputs: TransactionRequestOutput [] = []
List of outputs
BaseTransactionRequestLike.outputs
packages/providers/src/transaction-request/transaction-request.ts:102
• Abstract type: TransactionType
Type of the transaction
packages/providers/src/transaction-request/transaction-request.ts:90
• Optional witnessLimit: BN
The maximum amount of witness data allowed for the transaction
BaseTransactionRequestLike.witnessLimit
packages/providers/src/transaction-request/transaction-request.ts:98
• witnesses: BytesLike[] = []
List of witnesses
BaseTransactionRequestLike.witnesses
packages/providers/src/transaction-request/transaction-request.ts:104
▸ addChangeOutput(to, assetId?): void
Adds a change output to the transaction.
| Name | Type | Default value | Description |
|---|---|---|---|
to | AddressLike | undefined | Address of the owner. |
assetId | BytesLike | BaseAssetId | Asset ID of coin. |
void
packages/providers/src/transaction-request/transaction-request.ts:498
▸ 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.
| Name | Type | Description |
|---|---|---|
coin | Coin | Coin resource. |
predicate? | AbstractPredicate | Predicate bytes. |
void
packages/providers/src/transaction-request/transaction-request.ts:316
▸ addCoinOutput(to, amount, assetId?): BaseTransactionRequest
Adds a coin output to the transaction.
| 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. |
packages/providers/src/transaction-request/transaction-request.ts:462
▸ addCoinOutputs(to, quantities): BaseTransactionRequest
Adds multiple coin outputs to the transaction.
| Name | Type | Description |
|---|---|---|
to | AddressLike | Address of the destination. |
quantities | CoinQuantityLike [] | Quantities of coins. |
packages/providers/src/transaction-request/transaction-request.ts:479
▸ 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.
| Name | Type | Description |
|---|---|---|
message | MessageCoin | Message resource. |
predicate? | AbstractPredicate | Predicate bytes. |
void
packages/providers/src/transaction-request/transaction-request.ts:359
▸ addPredicateResource(resource, predicate): BaseTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
| Name | Type |
|---|---|
resource | Resource |
predicate | AbstractPredicate |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:432
▸ addPredicateResources(resources, predicate): BaseTransactionRequest
Adds multiple predicate coin/message inputs to the transaction and change outputs from the related assetIds.
| Name | Type | Description |
|---|---|---|
resources | Resource [] | The resources to add. |
predicate | AbstractPredicate | - |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:449
▸ 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.
| Name | Type | Description |
|---|---|---|
resource | Resource | The resource to add. |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:402
▸ addResources(resources): BaseTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
| Name | Type | Description |
|---|---|---|
resources | readonly Resource [] | The resources to add. |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:419
▸ calculateMaxGas(chainInfo, minGas): BN
| Name | Type |
|---|---|
chainInfo | ChainInfo |
minGas | BN |
BN
packages/providers/src/transaction-request/transaction-request.ts:543
▸ fundWithFakeUtxos(quantities): void
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
| Name | Type | Description |
|---|---|---|
quantities | CoinQuantity [] | CoinQuantity Array. |
void
packages/providers/src/transaction-request/transaction-request.ts:565
▸ getBaseTransaction(): ToBaseTransactionResponse
Method to obtain the base transaction details.
ToBaseTransactionResponse
The base transaction details.
packages/providers/src/transaction-request/transaction-request.ts:162
▸ getChangeOutputs(): ChangeTransactionRequestOutput []
Gets the change outputs for a transaction.
ChangeTransactionRequestOutput []
The change outputs.
packages/providers/src/transaction-request/transaction-request.ts:278
▸ getCoinInputs(): CoinTransactionRequestInput []
Gets the coin inputs for a transaction.
CoinTransactionRequestInput []
The coin inputs.
packages/providers/src/transaction-request/transaction-request.ts:256
▸ getCoinOutputs(): CoinTransactionRequestOutput []
Gets the coin outputs for a transaction.
CoinTransactionRequestOutput []
The coin outputs.
packages/providers/src/transaction-request/transaction-request.ts:267
▸ getCoinOutputsQuantities(): CoinQuantity []
Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.
CoinQuantity []
CoinQuantity array.
packages/providers/src/transaction-request/transaction-request.ts:612
▸ getTransactionId(chainId): string
Gets the Transaction Request by hashing the transaction.
| Name | Type | Description |
|---|---|---|
chainId | number | The chain ID. |
string
packages/providers/src/transaction-request/transaction-request.ts:628
▸ toJSON(): any
Return the minimum amount in native coins required to create a transaction.
any
The transaction as a JSON object.
packages/providers/src/transaction-request/transaction-request.ts:636
▸ toTransaction(): TransactionScript | TransactionCreate
TransactionScript | TransactionCreate
packages/providers/src/transaction-request/transaction-request.ts:181
▸ toTransactionBytes(): Uint8Array
Converts the transaction request to a byte array.
Uint8Array
The transaction bytes.
packages/providers/src/transaction-request/transaction-request.ts:188
▸ updateWitness(index, witness): void
Updates an existing witness without any side effects.
Throws
If the witness does not exist.
| Name | Type | Description |
|---|---|---|
index | number | The index of the witness to update. |
witness | BytesLike | The new witness. |
void
packages/providers/src/transaction-request/transaction-request.ts:244
▸ updateWitnessByOwner(address, signature): void
Updates the witness for a given owner and signature.
| 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. |
void
packages/providers/src/transaction-request/transaction-request.ts:229
▸ getPolicyMeta(req): Object
| Name | Type |
|---|---|
req | BaseTransactionRequest |
Object
| Name | Type |
|---|---|
policies | Policy[] |
policyTypes | number |
packages/providers/src/transaction-request/transaction-request.ts:129