Class: CreateTransactionRequest
@fuel-ts/account.CreateTransactionRequest
CreateTransactionRequest provides functionalities for creating a transaction request that creates a contract.
Hierarchy
↳
CreateTransactionRequest
Constructors
constructor
• new CreateTransactionRequest(createTransactionRequestLike): CreateTransactionRequest
Creates an instance CreateTransactionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
createTransactionRequestLike | CreateTransactionRequestLike | The initial values for the instance |
Returns
Overrides
BaseTransactionRequest.constructor
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:55
Properties
bytecodeWitnessIndex
• bytecodeWitnessIndex: number
Witness index of contract bytecode to create
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:44
inputs
• inputs: TransactionRequestInput[] = []
List of inputs
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:113
maturity
• Optional maturity: number
Block until which tx cannot be included
Inherited from
BaseTransactionRequest.maturity
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:107
maxFee
• maxFee: BN
The maximum fee payable by this transaction using BASE_ASSET.
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:109
outputs
• outputs: TransactionRequestOutput[] = []
List of outputs
Inherited from
BaseTransactionRequest.outputs
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:115
salt
• salt: string
Salt
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:46
storageSlots
• storageSlots: TransactionRequestStorageSlot[]
List of storage slots to initialize
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:48
tip
• Optional tip: BN
Gas price for transaction
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:105
type
• type: Create
Type of the transaction
Overrides
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:42
witnessLimit
• Optional witnessLimit: BN
The maximum amount of witness data allowed for the transaction
Inherited from
BaseTransactionRequest.witnessLimit
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:111
witnesses
• witnesses: BytesLike[] = []
List of witnesses
Inherited from
BaseTransactionRequest.witnesses
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:117
Methods
addAccountWitnesses
▸ addAccountWitnesses(account): Promise<CreateTransactionRequest>
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<CreateTransactionRequest>
The transaction with the signature witness added.
Inherited from
BaseTransactionRequest.addAccountWitnesses
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
| Name | Type | Description |
|---|---|---|
to | AddressLike | Address of the owner. |
assetId | BytesLike | Asset ID of coin. |
Returns
void
Inherited from
BaseTransactionRequest.addChangeOutput
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
| Name | Type | Description |
|---|---|---|
coin | Coin | Coin resource. |
Returns
void
Inherited from
BaseTransactionRequest.addCoinInput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:360
addCoinOutput
▸ addCoinOutput(to, amount, assetId): CreateTransactionRequest
Adds a coin output to the transaction.
Parameters
| Name | Type | Description |
|---|---|---|
to | AddressLike | Address of the owner. |
amount | BigNumberish | Amount of coin. |
assetId | BytesLike | Asset ID of coin. |
Returns
Inherited from
BaseTransactionRequest.addCoinOutput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:472
addCoinOutputs
▸ addCoinOutputs(to, quantities): CreateTransactionRequest
Adds multiple coin outputs to the transaction.
Parameters
| Name | Type | Description |
|---|---|---|
to | AddressLike | Address of the destination. |
quantities | CoinQuantityLike[] | Quantities of coins. |
Returns
Inherited from
BaseTransactionRequest.addCoinOutputs
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:489
addContractCreatedOutput
▸ addContractCreatedOutput(contractId, stateRoot): void
Adds a contract created output to the transaction request.
Parameters
| Name | Type | Description |
|---|---|---|
contractId | BytesLike | The contract ID. |
stateRoot | BytesLike | The state root. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:110
addMessageInput
▸ addMessageInput(message): void
Adds a single message input to the transaction and a change output for the asset against the message
Parameters
| Name | Type | Description |
|---|---|---|
message | MessageCoin | Message resource. |
Returns
void
Inherited from
BaseTransactionRequest.addMessageInput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:401
addResource
▸ addResource(resource): CreateTransactionRequest
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.
Inherited from
BaseTransactionRequest.addResource
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:442
addResources
▸ addResources(resources): CreateTransactionRequest
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.
Inherited from
BaseTransactionRequest.addResources
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:459
byteLength
▸ byteLength(): number
Returns
number
Inherited from
BaseTransactionRequest.byteLength
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:696
calculateMaxGas
▸ calculateMaxGas(chainInfo, minGas): BN
Parameters
| Name | Type |
|---|---|
chainInfo | ChainInfo |
minGas | BN |
Returns
BN
Inherited from
BaseTransactionRequest.calculateMaxGas
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:556
fundWithFakeUtxos
▸ fundWithFakeUtxos(quantities, baseAssetId, resourcesOwner?): CreateTransactionRequest
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
Parameters
| Name | Type | Description |
|---|---|---|
quantities | CoinQuantity[] | CoinQuantity Array. |
baseAssetId | string | The base asset to fund the transaction. |
resourcesOwner? | AbstractAddress | - |
Returns
Inherited from
BaseTransactionRequest.fundWithFakeUtxos
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:583
getBaseTransaction
▸ getBaseTransaction(): ToBaseTransactionResponse
Method to obtain the base transaction details.
Returns
ToBaseTransactionResponse
The base transaction details.
Inherited from
BaseTransactionRequest.getBaseTransaction
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.
Inherited from
BaseTransactionRequest.getChangeOutputs
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.
Inherited from
BaseTransactionRequest.getCoinInputs
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.
Inherited from
BaseTransactionRequest.getCoinOutputs
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.
Inherited from
BaseTransactionRequest.getCoinOutputsQuantities
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:634
getContractCreatedOutputs
▸ getContractCreatedOutputs(): ContractCreatedTransactionRequestOutput[]
Get contract created outputs for the transaction.
Returns
ContractCreatedTransactionRequestOutput[]
An array of contract created transaction request outputs.
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:86
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.
Overrides
BaseTransactionRequest.getTransactionId
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:100
metadataGas
▸ metadataGas(gasCosts): BN
Parameters
| Name | Type |
|---|---|
gasCosts | GasCosts |
Returns
BN
Overrides
BaseTransactionRequest.metadataGas
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:123
removeWitness
▸ removeWitness(index): void
Parameters
| Name | Type |
|---|---|
index | number |
Returns
void
Inherited from
BaseTransactionRequest.removeWitness
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.
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:658
toTransaction
▸ toTransaction(): TransactionCreate
Converts the transaction request to a TransactionCreate.
Returns
TransactionCreate
The transaction create object.
Overrides
BaseTransactionRequest.toTransaction
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:67
toTransactionBytes
▸ toTransactionBytes(): Uint8Array
Converts the transaction request to a byte array.
Returns
Uint8Array
The transaction bytes.
Inherited from
BaseTransactionRequest.toTransactionBytes
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:202
updatePredicateGasUsed
▸ updatePredicateGasUsed(inputs): void
Parameters
| Name | Type |
|---|---|
inputs | TransactionRequestInput[] |
Returns
void
Inherited from
BaseTransactionRequest.updatePredicateGasUsed
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.
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
Inherited from
BaseTransactionRequest.updateWitness
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
| 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
Inherited from
BaseTransactionRequest.updateWitnessByOwner
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:258
from
▸ from(obj): CreateTransactionRequest
Parameters
| Name | Type |
|---|---|
obj | CreateTransactionRequestLike |
Returns
Defined in
packages/account/src/providers/transaction-request/create-transaction-request.ts:34
getPolicyMeta
▸ getPolicyMeta(req): Object
Parameters
| Name | Type |
|---|---|
req | BaseTransactionRequest |
Returns
Object
| Name | Type |
|---|---|
policies | Policy[] |
policyTypes | number |
Inherited from
BaseTransactionRequest.getPolicyMeta
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:142