Class ScriptTransactionRequest

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

Hierarchy (view full)

BaseTransactionRequest
- ScriptTransactionRequest

Constructors

constructor

new ScriptTransactionRequest(scriptTransactionRequestLike?): ScriptTransactionRequest
Constructor for ScriptTransactionRequest.
Parameters
- scriptTransactionRequestLike: ScriptTransactionRequestLike = {}
  The initial values for the instance.
Returns ScriptTransactionRequest
Overrides BaseTransactionRequest.constructor
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:64

Properties

`Optional`abis

abis?: JsonAbisFromAllCalls

`Optional`expiration

expiration?: number

The block number after which the transaction is no longer valid.

gasLimit

gasLimit: BN

Gas limit for transaction

inputs

inputs: TransactionRequestInput[] = []

List of inputs

`Optional`maturity

maturity?: number

Block until which tx cannot be included

maxFee

maxFee: BN

The maximum fee payable by this transaction using BASE_ASSET.

outputs

outputs: TransactionRequestOutput[] = []

List of outputs

script

script: Uint8Array<ArrayBufferLike>

Script to execute

scriptData

scriptData: Uint8Array<ArrayBufferLike>

Script input data (parameters)

`Optional`tip

tip?: BN

Gas price for transaction

type

type: Script = ...

Type of the transaction

`Optional`witnessLimit

witnessLimit?: BN

The maximum amount of witness data allowed for the transaction

witnesses

witnesses: BytesLike[] = []

List of witnesses

Methods

addAccountWitnesses

addAccountWitnesses(account): Promise<ScriptTransactionRequest>
Helper function to add an external signature to the transaction.
Parameters
- 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:321

addChangeOutput

addChangeOutput(to, assetId): void
Adds a change output to the transaction.
Parameters
- 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:546

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
- coin: Coin
  Coin resource.
Returns void
Inherited from BaseTransactionRequest.addCoinInput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:395

addCoinOutput

addCoinOutput(to, amount, assetId): ScriptTransactionRequest
Adds a coin output to the transaction.
Parameters
- to: AddressLike
  Address of the owner.
- amount: BigNumberish
  Amount of coin.
- assetId: BytesLike
  Asset ID of coin.
Returns ScriptTransactionRequest
Inherited from BaseTransactionRequest.addCoinOutput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:510

addCoinOutputs

addCoinOutputs(to, quantities): ScriptTransactionRequest
Adds multiple coin outputs to the transaction.
Parameters
- to: AddressLike
  Address of the destination.
- quantities: CoinQuantityLike[]
  Quantities of coins.
Returns ScriptTransactionRequest
Inherited from BaseTransactionRequest.addCoinOutputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:527

addContractInputAndOutput

addContractInputAndOutput(contract): ScriptTransactionRequest
Adds a contract input and output to the transaction request.
Parameters
- contract: ContractIdLike
  The contract ID.
Returns ScriptTransactionRequest
The current instance of the ScriptTransactionRequest.
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:211

addMessageInput

addMessageInput(message): void
Adds a single message input to the transaction and a change output for the asset against the message
Parameters
- message: Message | MessageCoin
  Message resource.
Returns void
Inherited from BaseTransactionRequest.addMessageInput
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:436

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
- resource: Resource
  The resource to add.
Returns ScriptTransactionRequest
This transaction.
Inherited from BaseTransactionRequest.addResource
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:480

addResources

addResources(resources): ScriptTransactionRequest
Adds multiple resources to the transaction by adding coin/message inputs and change outputs from the related assetIds.
Parameters
- resources: readonly Resource[]
  The resources to add.
Returns ScriptTransactionRequest
This transaction.
Inherited from BaseTransactionRequest.addResources
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:497

addVariableOutputs

addVariableOutputs(numberOfVariables?): number
Adds variable outputs to the transaction request.
Parameters
- 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:163

byteLength

byteLength(): number
Returns number
Inherited from BaseTransactionRequest.byteLength
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:732

calculateMaxGas

calculateMaxGas(chainInfo, minGas): BN
Calculates the maximum gas for the transaction.
Parameters
- chainInfo: ChainInfo
  The chain information.
- minGas: BN
  The minimum gas.
Returns BN
the maximum gas.
Overrides BaseTransactionRequest.calculateMaxGas
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:183

estimateAndFund

estimateAndFund(account, params?): Promise<ScriptTransactionRequest>
Helper function to estimate and fund the transaction request with a specified account.
Parameters
- account: Account
  The account to fund the transaction.
- params: TransactionCostParams = {}
  The parameters for the transaction cost.
Returns Promise<ScriptTransactionRequest>
The current instance of the ScriptTransactionRequest funded.
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:79

fundWithFakeUtxos

fundWithFakeUtxos(quantities, baseAssetId, resourcesOwner?): ScriptTransactionRequest
Funds the transaction with fake UTXOs for each assetId and amount in the quantities array.
Parameters
- quantities: CoinQuantity[]
  CoinQuantity Array.
- baseAssetId: string
  The base asset to fund the transaction.
- OptionalresourcesOwner: Address
Returns ScriptTransactionRequest
Deprecated
- This method is deprecated and will be removed in future versions. Please use Account.generateFakeResources along with this.addResources instead.
Inherited from BaseTransactionRequest.fundWithFakeUtxos
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:623

`Protected`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:207

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:359

getCoinInputs

getCoinInputs(): CoinTransactionRequestInput[]
Gets the coin inputs for a transaction.

Returns CoinTransactionRequestInput[]
The coin inputs.
Inherited from BaseTransactionRequest.getCoinInputs
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:337

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:348

getCoinOutputsQuantities

getCoinOutputsQuantities(): CoinQuantity[]
Retrieves an array of CoinQuantity for each coin output present in the transaction. a transaction.

Returns CoinQuantity[]
CoinQuantity array.
Inherited from BaseTransactionRequest.getCoinOutputsQuantities
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:670

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:118

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:129

getTransactionId

getTransactionId(chainId): string
Gets the Transaction Request by hashing the transaction.
Parameters
- 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:240

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:140

removeWitness

removeWitness(index): void
Parameters
- index: number
Returns void
Inherited from BaseTransactionRequest.removeWitness
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:698

setData

setData(abi, args): ScriptTransactionRequest
Sets the data for the transaction request.
Parameters
- abi: JsonAbi
  Script JSON ABI.
- args: InputValue[]
  The input arguments.
Returns ScriptTransactionRequest
The current instance of the ScriptTransactionRequest.
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:251

setScript

setScript<T>(script, data): void
Set the script and its data.
Type Parameters
- T
Parameters
- 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:152

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 BaseTransactionRequest.toJSON
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:694

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:98

toTransactionBytes

toTransactionBytes(): Uint8Array<ArrayBufferLike>
Converts the transaction request to a byte array.

Returns Uint8Array<ArrayBufferLike>
The transaction bytes.
Inherited from BaseTransactionRequest.toTransactionBytes
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:238

updatePredicateGasUsed

updatePredicateGasUsed(inputs): void
Parameters
- inputs: TransactionRequestInput[]
Returns void
Inherited from BaseTransactionRequest.updatePredicateGasUsed
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:712

updateWitness

updateWitness(index, witness): void
Updates an existing witness without any side effects.
Parameters
- index: number
  The index of the witness to update.
- witness: BytesLike
  The new witness.
Returns void
Throws
If the witness does not exist.
Inherited from BaseTransactionRequest.updateWitness
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:308

updateWitnessByOwner

updateWitnessByOwner(address, signature): void
Updates the witness for a given owner and signature.
Parameters
- address: AddressInput
  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:293

`Static`from

from(obj): ScriptTransactionRequest
Parameters
- obj: ScriptTransactionRequestLike
Returns ScriptTransactionRequest
- Defined in packages/account/src/providers/transaction-request/script-transaction-request.ts:44

`Static`getPolicyMeta

getPolicyMeta(req): {
policies: Policy[];
policyTypes: number;
}
Parameters
- req: BaseTransactionRequest
Returns {
policies: Policy[];
policyTypes: number;
}
- policies: Policy[]
- policyTypes: number
Inherited from BaseTransactionRequest.getPolicyMeta
- Defined in packages/account/src/providers/transaction-request/transaction-request.ts:168

Class ScriptTransactionRequest

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ScriptTransactionRequest

Properties

Optionalabis

Optionalexpiration

gasLimit

inputs

Optionalmaturity

maxFee

outputs

script

scriptData

Optionaltip

type

OptionalwitnessLimit

witnesses

Methods

addAccountWitnesses

Parameters

Returns Promise<ScriptTransactionRequest>

addChangeOutput

Parameters

Returns void

addCoinInput

Parameters

Returns void

addCoinOutput

Parameters

Returns ScriptTransactionRequest

addCoinOutputs

Parameters

Returns ScriptTransactionRequest

addContractInputAndOutput

Parameters

Returns ScriptTransactionRequest

addMessageInput

Parameters

Returns void

addResource

Parameters

Returns ScriptTransactionRequest

addResources

Parameters

Returns ScriptTransactionRequest

addVariableOutputs

Parameters

Returns number

byteLength

Returns number

calculateMaxGas

Parameters

Returns BN

estimateAndFund

Parameters

Returns Promise<ScriptTransactionRequest>

fundWithFakeUtxos

Parameters

Returns ScriptTransactionRequest

Deprecated

ProtectedgetBaseTransaction

Returns ToBaseTransactionResponse

getChangeOutputs

Returns ChangeTransactionRequestOutput[]

getCoinInputs

Returns CoinTransactionRequestInput[]

getCoinOutputs

Returns CoinTransactionRequestOutput[]

getCoinOutputsQuantities

Returns CoinQuantity[]

getContractInputs

Returns ContractTransactionRequestInput[]

getContractOutputs

`Optional`abis

`Optional`expiration

`Optional`maturity

`Optional`tip

`Optional`witnessLimit

`Protected`getBaseTransaction

`Static`from

`Static`getPolicyMeta

Returns {
policies: Policy[];
policyTypes: number;
}