Ƭ AbiMap: Record
<string
, JsonAbi
>
packages/account/src/providers/transaction-summary/types.ts:128
Ƭ 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.
Name | Type |
---|---|
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.
Name | Type |
---|---|
data | string [] |
type | accounts |
packages/account/src/connectors/types/events.ts:28
Ƭ Asset: Object
Name | Type | Description |
---|---|---|
icon | string | icon of the asset |
name | string | name of the asset |
networks | (NetworkEthereum | NetworkFuel )[] | asset id on Fuel Network |
symbol | string | description of the asset |
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
Name | Type |
---|---|
height | BN |
id | string |
time | string |
transactionIds | string [] |
packages/account/src/providers/provider.ts:87
Ƭ BlockHeader: Object
Name | Type |
---|---|
applicationHash | string |
consensusParametersVersion | number |
daHeight | BN |
eventInboxRoot | string |
height | BN |
id | string |
messageOutboxRoot | string |
messageReceiptCount | number |
prevRoot | string |
stateTransitionBytecodeVersion | number |
time | string |
transactionsCount | number |
transactionsRoot | string |
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:156
Ƭ CacheFor: Object
â–ª [key: string
]: { timeout
: number
; value
: unknown
} | null
packages/account/src/connectors/utils/cache.ts:3
Ƭ CalculateTXFeeForSummaryParams: Object
Name | Type |
---|---|
consensusParameters | Pick <ConsensusParameters , "gasCosts" > & { feeParams : FeeParams ; maxGasPerTx : BN } |
gasPrice | BN |
rawPayload | string |
tip | BN |
totalFee? | BN |
packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:24
Ƭ CallResult: Object
Name | Type |
---|---|
dryRunStatus? | DryRunStatus |
receipts | TransactionResultReceipt [] |
packages/account/src/providers/provider.ts:74
Ƭ ChainInfo: Object
Chain information
Name | Type |
---|---|
baseChainHeight | BN |
consensusParameters | ConsensusParameters |
latestBlock | { height : BN ; id : string ; time : string ; transactions : { id : string }[] } |
latestBlock.height | BN |
latestBlock.id | string |
latestBlock.time | string |
latestBlock.transactions | { id : string }[] |
name | string |
packages/account/src/providers/provider.ts:130
Ƭ ChangeTransactionRequestOutput: Object
Name | Type | Description |
---|---|---|
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
Name | Type |
---|---|
amount | BN |
assetId | string |
blockCreated | BN |
id | string |
owner | AbstractAddress |
predicate? | BytesLike |
predicateData? | BytesLike |
txCreatedIdx | BN |
packages/account/src/providers/coin.ts:7
Ƭ CoinQuantity: Object
Name | Type |
---|---|
amount | BN |
assetId | string |
max? | BN |
packages/account/src/providers/coin-quantity.ts:9
Ƭ CoinQuantityLike: [amount: BigNumberish, assetId: BytesLike, max?: BigNumberish] | { amount
: BigNumberish
; assetId
: BytesLike
; max?
: BigNumberish
}
packages/account/src/providers/coin-quantity.ts:6
Ƭ CoinTransactionRequestInput: Object
Name | Type | Description |
---|---|---|
amount | BigNumberish | Amount of coins |
assetId | BytesLike | Asset ID of the coins |
id | BytesLike | UTXO ID |
owner | BytesLike | Owning address or script hash |
predicate? | BytesLike | Predicate bytecode |
predicateData? | BytesLike | Predicate input data (parameters) |
predicateGasUsed? | BigNumberish | Gas used by predicate |
txPointer | BytesLike | Points to the TX whose output is being spent. (TxPointer) |
type | InputType.Coin | - |
witnessIndex | number | Index of witness that authorizes spending the coin |
packages/account/src/providers/transaction-request/input.ts:11
Ƭ CoinTransactionRequestOutput: Object
Name | Type | Description |
---|---|---|
amount | BigNumberish | Amount of coins to send |
assetId | BytesLike | Asset ID of coins |
to | BytesLike | Receiving address or script hash |
type | OutputType.Coin | - |
packages/account/src/providers/transaction-request/output.ts:10
Ƭ ConnectorMetadata: Object
Name | Type |
---|---|
image? | string | { dark : string ; light : string } |
install | { action : string ; description : string ; link : string } |
install.action | string |
install.description | string |
install.link | string |
packages/account/src/connectors/types/connector-metadata.ts:1
Ƭ ConsensusParameters: Object
Name | Type |
---|---|
baseAssetId | string |
chainId | BN |
contractParameters | ModifyStringToBN <ContractParameters > |
feeParameters | ModifyStringToBN <FeeParameters > |
gasCosts | GasCosts |
predicateParameters | ModifyStringToBN <PredicateParameters > |
scriptParameters | ModifyStringToBN <ScriptParameters > |
txParameters | ModifyStringToBN <TxParameters > |
version | GqlConsensusParametersVersion |
packages/account/src/providers/provider.ts:115
Ƭ ContractCreatedTransactionRequestOutput: Object
Name | Type | Description |
---|---|---|
contractId | BytesLike | Contract ID |
stateRoot | BytesLike | State Root |
type | OutputType.ContractCreated | - |
packages/account/src/providers/transaction-request/output.ts:34
Ƭ ContractParameters: Object
Name | Type |
---|---|
contractMaxSize | Scalars ["U64" ] |
maxStorageSlots | Scalars ["U64" ] |
version | GqlContractParametersVersion |
packages/account/src/providers/generated/operations.ts:221
Ƭ ContractResult: Object
Deployed Contract bytecode and contract id
Name | Type |
---|---|
bytecode | string |
id | string |
packages/account/src/providers/provider.ts:97
Ƭ ContractTransactionRequestInput: Object
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
inputIndex | number | Index of input contract |
type | OutputType.Contract | - |
packages/account/src/providers/transaction-request/output.ts:19
Ƭ DeferPromise<R
>: Object
Name | Type |
---|---|
R | unknown |
Name | Type |
---|---|
promise | Promise <R > |
reject | (error : unknown ) => void |
resolve | (value : R ) => void |
packages/account/src/connectors/utils/promises.ts:2
Ƭ 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
Name | Type | Description |
---|---|---|
estimateTxDependencies? | boolean | Estimate the transaction dependencies. |
packages/account/src/providers/provider.ts:304
Ƭ EstimateTxDependenciesReturns: CallResult
& { missingContractIds
: string
[] ; outputVariables
: number
}
packages/account/src/providers/provider.ts:79
Ƭ EstimatedTxParams: Pick
<TransactionCost
, "estimatedPredicates"
| "addedSignatures"
| "requiredQuantities"
| "updateMaxFee"
>
packages/account/src/account.ts:53
Ƭ FailureStatus: GqlFailureStatusFragment
packages/account/src/providers/transaction-summary/types.ts:20
Ƭ FeeParameters: Object
Name | Type |
---|---|
gasPerByte | Scalars ["U64" ] |
gasPriceFactor | Scalars ["U64" ] |
version | GqlFeeParametersVersion |
packages/account/src/providers/generated/operations.ts:278
Ƭ 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
Name | Type |
---|---|
connectors? | FuelConnector [] |
storage? | StorageAbstract | null |
targetObject? | 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
Name | Type |
---|---|
emitEvents? | boolean |
packages/account/src/connectors/fuel.ts:36
Ƭ FuelEventArg<T
>: Extract
<FuelConnectorEventTypes
, { type
: T
}>["data"
]
Extract the event argument type from the event type.
Name | Type |
---|---|
T | extends FuelConnectorEvents ["type" ] |
packages/account/src/connectors/types/events.ts:16
Ƭ GasCosts: Object
Name | Type |
---|---|
add | Scalars ["U64" ] |
addi | Scalars ["U64" ] |
aloc | Scalars ["U64" ] |
and | Scalars ["U64" ] |
andi | Scalars ["U64" ] |
bal | Scalars ["U64" ] |
bhei | Scalars ["U64" ] |
bhsh | Scalars ["U64" ] |
burn | Scalars ["U64" ] |
call | GqlDependentCost |
cb | Scalars ["U64" ] |
ccp | GqlDependentCost |
cfei | Scalars ["U64" ] |
cfsi | Scalars ["U64" ] |
contractRoot | GqlDependentCost |
croo | GqlDependentCost |
csiz | GqlDependentCost |
div | Scalars ["U64" ] |
divi | Scalars ["U64" ] |
eck1 | Scalars ["U64" ] |
ecr1 | Scalars ["U64" ] |
ed19 | Scalars ["U64" ] |
eq | Scalars ["U64" ] |
exp | Scalars ["U64" ] |
expi | Scalars ["U64" ] |
flag | Scalars ["U64" ] |
gm | Scalars ["U64" ] |
gt | Scalars ["U64" ] |
gtf | Scalars ["U64" ] |
ji | Scalars ["U64" ] |
jmp | Scalars ["U64" ] |
jmpb | Scalars ["U64" ] |
jmpf | Scalars ["U64" ] |
jne | Scalars ["U64" ] |
jneb | Scalars ["U64" ] |
jnef | Scalars ["U64" ] |
jnei | Scalars ["U64" ] |
jnzb | Scalars ["U64" ] |
jnzf | Scalars ["U64" ] |
jnzi | Scalars ["U64" ] |
k256 | GqlDependentCost |
lb | Scalars ["U64" ] |
ldc | GqlDependentCost |
log | Scalars ["U64" ] |
logd | GqlDependentCost |
lt | Scalars ["U64" ] |
lw | Scalars ["U64" ] |
mcl | GqlDependentCost |
mcli | GqlDependentCost |
mcp | GqlDependentCost |
mcpi | GqlDependentCost |
meq | GqlDependentCost |
mint | Scalars ["U64" ] |
mldv | Scalars ["U64" ] |
mlog | Scalars ["U64" ] |
modOp | Scalars ["U64" ] |
modi | Scalars ["U64" ] |
moveOp | Scalars ["U64" ] |
movi | Scalars ["U64" ] |
mroo | Scalars ["U64" ] |
mul | Scalars ["U64" ] |
muli | Scalars ["U64" ] |
newStoragePerByte | Scalars ["U64" ] |
noop | Scalars ["U64" ] |
not | Scalars ["U64" ] |
or | Scalars ["U64" ] |
ori | Scalars ["U64" ] |
poph | Scalars ["U64" ] |
popl | Scalars ["U64" ] |
pshh | Scalars ["U64" ] |
pshl | Scalars ["U64" ] |
ret | Scalars ["U64" ] |
retd | GqlDependentCost |
rvrt | Scalars ["U64" ] |
s256 | GqlDependentCost |
sb | Scalars ["U64" ] |
scwq | GqlDependentCost |
sll | Scalars ["U64" ] |
slli | Scalars ["U64" ] |
smo | GqlDependentCost |
srl | Scalars ["U64" ] |
srli | Scalars ["U64" ] |
srw | Scalars ["U64" ] |
srwq | GqlDependentCost |
stateRoot | GqlDependentCost |
sub | Scalars ["U64" ] |
subi | Scalars ["U64" ] |
sw | Scalars ["U64" ] |
sww | Scalars ["U64" ] |
swwq | GqlDependentCost |
time | Scalars ["U64" ] |
tr | Scalars ["U64" ] |
tro | Scalars ["U64" ] |
version | GqlGasCostsVersion |
vmInitialization | GqlDependentCost |
wdam | Scalars ["U64" ] |
wdcm | Scalars ["U64" ] |
wddv | Scalars ["U64" ] |
wdmd | Scalars ["U64" ] |
wdml | Scalars ["U64" ] |
wdmm | Scalars ["U64" ] |
wdop | Scalars ["U64" ] |
wqam | Scalars ["U64" ] |
wqcm | Scalars ["U64" ] |
wqdv | Scalars ["U64" ] |
wqmd | Scalars ["U64" ] |
wqml | Scalars ["U64" ] |
wqmm | Scalars ["U64" ] |
wqop | Scalars ["U64" ] |
xor | Scalars ["U64" ] |
xori | Scalars ["U64" ] |
packages/account/src/providers/generated/operations.ts:288
Ƭ GetAssetNetworkParams<T
>: Object
Name | Type |
---|---|
T | extends NetworkTypes | undefined |
Name | Type |
---|---|
asset | Asset |
chainId? | number |
networkType | T |
packages/account/src/providers/assets/utils/network.ts:22
Ƭ GetOperationParams: { abiMap?
: AbiMap
; baseAssetId
: string
; maxInputs
: BN
; transactionType
: TransactionType
} & InputOutputParam
& ReceiptParam
& RawPayloadParam
packages/account/src/providers/transaction-summary/types.ts:140
Ƭ 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:134
Ƭ InputParam: Object
Name | Type |
---|---|
inputs | Input [] |
packages/account/src/providers/transaction-summary/types.ts:116
Ƭ JsonAbisFromAllCalls: Object
Name | Type |
---|---|
main | JsonAbi |
otherContractsAbis | Record <string , JsonAbi > |
packages/account/src/providers/transaction-request/types.ts:18
Ƭ MerkleProof: Object
Name | Type |
---|---|
proofIndex | BN |
proofSet | string [] |
packages/account/src/providers/message.ts:32
Ƭ Message: Object
A Fuel message
Name | Type |
---|---|
amount | BN |
daHeight | BN |
data | BytesLike |
messageId | BytesLike |
nonce | BytesLike |
recipient | AbstractAddress |
sender | AbstractAddress |
packages/account/src/providers/message.ts:10
Ƭ MessageCoin: Object
Name | Type |
---|---|
amount | BN |
assetId | string |
daHeight | BN |
nonce | BytesLike |
predicate? | BytesLike |
predicateData? | BytesLike |
recipient | AbstractAddress |
sender | AbstractAddress |
packages/account/src/providers/message.ts:21
Ƭ MessageProof: Object
Message Proof
Name | Type |
---|---|
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
Name | Type |
---|---|
state | GqlMessageState |
packages/account/src/providers/message.ts:71
Ƭ MessageTransactionRequestInput: Object
Name | Type | Description |
---|---|---|
amount | BigNumberish | Amount of coins |
data? | BytesLike | data of message |
nonce | BytesLike | Unique nonce of message |
predicate? | BytesLike | Predicate bytecode |
predicateData? | BytesLike | Predicate input data (parameters) |
predicateGasUsed? | BigNumberish | Gas used by predicate |
recipient | BytesLike | Address of recipient |
sender | BytesLike | Address of sender |
type | InputType.Message | - |
witnessIndex | number | Index of witness that authorizes the message |
packages/account/src/providers/transaction-request/input.ts:42
Ƭ MnemonicPhrase: string
| string
[]
packages/account/src/mnemonic/utils.ts:7
Ƭ Network: Object
Network
Name | Type | Description |
---|---|---|
chainId | number | The chain id of the network. |
url | string | The name of the network. |
packages/account/src/connectors/types/data-type.ts:20
Ƭ NetworkEthereum: Object
Name | Type | Description |
---|---|---|
address? | string | address of the asset contract |
chainId | number | chain id of the network |
decimals | number | number of decimals of the asset |
type | "ethereum" | type of network |
packages/account/src/providers/assets/types.ts:1
Ƭ NetworkFuel: Object
Name | Type | Description |
---|---|---|
assetId | string | assetId on the Fuel Network |
chainId | number | chain id of the network |
contractId? | string | the contractId of that generated the Asset on the Fuel Network |
decimals | number | number of decimals of the asset |
type | "fuel" | type of network |
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
Name | Type |
---|---|
maxDepth | BN |
maxTx | BN |
nodeVersion | string |
utxoValidation | boolean |
vmBacktrace | boolean |
packages/account/src/providers/provider.ts:145
Ƭ NodeInfoAndConsensusParameters: Object
Name | Type |
---|---|
gasPerByte | BN |
gasPriceFactor | BN |
maxGasPerTx | BN |
nodeVersion | string |
packages/account/src/providers/provider.ts:153
Ƭ Operation: Object
Name | Type |
---|---|
assetsSent? | OperationCoin [] |
calls? | OperationFunctionCall [] |
from? | OperationTransactionAddress |
name? | OperationName |
to? | OperationTransactionAddress |
packages/account/src/providers/transaction-summary/types.ts:86
Ƭ OperationCoin: Object
Name | Type |
---|---|
amount | BNInput |
assetId | string |
packages/account/src/providers/transaction-summary/types.ts:75
Ƭ OperationFunctionCall: { argumentsProvided?
: Record
<string
, unknown
> ; functionName
: string
; functionSignature
: string
} & Partial
<OperationCoin
>
packages/account/src/providers/transaction-summary/types.ts:80
Ƭ OperationTransactionAddress: Object
Name | Type |
---|---|
address | string |
chain? | ChainName |
type | AddressType |
packages/account/src/providers/transaction-summary/types.ts:110
Ƭ OutputParam: Object
Name | Type |
---|---|
outputs | Output [] |
packages/account/src/providers/transaction-summary/types.ts:120
Ƭ PredicateParameters: Object
Name | Type |
---|---|
maxGasPerPredicate | Scalars ["U64" ] |
maxMessageDataLength | Scalars ["U64" ] |
maxPredicateDataLength | Scalars ["U64" ] |
maxPredicateLength | Scalars ["U64" ] |
version | GqlPredicateParametersVersion |
packages/account/src/providers/generated/operations.ts:722
Ƭ PredicateParams<T
>: Object
Name | Type |
---|---|
T | InputValue [] |
Name | Type |
---|---|
abi? | JsonAbi |
bytecode | BytesLike |
configurableConstants? | { [name: string] : unknown ; } |
inputData? | T |
provider | Provider |
packages/account/src/predicate/predicate.ts:27
Ƭ 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:334
Ƭ ProviderOptions: Object
Name | Type | Description |
---|---|---|
cacheUtxo? | number | Cache UTXOs for the given time [ms]. |
fetch? | (url : string , requestInit? : RequestInit , providerOptions? : Omit <ProviderOptions , "fetch" >) => Promise <Response > | Custom fetch function to use for making requests. |
requestMiddleware? | (request : RequestInit ) => RequestInit | Promise <RequestInit > | Middleware to modify the request before it is sent. This can be used to add headers, modify the body, etc. |
retryOptions? | RetryOptions | Retry options to use when fetching data from the node. |
timeout? | number | Timeout [ms] after which every request will be aborted. |
packages/account/src/providers/provider.ts:266
Ƭ ProviderSendTxParams: EstimateTransactionParams
& { awaitExecution?
: boolean
}
Provider Send transaction params
packages/account/src/providers/provider.ts:339
Ƭ RawCoin: Object
Name | Type |
---|---|
amount | string |
assetId | string |
blockCreated | string |
owner | string |
txCreatedIdx | string |
utxoId | string |
packages/account/src/providers/resource.ts:6
Ƭ RawMessage: Object
Name | Type |
---|---|
amount | string |
assetId | string |
daHeight | string |
data | string |
nonce | string |
recipient | string |
sender | string |
packages/account/src/providers/resource.ts:15
Ƭ RawPayloadParam: Object
Name | Type |
---|---|
rawPayload? | string |
packages/account/src/providers/transaction-summary/types.ts:130
Ƭ RawResource: RawCoin
| RawMessage
packages/account/src/providers/resource.ts:25
Ƭ Reason: FailureStatus
["reason"
]
packages/account/src/providers/transaction-summary/types.ts:24
Ƭ ReceiptParam: Object
Name | Type |
---|---|
receipts | TransactionResultReceipt [] |
packages/account/src/providers/transaction-summary/types.ts:124
Ƭ Resource: Coin
| MessageCoin
packages/account/src/providers/resource.ts:26
Ƭ ScriptParameters: Object
Name | Type |
---|---|
maxScriptDataLength | Scalars ["U64" ] |
maxScriptLength | Scalars ["U64" ] |
version | GqlScriptParametersVersion |
packages/account/src/providers/generated/operations.ts:1007
Ƭ SqueezedOutStatus: GqlSqueezedOutStatusFragment
packages/account/src/providers/transaction-summary/types.ts:22
Ƭ Status: Object
Name | Type |
---|---|
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
Name | Type |
---|---|
addedSignatures | number |
dryRunStatus? | DryRunStatus |
estimatedPredicates | TransactionRequestInput [] |
gasPrice | BN |
gasUsed | BN |
maxFee | BN |
maxGas | BN |
minFee | BN |
minGas | BN |
missingContractIds | string [] |
outputVariables | number |
receipts | TransactionResultReceipt [] |
requiredQuantities | CoinQuantity [] |
updateMaxFee? | boolean |
packages/account/src/providers/provider.ts:161
Ƭ TransactionCostParams: EstimateTransactionParams
& { quantitiesToContract?
: CoinQuantity
[] ; resourcesOwner?
: AbstractAccount
; signatureCallback?
: (request
: ScriptTransactionRequest
) => Promise
<ScriptTransactionRequest
> }
packages/account/src/providers/provider.ts:311
Ƭ TransactionRequest: ScriptTransactionRequest
| CreateTransactionRequest
packages/account/src/providers/transaction-request/types.ts:13
Ƭ TransactionRequestInput: CoinTransactionRequestInput
| ContractTransactionRequestInput
| MessageTransactionRequestInput
packages/account/src/providers/transaction-request/input.ts:82
Ƭ TransactionRequestLike: { type
: Script
} & ScriptTransactionRequestLike
| { type
: Create
} & CreateTransactionRequestLike
packages/account/src/providers/transaction-request/types.ts:14
Ƭ 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:56
Ƭ TransactionResultMintReceipt: ReceiptMint
packages/account/src/providers/transaction-response/transaction-response.ts:55
Ƭ TransactionSummary<TTransactionType
>: Object
Name | Type |
---|---|
TTransactionType | void |
Name | Type |
---|---|
blockId? | BlockId |
burnedAssets | BurnedAsset [] |
date? | Date |
fee | BN |
gasUsed | BN |
id? | string |
isStatusFailure | boolean |
isStatusPending | boolean |
isStatusSuccess | boolean |
isTypeCreate | boolean |
isTypeMint | boolean |
isTypeScript | boolean |
isTypeUpgrade | boolean |
isTypeUpload | boolean |
mintedAssets | MintedAsset [] |
operations | Operation [] |
receipts | TransactionResultReceipt [] |
status? | TransactionStatus |
time? | string |
tip | BN |
transaction | Transaction <TTransactionType > |
type | TransactionTypeName |
packages/account/src/providers/transaction-summary/types.ts:158
Ƭ TransferParams: Object
Name | Type |
---|---|
amount | BigNumberish |
assetId? | BytesLike |
destination | string | AbstractAddress |
packages/account/src/account.ts:47
Ƭ TxParameters: Object
Name | Type |
---|---|
maxBytecodeSubsections | Scalars ["U16" ] |
maxGasPerTx | Scalars ["U64" ] |
maxInputs | Scalars ["U16" ] |
maxOutputs | Scalars ["U16" ] |
maxSize | Scalars ["U64" ] |
maxWitnesses | Scalars ["U32" ] |
version | GqlTxParametersVersion |
packages/account/src/providers/generated/operations.ts:1134
Ƭ TxParamsType: Pick
<ScriptTransactionRequestLike
, "gasLimit"
| "tip"
| "maturity"
| "maxFee"
| "witnessLimit"
>
packages/account/src/account.ts:42
Ƭ UTXOValidationParams: Object
UTXO validation params
Name | Type |
---|---|
utxoValidation? | boolean |
packages/account/src/providers/provider.ts:297
Ƭ VariableTransactionRequestOutput: Object
Name | Type |
---|---|
type | OutputType.Variable |
packages/account/src/providers/transaction-request/output.ts:31
Ƭ VaultConfig: Object
Name | Type |
---|---|
secret? | string |
title? | string |
type | string |
packages/account/src/wallet-manager/types.ts:17
Ƭ VaultsState: { data?
: VaultConfig
; title?
: string
; type
: string
; vault
: Vault
}[]
packages/account/src/wallet-manager/types.ts:23
Ƭ Version: Object
Version
Name | Type | Description |
---|---|---|
app | string | - |
network | string | Version selection this allow Caret Ranges ^1.2.3 ^0.2.5 ^0.0.4 Tilde Ranges ~1.2.3 ~1.2 ~1 And Exact Versions 1.0.0 |
packages/account/src/connectors/types/data-type.ts:6
Ƭ WalletManagerAccount: Object
Name | Type |
---|---|
address | AbstractAddress |
publicKey | string |
vaultId? | number |
packages/account/src/wallet-manager/types.ts:7
Ƭ WalletManagerOptions: Object
Name | Type |
---|---|
storage | StorageAbstract |
packages/account/src/wallet-manager/types.ts:13
• Const
CHAIN_IDS: Object
Name | Type |
---|---|
eth | { foundry : number = 31337; sepolia : number = 11155111 } |
eth.foundry | number |
eth.sepolia | number |
fuel | { beta5 : number = 0; devnet : number = 10 } |
fuel.beta5 | number |
fuel.devnet | number |
packages/account/src/providers/chains.ts:1
• Const
FuelConnectorEventType: "FuelConnector"
packages/account/src/connectors/types/connector-types.ts:42
• Const
MNEMONIC_SIZES: number
[]
packages/account/src/mnemonic/mnemonic.ts:20
• Const
assets: { icon
: string
; name
: string
; networks
: (NetworkEthereum
| NetworkFuel
)[] ; symbol
: string
}[]
packages/account/src/providers/assets/assets.ts:38
• Const
english: string
[]
packages/account/src/wordlists/words/english.ts:1
• Const
fuelAssetsBaseUrl: "https://cdn.fuel.network/assets/"
packages/account/src/providers/assets/utils/fuelAssetsBaseUrl.ts:1
• Const
rawAssets: Assets
packages/account/src/providers/assets/assets.ts:6
â–¸ addAmountToCoinQuantities(params
): CoinQuantity
[]
Name | Type |
---|---|
params | IAddAmountToAssetParams |
CoinQuantity
[]
packages/account/src/providers/coin-quantity.ts:40
â–¸ assemblePanicError(statusReason
): Object
Assembles an error message for a panic status.
Name | Type |
---|---|
statusReason | string |
Object
The error message.
Name | Type |
---|---|
errorMessage | string |
reason | string |
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
Name | Type |
---|---|
receipt | GqlReceiptFragment |
ReceiptCall
| ReceiptReturn
| ReceiptReturnData
| ReceiptPanic
| ReceiptRevert
| ReceiptLog
| ReceiptLogData
| ReceiptTransfer
| ReceiptTransferOut
| ReceiptScriptResult
| ReceiptMessageOut
| ReceiptMint
| ReceiptBurn
packages/account/src/providers/utils/receipts.ts:69
â–¸ assembleRevertError(receipts
, logs
): Object
Assembles an error message for a revert status.
Name | Type | Description |
---|---|---|
receipts | TransactionResultReceipt [] | The transaction result processed receipts. |
logs | unknown [] | The transaction decoded logs. |
Object
The error message.
Name | Type |
---|---|
errorMessage | string |
reason | string |
packages/account/src/providers/utils/extract-tx-error.ts:41
â–¸ cacheFor<F
>(fn
, «destructured»
): F
Name | Type |
---|---|
F | extends (...args : unknown []) => Promise <unknown > |
Name | Type |
---|---|
fn | F |
«destructured» | CacheForOptions |
F
packages/account/src/connectors/utils/cache.ts:16
â–¸ cacheRequestInputsResources(inputs
): Required
<ExcludeResourcesOption
>
Name | Type |
---|---|
inputs | TransactionRequestInput [] |
Required
<ExcludeResourcesOption
>
packages/account/src/providers/transaction-request/helpers.ts:52
â–¸ cacheRequestInputsResourcesFromOwner(inputs
, owner
): ExcludeResourcesOption
Name | Type |
---|---|
inputs | TransactionRequestInput [] |
owner | AbstractAddress |
ExcludeResourcesOption
packages/account/src/providers/transaction-request/helpers.ts:68
â–¸ calculateGasFee(params
): BN
Name | Type |
---|---|
params | CalculateGasFeeParams |
BN
packages/account/src/providers/utils/gas.ts:168
▸ calculateMetadataGasForTxCreate(«destructured»
): BN
Name | Type |
---|---|
«destructured» | Object |
› contractBytesSize | BN |
› gasCosts | GasCosts |
› stateRootSize | number |
› txBytesSize | number |
BN
packages/account/src/providers/utils/gas.ts:130
▸ calculateMetadataGasForTxScript(«destructured»
): BN
Name | Type |
---|---|
«destructured» | Object |
› gasCosts | GasCosts |
› txBytesSize | number |
BN
packages/account/src/providers/utils/gas.ts:151
â–¸ calculateTXFeeForSummary(params
): BN
Name | Type |
---|---|
params | CalculateTXFeeForSummaryParams |
BN
packages/account/src/providers/transaction-summary/calculate-tx-fee-for-summary.ts:35
â–¸ deferPromise<R
>(): DeferPromise
<R
>
Name | Type |
---|---|
R | unknown |
DeferPromise
<R
>
packages/account/src/connectors/utils/promises.ts:8
â–¸ 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.
Name | Type |
---|---|
connector | FuelConnector |
void
packages/account/src/connectors/utils/dispatch-fuel-connector-event.ts:8
â–¸ extractBurnedAssetsFromReceipts(receipts
): MintedAsset
[]
Name | Type |
---|---|
receipts | TransactionResultReceipt [] |
MintedAsset
[]
packages/account/src/providers/transaction-summary/receipt.ts:49
â–¸ extractMintedAssetsFromReceipts(receipts
): MintedAsset
[]
Name | Type |
---|---|
receipts | TransactionResultReceipt [] |
MintedAsset
[]
packages/account/src/providers/transaction-summary/receipt.ts:30
â–¸ extractTxError(params
): FuelError
Extracts the transaction error and returns a FuelError object.
Name | Type |
---|---|
params | IExtractTxError |
FuelError
The FuelError object.
packages/account/src/providers/utils/extract-tx-error.ts:110
â–¸ gasUsedByInputs(inputs
, txBytesSize
, gasCosts
): BN
Name | Type |
---|---|
inputs | (TransactionRequestInput | Input )[] |
txBytesSize | number |
gasCosts | GasCosts |
BN
packages/account/src/providers/utils/gas.ts:40
â–¸ getAssetAmountInRequestInputs(inputs
, assetId
, baseAsset
): BN
Name | Type |
---|---|
inputs | TransactionRequestInput [] |
assetId | string |
baseAsset | string |
BN
packages/account/src/providers/transaction-request/helpers.ts:35
â–¸ getAssetEth(asset
, chainId?
): undefined
| AssetEth
Returns the asset's details on Ethereum
Name | Type |
---|---|
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
Name | Type |
---|---|
asset | Asset |
chainId? | number |
undefined
| AssetFuel
packages/account/src/providers/assets/utils/network.ts:90
â–¸ getAssetNetwork<T
>(«destructured»
): NetworkTypeToNetwork
<T
>
Returns the asset's network on the given network eg. getAssetNetwork({ asset, chainId: 1, networkType: 'ethereum' }) will return the asset's details on Ethereum mainnet
Name | Type |
---|---|
T | extends undefined | NetworkTypes |
Name | Type |
---|---|
«destructured» | GetAssetNetworkParams <T > |
NetworkTypeToNetwork
<T
>
packages/account/src/providers/assets/utils/network.ts:32
â–¸ getAssetWithNetwork<T
>(«destructured»
): undefined
| AssetEth
| AssetFuel
Returns the asset's details on the given network alongwith the asset itself eg. getAssetWithNetwork({ asset, chainId: 1, networkType: 'ethereum' }) will return the asset's details on Ethereum mainnet and the asset itself
Name | Type |
---|---|
T | extends NetworkTypes |
Name | Type |
---|---|
«destructured» | 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
Name | Type |
---|---|
networkType | NetworkTypes |
undefined
| number
packages/account/src/providers/assets/utils/network.ts:11
â–¸ getMaxGas(params
): BN
Name | Type |
---|---|
params | IGetMaxGasParams |
BN
packages/account/src/providers/utils/gas.ts:109
â–¸ getMinGas(params
): BN
Name | Type |
---|---|
params | IGetMinGasParams |
BN
packages/account/src/providers/utils/gas.ts:88
â–¸ getRequestInputResourceOwner(input
): BytesLike
Name | Type |
---|---|
input | CoinTransactionRequestInput | MessageTransactionRequestInput |
packages/account/src/providers/transaction-request/helpers.ts:26
â–¸ getTransactionSummary<TTransactionType
>(params
): Promise
<TransactionResult
>
Name | Type |
---|---|
TTransactionType | void |
Name | Type |
---|---|
params | GetTransactionSummaryParams |
Promise
<TransactionResult
>
packages/account/src/providers/transaction-summary/get-transaction-summary.ts:26
â–¸ isRequestInputCoin(input
): input is CoinTransactionRequestInput
Name | Type |
---|---|
input | TransactionRequestInput |
input is CoinTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:13
â–¸ isRequestInputMessage(input
): input is MessageTransactionRequestInput
Name | Type |
---|---|
input | TransactionRequestInput |
input is MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:17
â–¸ isRequestInputResource(input
): input is CoinTransactionRequestInput | MessageTransactionRequestInput
Name | Type |
---|---|
input | TransactionRequestInput |
input is CoinTransactionRequestInput | MessageTransactionRequestInput
packages/account/src/providers/transaction-request/helpers.ts:21
â–¸ isRequestInputResourceFromOwner(input
, owner
): boolean
Name | Type |
---|---|
input | CoinTransactionRequestInput | MessageTransactionRequestInput |
owner | AbstractAddress |
boolean
packages/account/src/providers/transaction-request/helpers.ts:30
â–¸ processGqlReceipt(gqlReceipt
): TransactionResultReceipt
Name | Type |
---|---|
gqlReceipt | GqlReceiptFragment |
TransactionResultReceipt
packages/account/src/providers/transaction-summary/receipt.ts:9
â–¸ resolveGasDependentCosts(byteSize
, gasDependentCost
): BN
Name | Type |
---|---|
byteSize | BNInput |
gasDependentCost | GqlDependentCost |
BN
packages/account/src/providers/utils/gas.ts:29
â–¸ resolveIconPaths(assets
, basePath?
): { icon
: string
; name
: string
; networks
: (NetworkEthereum
| NetworkFuel
)[] ; symbol
: string
}[]
Returns the list of assets with the icon paths 'resolved'. eg. ./eth.svg
-> https://some-url.com/eth.svg
Name | Type | Default value | Description |
---|---|---|---|
assets | Assets | undefined | List of assets |
basePath | string | './' | Base path for the icon URLs (default: './') |
{ icon
: string
; name
: string
; networks
: (NetworkEthereum
| NetworkFuel
)[] ; symbol
: string
}[]
The assets with the icon paths resolved
packages/account/src/providers/assets/utils/resolveIconPaths.ts:11
â–¸ urlJoin(baseUrl
, ...paths
): string
Name | Type |
---|---|
baseUrl | undefined | string |
...paths | string [] |
string
packages/account/src/providers/assets/utils/url.ts:5
â–¸ withTimeout<F
, RT
>(promise
, timeout?
): Promise
<RT
>
Name | Type |
---|---|
F | extends Promise <unknown > |
RT | Awaited <F > |
Name | Type | Default value |
---|---|---|
promise | F | undefined |
timeout | number | 1050 |
Promise
<RT
>
packages/account/src/connectors/utils/promises.ts:20
Ƭ AssetsEvent: Object
Event trigger when the assets list of metadata changed.
AssetsEvent
packages/account/src/connectors/types/events.ts:114
Ƭ ConnectionEvent: Object
Event trigger when connection status changes. With the new connection status.
ConnectionEvent
Name | Type |
---|---|
data | boolean |
type | connection |
packages/account/src/connectors/types/events.ts:52
Ƭ ConnectorEvent: Object
Event trigger when the current connector has changed.
ConnectorEvent
Name | Type |
---|---|
data | FuelConnector |
type | currentConnector |
packages/account/src/connectors/types/events.ts:102
Ƭ ConnectorsEvent: Object
Event trigger when the list of connectors has changed.
ConnectorsEvent
Name | Type |
---|---|
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
Name | Type |
---|---|
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