Icon LinkClass: ScriptTransactionRequest

@fuel-ts/providers.ScriptTransactionRequest

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

Icon LinkHierarchy

Icon LinkConstructors

Icon Linkconstructor

new ScriptTransactionRequest(scriptTransactionRequestLike?)

Constructor for ScriptTransactionRequest.

Icon LinkParameters

NameTypeDescription
scriptTransactionRequestLikeScriptTransactionRequestLikeThe initial values for the instance.

Icon LinkOverrides

BaseTransactionRequest.constructor

Icon LinkDefined in

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

Icon LinkProperties

Icon LinkbytesOffset

bytesOffset: undefined | number

determined bytes offset for start of script data

Icon LinkDefined in

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


Icon LinkgasLimit

gasLimit: BN

Gas limit for transaction

Icon LinkInherited from

BaseTransactionRequest.gasLimit

Icon LinkDefined in

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


Icon LinkgasPrice

gasPrice: BN

Gas price for transaction

Icon LinkInherited from

BaseTransactionRequest.gasPrice

Icon LinkDefined in

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


Icon Linkinputs

inputs: TransactionRequestInput[] = []

List of inputs

Icon LinkInherited from

BaseTransactionRequest.inputs

Icon LinkDefined in

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


Icon Linkmaturity

maturity: number

Block until which tx cannot be included

Icon LinkInherited from

BaseTransactionRequest.maturity

Icon LinkDefined in

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


Icon Linkoutputs

outputs: TransactionRequestOutput[] = []

List of outputs

Icon LinkInherited from

BaseTransactionRequest.outputs

Icon LinkDefined in

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


Icon Linkscript

script: Uint8Array

Script to execute

Icon LinkDefined in

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


Icon LinkscriptData

scriptData: Uint8Array

Script input data (parameters)

Icon LinkDefined in

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


Icon Linktype

type: Script

Type of the transaction

Icon LinkOverrides

BaseTransactionRequest.type

Icon LinkDefined in

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


Icon Linkwitnesses

witnesses: BytesLike[] = []

List of witnesses

Icon LinkInherited from

BaseTransactionRequest.witnesses

Icon LinkDefined in

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

Icon LinkMethods

Icon LinkaddCoinOutput

addCoinOutput(to, amount, assetId?): void

Adds a coin input to the transaction.

Icon LinkParameters

NameTypeDefault valueDescription
toAddressLikeundefinedAddress of the owner.
amountBigNumberishundefinedAmount of coin.
assetIdBytesLikeBaseAssetIdAsset ID of coin.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest.addCoinOutput

Icon LinkDefined in

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


Icon LinkaddCoinOutputs

addCoinOutputs(to, quantities): void

Adds multiple coin outputs to the transaction.

Icon LinkParameters

NameTypeDescription
toAddressLikeAddress of the destination.
quantitiesCoinQuantityLike[]Quantities of coins.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest.addCoinOutputs

Icon LinkDefined in

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


Icon LinkaddContractInputAndOutput

addContractInputAndOutput(contract): ScriptTransactionRequest

Adds a contract input and output to the transaction request.

Icon LinkParameters

NameTypeDescription
contractContractIdLikeThe contract ID.

Icon LinkReturns

ScriptTransactionRequest

The current instance of the ScriptTransactionRequest.

Icon LinkDefined in

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


Icon LinkaddResourceInputAndOutput

addResourceInputAndOutput(resource): ScriptTransactionRequest

Adds a single resource to the transaction by adding inputs and outputs.

Icon LinkParameters

NameType
resourceResource

Icon LinkReturns

ScriptTransactionRequest

This transaction.

Icon LinkInherited from

BaseTransactionRequest.addResourceInputAndOutput

Icon LinkDefined in

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


Icon LinkaddResourceInputsAndOutputs

addResourceInputsAndOutputs(resources): ScriptTransactionRequest

Adds multiple resources to the transaction by adding inputs and outputs.

Icon LinkParameters

NameTypeDescription
resourcesreadonly Resource[]The resources to add.

Icon LinkReturns

ScriptTransactionRequest

This transaction.

Icon LinkInherited from

BaseTransactionRequest.addResourceInputsAndOutputs

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:326 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/providers/src/transaction-request/script-transaction-request.ts:134 Icon Link


Icon LinkcalculateFee

calculateFee(): CoinQuantity

Return the minimum amount in native coins required to create a transaction. This is required even if the gasPrice is 0.

Icon LinkReturns

CoinQuantity

The minimum amount in coins required to create a transaction.

Icon LinkInherited from

BaseTransactionRequest.calculateFee

Icon LinkDefined in

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


Icon LinkgetBaseTransaction

Protected getBaseTransaction(): Pick<TransactionScript | TransactionCreate, "inputsCount" | "outputsCount" | "witnessesCount" | keyof BaseTransactionRequestLike>

Method to obtain the base transaction details.

Icon LinkReturns

Pick<TransactionScript | TransactionCreate, "inputsCount" | "outputsCount" | "witnessesCount" | keyof BaseTransactionRequestLike>

The base transaction details.

Icon LinkInherited from

BaseTransactionRequest.getBaseTransaction

Icon LinkDefined in

packages/providers/src/transaction-request/transaction-request.ts:103 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/providers/src/transaction-request/transaction-request.ts:218 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/providers/src/transaction-request/transaction-request.ts:196 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/providers/src/transaction-request/transaction-request.ts:207 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/providers/src/transaction-request/script-transaction-request.ts:85 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/providers/src/transaction-request/script-transaction-request.ts:96 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/providers/src/transaction-request/script-transaction-request.ts:107 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/providers/src/transaction-request/script-transaction-request.ts:182 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/providers/src/transaction-request/script-transaction-request.ts:119 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/providers/src/transaction-request/transaction-request.ts:413 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/providers/src/transaction-request/script-transaction-request.ts:66 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/providers/src/transaction-request/transaction-request.ts:130 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.
witnessBytesLikeThe new witness.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest.updateWitness

Icon LinkDefined in

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


Icon LinkupdateWitnessByCoinInputOwner

updateWitnessByCoinInputOwner(owner, witness): void

Updates the witness for the given CoinInput owner.

Throws

If no witness exists for the given owner.

Icon LinkParameters

NameTypeDescription
ownerAddressLikeThe owner of the CoinInput.
witnessBytesLikeThe witness to update.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest.updateWitnessByCoinInputOwner

Icon LinkDefined in

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


Icon LinkupdateWitnessByOwner

updateWitnessByOwner(address, signature): void

Updates the witness for a given owner and signature.

Icon LinkParameters

NameTypeDescription
addressAbstractAddressThe address to get the coin input witness index for.
signatureBytesLikeThe signature to update the witness with.

Icon LinkReturns

void

Icon LinkInherited from

BaseTransactionRequest.updateWitnessByOwner

Icon LinkDefined in

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


Icon Linkfrom

Static from(obj): ScriptTransactionRequest

Icon LinkParameters

NameType
objScriptTransactionRequestLike

Icon LinkReturns

ScriptTransactionRequest

Icon LinkDefined in

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