@fuel-ts/providers.BaseTransactionRequest
Abstract class to define the functionalities of a transaction request transaction request.
BaseTransactionRequest
BaseTransactionRequestLike • new 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:82
• gasLimit: BN
Gas limit for transaction
BaseTransactionRequestLike.gasLimit
packages/providers/src/transaction-request/transaction-request.ts:67
• gasPrice: BN
Gas price for transaction
BaseTransactionRequestLike.gasPrice
packages/providers/src/transaction-request/transaction-request.ts:65
• inputs: TransactionRequestInput[] = []
List of inputs
BaseTransactionRequestLike.inputs
packages/providers/src/transaction-request/transaction-request.ts:71
• maturity: number
Block until which tx cannot be included
BaseTransactionRequestLike.maturity
packages/providers/src/transaction-request/transaction-request.ts:69
• outputs: TransactionRequestOutput[] = []
List of outputs
BaseTransactionRequestLike.outputs
packages/providers/src/transaction-request/transaction-request.ts:73
• Abstract type: TransactionType
Type of the transaction
packages/providers/src/transaction-request/transaction-request.ts:63
• witnesses: BytesLike[] = []
List of witnesses
BaseTransactionRequestLike.witnesses
packages/providers/src/transaction-request/transaction-request.ts:75
▸ addCoinOutput(to, amount, assetId?): void
Adds a coin input 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. |
void
packages/providers/src/transaction-request/transaction-request.ts:339
▸ addCoinOutputs(to, quantities): void
Adds multiple coin outputs to the transaction.
| Name | Type | Description |
|---|---|---|
to | AddressLike | Address of the destination. |
quantities | CoinQuantityLike[] | Quantities of coins. |
void
packages/providers/src/transaction-request/transaction-request.ts:361
▸ addResourceInputAndOutput(resource): BaseTransactionRequest
Adds a single resource to the transaction by adding inputs and outputs.
| Name | Type |
|---|---|
resource | Resource |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:267
▸ addResourceInputsAndOutputs(resources): BaseTransactionRequest
Adds multiple resources to the transaction by adding inputs and outputs.
| Name | Type | Description |
|---|---|---|
resources | readonly Resource[] | The resources to add. |
This transaction.
packages/providers/src/transaction-request/transaction-request.ts:326
▸ calculateFee(): CoinQuantity
Return the minimum amount in native coins required to create a transaction. This is required even if the gasPrice is 0.
The minimum amount in coins required to create a transaction.
packages/providers/src/transaction-request/transaction-request.ts:398
▸ Protected getBaseTransaction(): Pick<TransactionScript | TransactionCreate, "inputsCount" | "outputsCount" | "witnessesCount" | keyof BaseTransactionRequestLike>
Method to obtain the base transaction details.
Pick<TransactionScript | TransactionCreate, "inputsCount" | "outputsCount" | "witnessesCount" | keyof BaseTransactionRequestLike>
The base transaction details.
packages/providers/src/transaction-request/transaction-request.ts:103
▸ getChangeOutputs(): ChangeTransactionRequestOutput[]
Gets the change outputs for a transaction.
ChangeTransactionRequestOutput[]
The change outputs.
packages/providers/src/transaction-request/transaction-request.ts:218
▸ getCoinInputs(): CoinTransactionRequestInput[]
Gets the coin inputs for a transaction.
The coin inputs.
packages/providers/src/transaction-request/transaction-request.ts:196
▸ getCoinOutputs(): CoinTransactionRequestOutput[]
Gets the coin outputs for a transaction.
CoinTransactionRequestOutput[]
The coin outputs.
packages/providers/src/transaction-request/transaction-request.ts:207
▸ 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:413
▸ Abstract toTransaction(): TransactionScript | TransactionCreate
TransactionScript | TransactionCreate
packages/providers/src/transaction-request/transaction-request.ts:123
▸ toTransactionBytes(): Uint8Array
Converts the transaction request to a byte array.
Uint8Array
The transaction bytes.
packages/providers/src/transaction-request/transaction-request.ts:130
▸ 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:184
▸ updateWitnessByCoinInputOwner(owner, witness): void
Updates the witness for the given CoinInput owner.
Throws
If no witness exists for the given owner.
| Name | Type | Description |
|---|---|---|
owner | AddressLike | The owner of the CoinInput. |
witness | BytesLike | The witness to update. |
void
packages/providers/src/transaction-request/transaction-request.ts:251
▸ updateWitnessByOwner(address, signature): void
Updates the witness for a given owner and signature.
| Name | Type | Description |
|---|---|---|
address | 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:170