Class Predicate<TData, TConfigurables>

Predicate provides methods to populate transaction data with predicate information and sending transactions with them.

Type Parameters

TData extends InputValue[] = InputValue[]
TConfigurables extends {
[name: string]: unknown;
} | undefined = {
[name: string]: unknown;
}

Hierarchy (view full)

Account
- Predicate

Constructors

constructor

new Predicate<TData, TConfigurables>(__namedParameters): Predicate<TData, TConfigurables>
Creates an instance of the Predicate class.
Type Parameters
- TData extends InputValue[] = InputValue[]
- TConfigurables extends undefined | {
  [name: string]: unknown;
  } = {
  [name: string]: unknown;
  }
Parameters
- __namedParameters: PredicateParams<TData, TConfigurables>
Returns Predicate<TData, TConfigurables>
Overrides Account.constructor
- Defined in packages/account/src/predicate/predicate.ts:62

Properties

`Protected` `Optional`_connector

_connector?: FuelConnector

The connector for use with external wallets

`Protected` `Optional`_provider

_provider?: Provider

The provider used to interact with the network.

`Readonly`address

address: Address

The address associated with the account.

bytes

bytes: Uint8Array<ArrayBufferLike>

configurableConstants

configurableConstants: undefined | TConfigurables

initialBytecode

initialBytecode: Uint8Array<ArrayBufferLike>

interface

interface: Interface

predicateData

predicateData: TData = ...

Accessors

provider

get provider(): Provider
The provider used to interact with the network.

Returns Provider
A Provider instance.

Throws
FuelError if the provider is not set.
Inherited from Account.provider
- Defined in packages/account/src/account.ts:127
set provider(provider): void
Sets the provider for the account.
Parameters
- provider: Provider
  A Provider instance.
Returns void
Inherited from Account.provider
- Defined in packages/account/src/account.ts:140

Methods

addBatchTransfer

addBatchTransfer(request, transferParams): ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
Parameters
- request: ScriptTransactionRequest
  The script transaction request to add transfers to.
- transferParams: TransferParams[]
  An array of TransferParams objects representing the transfers to be made.
Returns ScriptTransactionRequest
The updated script transaction request.
Inherited from Account.addBatchTransfer
- Defined in packages/account/src/account.ts:440

addTransfer

addTransfer(request, transferParams): ScriptTransactionRequest
Adds a transfer to the given transaction request.
Parameters
- request: ScriptTransactionRequest
  The script transaction request to add transfers to.
- transferParams: TransferParams
  The object representing the transfer to be made.
Returns ScriptTransactionRequest
The updated transaction request with the added transfer.
Inherited from Account.addTransfer
- Defined in packages/account/src/account.ts:426

batchTransfer

batchTransfer(transferParams, txParams?): Promise<TransactionResponse>
Transfers multiple amounts of a token to multiple recipients.
Parameters
- transferParams: TransferParams[]
  An array of TransferParams objects representing the transfers to be made.
- txParams: TxParamsType = {}
  Optional transaction parameters.
Returns Promise<TransactionResponse>
A promise that resolves to a TransactionResponse object representing the transaction result.
Inherited from Account.batchTransfer
- Defined in packages/account/src/account.ts:409

batchTransferToContracts

batchTransferToContracts(contractTransferParams, txParams?): Promise<TransactionResponse>
Parameters
- contractTransferParams: ContractTransferParams[]
- txParams: TxParamsType = {}
Returns Promise<TransactionResponse>
Inherited from Account.batchTransferToContracts
- Defined in packages/account/src/account.ts:469

connect

connect(provider): Provider
Changes the provider connection for the account.
Parameters
- provider: Provider
  A Provider instance.
Returns Provider
The updated Provider instance.
Inherited from Account.connect
- Defined in packages/account/src/account.ts:150

createTransfer

createTransfer(destination, amount, assetId?, txParams?): Promise<ScriptTransactionRequest>
A helper that creates a transfer transaction request and returns it.
Parameters
- destination: string | Address
  The address of the destination.
- amount: BigNumberish
  The amount of coins to transfer.
- OptionalassetId: BytesLike
  The asset ID of the coins to transfer (optional).
- txParams: TxParamsType = {}
  The transaction parameters (optional).
Returns Promise<ScriptTransactionRequest>
A promise that resolves to the prepared transaction request.
Inherited from Account.createTransfer
- Defined in packages/account/src/account.ts:364

deploy

deploy<T>(account): Promise<{
blobId: string;
waitForResult: (() => Promise<T>);
}>
Type Parameters
- T = Predicate<TData, TConfigurables>
Parameters
- account: Account
  The account used to pay the deployment costs.
Returns Promise<{
blobId: string;
waitForResult: (() => Promise<T>);
}>
The blobId and a waitForResult callback that returns the deployed predicate once the blob deployment transaction finishes.

The returned loader predicate will have the same configurable constants as the original predicate which was used to generate the loader predicate.
- Defined in packages/account/src/predicate/predicate.ts:339

fund

fund<T>(request, params): Promise<T>
Funds a transaction request by adding the necessary resources.
Type Parameters
- T extends TransactionRequest
  The type of the TransactionRequest.
Parameters
- request: T
  The transaction request to fund.
- params: EstimatedTxParams
  The estimated transaction parameters.
Returns Promise<T>
A promise that resolves to the funded transaction request.
Inherited from Account.fund
- Defined in packages/account/src/account.ts:220

generateFakeResources

generateFakeResources(coins): Resource[]
Generates an array of fake resources based on the provided coins.
Parameters
- coins: FakeResources[]
  An array of FakeResources objects representing the coins.
Returns Resource[]
An array of Resource objects with generated properties.
Overrides Account.generateFakeResources
- Defined in packages/account/src/predicate/predicate.ts:236

getBalance

getBalance(assetId?): Promise<BN>
Retrieves the balance of the account for the given asset.
Parameters
- OptionalassetId: BytesLike
  The asset ID to check the balance for (optional).
Returns Promise<BN>
A promise that resolves to the balance amount.
Inherited from Account.getBalance
- Defined in packages/account/src/account.ts:197

getBalances

getBalances(): Promise<GetBalancesResponse>
Retrieves all the balances for the account.

Returns Promise<GetBalancesResponse>
A promise that resolves to an array of Coins and their quantities.
Inherited from Account.getBalances
- Defined in packages/account/src/account.ts:208

getCoins

getCoins(assetId?, paginationArgs?): Promise<GetCoinsResponse>
Retrieves coins owned by the account.
Parameters
- OptionalassetId: BytesLike
  The asset ID of the coins to retrieve (optional).
- OptionalpaginationArgs: CursorPaginationArgs
Returns Promise<GetCoinsResponse>
A promise that resolves to an array of Coins.
Inherited from Account.getCoins
- Defined in packages/account/src/account.ts:175

getMessages

getMessages(paginationArgs?): Promise<GetMessagesResponse>
Retrieves messages owned by the account.
Parameters
- OptionalpaginationArgs: CursorPaginationArgs
Returns Promise<GetMessagesResponse>
A promise that resolves to an array of Messages.
Inherited from Account.getMessages
- Defined in packages/account/src/account.ts:187

getResourcesToSpend

getResourcesToSpend(quantities, excludedIds?): Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
Parameters
- quantities: CoinQuantityLike[]
  IDs of coins to exclude.
- OptionalexcludedIds: ExcludeResourcesOption
  IDs of resources to be excluded from the query.
Returns Promise<Resource[]>
A promise that resolves to an array of Resources.
Overrides Account.getResourcesToSpend
- Defined in packages/account/src/predicate/predicate.ts:214

getTransactionCost

getTransactionCost(transactionRequestLike, transactionCostParams?): Promise<TransactionCost>
Returns a transaction cost to enable user to set gasLimit and also reserve balance amounts on the transaction.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request object.
- transactionCostParams: TransactionCostParams = {}
  The transaction cost parameters (optional).
Returns Promise<TransactionCost>
A promise that resolves to the transaction cost object.
Inherited from Account.getTransactionCost
- Defined in packages/account/src/account.ts:571

populateTransactionPredicateData

populateTransactionPredicateData<T>(transactionRequestLike): T
Populates the transaction data with predicate data.
Type Parameters
- T extends TransactionRequest
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request-like object.
Returns T
The transaction request with predicate data.
- Defined in packages/account/src/predicate/predicate.ts:92

sendTransaction

sendTransaction(transactionRequestLike): Promise<TransactionResponse>
Sends a transaction with the populated predicate data.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request-like object.
Returns Promise<TransactionResponse>
A promise that resolves to the transaction response.
Overrides Account.sendTransaction
- Defined in packages/account/src/predicate/predicate.ts:123

signTransaction

signTransaction(transactionRequestLike): Promise<string>
Signs a transaction from the account via the connector..
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request to sign.
Returns Promise<string>
A promise that resolves to the signature of the transaction.
Inherited from Account.signTransaction
- Defined in packages/account/src/account.ts:654

simulateTransaction

simulateTransaction(transactionRequestLike): Promise<CallResult>
Simulates a transaction with the populated predicate data.
Parameters
- transactionRequestLike: TransactionRequestLike
  The transaction request-like object.
Returns Promise<CallResult>
A promise that resolves to the call result.
Overrides Account.simulateTransaction
- Defined in packages/account/src/predicate/predicate.ts:137

toNewInstance

toNewInstance(overrides?): Predicate<TData, TConfigurables>
Creates a new Predicate instance from an existing Predicate instance.
Parameters
- overrides: Pick<PredicateParams<TData, TConfigurables>, "data" | "configurableConstants"> = {}
  The data and configurable constants to override.
Returns Predicate<TData, TConfigurables>
A new Predicate instance with the same bytecode, ABI and provider but with the ability to set the data and configurable constants.
- Defined in packages/account/src/predicate/predicate.ts:158

transfer

transfer(destination, amount, assetId?, txParams?): Promise<TransactionResponse>
Transfers coins to a destination address.
Parameters
- destination: string | Address
  The address of the destination.
- amount: BigNumberish
  The amount of coins to transfer.
- OptionalassetId: BytesLike
  The asset ID of the coins to transfer (optional).
- txParams: TxParamsType = {}
  The transaction parameters (optional).
Returns Promise<TransactionResponse>
A promise that resolves to the transaction response.
Inherited from Account.transfer
- Defined in packages/account/src/account.ts:392

transferToContract

transferToContract(contractId, amount, assetId, txParams?): Promise<TransactionResponse>
Transfers coins to a contract address.
Parameters
- contractId: string | Address
  The address of the contract.
- amount: BigNumberish
  The amount of coins to transfer.
- assetId: BytesLike
  The asset ID of the coins to transfer (optional).
- txParams: TxParamsType = {}
  The transaction parameters (optional).
Returns Promise<TransactionResponse>
A promise that resolves to the transaction response.
Inherited from Account.transferToContract
- Defined in packages/account/src/account.ts:460

withdrawToBaseLayer

withdrawToBaseLayer(recipient, amount, txParams?): Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
Parameters
- recipient: AddressInput
  Address of the recipient on the base chain.
- amount: BigNumberish
  Amount of base asset.
- txParams: TxParamsType = {}
  The transaction parameters (optional).
Returns Promise<TransactionResponse>
A promise that resolves to the transaction response.
Inherited from Account.withdrawToBaseLayer
- Defined in packages/account/src/account.ts:522

Class Predicate<TData, TConfigurables>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Predicate<TData, TConfigurables>

Properties

Protected Optional_connector

Protected Optional_provider

Readonlyaddress

bytes

configurableConstants

initialBytecode

interface

predicateData

Accessors

provider

Returns Provider

Throws

Parameters

Returns void

Methods

addBatchTransfer

Parameters

Returns ScriptTransactionRequest

addTransfer

Parameters

Returns ScriptTransactionRequest

batchTransfer

Parameters

Returns Promise<TransactionResponse>

batchTransferToContracts

Parameters

Returns Promise<TransactionResponse>

connect

Parameters

Returns Provider

createTransfer

Parameters

Returns Promise<ScriptTransactionRequest>

deploy

Type Parameters

Parameters

Returns Promise<{ blobId: string; waitForResult: (() => Promise<T>); }>

fund

Type Parameters

Parameters

Returns Promise<T>

generateFakeResources

Parameters

Returns Resource[]

getBalance

Parameters

Returns Promise<BN>

getBalances

Returns Promise<GetBalancesResponse>

getCoins

Parameters

Returns Promise<GetCoinsResponse>

getMessages

Parameters

Returns Promise<GetMessagesResponse>

getResourcesToSpend

Parameters

Returns Promise<Resource[]>

getTransactionCost

Parameters

Returns Promise<TransactionCost>

populateTransactionPredicateData

Type Parameters

Parameters

Returns T

sendTransaction

`Protected` `Optional`_connector

`Protected` `Optional`_provider

`Readonly`address

Returns Promise<{
blobId: string;
waitForResult: (() => Promise<T>);
}>