@fuel-ts/account v0.96.1 • Docs
Class: Predicate<TData, TConfigurables>
Predicate provides methods to populate transaction data with predicate information and sending transactions with them.
Extends
Type Parameters
• 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
• __namedParameters: PredicateParams<TData, TConfigurables>
Returns
Predicate<TData, TConfigurables>
Overrides
Defined in
packages/account/src/predicate/predicate.ts:61
Properties
_connector?
protectedoptional_connector:FuelConnector
The connector for use with external wallets
Inherited from
Defined in
packages/account/src/account.ts:93
_provider?
protectedoptional_provider:Provider
The provider used to interact with the network.
Inherited from
Defined in
packages/account/src/account.ts:88
address
readonlyaddress:AbstractAddress
The address associated with the account.
Inherited from
Defined in
packages/account/src/account.ts:83
bytes
bytes:
Uint8Array
Defined in
packages/account/src/predicate/predicate.ts:48
interface
interface:
Interface
Defined in
packages/account/src/predicate/predicate.ts:50
predicateData
predicateData:
TData
Defined in
packages/account/src/predicate/predicate.ts:49
Accessors
provider
getprovider():Provider
The provider used to interact with the network.
Throws
FuelError if the provider is not set.
setprovider(provider):void
Sets the provider for the account.
Parameters
• provider: Provider
A Provider instance.
Returns
A Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:116
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
The updated script transaction request.
Inherited from
Defined in
packages/account/src/account.ts:415
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
The updated transaction request with the added transfer.
Inherited from
Defined in
packages/account/src/account.ts:397
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
Defined in
packages/account/src/account.ts:380
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:445
connect()
connect(
provider):Provider
Changes the provider connection for the account.
Parameters
• provider: Provider
A Provider instance.
Returns
The updated Provider instance.
Inherited from
Defined in
packages/account/src/account.ts:139
createTransfer()
createTransfer(
destination,amount,assetId?,txParams?):Promise<ScriptTransactionRequest>
A helper that creates a transfer transaction request and returns it.
Parameters
• 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:342
deploy()
deploy<
T>(account):Promise<object>
Type Parameters
• T = Predicate<TData, TConfigurables>
Parameters
• account: Account
The account used to pay the deployment costs.
Returns
Promise<object>
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.
blobId
blobId:
string
waitForResult()
waitForResult: () =>
Promise<T>
Returns
Promise<T>
Defined in
packages/account/src/predicate/predicate.ts:315
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
Defined in
packages/account/src/account.ts:209
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
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
• 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:186
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:197
getCoins()
getCoins(
assetId?,paginationArgs?):Promise<GetCoinsResponse>
Retrieves coins owned by the account.
Parameters
• 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:164
getMessages()
getMessages(
paginationArgs?):Promise<GetMessagesResponse>
Retrieves messages owned by the account.
Parameters
• paginationArgs?: CursorPaginationArgs
Returns
Promise<GetMessagesResponse>
A promise that resolves to an array of Messages.
Inherited from
Defined in
packages/account/src/account.ts:176
getResourcesToSpend()
getResourcesToSpend(
quantities,excludedIds?):Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
Parameters
• 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
• 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:547
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:89
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
Defined in
packages/account/src/predicate/predicate.ts:120
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
Defined in
packages/account/src/account.ts:629
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
Defined in
packages/account/src/predicate/predicate.ts:132
transfer()
transfer(
destination,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a destination address.
Parameters
• 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:363
transferToContract()
transferToContract(
contractId,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a contract address.
Parameters
• 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:436
withdrawToBaseLayer()
withdrawToBaseLayer(
recipient,amount,txParams):Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
Parameters
• 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:498