Ƭ AbiMap: Record<string, JsonAbi>
packages/account/src/providers/transaction-summary/types.ts:123
Ƭ 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:71
Ƭ BlockHeader: Object
| Name | Type |
|---|---|
applicationHash | string |
daHeight | BN |
height | BN |
id | string |
messageReceiptCount | BN |
messageReceiptRoot | string |
prevRoot | string |
time | string |
transactionsCount | BN |
transactionsRoot | string |
packages/account/src/providers/message.ts:35
Ƭ BlockId: SuccessStatus ["block"]["id"] | FailureStatus ["block"]["id"]
packages/account/src/providers/transaction-summary/types.ts:24
Ƭ BurnedAsset: MintedAsset
packages/account/src/providers/transaction-summary/types.ts:150
Ƭ CacheFor: Object
▪ [key: string]: { timeout: number ; value: unknown } | null
packages/account/src/connectors/utils/cache.ts:3
Ƭ CalculateTransactionFeeParams: Object
| Name | Type |
|---|---|
consensusParameters | Pick<GqlConsensusParameters, "gasCosts"> & { feeParams: FeeParams } |
gasUsed | BN |
rawPayload | string |
packages/account/src/providers/transaction-summary/calculate-transaction-fee.ts:23
Ƭ CallResult: Object
| Name | Type |
|---|---|
receipts | TransactionResultReceipt[] |
packages/account/src/providers/provider.ts:59
Ƭ ChainInfo: Object
Chain information
| Name | Type |
|---|---|
baseChainHeight | BN |
consensusParameters | ConsensusParameters |
gasCosts | GqlGasCosts |
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:108
Ƭ 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 |
maturity | number |
owner | AbstractAddress |
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:10
Ƭ CoinQuantityLike: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] | { amount: BigNumberish ; assetId?: BytesLike ; max?: BigNumberish }
packages/account/src/providers/coin-quantity.ts:7
Ƭ CoinTransactionRequestInput: Object
| Name | Type | Description |
|---|---|---|
amount | BigNumberish | Amount of coins |
assetId | BytesLike | Asset ID of the coins |
id | BytesLike | UTXO ID |
maturity? | number | UTXO being spent must have been created at least this many blocks ago |
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
Ƭ 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
Ƭ ContractResult: Object
Deployed Contract bytecode and contract id
| Name | Type |
|---|---|
bytecode | string |
id | string |
packages/account/src/providers/provider.ts:81
Ƭ 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:76
Ƭ 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
Ƭ EstimatePredicateParams: Object
| Name | Type |
|---|---|
estimatePredicates? | boolean |
packages/account/src/providers/provider.ts:261
Ƭ EstimateTransactionParams: Object
Transaction estimation Param
| Name | Type |
|---|---|
estimateTxDependencies? | boolean |
packages/account/src/providers/provider.ts:257
Ƭ EstimateTxDependenciesReturns: CallResult & { missingContractIds: string[] ; outputVariables: number }
packages/account/src/providers/provider.ts:63
Ƭ FailureStatus: Extract<GraphqlTransactionStatus , { __typename: "FailureStatus" }>
packages/account/src/providers/transaction-summary/types.ts:14
Ƭ 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
Ƭ 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 ; maxInputs: BN ; transactionType: TransactionType } & InputOutputParam & ReceiptParam & RawPayloadParam
packages/account/src/providers/transaction-summary/types.ts:135
Ƭ GqlTransaction: NonNullable<GqlGetTransactionQuery["transaction"]>
packages/account/src/providers/transaction-summary/types.ts:9
Ƭ GraphqlTransactionStatus: GqlTransaction ["status"]
packages/account/src/providers/transaction-summary/types.ts:11
Ƭ InputOutputParam: InputParam & OutputParam
packages/account/src/providers/transaction-summary/types.ts:129
Ƭ InputParam: Object
| Name | Type |
|---|---|
inputs | Input[] |
packages/account/src/providers/transaction-summary/types.ts:111
Ƭ 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:30
Ƭ 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 |
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:51
Ƭ MessageStatus: Object
Message Status
| Name | Type |
|---|---|
state | GqlMessageState |
packages/account/src/providers/message.ts:66
Ƭ 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:45
Ƭ 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 |
minGasPrice | BN |
nodeVersion | string |
peers | GqlPeerInfo[] |
utxoValidation | boolean |
vmBacktrace | boolean |
packages/account/src/providers/provider.ts:124
Ƭ NodeInfoAndConsensusParameters: Object
| Name | Type |
|---|---|
gasPerByte | BN |
gasPriceFactor | BN |
maxGasPerTx | BN |
minGasPrice | BN |
nodeVersion | string |
packages/account/src/providers/provider.ts:134
Ƭ Operation: Object
| Name | Type |
|---|---|
assetsSent? | OperationCoin [] |
calls? | OperationFunctionCall [] |
from? | OperationTransactionAddress |
name? | OperationName |
to? | OperationTransactionAddress |
packages/account/src/providers/transaction-summary/types.ts:81
Ƭ OperationCoin: Object
| Name | Type |
|---|---|
amount | BNInput |
assetId | string |
packages/account/src/providers/transaction-summary/types.ts:70
Ƭ OperationFunctionCall: { argumentsProvided?: Record<string, unknown> ; functionName: string ; functionSignature: string } & Partial<OperationCoin >
packages/account/src/providers/transaction-summary/types.ts:75
Ƭ OperationTransactionAddress: Object
| Name | Type |
|---|---|
address | string |
chain? | ChainName |
type | AddressType |
packages/account/src/providers/transaction-summary/types.ts:105
Ƭ OutputParam: Object
| Name | Type |
|---|---|
outputs | Output[] |
packages/account/src/providers/transaction-summary/types.ts:115
Ƭ 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:32
Ƭ ProgramState: SuccessStatus ["programState"]
packages/account/src/providers/transaction-summary/types.ts:22
Ƭ ProviderCallParams: UTXOValidationParams & EstimateTransactionParams
Provider Call transaction params
packages/account/src/providers/provider.ts:274
Ƭ 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:219
Ƭ ProviderSendTxParams: EstimateTransactionParams & { awaitExecution?: boolean }
Provider Send transaction params
packages/account/src/providers/provider.ts:279
Ƭ RawCoin: Object
| Name | Type |
|---|---|
amount | string |
assetId | string |
blockCreated | string |
maturity | 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:16
Ƭ RawPayloadParam: Object
| Name | Type |
|---|---|
rawPayload? | string |
packages/account/src/providers/transaction-summary/types.ts:125
Ƭ RawResource: RawCoin | RawMessage
packages/account/src/providers/resource.ts:26
Ƭ Reason: FailureStatus ["reason"]
packages/account/src/providers/transaction-summary/types.ts:21
Ƭ ReceiptParam: Object
| Name | Type |
|---|---|
receipts | TransactionResultReceipt[] |
packages/account/src/providers/transaction-summary/types.ts:119
Ƭ Resource: Coin | MessageCoin
packages/account/src/providers/resource.ts:27
Ƭ SqueezedOutStatus: Extract<GraphqlTransactionStatus , { __typename: "SqueezedOutStatus" }>
packages/account/src/providers/transaction-summary/types.ts:16
Ƭ Status: Object
| Name | Type |
|---|---|
connected | boolean |
installed | boolean |
packages/account/src/connectors/fuel.ts:40
Ƭ SubmittedStatus: Extract<GraphqlTransactionStatus , { __typename: "SubmittedStatus" }>
packages/account/src/providers/transaction-summary/types.ts:15
Ƭ SuccessStatus: Extract<GraphqlTransactionStatus , { __typename: "SuccessStatus" }>
packages/account/src/providers/transaction-summary/types.ts:13
Ƭ Time: SubmittedStatus ["time"] | SuccessStatus ["time"] | FailureStatus ["time"]
packages/account/src/providers/transaction-summary/types.ts:23
Ƭ TransactionCost: Object
| Name | Type |
|---|---|
estimatedInputs | TransactionRequest ["inputs"] |
gasPrice | BN |
gasUsed | BN |
maxFee | BN |
maxGas | BN |
minFee | BN |
minGas | BN |
minGasPrice | BN |
missingContractIds | string[] |
outputVariables | number |
receipts | TransactionResultReceipt[] |
requiredQuantities | CoinQuantity [] |
packages/account/src/providers/provider.ts:143
Ƭ TransactionCostParams: EstimateTransactionParams & EstimatePredicateParams & { resourcesOwner?: AbstractAccount ; signatureCallback?: (request: ScriptTransactionRequest ) => Promise<ScriptTransactionRequest > }
packages/account/src/providers/provider.ts:265
Ƭ TransactionRequest: ScriptTransactionRequest | CreateTransactionRequest
packages/account/src/providers/transaction-request/types.ts:13
Ƭ TransactionRequestInput: CoinTransactionRequestInput | ContractTransactionRequestInput | MessageTransactionRequestInput
packages/account/src/providers/transaction-request/input.ts:85
Ƭ 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:55
Ƭ TransactionResultMintReceipt: ReceiptMint
packages/account/src/providers/transaction-response/transaction-response.ts:54
Ƭ 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 |
mintedAssets | MintedAsset [] |
operations | Operation [] |
receipts | TransactionResultReceipt[] |
status? | TransactionStatus |
time? | string |
transaction | Transaction<TTransactionType> |
type | TransactionTypeName |
packages/account/src/providers/transaction-summary/types.ts:152
Ƭ TxParamsType: Pick<ScriptTransactionRequestLike, "gasLimit" | "gasPrice" | "maturity" | "maxFee" | "witnessLimit">
packages/account/src/account.ts:35
Ƭ UTXOValidationParams: Object
UTXO Validation Param
| Name | Type |
|---|---|
utxoValidation? | boolean |
packages/account/src/providers/provider.ts:250
Ƭ 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:27
• Const assets: Assets
packages/account/src/providers/assets/index.ts:5
• Const english: string[]
packages/account/src/wordlists/words/english.ts:1
▸ addAmountToAsset(params): CoinQuantity []
| Name | Type |
|---|---|
params | IAddAmountToAssetParams |
CoinQuantity []
packages/account/src/providers/coin-quantity.ts:41
▸ assemblePanicError(status): Object
Assembles an error message for a panic status.
| Name | Type | Description |
|---|---|---|
status | Object | The transaction failure status. |
status.__typename | "FailureStatus" | - |
status.block | Object | - |
status.block.__typename | "Block" | - |
status.block.id | string | - |
status.reason | string | - |
status.time | string | - |
status.type | "FailureStatus" | - |
Object
The error message.
| Name | Type |
|---|---|
errorMessage | string |
reason | string |
packages/account/src/providers/utils/extract-tx-error.ts:24
▸ assembleReceiptByType(receipt): ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn
| Name | Type |
|---|---|
receipt | GqlReceiptFragmentFragment |
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:44
▸ 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
▸ calculateMetadataGasForTxCreate(«destructured»): BN
| Name | Type |
|---|---|
«destructured» | Object |
› contractBytesSize | BN |
› gasCosts | GqlGasCosts |
› stateRootSize | number |
› txBytesSize | number |
BN
packages/account/src/providers/utils/gas.ts:104
▸ calculateMetadataGasForTxScript(«destructured»): BN
| Name | Type |
|---|---|
«destructured» | Object |
› gasCosts | GqlGasCosts |
› txBytesSize | number |
BN
packages/account/src/providers/utils/gas.ts:125
▸ calculateTransactionFee(params): Object
| Name | Type |
|---|---|
params | CalculateTransactionFeeParams |
Object
| Name | Type |
|---|---|
fee | BN |
feeFromGasUsed | BN |
maxFee | BN |
minFee | BN |
packages/account/src/providers/transaction-summary/calculate-transaction-fee.ts:29
▸ 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:51
▸ extractMintedAssetsFromReceipts(receipts): MintedAsset []
| Name | Type |
|---|---|
receipts | TransactionResultReceipt[] |
MintedAsset []
packages/account/src/providers/transaction-summary/receipt.ts:32
▸ 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:113
▸ gasUsedByInputs(inputs, txBytesSize, gasCosts): BN
| Name | Type |
|---|---|
inputs | (TransactionRequestInput | Input)[] |
txBytesSize | number |
gasCosts | GqlGasCosts |
BN
packages/account/src/providers/utils/gas.ts:40
▸ 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:92
▸ getMinGas(params): BN
| Name | Type |
|---|---|
params | IGetMinGasParams |
BN
packages/account/src/providers/utils/gas.ts:72
▸ 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:25
▸ processGqlReceipt(gqlReceipt): TransactionResultReceipt
| Name | Type |
|---|---|
gqlReceipt | GqlReceiptFragmentFragment |
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:28
▸ 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