Fuel中文社区Icon Linkgithub

⌘K

Fuel中文社区Icon Linkgithub
Docs /
Fuels Ts /
Account /
ScriptTransactionRequest

Icon LinkClass: ScriptTransactionRequest

@fuel-ts/account .ScriptTransactionRequest

ScriptTransactionRequest provides functionalities for creating a transaction request that uses a script.

Icon LinkHierarchy

Icon LinkConstructors

Icon Linkconstructor

• new ScriptTransactionRequest(scriptTransactionRequestLike?): ScriptTransactionRequest

Constructor for ScriptTransactionRequest.

Icon LinkParameters

NameTypeDescription
scriptTransactionRequestLikeScriptTransactionRequestLikeThe initial values for the instance.

Icon LinkReturns

ScriptTransactionRequest

Icon LinkOverrides

BaseTransactionRequest .constructor

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:64 Icon Link

Icon LinkProperties

Icon Linkabis

• Optional abis: JsonAbisFromAllCalls

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:57 Icon Link

Icon LinkgasLimit

• gasLimit: BN

Gas limit for transaction

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:51 Icon Link

Icon Linkinputs

• inputs: TransactionRequestInput [] = []

List of inputs

Icon LinkInherited from

BaseTransactionRequest .inputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:107 Icon Link

Icon Linkmaturity

• Optional maturity: number

Block until which tx cannot be included

Icon LinkInherited from

BaseTransactionRequest .maturity

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:101 Icon Link

Icon LinkmaxFee

• maxFee: BN

The maximum fee payable by this transaction using BASE_ASSET.

Icon LinkInherited from

BaseTransactionRequest .maxFee

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:103 Icon Link

Icon Linkoutputs

• outputs: TransactionRequestOutput [] = []

List of outputs

Icon LinkInherited from

BaseTransactionRequest .outputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:109 Icon Link

Icon Linkscript

• script: Uint8Array

Script to execute

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:53 Icon Link

Icon LinkscriptData

• scriptData: Uint8Array

Script input data (parameters)

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:55 Icon Link

Icon Linktip

• Optional tip: BN

Gas price for transaction

Icon LinkInherited from

BaseTransactionRequest .tip

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:99 Icon Link

Icon Linktype

• type: Script

Type of the transaction

Icon LinkOverrides

BaseTransactionRequest .type

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:49 Icon Link

Icon LinkwitnessLimit

• Optional witnessLimit: BN

The maximum amount of witness data allowed for the transaction

Icon LinkInherited from

BaseTransactionRequest .witnessLimit

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:105 Icon Link

Icon Linkwitnesses

• witnesses: BytesLike [] = []

List of witnesses

Icon LinkInherited from

BaseTransactionRequest .witnesses

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:111 Icon Link

Icon LinkMethods

Icon LinkaddAccountWitnesses

▸ addAccountWitnesses(account): Promise<ScriptTransactionRequest >

Helper function to add an external signature to the transaction.

Icon LinkParameters

NameTypeDescription
accountAccount | Account []The account/s to sign to the transaction.

Icon LinkReturns

Promise<ScriptTransactionRequest >

The transaction with the signature witness added.

Icon LinkInherited from

BaseTransactionRequest .addAccountWitnesses

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:280 Icon Link

Icon LinkaddChangeOutput

▸ addChangeOutput(to, assetId): void

Adds a change output to the transaction.

Icon LinkParameters

NameTypeDescription
toAddressLike Address of the owner.
assetIdBytesLike Asset ID of coin.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .addChangeOutput

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:502 Icon Link

Icon LinkaddCoinInput

▸ 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.

Icon LinkParameters

NameTypeDescription
coinCoin Coin resource.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .addCoinInput

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:354 Icon Link

Icon LinkaddCoinOutput

▸ addCoinOutput(to, amount, assetId): ScriptTransactionRequest

Adds a coin output to the transaction.

Icon LinkParameters

NameTypeDescription
toAddressLike Address of the owner.
amountBigNumberishAmount of coin.
assetIdBytesLike Asset ID of coin.

Icon LinkReturns

ScriptTransactionRequest

Icon LinkInherited from

BaseTransactionRequest .addCoinOutput

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:466 Icon Link

Icon LinkaddCoinOutputs

▸ addCoinOutputs(to, quantities): ScriptTransactionRequest

Adds multiple coin outputs to the transaction.

Icon LinkParameters

NameTypeDescription
toAddressLike Address of the destination.
quantitiesCoinQuantityLike []Quantities of coins.

Icon LinkReturns

ScriptTransactionRequest

Icon LinkInherited from

BaseTransactionRequest .addCoinOutputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:483 Icon Link

Icon LinkaddContractInputAndOutput

▸ addContractInputAndOutput(contract): ScriptTransactionRequest

Adds a contract input and output to the transaction request.

Icon LinkParameters

NameTypeDescription
contractContractIdLike The contract ID.

Icon LinkReturns

ScriptTransactionRequest

The current instance of the ScriptTransactionRequest.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:190 Icon Link

Icon LinkaddMessageInput

▸ addMessageInput(message): void

Adds a single message input to the transaction and a change output for the asset against the message

Icon LinkParameters

NameTypeDescription
messageMessageCoin Message resource.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .addMessageInput

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:395 Icon Link

Icon LinkaddResource

▸ 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.

Icon LinkParameters

NameTypeDescription
resourceResource The resource to add.

Icon LinkReturns

ScriptTransactionRequest

This transaction.

Icon LinkInherited from

BaseTransactionRequest .addResource

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:436 Icon Link

Icon LinkaddResources

▸ addResources(resources): ScriptTransactionRequest

Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.

Icon LinkParameters

NameTypeDescription
resourcesreadonly Resource []The resources to add.

Icon LinkReturns

ScriptTransactionRequest

This transaction.

Icon LinkInherited from

BaseTransactionRequest .addResources

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:453 Icon Link

Icon LinkaddVariableOutputs

▸ addVariableOutputs(numberOfVariables?): number

Adds variable outputs to the transaction request.

Icon LinkParameters

NameTypeDefault valueDescription
numberOfVariablesnumber1The number of variables to add.

Icon LinkReturns

number

The new length of the outputs array.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:142 Icon Link

Icon LinkcalculateMaxGas

▸ calculateMaxGas(chainInfo, minGas): BN

Calculates the maximum gas for the transaction.

Icon LinkParameters

NameTypeDescription
chainInfoChainInfo The chain information.
minGasBNThe minimum gas.

Icon LinkReturns

BN

the maximum gas.

Icon LinkOverrides

BaseTransactionRequest .calculateMaxGas

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:162 Icon Link

Icon LinkfundWithFakeUtxos

▸ fundWithFakeUtxos(quantities, baseAssetId, resourcesOwner?): void

Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.

Icon LinkParameters

NameTypeDescription
quantitiesCoinQuantity []CoinQuantity Array.
baseAssetIdstringThe base asset to fund the transaction.
resourcesOwner?AbstractAddress -

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .fundWithFakeUtxos

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:577 Icon Link

Icon LinkgetBaseTransaction

▸ getBaseTransaction(): ToBaseTransactionResponse

Method to obtain the base transaction details.

Icon LinkReturns

ToBaseTransactionResponse

The base transaction details.

Icon LinkInherited from

BaseTransactionRequest .getBaseTransaction

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:170 Icon Link

Icon LinkgetChangeOutputs

▸ getChangeOutputs(): ChangeTransactionRequestOutput []

Gets the change outputs for a transaction.

Icon LinkReturns

ChangeTransactionRequestOutput []

The change outputs.

Icon LinkInherited from

BaseTransactionRequest .getChangeOutputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:318 Icon Link

Icon LinkgetCoinInputs

▸ getCoinInputs(): CoinTransactionRequestInput []

Gets the coin inputs for a transaction.

Icon LinkReturns

CoinTransactionRequestInput []

The coin inputs.

Icon LinkInherited from

BaseTransactionRequest .getCoinInputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:296 Icon Link

Icon LinkgetCoinOutputs

▸ getCoinOutputs(): CoinTransactionRequestOutput []

Gets the coin outputs for a transaction.

Icon LinkReturns

CoinTransactionRequestOutput []

The coin outputs.

Icon LinkInherited from

BaseTransactionRequest .getCoinOutputs

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:307 Icon Link

Icon LinkgetCoinOutputsQuantities

▸ getCoinOutputsQuantities(): CoinQuantity []

Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.

Icon LinkReturns

CoinQuantity []

CoinQuantity array.

Icon LinkInherited from

BaseTransactionRequest .getCoinOutputsQuantities

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:626 Icon Link

Icon LinkgetContractInputs

▸ getContractInputs(): ContractTransactionRequestInput []

Get contract inputs for the transaction.

Icon LinkReturns

ContractTransactionRequestInput []

An array of contract transaction request inputs.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:97 Icon Link

Icon LinkgetContractOutputs

▸ getContractOutputs(): ContractTransactionRequestOutput []

Get contract outputs for the transaction.

Icon LinkReturns

ContractTransactionRequestOutput []

An array of contract transaction request outputs.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:108 Icon Link

Icon LinkgetTransactionId

▸ getTransactionId(chainId): string

Gets the Transaction Request by hashing the transaction.

Icon LinkParameters

NameTypeDescription
chainIdnumberThe chain ID.

Icon LinkReturns

string

  • A hash of the transaction, which is the transaction ID.

Icon LinkOverrides

BaseTransactionRequest .getTransactionId

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:219 Icon Link

Icon LinkgetVariableOutputs

▸ getVariableOutputs(): VariableTransactionRequestOutput []

Get variable outputs for the transaction.

Icon LinkReturns

VariableTransactionRequestOutput []

An array of variable transaction request outputs.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:119 Icon Link

Icon LinkmetadataGas

▸ metadataGas(gasCosts): BN

Icon LinkParameters

NameType
gasCostsGasCosts

Icon LinkReturns

BN

Icon LinkOverrides

BaseTransactionRequest.metadataGas

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:236 Icon Link

Icon LinkremoveWitness

▸ removeWitness(index): void

Icon LinkParameters

NameType
indexnumber

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .removeWitness

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:654 Icon Link

Icon LinksetData

▸ setData(abi, args): ScriptTransactionRequest

Sets the data for the transaction request.

Icon LinkParameters

NameTypeDescription
abiJsonAbiScript JSON ABI.
argsInputValue[]The input arguments.

Icon LinkReturns

ScriptTransactionRequest

The current instance of the ScriptTransactionRequest.

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:230 Icon Link

Icon LinksetScript

▸ setScript<T>(script, data): void

Set the script and its data.

Icon LinkType parameters

Name
T

Icon LinkParameters

NameTypeDescription
scriptAbstractScriptRequest<T>The abstract script request.
dataTThe script data.

Icon LinkReturns

void

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:131 Icon Link

Icon LinktoJSON

▸ toJSON(): any

Return the minimum amount in native coins required to create a transaction.

Icon LinkReturns

any

The transaction as a JSON object.

Icon LinkInherited from

BaseTransactionRequest .toJSON

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:650 Icon Link

Icon LinktoTransaction

▸ toTransaction(): TransactionScript

Converts the transaction request to a TransactionScript.

Icon LinkReturns

TransactionScript

The transaction script object.

Icon LinkOverrides

BaseTransactionRequest .toTransaction

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:77 Icon Link

Icon LinktoTransactionBytes

▸ toTransactionBytes(): Uint8Array

Converts the transaction request to a byte array.

Icon LinkReturns

Uint8Array

The transaction bytes.

Icon LinkInherited from

BaseTransactionRequest .toTransactionBytes

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:196 Icon Link

Icon LinkupdatePredicateGasUsed

▸ updatePredicateGasUsed(inputs): void

Icon LinkParameters

NameType
inputsTransactionRequestInput []

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .updatePredicateGasUsed

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:668 Icon Link

Icon LinkupdateWitness

▸ updateWitness(index, witness): void

Updates an existing witness without any side effects.

Throws

If the witness does not exist.

Icon LinkParameters

NameTypeDescription
indexnumberThe index of the witness to update.
witnessBytesLike The new witness.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .updateWitness

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:267 Icon Link

Icon LinkupdateWitnessByOwner

▸ updateWitnessByOwner(address, signature): void

Updates the witness for a given owner and signature.

Icon LinkParameters

NameTypeDescription
addressstring | AbstractAddress The address to get the coin input witness index for.
signatureBytesLike The signature to update the witness with.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest .updateWitnessByOwner

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:252 Icon Link

Icon Linkfrom

▸ from(obj): ScriptTransactionRequest

Icon LinkParameters

NameType
objScriptTransactionRequestLike

Icon LinkReturns

ScriptTransactionRequest

Icon LinkDefined in

packages/account/src/providers/transaction-request/script-transaction-request.ts:41 Icon Link

Icon LinkgetPolicyMeta

▸ getPolicyMeta(req): Object

Icon LinkParameters

NameType
reqBaseTransactionRequest

Icon LinkReturns

Object

NameType
policiesPolicy[]
policyTypesnumber

Icon LinkInherited from

BaseTransactionRequest .getPolicyMeta

Icon LinkDefined in

packages/account/src/providers/transaction-request/transaction-request.ts:136 Icon Link