Module: @fuel-ts/account

Enumerations

Classes

Interfaces

Type Aliases

AbiMap

Ƭ AbiMap: Record<string, JsonAbi>

Defined in

packages/account/src/providers/transaction-summary/types.ts:129

AccountEvent

Ƭ AccountEvent: Object

Event trigger when the current account on the connector is changed if the account is not authorized for the connection it should trigger with value null.

Type declaration

Name	Type
`data`	`string` \| `null`
`type`	`currentAccount`

Defined in

packages/account/src/connectors/types/events.ts:40

AccountsEvent

Ƭ AccountsEvent: Object

Event trigger when the accounts available to the connection changes.

Type declaration

Name	Type
`data`	`string`[]
`type`	`accounts`

Defined in

packages/account/src/connectors/types/events.ts:28

Asset

Ƭ Asset: Object

Type declaration

Name	Type	Description
`icon`	`string`	icon of the asset
`name`	`string`	name of the asset
`networks`	(`NetworkEthereum` \| `NetworkFuel`)[]	asset id on Fuel Network
`symbol`	`string`	description of the asset

Defined in

packages/account/src/providers/assets/types.ts:25

AssetEth

Ƭ AssetEth: Omit<Asset, "networks"> & NetworkEthereum

Defined in

packages/account/src/providers/assets/types.ts:38

AssetFuel

Ƭ AssetFuel: Omit<Asset, "networks"> & NetworkFuel

Defined in

packages/account/src/providers/assets/types.ts:39

Assets

Ƭ Assets: Asset[]

Defined in

packages/account/src/providers/assets/types.ts:36

Block

Ƭ Block: Object

A Fuel block

Type declaration

Name	Type
`height`	`BN`
`id`	`string`
`time`	`string`
`transactionIds`	`string`[]

Defined in

packages/account/src/providers/provider.ts:87

BlockHeader

Ƭ BlockHeader: Object

Type declaration

Name	Type
`applicationHash`	`string`
`consensusParametersVersion`	`number`
`daHeight`	`BN`
`eventInboxRoot`	`string`
`height`	`BN`
`id`	`string`
`messageOutboxRoot`	`string`
`messageReceiptCount`	`number`
`prevRoot`	`string`
`stateTransitionBytecodeVersion`	`number`
`time`	`string`
`transactionsCount`	`number`
`transactionsRoot`	`string`

Defined in

packages/account/src/providers/message.ts:37

BlockId

Ƭ BlockId: SuccessStatus["block"]["id"] | FailureStatus["block"]["id"]

Defined in

packages/account/src/providers/transaction-summary/types.ts:27

BurnedAsset

Ƭ BurnedAsset: MintedAsset

Defined in

packages/account/src/providers/transaction-summary/types.ts:157

CacheFor

Ƭ CacheFor: Object

Index signature

▪ [key: string]: { timeout: number ; value: unknown } | null

Defined in

packages/account/src/connectors/utils/cache.ts:3

CalculateTXFeeForSummaryParams

Ƭ CalculateTXFeeForSummaryParams: Object

Type declaration

Name	Type
`consensusParameters`	`Pick`<`ConsensusParameters`, `"gasCosts"`> & { `feeParams`: `FeeParams` ; `maxGasPerTx`: `BN` }
`gasPrice`	`BN`
`rawPayload`	`string`
`tip`	`BN`
`totalFee?`	`BN`

Defined in

packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:24

CallResult

Ƭ CallResult: Object

Type declaration

Name	Type
`dryRunStatus?`	`DryRunStatus`
`receipts`	`TransactionResultReceipt`[]

Defined in

packages/account/src/providers/provider.ts:74

ChainInfo

Ƭ ChainInfo: Object

Chain information

Type declaration

Name	Type
`baseChainHeight`	`BN`
`consensusParameters`	`ConsensusParameters`
`latestBlock`	{ `height`: `BN` ; `id`: `string` ; `time`: `string` ; `transactions`: { `id`: `string` }[] }
`latestBlock.height`	`BN`
`latestBlock.id`	`string`
`latestBlock.time`	`string`
`latestBlock.transactions`	{ `id`: `string` }[]
`name`	`string`

Defined in

packages/account/src/providers/provider.ts:154

ChangeTransactionRequestOutput

Ƭ ChangeTransactionRequestOutput: Object

Type declaration

Name	Type	Description
`assetId`	`BytesLike`	Asset ID of coins
`to`	`BytesLike`	Receiving address or script hash
`type`	`OutputType.Change`	-

Defined in

packages/account/src/providers/transaction-request/output.ts:24

Coin

Ƭ Coin: Object

A Fuel coin

Type declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`blockCreated`	`BN`
`id`	`string`
`owner`	`AbstractAddress`
`predicate?`	`BytesLike`
`predicateData?`	`BytesLike`
`txCreatedIdx`	`BN`

Defined in

packages/account/src/providers/coin.ts:7

CoinQuantity

Ƭ CoinQuantity: Object

Type declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`max?`	`BN`

Defined in

packages/account/src/providers/coin-quantity.ts:9

CoinQuantityLike

Ƭ CoinQuantityLike: [amount: BigNumberish, assetId: BytesLike, max?: BigNumberish] | { amount: BigNumberish ; assetId: BytesLike ; max?: BigNumberish }

Defined in

packages/account/src/providers/coin-quantity.ts:6

CoinTransactionRequestInput

Ƭ CoinTransactionRequestInput: Object

Type declaration

Name	Type	Description
`amount`	`BigNumberish`	Amount of coins
`assetId`	`BytesLike`	Asset ID of the coins
`id`	`BytesLike`	UTXO ID
`owner`	`BytesLike`	Owning address or script hash
`predicate?`	`BytesLike`	Predicate bytecode
`predicateData?`	`BytesLike`	Predicate input data (parameters)
`predicateGasUsed?`	`BigNumberish`	Gas used by predicate
`txPointer`	`BytesLike`	Points to the TX whose output is being spent. (TxPointer)
`type`	`InputType.Coin`	-
`witnessIndex`	`number`	Index of witness that authorizes spending the coin

Defined in

packages/account/src/providers/transaction-request/input.ts:11

CoinTransactionRequestOutput

Ƭ CoinTransactionRequestOutput: Object

Type declaration

Name	Type	Description
`amount`	`BigNumberish`	Amount of coins to send
`assetId`	`BytesLike`	Asset ID of coins
`to`	`BytesLike`	Receiving address or script hash
`type`	`OutputType.Coin`	-

Defined in

packages/account/src/providers/transaction-request/output.ts:10

ConnectorMetadata

Ƭ ConnectorMetadata: Object

Type declaration

Name	Type
`image?`	`string` \| { `dark`: `string` ; `light`: `string` }
`install`	{ `action`: `string` ; `description`: `string` ; `link`: `string` }
`install.action`	`string`
`install.description`	`string`
`install.link`	`string`

Defined in

packages/account/src/connectors/types/connector-metadata.ts:2

ConsensusParameters

Ƭ ConsensusParameters: Object

Type declaration

Name	Type
`baseAssetId`	`string`
`chainId`	`BN`
`contractParameters`	`ModifyStringToBN`<`ContractParameters`>
`feeParameters`	`ModifyStringToBN`<`FeeParameters`>
`gasCosts`	`GasCosts`
`predicateParameters`	`ModifyStringToBN`<`PredicateParameters`>
`scriptParameters`	`ModifyStringToBN`<`ScriptParameters`>
`txParameters`	`ModifyStringToBN`<`TxParameters`>
`version`	`GqlConsensusParametersVersion`

Defined in

packages/account/src/providers/provider.ts:139

ContractCreatedTransactionRequestOutput

Ƭ ContractCreatedTransactionRequestOutput: Object

Type declaration

Name	Type	Description
`contractId`	`BytesLike`	Contract ID
`stateRoot`	`BytesLike`	State Root
`type`	`OutputType.ContractCreated`	-

Defined in

packages/account/src/providers/transaction-request/output.ts:34

ContractParameters

Ƭ ContractParameters: Object

Type declaration

Name	Type
`contractMaxSize`	`Scalars`[`"U64"`][`"output"`]
`maxStorageSlots`	`Scalars`[`"U64"`][`"output"`]
`version`	`GqlContractParametersVersion`

Defined in

packages/account/src/providers/generated/operations.ts:230

ContractResult

Ƭ ContractResult: Object

Deployed Contract bytecode and contract id

Type declaration

Name	Type
`bytecode`	`string`
`id`	`string`

Defined in

packages/account/src/providers/provider.ts:121

ContractTransactionRequestInput

Ƭ ContractTransactionRequestInput: Object

Type declaration

Name	Type	Description
`contractId`	`BytesLike`	Contract ID
`txPointer`	`BytesLike`	Points to the TX whose output is being spent. (TxPointer)
`type`	`InputType.Contract`	-

Defined in

packages/account/src/providers/transaction-request/input.ts:73

ContractTransactionRequestOutput

Ƭ ContractTransactionRequestOutput: Object

Type declaration

Name	Type	Description
`inputIndex`	`number`	Index of input contract
`type`	`OutputType.Contract`	-

Defined in

packages/account/src/providers/transaction-request/output.ts:19

DeferPromise

Ƭ DeferPromise<R>: Object

Type parameters

Name	Type
`R`	`unknown`

Type declaration

Name	Type
`promise`	`Promise`<`R`>
`reject`	(`error`: `unknown`) => `void`
`resolve`	(`value`: `R`) => `void`

Defined in

packages/account/src/connectors/utils/promises.ts:5

DryRunFailureStatusFragment

Ƭ DryRunFailureStatusFragment: GqlDryRunFailureStatusFragment

Defined in

packages/account/src/providers/provider.ts:69

DryRunStatus

Ƭ DryRunStatus: DryRunFailureStatusFragment | DryRunSuccessStatusFragment

Defined in

packages/account/src/providers/provider.ts:72

DryRunSuccessStatusFragment

Ƭ DryRunSuccessStatusFragment: GqlDryRunSuccessStatusFragment

Defined in

packages/account/src/providers/provider.ts:70

EstimateTransactionParams

Ƭ EstimateTransactionParams: Object

Transaction estimation params

Type declaration

Name	Type	Description
`estimateTxDependencies?`	`boolean`	Estimate the transaction dependencies.

Defined in

packages/account/src/providers/provider.ts:328

EstimateTxDependenciesReturns

Ƭ EstimateTxDependenciesReturns: CallResult & { missingContractIds: string[] ; outputVariables: number }

Defined in

packages/account/src/providers/provider.ts:79

EstimatedTxParams

Ƭ EstimatedTxParams: Pick<TransactionCost, "estimatedPredicates" | "addedSignatures" | "requiredQuantities" | "updateMaxFee" | "gasPrice">

Defined in

packages/account/src/account.ts:60

FailureStatus

Ƭ FailureStatus: GqlFailureStatusFragment

Defined in

packages/account/src/providers/transaction-summary/types.ts:20

FakeResources

Ƭ FakeResources: Partial<Coin> & Required<Pick<Coin, "amount" | "assetId">>

Defined in

packages/account/src/account.ts:66

FeeParameters

Ƭ FeeParameters: Object

Type declaration

Name	Type
`gasPerByte`	`Scalars`[`"U64"`][`"output"`]
`gasPriceFactor`	`Scalars`[`"U64"`][`"output"`]
`version`	`GqlFeeParametersVersion`

Defined in

packages/account/src/providers/generated/operations.ts:289

FuelABI

Ƭ FuelABI: JsonAbi

ABI that represents a binary code interface from Sway.

Defined in

packages/account/src/connectors/types/data-type.ts:36

FuelConfig

Ƭ FuelConfig: Object

Type declaration

Name	Type
`connectors?`	`FuelConnector`[]
`storage?`	`StorageAbstract` \| `null`
`targetObject?`	`TargetObject`

Defined in

packages/account/src/connectors/fuel.ts:30

FuelConnectorEvents

All the events available to the connector.

Defined in

packages/account/src/connectors/types/events.ts:122

FuelConnectorEventsType

Ƭ FuelConnectorEventsType: FuelConnectorEvents["type"]

Defined in

packages/account/src/connectors/types/events.ts:132

FuelConnectorSelectOptions

Ƭ FuelConnectorSelectOptions: Object

Type declaration

Name	Type
`emitEvents?`	`boolean`

Defined in

packages/account/src/connectors/fuel.ts:36

FuelEventArg

Ƭ FuelEventArg<T>: Extract<FuelConnectorEventTypes, { type: T }>["data"]

Extract the event argument type from the event type.

Type parameters

Name	Type
`T`	extends `FuelConnectorEvents`[`"type"`]

Defined in

packages/account/src/connectors/types/events.ts:16

GasCosts

Ƭ GasCosts: Object

Type declaration

Name	Type
`add`	`Scalars`[`"U64"`][`"output"`]
`addi`	`Scalars`[`"U64"`][`"output"`]
`aloc`	`Scalars`[`"U64"`][`"output"`]
`alocDependentCost`	`GqlDependentCost`
`and`	`Scalars`[`"U64"`][`"output"`]
`andi`	`Scalars`[`"U64"`][`"output"`]
`bal`	`Scalars`[`"U64"`][`"output"`]
`bhei`	`Scalars`[`"U64"`][`"output"`]
`bhsh`	`Scalars`[`"U64"`][`"output"`]
`bldd?`	`Maybe`<`GqlDependentCost`>
`bsiz?`	`Maybe`<`GqlDependentCost`>
`burn`	`Scalars`[`"U64"`][`"output"`]
`call`	`GqlDependentCost`
`cb`	`Scalars`[`"U64"`][`"output"`]
`ccp`	`GqlDependentCost`
`cfe`	`GqlDependentCost`
`cfei`	`Scalars`[`"U64"`][`"output"`]
`cfeiDependentCost`	`GqlDependentCost`
`cfsi`	`Scalars`[`"U64"`][`"output"`]
`contractRoot`	`GqlDependentCost`
`croo`	`GqlDependentCost`
`csiz`	`GqlDependentCost`
`div`	`Scalars`[`"U64"`][`"output"`]
`divi`	`Scalars`[`"U64"`][`"output"`]
`eck1`	`Scalars`[`"U64"`][`"output"`]
`ecr1`	`Scalars`[`"U64"`][`"output"`]
`ed19`	`Scalars`[`"U64"`][`"output"`]
`ed19DependentCost`	`GqlDependentCost`
`eq`	`Scalars`[`"U64"`][`"output"`]
`exp`	`Scalars`[`"U64"`][`"output"`]
`expi`	`Scalars`[`"U64"`][`"output"`]
`flag`	`Scalars`[`"U64"`][`"output"`]
`gm`	`Scalars`[`"U64"`][`"output"`]
`gt`	`Scalars`[`"U64"`][`"output"`]
`gtf`	`Scalars`[`"U64"`][`"output"`]
`ji`	`Scalars`[`"U64"`][`"output"`]
`jmp`	`Scalars`[`"U64"`][`"output"`]
`jmpb`	`Scalars`[`"U64"`][`"output"`]
`jmpf`	`Scalars`[`"U64"`][`"output"`]
`jne`	`Scalars`[`"U64"`][`"output"`]
`jneb`	`Scalars`[`"U64"`][`"output"`]
`jnef`	`Scalars`[`"U64"`][`"output"`]
`jnei`	`Scalars`[`"U64"`][`"output"`]
`jnzb`	`Scalars`[`"U64"`][`"output"`]
`jnzf`	`Scalars`[`"U64"`][`"output"`]
`jnzi`	`Scalars`[`"U64"`][`"output"`]
`k256`	`GqlDependentCost`
`lb`	`Scalars`[`"U64"`][`"output"`]
`ldc`	`GqlDependentCost`
`log`	`Scalars`[`"U64"`][`"output"`]
`logd`	`GqlDependentCost`
`lt`	`Scalars`[`"U64"`][`"output"`]
`lw`	`Scalars`[`"U64"`][`"output"`]
`mcl`	`GqlDependentCost`
`mcli`	`GqlDependentCost`
`mcp`	`GqlDependentCost`
`mcpi`	`GqlDependentCost`
`meq`	`GqlDependentCost`
`mint`	`Scalars`[`"U64"`][`"output"`]
`mldv`	`Scalars`[`"U64"`][`"output"`]
`mlog`	`Scalars`[`"U64"`][`"output"`]
`modOp`	`Scalars`[`"U64"`][`"output"`]
`modi`	`Scalars`[`"U64"`][`"output"`]
`moveOp`	`Scalars`[`"U64"`][`"output"`]
`movi`	`Scalars`[`"U64"`][`"output"`]
`mroo`	`Scalars`[`"U64"`][`"output"`]
`mul`	`Scalars`[`"U64"`][`"output"`]
`muli`	`Scalars`[`"U64"`][`"output"`]
`newStoragePerByte`	`Scalars`[`"U64"`][`"output"`]
`noop`	`Scalars`[`"U64"`][`"output"`]
`not`	`Scalars`[`"U64"`][`"output"`]
`or`	`Scalars`[`"U64"`][`"output"`]
`ori`	`Scalars`[`"U64"`][`"output"`]
`poph`	`Scalars`[`"U64"`][`"output"`]
`popl`	`Scalars`[`"U64"`][`"output"`]
`pshh`	`Scalars`[`"U64"`][`"output"`]
`pshl`	`Scalars`[`"U64"`][`"output"`]
`ret`	`Scalars`[`"U64"`][`"output"`]
`retd`	`GqlDependentCost`
`rvrt`	`Scalars`[`"U64"`][`"output"`]
`s256`	`GqlDependentCost`
`sb`	`Scalars`[`"U64"`][`"output"`]
`scwq`	`GqlDependentCost`
`sll`	`Scalars`[`"U64"`][`"output"`]
`slli`	`Scalars`[`"U64"`][`"output"`]
`smo`	`GqlDependentCost`
`srl`	`Scalars`[`"U64"`][`"output"`]
`srli`	`Scalars`[`"U64"`][`"output"`]
`srw`	`Scalars`[`"U64"`][`"output"`]
`srwq`	`GqlDependentCost`
`stateRoot`	`GqlDependentCost`
`sub`	`Scalars`[`"U64"`][`"output"`]
`subi`	`Scalars`[`"U64"`][`"output"`]
`sw`	`Scalars`[`"U64"`][`"output"`]
`sww`	`Scalars`[`"U64"`][`"output"`]
`swwq`	`GqlDependentCost`
`time`	`Scalars`[`"U64"`][`"output"`]
`tr`	`Scalars`[`"U64"`][`"output"`]
`tro`	`Scalars`[`"U64"`][`"output"`]
`version`	`GqlGasCostsVersion`
`vmInitialization`	`GqlDependentCost`
`wdam`	`Scalars`[`"U64"`][`"output"`]
`wdcm`	`Scalars`[`"U64"`][`"output"`]
`wddv`	`Scalars`[`"U64"`][`"output"`]
`wdmd`	`Scalars`[`"U64"`][`"output"`]
`wdml`	`Scalars`[`"U64"`][`"output"`]
`wdmm`	`Scalars`[`"U64"`][`"output"`]
`wdop`	`Scalars`[`"U64"`][`"output"`]
`wqam`	`Scalars`[`"U64"`][`"output"`]
`wqcm`	`Scalars`[`"U64"`][`"output"`]
`wqdv`	`Scalars`[`"U64"`][`"output"`]
`wqmd`	`Scalars`[`"U64"`][`"output"`]
`wqml`	`Scalars`[`"U64"`][`"output"`]
`wqmm`	`Scalars`[`"U64"`][`"output"`]
`wqop`	`Scalars`[`"U64"`][`"output"`]
`xor`	`Scalars`[`"U64"`][`"output"`]
`xori`	`Scalars`[`"U64"`][`"output"`]

Defined in

packages/account/src/providers/generated/operations.ts:299

GetAssetNetworkParams

Ƭ GetAssetNetworkParams<T>: Object

Type parameters

Name	Type
`T`	extends `NetworkTypes` \| `undefined`

Type declaration

Name	Type
`asset`	`Asset`
`chainId?`	`number`
`networkType`	`T`

Defined in

packages/account/src/providers/assets/utils/network.ts:22

GetBalancesResponse

Ƭ GetBalancesResponse: Object

Type declaration

Name	Type
`balances`	`CoinQuantity`[]

Defined in

packages/account/src/providers/provider.ts:104

GetBlocksResponse

Ƭ GetBlocksResponse: Object

Type declaration

Name	Type
`blocks`	`Block`[]
`pageInfo`	`GqlPageInfo`

Defined in

packages/account/src/providers/provider.ts:113

GetCoinsResponse

Ƭ GetCoinsResponse: Object

Type declaration

Name	Type
`coins`	`Coin`[]
`pageInfo`	`GqlPageInfo`

Defined in

packages/account/src/providers/provider.ts:94

GetMessagesResponse

Ƭ GetMessagesResponse: Object

Type declaration

Name	Type
`messages`	`Message`[]
`pageInfo`	`GqlPageInfo`

Defined in

packages/account/src/providers/provider.ts:99

GetOperationParams

Ƭ GetOperationParams: { abiMap?: AbiMap ; baseAssetId: string ; maxInputs: BN ; transactionType: TransactionType } & InputOutputParam & ReceiptParam & RawPayloadParam

Defined in

packages/account/src/providers/transaction-summary/types.ts:141

GetTransactionsResponse

Ƭ GetTransactionsResponse: Object

Type declaration

Name	Type
`pageInfo`	`GqlPageInfo`
`transactions`	`Transaction`[]

Defined in

packages/account/src/providers/provider.ts:108

GqlTransaction

Ƭ GqlTransaction: NonNullable<GqlGetTransactionQuery["transaction"]>

Defined in

packages/account/src/providers/transaction-summary/types.ts:15

GraphqlTransactionStatus

Ƭ GraphqlTransactionStatus: GqlTransaction["status"]

Defined in

packages/account/src/providers/transaction-summary/types.ts:17

InputOutputParam

Ƭ InputOutputParam: InputParam & OutputParam

Defined in

packages/account/src/providers/transaction-summary/types.ts:135

InputParam

Ƭ InputParam: Object

Type declaration

Name	Type
`inputs`	`Input`[]

Defined in

packages/account/src/providers/transaction-summary/types.ts:117

JsonAbisFromAllCalls

Ƭ JsonAbisFromAllCalls: Object

Type declaration

Name	Type
`main`	`JsonAbi`
`otherContractsAbis`	`Record`<`string`, `JsonAbi`>

Defined in

packages/account/src/providers/transaction-request/types.ts:26

MerkleProof

Ƭ MerkleProof: Object

Type declaration

Name	Type
`proofIndex`	`BN`
`proofSet`	`string`[]

Defined in

packages/account/src/providers/message.ts:32

Message

Ƭ Message: Object

A Fuel message

Type declaration

Name	Type
`amount`	`BN`
`daHeight`	`BN`
`data`	`BytesLike`
`messageId`	`BytesLike`
`nonce`	`BytesLike`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Defined in

packages/account/src/providers/message.ts:10

MessageCoin

Ƭ MessageCoin: Object

Type declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`daHeight`	`BN`
`nonce`	`BytesLike`
`predicate?`	`BytesLike`
`predicateData?`	`BytesLike`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Defined in

packages/account/src/providers/message.ts:21

MessageProof

Ƭ MessageProof: Object

Message Proof

Type declaration

Name	Type
`amount`	`BN`
`blockProof`	`MerkleProof`
`commitBlockHeader`	`BlockHeader`
`data`	`string`
`messageBlockHeader`	`BlockHeader`
`messageProof`	`MerkleProof`
`nonce`	`string`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Defined in

packages/account/src/providers/message.ts:56

MessageStatus

Ƭ MessageStatus: Object

Message Status

Type declaration

Name	Type
`state`	`GqlMessageState`

Defined in

packages/account/src/providers/message.ts:71

MessageTransactionRequestInput

Ƭ MessageTransactionRequestInput: Object

Type declaration

Name	Type	Description
`amount`	`BigNumberish`	Amount of coins
`data?`	`BytesLike`	data of message
`nonce`	`BytesLike`	Unique nonce of message
`predicate?`	`BytesLike`	Predicate bytecode
`predicateData?`	`BytesLike`	Predicate input data (parameters)
`predicateGasUsed?`	`BigNumberish`	Gas used by predicate
`recipient`	`BytesLike`	Address of recipient
`sender`	`BytesLike`	Address of sender
`type`	`InputType.Message`	-
`witnessIndex`	`number`	Index of witness that authorizes the message

Defined in

packages/account/src/providers/transaction-request/input.ts:42

MnemonicPhrase

Ƭ MnemonicPhrase: string | string[]

Defined in

packages/account/src/mnemonic/utils.ts:7

Network

Ƭ Network: Object

Network

Type declaration

Name	Type	Description
`chainId`	`number`	The chain id of the network.
`url`	`string`	The name of the network.

Defined in

packages/account/src/connectors/types/data-type.ts:20

NetworkEthereum

Ƭ NetworkEthereum: Object

Type declaration

Name	Type	Description
`address?`	`string`	address of the asset contract
`chainId`	`number`	chain id of the network
`decimals`	`number`	number of decimals of the asset
`type`	`"ethereum"`	type of network

Defined in

packages/account/src/providers/assets/types.ts:1

NetworkFuel

Ƭ NetworkFuel: Object

Type declaration

Name	Type	Description
`assetId`	`string`	assetId on the Fuel Network
`chainId`	`number`	chain id of the network
`contractId?`	`string`	the contractId of that generated the Asset on the Fuel Network
`decimals`	`number`	number of decimals of the asset
`type`	`"fuel"`	type of network

Defined in

packages/account/src/providers/assets/types.ts:12

NetworkTypes

Ƭ NetworkTypes: NetworkEthereum["type"] | NetworkFuel["type"]

Defined in

packages/account/src/providers/assets/utils/network.ts:5

NodeInfo

Ƭ NodeInfo: Object

Node information

Type declaration

Name	Type
`maxDepth`	`BN`
`maxTx`	`BN`
`nodeVersion`	`string`
`utxoValidation`	`boolean`
`vmBacktrace`	`boolean`

Defined in

packages/account/src/providers/provider.ts:169

NodeInfoAndConsensusParameters

Ƭ NodeInfoAndConsensusParameters: Object

Type declaration

Name	Type
`gasPerByte`	`BN`
`gasPriceFactor`	`BN`
`maxGasPerTx`	`BN`
`nodeVersion`	`string`

Defined in

packages/account/src/providers/provider.ts:177

Operation

Ƭ Operation: Object

Type declaration

Name	Type
`assetsSent?`	`OperationCoin`[]
`calls?`	`OperationFunctionCall`[]
`from?`	`OperationTransactionAddress`
`name?`	`OperationName`
`to?`	`OperationTransactionAddress`

Defined in

packages/account/src/providers/transaction-summary/types.ts:87

OperationCoin

Ƭ OperationCoin: Object

Type declaration

Name	Type
`amount`	`BNInput`
`assetId`	`string`

Defined in

packages/account/src/providers/transaction-summary/types.ts:76

OperationFunctionCall

Ƭ OperationFunctionCall: { argumentsProvided?: Record<string, unknown> ; functionName: string ; functionSignature: string } & Partial<OperationCoin>

Defined in

packages/account/src/providers/transaction-summary/types.ts:81

OperationTransactionAddress

Ƭ OperationTransactionAddress: Object

Type declaration

Name	Type
`address`	`string`
`chain?`	`ChainName`
`type`	`AddressType`

Defined in

packages/account/src/providers/transaction-summary/types.ts:111

OutputParam

Ƭ OutputParam: Object

Type declaration

Name	Type
`outputs`	`Output`[]

Defined in

packages/account/src/providers/transaction-summary/types.ts:121

PredicateParameters

Ƭ PredicateParameters: Object

Type declaration

Name	Type
`maxGasPerPredicate`	`Scalars`[`"U64"`][`"output"`]
`maxMessageDataLength`	`Scalars`[`"U64"`][`"output"`]
`maxPredicateDataLength`	`Scalars`[`"U64"`][`"output"`]
`maxPredicateLength`	`Scalars`[`"U64"`][`"output"`]
`version`	`GqlPredicateParametersVersion`

Defined in

packages/account/src/providers/generated/operations.ts:746

PredicateParams

Ƭ PredicateParams<TData, TConfigurables>: Object

Type parameters

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

Type declaration

Name	Type
`abi?`	`JsonAbi`
`bytecode`	`BytesLike`
`configurableConstants?`	`TConfigurables`
`data?`	`TData`
`provider`	`Provider`

Defined in

packages/account/src/predicate/predicate.ts:28

ProgramState

Ƭ ProgramState: SuccessStatus["programState"]

Defined in

packages/account/src/providers/transaction-summary/types.ts:25

ProviderCallParams

Ƭ ProviderCallParams: UTXOValidationParams & EstimateTransactionParams

Provider Call transaction params

Defined in

packages/account/src/providers/provider.ts:353

ProviderOptions

Ƭ ProviderOptions: Object

Type declaration

Name	Type	Description
`fetch?`	(`url`: `string`, `requestInit?`: `RequestInit`, `providerOptions?`: `Omit`<`ProviderOptions`, `"fetch"`>) => `Promise`<`Response`>	-
`requestMiddleware?`	(`request`: `RequestInit`) => `RequestInit` \| `Promise`<`RequestInit`>	-
`resourceCacheTTL?`	`number`	Resources cache for the given time [ms]. If set to -1, the cache will be disabled.
`retryOptions?`	`RetryOptions`	Retry options to use when fetching data from the node.
`timeout?`	`number`	Timeout [ms] after which every request will be aborted.

Defined in

packages/account/src/providers/provider.ts:290

ProviderSendTxParams

Ƭ ProviderSendTxParams: EstimateTransactionParams

Provider Send transaction params

Defined in

packages/account/src/providers/provider.ts:358

RawCoin

Ƭ RawCoin: Object

Type declaration

Name	Type
`amount`	`string`
`assetId`	`string`
`blockCreated`	`string`
`owner`	`string`
`txCreatedIdx`	`string`
`utxoId`	`string`

Defined in

packages/account/src/providers/resource.ts:6

RawMessage

Ƭ RawMessage: Object

Type declaration

Name	Type
`amount`	`string`
`assetId`	`string`
`daHeight`	`string`
`data`	`string`
`nonce`	`string`
`recipient`	`string`
`sender`	`string`

Defined in

packages/account/src/providers/resource.ts:15

RawPayloadParam

Ƭ RawPayloadParam: Object

Type declaration

Name	Type
`rawPayload?`	`string`

Defined in

packages/account/src/providers/transaction-summary/types.ts:131

RawResource

Ƭ RawResource: RawCoin | RawMessage

Defined in

packages/account/src/providers/resource.ts:25

Reason

Ƭ Reason: FailureStatus["reason"]

Defined in

packages/account/src/providers/transaction-summary/types.ts:24

ReceiptParam

Ƭ ReceiptParam: Object

Type declaration

Name	Type
`receipts`	`TransactionResultReceipt`[]

Defined in

packages/account/src/providers/transaction-summary/types.ts:125

Resource

Ƭ Resource: Coin | MessageCoin

Defined in

packages/account/src/providers/resource.ts:26

ScriptParameters

Ƭ ScriptParameters: Object

Type declaration

Name	Type
`maxScriptDataLength`	`Scalars`[`"U64"`][`"output"`]
`maxScriptLength`	`Scalars`[`"U64"`][`"output"`]
`version`	`GqlScriptParametersVersion`

Defined in

packages/account/src/providers/generated/operations.ts:1031

SqueezedOutStatus

Ƭ SqueezedOutStatus: GqlSqueezedOutStatusFragment

Defined in

packages/account/src/providers/transaction-summary/types.ts:22

Status

Ƭ Status: Object

Type declaration

Name	Type
`connected`	`boolean`
`installed`	`boolean`

Defined in

packages/account/src/connectors/fuel.ts:40

SubmittedStatus

Ƭ SubmittedStatus: GqlSubmittedStatusFragment

Defined in

packages/account/src/providers/transaction-summary/types.ts:21

SuccessStatus

Ƭ SuccessStatus: GqlSuccessStatusFragment

Defined in

packages/account/src/providers/transaction-summary/types.ts:19

Time

Ƭ Time: SubmittedStatus["time"] | SuccessStatus["time"] | FailureStatus["time"]

Defined in

packages/account/src/providers/transaction-summary/types.ts:26

TransactionCost

Ƭ TransactionCost: Object

Type declaration

Name	Type
`addedSignatures`	`number`
`dryRunStatus?`	`DryRunStatus`
`estimatedPredicates`	`TransactionRequestInput`[]
`gasPrice`	`BN`
`gasUsed`	`BN`
`maxFee`	`BN`
`maxGas`	`BN`
`minFee`	`BN`
`minGas`	`BN`
`missingContractIds`	`string`[]
`outputVariables`	`number`
`receipts`	`TransactionResultReceipt`[]
`requiredQuantities`	`CoinQuantity`[]
`updateMaxFee?`	`boolean`

Defined in

packages/account/src/providers/provider.ts:185

TransactionCostParams

Ƭ TransactionCostParams: EstimateTransactionParams & { quantities?: CoinQuantity[] ; signatureCallback?: (request: ScriptTransactionRequest) => Promise<ScriptTransactionRequest> }

Defined in

packages/account/src/providers/provider.ts:335

TransactionRequest

Ƭ TransactionRequest: ScriptTransactionRequest | CreateTransactionRequest | BlobTransactionRequest

Defined in

packages/account/src/providers/transaction-request/types.ts:17

TransactionRequestInput

Ƭ TransactionRequestInput: CoinTransactionRequestInput | ContractTransactionRequestInput | MessageTransactionRequestInput

Defined in

packages/account/src/providers/transaction-request/input.ts:82

TransactionRequestLike

Ƭ TransactionRequestLike: { type: Script } & ScriptTransactionRequestLike | { type: Create } & CreateTransactionRequestLike | { type: Blob } & BlobTransactionRequestLike

Defined in

packages/account/src/providers/transaction-request/types.ts:21

TransactionRequestOutput

Ƭ TransactionRequestOutput: CoinTransactionRequestOutput | ContractTransactionRequestOutput | ChangeTransactionRequestOutput | VariableTransactionRequestOutput | ContractCreatedTransactionRequestOutput

Defined in

packages/account/src/providers/transaction-request/output.ts:41

TransactionResultBurnReceipt

Ƭ TransactionResultBurnReceipt: ReceiptBurn

Defined in

packages/account/src/providers/transaction-response/transaction-response.ts:71

TransactionResultMintReceipt

Ƭ TransactionResultMintReceipt: ReceiptMint

Defined in

packages/account/src/providers/transaction-response/transaction-response.ts:70

TransactionSummary

Ƭ TransactionSummary<TTransactionType>: Object

Type parameters

Name	Type
`TTransactionType`	`void`

Type declaration

Name	Type
`blockId?`	`BlockId`
`burnedAssets`	`BurnedAsset`[]
`date?`	`Date`
`fee`	`BN`
`gasUsed`	`BN`
`id`	`string`
`isStatusFailure`	`boolean`
`isStatusPending`	`boolean`
`isStatusSuccess`	`boolean`
`isTypeBlob`	`boolean`
`isTypeCreate`	`boolean`
`isTypeMint`	`boolean`
`isTypeScript`	`boolean`
`isTypeUpgrade`	`boolean`
`isTypeUpload`	`boolean`
`mintedAssets`	`MintedAsset`[]
`operations`	`Operation`[]
`receipts`	`TransactionResultReceipt`[]
`status?`	`TransactionStatus`
`time?`	`string`
`tip`	`BN`
`transaction`	`Transaction`<`TTransactionType`>
`type`	`TransactionTypeName`

Defined in

packages/account/src/providers/transaction-summary/types.ts:159

TransferParams

Ƭ TransferParams: Object

Type declaration

Name	Type
`amount`	`BigNumberish`
`assetId?`	`BytesLike`
`destination`	`string` \| `AbstractAddress`

Defined in

packages/account/src/account.ts:54

TxParameters

Ƭ TxParameters: Object

Type declaration

Name	Type
`maxBytecodeSubsections`	`Scalars`[`"U16"`][`"output"`]
`maxGasPerTx`	`Scalars`[`"U64"`][`"output"`]
`maxInputs`	`Scalars`[`"U16"`][`"output"`]
`maxOutputs`	`Scalars`[`"U16"`][`"output"`]
`maxSize`	`Scalars`[`"U64"`][`"output"`]
`maxWitnesses`	`Scalars`[`"U32"`][`"output"`]
`version`	`GqlTxParametersVersion`

Defined in

packages/account/src/providers/generated/operations.ts:1162

TxParamsType

Ƭ TxParamsType: Pick<ScriptTransactionRequestLike, "gasLimit" | "tip" | "maturity" | "maxFee" | "witnessLimit">

Defined in

packages/account/src/account.ts:49

UTXOValidationParams

Ƭ UTXOValidationParams: Object

UTXO validation params

Type declaration

Name	Type
`utxoValidation?`	`boolean`

Defined in

packages/account/src/providers/provider.ts:321

VariableTransactionRequestOutput

Ƭ VariableTransactionRequestOutput: Object

Type declaration

Name	Type
`type`	`OutputType.Variable`

Defined in

packages/account/src/providers/transaction-request/output.ts:31

VaultConfig

Ƭ VaultConfig: Object

Type declaration

Name	Type
`secret?`	`string`
`title?`	`string`
`type`	`string`

Defined in

packages/account/src/wallet-manager/types.ts:17

VaultsState

Ƭ VaultsState: { data?: VaultConfig ; title?: string ; type: string ; vault: Vault }[]

Defined in

packages/account/src/wallet-manager/types.ts:23

Version

Ƭ Version: Object

Version

Type declaration

Name	Type	Description
`app`	`string`	-
`network`	`string`	Version selection this allow Caret Ranges ^1.2.3 ^0.2.5 ^0.0.4 Tilde Ranges ~1.2.3 ~1.2 ~1 And Exact Versions 1.0.0

Defined in

packages/account/src/connectors/types/data-type.ts:6

WalletManagerAccount

Ƭ WalletManagerAccount: Object

Type declaration

Name	Type
`address`	`AbstractAddress`
`publicKey`	`string`
`vaultId?`	`number`

Defined in

packages/account/src/wallet-manager/types.ts:7

WalletManagerOptions

Ƭ WalletManagerOptions: Object

Type declaration

Name	Type
`storage`	`StorageAbstract`

Defined in

packages/account/src/wallet-manager/types.ts:13

Variables

BLOCKS_PAGE_SIZE_LIMIT

• Const BLOCKS_PAGE_SIZE_LIMIT: 5

Defined in

packages/account/src/providers/provider.ts:66

CHAIN_IDS

• Const CHAIN_IDS: Object

Type declaration

Name	Type
`eth`	{ `foundry`: `number` = 31337; `sepolia`: `number` = 11155111 }
`eth.foundry`	`number`
`eth.sepolia`	`number`
`fuel`	{ `devnet`: `number` = 0; `testnet`: `number` = 0 }
`fuel.devnet`	`number`
`fuel.testnet`	`number`

Defined in

packages/account/src/providers/chains.ts:1

DEFAULT_RESOURCE_CACHE_TTL

• Const DEFAULT_RESOURCE_CACHE_TTL: 20000

Defined in

packages/account/src/providers/provider.ts:67

FuelConnectorEventType

• Const FuelConnectorEventType: "FuelConnector"

Defined in

packages/account/src/connectors/types/connector-types.ts:42

MNEMONIC_SIZES

• Const MNEMONIC_SIZES: number[]

Defined in

packages/account/src/mnemonic/mnemonic.ts:20

RESOURCES_PAGE_SIZE_LIMIT

• Const RESOURCES_PAGE_SIZE_LIMIT: 512

Defined in

packages/account/src/providers/provider.ts:65

assets

• Const assets: { icon: string ; name: string ; networks: (NetworkEthereum | NetworkFuel)[] ; symbol: string }[]

Defined in

packages/account/src/providers/assets/assets.ts:38

english

• Const english: string[]

Defined in

packages/account/src/wordlists/words/english.ts:1

fuelAssetsBaseUrl

• Const fuelAssetsBaseUrl: "https://cdn.fuel.network/assets/"

Defined in

packages/account/src/providers/assets/utils/fuelAssetsBaseUrl.ts:1

rawAssets

• Const rawAssets: Assets

Defined in

packages/account/src/providers/assets/assets.ts:6

Functions

addAmountToCoinQuantities

▸ addAmountToCoinQuantities(params): CoinQuantity[]

Parameters

Name	Type
`params`	`IAddAmountToAssetParams`

Returns

CoinQuantity[]

Defined in

packages/account/src/providers/coin-quantity.ts:40

assemblePanicError

▸ assemblePanicError(statusReason, metadata): FuelError

Assembles an error message for a panic status.

Parameters

Name	Type
`statusReason`	`string`
`metadata`	`Record`<`string`, `unknown`>

Returns

FuelError

The error message.

Defined in

packages/account/src/providers/utils/extract-tx-error.ts:22

assembleReceiptByType

Parameters

Name	Type
`receipt`	`GqlReceiptFragment`

Returns

Defined in

packages/account/src/providers/utils/receipts.ts:69

assembleRevertError

▸ assembleRevertError(receipts, logs, metadata): FuelError

Assembles an error message for a revert status.

Parameters

Name	Type	Description
`receipts`	`TransactionResultReceipt`[]	The transaction result processed receipts.
`logs`	`unknown`[]	The transaction decoded logs.
`metadata`	`Record`<`string`, `unknown`>	-

Returns

FuelError

The error message.

Defined in

packages/account/src/providers/utils/extract-tx-error.ts:47

cacheFor

▸ cacheFor<F>(fn, «destructured»): F

Type parameters

Name	Type
`F`	extends (...`args`: `unknown`[]) => `Promise`<`unknown`>

Parameters

Name	Type
`fn`	`F`
`«destructured»`	`CacheForOptions`

Returns

F

Defined in

packages/account/src/connectors/utils/cache.ts:16

cacheRequestInputsResources

▸ cacheRequestInputsResources(inputs): Required<ExcludeResourcesOption>

Parameters

Name	Type
`inputs`	`TransactionRequestInput`[]

Returns

Required<ExcludeResourcesOption>

Defined in

packages/account/src/providers/transaction-request/helpers.ts:52

cacheRequestInputsResourcesFromOwner

▸ cacheRequestInputsResourcesFromOwner(inputs, owner): ExcludeResourcesOption

Parameters

Name	Type
`inputs`	`TransactionRequestInput`[]
`owner`	`AbstractAddress`

Returns

ExcludeResourcesOption

Defined in

packages/account/src/providers/transaction-request/helpers.ts:68

calculateGasFee

▸ calculateGasFee(params): BN

Parameters

Name	Type
`params`	`CalculateGasFeeParams`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:183

calculateMetadataGasForTxBlob

▸ calculateMetadataGasForTxBlob(«destructured»): BN

Parameters

Name	Type
`«destructured»`	`Object`
› `gasCosts`	`GasCosts`
› `txBytesSize`	`number`
› `witnessBytesSize`	`number`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:162

calculateMetadataGasForTxCreate

▸ calculateMetadataGasForTxCreate(«destructured»): BN

Parameters

Name	Type
`«destructured»`	`Object`
› `contractBytesSize`	`BN`
› `gasCosts`	`GasCosts`
› `stateRootSize`	`number`
› `txBytesSize`	`number`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:131

calculateMetadataGasForTxScript

▸ calculateMetadataGasForTxScript(«destructured»): BN

Parameters

Name	Type
`«destructured»`	`Object`
› `gasCosts`	`GasCosts`
› `txBytesSize`	`number`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:152

calculateTXFeeForSummary

▸ calculateTXFeeForSummary(params): BN

Parameters

Name	Type
`params`	`CalculateTXFeeForSummaryParams`

Returns

BN

Defined in

packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:35

deferPromise

▸ deferPromise<R>(): DeferPromise<R>

Type parameters

Name	Type
`R`	`unknown`

Returns

DeferPromise<R>

Defined in

packages/account/src/connectors/utils/promises.ts:11

dispatchFuelConnectorEvent

▸ dispatchFuelConnectorEvent(connector): void

Fuel Connector Event is a custom event that can be used by the connector to inform the Fuel Connector Manager that a new connector is available.

Parameters

Name	Type
`connector`	`FuelConnector`

Returns

void

Defined in

packages/account/src/connectors/utils/dispatch-fuel-connector-event.ts:8

extractBurnedAssetsFromReceipts

▸ extractBurnedAssetsFromReceipts(receipts): MintedAsset[]

Parameters

Name	Type
`receipts`	`TransactionResultReceipt`[]

Returns

MintedAsset[]

Defined in

packages/account/src/providers/transaction-summary/receipt.ts:49

extractMintedAssetsFromReceipts

▸ extractMintedAssetsFromReceipts(receipts): MintedAsset[]

Parameters

Name	Type
`receipts`	`TransactionResultReceipt`[]

Returns

MintedAsset[]

Defined in

packages/account/src/providers/transaction-summary/receipt.ts:30

extractTxError

▸ extractTxError(params): FuelError

Extracts the transaction error and returns a FuelError object.

Parameters

Name	Type
`params`	`IExtractTxError`

Returns

FuelError

The FuelError object.

Defined in

packages/account/src/providers/utils/extract-tx-error.ts:126

gasUsedByInputs

▸ gasUsedByInputs(inputs, txBytesSize, gasCosts): BN

Parameters

Name	Type
`inputs`	(`TransactionRequestInput` \| `Input`)[]
`txBytesSize`	`number`
`gasCosts`	`GasCosts`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:40

getAssetAmountInRequestInputs

▸ getAssetAmountInRequestInputs(inputs, assetId, baseAsset): BN

Parameters

Name	Type
`inputs`	`TransactionRequestInput`[]
`assetId`	`string`
`baseAsset`	`string`

Returns

BN

Defined in

packages/account/src/providers/transaction-request/helpers.ts:35

getAssetEth

▸ getAssetEth(asset, chainId?): undefined | AssetEth

Returns the asset's details on Ethereum

Parameters

Name	Type
`asset`	`Asset`
`chainId?`	`number`

Returns

undefined | AssetEth

Defined in

packages/account/src/providers/assets/utils/network.ts:80

getAssetFuel

▸ getAssetFuel(asset, chainId?): undefined | AssetFuel

Returns the asset's details on Fuel

Parameters

Name	Type
`asset`	`Asset`
`chainId?`	`number`

Returns

undefined | AssetFuel

Defined in

packages/account/src/providers/assets/utils/network.ts:90

getAssetNetwork

▸ getAssetNetwork<T>(«destructured»): NetworkTypeToNetwork<T>

Returns the asset's network on the given network eg. getAssetNetwork({ asset, chainId: 1, networkType: 'ethereum' }) will return the asset's details on Ethereum mainnet

Type parameters

Name	Type
`T`	extends `undefined` \| `NetworkTypes`

Parameters

Name	Type
`«destructured»`	`GetAssetNetworkParams`<`T`>

Returns

NetworkTypeToNetwork<T>

Defined in

packages/account/src/providers/assets/utils/network.ts:32

getAssetWithNetwork

▸ getAssetWithNetwork<T>(«destructured»): undefined | AssetEth | AssetFuel

Returns the asset's details on the given network alongwith the asset itself eg. getAssetWithNetwork({ asset, chainId: 1, networkType: 'ethereum' }) will return the asset's details on Ethereum mainnet and the asset itself

Type parameters

Name	Type
`T`	extends `NetworkTypes`

Parameters

Name	Type
`«destructured»`	`GetAssetNetworkParams`<`T`>

Returns

undefined | AssetEth | AssetFuel

Defined in

packages/account/src/providers/assets/utils/network.ts:48

getDefaultChainId

▸ getDefaultChainId(networkType): undefined | number

Returns the default chainId for the given network

Parameters

Name	Type
`networkType`	`NetworkTypes`

Returns

undefined | number

Defined in

packages/account/src/providers/assets/utils/network.ts:11

getMaxGas

▸ getMaxGas(params): BN

Parameters

Name	Type
`params`	`IGetMaxGasParams`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:110

getMinGas

▸ getMinGas(params): BN

Parameters

Name	Type
`params`	`IGetMinGasParams`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:88

getRequestInputResourceOwner

▸ getRequestInputResourceOwner(input): BytesLike

Parameters

Name	Type
`input`	`CoinTransactionRequestInput` \| `MessageTransactionRequestInput`

Returns

BytesLike

Defined in

packages/account/src/providers/transaction-request/helpers.ts:26

getTransactionSummary

▸ getTransactionSummary<TTransactionType>(params): Promise<TransactionResult>

Type parameters

Name	Type
`TTransactionType`	`void`

Parameters

Name	Type
`params`	`GetTransactionSummaryParams`

Returns

Promise<TransactionResult>

Defined in

packages/account/src/providers/transaction-summary/get-transaction-summary.ts:26

isRequestInputCoin

▸ isRequestInputCoin(input): input is CoinTransactionRequestInput

Parameters

Name	Type
`input`	`TransactionRequestInput`

Returns

input is CoinTransactionRequestInput

Defined in

packages/account/src/providers/transaction-request/helpers.ts:13

isRequestInputMessage

▸ isRequestInputMessage(input): input is MessageTransactionRequestInput

Parameters

Name	Type
`input`	`TransactionRequestInput`

Returns

input is MessageTransactionRequestInput

Defined in

packages/account/src/providers/transaction-request/helpers.ts:17

isRequestInputResource

▸ isRequestInputResource(input): input is CoinTransactionRequestInput | MessageTransactionRequestInput

Parameters

Name	Type
`input`	`TransactionRequestInput`

Returns

input is CoinTransactionRequestInput | MessageTransactionRequestInput

Defined in

packages/account/src/providers/transaction-request/helpers.ts:21

isRequestInputResourceFromOwner

▸ isRequestInputResourceFromOwner(input, owner): boolean

Parameters

Name	Type
`input`	`CoinTransactionRequestInput` \| `MessageTransactionRequestInput`
`owner`	`AbstractAddress`

Returns

boolean

Defined in

packages/account/src/providers/transaction-request/helpers.ts:30

processGqlReceipt

▸ processGqlReceipt(gqlReceipt): TransactionResultReceipt

Parameters

Name	Type
`gqlReceipt`	`GqlReceiptFragment`

Returns

TransactionResultReceipt

Defined in

packages/account/src/providers/transaction-summary/receipt.ts:9

resolveGasDependentCosts

▸ resolveGasDependentCosts(byteSize, gasDependentCost): BN

Parameters

Name	Type
`byteSize`	`BNInput`
`gasDependentCost`	`GqlDependentCost`

Returns

BN

Defined in

packages/account/src/providers/utils/gas.ts:29

resolveIconPaths

▸ resolveIconPaths(assets, basePath?): { icon: string ; name: string ; networks: (NetworkEthereum | NetworkFuel)[] ; symbol: string }[]

Returns the list of assets with the icon paths 'resolved'. eg. ./eth.svg -> https://some-url.com/eth.svg

Parameters

Name	Type	Default value	Description
`assets`	`Assets`	`undefined`	List of assets
`basePath`	`string`	`'./'`	Base path for the icon URLs (default: './')

Returns

{ icon: string ; name: string ; networks: (NetworkEthereum | NetworkFuel)[] ; symbol: string }[]

The assets with the icon paths resolved

Defined in

packages/account/src/providers/assets/utils/resolveIconPaths.ts:11

urlJoin

▸ urlJoin(baseUrl, ...paths): string

Parameters

Name	Type
`baseUrl`	`undefined` \| `string`
`...paths`	`string`[]

Returns

string

Defined in

packages/account/src/providers/assets/utils/url.ts:5

withTimeout

▸ withTimeout<F, RT>(promise, timeout?): Promise<RT>

Type parameters

Name	Type
`F`	extends `Promise`<`unknown`>
`RT`	`Awaited`<`F`>

Parameters

Name	Type	Default value
`promise`	`F`	`undefined`
`timeout`	`number`	`1050`

Returns

Promise<RT>

Defined in

packages/account/src/connectors/utils/promises.ts:23

Events

AssetsEvent

Ƭ AssetsEvent: Object

Event trigger when the assets list of metadata changed.

AssetsEvent

Type declaration

Name	Type
`data`	`Asset`[]
`type`	`assets`

Defined in

packages/account/src/connectors/types/events.ts:114

ConnectionEvent

Ƭ ConnectionEvent: Object

Event trigger when connection status changes. With the new connection status.

ConnectionEvent

Type declaration

Name	Type
`data`	`boolean`
`type`	`connection`

Defined in

packages/account/src/connectors/types/events.ts:52

ConnectorEvent

Ƭ ConnectorEvent: Object

Event trigger when the current connector has changed.

ConnectorEvent

Type declaration

Name	Type
`data`	`FuelConnector`
`type`	`currentConnector`

Defined in

packages/account/src/connectors/types/events.ts:102

ConnectorsEvent

Ƭ ConnectorsEvent: Object

Event trigger when the list of connectors has changed.

ConnectorsEvent

Type declaration

Name	Type
`data`	`FuelConnector`[]
`type`	`connectors`

Defined in

packages/account/src/connectors/types/events.ts:90

NetworkEvent

Ƭ NetworkEvent: Object

Event trigger when the network selected on the connector is changed. It should trigger even if the network is not available for the connection.

NetworkEvent

Type declaration

Name	Type
`data`	`Network`
`type`	`currentNetwork`

Defined in

packages/account/src/connectors/types/events.ts:65

NetworksEvent

Ƭ NetworksEvent: Object

Event trigger when the network selected on the connector is changed. It should trigger even if the network is not available for the connection.

NetworksEvent

Type declaration

Name	Type
`data`	`Network`
`type`	`networks`

Defined in

packages/account/src/connectors/types/events.ts:78

Account

Address

Contract

Interfaces

Program

Script

Utils

Module: @fuel-ts/account ​

Enumerations ​

Classes ​

Interfaces ​

Type Aliases ​

AbiMap ​

Defined in ​

AccountEvent ​

Type declaration ​

Defined in ​

AccountsEvent ​

Type declaration ​

Defined in ​

Asset ​

Type declaration ​

Defined in ​

AssetEth ​

Defined in ​

AssetFuel ​

Defined in ​

Assets ​

Defined in ​

Block ​

Type declaration ​

Defined in ​

BlockHeader ​

Type declaration ​

Defined in ​

BlockId ​

Defined in ​

BurnedAsset ​

Defined in ​

CacheFor ​

Index signature ​

Defined in ​

CalculateTXFeeForSummaryParams ​

Type declaration ​

Defined in ​

CallResult ​

Type declaration ​

Defined in ​

ChainInfo ​

Type declaration ​

Defined in ​

ChangeTransactionRequestOutput ​

Type declaration ​

Defined in ​

Coin ​

Type declaration ​

Defined in ​

CoinQuantity ​

Type declaration ​

Defined in ​

CoinQuantityLike ​

Defined in ​

CoinTransactionRequestInput ​

Type declaration ​

Defined in ​

CoinTransactionRequestOutput ​

Type declaration ​

Defined in ​

ConnectorMetadata ​

Type declaration ​

Defined in ​

ConsensusParameters ​

Type declaration ​

Defined in ​

ContractCreatedTransactionRequestOutput ​

Type declaration ​

Defined in ​

ContractParameters ​

Type declaration ​

Defined in ​

Module: @fuel-ts/account

Enumerations

Classes

Interfaces

Type Aliases

AbiMap

Defined in

AccountEvent

Type declaration

Defined in

AccountsEvent

Type declaration

Defined in

Asset

Type declaration

Defined in

AssetEth

Defined in

AssetFuel

Defined in

Assets

Defined in

Block

Type declaration

Defined in

BlockHeader

Type declaration

Defined in

BlockId

Defined in

BurnedAsset

Defined in

CacheFor

Index signature

Defined in

CalculateTXFeeForSummaryParams

Type declaration

Defined in

CallResult

Type declaration

Defined in

ChainInfo

Type declaration

Defined in

ChangeTransactionRequestOutput

Type declaration

Defined in

Coin

Type declaration

Defined in

CoinQuantity

Type declaration

Defined in

CoinQuantityLike

Defined in

CoinTransactionRequestInput

Type declaration

Defined in

CoinTransactionRequestOutput

Type declaration

Defined in

ConnectorMetadata

Type declaration

Defined in

ConsensusParameters

Type declaration

Defined in

ContractCreatedTransactionRequestOutput

Type declaration

Defined in

ContractParameters

Type declaration

Defined in

ContractResult

Type declaration

Defined in

ContractTransactionRequestInput

Type declaration

Defined in

ContractTransactionRequestOutput