@fuel-ts/account .Predicate
Predicate provides methods to populate transaction data with predicate information and sending transactions with them.
| Name | Type |
|---|---|
TData | extends InputValue[] = InputValue[] |
TConfigurables | extends { [name: string]: unknown; } | undefined = { [name: string]: unknown; } |
↳ Predicate
• new Predicate<TData, TConfigurables>(«destructured»): Predicate <TData, TConfigurables>
Creates an instance of the Predicate class.
| Name | Type |
|---|---|
TData | extends InputValue[] = InputValue[] |
TConfigurables | extends undefined | { [name: string]: unknown; } = { [name: string]: unknown; } |
| Name | Type |
|---|---|
«destructured» | PredicateParams <TData, TConfigurables> |
Predicate <TData, TConfigurables>
packages/account/src/predicate/predicate.ts:59
• Protected Optional _connector: FuelConnector
The connector for use with external wallets
packages/account/src/account.ts:85
• Protected Optional _provider: Provider
The provider used to interact with the network.
packages/account/src/account.ts:80
• Readonly address: AbstractAddress
The address associated with the account.
packages/account/src/account.ts:75
• bytes: Uint8Array
packages/account/src/predicate/predicate.ts:46
• Optional interface: Interface
packages/account/src/predicate/predicate.ts:48
• predicateData: TData
packages/account/src/predicate/predicate.ts:47
• get provider(): Provider
The provider used to interact with the network.
Throws
FuelError if the provider is not set.
A Provider instance.
Account.provider
packages/account/src/account.ts:108
• set provider(provider): void
Sets the provider for the account.
| Name | Type | Description |
|---|---|---|
provider | Provider | A Provider instance. |
void
Account.provider
packages/account/src/account.ts:121
▸ addBatchTransfer(request, transferParams): ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
| Name | Type | Description |
|---|---|---|
request | ScriptTransactionRequest | The script transaction request to add transfers to. |
transferParams | TransferParams [] | An array of TransferParams objects representing the transfers to be made. |
The updated script transaction request.
packages/account/src/account.ts:405
▸ addTransfer(request, transferParams): ScriptTransactionRequest
Adds a transfer to the given transaction request.
| Name | Type | Description |
|---|---|---|
request | ScriptTransactionRequest | The script transaction request to add transfers to. |
transferParams | TransferParams | The object representing the transfer to be made. |
The updated transaction request with the added transfer.
packages/account/src/account.ts:387
▸ batchTransfer(transferParams, txParams?): Promise<TransactionResponse >
Transfers multiple amounts of a token to multiple recipients.
| Name | Type | Description |
|---|---|---|
transferParams | TransferParams [] | An array of TransferParams objects representing the transfers to be made. |
txParams | TxParamsType | Optional transaction parameters. |
Promise<TransactionResponse >
A promise that resolves to a TransactionResponse object representing the transaction result.
packages/account/src/account.ts:370
▸ connect(provider): Provider
Changes the provider connection for the account.
| Name | Type | Description |
|---|---|---|
provider | Provider | A Provider instance. |
The updated Provider instance.
packages/account/src/account.ts:131
▸ createTransfer(destination, amount, assetId?, txParams?): Promise<ScriptTransactionRequest >
A helper that creates a transfer transaction request and returns it.
| Name | Type | Description |
|---|---|---|
destination | string | AbstractAddress | The address of the destination. |
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). |
Promise<ScriptTransactionRequest >
A promise that resolves to the prepared transaction request.
packages/account/src/account.ts:332
▸ fund<T>(request, params): Promise<T>
Funds a transaction request by adding the necessary resources.
| Name | Type | Description |
|---|---|---|
T | extends TransactionRequest | The type of the TransactionRequest. |
| Name | Type | Description |
|---|---|---|
request | T | The transaction request to fund. |
params | EstimatedTxParams | The estimated transaction parameters. |
Promise<T>
A promise that resolves to the funded transaction request.
packages/account/src/account.ts:201
▸ generateFakeResources(coins): Resource []
Generates an array of fake resources based on the provided coins.
| Name | Type | Description |
|---|---|---|
coins | FakeResources [] | An array of FakeResources objects representing the coins. |
Resource []
An array of Resource objects with generated properties.
Account .generateFakeResources
packages/account/src/predicate/predicate.ts:212
▸ getBalance(assetId?): Promise<BN>
Retrieves the balance of the account for the given asset.
| Name | Type | Description |
|---|---|---|
assetId? | BytesLike | The asset ID to check the balance for (optional). |
Promise<BN>
A promise that resolves to the balance amount.
packages/account/src/account.ts:178
▸ getBalances(): Promise<GetBalancesResponse >
Retrieves all the balances for the account.
Promise<GetBalancesResponse >
A promise that resolves to an array of Coins and their quantities.
packages/account/src/account.ts:189
▸ getCoins(assetId?, paginationArgs?): Promise<GetCoinsResponse >
Retrieves coins owned by the account.
| Name | Type | Description |
|---|---|---|
assetId? | BytesLike | The asset ID of the coins to retrieve (optional). |
paginationArgs? | CursorPaginationArgs | - |
Promise<GetCoinsResponse >
A promise that resolves to an array of Coins.
packages/account/src/account.ts:156
▸ getIndexFromPlaceholderWitness(request): number
Returns the index of the witness placeholder that was added to this predicate. If no witness placeholder was added, it returns -1.
| Name | Type | Description |
|---|---|---|
request | TransactionRequest | The transaction request. |
number
The index of the witness placeholder, or -1 if there is no witness placeholder.
packages/account/src/predicate/predicate.ts:280
▸ getMessages(paginationArgs?): Promise<GetMessagesResponse >
Retrieves messages owned by the account.
| Name | Type |
|---|---|
paginationArgs? | CursorPaginationArgs |
Promise<GetMessagesResponse >
A promise that resolves to an array of Messages.
packages/account/src/account.ts:168
▸ getPredicateData(): Uint8Array
Uint8Array
packages/account/src/predicate/predicate.ts:134
▸ getResourcesToSpend(quantities, excludedIds?): Promise<Resource []>
Retrieves resources satisfying the spend query for the account.
| Name | Type | Description |
|---|---|---|
quantities | CoinQuantityLike [] | IDs of coins to exclude. |
excludedIds? | ExcludeResourcesOption | IDs of resources to be excluded from the query. |
Promise<Resource []>
A promise that resolves to an array of Resources.
packages/account/src/predicate/predicate.ts:190
▸ getTransactionCost(transactionRequestLike, transactionCostParams?): Promise<TransactionCost >
Returns a transaction cost to enable user to set gasLimit and also reserve balance amounts on the transaction.
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request object. |
transactionCostParams | TransactionCostParams | The transaction cost parameters (optional). |
Promise<TransactionCost >
A promise that resolves to the transaction cost object.
packages/account/src/account.ts:528
▸ populateTransactionPredicateData<T>(transactionRequestLike): T
Populates the transaction data with predicate data.
| Name | Type |
|---|---|
T | extends TransactionRequest |
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
T
The transaction request with predicate data.
packages/account/src/predicate/predicate.ts:87
▸ sendTransaction(transactionRequestLike): Promise<TransactionResponse >
Sends a transaction with the populated predicate data.
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/predicate/predicate.ts:118
▸ signTransaction(transactionRequestLike): Promise<string>
Signs a transaction from the account via the connector..
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to sign. |
Promise<string>
A promise that resolves to the signature of the transaction.
packages/account/src/account.ts:608
▸ simulateTransaction(transactionRequestLike): Promise<CallResult >
Simulates a transaction with the populated predicate data.
| Name | Type | Description |
|---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
Promise<CallResult >
A promise that resolves to the call result.
packages/account/src/predicate/predicate.ts:129
▸ transfer(destination, amount, assetId?, txParams?): Promise<TransactionResponse >
Transfers coins to a destination address.
| Name | Type | Description |
|---|---|---|
destination | string | AbstractAddress | The address of the destination. |
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). |
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/account.ts:353
▸ transferToContract(contractId, amount, assetId?, txParams?): Promise<TransactionResponse >
Transfers coins to a contract address.
| Name | Type | Description |
|---|---|---|
contractId | string | AbstractAddress | 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). |
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/account.ts:426
▸ withdrawToBaseLayer(recipient, amount, txParams?): Promise<TransactionResponse >
Withdraws an amount of the base asset to the base chain.
| Name | Type | Description |
|---|---|---|
recipient | string | AbstractAddress | Address of the recipient on the base chain. |
amount | BigNumberish | Amount of base asset. |
txParams | TxParamsType | The transaction parameters (optional). |
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/account.ts:479
▸ processPredicateData(bytes, jsonAbi?, configurableConstants?): Object
Processes the predicate data and returns the altered bytecode and interface.
| Name | Type | Description |
|---|---|---|
bytes | BytesLike | The bytes of the predicate. |
jsonAbi? | JsonAbi | The JSON ABI of the predicate. |
configurableConstants? | Object | Optional configurable constants for the predicate. |
Object
An object containing the new predicate bytes and interface.
| Name | Type |
|---|---|
predicateBytes | Uint8Array |
predicateInterface | undefined | Interface |
packages/account/src/predicate/predicate.ts:151
▸ setConfigurableConstants(bytes, configurableConstants, abiInterface?): Uint8Array
Sets the configurable constants for the predicate.
| Name | Type | Description |
|---|---|---|
bytes | Uint8Array | The bytes of the predicate. |
configurableConstants | Object | Configurable constants to be set. |
abiInterface? | Interface | The ABI interface of the predicate. |
Uint8Array
The mutated bytes with the configurable constants set.