Class: ScriptTransactionRequest
@fuel-ts/account.ScriptTransactionRequest
ScriptTransactionRequest
provides functionalities for creating a transaction request that uses a script.
Hierarchy
↳
ScriptTransactionRequest
Constructors
constructor
• new ScriptTransactionRequest(scriptTransactionRequestLike?
): ScriptTransactionRequest
Constructor for ScriptTransactionRequest
.
Parameters
Name | Type | Description |
---|---|---|
scriptTransactionRequestLike | ScriptTransactionRequestLike | The initial values for the instance. |
Returns
Overrides
BaseTransactionRequest.constructor
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:65
Properties
abis
• Optional
abis: JsonAbisFromAllCalls
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:58
gasLimit
• gasLimit: BN
Gas limit for transaction
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:52
gasPrice
• gasPrice: BN
Gas price for transaction
Inherited from
BaseTransactionRequest.gasPrice
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:97
inputs
• inputs: TransactionRequestInput
[] = []
List of inputs
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:105
maturity
• maturity: number
Block until which tx cannot be included
Inherited from
BaseTransactionRequest.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.
Inherited from
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:101
outputs
• outputs: TransactionRequestOutput
[] = []
List of outputs
Inherited from
BaseTransactionRequest.outputs
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:107
script
• script: Uint8Array
Script to execute
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:54
scriptData
• scriptData: Uint8Array
Script input data (parameters)
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:56
type
• type: Script
Type of the transaction
Overrides
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:50
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:103
witnesses
• witnesses: BytesLike
[] = []
List of witnesses
Inherited from
BaseTransactionRequest.witnesses
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:109
Methods
addAccountWitnesses
▸ addAccountWitnesses(account
): Promise
<ScriptTransactionRequest
>
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
<ScriptTransactionRequest
>
The transaction with the signature witness added.
Inherited from
BaseTransactionRequest.addAccountWitnesses
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
Inherited from
BaseTransactionRequest.addChangeOutput
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
Inherited from
BaseTransactionRequest.addCoinInput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:353
addCoinOutput
▸ addCoinOutput(to
, amount
, assetId?
): ScriptTransactionRequest
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
Inherited from
BaseTransactionRequest.addCoinOutput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:497
addCoinOutputs
▸ addCoinOutputs(to
, quantities
): ScriptTransactionRequest
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:514
addContractInputAndOutput
▸ addContractInputAndOutput(contract
): ScriptTransactionRequest
Adds a contract input and output to the transaction request.
Parameters
Name | Type | Description |
---|---|---|
contract | ContractIdLike | The contract ID. |
Returns
The current instance of the ScriptTransactionRequest
.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:180
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
Inherited from
BaseTransactionRequest.addMessageInput
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:395
addPredicateResource
▸ addPredicateResource(resource
, predicate
): ScriptTransactionRequest
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.
Inherited from
BaseTransactionRequest.addPredicateResource
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:467
addPredicateResources
▸ addPredicateResources(resources
, predicate
): ScriptTransactionRequest
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.
Inherited from
BaseTransactionRequest.addPredicateResources
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:484
addResource
▸ addResource(resource
): ScriptTransactionRequest
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:437
addResources
▸ addResources(resources
): ScriptTransactionRequest
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:454
addVariableOutputs
▸ addVariableOutputs(numberOfVariables?
): number
Adds variable outputs to the transaction request.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
numberOfVariables | number | 1 | The number of variables to add. |
Returns
number
The new length of the outputs array.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:143
calculateMaxGas
▸ calculateMaxGas(chainInfo
, minGas
): BN
Parameters
Name | Type |
---|---|
chainInfo | ChainInfo |
minGas | BN |
Returns
BN
Overrides
BaseTransactionRequest.calculateMaxGas
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:156
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
Inherited from
BaseTransactionRequest.fundWithFakeUtxos
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.
Inherited from
BaseTransactionRequest.getBaseTransaction
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.
Inherited from
BaseTransactionRequest.getChangeOutputs
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.
Inherited from
BaseTransactionRequest.getCoinInputs
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.
Inherited from
BaseTransactionRequest.getCoinOutputs
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.
Inherited from
BaseTransactionRequest.getCoinOutputsQuantities
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:640
getContractInputs
▸ getContractInputs(): ContractTransactionRequestInput
[]
Get contract inputs for the transaction.
Returns
ContractTransactionRequestInput
[]
An array of contract transaction request inputs.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:98
getContractOutputs
▸ getContractOutputs(): ContractTransactionRequestOutput
[]
Get contract outputs for the transaction.
Returns
ContractTransactionRequestOutput
[]
An array of contract transaction request outputs.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:109
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/script-transaction-request.ts:209
getVariableOutputs
▸ getVariableOutputs(): VariableTransactionRequestOutput
[]
Get variable outputs for the transaction.
Returns
VariableTransactionRequestOutput
[]
An array of variable transaction request outputs.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:120
metadataGas
▸ metadataGas(gasCosts
): BN
Parameters
Name | Type |
---|---|
gasCosts | GqlGasCosts |
Returns
BN
Overrides
BaseTransactionRequest.metadataGas
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:226
setData
▸ setData(abi
, args
): ScriptTransactionRequest
Sets the data for the transaction request.
Parameters
Name | Type | Description |
---|---|---|
abi | JsonAbi | Script JSON ABI. |
args | InputValue [] | The input arguments. |
Returns
The current instance of the ScriptTransactionRequest
.
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:220
setScript
▸ setScript<T
>(script
, data
): void
Set the script and its data.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
script | AbstractScriptRequest <T > | The abstract script request. |
data | T | The script data. |
Returns
void
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:132
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:664
toTransaction
▸ toTransaction(): TransactionScript
Converts the transaction request to a TransactionScript
.
Returns
TransactionScript
The transaction script object.
Overrides
BaseTransactionRequest.toTransaction
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:78
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:193
updatePredicateInputs
▸ updatePredicateInputs(inputs
): void
Parameters
Name | Type |
---|---|
inputs | TransactionRequestInput [] |
Returns
void
Inherited from
BaseTransactionRequest.updatePredicateInputs
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
Inherited from
BaseTransactionRequest.updateWitness
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
Inherited from
BaseTransactionRequest.updateWitnessByOwner
Defined in
packages/account/src/providers/transaction-request/transaction-request.ts:249
from
▸ from(obj
): ScriptTransactionRequest
Parameters
Name | Type |
---|---|
obj | ScriptTransactionRequestLike |
Returns
Defined in
packages/account/src/providers/transaction-request/script-transaction-request.ts:42
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:134