Ƭ AbiMap : Record<string, JsonAbi>
Ƭ 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.
Ƭ AccountsEvent : Object
Event trigger when the accounts available to the
connection changes.
Ƭ Asset : Object
Name Type Description iconstringicon of the asset namestringname of the asset networks(NetworkEthereum NetworkFuel asset id on Fuel Network symbolstringdescription of the asset
Ƭ
AssetEth :
Omit<
Asset ,
"networks"> &
NetworkEthereum Ƭ
AssetFuel :
Omit<
Asset ,
"networks"> &
NetworkFuel Ƭ Block : Object
A Fuel block
Name Type heightBNidstringtimestringtransactionIdsstring[]
Ƭ BlockHeader : Object
Name Type applicationHashstringdaHeightBNheightBNidstringmessageReceiptCountBNmessageReceiptRootstringprevRootstringtimestringtransactionsCountBNtransactionsRootstring
Ƭ
BlockId :
SuccessStatus [
"block"][
"id"] |
FailureStatus [
"block"][
"id"]
Ƭ
BurnedAsset :
MintedAsset Ƭ CacheFor : Object
▪ [key: string]: { timeout: number ; value: unknown } | null
Ƭ CalculateTransactionFeeParams : Object
Name Type consensusParametersPick<GqlConsensusParameters, "gasCosts"> & { feeParams: FeeParams }gasUsedBNrawPayloadstring
Ƭ CallResult : Object
Name Type receiptsTransactionResultReceipt[]
Ƭ ChainInfo : Object
Chain information
Name Type baseChainHeightBNconsensusParametersConsensusParametersgasCostsGqlGasCostslatestBlock{ height: BN ; id: string ; time: string ; transactions: { id: string }[] } latestBlock.heightBNlatestBlock.idstringlatestBlock.timestringlatestBlock.transactions{ id: string }[] namestring
Ƭ ChangeTransactionRequestOutput : Object
Name Type Description assetIdBytesLike Asset ID of coins toBytesLike Receiving address or script hash typeOutputType.Change-
Icon Link Coin
Ƭ Coin : Object
A Fuel coin
Name Type amountBNassetIdstringblockCreatedBNidstringmaturitynumberownerAbstractAddress txCreatedIdxBN
Ƭ CoinQuantity : Object
Name Type amountBNassetIdstringmax?BN
Ƭ
CoinQuantityLike : [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] | {
amount:
BigNumberish ;
assetId?:
BytesLike ;
max?:
BigNumberish }
Ƭ CoinTransactionRequestInput : Object
Name Type Description amountBigNumberishAmount of coins assetIdBytesLike Asset ID of the coins idBytesLike UTXO ID maturity?numberUTXO being spent must have been created at least this many blocks ago ownerBytesLike Owning address or script hash predicate?BytesLike Predicate bytecode predicateData?BytesLike Predicate input data (parameters) predicateGasUsed?BigNumberishGas used by predicate txPointerBytesLike Points to the TX whose output is being spent. (TxPointer) typeInputType.Coin- witnessIndexnumberIndex of witness that authorizes spending the coin
Ƭ CoinTransactionRequestOutput : Object
Name Type Description amountBigNumberishAmount of coins to send assetIdBytesLike Asset ID of coins toBytesLike Receiving address or script hash typeOutputType.Coin-
Ƭ ConnectorMetadata : Object
Name Type image?string | { dark: string ; light: string }install{ action: string ; description: string ; link: string } install.actionstringinstall.descriptionstringinstall.linkstring
Ƭ ContractCreatedTransactionRequestOutput : Object
Name Type Description contractIdBytesLike Contract ID stateRootBytesLike State Root typeOutputType.ContractCreated-
Ƭ ContractResult : Object
Deployed Contract bytecode and contract id
Name Type bytecodestringidstring
Ƭ ContractTransactionRequestInput : Object
Name Type Description contractIdBytesLike Contract ID txPointerBytesLike Points to the TX whose output is being spent. (TxPointer) typeInputType.Contract-
Ƭ ContractTransactionRequestOutput : Object
Name Type Description inputIndexnumberIndex of input contract typeOutputType.Contract-
Ƭ DeferPromise <R>: Object
Name Type promisePromise<R>reject(error: unknown) => void resolve(value: R) => void
Ƭ EstimatePredicateParams : Object
Name Type estimatePredicates?boolean
Ƭ EstimateTransactionParams : Object
Transaction estimation Param
Name Type estimateTxDependencies?boolean
Ƭ
EstimateTxDependenciesReturns :
CallResult & {
missingContractIds:
string[] ;
outputVariables:
number }
Ƭ
FailureStatus :
Extract<
GraphqlTransactionStatus , {
__typename:
"FailureStatus" }>
Ƭ FuelABI : JsonAbi
ABI that represents a binary code interface from Sway.
Ƭ FuelConfig : Object
All the events available to the connector.
Ƭ
FuelConnectorEventsType :
FuelConnectorEvents [
"type"]
Ƭ FuelConnectorSelectOptions : Object
Name Type emitEvents?boolean
Ƭ
FuelEventArg <
T>:
Extract<
FuelConnectorEventTypes , {
type:
T }>[
"data"]
Extract the event argument type from the event type.
Ƭ GetAssetNetworkParams <T>: Object
Name Type assetAsset chainId?numbernetworkTypeT
Ƭ
GetOperationParams : {
abiMap?:
AbiMap ;
maxInputs:
BN ;
transactionType:
TransactionType } &
InputOutputParam &
ReceiptParam &
RawPayloadParam Ƭ GqlTransaction : NonNullable<GqlGetTransactionQuery["transaction"]>
Ƭ
GraphqlTransactionStatus :
GqlTransaction [
"status"]
Ƭ
InputOutputParam :
InputParam &
OutputParam Ƭ InputParam : Object
Ƭ JsonAbisFromAllCalls : Object
Name Type mainJsonAbiotherContractsAbisRecord<string, JsonAbi>
Ƭ MerkleProof : Object
Name Type proofIndexBNproofSetstring[]
Ƭ Message : Object
A Fuel message
Ƭ MessageCoin : Object
Ƭ MessageProof : Object
Message Proof
Ƭ MessageStatus : Object
Message Status
Name Type stateGqlMessageState
Ƭ MessageTransactionRequestInput : Object
Name Type Description amountBigNumberishAmount of coins data?BytesLike data of message nonceBytesLike Unique nonce of message predicate?BytesLike Predicate bytecode predicateData?BytesLike Predicate input data (parameters) predicateGasUsed?BigNumberishGas used by predicate recipientBytesLike Address of recipient senderBytesLike Address of sender typeInputType.Message- witnessIndexnumberIndex of witness that authorizes the message
Ƭ MnemonicPhrase : string | string[]
Ƭ Network : Object
Network
Name Type Description chainIdnumberThe chain id of the network. urlstringThe name of the network.
Ƭ NetworkEthereum : Object
Name Type Description address?stringaddress of the asset contract chainIdnumberchain id of the network decimalsnumbernumber of decimals of the asset type"ethereum"type of network
Ƭ NetworkFuel : Object
Name Type Description assetIdstringassetId on the Fuel Network chainIdnumberchain id of the network contractId?stringthe contractId of that generated the Asset on the Fuel Network decimalsnumbernumber of decimals of the asset type"fuel"type of network
Ƭ
NetworkTypes :
NetworkEthereum [
"type"] |
NetworkFuel [
"type"]
Ƭ NodeInfo : Object
Node information
Name Type maxDepthBNmaxTxBNminGasPriceBNnodeVersionstringpeersGqlPeerInfo[]utxoValidationbooleanvmBacktraceboolean
Ƭ NodeInfoAndConsensusParameters : Object
Name Type gasPerByteBNgasPriceFactorBNmaxGasPerTxBNminGasPriceBNnodeVersionstring
Ƭ Operation : Object
Ƭ OperationCoin : Object
Name Type amountBNInputassetIdstring
Ƭ
OperationFunctionCall : {
argumentsProvided?:
Record<
string,
unknown> ;
functionName:
string ;
functionSignature:
string } &
Partial<
OperationCoin >
Ƭ OperationTransactionAddress : Object
Name Type addressstringchain?ChainNametypeAddressType
Ƭ OutputParam : Object
Ƭ PredicateParams <T>: Object
Name Type abi?JsonAbibytecodeBytesLike configurableConstants?{ [name: string]: unknown; } inputData?TproviderProvider
Ƭ
ProgramState :
SuccessStatus [
"programState"]
Provider Call transaction params
Ƭ ProviderOptions : Object
Name Type Description cacheUtxo?numberCache 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?RetryOptionsRetry options to use when fetching data from the node. timeout?numberTimeout [ms] after which every request will be aborted.
Ƭ
ProviderSendTxParams :
EstimateTransactionParams & {
awaitExecution?:
boolean }
Provider Send transaction params
Ƭ RawCoin : Object
Name Type amountstringassetIdstringblockCreatedstringmaturitystringownerstringtxCreatedIdxstringutxoIdstring
Ƭ RawMessage : Object
Name Type amountstringassetIdstringdaHeightstringdatastringnoncestringrecipientstringsenderstring
Ƭ RawPayloadParam : Object
Name Type rawPayload?string
Ƭ
RawResource :
RawCoin |
RawMessage Ƭ
Reason :
FailureStatus [
"reason"]
Ƭ ReceiptParam : Object
Name Type receiptsTransactionResultReceipt[]
Ƭ
Resource :
Coin |
MessageCoin Ƭ
SqueezedOutStatus :
Extract<
GraphqlTransactionStatus , {
__typename:
"SqueezedOutStatus" }>
Ƭ Status : Object
Name Type connectedbooleaninstalledboolean
Ƭ
SubmittedStatus :
Extract<
GraphqlTransactionStatus , {
__typename:
"SubmittedStatus" }>
Ƭ
SuccessStatus :
Extract<
GraphqlTransactionStatus , {
__typename:
"SuccessStatus" }>
Icon Link Time
Ƭ
Time :
SubmittedStatus [
"time"] |
SuccessStatus [
"time"] |
FailureStatus [
"time"]
Ƭ TransactionCost : Object
Name Type estimatedInputsTransactionRequest "inputs"]gasPriceBNgasUsedBNmaxFeeBNmaxGasBNminFeeBNminGasBNminGasPriceBNmissingContractIdsstring[]outputVariablesnumberreceiptsTransactionResultReceipt[]requiredQuantitiesCoinQuantity usedFeeBN
Ƭ
TransactionRequestLike : {
type:
Script } &
ScriptTransactionRequestLike | {
type:
Create } &
CreateTransactionRequestLike Ƭ TransactionResultBurnReceipt : ReceiptBurn
Ƭ TransactionResultMintReceipt : ReceiptMint
Ƭ TransactionSummary <TTransactionType>: Object
Name Type TTransactionTypevoid
Name Type blockId?BlockId burnedAssetsBurnedAsset date?DatefeeBNgasUsedBNid?stringisStatusFailurebooleanisStatusPendingbooleanisStatusSuccessbooleanisTypeCreatebooleanisTypeMintbooleanisTypeScriptbooleanmintedAssetsMintedAsset operationsOperation receiptsTransactionResultReceipt[]status?TransactionStatustime?stringtransactionTransaction<TTransactionType>typeTransactionTypeName
Ƭ TxParamsType : Pick<ScriptTransactionRequestLike, "gasLimit" | "gasPrice" | "maturity" | "maxFee" | "witnessLimit">
Ƭ UTXOValidationParams : Object
UTXO Validation Param
Name Type utxoValidation?boolean
Ƭ VariableTransactionRequestOutput : Object
Name Type typeOutputType.Variable
Ƭ VaultConfig : Object
Name Type secret?stringtitle?stringtypestring
Ƭ
VaultsState : {
data?:
VaultConfig ;
title?:
string ;
type:
string ;
vault:
Vault }[]
Ƭ Version : Object
Version
Name Type Description appstring- networkstringVersion 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
Ƭ WalletManagerAccount : Object
Ƭ WalletManagerOptions : Object
• Const CHAIN_IDS : Object
Name Type eth{ foundry: number = 31337; sepolia: number = 11155111 } eth.foundrynumbereth.sepolianumberfuel{ beta5: number = 0; devnet: number = 10 } fuel.beta5numberfuel.devnetnumber
• Const FuelConnectorEventType : "FuelConnector"
• Const MNEMONIC_SIZES : number[]
• Const english : string[]
▸
addAmountToAsset (
params):
CoinQuantity []
▸ assembleReceiptByType (receipt): ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn
Name Type receiptGqlReceiptFragmentFragment
ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn
▸ cacheFor <F>(fn, «destructured»): F
Name Type Fextends (...args: unknown[]) => Promise<unknown>
Name Type fnF«destructured»CacheForOptions
F
▸ calculateMetadataGasForTxCreate («destructured»): BN
Name Type «destructured»Object› contractBytesSize BN› gasCosts GqlGasCosts› stateRootSize number› txBytesSize number
BN
▸ calculateMetadataGasForTxScript («destructured»): BN
Name Type «destructured»Object› gasCosts GqlGasCosts› txBytesSize number
BN
▸ calculateTransactionFee (params): Object
Object
Name Type feeBNfeeFromGasUsedBNmaxFeeBNminFeeBN
▸
deferPromise <
R>():
DeferPromise <
R>
▸ 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.
void
▸
extractBurnedAssetsFromReceipts (
receipts):
MintedAsset []
Name Type receiptsTransactionResultReceipt[]
▸
extractMintedAssetsFromReceipts (
receipts):
MintedAsset []
Name Type receiptsTransactionResultReceipt[]
▸ gasUsedByInputs (inputs, txBytesSize, gasCosts): BN
BN
▸
getAssetEth (
asset,
chainId?):
undefined |
AssetEth Returns the asset's details on Ethereum
Name Type assetAsset chainId?number
▸
getAssetFuel (
asset,
chainId?):
undefined |
AssetFuel Returns the asset's details on Fuel
Name Type assetAsset chainId?number
▸ 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
NetworkTypeToNetwork<T>
▸
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
▸ getDefaultChainId (networkType): undefined | number
Returns the default chainId for the given network
undefined | number
▸ getMaxGas (params): BN
BN
▸ getMinGas (params): BN
BN
▸ getTransactionSummary <TTransactionType>(params): Promise<TransactionResult>
Name Type TTransactionTypevoid
Name Type paramsGetTransactionSummaryParams
Promise<TransactionResult>
▸ processGqlReceipt (gqlReceipt): TransactionResultReceipt
Name Type gqlReceiptGqlReceiptFragmentFragment
TransactionResultReceipt
▸ resolveGasDependentCosts (byteSize, gasDependentCost): BN
Name Type byteSizeBNInputgasDependentCostGqlDependentCost
BN
▸
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 assetsAssets undefinedList of assets basePathstring'./'Base path for the icon URLs (default: './')
{
icon:
string ;
name:
string ;
networks: (
NetworkEthereum |
NetworkFuel )[] ;
symbol:
string }[]
The assets with the icon paths resolved
▸ urlJoin (baseUrl, ...paths): string
Name Type baseUrlundefined | string...pathsstring[]
string
▸ withTimeout <F, RT>(promise, timeout?): Promise<RT>
Name Type Fextends Promise<unknown> RTAwaited<F>
Name Type Default value promiseFundefinedtimeoutnumber1050
Promise<RT>
Ƭ AssetsEvent : Object
Event trigger when the assets list of metadata changed.
AssetsEvent
Ƭ ConnectionEvent : Object
Event trigger when connection status changes. With the new connection status.
ConnectionEvent
Ƭ ConnectorEvent : Object
Event trigger when the current connector has changed.
ConnectorEvent
Ƭ ConnectorsEvent : Object
Event trigger when the list of connectors has changed.
ConnectorsEvent
Ƭ 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
Ƭ 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