Icon HelpCircleForumIcon Link

⌘K

Icon HelpCircleForumIcon Link
Providers

Icon LinkModule: @fuel-ts/providers

Icon LinkEnumerations

Icon LinkClasses

Icon LinkInterfaces

Icon LinkType Aliases

Icon LinkAbiMap

Ƭ AbiMap: Record<string, JsonAbi>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:124 Icon Link


Icon LinkBlock

Ƭ Block: Object

A Fuel block

Icon LinkType declaration

NameType
heightBN
idstring
timestring
transactionIdsstring[]

Icon LinkDefined in

packages/providers/src/provider.ts:64 Icon Link


Icon LinkBlockHeader

Ƭ BlockHeader: Object

Icon LinkType declaration

NameType
applicationHashstring
daHeightBN
heightBN
idstring
messageReceiptCountBN
messageReceiptRootstring
prevRootstring
timestring
transactionsCountBN
transactionsRootstring

Icon LinkDefined in

packages/providers/src/message.ts:36 Icon Link


Icon LinkBlockId

Ƭ BlockId: SuccessStatus ["block"]["id"] | FailureStatus ["block"]["id"]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:24 Icon Link


Icon LinkBurnedAsset

Ƭ BurnedAsset: MintedAsset

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:151 Icon Link


Icon LinkCalculateTransactionFeeParams

Ƭ CalculateTransactionFeeParams: Object

Icon LinkType declaration

NameType
consensusParametersPick<GqlConsensusParameters, "gasCosts"> & { feeParams: FeeParams }
gasUsedBN
rawPayloadstring

Icon LinkDefined in

packages/providers/src/transaction-summary/calculate-transaction-fee.ts:23 Icon Link


Icon LinkCallResult

Ƭ CallResult: Object

Icon LinkType declaration

NameType
receiptsTransactionResultReceipt[]

Icon LinkDefined in

packages/providers/src/provider.ts:57 Icon Link


Icon LinkChainInfo

Ƭ ChainInfo: Object

Chain information

Icon LinkType declaration

NameType
baseChainHeightBN
consensusParametersConsensusParameters
gasCostsGqlGasCosts
latestBlock{ height: BN ; id: string ; time: string ; transactions: { id: string }[] }
latestBlock.heightBN
latestBlock.idstring
latestBlock.timestring
latestBlock.transactions{ id: string }[]
namestring

Icon LinkDefined in

packages/providers/src/provider.ts:101 Icon Link


Icon LinkChangeTransactionRequestOutput

Ƭ ChangeTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
assetIdBytesLikeAsset ID of coins
toBytesLikeReceiving address or script hash
typeOutputType.Change-

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:24 Icon Link


Icon LinkCoin

Ƭ Coin: Object

A Fuel coin

Icon LinkType declaration

NameType
amountBN
assetIdstring
blockCreatedBN
idstring
maturitynumber
ownerAbstractAddress
txCreatedIdxBN

Icon LinkDefined in

packages/providers/src/coin.ts:7 Icon Link


Icon LinkCoinQuantity

Ƭ CoinQuantity: Object

Icon LinkType declaration

NameType
amountBN
assetIdstring
max?BN

Icon LinkDefined in

packages/providers/src/coin-quantity.ts:10 Icon Link


Icon LinkCoinQuantityLike

Ƭ CoinQuantityLike: [amount: BigNumberish, assetId?: BytesLike, max?: BigNumberish] | { amount: BigNumberish ; assetId?: BytesLike ; max?: BigNumberish }

Icon LinkDefined in

packages/providers/src/coin-quantity.ts:7 Icon Link


Icon LinkCoinTransactionRequestInput

Ƭ CoinTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins
assetIdBytesLikeAsset ID of the coins
idBytesLikeUTXO ID
maturity?numberUTXO being spent must have been created at least this many blocks ago
ownerBytesLikeOwning address or script hash
predicate?BytesLikePredicate bytecode
predicateData?BytesLikePredicate input data (parameters)
predicateGasUsed?BigNumberishGas used by predicate
txPointerBytesLikePoints to the TX whose output is being spent. (TxPointer)
typeInputType.Coin-
witnessIndexnumberIndex of witness that authorizes spending the coin

Icon LinkDefined in

packages/providers/src/transaction-request/input.ts:10 Icon Link


Icon LinkCoinTransactionRequestOutput

Ƭ CoinTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins to send
assetIdBytesLikeAsset ID of coins
toBytesLikeReceiving address or script hash
typeOutputType.Coin-

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:10 Icon Link


Icon LinkContractCreatedTransactionRequestOutput

Ƭ ContractCreatedTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
contractIdBytesLikeContract ID
stateRootBytesLikeState Root
typeOutputType.ContractCreated-

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:34 Icon Link


Icon LinkContractResult

Ƭ ContractResult: Object

Deployed Contract bytecode and contract id

Icon LinkType declaration

NameType
bytecodestring
idstring

Icon LinkDefined in

packages/providers/src/provider.ts:74 Icon Link


Icon LinkContractTransactionRequestInput

Ƭ ContractTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
contractIdBytesLikeContract ID
txPointerBytesLikePoints to the TX whose output is being spent. (TxPointer)
typeInputType.Contract-

Icon LinkDefined in

packages/providers/src/transaction-request/input.ts:75 Icon Link


Icon LinkContractTransactionRequestOutput

Ƭ ContractTransactionRequestOutput: Object

Icon LinkType declaration

NameTypeDescription
inputIndexnumberIndex of input contract
typeOutputType.Contract-

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:19 Icon Link


Icon LinkEstimatePredicateParams

Ƭ EstimatePredicateParams: Object

Icon LinkType declaration

NameType
estimatePredicates?boolean

Icon LinkDefined in

packages/providers/src/provider.ts:241 Icon Link


Icon LinkEstimateTransactionParams

Ƭ EstimateTransactionParams: Object

Transaction estimation Param

Icon LinkType declaration

NameType
estimateTxDependencies?boolean

Icon LinkDefined in

packages/providers/src/provider.ts:237 Icon Link


Icon LinkFailureStatus

Ƭ FailureStatus: Extract<GraphqlTransactionStatus , { __typename: "FailureStatus" }>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:14 Icon Link


Icon LinkFetchRequestOptions

Ƭ FetchRequestOptions: Object

Icon LinkType declaration

NameType
bodystring
headers{ [key: string]: string; }
method"POST"

Icon LinkDefined in

packages/providers/src/provider.ts:207 Icon Link


Icon LinkGetOperationParams

Ƭ GetOperationParams: { abiMap?: AbiMap ; maxInputs: BN ; transactionType: TransactionType } & InputOutputParam & ReceiptParam & RawPayloadParam

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:136 Icon Link


Icon LinkGqlTransaction

Ƭ GqlTransaction: NonNullable<GqlGetTransactionQuery["transaction"]>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:9 Icon Link


Icon LinkGraphqlTransactionStatus

Ƭ GraphqlTransactionStatus: GqlTransaction ["status"]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:11 Icon Link


Icon LinkInputOutputParam

Ƭ InputOutputParam: InputParam & OutputParam

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:130 Icon Link


Icon LinkInputParam

Ƭ InputParam: Object

Icon LinkType declaration

NameType
inputsInput[]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:112 Icon Link


Icon LinkMerkleProof

Ƭ MerkleProof: Object

Icon LinkType declaration

NameType
proofIndexBN
proofSetstring[]

Icon LinkDefined in

packages/providers/src/message.ts:31 Icon Link


Icon LinkMessage

Ƭ Message: Object

A Fuel message

Icon LinkType declaration

NameType
amountBN
daHeightBN
dataBytesLike
messageIdBytesLike
nonceBytesLike
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

packages/providers/src/message.ts:11 Icon Link


Icon LinkMessageCoin

Ƭ MessageCoin: Object

Icon LinkType declaration

NameType
amountBN
assetIdstring
daHeightBN
nonceBytesLike
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

packages/providers/src/message.ts:22 Icon Link


Icon LinkMessageProof

Ƭ MessageProof: Object

Message Proof

Icon LinkType declaration

NameType
amountBN
blockProofMerkleProof
commitBlockHeaderBlockHeader
datastring
messageBlockHeaderBlockHeader
messageProofMerkleProof
noncestring
recipientAbstractAddress
senderAbstractAddress

Icon LinkDefined in

packages/providers/src/message.ts:52 Icon Link


Icon LinkMessageStatus

Ƭ MessageStatus: Object

Message Status

Icon LinkType declaration

NameType
stateGqlMessageState

Icon LinkDefined in

packages/providers/src/message.ts:67 Icon Link


Icon LinkMessageTransactionRequestInput

Ƭ MessageTransactionRequestInput: Object

Icon LinkType declaration

NameTypeDescription
amountBigNumberishAmount of coins
data?BytesLikedata of message
nonceBytesLikeUnique nonce of message
predicate?BytesLikePredicate bytecode
predicateData?BytesLikePredicate input data (parameters)
predicateGasUsed?BigNumberishGas used by predicate
recipientBytesLikeAddress of recipient
senderBytesLikeAddress of sender
typeInputType.Message-
witnessIndexnumberIndex of witness that authorizes the message

Icon LinkDefined in

packages/providers/src/transaction-request/input.ts:44 Icon Link


Icon LinkNodeInfo

Ƭ NodeInfo: Object

Node information

Icon LinkType declaration

NameType
maxDepthBN
maxTxBN
minGasPriceBN
nodeVersionstring
peersGqlPeerInfo[]
utxoValidationboolean
vmBacktraceboolean

Icon LinkDefined in

packages/providers/src/provider.ts:117 Icon Link


Icon LinkNodeInfoAndConsensusParameters

Ƭ NodeInfoAndConsensusParameters: Object

Icon LinkType declaration

NameType
gasPerByteBN
gasPriceFactorBN
maxGasPerTxBN
minGasPriceBN
nodeVersionstring

Icon LinkDefined in

packages/providers/src/provider.ts:127 Icon Link


Icon LinkOperation

Ƭ Operation: Object

Icon LinkType declaration

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:82 Icon Link


Icon LinkOperationCoin

Ƭ OperationCoin: Object

Icon LinkType declaration

NameType
amountBNInput
assetIdstring

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:71 Icon Link


Icon LinkOperationFunctionCall

Ƭ OperationFunctionCall: { argumentsProvided?: Record<string, unknown> ; functionName: string ; functionSignature: string } & Partial<OperationCoin >

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:76 Icon Link


Icon LinkOperationTransactionAddress

Ƭ OperationTransactionAddress: Object

Icon LinkType declaration

NameType
addressstring
chain?ChainName
typeAddressType

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:106 Icon Link


Icon LinkOutputParam

Ƭ OutputParam: Object

Icon LinkType declaration

NameType
outputsOutput[]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:116 Icon Link


Icon LinkProgramState

Ƭ ProgramState: SuccessStatus ["programState"]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:22 Icon Link


Icon LinkProviderCallParams

Ƭ ProviderCallParams: UTXOValidationParams & EstimateTransactionParams

Provider Call transaction params

Icon LinkDefined in

packages/providers/src/provider.ts:250 Icon Link


Icon LinkProviderOptions

Ƭ ProviderOptions: Object

Icon LinkType declaration

NameType
cacheUtxo?number
fetch?(url: string, options: FetchRequestOptions , providerOptions: Omit<ProviderOptions , "fetch">) => Promise<Response>
retryOptions?RetryOptions
timeout?number

Icon LinkDefined in

packages/providers/src/provider.ts:216 Icon Link


Icon LinkProviderSendTxParams

Ƭ ProviderSendTxParams: EstimateTransactionParams & { awaitExecution?: boolean }

Provider Send transaction params

Icon LinkDefined in

packages/providers/src/provider.ts:255 Icon Link


Icon LinkRawCoin

Ƭ RawCoin: Object

Icon LinkType declaration

NameType
amountstring
assetIdstring
blockCreatedstring
maturitystring
ownerstring
txCreatedIdxstring
utxoIdstring

Icon LinkDefined in

packages/providers/src/resource.ts:6 Icon Link


Icon LinkRawMessage

Ƭ RawMessage: Object

Icon LinkType declaration

NameType
amountstring
assetIdstring
daHeightstring
datastring
noncestring
recipientstring
senderstring

Icon LinkDefined in

packages/providers/src/resource.ts:16 Icon Link


Icon LinkRawPayloadParam

Ƭ RawPayloadParam: Object

Icon LinkType declaration

NameType
rawPayload?string

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:126 Icon Link


Icon LinkRawResource

Ƭ RawResource: RawCoin | RawMessage

Icon LinkDefined in

packages/providers/src/resource.ts:26 Icon Link


Icon LinkReason

Ƭ Reason: FailureStatus ["reason"]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:21 Icon Link


Icon LinkReceiptParam

Ƭ ReceiptParam: Object

Icon LinkType declaration

NameType
receiptsTransactionResultReceipt[]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:120 Icon Link


Icon LinkResource

Ƭ Resource: Coin | MessageCoin

Icon LinkDefined in

packages/providers/src/resource.ts:27 Icon Link


Icon LinkSqueezedOutStatus

Ƭ SqueezedOutStatus: Extract<GraphqlTransactionStatus , { __typename: "SqueezedOutStatus" }>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:16 Icon Link


Icon LinkSubmittedStatus

Ƭ SubmittedStatus: Extract<GraphqlTransactionStatus , { __typename: "SubmittedStatus" }>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:15 Icon Link


Icon LinkSuccessStatus

Ƭ SuccessStatus: Extract<GraphqlTransactionStatus , { __typename: "SuccessStatus" }>

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:13 Icon Link


Icon LinkTime

Ƭ Time: SubmittedStatus ["time"] | SuccessStatus ["time"] | FailureStatus ["time"]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:23 Icon Link


Icon LinkTransactionCost

Ƭ TransactionCost: Object

Icon LinkType declaration

NameType
gasPriceBN
gasUsedBN
maxFeeBN
maxGasBN
minFeeBN
minGasBN
minGasPriceBN
receiptsTransactionResultReceipt[]
requiredQuantitiesCoinQuantity []
usedFeeBN

Icon LinkDefined in

packages/providers/src/provider.ts:136 Icon Link


Icon LinkTransactionCostParams

Ƭ TransactionCostParams: EstimateTransactionParams & EstimatePredicateParams

Icon LinkDefined in

packages/providers/src/provider.ts:245 Icon Link


Icon LinkTransactionRequest

Ƭ TransactionRequest: ScriptTransactionRequest | CreateTransactionRequest

Icon LinkDefined in

packages/providers/src/transaction-request/types.ts:12 Icon Link


Icon LinkTransactionRequestInput

Ƭ TransactionRequestInput: CoinTransactionRequestInput | ContractTransactionRequestInput | MessageTransactionRequestInput

Icon LinkDefined in

packages/providers/src/transaction-request/input.ts:84 Icon Link


Icon LinkTransactionRequestLike

Ƭ TransactionRequestLike: { type: Script } & ScriptTransactionRequestLike | { type: Create } & CreateTransactionRequestLike

Icon LinkDefined in

packages/providers/src/transaction-request/types.ts:13 Icon Link


Icon LinkTransactionRequestOutput

Ƭ TransactionRequestOutput: CoinTransactionRequestOutput | ContractTransactionRequestOutput | ChangeTransactionRequestOutput | VariableTransactionRequestOutput | ContractCreatedTransactionRequestOutput

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:41 Icon Link


Icon LinkTransactionResultBurnReceipt

Ƭ TransactionResultBurnReceipt: ReceiptBurn

Icon LinkDefined in

packages/providers/src/transaction-response/transaction-response.ts:56 Icon Link


Icon LinkTransactionResultMintReceipt

Ƭ TransactionResultMintReceipt: ReceiptMint

Icon LinkDefined in

packages/providers/src/transaction-response/transaction-response.ts:55 Icon Link


Icon LinkTransactionSummary

Ƭ TransactionSummary<TTransactionType>: Object

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkType declaration

NameType
blockId?BlockId
burnedAssetsBurnedAsset []
date?Date
feeBN
gasUsedBN
id?string
isStatusFailureboolean
isStatusPendingboolean
isStatusSuccessboolean
isTypeCreateboolean
isTypeMintboolean
isTypeScriptboolean
mintedAssetsMintedAsset []
operationsOperation []
receiptsTransactionResultReceipt[]
status?TransactionStatus
time?string
transactionTransaction<TTransactionType>
typeTransactionTypeName

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:153 Icon Link


Icon LinkUTXOValidationParams

Ƭ UTXOValidationParams: Object

UTXO Validation Param

Icon LinkType declaration

NameType
utxoValidation?boolean

Icon LinkDefined in

packages/providers/src/provider.ts:230 Icon Link


Icon LinkVariableTransactionRequestOutput

Ƭ VariableTransactionRequestOutput: Object

Icon LinkType declaration

NameType
typeOutputType.Variable

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:31 Icon Link

Icon LinkFunctions

Icon LinkaddAmountToAsset

addAmountToAsset(params): CoinQuantity []

Icon LinkParameters

Icon LinkReturns

CoinQuantity []

Icon LinkDefined in

packages/providers/src/coin-quantity.ts:41 Icon Link


Icon LinkassembleReceiptByType

assembleReceiptByType(receipt): ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn

Icon LinkParameters

NameType
receiptGqlReceiptFragmentFragment

Icon LinkReturns

ReceiptCall | ReceiptReturn | ReceiptReturnData | ReceiptPanic | ReceiptRevert | ReceiptLog | ReceiptLogData | ReceiptTransfer | ReceiptTransferOut | ReceiptScriptResult | ReceiptMessageOut | ReceiptMint | ReceiptBurn

Icon LinkDefined in

packages/providers/src/utils/receipts.ts:69 Icon Link


Icon LinkcalculateMetadataGasForTxCreate

calculateMetadataGasForTxCreate(«destructured»): BN

Icon LinkParameters

NameType
«destructured»Object
› contractBytesSizeBN
› gasCostsGqlGasCosts
› stateRootSizenumber
› txBytesSizenumber

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:106 Icon Link


Icon LinkcalculateMetadataGasForTxScript

calculateMetadataGasForTxScript(«destructured»): BN

Icon LinkParameters

NameType
«destructured»Object
› gasCostsGqlGasCosts
› txBytesSizenumber

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:127 Icon Link


Icon LinkcalculateTransactionFee

calculateTransactionFee(params): Object

Icon LinkParameters

Icon LinkReturns

Object

NameType
feeBN
feeFromGasUsedBN
maxFeeBN
minFeeBN

Icon LinkDefined in

packages/providers/src/transaction-summary/calculate-transaction-fee.ts:29 Icon Link


Icon LinkextractBurnedAssetsFromReceipts

extractBurnedAssetsFromReceipts(receipts): MintedAsset []

Icon LinkParameters

NameType
receiptsTransactionResultReceipt[]

Icon LinkReturns

MintedAsset []

Icon LinkDefined in

packages/providers/src/transaction-summary/receipt.ts:51 Icon Link


Icon LinkextractMintedAssetsFromReceipts

extractMintedAssetsFromReceipts(receipts): MintedAsset []

Icon LinkParameters

NameType
receiptsTransactionResultReceipt[]

Icon LinkReturns

MintedAsset []

Icon LinkDefined in

packages/providers/src/transaction-summary/receipt.ts:32 Icon Link


Icon LinkfromDateToTai64

fromDateToTai64(date): string

Icon LinkParameters

NameType
dateDate

Icon LinkReturns

string

Icon LinkDefined in

packages/providers/src/transaction-summary/date.ts:8 Icon Link


Icon LinkfromTai64ToDate

fromTai64ToDate(tai64Timestamp): Date

Icon LinkParameters

NameType
tai64Timestampstring

Icon LinkReturns

Date

Icon LinkDefined in

packages/providers/src/transaction-summary/date.ts:3 Icon Link


Icon LinkgasUsedByInputs

gasUsedByInputs(inputs, txBytesSize, gasCosts): BN

Icon LinkParameters

NameType
inputs(TransactionRequestInput | Input)[]
txBytesSizenumber
gasCostsGqlGasCosts

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:40 Icon Link


Icon LinkgetMaxGas

getMaxGas(params): BN

Icon LinkParameters

NameType
paramsIGetMaxGasParams

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:94 Icon Link


Icon LinkgetMinGas

getMinGas(params): BN

Icon LinkParameters

NameType
paramsIGetMinGasParams

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:74 Icon Link


Icon LinkgetTransactionSummary

getTransactionSummary<TTransactionType>(params): Promise<TransactionResult>

Icon LinkType parameters

NameType
TTransactionTypevoid

Icon LinkParameters

NameType
paramsGetTransactionSummaryParams

Icon LinkReturns

Promise<TransactionResult>

Icon LinkDefined in

packages/providers/src/transaction-summary/get-transaction-summary.ts:25 Icon Link


Icon LinkprocessGqlReceipt

processGqlReceipt(gqlReceipt): TransactionResultReceipt

Icon LinkParameters

NameType
gqlReceiptGqlReceiptFragmentFragment

Icon LinkReturns

TransactionResultReceipt

Icon LinkDefined in

packages/providers/src/transaction-summary/receipt.ts:9 Icon Link


Icon LinkresolveGasDependentCosts

resolveGasDependentCosts(byteSize, gasDependentCost): BN

Icon LinkParameters

NameType
byteSizeBNInput
gasDependentCostGqlDependentCost

Icon LinkReturns

BN

Icon LinkDefined in

packages/providers/src/utils/gas.ts:28 Icon Link