@fuel-ts/account v0.97.0 • Docs
Predicate provides methods to populate transaction data with predicate information and sending transactions with them.
• TData extends InputValue[] = InputValue[]
• TConfigurables extends object | undefined = object
new Predicate<
TData,TConfigurables>(__namedParameters):Predicate<TData,TConfigurables>
Creates an instance of the Predicate class.
• __namedParameters: PredicateParams <TData, TConfigurables>
Predicate <TData, TConfigurables>
packages/account/src/predicate/predicate.ts:61
protectedoptional_connector:FuelConnector
The connector for use with external wallets
packages/account/src/account.ts:93
protectedoptional_provider:Provider
The provider used to interact with the network.
packages/account/src/account.ts:88
readonlyaddress:AbstractAddress
The address associated with the account.
packages/account/src/account.ts:83
bytes:
Uint8Array
packages/account/src/predicate/predicate.ts:48
interface:
Interface
packages/account/src/predicate/predicate.ts:50
predicateData:
TData
packages/account/src/predicate/predicate.ts:49
getprovider():Provider
The provider used to interact with the network.
FuelError if the provider is not set.
setprovider(provider):void
Sets the provider for the account.
• provider: Provider
A Provider instance.
A Provider instance.
packages/account/src/account.ts:116
addBatchTransfer(
request,transferParams):ScriptTransactionRequest
Adds multiple transfers to a script transaction request.
• 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:415
addTransfer(
request,transferParams):ScriptTransactionRequest
Adds a transfer to the given transaction request.
• 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:397
batchTransfer(
transferParams,txParams):Promise<TransactionResponse>
Transfers multiple amounts of a token to multiple recipients.
• 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:380
batchTransferToContracts(
contractTransferParams,txParams):Promise<TransactionResponse>
• contractTransferParams: ContractTransferParams []
• txParams: TxParamsType = {}
Promise<TransactionResponse >
Account .batchTransferToContracts
packages/account/src/account.ts:445
connect(
provider):Provider
Changes the provider connection for the account.
• provider: Provider
A Provider instance.
The updated Provider instance.
packages/account/src/account.ts:139
createTransfer(
destination,amount,assetId?,txParams?):Promise<ScriptTransactionRequest>
A helper that creates a transfer transaction request and returns it.
• 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:342
deploy<
T>(account):Promise<object>
• T = Predicate <TData, TConfigurables>
• account: Account
The account used to pay the deployment costs.
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:
string
waitForResult: () =>
Promise<T>
Promise<T>
packages/account/src/predicate/predicate.ts:315
fund<
T>(request,params):Promise<T>
Funds a transaction request by adding the necessary resources.
• T extends TransactionRequest
The type of the TransactionRequest.
• 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:209
generateFakeResources(
coins):Resource[]
Generates an array of fake resources based on the provided coins.
• 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.
• 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:186
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:197
getCoins(
assetId?,paginationArgs?):Promise<GetCoinsResponse>
Retrieves coins owned by the account.
• 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:164
getMessages(
paginationArgs?):Promise<GetMessagesResponse>
Retrieves messages owned by the account.
• paginationArgs?: CursorPaginationArgs
Promise<GetMessagesResponse >
A promise that resolves to an array of Messages.
packages/account/src/account.ts:176
getResourcesToSpend(
quantities,excludedIds?):Promise<Resource[]>
Retrieves resources satisfying the spend query for the account.
• 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.
• 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:547
populateTransactionPredicateData<
T>(transactionRequestLike):T
Populates the transaction data with predicate data.
• T extends TransactionRequest
• transactionRequestLike: TransactionRequestLike
The transaction request-like object.
T
The transaction request with predicate data.
packages/account/src/predicate/predicate.ts:89
sendTransaction(
transactionRequestLike):Promise<TransactionResponse>
Sends a transaction with the populated predicate data.
• transactionRequestLike: TransactionRequestLike
The transaction request-like object.
Promise<TransactionResponse >
A promise that resolves to the transaction response.
packages/account/src/predicate/predicate.ts:120
signTransaction(
transactionRequestLike):Promise<string>
Signs a transaction from the account via the connector..
• transactionRequestLike: TransactionRequestLike
The transaction request to sign.
Promise<string>
A promise that resolves to the signature of the transaction.
packages/account/src/account.ts:629
simulateTransaction(
transactionRequestLike):Promise<CallResult>
Simulates a transaction with the populated predicate data.
• transactionRequestLike: TransactionRequestLike
The transaction request-like object.
Promise<CallResult >
A promise that resolves to the call result.
packages/account/src/predicate/predicate.ts:132
transfer(
destination,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a destination address.
• 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:363
transferToContract(
contractId,amount,assetId?,txParams?):Promise<TransactionResponse>
Transfers coins to a contract address.
• 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:436
withdrawToBaseLayer(
recipient,amount,txParams):Promise<TransactionResponse>
Withdraws an amount of the base asset to the base chain.
• 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.