Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Docs /
Fuels Ts /
Account

Icon LinkModule: @fuel-ts/account

Icon LinkEnumerations

Icon LinkClasses

Icon LinkInterfaces

Icon LinkType Aliases

Icon LinkAbiMap

Ƭ AbiMap: Record<string, JsonAbi>

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:128 Icon Link

Icon LinkAccountEvent

Ƭ 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.

Icon LinkType declaration

NameType
datastring | null
typecurrentAccount

Icon LinkDefined in

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

Icon LinkAccountsEvent

Ƭ AccountsEvent: Object

Event trigger when the accounts available to the connection changes.

Icon LinkType declaration

NameType
datastring[]
typeaccounts

Icon LinkDefined in

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

Icon LinkAsset

Ƭ Asset: Object

Icon LinkType declaration

NameTypeDescription
iconstringicon of the asset
namestringname of the asset
networks(NetworkEthereum | NetworkFuel )[]asset id on Fuel Network
symbolstringdescription of the asset

Icon LinkDefined in

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

Icon LinkAssetEth

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

Icon LinkDefined in

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

Icon LinkAssetFuel

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

Icon LinkDefined in

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

Icon LinkAssets

Ƭ Assets: Asset []

Icon LinkDefined in

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

Icon LinkBlock

Ƭ Block: Object

A Fuel block

Icon LinkType declaration

NameType
heightBN
idstring
timestring
transactionIdsstring[]

Icon LinkDefined in

packages/account/src/providers/provider.ts:90 Icon Link

Icon LinkBlockHeader

Ƭ BlockHeader: Object

Icon LinkType declaration

NameType
applicationHashstring
consensusParametersVersionnumber
daHeightBN
eventInboxRootstring
heightBN
idstring
messageOutboxRootstring
messageReceiptCountnumber
prevRootstring
stateTransitionBytecodeVersionnumber
timestring
transactionsCountnumber
transactionsRootstring

Icon LinkDefined in

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

Icon LinkBlockId

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

Icon LinkDefined in

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

Icon LinkBurnedAsset

Ƭ BurnedAsset: MintedAsset

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:156 Icon Link

Icon LinkCacheFor

Ƭ CacheFor: Object

Icon LinkIndex signature

â–ª [key: string]: { timeout: number ; value: unknown } | null

Icon LinkDefined in

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

Icon LinkCalculateTXFeeForSummaryParams

Ƭ CalculateTXFeeForSummaryParams: Object

Icon LinkType declaration

NameType
consensusParametersPick<ConsensusParameters , "gasCosts"> & { feeParams: FeeParams ; maxGasPerTx: BN }
gasPriceBN
rawPayloadstring
tipBN
totalFee?BN

Icon LinkDefined in

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

Icon LinkCallResult

Ƭ CallResult: Object

Icon LinkType declaration

NameType
dryRunStatus?DryRunStatus
receiptsTransactionResultReceipt[]

Icon LinkDefined in

packages/account/src/providers/provider.ts:77 Icon Link

Icon LinkChainInfo

Ƭ ChainInfo: Object

Chain information

Icon LinkType declaration

NameType
baseChainHeightBN
consensusParametersConsensusParameters
latestBlock{ height: BN ; id: string ; time: string ; transactions: { id: string }[] }
latestBlock.heightBN
latestBlock.idstring
latestBlock.timestring
latestBlock.transactions{ id: string }[]
namestring

Icon LinkDefined in

packages/account/src/providers/provider.ts:157 Icon Link

Icon LinkChangeTransactionRequestOutput

Ƭ ChangeTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
assetIdBytesLike Asset ID of coins
toBytesLike Receiving address or script hash
typeOutputType.Change-

Icon LinkDefined in

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

Icon LinkCoin

Ƭ Coin: Object

A Fuel coin

Icon LinkType declaration

NameType
amountBN
assetIdstring
blockCreatedBN
idstring
ownerAbstractAddress
predicate?BytesLike
predicateData?BytesLike
txCreatedIdxBN

Icon LinkDefined in

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

Icon LinkCoinQuantity

Ƭ CoinQuantity: Object

Icon LinkType declaration

NameType
amountBN
assetIdstring
max?BN

Icon LinkDefined in

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

Icon LinkCoinQuantityLike

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

Icon LinkDefined in

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

Icon LinkCoinTransactionRequestInput

Ƭ CoinTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins
assetIdBytesLike Asset ID of the coins
idBytesLike UTXO ID
ownerBytesLike Owning address or script hash
predicate?BytesLike Predicate bytecode
predicateData?BytesLike Predicate input data (parameters)
predicateGasUsed?BigNumberishGas used by predicate
txPointerBytesLike Points to the TX whose output is being spent. (TxPointer)
typeInputType.Coin-
witnessIndexnumberIndex of witness that authorizes spending the coin

Icon LinkDefined in

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

Icon LinkCoinTransactionRequestOutput

Ƭ CoinTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins to send
assetIdBytesLike Asset ID of coins
toBytesLike Receiving address or script hash
typeOutputType.Coin-

Icon LinkDefined in

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

Icon LinkConnectorMetadata

Ƭ ConnectorMetadata: Object

Icon LinkType declaration

NameType
image?string | { dark: string ; light: string }
install{ action: string ; description: string ; link: string }
install.actionstring
install.descriptionstring
install.linkstring

Icon LinkDefined in

packages/account/src/connectors/types/connector-metadata.ts:1 Icon Link

Icon LinkConsensusParameters

Ƭ ConsensusParameters: Object

Icon LinkType declaration

NameType
baseAssetIdstring
chainIdBN
contractParametersModifyStringToBN<ContractParameters >
feeParametersModifyStringToBN<FeeParameters >
gasCostsGasCosts
predicateParametersModifyStringToBN<PredicateParameters >
scriptParametersModifyStringToBN<ScriptParameters >
txParametersModifyStringToBN<TxParameters >
versionGqlConsensusParametersVersion

Icon LinkDefined in

packages/account/src/providers/provider.ts:142 Icon Link

Icon LinkContractCreatedTransactionRequestOutput

Ƭ ContractCreatedTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
contractIdBytesLike Contract ID
stateRootBytesLike State Root
typeOutputType.ContractCreated-

Icon LinkDefined in

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

Icon LinkContractParameters

Ƭ ContractParameters: Object

Icon LinkType declaration

NameType
contractMaxSizeScalars["U64"]["output"]
maxStorageSlotsScalars["U64"]["output"]
versionGqlContractParametersVersion

Icon LinkDefined in

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

Icon LinkContractResult

Ƭ ContractResult: Object

Deployed Contract bytecode and contract id

Icon LinkType declaration

NameType
bytecodestring
idstring

Icon LinkDefined in

packages/account/src/providers/provider.ts:124 Icon Link

Icon LinkContractTransactionRequestInput

Ƭ ContractTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
contractIdBytesLike Contract ID
txPointerBytesLike Points to the TX whose output is being spent. (TxPointer)
typeInputType.Contract-

Icon LinkDefined in

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

Icon LinkContractTransactionRequestOutput

Ƭ ContractTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
inputIndexnumberIndex of input contract
typeOutputType.Contract-

Icon LinkDefined in

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

Icon LinkDeferPromise

Ƭ DeferPromise<R>: Object

Icon LinkType parameters

NameType
Runknown

Icon LinkType declaration

NameType
promisePromise<R>
reject(error: unknown) => void
resolve(value: R) => void

Icon LinkDefined in

packages/account/src/connectors/utils/promises.ts:2 Icon Link

Icon LinkDryRunFailureStatusFragment

Ƭ DryRunFailureStatusFragment: GqlDryRunFailureStatusFragment

Icon LinkDefined in

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

Icon LinkDryRunStatus

Ƭ DryRunStatus: DryRunFailureStatusFragment | DryRunSuccessStatusFragment

Icon LinkDefined in

packages/account/src/providers/provider.ts:75 Icon Link

Icon LinkDryRunSuccessStatusFragment

Ƭ DryRunSuccessStatusFragment: GqlDryRunSuccessStatusFragment

Icon LinkDefined in

packages/account/src/providers/provider.ts:73 Icon Link

Icon LinkEstimateTransactionParams

Ƭ EstimateTransactionParams: Object

Transaction estimation params

Icon LinkType declaration

NameTypeDescription
estimateTxDependencies?booleanEstimate the transaction dependencies.

Icon LinkDefined in

packages/account/src/providers/provider.ts:331 Icon Link

Icon LinkEstimateTxDependenciesReturns

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

Icon LinkDefined in

packages/account/src/providers/provider.ts:82 Icon Link

Icon LinkEstimatedTxParams

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

Icon LinkDefined in

packages/account/src/account.ts:58 Icon Link

Icon LinkFailureStatus

Ƭ FailureStatus: GqlFailureStatusFragment

Icon LinkDefined in

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

Icon LinkFakeResources

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

Icon LinkDefined in

packages/account/src/account.ts:64 Icon Link

Icon LinkFeeParameters

Ƭ FeeParameters: Object

Icon LinkType declaration

NameType
gasPerByteScalars["U64"]["output"]
gasPriceFactorScalars["U64"]["output"]
versionGqlFeeParametersVersion

Icon LinkDefined in

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

Icon LinkFuelABI

Ƭ FuelABI: JsonAbi

ABI that represents a binary code interface from Sway.

Read more at: https://docs.fuel.network/docs/specs/abi/json-abi-format/ Icon Link

Icon LinkDefined in

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

Icon LinkFuelConfig

Ƭ FuelConfig: Object

Icon LinkType declaration

NameType
connectors?FuelConnector []
storage?StorageAbstract | null
targetObject?TargetObject

Icon LinkDefined in

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

Icon LinkFuelConnectorEvents

Ƭ FuelConnectorEvents: ConnectionEvent | NetworkEvent | NetworksEvent | AccountEvent | AccountsEvent | ConnectorsEvent | ConnectorEvent | AssetsEvent

All the events available to the connector.

Icon LinkDefined in

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

Icon LinkFuelConnectorEventsType

Ƭ FuelConnectorEventsType: FuelConnectorEvents ["type"]

Icon LinkDefined in

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

Icon LinkFuelConnectorSelectOptions

Ƭ FuelConnectorSelectOptions: Object

Icon LinkType declaration

NameType
emitEvents?boolean

Icon LinkDefined in

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

Icon LinkFuelEventArg

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

Extract the event argument type from the event type.

Icon LinkType parameters

NameType
Textends FuelConnectorEvents ["type"]

Icon LinkDefined in

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

Icon LinkGasCosts

Ƭ GasCosts: Object

Icon LinkType declaration

NameType
addScalars["U64"]["output"]
addiScalars["U64"]["output"]
alocScalars["U64"]["output"]
alocDependentCostGqlDependentCost
andScalars["U64"]["output"]
andiScalars["U64"]["output"]
balScalars["U64"]["output"]
bheiScalars["U64"]["output"]
bhshScalars["U64"]["output"]
burnScalars["U64"]["output"]
callGqlDependentCost
cbScalars["U64"]["output"]
ccpGqlDependentCost
cfeGqlDependentCost
cfeiScalars["U64"]["output"]
cfeiDependentCostGqlDependentCost
cfsiScalars["U64"]["output"]
contractRootGqlDependentCost
crooGqlDependentCost
csizGqlDependentCost
divScalars["U64"]["output"]
diviScalars["U64"]["output"]
eck1Scalars["U64"]["output"]
ecr1Scalars["U64"]["output"]
ed19Scalars["U64"]["output"]
eqScalars["U64"]["output"]
expScalars["U64"]["output"]
expiScalars["U64"]["output"]
flagScalars["U64"]["output"]
gmScalars["U64"]["output"]
gtScalars["U64"]["output"]
gtfScalars["U64"]["output"]
jiScalars["U64"]["output"]
jmpScalars["U64"]["output"]
jmpbScalars["U64"]["output"]
jmpfScalars["U64"]["output"]
jneScalars["U64"]["output"]
jnebScalars["U64"]["output"]
jnefScalars["U64"]["output"]
jneiScalars["U64"]["output"]
jnzbScalars["U64"]["output"]
jnzfScalars["U64"]["output"]
jnziScalars["U64"]["output"]
k256GqlDependentCost
lbScalars["U64"]["output"]
ldcGqlDependentCost
logScalars["U64"]["output"]
logdGqlDependentCost
ltScalars["U64"]["output"]
lwScalars["U64"]["output"]
mclGqlDependentCost
mcliGqlDependentCost
mcpGqlDependentCost
mcpiGqlDependentCost
meqGqlDependentCost
mintScalars["U64"]["output"]
mldvScalars["U64"]["output"]
mlogScalars["U64"]["output"]
modOpScalars["U64"]["output"]
modiScalars["U64"]["output"]
moveOpScalars["U64"]["output"]
moviScalars["U64"]["output"]
mrooScalars["U64"]["output"]
mulScalars["U64"]["output"]
muliScalars["U64"]["output"]
newStoragePerByteScalars["U64"]["output"]
noopScalars["U64"]["output"]
notScalars["U64"]["output"]
orScalars["U64"]["output"]
oriScalars["U64"]["output"]
pophScalars["U64"]["output"]
poplScalars["U64"]["output"]
pshhScalars["U64"]["output"]
pshlScalars["U64"]["output"]
retScalars["U64"]["output"]
retdGqlDependentCost
rvrtScalars["U64"]["output"]
s256GqlDependentCost
sbScalars["U64"]["output"]
scwqGqlDependentCost
sllScalars["U64"]["output"]
slliScalars["U64"]["output"]
smoGqlDependentCost
srlScalars["U64"]["output"]
srliScalars["U64"]["output"]
srwScalars["U64"]["output"]
srwqGqlDependentCost
stateRootGqlDependentCost
subScalars["U64"]["output"]
subiScalars["U64"]["output"]
swScalars["U64"]["output"]
swwScalars["U64"]["output"]
swwqGqlDependentCost
timeScalars["U64"]["output"]
trScalars["U64"]["output"]
troScalars["U64"]["output"]
versionGqlGasCostsVersion
vmInitializationGqlDependentCost
wdamScalars["U64"]["output"]
wdcmScalars["U64"]["output"]
wddvScalars["U64"]["output"]
wdmdScalars["U64"]["output"]
wdmlScalars["U64"]["output"]
wdmmScalars["U64"]["output"]
wdopScalars["U64"]["output"]
wqamScalars["U64"]["output"]
wqcmScalars["U64"]["output"]
wqdvScalars["U64"]["output"]
wqmdScalars["U64"]["output"]
wqmlScalars["U64"]["output"]
wqmmScalars["U64"]["output"]
wqopScalars["U64"]["output"]
xorScalars["U64"]["output"]
xoriScalars["U64"]["output"]

Icon LinkDefined in

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

Icon LinkGetAssetNetworkParams

Ƭ GetAssetNetworkParams<T>: Object

Icon LinkType parameters

NameType
Textends NetworkTypes | undefined

Icon LinkType declaration

NameType
assetAsset
chainId?number
networkTypeT

Icon LinkDefined in

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

Icon LinkGetBalancesResponse

Ƭ GetBalancesResponse: Object

Icon LinkType declaration

NameType
balancesCoinQuantity []

Icon LinkDefined in

packages/account/src/providers/provider.ts:107 Icon Link

Icon LinkGetBlocksResponse

Ƭ GetBlocksResponse: Object

Icon LinkType declaration

NameType
blocksBlock []
pageInfoGqlPageInfo

Icon LinkDefined in

packages/account/src/providers/provider.ts:116 Icon Link

Icon LinkGetCoinsResponse

Ƭ GetCoinsResponse: Object

Icon LinkType declaration

NameType
coinsCoin []
pageInfoGqlPageInfo

Icon LinkDefined in

packages/account/src/providers/provider.ts:97 Icon Link

Icon LinkGetMessagesResponse

Ƭ GetMessagesResponse: Object

Icon LinkType declaration

NameType
messagesMessage []
pageInfoGqlPageInfo

Icon LinkDefined in

packages/account/src/providers/provider.ts:102 Icon Link

Icon LinkGetOperationParams

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

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:140 Icon Link

Icon LinkGetTransactionsResponse

Ƭ GetTransactionsResponse: Object

Icon LinkType declaration

NameType
pageInfoGqlPageInfo
transactionsTransaction[]

Icon LinkDefined in

packages/account/src/providers/provider.ts:111 Icon Link

Icon LinkGqlTransaction

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

Icon LinkDefined in

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

Icon LinkGraphqlTransactionStatus

Ƭ GraphqlTransactionStatus: GqlTransaction ["status"]

Icon LinkDefined in

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

Icon LinkInputOutputParam

Ƭ InputOutputParam: InputParam & OutputParam

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:134 Icon Link

Icon LinkInputParam

Ƭ InputParam: Object

Icon LinkType declaration

NameType
inputsInput[]

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:116 Icon Link

Icon LinkJsonAbisFromAllCalls

Ƭ JsonAbisFromAllCalls: Object

Icon LinkType declaration

NameType
mainJsonAbi
otherContractsAbisRecord<string, JsonAbi>

Icon LinkDefined in

packages/account/src/providers/transaction-request/types.ts:18 Icon Link

Icon LinkMerkleProof

Ƭ MerkleProof: Object

Icon LinkType declaration

NameType
proofIndexBN
proofSetstring[]

Icon LinkDefined in

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

Icon LinkMessage

Ƭ Message: Object

A Fuel message

Icon LinkType declaration

NameType
amountBN
daHeightBN
dataBytesLike
messageIdBytesLike
nonceBytesLike
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

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

Icon LinkMessageCoin

Ƭ MessageCoin: Object

Icon LinkType declaration

NameType
amountBN
assetIdstring
daHeightBN
nonceBytesLike
predicate?BytesLike
predicateData?BytesLike
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

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

Icon LinkMessageProof

Ƭ MessageProof: Object

Message Proof

Icon LinkType declaration

NameType
amountBN
blockProofMerkleProof
commitBlockHeaderBlockHeader
datastring
messageBlockHeaderBlockHeader
messageProofMerkleProof
noncestring
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

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

Icon LinkMessageStatus

Ƭ MessageStatus: Object

Message Status

Icon LinkType declaration

NameType
stateGqlMessageState

Icon LinkDefined in

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

Icon LinkMessageTransactionRequestInput

Ƭ MessageTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins
data?BytesLike data of message
nonceBytesLike Unique nonce of message
predicate?BytesLike Predicate bytecode
predicateData?BytesLike Predicate input data (parameters)
predicateGasUsed?BigNumberishGas used by predicate
recipientBytesLike Address of recipient
senderBytesLike Address of sender
typeInputType.Message-
witnessIndexnumberIndex of witness that authorizes the message

Icon LinkDefined in

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

Icon LinkMnemonicPhrase

Ƭ MnemonicPhrase: string | string[]

Icon LinkDefined in

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

Icon LinkNetwork

Ƭ Network: Object

Network

Icon LinkType declaration

NameTypeDescription
chainIdnumberThe chain id of the network.
urlstringThe name of the network.

Icon LinkDefined in

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

Icon LinkNetworkEthereum

Ƭ NetworkEthereum: Object

Icon LinkType declaration

NameTypeDescription
address?stringaddress of the asset contract
chainIdnumberchain id of the network
decimalsnumbernumber of decimals of the asset
type"ethereum"type of network

Icon LinkDefined in

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

Icon LinkNetworkFuel

Ƭ NetworkFuel: Object

Icon LinkType declaration

NameTypeDescription
assetIdstringassetId on the Fuel Network
chainIdnumberchain id of the network
contractId?stringthe contractId of that generated the Asset on the Fuel Network
decimalsnumbernumber of decimals of the asset
type"fuel"type of network

Icon LinkDefined in

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

Icon LinkNetworkTypes

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

Icon LinkDefined in

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

Icon LinkNodeInfo

Ƭ NodeInfo: Object

Node information

Icon LinkType declaration

NameType
maxDepthBN
maxTxBN
nodeVersionstring
utxoValidationboolean
vmBacktraceboolean

Icon LinkDefined in

packages/account/src/providers/provider.ts:172 Icon Link

Icon LinkNodeInfoAndConsensusParameters

Ƭ NodeInfoAndConsensusParameters: Object

Icon LinkType declaration

NameType
gasPerByteBN
gasPriceFactorBN
maxGasPerTxBN
nodeVersionstring

Icon LinkDefined in

packages/account/src/providers/provider.ts:180 Icon Link

Icon LinkOperation

Ƭ Operation: Object

Icon LinkType declaration

NameType
assetsSent?OperationCoin []
calls?OperationFunctionCall []
from?OperationTransactionAddress
name?OperationName
to?OperationTransactionAddress

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:86 Icon Link

Icon LinkOperationCoin

Ƭ OperationCoin: Object

Icon LinkType declaration

NameType
amountBNInput
assetIdstring

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:75 Icon Link

Icon LinkOperationFunctionCall

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

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:80 Icon Link

Icon LinkOperationTransactionAddress

Ƭ OperationTransactionAddress: Object

Icon LinkType declaration

NameType
addressstring
chain?ChainName
typeAddressType

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:110 Icon Link

Icon LinkOutputParam

Ƭ OutputParam: Object

Icon LinkType declaration

NameType
outputsOutput[]

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:120 Icon Link

Icon LinkPredicateParameters

Ƭ PredicateParameters: Object

Icon LinkType declaration

NameType
maxGasPerPredicateScalars["U64"]["output"]
maxMessageDataLengthScalars["U64"]["output"]
maxPredicateDataLengthScalars["U64"]["output"]
maxPredicateLengthScalars["U64"]["output"]
versionGqlPredicateParametersVersion

Icon LinkDefined in

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

Icon LinkPredicateParams

Ƭ PredicateParams<T>: Object

Icon LinkType parameters

NameType
TInputValue[]

Icon LinkType declaration

NameType
abi?JsonAbi
bytecodeBytesLike
configurableConstants?{ [name: string]: unknown; }
inputData?T
providerProvider

Icon LinkDefined in

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

Icon LinkProgramState

Ƭ ProgramState: SuccessStatus ["programState"]

Icon LinkDefined in

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

Icon LinkProviderCallParams

Ƭ ProviderCallParams: UTXOValidationParams & EstimateTransactionParams

Provider Call transaction params

Icon LinkDefined in

packages/account/src/providers/provider.ts:361 Icon Link

Icon LinkProviderOptions

Ƭ ProviderOptions: Object

Icon LinkType declaration

NameTypeDescription
cacheUtxo?numberCache UTXOs for the given time [ms].
fetch?(url: string, requestInit?: RequestInit, providerOptions?: Omit<ProviderOptions , "fetch">) => Promise<Response>-
requestMiddleware?(request: RequestInit) => RequestInit | Promise<RequestInit>-
retryOptions?RetryOptionsRetry options to use when fetching data from the node.
timeout?numberTimeout [ms] after which every request will be aborted.

Icon LinkDefined in

packages/account/src/providers/provider.ts:293 Icon Link

Icon LinkProviderSendTxParams

Ƭ ProviderSendTxParams: EstimateTransactionParams & { awaitExecution?: boolean }

Provider Send transaction params

Icon LinkDefined in

packages/account/src/providers/provider.ts:366 Icon Link

Icon LinkRawCoin

Ƭ RawCoin: Object

Icon LinkType declaration

NameType
amountstring
assetIdstring
blockCreatedstring
ownerstring
txCreatedIdxstring
utxoIdstring

Icon LinkDefined in

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

Icon LinkRawMessage

Ƭ RawMessage: Object

Icon LinkType declaration

NameType
amountstring
assetIdstring
daHeightstring
datastring
noncestring
recipientstring
senderstring

Icon LinkDefined in

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

Icon LinkRawPayloadParam

Ƭ RawPayloadParam: Object

Icon LinkType declaration

NameType
rawPayload?string

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:130 Icon Link

Icon LinkRawResource

Ƭ RawResource: RawCoin | RawMessage

Icon LinkDefined in

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

Icon LinkReason

Ƭ Reason: FailureStatus ["reason"]

Icon LinkDefined in

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

Icon LinkReceiptParam

Ƭ ReceiptParam: Object

Icon LinkType declaration

NameType
receiptsTransactionResultReceipt[]

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:124 Icon Link

Icon LinkResource

Ƭ Resource: Coin | MessageCoin

Icon LinkDefined in

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

Icon LinkScriptParameters

Ƭ ScriptParameters: Object

Icon LinkType declaration

NameType
maxScriptDataLengthScalars["U64"]["output"]
maxScriptLengthScalars["U64"]["output"]
versionGqlScriptParametersVersion

Icon LinkDefined in

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

Icon LinkSqueezedOutStatus

Ƭ SqueezedOutStatus: GqlSqueezedOutStatusFragment

Icon LinkDefined in

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

Icon LinkStatus

Ƭ Status: Object

Icon LinkType declaration

NameType
connectedboolean
installedboolean

Icon LinkDefined in

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

Icon LinkSubmittedStatus

Ƭ SubmittedStatus: GqlSubmittedStatusFragment

Icon LinkDefined in

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

Icon LinkSuccessStatus

Ƭ SuccessStatus: GqlSuccessStatusFragment

Icon LinkDefined in

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

Icon LinkTime

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

Icon LinkDefined in

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

Icon LinkTransactionCost

Ƭ TransactionCost: Object

Icon LinkType declaration

NameType
addedSignaturesnumber
dryRunStatus?DryRunStatus
estimatedPredicatesTransactionRequestInput []
gasPriceBN
gasUsedBN
maxFeeBN
maxGasBN
minFeeBN
minGasBN
missingContractIdsstring[]
outputVariablesnumber
receiptsTransactionResultReceipt[]
requiredQuantitiesCoinQuantity []
updateMaxFee?boolean

Icon LinkDefined in

packages/account/src/providers/provider.ts:188 Icon Link

Icon LinkTransactionCostParams

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

Icon LinkDefined in

packages/account/src/providers/provider.ts:338 Icon Link

Icon LinkTransactionRequest

Ƭ TransactionRequest: ScriptTransactionRequest | CreateTransactionRequest

Icon LinkDefined in

packages/account/src/providers/transaction-request/types.ts:13 Icon Link

Icon LinkTransactionRequestInput

Ƭ TransactionRequestInput: CoinTransactionRequestInput | ContractTransactionRequestInput | MessageTransactionRequestInput

Icon LinkDefined in

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

Icon LinkTransactionRequestLike

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

Icon LinkDefined in

packages/account/src/providers/transaction-request/types.ts:14 Icon Link

Icon LinkTransactionRequestOutput

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

Icon LinkDefined in

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

Icon LinkTransactionResultBurnReceipt

Ƭ TransactionResultBurnReceipt: ReceiptBurn

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:56 Icon Link

Icon LinkTransactionResultMintReceipt

Ƭ TransactionResultMintReceipt: ReceiptMint

Icon LinkDefined in

packages/account/src/providers/transaction-response/transaction-response.ts:55 Icon Link

Icon LinkTransactionSummary

Ƭ TransactionSummary<TTransactionType>: Object

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkType declaration

NameType
blockId?BlockId
burnedAssetsBurnedAsset []
date?Date
feeBN
gasUsedBN
id?string
isStatusFailureboolean
isStatusPendingboolean
isStatusSuccessboolean
isTypeCreateboolean
isTypeMintboolean
isTypeScriptboolean
isTypeUpgradeboolean
isTypeUploadboolean
mintedAssetsMintedAsset []
operationsOperation []
receiptsTransactionResultReceipt[]
status?TransactionStatus
time?string
tipBN
transactionTransaction<TTransactionType>
typeTransactionTypeName

Icon LinkDefined in

packages/account/src/providers/transaction-summary/types.ts:158 Icon Link

Icon LinkTransferParams

Ƭ TransferParams: Object

Icon LinkType declaration

NameType
amountBigNumberish
assetId?BytesLike
destinationstring | AbstractAddress

Icon LinkDefined in

packages/account/src/account.ts:52 Icon Link

Icon LinkTxParameters

Ƭ TxParameters: Object

Icon LinkType declaration

NameType
maxBytecodeSubsectionsScalars["U16"]["output"]
maxGasPerTxScalars["U64"]["output"]
maxInputsScalars["U16"]["output"]
maxOutputsScalars["U16"]["output"]
maxSizeScalars["U64"]["output"]
maxWitnessesScalars["U32"]["output"]
versionGqlTxParametersVersion

Icon LinkDefined in

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

Icon LinkTxParamsType

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

Icon LinkDefined in

packages/account/src/account.ts:47 Icon Link

Icon LinkUTXOValidationParams

Ƭ UTXOValidationParams: Object

UTXO validation params

Icon LinkType declaration

NameType
utxoValidation?boolean

Icon LinkDefined in

packages/account/src/providers/provider.ts:324 Icon Link

Icon LinkVariableTransactionRequestOutput

Ƭ VariableTransactionRequestOutput: Object

Icon LinkType declaration

NameType
typeOutputType.Variable

Icon LinkDefined in

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

Icon LinkVaultConfig

Ƭ VaultConfig: Object

Icon LinkType declaration

NameType
secret?string
title?string
typestring

Icon LinkDefined in

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

Icon LinkVaultsState

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

Icon LinkDefined in

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

Icon LinkVersion

Ƭ Version: Object

Version

Icon LinkType declaration

NameTypeDescription
appstring-
networkstringVersion 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

Icon LinkDefined in

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

Icon LinkWalletManagerAccount

Ƭ WalletManagerAccount: Object

Icon LinkType declaration

NameType
addressAbstractAddress
publicKeystring
vaultId?number

Icon LinkDefined in

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

Icon LinkWalletManagerOptions

Ƭ WalletManagerOptions: Object

Icon LinkType declaration

NameType
storageStorageAbstract

Icon LinkDefined in

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

Icon LinkVariables

Icon LinkBLOCKS_PAGE_SIZE_LIMIT

• Const BLOCKS_PAGE_SIZE_LIMIT: 5

Icon LinkDefined in

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

Icon LinkCHAIN_IDS

• Const CHAIN_IDS: Object

Icon LinkType declaration

NameType
eth{ foundry: number = 31337; sepolia: number = 11155111 }
eth.foundrynumber
eth.sepolianumber
fuel{ devnet: number = 0; testnet: number = 0 }
fuel.devnetnumber
fuel.testnetnumber

Icon LinkDefined in

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

Icon LinkFuelConnectorEventType

• Const FuelConnectorEventType: "FuelConnector"

Icon LinkDefined in

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

Icon LinkMNEMONIC_SIZES

• Const MNEMONIC_SIZES: number[]

Icon LinkDefined in

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

Icon LinkRESOURCES_PAGE_SIZE_LIMIT

• Const RESOURCES_PAGE_SIZE_LIMIT: 512

Icon LinkDefined in

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

Icon Linkassets

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

Icon LinkDefined in

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

Icon Linkenglish

• Const english: string[]

Icon LinkDefined in

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

Icon LinkfuelAssetsBaseUrl

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

Icon LinkDefined in

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

Icon LinkrawAssets

• Const rawAssets: Assets

Icon LinkDefined in

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

Icon LinkFunctions

Icon LinkaddAmountToCoinQuantities

â–¸ addAmountToCoinQuantities(params): CoinQuantity []

Icon LinkParameters

NameType
paramsIAddAmountToAssetParams

Icon LinkReturns

CoinQuantity []

Icon LinkDefined in

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

Icon LinkassemblePanicError

â–¸ assemblePanicError(statusReason, metadata): FuelError

Assembles an error message for a panic status.

Icon LinkParameters

NameType
statusReasonstring
metadataRecord<string, unknown>

Icon LinkReturns

FuelError

The error message.

Icon LinkDefined in

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

Icon LinkassembleReceiptByType

â–¸ assembleReceiptByType(receipt): ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn

Icon LinkParameters

NameType
receiptGqlReceiptFragment

Icon LinkReturns

ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn

Icon LinkDefined in

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

Icon LinkassembleRevertError

â–¸ assembleRevertError(receipts, logs, metadata): FuelError

Assembles an error message for a revert status.

Icon LinkParameters

NameTypeDescription
receiptsTransactionResultReceipt[]The transaction result processed receipts.
logsunknown[]The transaction decoded logs.
metadataRecord<string, unknown>-

Icon LinkReturns

FuelError

The error message.

Icon LinkDefined in

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

Icon LinkcacheFor

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

Icon LinkType parameters

NameType
Fextends (...args: unknown[]) => Promise<unknown>

Icon LinkParameters

NameType
fnF
«destructured»CacheForOptions

Icon LinkReturns

F

Icon LinkDefined in

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

Icon LinkcacheRequestInputsResources

â–¸ cacheRequestInputsResources(inputs): Required<ExcludeResourcesOption>

Icon LinkParameters

NameType
inputsTransactionRequestInput []

Icon LinkReturns

Required<ExcludeResourcesOption>

Icon LinkDefined in

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

Icon LinkcacheRequestInputsResourcesFromOwner

â–¸ cacheRequestInputsResourcesFromOwner(inputs, owner): ExcludeResourcesOption

Icon LinkParameters

NameType
inputsTransactionRequestInput []
ownerAbstractAddress

Icon LinkReturns

ExcludeResourcesOption

Icon LinkDefined in

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

Icon LinkcalculateGasFee

â–¸ calculateGasFee(params): BN

Icon LinkParameters

NameType
paramsCalculateGasFeeParams

Icon LinkReturns

BN

Icon LinkDefined in

packages/account/src/providers/utils/gas.ts:168 Icon Link

Icon LinkcalculateMetadataGasForTxCreate

▸ calculateMetadataGasForTxCreate(«destructured»): BN

Icon LinkParameters

NameType
«destructured»Object
› contractBytesSizeBN
› gasCostsGasCosts
› stateRootSizenumber
› txBytesSizenumber

Icon LinkReturns

BN

Icon LinkDefined in

packages/account/src/providers/utils/gas.ts:130 Icon Link

Icon LinkcalculateMetadataGasForTxScript

▸ calculateMetadataGasForTxScript(«destructured»): BN

Icon LinkParameters

NameType
«destructured»Object
› gasCostsGasCosts
› txBytesSizenumber

Icon LinkReturns

BN

Icon LinkDefined in

packages/account/src/providers/utils/gas.ts:151 Icon Link

Icon LinkcalculateTXFeeForSummary

â–¸ calculateTXFeeForSummary(params): BN

Icon LinkParameters

NameType
paramsCalculateTXFeeForSummaryParams

Icon LinkReturns

BN

Icon LinkDefined in

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

Icon LinkdeferPromise

â–¸ deferPromise<R>(): DeferPromise <R>

Icon LinkType parameters

NameType
Runknown

Icon LinkReturns

DeferPromise <R>

Icon LinkDefined in

packages/account/src/connectors/utils/promises.ts:8 Icon Link

Icon LinkdispatchFuelConnectorEvent

â–¸ 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.

Icon LinkParameters

NameType
connectorFuelConnector

Icon LinkReturns

void

Icon LinkDefined in

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

Icon LinkextractBurnedAssetsFromReceipts

â–¸ extractBurnedAssetsFromReceipts(receipts): MintedAsset []

Icon LinkParameters

NameType
receiptsTransactionResultReceipt[]

Icon LinkReturns

MintedAsset []

Icon LinkDefined in

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

Icon LinkextractMintedAssetsFromReceipts

â–¸ extractMintedAssetsFromReceipts(receipts): MintedAsset []

Icon LinkParameters

NameType
receiptsTransactionResultReceipt[]

Icon LinkReturns

MintedAsset []

Icon LinkDefined in

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

Icon LinkextractTxError

â–¸ extractTxError(params): FuelError

Extracts the transaction error and returns a FuelError object.

Icon LinkParameters

NameType
paramsIExtractTxError

Icon LinkReturns

FuelError

The FuelError object.

Icon LinkDefined in

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

Icon LinkgasUsedByInputs

â–¸ gasUsedByInputs(inputs, txBytesSize, gasCosts): BN

Icon LinkParameters

NameType
inputs(TransactionRequestInput | Input)[]
txBytesSizenumber
gasCostsGasCosts

Icon LinkReturns

BN

Icon LinkDefined in

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

Icon LinkgetAssetAmountInRequestInputs

â–¸ getAssetAmountInRequestInputs(inputs, assetId, baseAsset): BN

Icon LinkParameters

NameType
inputsTransactionRequestInput []
assetIdstring
baseAssetstring

Icon LinkReturns

BN

Icon LinkDefined in

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

Icon LinkgetAssetEth

â–¸ getAssetEth(asset, chainId?): undefined | AssetEth

Returns the asset's details on Ethereum

Icon LinkParameters

NameType
assetAsset
chainId?number

Icon LinkReturns

undefined | AssetEth

Icon LinkDefined in

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

Icon LinkgetAssetFuel

â–¸ getAssetFuel(asset, chainId?): undefined | AssetFuel

Returns the asset's details on Fuel

Icon LinkParameters

NameType
assetAsset
chainId?number

Icon LinkReturns

undefined | AssetFuel

Icon LinkDefined in

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

Icon LinkgetAssetNetwork

▸ 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

Icon LinkType parameters

NameType
Textends undefined | NetworkTypes

Icon LinkParameters

NameType
«destructured»GetAssetNetworkParams <T>

Icon LinkReturns

NetworkTypeToNetwork<T>

Icon LinkDefined in

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

Icon LinkgetAssetWithNetwork

▸ 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

Icon LinkType parameters

NameType
Textends NetworkTypes

Icon LinkParameters

NameType
«destructured»GetAssetNetworkParams <T>

Icon LinkReturns

undefined | AssetEth | AssetFuel

Icon LinkDefined in

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

Icon LinkgetDefaultChainId

â–¸ getDefaultChainId(networkType): undefined | number

Returns the default chainId for the given network

Icon LinkParameters

NameType
networkTypeNetworkTypes

Icon LinkReturns

undefined | number

Icon LinkDefined in

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

Icon LinkgetMaxGas

â–¸ getMaxGas(params): BN

Icon LinkParameters

NameType
paramsIGetMaxGasParams

Icon LinkReturns

BN

Icon LinkDefined in

packages/account/src/providers/utils/gas.ts:109 Icon Link

Icon LinkgetMinGas

â–¸ getMinGas(params): BN

Icon LinkParameters

NameType
paramsIGetMinGasParams

Icon LinkReturns

BN

Icon LinkDefined in

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

Icon LinkgetRequestInputResourceOwner

â–¸ getRequestInputResourceOwner(input): BytesLike

Icon LinkParameters

NameType
inputCoinTransactionRequestInput | MessageTransactionRequestInput

Icon LinkReturns

BytesLike

Icon LinkDefined in

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

Icon LinkgetTransactionSummary

â–¸ getTransactionSummary<TTransactionType>(params): Promise<TransactionResult>

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameType
paramsGetTransactionSummaryParams

Icon LinkReturns

Promise<TransactionResult>

Icon LinkDefined in

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

Icon LinkisRequestInputCoin

â–¸ isRequestInputCoin(input): input is CoinTransactionRequestInput

Icon LinkParameters

NameType
inputTransactionRequestInput

Icon LinkReturns

input is CoinTransactionRequestInput

Icon LinkDefined in

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

Icon LinkisRequestInputMessage

â–¸ isRequestInputMessage(input): input is MessageTransactionRequestInput

Icon LinkParameters

NameType
inputTransactionRequestInput

Icon LinkReturns

input is MessageTransactionRequestInput

Icon LinkDefined in

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

Icon LinkisRequestInputResource

â–¸ isRequestInputResource(input): input is CoinTransactionRequestInput | MessageTransactionRequestInput

Icon LinkParameters

NameType
inputTransactionRequestInput

Icon LinkReturns

input is CoinTransactionRequestInput | MessageTransactionRequestInput

Icon LinkDefined in

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

Icon LinkisRequestInputResourceFromOwner

â–¸ isRequestInputResourceFromOwner(input, owner): boolean

Icon LinkParameters

NameType
inputCoinTransactionRequestInput | MessageTransactionRequestInput
ownerAbstractAddress

Icon LinkReturns

boolean

Icon LinkDefined in

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

Icon LinkprocessGqlReceipt

â–¸ processGqlReceipt(gqlReceipt): TransactionResultReceipt

Icon LinkParameters

NameType
gqlReceiptGqlReceiptFragment

Icon LinkReturns

TransactionResultReceipt

Icon LinkDefined in

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

Icon LinkresolveGasDependentCosts

â–¸ resolveGasDependentCosts(byteSize, gasDependentCost): BN

Icon LinkParameters

NameType
byteSizeBNInput
gasDependentCostGqlDependentCost

Icon LinkReturns

BN

Icon LinkDefined in

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

Icon LinkresolveIconPaths

â–¸ 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

Icon LinkParameters

NameTypeDefault valueDescription
assetsAssets undefinedList of assets
basePathstring'./'Base path for the icon URLs (default: './')

Icon LinkReturns

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

The assets with the icon paths resolved

Icon LinkDefined in

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

Icon LinkurlJoin

â–¸ urlJoin(baseUrl, ...paths): string

Icon LinkParameters

NameType
baseUrlundefined | string
...pathsstring[]

Icon LinkReturns

string

Icon LinkDefined in

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

Icon LinkwithTimeout

â–¸ withTimeout<F, RT>(promise, timeout?): Promise<RT>

Icon LinkType parameters

NameType
Fextends Promise<unknown>
RTAwaited<F>

Icon LinkParameters

NameTypeDefault value
promiseFundefined
timeoutnumber1050

Icon LinkReturns

Promise<RT>

Icon LinkDefined in

packages/account/src/connectors/utils/promises.ts:20 Icon Link

Icon LinkEvents

Icon LinkAssetsEvent

Ƭ AssetsEvent: Object

Event trigger when the assets list of metadata changed.

AssetsEvent

Icon LinkType declaration

NameType
dataAsset []
typeassets

Icon LinkDefined in

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

Icon LinkConnectionEvent

Ƭ ConnectionEvent: Object

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

ConnectionEvent

Icon LinkType declaration

NameType
databoolean
typeconnection

Icon LinkDefined in

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

Icon LinkConnectorEvent

Ƭ ConnectorEvent: Object

Event trigger when the current connector has changed.

ConnectorEvent

Icon LinkType declaration

NameType
dataFuelConnector
typecurrentConnector

Icon LinkDefined in

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

Icon LinkConnectorsEvent

Ƭ ConnectorsEvent: Object

Event trigger when the list of connectors has changed.

ConnectorsEvent

Icon LinkType declaration

NameType
dataFuelConnector []
typeconnectors

Icon LinkDefined in

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

Icon LinkNetworkEvent

Ƭ 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

Icon LinkType declaration

NameType
dataNetwork
typecurrentNetwork

Icon LinkDefined in

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

Icon LinkNetworksEvent

Ƭ 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

Icon LinkType declaration

NameType
dataNetwork
typenetworks

Icon LinkDefined in

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