@fuel-ts/account v0.94.2 • 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
height:
BN
id:
string
time:
string
transactionIds:
string[]
packages/account/src/providers/provider.ts:87
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:37
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:74
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:154
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:139
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:235
ContractResult:
object
Deployed Contract bytecode and contract id
bytecode:
string
id:
string
packages/account/src/providers/provider.ts:121
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:69
DryRunStatus:
DryRunFailureStatusFragment|DryRunSuccessStatusFragment
packages/account/src/providers/provider.ts:72
DryRunSuccessStatusFragment:
GqlDryRunSuccessStatusFragment
packages/account/src/providers/provider.ts:70
EstimateTransactionParams:
object
Transaction estimation params
optionalestimateTxDependencies:boolean
Estimate the transaction dependencies.
packages/account/src/providers/provider.ts:328
EstimateTxDependenciesReturns:
CallResult&object
missingContractIds:
string[]
outputVariables:
number
packages/account/src/providers/provider.ts:79
EstimatedTxParams:
Pick<TransactionCost,"estimatedPredicates"|"addedSignatures"|"requiredQuantities"|"updateMaxFee"|"gasPrice">
packages/account/src/account.ts:60
FailureStatus:
GqlFailureStatusFragment
packages/account/src/providers/transaction-summary/types.ts:20
FakeResources:
Partial<Coin> &Required<Pick<Coin,"amount"|"assetId">>
packages/account/src/account.ts:66
FeeParameters:
object
gasPerByte:
Scalars["U64"]["output"]
gasPriceFactor:
Scalars["U64"]["output"]
version:
GqlFeeParametersVersion
packages/account/src/providers/__generated__/operations.ts:294
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:36
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:304
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:104
GetBlocksResponse:
object
blocks:
Block[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:113
GetCoinsResponse:
object
coins:
Coin[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:94
GetMessagesResponse:
object
messages:
Message[]
pageInfo:
GqlPageInfo
packages/account/src/providers/provider.ts:99
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:108
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:26
MerkleProof:
object
proofIndex:
BN
proofSet:
string[]
packages/account/src/providers/message.ts:32
Message:
object
A Fuel message
amount:
BN
daHeight:
BN
data:
BytesLike
messageId:
BytesLike
nonce:
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:21
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:56
MessageStatus:
object
Message Status
state:
GqlMessageState
packages/account/src/providers/message.ts:71
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