@fuel-ts/account v0.94.6 • Docs
@fuel-ts/account
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
data
data:
string|null
type
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
data
data:
string[]
type
type:
accounts
Defined in
packages/account/src/connectors/types/events.ts:28
Asset
Asset:
object
Type declaration
icon
icon:
string
icon of the asset
name
name:
string
name of the asset
networks
networks: (
NetworkEthereum|NetworkFuel)[]
asset id on Fuel Network
symbol
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
header
header:
object
header.applicationHash
header.applicationHash:
string
header.daHeight
header.daHeight:
BN
header.eventInboxRoot
header.eventInboxRoot:
string
header.messageOutboxRoot
header.messageOutboxRoot:
string
header.prevRoot
header.prevRoot:
string
header.stateTransitionBytecodeVersion
header.stateTransitionBytecodeVersion:
string
header.transactionsCount
header.transactionsCount:
string
header.transactionsRoot
header.transactionsRoot:
string
height
height:
BN
id
id:
string
time
time:
string
transactionIds
transactionIds:
string[]
Defined in
packages/account/src/providers/provider.ts:89
BlockHeader
BlockHeader:
object
Type declaration
applicationHash
applicationHash:
string
consensusParametersVersion
consensusParametersVersion:
number
daHeight
daHeight:
BN
eventInboxRoot
eventInboxRoot:
string
height
height:
BN
id
id:
string
messageOutboxRoot
messageOutboxRoot:
string
messageReceiptCount
messageReceiptCount:
number
prevRoot
prevRoot:
string
stateTransitionBytecodeVersion
stateTransitionBytecodeVersion:
number
time
time:
string
transactionsCount
transactionsCount:
number
transactionsRoot
transactionsRoot:
string
Defined in
packages/account/src/providers/message.ts:39
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:158
CacheFor
CacheFor:
object
Index Signature
[key: string]: object | null
Defined in
packages/account/src/connectors/utils/cache.ts:3
CalculateTXFeeForSummaryParams
CalculateTXFeeForSummaryParams:
object
Type declaration
consensusParameters
consensusParameters:
Pick<ConsensusParameters,"gasCosts"> &object
Type declaration
feeParams
feeParams:
FeeParams
maxGasPerTx
maxGasPerTx:
BN
gasPrice
gasPrice:
BN
rawPayload
rawPayload:
string
tip
tip:
BN
totalFee?
optionaltotalFee:BN
Defined in
packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:24
CallResult
CallResult:
object
Type declaration
dryRunStatus?
optionaldryRunStatus:DryRunStatus
receipts
receipts:
TransactionResultReceipt[]
Defined in
packages/account/src/providers/provider.ts:76
ChainInfo
ChainInfo:
object
Chain information
Type declaration
baseChainHeight
baseChainHeight:
BN
consensusParameters
consensusParameters:
ConsensusParameters
latestBlock
latestBlock:
object
latestBlock.height
latestBlock.height:
BN
latestBlock.id
latestBlock.id:
string
latestBlock.time
latestBlock.time:
string
latestBlock.transactions
latestBlock.transactions:
object[]
name
name:
string
Defined in
packages/account/src/providers/provider.ts:166
ChangeTransactionRequestOutput
ChangeTransactionRequestOutput:
object
Type declaration
assetId
assetId:
BytesLike
Asset ID of coins
to
to:
BytesLike
Receiving address or script hash
type
type:
OutputType.Change
Defined in
packages/account/src/providers/transaction-request/output.ts:24
Coin
Coin:
object
A Fuel coin
Type declaration
amount
amount:
BN
assetId
assetId:
string
blockCreated
blockCreated:
BN
id
id:
string
owner
owner:
AbstractAddress
predicate?
optionalpredicate:BytesLike
predicateData?
optionalpredicateData:BytesLike
txCreatedIdx
txCreatedIdx:
BN
Defined in
packages/account/src/providers/coin.ts:7
CoinQuantity
CoinQuantity:
object
Type declaration
amount
amount:
BN
assetId
assetId:
string
max?
optionalmax:BN
Defined in
packages/account/src/providers/coin-quantity.ts:9
CoinQuantityLike
CoinQuantityLike: [
BigNumberish,BytesLike,BigNumberish] |object
Defined in
packages/account/src/providers/coin-quantity.ts:6
CoinTransactionRequestInput
CoinTransactionRequestInput:
object
Type declaration
amount
amount:
BigNumberish
Amount of coins
assetId
assetId:
BytesLike
Asset ID of the coins
id
id:
BytesLike
UTXO ID
owner
owner:
BytesLike
Owning address or script hash
predicate?
optionalpredicate:BytesLike
Predicate bytecode
predicateData?
optionalpredicateData:BytesLike
Predicate input data (parameters)
predicateGasUsed?
optionalpredicateGasUsed:BigNumberish
Gas used by predicate
txPointer
txPointer:
BytesLike
Points to the TX whose output is being spent. (TxPointer)
type
type:
InputType.Coin
witnessIndex
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
amount
amount:
BigNumberish
Amount of coins to send
assetId
assetId:
BytesLike
Asset ID of coins
to
to:
BytesLike
Receiving address or script hash
type
type:
OutputType.Coin
Defined in
packages/account/src/providers/transaction-request/output.ts:10
ConnectorMetadata
ConnectorMetadata:
object
Type declaration
image?
optionalimage:string|object
install
install:
object
install.action
install.action:
string
install.description
install.description:
string
install.link
install.link:
string
Defined in
packages/account/src/connectors/types/connector-metadata.ts:2
ConsensusParameters
ConsensusParameters:
object
Type declaration
baseAssetId
baseAssetId:
string
chainId
chainId:
BN
contractParameters
contractParameters:
ModifyStringToBN<ContractParameters>
feeParameters
feeParameters:
ModifyStringToBN<FeeParameters>
gasCosts
gasCosts:
GasCosts
predicateParameters
predicateParameters:
ModifyStringToBN<PredicateParameters>
scriptParameters
scriptParameters:
ModifyStringToBN<ScriptParameters>
txParameters
txParameters:
ModifyStringToBN<TxParameters>
version
version:
GqlConsensusParametersVersion
Defined in
packages/account/src/providers/provider.ts:151
ContractCreatedTransactionRequestOutput
ContractCreatedTransactionRequestOutput:
object
Type declaration
contractId
contractId:
BytesLike
Contract ID
stateRoot
stateRoot:
BytesLike
State Root
type
type:
OutputType.ContractCreated
Defined in
packages/account/src/providers/transaction-request/output.ts:34
ContractParameters
ContractParameters:
object
Type declaration
contractMaxSize
contractMaxSize:
Scalars["U64"]["output"]
maxStorageSlots
maxStorageSlots:
Scalars["U64"]["output"]
version
version:
GqlContractParametersVersion
Defined in
packages/account/src/providers/__generated__/operations.ts:236
ContractResult
ContractResult:
object
Deployed Contract bytecode and contract id
Type declaration
bytecode
bytecode:
string
id
id:
string
Defined in
packages/account/src/providers/provider.ts:133
ContractTransactionRequestInput
ContractTransactionRequestInput:
object
Type declaration
contractId
contractId:
BytesLike
Contract ID
txPointer
txPointer:
BytesLike
Points to the TX whose output is being spent. (TxPointer)
type
type:
InputType.Contract
Defined in
packages/account/src/providers/transaction-request/input.ts:73
ContractTransactionRequestOutput
ContractTransactionRequestOutput:
object
Type declaration
inputIndex
inputIndex:
number
Index of input contract
type
type:
OutputType.Contract
Defined in
packages/account/src/providers/transaction-request/output.ts:19
DeferPromise<R>
DeferPromise<
R>:object
Type Parameters
• R = unknown
Type declaration
promise
promise:
Promise<R>
reject()
reject: (
error) =>void
Parameters
• error: unknown
Returns
void
resolve()
resolve: (
value) =>void
Parameters
• value: R
Returns
void
Defined in
packages/account/src/connectors/utils/promises.ts:5
DryRunFailureStatusFragment
DryRunFailureStatusFragment:
GqlDryRunFailureStatusFragment
Defined in
packages/account/src/providers/provider.ts:71
DryRunStatus
DryRunStatus:
DryRunFailureStatusFragment|DryRunSuccessStatusFragment
Defined in
packages/account/src/providers/provider.ts:74
DryRunSuccessStatusFragment
DryRunSuccessStatusFragment:
GqlDryRunSuccessStatusFragment
Defined in
packages/account/src/providers/provider.ts:72
EstimateTransactionParams
EstimateTransactionParams:
object
Transaction estimation params
Type declaration
estimateTxDependencies?
optionalestimateTxDependencies:boolean
Estimate the transaction dependencies.
Defined in
packages/account/src/providers/provider.ts:344
EstimateTxDependenciesReturns
EstimateTxDependenciesReturns:
CallResult&object
Type declaration
missingContractIds
missingContractIds:
string[]
outputVariables
outputVariables:
number
Defined in
packages/account/src/providers/provider.ts:81
EstimatedTxParams
EstimatedTxParams:
Pick<TransactionCost,"estimatedPredicates"|"addedSignatures"|"requiredQuantities"|"updateMaxFee"|"gasPrice">
Defined in
packages/account/src/account.ts:62
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:68
FeeParameters
FeeParameters:
object
Type declaration
gasPerByte
gasPerByte:
Scalars["U64"]["output"]
gasPriceFactor
gasPriceFactor:
Scalars["U64"]["output"]
version
version:
GqlFeeParametersVersion
Defined in
packages/account/src/providers/__generated__/operations.ts:295
FuelABI
FuelABI:
JsonAbi
ABI that represents a binary code interface from Sway.
Read more at: https://docs.fuel.network/docs/specs/abi/json-abi-format/
Defined in
packages/account/src/connectors/types/data-type.ts:44
FuelConfig
FuelConfig:
object
Type declaration
connectors?
optionalconnectors:FuelConnector[]
storage?
optionalstorage:StorageAbstract|null
targetObject?
optionaltargetObject:TargetObject
Defined in
packages/account/src/connectors/fuel.ts:30
FuelConnectorEvents
FuelConnectorEvents:
ConnectionEvent|NetworkEvent|NetworksEvent|AccountEvent|AccountsEvent|ConnectorsEvent|ConnectorEvent|AssetsEvent
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
emitEvents?
optionalemitEvents:boolean
Defined in
packages/account/src/connectors/fuel.ts:36
FuelEventArg<T>
FuelEventArg<
T>:Extract<FuelConnectorEventTypes,object>["data"]
Extract the event argument type from the event type.
Type Parameters
• T extends FuelConnectorEvents["type"]
Defined in
packages/account/src/connectors/types/events.ts:16
GasCosts
GasCosts:
object
Type declaration
add
add:
Scalars["U64"]["output"]
addi
addi:
Scalars["U64"]["output"]
aloc
aloc:
Scalars["U64"]["output"]
alocDependentCost
alocDependentCost:
GqlDependentCost
and
and:
Scalars["U64"]["output"]
andi
andi:
Scalars["U64"]["output"]
bal
bal:
Scalars["U64"]["output"]
bhei
bhei:
Scalars["U64"]["output"]
bhsh
bhsh:
Scalars["U64"]["output"]
bldd?
optionalbldd:Maybe<GqlDependentCost>
bsiz?
optionalbsiz:Maybe<GqlDependentCost>
burn
burn:
Scalars["U64"]["output"]
call
call:
GqlDependentCost
cb
cb:
Scalars["U64"]["output"]
ccp
ccp:
GqlDependentCost
cfe
cfe:
GqlDependentCost
cfei
cfei:
Scalars["U64"]["output"]
cfeiDependentCost
cfeiDependentCost:
GqlDependentCost
cfsi
cfsi:
Scalars["U64"]["output"]
contractRoot
contractRoot:
GqlDependentCost
croo
croo:
GqlDependentCost
csiz
csiz:
GqlDependentCost
div
div:
Scalars["U64"]["output"]
divi
divi:
Scalars["U64"]["output"]
eck1
eck1:
Scalars["U64"]["output"]
ecr1
ecr1:
Scalars["U64"]["output"]
ed19
ed19:
Scalars["U64"]["output"]
ed19DependentCost
ed19DependentCost:
GqlDependentCost
eq
eq:
Scalars["U64"]["output"]
exp
exp:
Scalars["U64"]["output"]
expi
expi:
Scalars["U64"]["output"]
flag
flag:
Scalars["U64"]["output"]
gm
gm:
Scalars["U64"]["output"]
gt
gt:
Scalars["U64"]["output"]
gtf
gtf:
Scalars["U64"]["output"]
ji
ji:
Scalars["U64"]["output"]
jmp
jmp:
Scalars["U64"]["output"]
jmpb
jmpb:
Scalars["U64"]["output"]
jmpf
jmpf:
Scalars["U64"]["output"]
jne
jne:
Scalars["U64"]["output"]
jneb
jneb:
Scalars["U64"]["output"]
jnef
jnef:
Scalars["U64"]["output"]
jnei
jnei:
Scalars["U64"]["output"]
jnzb
jnzb:
Scalars["U64"]["output"]
jnzf
jnzf:
Scalars["U64"]["output"]
jnzi
jnzi:
Scalars["U64"]["output"]
k256
k256:
GqlDependentCost
lb
lb:
Scalars["U64"]["output"]
ldc
ldc:
GqlDependentCost
log
log:
Scalars["U64"]["output"]
logd
logd:
GqlDependentCost
lt
lt:
Scalars["U64"]["output"]
lw
lw:
Scalars["U64"]["output"]
mcl
mcl:
GqlDependentCost
mcli
mcli:
GqlDependentCost
mcp
mcp:
GqlDependentCost
mcpi
mcpi:
GqlDependentCost
meq
meq:
GqlDependentCost
mint
mint:
Scalars["U64"]["output"]
mldv
mldv:
Scalars["U64"]["output"]
mlog
mlog:
Scalars["U64"]["output"]
modOp
modOp:
Scalars["U64"]["output"]
modi
modi:
Scalars["U64"]["output"]
moveOp
moveOp:
Scalars["U64"]["output"]
movi
movi:
Scalars["U64"]["output"]
mroo
mroo:
Scalars["U64"]["output"]
mul
mul:
Scalars["U64"]["output"]
muli
muli:
Scalars["U64"]["output"]
newStoragePerByte
newStoragePerByte:
Scalars["U64"]["output"]
noop
noop:
Scalars["U64"]["output"]
not
not:
Scalars["U64"]["output"]
or
or:
Scalars["U64"]["output"]
ori
ori:
Scalars["U64"]["output"]
poph
poph:
Scalars["U64"]["output"]
popl
popl:
Scalars["U64"]["output"]
pshh
pshh:
Scalars["U64"]["output"]
pshl
pshl:
Scalars["U64"]["output"]
ret
ret:
Scalars["U64"]["output"]
retd
retd:
GqlDependentCost
rvrt
rvrt:
Scalars["U64"]["output"]
s256
s256:
GqlDependentCost
sb
sb:
Scalars["U64"]["output"]
scwq
scwq:
GqlDependentCost
sll
sll:
Scalars["U64"]["output"]
slli
slli:
Scalars["U64"]["output"]
smo
smo:
GqlDependentCost
srl
srl:
Scalars["U64"]["output"]
srli
srli:
Scalars["U64"]["output"]
srw
srw:
Scalars["U64"]["output"]
srwq
srwq:
GqlDependentCost
stateRoot
stateRoot:
GqlDependentCost
sub
sub:
Scalars["U64"]["output"]
subi
subi:
Scalars["U64"]["output"]
sw
sw:
Scalars["U64"]["output"]
sww
sww:
Scalars["U64"]["output"]
swwq
swwq:
GqlDependentCost
time
time:
Scalars["U64"]["output"]
tr
tr:
Scalars["U64"]["output"]
tro
tro:
Scalars["U64"]["output"]
version
version:
GqlGasCostsVersion
vmInitialization
vmInitialization:
GqlDependentCost
wdam
wdam:
Scalars["U64"]["output"]
wdcm
wdcm:
Scalars["U64"]["output"]
wddv
wddv:
Scalars["U64"]["output"]
wdmd
wdmd:
Scalars["U64"]["output"]
wdml
wdml:
Scalars["U64"]["output"]
wdmm
wdmm:
Scalars["U64"]["output"]
wdop
wdop:
Scalars["U64"]["output"]
wqam
wqam:
Scalars["U64"]["output"]
wqcm
wqcm:
Scalars["U64"]["output"]
wqdv
wqdv:
Scalars["U64"]["output"]
wqmd
wqmd:
Scalars["U64"]["output"]
wqml
wqml:
Scalars["U64"]["output"]
wqmm
wqmm:
Scalars["U64"]["output"]
wqop
wqop:
Scalars["U64"]["output"]
xor
xor:
Scalars["U64"]["output"]
xori
xori:
Scalars["U64"]["output"]
Defined in
packages/account/src/providers/__generated__/operations.ts:305
GetAssetNetworkParams<T>
GetAssetNetworkParams<
T>:object
Type Parameters
• T extends NetworkTypes | undefined
Type declaration
asset
asset:
Asset
chainId?
optionalchainId:number
networkType
networkType:
T
Defined in
packages/account/src/providers/assets/utils/network.ts:22
GetBalancesResponse
GetBalancesResponse:
object
Type declaration
balances
balances:
CoinQuantity[]
Defined in
packages/account/src/providers/provider.ts:116
GetBlocksResponse
GetBlocksResponse:
object
Type declaration
blocks
blocks:
Block[]
pageInfo
pageInfo:
GqlPageInfo
Defined in
packages/account/src/providers/provider.ts:125
GetCoinsResponse
GetCoinsResponse:
object
Type declaration
coins
coins:
Coin[]
pageInfo
pageInfo:
GqlPageInfo
Defined in
packages/account/src/providers/provider.ts:106
GetMessagesResponse
GetMessagesResponse:
object
Type declaration
messages
messages:
Message[]
pageInfo
pageInfo:
GqlPageInfo
Defined in
packages/account/src/providers/provider.ts:111
GetOperationParams
GetOperationParams:
object&InputOutputParam&ReceiptParam&RawPayloadParam
Type declaration
abiMap?
optionalabiMap:AbiMap
baseAssetId
baseAssetId:
string
maxInputs
maxInputs:
BN
transactionType
transactionType:
TransactionType
Defined in
packages/account/src/providers/transaction-summary/types.ts:142
GetTransactionsResponse
GetTransactionsResponse:
object
Type declaration
pageInfo
pageInfo:
GqlPageInfo
transactions
transactions:
Transaction[]
Defined in
packages/account/src/providers/provider.ts:120
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
inputs
inputs:
Input[]
Defined in
packages/account/src/providers/transaction-summary/types.ts:117
JsonAbisFromAllCalls
JsonAbisFromAllCalls:
object
Type declaration
main
main:
JsonAbi
otherContractsAbis
otherContractsAbis:
Record<string,JsonAbi>
Defined in
packages/account/src/providers/transaction-request/types.ts:38
MerkleProof
MerkleProof:
object
Type declaration
proofIndex
proofIndex:
BN
proofSet
proofSet:
string[]
Defined in
packages/account/src/providers/message.ts:34
Message
Message:
object
A Fuel message
Type declaration
amount
amount:
BN
daHeight
daHeight:
BN
data
data:
BytesLike
messageId
messageId:
BytesLike
nonce
nonce:
BytesLike
predicate?
optionalpredicate:BytesLike
predicateData?
optionalpredicateData:BytesLike
recipient
recipient:
AbstractAddress
sender
sender:
AbstractAddress
Defined in
packages/account/src/providers/message.ts:10
MessageCoin
MessageCoin:
object
Type declaration
amount
amount:
BN
assetId
assetId:
string
daHeight
daHeight:
BN
nonce
nonce:
BytesLike
predicate?
optionalpredicate:BytesLike
predicateData?
optionalpredicateData:BytesLike
recipient
recipient:
AbstractAddress
sender
sender:
AbstractAddress
Defined in
packages/account/src/providers/message.ts:23
MessageProof
MessageProof:
object
Message Proof
Type declaration
amount
amount:
BN
blockProof
blockProof:
MerkleProof
commitBlockHeader
commitBlockHeader:
BlockHeader
data
data:
string
messageBlockHeader
messageBlockHeader:
BlockHeader
messageProof
messageProof:
MerkleProof
nonce
nonce:
string
recipient
recipient:
AbstractAddress
sender
sender:
AbstractAddress
Defined in
packages/account/src/providers/message.ts:58
MessageStatus
MessageStatus:
object
Message Status
Type declaration
state
state:
GqlMessageState
Defined in
packages/account/src/providers/message.ts:73
MessageTransactionRequestInput
MessageTransactionRequestInput:
object
Type declaration
amount
amount:
BigNumberish
Amount of coins
data?
optionaldata:BytesLike
data of message
nonce
nonce:
BytesLike
Unique nonce of message
predicate?
optionalpredicate:BytesLike
Predicate bytecode
predicateData?
optionalpredicateData:BytesLike
Predicate input data (parameters)
predicateGasUsed?
optionalpredicateGasUsed:BigNumberish
Gas used by predicate
recipient
recipient:
BytesLike
Address of recipient
sender
sender:
BytesLike
Address of sender
type
type:
InputType.Message
witnessIndex
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
Name
Network
Type declaration
chainId
chainId:
number
The chain id of the network.
url
url:
string
The name of the network.
Defined in
packages/account/src/connectors/types/data-type.ts:21
NetworkEthereum
NetworkEthereum:
object
Type declaration
address?
optionaladdress:string
address of the asset contract
chainId
chainId:
number
chain id of the network
decimals
decimals:
number
number of decimals of the asset
type
type:
"ethereum"
type of network
Defined in
packages/account/src/providers/assets/types.ts:1
NetworkFuel
NetworkFuel:
object
Type declaration
assetId
assetId:
string
assetId on the Fuel Network
chainId
chainId:
number
chain id of the network
contractId?
optionalcontractId:string
the contractId of that generated the Asset on the Fuel Network
decimals
decimals:
number
number of decimals of the asset
type
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
maxDepth
maxDepth:
BN
maxTx
maxTx:
BN
nodeVersion
nodeVersion:
string
utxoValidation
utxoValidation:
boolean
vmBacktrace
vmBacktrace:
boolean
Defined in
packages/account/src/providers/provider.ts:181
NodeInfoAndConsensusParameters
NodeInfoAndConsensusParameters:
object
Type declaration
gasPerByte
gasPerByte:
BN
gasPriceFactor
gasPriceFactor:
BN
maxGasPerTx
maxGasPerTx:
BN
nodeVersion
nodeVersion:
string
Defined in
packages/account/src/providers/provider.ts:189
Operation
Operation:
object
Type declaration
assetsSent?
optionalassetsSent:OperationCoin[]
calls?
optionalcalls:OperationFunctionCall[]
from?
optionalfrom:OperationTransactionAddress
name?
optionalname:OperationName
to?
optionalto:OperationTransactionAddress
Defined in
packages/account/src/providers/transaction-summary/types.ts:87
OperationCoin
OperationCoin:
object
Type declaration
amount
amount:
BNInput
assetId
assetId:
string
Defined in
packages/account/src/providers/transaction-summary/types.ts:76
OperationFunctionCall
OperationFunctionCall:
object&Partial<OperationCoin>
Type declaration
argumentsProvided?
optionalargumentsProvided:Record<string,unknown>
functionName
functionName:
string
functionSignature
functionSignature:
string
Defined in
packages/account/src/providers/transaction-summary/types.ts:81
OperationTransactionAddress
OperationTransactionAddress:
object
Type declaration
address
address:
string
chain?
optionalchain:ChainName
type
type:
AddressType
Defined in
packages/account/src/providers/transaction-summary/types.ts:111
OutputParam
OutputParam:
object
Type declaration
outputs
outputs:
Output[]
Defined in
packages/account/src/providers/transaction-summary/types.ts:121
PredicateParameters
PredicateParameters:
object
Type declaration
maxGasPerPredicate
maxGasPerPredicate:
Scalars["U64"]["output"]
maxMessageDataLength
maxMessageDataLength:
Scalars["U64"]["output"]
maxPredicateDataLength
maxPredicateDataLength:
Scalars["U64"]["output"]
maxPredicateLength
maxPredicateLength:
Scalars["U64"]["output"]
version
version:
GqlPredicateParametersVersion
Defined in
packages/account/src/providers/__generated__/operations.ts:752
PredicateParams<TData, TConfigurables>
PredicateParams<
TData,TConfigurables>:object
Type Parameters
• TData extends InputValue[] = InputValue[]
• TConfigurables extends object | undefined = object
Type declaration
abi?
optionalabi:JsonAbi
bytecode
bytecode:
BytesLike
configurableConstants?
optionalconfigurableConstants:TConfigurables
data?
optionaldata:TData
provider
provider:
Provider
Defined in
packages/account/src/predicate/predicate.ts:29
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:369
ProviderOptions
ProviderOptions:
object
Type declaration
fetch()?
optionalfetch: (url,requestInit?,providerOptions?) =>Promise<Response>
Custom fetch function to use for making requests.
Parameters
• url: string
• requestInit?: RequestInit
• providerOptions?: Omit<ProviderOptions, "fetch">
Returns
Promise<Response>
headers?
optionalheaders:RequestInit["headers"]
Custom headers to include in the request.
requestMiddleware()?
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.
Parameters
• request: RequestInit
Returns
RequestInit | Promise<RequestInit>
resourceCacheTTL?
optionalresourceCacheTTL:number
Resources cache for the given time [ms]. If set to -1, the cache will be disabled.
retryOptions?
optionalretryOptions:RetryOptions
Retry options to use when fetching data from the node.
timeout?
optionaltimeout:number
Timeout [ms] after which every request will be aborted.
Defined in
packages/account/src/providers/provider.ts:302
ProviderSendTxParams
ProviderSendTxParams:
EstimateTransactionParams
Provider Send transaction params
Defined in
packages/account/src/providers/provider.ts:374
RawCoin
RawCoin:
object
Type declaration
amount
amount:
string
assetId
assetId:
string
blockCreated
blockCreated:
string
owner
owner:
string
txCreatedIdx
txCreatedIdx:
string
utxoId
utxoId:
string
Defined in
packages/account/src/providers/resource.ts:6
RawMessage
RawMessage:
object
Type declaration
amount
amount:
string
assetId
assetId:
string
daHeight
daHeight:
string
data
data:
string
nonce
nonce:
string
recipient
recipient:
string
sender
sender:
string
Defined in
packages/account/src/providers/resource.ts:15
RawPayloadParam
RawPayloadParam:
object
Type declaration
rawPayload?
optionalrawPayload: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
receipts
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
maxScriptDataLength
maxScriptDataLength:
Scalars["U64"]["output"]
maxScriptLength
maxScriptLength:
Scalars["U64"]["output"]
version
version:
GqlScriptParametersVersion
Defined in
packages/account/src/providers/__generated__/operations.ts:1061
SelectNetworkArguments
SelectNetworkArguments:
RequireAtLeastOne<Network,"chainId"|"url">
Name
SelectNetworkArguments
Select a network requires either the chainId or the url.
Defined in
packages/account/src/connectors/types/data-type.ts:37
SqueezedOutStatus
SqueezedOutStatus:
GqlSqueezedOutStatusFragment
Defined in
packages/account/src/providers/transaction-summary/types.ts:22
Status
Status:
object
Type declaration
connected
connected:
boolean
installed
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
addedSignatures
addedSignatures:
number
dryRunStatus?
optionaldryRunStatus:DryRunStatus
estimatedPredicates
estimatedPredicates:
TransactionRequestInput[]
gasPrice
gasPrice:
BN
gasUsed
gasUsed:
BN
maxFee
maxFee:
BN
maxGas
maxGas:
BN
minFee
minFee:
BN
minGas
minGas:
BN
missingContractIds
missingContractIds:
string[]
outputVariables
outputVariables:
number
receipts
receipts:
TransactionResultReceipt[]
requiredQuantities
requiredQuantities:
CoinQuantity[]
updateMaxFee?
optionalupdateMaxFee:boolean
Defined in
packages/account/src/providers/provider.ts:197
TransactionCostParams
TransactionCostParams:
EstimateTransactionParams&object
Type declaration
quantities?
optionalquantities:CoinQuantity[]
The quantities to forward to the contract.
signatureCallback()?
optionalsignatureCallback: (request) =>Promise<ScriptTransactionRequest>
A callback to sign the transaction.
Parameters
• request: ScriptTransactionRequest
The transaction request to sign.
Returns
Promise<ScriptTransactionRequest>
A promise that resolves to the signed transaction request.
Defined in
packages/account/src/providers/provider.ts:351
TransactionRequest
TransactionRequest:
ScriptTransactionRequest|CreateTransactionRequest|BlobTransactionRequest|UpgradeTransactionRequest|UploadTransactionRequest
Defined in
packages/account/src/providers/transaction-request/types.ts:25
TransactionRequestInput
TransactionRequestInput:
CoinTransactionRequestInput|ContractTransactionRequestInput|MessageTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/input.ts:82
TransactionRequestLike
TransactionRequestLike:
object&ScriptTransactionRequestLike|object&CreateTransactionRequestLike|object&BlobTransactionRequestLike|object&UpgradeTransactionRequestLike|object&UploadTransactionRequestLike
Defined in
packages/account/src/providers/transaction-request/types.ts:31
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:67
TransactionResultMintReceipt
TransactionResultMintReceipt:
ReceiptMint
Defined in
packages/account/src/providers/transaction-response/transaction-response.ts:66
TransactionSummary<TTransactionType>
TransactionSummary<
TTransactionType>:object
Type Parameters
• TTransactionType = void
Type declaration
blockId?
optionalblockId:BlockId
burnedAssets
burnedAssets:
BurnedAsset[]
date?
optionaldate:Date
fee
fee:
BN
gasUsed
gasUsed:
BN
id
id:
string
isStatusFailure
isStatusFailure:
boolean
isStatusPending
isStatusPending:
boolean
isStatusSuccess
isStatusSuccess:
boolean
isTypeBlob
isTypeBlob:
boolean
isTypeCreate
isTypeCreate:
boolean
isTypeMint
isTypeMint:
boolean
isTypeScript
isTypeScript:
boolean
isTypeUpgrade
isTypeUpgrade:
boolean
isTypeUpload
isTypeUpload:
boolean
mintedAssets
mintedAssets:
MintedAsset[]
operations
operations:
Operation[]
receipts
receipts:
TransactionResultReceipt[]
status?
optionalstatus:TransactionStatus
time?
optionaltime:string
tip
tip:
BN
transaction
transaction:
Transaction<TTransactionType>
type
type:
TransactionTypeName
Defined in
packages/account/src/providers/transaction-summary/types.ts:160
TransferParams
TransferParams:
object
Type declaration
amount
amount:
BigNumberish
assetId?
optionalassetId:BytesLike
destination
destination:
string|AbstractAddress
Defined in
packages/account/src/account.ts:56
TxParameters
TxParameters:
object
Type declaration
maxBytecodeSubsections
maxBytecodeSubsections:
Scalars["U16"]["output"]
maxGasPerTx
maxGasPerTx:
Scalars["U64"]["output"]
maxInputs
maxInputs:
Scalars["U16"]["output"]
maxOutputs
maxOutputs:
Scalars["U16"]["output"]
maxSize
maxSize:
Scalars["U64"]["output"]
maxWitnesses
maxWitnesses:
Scalars["U32"]["output"]
version
version:
GqlTxParametersVersion
Defined in
packages/account/src/providers/__generated__/operations.ts:1208
TxParamsType
TxParamsType:
Pick<ScriptTransactionRequestLike,"gasLimit"|"tip"|"maturity"|"maxFee"|"witnessLimit">
Defined in
packages/account/src/account.ts:51
UTXOValidationParams
UTXOValidationParams:
object
UTXO validation params
Type declaration
utxoValidation?
optionalutxoValidation:boolean
Defined in
packages/account/src/providers/provider.ts:337
VariableTransactionRequestOutput
VariableTransactionRequestOutput:
object
Type declaration
type
type:
OutputType.Variable
Defined in
packages/account/src/providers/transaction-request/output.ts:31
VaultConfig
VaultConfig:
object
Type declaration
secret?
optionalsecret:string
title?
optionaltitle:string
type
type:
string
Defined in
packages/account/src/wallet-manager/types.ts:17
VaultsState
VaultsState:
object[]
Defined in
packages/account/src/wallet-manager/types.ts:23
Version
Version:
object
Name
Version
Type declaration
app
app:
string
network
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:7
WalletManagerAccount
WalletManagerAccount:
object
Type declaration
address
address:
AbstractAddress
publicKey
publicKey:
string
vaultId?
optionalvaultId:number
Defined in
packages/account/src/wallet-manager/types.ts:7
WalletManagerOptions
WalletManagerOptions:
object
Type declaration
storage
storage:
StorageAbstract
Defined in
packages/account/src/wallet-manager/types.ts:13
Variables
BLOCKS_PAGE_SIZE_LIMIT
constBLOCKS_PAGE_SIZE_LIMIT:5=5
Defined in
packages/account/src/providers/provider.ts:68
CHAIN_IDS
constCHAIN_IDS:object
Type declaration
eth
eth:
object
eth.foundry
eth.foundry:
number=31337
eth.mainnet
eth.mainnet:
number=1
eth.sepolia
eth.sepolia:
number=11155111
fuel
fuel:
object
fuel.devnet
fuel.devnet:
number=0
fuel.mainnet
fuel.mainnet:
number=9889
fuel.testnet
fuel.testnet:
number=0
Defined in
packages/account/src/providers/chains.ts:1
DEFAULT_RESOURCE_CACHE_TTL
constDEFAULT_RESOURCE_CACHE_TTL:20000=20_000
Defined in
packages/account/src/providers/provider.ts:69
FuelConnectorEventType
constFuelConnectorEventType:"FuelConnector"='FuelConnector'
Defined in
packages/account/src/connectors/types/connector-types.ts:42
MNEMONIC_SIZES
constMNEMONIC_SIZES:number[]
Defined in
packages/account/src/mnemonic/mnemonic.ts:20
RESOURCES_PAGE_SIZE_LIMIT
constRESOURCES_PAGE_SIZE_LIMIT:512=512
Defined in
packages/account/src/providers/provider.ts:67
assets
constassets:object[]
Defined in
packages/account/src/providers/assets/assets.ts:621
english
constenglish:string[]
Defined in
packages/account/src/wordlists/words/english.ts:1
fuelAssetsBaseUrl
constfuelAssetsBaseUrl:"https://cdn.fuel.network/assets/"='https://cdn.fuel.network/assets/'
Defined in
packages/account/src/providers/assets/utils/fuelAssetsBaseUrl.ts:1
rawAssets
constrawAssets:Assets
Defined in
packages/account/src/providers/assets/assets.ts:6
Functions
addAmountToCoinQuantities()
addAmountToCoinQuantities(
params):CoinQuantity[]
Parameters
• params: IAddAmountToAssetParams
Returns
Defined in
packages/account/src/providers/coin-quantity.ts:40
assemblePanicError()
assemblePanicError(
statusReason,metadata):FuelError
Assembles an error message for a panic status.
Parameters
• statusReason: string
• metadata: Record<string, unknown>
Returns
FuelError
The error message.
Defined in
packages/account/src/providers/utils/extract-tx-error.ts:22
assembleReceiptByType()
assembleReceiptByType(
receipt):ReceiptCall|ReceiptReturn|ReceiptReturnData|ReceiptPanic|ReceiptRevert|ReceiptLog|ReceiptLogData|ReceiptTransfer|ReceiptTransferOut|ReceiptScriptResult|ReceiptMessageOut|ReceiptMint|ReceiptBurn
Parameters
• receipt: GqlReceiptFragment
Returns
ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn
Defined in
packages/account/src/providers/utils/receipts.ts:64
assembleRevertError()
assembleRevertError(
receipts,logs,metadata):FuelError
Assembles an error message for a revert status.
Parameters
• 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,__namedParameters):F
Type Parameters
• F extends (...args) => Promise<unknown>
Parameters
• fn: F
• __namedParameters: CacheForOptions
Returns
F
Defined in
packages/account/src/connectors/utils/cache.ts:16
cacheRequestInputsResources()
cacheRequestInputsResources(
inputs):Required<ExcludeResourcesOption>
Parameters
• inputs: TransactionRequestInput[]
Returns
Required<ExcludeResourcesOption>
Defined in
packages/account/src/providers/transaction-request/helpers.ts:62
cacheRequestInputsResourcesFromOwner()
cacheRequestInputsResourcesFromOwner(
inputs,owner):ExcludeResourcesOption
Parameters
• inputs: TransactionRequestInput[]
• owner: AbstractAddress
Returns
ExcludeResourcesOption
Defined in
packages/account/src/providers/transaction-request/helpers.ts:78
calculateGasFee()
calculateGasFee(
params):BN
Parameters
• params: CalculateGasFeeParams
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:241
calculateMetadataGasForTxBlob()
calculateMetadataGasForTxBlob(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
• __namedParameters.witnessBytesSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:162
calculateMetadataGasForTxCreate()
calculateMetadataGasForTxCreate(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.contractBytesSize: BN
• __namedParameters.gasCosts: GasCosts
• __namedParameters.stateRootSize: number
• __namedParameters.txBytesSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:131
calculateMetadataGasForTxScript()
calculateMetadataGasForTxScript(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:152
calculateMetadataGasForTxUpgrade()
calculateMetadataGasForTxUpgrade(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.consensusSize?: number
• __namedParameters.gasCosts: GasCosts
• __namedParameters.txBytesSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:176
calculateMetadataGasForTxUpload()
calculateMetadataGasForTxUpload(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.gasCosts: GasCosts
• __namedParameters.subsectionSize: number
• __namedParameters.subsectionsSize: number
• __namedParameters.txBytesSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:195
calculateMinGasForTxUpload()
calculateMinGasForTxUpload(
__namedParameters):BN
Parameters
• __namedParameters
• __namedParameters.baseMinGas: number
• __namedParameters.gasCosts: GasCosts
• __namedParameters.subsectionSize: number
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:217
calculateTXFeeForSummary()
calculateTXFeeForSummary(
params):BN
Parameters
• 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
• 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
• connector: FuelConnector
Returns
void
Defined in
packages/account/src/connectors/utils/dispatch-fuel-connector-event.ts:8
extractBurnedAssetsFromReceipts()
extractBurnedAssetsFromReceipts(
receipts):MintedAsset[]
Parameters
• receipts: TransactionResultReceipt[]
Returns
Defined in
packages/account/src/providers/transaction-summary/receipt.ts:31
extractMintedAssetsFromReceipts()
extractMintedAssetsFromReceipts(
receipts):MintedAsset[]
Parameters
• receipts: TransactionResultReceipt[]
Returns
Defined in
packages/account/src/providers/transaction-summary/receipt.ts:12
extractTxError()
extractTxError(
params):FuelError
Extracts the transaction error and returns a FuelError object.
Parameters
• params: IExtractTxError
Returns
FuelError
The FuelError object.
Defined in
packages/account/src/providers/utils/extract-tx-error.ts:132
gasUsedByInputs()
gasUsedByInputs(
inputs,txBytesSize,gasCosts):BN
Parameters
• 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
• inputs: TransactionRequestInput[]
• assetId: string
• baseAsset: string
Returns
BN
Defined in
packages/account/src/providers/transaction-request/helpers.ts:45
getAssetEth()
getAssetEth(
asset,chainId?):undefined|AssetEth
Returns the asset's details on Ethereum
Parameters
• 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
• asset: Asset
• chainId?: number
Returns
undefined | AssetFuel
Defined in
packages/account/src/providers/assets/utils/network.ts:90
getAssetNetwork()
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
Type Parameters
• T extends undefined | NetworkTypes
Parameters
• __namedParameters: GetAssetNetworkParams<T>
Returns
NetworkTypeToNetwork<T>
Defined in
packages/account/src/providers/assets/utils/network.ts:32
getAssetWithNetwork()
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
Type Parameters
• T extends NetworkTypes
Parameters
• __namedParameters: 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
• networkType: NetworkTypes
Returns
undefined | number
Defined in
packages/account/src/providers/assets/utils/network.ts:11
getMaxGas()
getMaxGas(
params):BN
Parameters
• params: IGetMaxGasParams
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:110
getMinGas()
getMinGas(
params):BN
Parameters
• params: IGetMinGasParams
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:88
getRequestInputResourceOwner()
getRequestInputResourceOwner(
input):BytesLike
Parameters
• input: CoinTransactionRequestInput | MessageTransactionRequestInput
Returns
Defined in
packages/account/src/providers/transaction-request/helpers.ts:36
getTransactionSummary()
getTransactionSummary<
TTransactionType>(params):Promise<TransactionResult>
Type Parameters
• TTransactionType = void
Parameters
• params: GetTransactionSummaryParams
Returns
Promise<TransactionResult>
Defined in
packages/account/src/providers/transaction-summary/get-transaction-summary.ts:26
isMessageCoin()
isMessageCoin(
message):message is MessageCoin
Parameters
• message: Message | MessageCoin
Returns
message is MessageCoin
Defined in
packages/account/src/providers/message.ts:77
isRequestInputCoin()
isRequestInputCoin(
input):input is CoinTransactionRequestInput
Parameters
• input: TransactionRequestInput
Returns
input is CoinTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/helpers.ts:13
isRequestInputCoinOrMessage()
isRequestInputCoinOrMessage(
input): input is CoinTransactionRequestInput | MessageTransactionRequestInput
Parameters
• input: TransactionRequestInput
Returns
input is CoinTransactionRequestInput | MessageTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/helpers.ts:26
isRequestInputMessage()
isRequestInputMessage(
input):input is MessageTransactionRequestInput
Parameters
• input: TransactionRequestInput
Returns
input is MessageTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/helpers.ts:17
isRequestInputMessageWithoutData()
isRequestInputMessageWithoutData(
input):input is MessageTransactionRequestInput
Parameters
• input: TransactionRequestInput
Returns
input is MessageTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/helpers.ts:21
isRequestInputResource()
isRequestInputResource(
input): input is CoinTransactionRequestInput | MessageTransactionRequestInput
Parameters
• input: TransactionRequestInput
Returns
input is CoinTransactionRequestInput | MessageTransactionRequestInput
Defined in
packages/account/src/providers/transaction-request/helpers.ts:31
isRequestInputResourceFromOwner()
isRequestInputResourceFromOwner(
input,owner):boolean
Parameters
• input: CoinTransactionRequestInput | MessageTransactionRequestInput
• owner: AbstractAddress
Returns
boolean
Defined in
packages/account/src/providers/transaction-request/helpers.ts:40
processGqlReceipt()
processGqlReceipt(
gqlReceipt):TransactionResultReceipt
Parameters
• gqlReceipt: GqlReceiptFragment
Returns
TransactionResultReceipt
Defined in
packages/account/src/providers/transaction-summary/receipt.ts:9
resolveGasDependentCosts()
resolveGasDependentCosts(
byteSize,gasDependentCost):BN
Parameters
• byteSize: BNInput
• gasDependentCost: GqlDependentCost
Returns
BN
Defined in
packages/account/src/providers/utils/gas.ts:29
resolveIconPaths()
resolveIconPaths(
assets,basePath):object[]
Returns the list of assets with the icon paths 'resolved'. eg. ./eth.svg -> https://some-url.com/eth.svg
Parameters
• assets: Assets
List of assets
• basePath: string = './'
Base path for the icon URLs (default: './')
Returns
object[]
The assets with the icon paths resolved
Defined in
packages/account/src/providers/assets/utils/resolveIconPaths.ts:11
urlJoin()
urlJoin(
baseUrl, ...paths):string
Parameters
• 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
• F extends Promise<unknown>
• RT = Awaited<F>
Parameters
• promise: F
• 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
data
data:
Asset[]
type
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
data
data:
boolean
type
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
data
data:
FuelConnector
type
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
data
data:
FuelConnector[]
type
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
data
data:
Network
type
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
data
data:
Network
type
type:
networks
Defined in
packages/account/src/connectors/types/events.ts:78
Enumerations
Classes
- Account
- BaseTransactionRequest
- BaseWalletUnlocked
- BlobTransactionRequest
- CreateTransactionRequest
- Fuel
- FuelConnector
- HDWallet
- LocalStorage
- MemoryStorage
- Mnemonic
- MnemonicVault
- Predicate
- PrivateKeyVault
- Provider
- ScriptTransactionRequest
- Signer
- StorageAbstract
- TransactionResponse
- UpgradeTransactionRequest
- UploadTransactionRequest
- Vault
- Wallet
- WalletLocked
- WalletManager
- WalletUnlocked
Interfaces
- AssembleTransactionSummaryParams
- BlobTransactionRequestLike
- CalculateGasFeeParams
- GenerateOptions
- GetTransactionSummaryFromRequestParams
- GetTransactionsSummariesParams
- GetTransactionsSummariesReturns
- GetTransferOperationsParams
- IAddAmountToAssetParams
- IGetMaxGasParams
- IGetMinGasParams
- MintedAsset
- MnemonicVaultOptions
- PkVaultOptions
- TargetObject
- WalletManagerState