@fuel-ts/account v0.94.1 • Docs
Class: Predicate<TData, TConfigurables>
Predicate
provides methods to populate transaction data with predicate information and sending transactions with them.
Extends
Type Parameters
Type Parameter | Default type |
---|---|
TData extends InputValue [] | InputValue [] |
TConfigurables extends object | undefined | object |
Constructors
new Predicate()
new Predicate<
TData
,TConfigurables
>(__namedParameters
):Predicate
<TData
,TConfigurables
>
Creates an instance of the Predicate class.
Parameters
Parameter | Type |
---|---|
__namedParameters | PredicateParams <TData , TConfigurables > |
Returns
Predicate
<TData
, TConfigurables
>
Overrides
Defined in
packages/account/src/predicate/predicate.ts:59
Properties
Property | Modifier | Type | Description | Inherited from | Defined in |
---|---|---|---|---|---|
_connector? | protected | FuelConnector | The connector for use with external wallets | Account ._connector | packages/account/src/account.ts:85 |
_provider? | protected | Provider | The provider used to interact with the network. | Account ._provider | packages/account/src/account.ts:80 |
address | readonly | AbstractAddress | The address associated with the account. | Account .address | packages/account/src/account.ts:75 |
bytes | public | Uint8Array | - | - | packages/account/src/predicate/predicate.ts:46 |
interface? | public | Interface | - | - | packages/account/src/predicate/predicate.ts:48 |
predicateData | public | TData | - | - | packages/account/src/predicate/predicate.ts:47 |
Accessors
provider
get
provider():Provider
The provider used to interact with the network.
Throws
FuelError
if the provider is not set.
set
provider(provider
):void
Sets the provider for the account.
Parameters
Parameter | Type | Description |
---|---|---|
provider | Provider | A Provider instance. |
Returns
A Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:108
Methods
addBatchTransfer()
addBatchTransfer(
request
,transferParams
):ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
Parameters
Parameter | 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. |
Returns
The updated script transaction request.
Inherited from
Defined in
packages/account/src/account.ts:405
addTransfer()
addTransfer(
request
,transferParams
):ScriptTransactionRequest
Adds a transfer to the given transaction request.
Parameters
Parameter | Type | Description |
---|---|---|
request | ScriptTransactionRequest | The script transaction request to add transfers to. |
transferParams | TransferParams | The object representing the transfer to be made. |
Returns
The updated transaction request with the added transfer.
Inherited from
Defined in
packages/account/src/account.ts:387
batchTransfer()
batchTransfer(
transferParams
,txParams
):Promise
<TransactionResponse
>
Transfers multiple amounts of a token to multiple recipients.
Parameters
Parameter | Type | Description |
---|---|---|
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
Defined in
packages/account/src/account.ts:370
connect()
connect(
provider
):Provider
Changes the provider connection for the account.
Parameters
Parameter | Type | Description |
---|---|---|
provider | Provider | A Provider instance. |
Returns
The updated Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:131
createTransfer()
createTransfer(
destination
,amount
,assetId
?,txParams
?):Promise
<ScriptTransactionRequest
>
A helper that creates a transfer transaction request and returns it.
Parameters
Parameter | 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). |
Returns
Promise
<ScriptTransactionRequest
>
A promise that resolves to the prepared transaction request.
Inherited from
Defined in
packages/account/src/account.ts:332
fund()
fund<
T
>(request
,params
):Promise
<T
>
Funds a transaction request by adding the necessary resources.
Type Parameters
Type Parameter | Description |
---|---|
T extends TransactionRequest | The type of the TransactionRequest. |
Parameters
Parameter | Type | Description |
---|---|---|
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
Defined in
packages/account/src/account.ts:201
generateFakeResources()
generateFakeResources(
coins
):Resource
[]
Generates an array of fake resources based on the provided coins.
Parameters
Parameter | Type | Description |
---|---|---|
coins | FakeResources [] | An array of FakeResources objects representing the coins. |
Returns
Resource
[]
An array of Resource
objects with generated properties.
Overrides
Defined in
packages/account/src/predicate/predicate.ts:212
getBalance()
getBalance(
assetId
?):Promise
<BN
>
Retrieves the balance of the account for the given asset.
Parameters
Parameter | Type | Description |
---|---|---|
assetId ? | BytesLike | The asset ID to check the balance for (optional). |
Returns
Promise
<BN
>
A promise that resolves to the balance amount.
Inherited from
Defined in
packages/account/src/account.ts:178
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
Defined in
packages/account/src/account.ts:189
getCoins()
getCoins(
assetId
?,paginationArgs
?):Promise
<GetCoinsResponse
>
Retrieves coins owned by the account.
Parameters
Parameter | Type | Description |
---|---|---|
assetId ? | BytesLike | The asset ID of the coins to retrieve (optional). |
paginationArgs ? | CursorPaginationArgs | - |
Returns
Promise
<GetCoinsResponse
>
A promise that resolves to an array of Coins.
Inherited from
Defined in
packages/account/src/account.ts:156
getMessages()
getMessages(
paginationArgs
?):Promise
<GetMessagesResponse
>
Retrieves messages owned by the account.
Parameters
Parameter | Type |
---|---|
paginationArgs ? | CursorPaginationArgs |
Returns
Promise
<GetMessagesResponse
>
A promise that resolves to an array of Messages.
Inherited from
Defined in
packages/account/src/account.ts:168
getResourcesToSpend()
getResourcesToSpend(
quantities
,excludedIds
?):Promise
<Resource
[]>
Retrieves resources satisfying the spend query for the account.
Parameters
Parameter | Type | Description |
---|---|---|
quantities | CoinQuantityLike [] | IDs of coins to exclude. |
excludedIds ? | ExcludeResourcesOption | IDs of resources to be excluded from the query. |
Returns
Promise
<Resource
[]>
A promise that resolves to an array of Resources.
Overrides
Defined in
packages/account/src/predicate/predicate.ts:190
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
Parameter | Type | Description |
---|---|---|
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
Defined in
packages/account/src/account.ts:528
populateTransactionPredicateData()
populateTransactionPredicateData<
T
>(transactionRequestLike
):T
Populates the transaction data with predicate data.
Type Parameters
Type Parameter |
---|
T extends TransactionRequest |
Parameters
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
Returns
T
The transaction request with predicate data.
Defined in
packages/account/src/predicate/predicate.ts:87
sendTransaction()
sendTransaction(
transactionRequestLike
):Promise
<TransactionResponse
>
Sends a transaction with the populated predicate data.
Parameters
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
Returns
Promise
<TransactionResponse
>
A promise that resolves to the transaction response.
Overrides
Defined in
packages/account/src/predicate/predicate.ts:118
signTransaction()
signTransaction(
transactionRequestLike
):Promise
<string
>
Signs a transaction from the account via the connector..
Parameters
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request to sign. |
Returns
Promise
<string
>
A promise that resolves to the signature of the transaction.
Inherited from
Defined in
packages/account/src/account.ts:608
simulateTransaction()
simulateTransaction(
transactionRequestLike
):Promise
<CallResult
>
Simulates a transaction with the populated predicate data.
Parameters
Parameter | Type | Description |
---|---|---|
transactionRequestLike | TransactionRequestLike | The transaction request-like object. |
Returns
Promise
<CallResult
>
A promise that resolves to the call result.
Overrides
Defined in
packages/account/src/predicate/predicate.ts:129
transfer()
transfer(
destination
,amount
,assetId
?,txParams
?):Promise
<TransactionResponse
>
Transfers coins to a destination address.
Parameters
Parameter | 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). |
Returns
Promise
<TransactionResponse
>
A promise that resolves to the transaction response.
Inherited from
Defined in
packages/account/src/account.ts:353
transferToContract()
transferToContract(
contractId
,amount
,assetId
?,txParams
?):Promise
<TransactionResponse
>
Transfers coins to a contract address.
Parameters
Parameter | 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). |
Returns
Promise
<TransactionResponse
>
A promise that resolves to the transaction response.
Inherited from
Defined in
packages/account/src/account.ts:426
withdrawToBaseLayer()
withdrawToBaseLayer(
recipient
,amount
,txParams
):Promise
<TransactionResponse
>
Withdraws an amount of the base asset to the base chain.
Parameters
Parameter | 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). |
Returns
Promise
<TransactionResponse
>
A promise that resolves to the transaction response.
Inherited from
Defined in
packages/account/src/account.ts:479