@fuel-ts/account v0.94.8 • Docs
AbiMap:
Record<string,JsonAbi>
packages/account/src/providers/transaction-summary/types.ts:129
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.
data:
string|null
type:
currentAccount
packages/account/src/connectors/types/events.ts:40
AccountsEvent:
object
Event trigger when the accounts available to the connection changes.
data:
string[]
type:
accounts
packages/account/src/connectors/types/events.ts:28
Asset:
object
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
packages/account/src/providers/assets/types.ts:25
AssetEth:
Omit<Asset,"networks"> &NetworkEthereum
packages/account/src/providers/assets/types.ts:38
AssetFuel:
Omit<Asset,"networks"> &NetworkFuel
packages/account/src/providers/assets/types.ts:39
Assets:
Asset[]
packages/account/src/providers/assets/types.ts:36
Block:
object
A Fuel block
header:
object
header.applicationHash:
string
header.daHeight:
BN
header.eventInboxRoot:
string
header.messageOutboxRoot:
string
header.prevRoot:
string
header.stateTransitionBytecodeVersion:
string
header.transactionsCount:
string
header.transactionsRoot:
string
height:
BN
id:
string
time:
string
transactionIds:
string[]
packages/account/src/providers/provider.ts:89
BlockHeader:
object
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
packages/account/src/providers/message.ts:39
BlockId:
SuccessStatus["block"]["id"] |FailureStatus["block"]["id"]
packages/account/src/providers/transaction-summary/types.ts:27
BurnedAsset:
MintedAsset
packages/account/src/providers/transaction-summary/types.ts:158
CacheFor:
object
[key: string]: object | null
packages/account/src/connectors/utils/cache.ts:3
CalculateTXFeeForSummaryParams:
object
consensusParameters:
Pick<ConsensusParameters,"gasCosts"> &object
feeParams:
FeeParams
maxGasPerTx:
BN
gasPrice:
BN
rawPayload:
string
tip:
BN
optionaltotalFee:BN
packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:24
CallResult:
object
optionaldryRunStatus:DryRunStatus
receipts:
TransactionResultReceipt[]
packages/account/src/providers/provider.ts:76
ChainInfo:
object
Chain information
baseChainHeight:
BN
consensusParameters:
ConsensusParameters
latestBlock:
object
latestBlock.height:
BN
latestBlock.id:
string
latestBlock.time:
string
latestBlock.transactions:
object[]
name:
string
packages/account/src/providers/provider.ts:166
ChangeTransactionRequestOutput:
object
assetId:
BytesLike
Asset ID of coins
to:
BytesLike
Receiving address or script hash
type:
OutputType.Change
packages/account/src/providers/transaction-request/output.ts:24
Coin:
object
A Fuel coin
amount:
BN
assetId:
string
blockCreated:
BN
id:
string
owner:
AbstractAddress
optionalpredicate:BytesLike
optionalpredicateData:BytesLike
txCreatedIdx:
BN
packages/account/src/providers/coin.ts:7
CoinQuantity:
object
amount:
BN
assetId:
string
optionalmax:BN
packages/account/src/providers/coin-quantity.ts:9
CoinQuantityLike: [
BigNumberish,BytesLike,BigNumberish] |object
packages/account/src/providers/coin-quantity.ts:6
CoinTransactionRequestInput:
object
amount:
BigNumberish
Amount of coins
assetId:
BytesLike
Asset ID of the coins
id:
BytesLike
UTXO ID
owner:
BytesLike
Owning address or script hash
optionalpredicate:BytesLike
Predicate bytecode
optionalpredicateData:BytesLike
Predicate input data (parameters)
optionalpredicateGasUsed: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
packages/account/src/providers/transaction-request/input.ts:11
CoinTransactionRequestOutput:
object
amount:
BigNumberish
Amount of coins to send
assetId:
BytesLike
Asset ID of coins
to:
BytesLike
Receiving address or script hash
type:
OutputType.Coin
packages/account/src/providers/transaction-request/output.ts:10
ConnectorMetadata:
object
optionalimage:string|object
install:
object
install.action:
string
install.description:
string
install.link:
string
packages/account/src/connectors/types/connector-metadata.ts:2
ConsensusParameters:
object
baseAssetId:
string
chainId:
BN
contractParameters:
ModifyStringToBN<ContractParameters>
feeParameters:
ModifyStringToBN<FeeParameters>
gasCosts:
GasCosts
predicateParameters:
ModifyStringToBN<PredicateParameters>
scriptParameters:
ModifyStringToBN<ScriptParameters>
txParameters:
ModifyStringToBN<TxParameters>
version:
GqlConsensusParametersVersion
packages/account/src/providers/provider.ts:151
ContractCreatedTransactionRequestOutput:
object
contractId:
BytesLike
Contract ID
stateRoot:
BytesLike
State Root
type:
OutputType.ContractCreated
packages/account/src/providers/transaction-request/output.ts:34
ContractParameters:
object
contractMaxSize:
Scalars["U64"]["output"]
maxStorageSlots:
Scalars["U64"]["output"]
version:
GqlContractParametersVersion
packages/account/src/providers/__generated__/operations.ts:236
ContractResult:
object
Deployed Contract bytecode and contract id
bytecode:
string
id:
string
packages/account/src/providers/provider.ts:133
ContractTransactionRequestInput:
object
contractId:
BytesLike
Contract ID
txPointer:
BytesLike
Points to the TX whose output is being spent. (TxPointer)
type:
InputType.Contract
packages/account/src/providers/transaction-request/input.ts:73
ContractTransactionRequestOutput:
object
inputIndex:
number
Index of input contract
type:
OutputType.Contract
packages/account/src/providers/transaction-request/output.ts:19
DeferPromise<
R>:object
• R = unknown
promise:
Promise<R>
reject: (
error) =>void
• error: unknown
void
resolve: (
value) =>void
• value: R
void
packages/account/src/connectors/utils/promises.ts:5
DryRunFailureStatusFragment:
GqlDryRunFailureStatusFragment
packages/account/src/providers/provider.ts:71
DryRunStatus:
DryRunFailureStatusFragment|DryRunSuccessStatusFragment
packages/account/src/providers/provider.ts:74
DryRunSuccessStatusFragment:
GqlDryRunSuccessStatusFragment
packages/account/src/providers/provider.ts:72
EstimateTransactionParams:
object
Transaction estimation params
optionalestimateTxDependencies:boolean
Estimate the transaction dependencies.
packages/account/src/providers/provider.ts:344
EstimateTxDependenciesReturns:
CallResult&object
missingContractIds:
string[]
outputVariables:
number
packages/account/src/providers/provider.ts:81
EstimatedTxParams:
Pick<TransactionCost,"estimatedPredicates"|"addedSignatures"|"requiredQuantities"|"updateMaxFee"|"gasPrice">
packages/account/src/account.ts:62
FailureStatus:
GqlFailureStatusFragment
packages/account/src/providers/transaction-summary/types.ts:20
FakeResources:
Partial<Coin> &Required<Pick<Coin,"amount"|"assetId">>
packages/account/src/account.ts:68
FeeParameters:
object
gasPerByte:
Scalars["U64"]["output"]
gasPriceFactor:
Scalars["U64"]["output"]
version:
GqlFeeParametersVersion
packages/account/src/providers/__generated__/operations.ts:295
FuelABI:
JsonAbi
ABI that represents a binary code interface from Sway.
Read more at: https://docs.fuel.network/docs/specs/abi/json-abi-format/
packages/account/src/connectors/types/data-type.ts:44
FuelConfig:
object
optionalconnectors:FuelConnector[]
optionalstorage:StorageAbstract|null
optionaltargetObject:TargetObject
packages/account/src/connectors/fuel.ts:30
FuelConnectorEvents:
ConnectionEvent|NetworkEvent|NetworksEvent|AccountEvent|AccountsEvent|ConnectorsEvent|ConnectorEvent|AssetsEvent
All the events available to the connector.
packages/account/src/connectors/types/events.ts:122
FuelConnectorEventsType:
FuelConnectorEvents["type"]
packages/account/src/connectors/types/events.ts:132
FuelConnectorSelectOptions:
object
optionalemitEvents:boolean
packages/account/src/connectors/fuel.ts:36
FuelEventArg<
T>:Extract<FuelConnectorEventTypes,object>["data"]
Extract the event argument type from the event type.
• T extends FuelConnectorEvents ["type"]
packages/account/src/connectors/types/events.ts:16
GasCosts:
object
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"]
optionalbldd:Maybe<GqlDependentCost>
optionalbsiz: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"]
packages/account/src/providers/__generated__/operations.ts:305
GetAssetNetworkParams<
T>:object
• T extends NetworkTypes | undefined
asset:
Asset
optionalchainId:number
networkType:
T
packages/account/src/providers/assets/utils/network.ts:22
GetBalancesResponse:
object
balances:
CoinQuantity[]
packages/account/src/providers/provider.ts:116
GetBlocksResponse:
object
blocks:
Block[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:125
GetCoinsResponse:
object
coins:
Coin[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:106
GetMessagesResponse:
object
messages:
Message[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:111
GetOperationParams:
object&InputOutputParam&ReceiptParam&RawPayloadParam
optionalabiMap:AbiMap
baseAssetId:
string
maxInputs:
BN
transactionType:
TransactionType
packages/account/src/providers/transaction-summary/types.ts:142
GetTransactionsResponse:
object
pageInfo:
GqlPageInfo
transactions:
Transaction[]
packages/account/src/providers/provider.ts:120
GqlTransaction:
NonNullable<GqlGetTransactionQuery["transaction"]>
packages/account/src/providers/transaction-summary/types.ts:15
GraphqlTransactionStatus:
GqlTransaction["status"]
packages/account/src/providers/transaction-summary/types.ts:17
InputOutputParam:
InputParam&OutputParam
packages/account/src/providers/transaction-summary/types.ts:135
InputParam:
object
inputs:
Input[]
packages/account/src/providers/transaction-summary/types.ts:117
JsonAbisFromAllCalls:
object
main:
JsonAbi
otherContractsAbis:
Record<string,JsonAbi>
packages/account/src/providers/transaction-request/types.ts:38
MerkleProof:
object
proofIndex:
BN
proofSet:
string[]
packages/account/src/providers/message.ts:34
Message:
object
A Fuel message
amount:
BN
daHeight:
BN
data:
BytesLike
messageId:
BytesLike
nonce:
BytesLike
optionalpredicate:BytesLike
optionalpredicateData:BytesLike
recipient:
AbstractAddress
sender:
AbstractAddress
packages/account/src/providers/message.ts:10
MessageCoin:
object
amount:
BN
assetId:
string
daHeight:
BN
nonce:
BytesLike
optionalpredicate:BytesLike
optionalpredicateData:BytesLike
recipient:
AbstractAddress
sender:
AbstractAddress
packages/account/src/providers/message.ts:23
MessageProof:
object
Message Proof
amount:
BN
blockProof:
MerkleProof
commitBlockHeader:
BlockHeader
data:
string
messageBlockHeader:
BlockHeader
messageProof:
MerkleProof
nonce:
string
recipient:
AbstractAddress
sender:
AbstractAddress
packages/account/src/providers/message.ts:58
MessageStatus:
object
Message Status
state:
GqlMessageState
packages/account/src/providers/message.ts:73
MessageTransactionRequestInput:
object
amount:
BigNumberish
Amount of coins
optionaldata:BytesLike
data of message
nonce:
BytesLike
Unique nonce of message
optionalpredicate:BytesLike
Predicate bytecode
optionalpredicateData:BytesLike
Predicate input data (parameters)
optionalpredicateGasUsed: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
packages/account/src/providers/transaction-request/input.ts:42
MnemonicPhrase:
string|string[]
packages/account/src/mnemonic/utils.ts:7
Network:
object
Name
Network
chainId:
number
The chain id of the network.
url:
string
The name of the network.
packages/account/src/connectors/types/data-type.ts:21
NetworkEthereum:
object
optionaladdress: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
packages/account/src/providers/assets/types.ts:1
NetworkFuel:
object
assetId:
string
assetId on the Fuel Network
chainId:
number
chain id of the network
optionalcontractId: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
packages/account/src/providers/assets/types.ts:12
NetworkTypes:
NetworkEthereum["type"] |NetworkFuel["type"]
packages/account/src/providers/assets/utils/network.ts:5
NodeInfo:
object
Node information
maxDepth:
BN
maxTx:
BN
nodeVersion:
string
utxoValidation:
boolean
vmBacktrace:
boolean
packages/account/src/providers/provider.ts:181
NodeInfoAndConsensusParameters:
object
gasPerByte:
BN
gasPriceFactor:
BN
maxGasPerTx:
BN
nodeVersion:
string
packages/account/src/providers/provider.ts:189
Operation:
object
optionalassetsSent:OperationCoin[]
optionalcalls:OperationFunctionCall[]
optionalfrom:OperationTransactionAddress
optionalname:OperationName
optionalto:OperationTransactionAddress
packages/account/src/providers/transaction-summary/types.ts:87
OperationCoin:
object
amount:
BNInput
assetId:
string
packages/account/src/providers/transaction-summary/types.ts:76
OperationFunctionCall:
object&Partial<OperationCoin>
optionalargumentsProvided:Record<string,unknown>
functionName:
string
functionSignature:
string
packages/account/src/providers/transaction-summary/types.ts:81
OperationTransactionAddress:
object
address:
string
optionalchain:ChainName
type:
AddressType
packages/account/src/providers/transaction-summary/types.ts:111
OutputParam:
object
outputs:
Output[]
packages/account/src/providers/transaction-summary/types.ts:121
PredicateParameters:
object
maxGasPerPredicate:
Scalars["U64"]["output"]
maxMessageDataLength:
Scalars["U64"]["output"]
maxPredicateDataLength:
Scalars["U64"]["output"]
maxPredicateLength:
Scalars["U64"]["output"]
version:
GqlPredicateParametersVersion
packages/account/src/providers/__generated__/operations.ts:752
PredicateParams<
TData,TConfigurables>:object
• TData extends InputValue[] = InputValue[]
• TConfigurables extends object | undefined = object
optionalabi:JsonAbi
bytecode:
BytesLike
optionalconfigurableConstants:TConfigurables
optionaldata:TData
provider:
Provider
packages/account/src/predicate/predicate.ts:29
ProgramState:
SuccessStatus["programState"]
packages/account/src/providers/transaction-summary/types.ts:25
ProviderCallParams:
UTXOValidationParams&EstimateTransactionParams
Provider Call transaction params
packages/account/src/providers/provider.ts:369
ProviderOptions:
object
optionalfetch: (url,requestInit?,providerOptions?) =>Promise<Response>
Custom fetch function to use for making requests.
• url: string
• requestInit?: RequestInit
• providerOptions?: Omit<ProviderOptions , "fetch">
Promise<Response>
optionalheaders:RequestInit["headers"]
Custom headers to include in the request.
optionalrequestMiddleware: (request) =>RequestInit|Promise<RequestInit>
Middleware to modify the request before it is sent. This can be used to add headers, modify the body, etc.
• request: RequestInit
RequestInit | Promise<RequestInit>
optionalresourceCacheTTL:number
Resources cache for the given time [ms]. If set to -1, the cache will be disabled.
optionalretryOptions:RetryOptions
Retry options to use when fetching data from the node.
optionaltimeout:number
Timeout [ms] after which every request will be aborted.
packages/account/src/providers/provider.ts:302
ProviderSendTxParams:
EstimateTransactionParams
Provider Send transaction params
packages/account/src/providers/provider.ts:374
RawCoin:
object
amount:
string
assetId:
string
blockCreated:
string
owner:
string
txCreatedIdx:
string
utxoId:
string
packages/account/src/providers/resource.ts:6
RawMessage:
object
amount:
string
assetId:
string
daHeight:
string
data:
string
nonce:
string
recipient:
string
sender:
string
packages/account/src/providers/resource.ts:15
RawPayloadParam:
object
optionalrawPayload:string
packages/account/src/providers/transaction-summary/types.ts:131
RawResource:
RawCoin|RawMessage
packages/account/src/providers/resource.ts:25
Reason:
FailureStatus["reason"]
packages/account/src/providers/transaction-summary/types.ts:24
ReceiptParam:
object
receipts:
TransactionResultReceipt[]
packages/account/src/providers/transaction-summary/types.ts:125
Resource:
Coin|MessageCoin
packages/account/src/providers/resource.ts:26
ScriptParameters:
object
maxScriptDataLength:
Scalars["U64"]["output"]
maxScriptLength:
Scalars["U64"]["output"]
version:
GqlScriptParametersVersion
packages/account/src/providers/__generated__/operations.ts:1061
SelectNetworkArguments:
RequireAtLeastOne<Network,"chainId"|"url">
Name
SelectNetworkArguments
Select a network requires either the chainId or the url.
packages/account/src/connectors/types/data-type.ts:37
SqueezedOutStatus:
GqlSqueezedOutStatusFragment
packages/account/src/providers/transaction-summary/types.ts:22
Status:
object
connected:
boolean
installed:
boolean
packages/account/src/connectors/fuel.ts:40
SubmittedStatus:
GqlSubmittedStatusFragment
packages/account/src/providers/transaction-summary/types.ts:21
SuccessStatus:
GqlSuccessStatusFragment
packages/account/src/providers/transaction-summary/types.ts:19
Time:
SubmittedStatus["time"] |SuccessStatus["time"] |FailureStatus["time"]
packages/account/src/providers/transaction-summary/types.ts:26
TransactionCost:
object
addedSignatures:
number
optionaldryRunStatus:DryRunStatus
estimatedPredicates:
TransactionRequestInput[]
gasPrice:
BN
gasUsed:
BN
maxFee:
BN
maxGas:
BN
minFee:
BN
minGas:
BN
missingContractIds:
string[]
outputVariables:
number
receipts:
TransactionResultReceipt[]
requiredQuantities:
CoinQuantity[]
optionalupdateMaxFee:boolean
packages/account/src/providers/provider.ts:197
TransactionCostParams:
EstimateTransactionParams&object
optionalquantities:CoinQuantity[]
The quantities to forward to the contract.
optionalsignatureCallback: (request) =>Promise<ScriptTransactionRequest>
A callback to sign the transaction.
• request: ScriptTransactionRequest
The transaction request to sign.
Promise<ScriptTransactionRequest >
A promise that resolves to the signed transaction request.
packages/account/src/providers/provider.ts:351
TransactionRequest:
ScriptTransactionRequest|CreateTransactionRequest|BlobTransactionRequest|UpgradeTransactionRequest|UploadTransactionRequest
packages/account/src/providers/transaction-request/types.ts:25
TransactionRequestInput:
CoinTransactionRequestInput|ContractTransactionRequestInput|MessageTransactionRequestInput
packages/account/src/providers/transaction-request/input.ts:82
TransactionRequestLike:
object&ScriptTransactionRequestLike|object&CreateTransactionRequestLike|object&BlobTransactionRequestLike|object&UpgradeTransactionRequestLike|object&UploadTransactionRequestLike
packages/account/src/providers/transaction-request/types.ts:31
TransactionRequestOutput:
CoinTransactionRequestOutput|ContractTransactionRequestOutput|ChangeTransactionRequestOutput|VariableTransactionRequestOutput|ContractCreatedTransactionRequestOutput
packages/account/src/providers/transaction-request/output.ts:41
TransactionResultBurnReceipt:
ReceiptBurn
packages/account/src/providers/transaction-response/transaction-response.ts:67
TransactionResultMintReceipt:
ReceiptMint
packages/account/src/providers/transaction-response/transaction-response.ts:66
TransactionSummary<
TTransactionType>:object
• TTransactionType = void
optionalblockId:BlockId
burnedAssets:
BurnedAsset[]
optionaldate: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[]
optionalstatus:TransactionStatus
optionaltime:string
tip:
BN
transaction:
Transaction<TTransactionType>
type:
TransactionTypeName
packages/account/src/providers/transaction-summary/types.ts:160
TransferParams:
object
amount:
BigNumberish
optionalassetId:BytesLike
destination:
string|AbstractAddress
packages/account/src/account.ts:56
TxParameters:
object
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
packages/account/src/providers/__generated__/operations.ts:1208
TxParamsType:
Pick<ScriptTransactionRequestLike,"gasLimit"|"tip"|"maturity"|"maxFee"|"witnessLimit">
packages/account/src/account.ts:51
UTXOValidationParams:
object
UTXO validation params
optionalutxoValidation:boolean
packages/account/src/providers/provider.ts:337
VariableTransactionRequestOutput:
object
type:
OutputType.Variable
packages/account/src/providers/transaction-request/output.ts:31
VaultConfig:
object
optionalsecret:string
optionaltitle:string
type:
string
packages/account/src/wallet-manager/types.ts:17
VaultsState:
object[]
packages/account/src/wallet-manager/types.ts:23
Version:
object
Name
Version
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
packages/account/src/connectors/types/data-type.ts:7
WalletManagerAccount:
object
address:
AbstractAddress
publicKey:
string
optionalvaultId:number
packages/account/src/wallet-manager/types.ts:7
WalletManagerOptions:
object
storage:
StorageAbstract
packages/account/src/wallet-manager/types.ts:13
constBLOCKS_PAGE_SIZE_LIMIT:5=5
packages/account/src/providers/provider.ts:68
constCHAIN_IDS:object
eth:
object
eth.foundry:
number=31337
eth.mainnet:
number=1
eth.sepolia:
number=11155111
fuel:
object
fuel.devnet:
number=0
fuel.mainnet:
number=9889
fuel.testnet:
number=0
packages/account/src/providers/chains.ts:1
constDEFAULT_RESOURCE_CACHE_TTL:20000=20_000
packages/account/src/providers/provider.ts:69
constFuelConnectorEventType:"FuelConnector"='FuelConnector'
packages/account/src/connectors/types/connector-types.ts:42
constMNEMONIC_SIZES:number[]
packages/account/src/mnemonic/mnemonic.ts:20
constRESOURCES_PAGE_SIZE_LIMIT:512=512
packages/account/src/providers/provider.ts:67
constassets:object[]
packages/account/src/providers/assets/assets.ts:621
constenglish:string[]
packages/account/src/wordlists/words/english.ts:1
constfuelAssetsBaseUrl:"https://cdn.fuel.network/assets/"='https://cdn.fuel.network/assets/'
packages/account/src/providers/assets/utils/fuelAssetsBaseUrl.ts:1
constrawAssets:Assets
packages/account/src/providers/assets/assets.ts:6
addAmountToCoinQuantities(
params):CoinQuantity[]
• params: IAddAmountToAssetParams
CoinQuantity []
packages/account/src/providers/coin-quantity.ts:40
assemblePanicError(
statusReason,metadata):FuelError
Assembles an error message for a panic status.
• statusReason: string
• metadata: Record<string, unknown>
FuelError
The error message.
packages/account/src/providers/utils/extract-tx-error.ts:22
assembleReceiptByType(
receipt):ReceiptCall|ReceiptReturn|ReceiptReturnData|ReceiptPanic|ReceiptRevert|ReceiptLog|ReceiptLogData|ReceiptTransfer|ReceiptTransferOut|ReceiptScriptResult|ReceiptMessageOut|ReceiptMint|ReceiptBurn
• receipt: GqlReceiptFragment
ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn
packages/account/src/providers/utils/receipts.ts:64
assembleRevertError(
receipts,logs,metadata):FuelError
Assembles an error message for a revert status.
• receipts: TransactionResultReceipt[]
The transaction result processed receipts.
• logs: unknown[]
The transaction decoded logs.
• metadata: Record<string, unknown>
FuelError
The error message.
packages/account/src/providers/utils/extract-tx-error.ts:47
cacheFor<
F>(fn,__namedParameters):F
• F extends (...args) => Promise<unknown>
• fn: F
• __namedParameters: CacheForOptions
F
packages/account/src/connectors/utils/cache.ts:16
cacheRequestInputsResources(
inputs):Required<ExcludeResourcesOption>
• inputs: TransactionRequestInput []
Required<ExcludeResourcesOption>
packages/account/src/providers/transaction-request/helpers.ts:62
cacheRequestInputsResourcesFromOwner(
inputs,owner):ExcludeResourcesOption
• inputs: TransactionRequestInput []
• owner: AbstractAddress
ExcludeResourcesOption
packages/account/src/providers/transaction-request/helpers.ts:78
calculateGasFee(
params):BN
• params: CalculateGasFeeParams
BN
packages/account/src/providers/utils/gas.ts:241
calculateMetadataGasForTxBlob(
__namedParameters):BN
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
• __namedParameters.witnessBytesSize: number
BN
packages/account/src/providers/utils/gas.ts:162
calculateMetadataGasForTxCreate(
__namedParameters):BN
• __namedParameters
• __namedParameters.contractBytesSize: BN
• __namedParameters.gasCosts: GasCosts
• __namedParameters.stateRootSize: number
• __namedParameters.txBytesSize: number
BN
packages/account/src/providers/utils/gas.ts:131
calculateMetadataGasForTxScript(
__namedParameters):BN
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
BN
packages/account/src/providers/utils/gas.ts:152
calculateMetadataGasForTxUpgrade(
__namedParameters):BN
• __namedParameters
• __namedParameters.consensusSize?: number
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
BN
packages/account/src/providers/utils/gas.ts:176
calculateMetadataGasForTxUpload(
__namedParameters):BN
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.subsectionSize: number
• __namedParameters.subsectionsSize: number
• __namedParameters.txBytesSize: number
BN
packages/account/src/providers/utils/gas.ts:195
calculateMinGasForTxUpload(
__namedParameters):BN
• __namedParameters
• __namedParameters.baseMinGas: number
• __namedParameters.gasCosts: GasCosts
• __namedParameters.subsectionSize: number
BN
packages/account/src/providers/utils/gas.ts:217
calculateTXFeeForSummary(
params):BN
• params: CalculateTXFeeForSummaryParams
BN
packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:35
deferPromise<
R>():DeferPromise<R>
• R = unknown
DeferPromise <R>
packages/account/src/connectors/utils/promises.ts:11
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.
• connector: FuelConnector
void
packages/account/src/connectors/utils/dispatch-fuel-connector-event.ts:8
extractBurnedAssetsFromReceipts(
receipts):MintedAsset[]
• receipts: TransactionResultReceipt[]
MintedAsset []
packages/account/src/providers/transaction-summary/receipt.ts:31
extractMintedAssetsFromReceipts(
receipts):MintedAsset[]
• receipts: TransactionResultReceipt[]
MintedAsset []
packages/account/src/providers/transaction-summary/receipt.ts:12
extractTxError(
params):FuelError
Extracts the transaction error and returns a FuelError object.
• params: IExtractTxError
FuelError
The FuelError object.
packages/account/src/providers/utils/extract-tx-error.ts:132
gasUsedByInputs(
inputs,txBytesSize,gasCosts):BN
• inputs: (TransactionRequestInput | Input)[]
• txBytesSize: number
• gasCosts: GasCosts
BN
packages/account/src/providers/utils/gas.ts:40
getAssetAmountInRequestInputs(
inputs,assetId,baseAsset):BN
• inputs: TransactionRequestInput []
• assetId: string
• baseAsset: string
BN
packages/account/src/providers/transaction-request/helpers.ts:45
getAssetEth(
asset,chainId?):undefined|AssetEth
Returns the asset's details on Ethereum
• asset: Asset
• chainId?: number
undefined | AssetEth
packages/account/src/providers/assets/utils/network.ts:80
getAssetFuel(
asset,chainId?):undefined|AssetFuel
Returns the asset's details on Fuel
• asset: Asset
• chainId?: number
undefined | AssetFuel
packages/account/src/providers/assets/utils/network.ts:90
getAssetNetwork<
T>(__namedParameters):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
• T extends undefined | NetworkTypes
• __namedParameters: GetAssetNetworkParams <T>
NetworkTypeToNetwork<T>
packages/account/src/providers/assets/utils/network.ts:32
getAssetWithNetwork<
T>(__namedParameters):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
• T extends NetworkTypes
• __namedParameters: GetAssetNetworkParams <T>
undefined | AssetEth | AssetFuel
packages/account/src/providers/assets/utils/network.ts:48
getDefaultChainId(
networkType):undefined|number
Returns the default chainId for the given network
• networkType: NetworkTypes
undefined | number
packages/account/src/providers/assets/utils/network.ts:11
getMaxGas(
params):BN
• params: IGetMaxGasParams
BN
packages/account/src/providers/utils/gas.ts:110
getMinGas(
params):BN
• params: IGetMinGasParams
BN
packages/account/src/providers/utils/gas.ts:88
getRequestInputResourceOwner(
input):BytesLike
• input: CoinTransactionRequestInput | MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:36
getTransactionSummary<
TTransactionType>(params):Promise<TransactionResult>
• TTransactionType = void
• params: GetTransactionSummaryParams
Promise<TransactionResult>
packages/account/src/providers/transaction-summary/get-transaction-summary.ts:26
isMessageCoin(
message):message is MessageCoin
• message: Message | MessageCoin
message is MessageCoin
packages/account/src/providers/message.ts:77
isRequestInputCoin(
input):input is CoinTransactionRequestInput
• input: TransactionRequestInput
input is CoinTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:13
isRequestInputCoinOrMessage(
input): input is CoinTransactionRequestInput | MessageTransactionRequestInput
• input: TransactionRequestInput
input is CoinTransactionRequestInput | MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:26
isRequestInputMessage(
input):input is MessageTransactionRequestInput
• input: TransactionRequestInput
input is MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:17
isRequestInputMessageWithoutData(
input):input is MessageTransactionRequestInput
• input: TransactionRequestInput
input is MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:21
isRequestInputResource(
input): input is CoinTransactionRequestInput | MessageTransactionRequestInput
• input: TransactionRequestInput
input is CoinTransactionRequestInput | MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:31
isRequestInputResourceFromOwner(
input,owner):boolean
• input: CoinTransactionRequestInput | MessageTransactionRequestInput
• owner: AbstractAddress
boolean
packages/account/src/providers/transaction-request/helpers.ts:40
processGqlReceipt(
gqlReceipt):TransactionResultReceipt
• gqlReceipt: GqlReceiptFragment
TransactionResultReceipt
packages/account/src/providers/transaction-summary/receipt.ts:9
resolveGasDependentCosts(
byteSize,gasDependentCost):BN
• byteSize: BNInput
• gasDependentCost: GqlDependentCost
BN
packages/account/src/providers/utils/gas.ts:29
resolveIconPaths(
assets,basePath):object[]
Returns the list of assets with the icon paths 'resolved'. eg. ./eth.svg -> https://some-url.com/eth.svg
• assets: Assets
List of assets
• basePath: string = './'
Base path for the icon URLs (default: './')
object[]
The assets with the icon paths resolved
packages/account/src/providers/assets/utils/resolveIconPaths.ts:11
urlJoin(
baseUrl, ...paths):string
• baseUrl: undefined | string
• ...paths: string[]
string
packages/account/src/providers/assets/utils/url.ts:5
withTimeout<
F,RT>(promise,timeout):Promise<RT>
• F extends Promise<unknown>
• RT = Awaited<F>
• promise: F
• timeout: number = 1050
Promise<RT>
packages/account/src/connectors/utils/promises.ts:23
AssetsEvent:
object
Event trigger when the assets list of metadata changed.
AssetsEvent
data:
Asset[]
type:
assets
packages/account/src/connectors/types/events.ts:114
ConnectionEvent:
object
Event trigger when connection status changes. With the new connection status.
ConnectionEvent
data:
boolean
type:
connection
packages/account/src/connectors/types/events.ts:52
ConnectorEvent:
object
Event trigger when the current connector has changed.
ConnectorEvent
data:
FuelConnector
type:
currentConnector
packages/account/src/connectors/types/events.ts:102
ConnectorsEvent:
object
Event trigger when the list of connectors has changed.
ConnectorsEvent
data:
FuelConnector[]
type:
connectors
packages/account/src/connectors/types/events.ts:90
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
data:
Network
type:
currentNetwork
packages/account/src/connectors/types/events.ts:65
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
data:
Network
type:
networks
packages/account/src/connectors/types/events.ts:78