Fuel TS SDK

Icon LinkClasses

Icon LinkType Aliases

Icon LinkAbiParam

Ƭ AbiParam: Object

Icon LinkType declaration

Name	Type
`abiMap?`	{ `[key: string]`: `JsonAbi`; }

Icon LinkDefined in

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

Icon LinkBlock

Ƭ Block: Object

A Fuel block

Icon LinkType declaration

Name	Type
`height`	`BN`
`id`	`string`
`time`	`string`
`transactionIds`	`string`[]

Icon LinkDefined in

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

Icon LinkBlockHeader

Ƭ BlockHeader: Object

Icon LinkType declaration

Name	Type
`applicationHash`	`string`
`daHeight`	`BN`
`height`	`BN`
`id`	`string`
`messageReceiptCount`	`BN`
`messageReceiptRoot`	`string`
`prevRoot`	`string`
`time`	`string`
`transactionsCount`	`BN`
`transactionsRoot`	`string`

Icon LinkDefined in

packages/providers/src/message.ts:34 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 LinkBuildPredicateOptions

Ƭ BuildPredicateOptions: { fundTransaction?: boolean } & Pick<TransactionRequestLike, "gasLimit" | "gasPrice" | "maturity">

Icon LinkDefined in

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

Icon LinkBurnedAsset

Ƭ BurnedAsset: MintedAsset

Icon LinkDefined in

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

Icon LinkCallResult

Ƭ CallResult: Object

Icon LinkType declaration

Name	Type
`receipts`	`TransactionResultReceipt`[]

Icon LinkDefined in

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

Icon LinkChainInfo

Ƭ ChainInfo: Object

Chain information

Icon LinkType declaration

Name	Type
`baseChainHeight`	`BN`
`consensusParameters`	{ `chainId`: `BN` ; `contractMaxSize`: `BN` ; `gasPerByte`: `BN` ; `gasPriceFactor`: `BN` ; `maxGasPerPredicate`: `BN` ; `maxGasPerTx`: `BN` ; `maxInputs`: `BN` ; `maxMessageDataLength`: `BN` ; `maxOutputs`: `BN` ; `maxPredicateDataLength`: `BN` ; `maxPredicateLength`: `BN` ; `maxScriptDataLength`: `BN` ; `maxScriptLength`: `BN` ; `maxStorageSlots`: `BN` ; `maxWitnesses`: `BN` }
`consensusParameters.chainId`	`BN`
`consensusParameters.contractMaxSize`	`BN`
`consensusParameters.gasPerByte`	`BN`
`consensusParameters.gasPriceFactor`	`BN`
`consensusParameters.maxGasPerPredicate`	`BN`
`consensusParameters.maxGasPerTx`	`BN`
`consensusParameters.maxInputs`	`BN`
`consensusParameters.maxMessageDataLength`	`BN`
`consensusParameters.maxOutputs`	`BN`
`consensusParameters.maxPredicateDataLength`	`BN`
`consensusParameters.maxPredicateLength`	`BN`
`consensusParameters.maxScriptDataLength`	`BN`
`consensusParameters.maxScriptLength`	`BN`
`consensusParameters.maxStorageSlots`	`BN`
`consensusParameters.maxWitnesses`	`BN`
`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`
`peerCount`	`number`

Icon LinkDefined in

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

Icon LinkChangeTransactionRequestOutput

Ƭ ChangeTransactionRequestOutput: Object

Icon LinkType declaration

Name	Type	Description
`assetId`	`BytesLike`	Asset ID of coins
`to`	`BytesLike`	Receiving address or script hash
`type`	`OutputType.Change`	-

Icon LinkDefined in

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

Icon LinkCoin

Ƭ Coin: Object

A Fuel coin

Icon LinkType declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`blockCreated`	`BN`
`id`	`string`
`maturity`	`number`
`owner`	`AbstractAddress`
`txCreatedIdx`	`BN`

Icon LinkDefined in

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

Icon LinkCoinQuantity

Ƭ CoinQuantity: Object

Icon LinkType declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`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

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

Icon LinkDefined in

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

Icon LinkCoinTransactionRequestOutput

Ƭ CoinTransactionRequestOutput: Object

Icon LinkType declaration

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`	-

Icon LinkDefined in

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

Icon LinkContractCreatedTransactionRequestOutput

Ƭ ContractCreatedTransactionRequestOutput: Object

Icon LinkType declaration

Name	Type	Description
`contractId`	`BytesLike`	Contract ID
`stateRoot`	`BytesLike`	State Root
`type`	`OutputType.ContractCreated`	-

Icon LinkDefined in

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

Icon LinkContractResult

Ƭ ContractResult: Object

Deployed Contract bytecode and contract id

Icon LinkType declaration

Name	Type
`bytecode`	`string`
`id`	`string`

Icon LinkDefined in

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

Icon LinkContractTransactionRequestInput

Ƭ ContractTransactionRequestInput: Object

Icon LinkType declaration

Name	Type	Description
`contractId`	`BytesLike`	Contract ID
`txPointer`	`BytesLike`	Points to the TX whose output is being spent. (TxPointer)
`type`	`InputType.Contract`	-

Icon LinkDefined in

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

Icon LinkContractTransactionRequestOutput

Ƭ ContractTransactionRequestOutput: Object

Icon LinkType declaration

Name	Type	Description
`inputIndex`	`number`	Index of input contract
`type`	`OutputType.Contract`	-

Icon LinkDefined in

packages/providers/src/transaction-request/output.ts:18 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

Name	Type
`body`	`string`
`headers`	{ `[key: string]`: `string`; }
`method`	`"POST"`

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:144 Icon Link

Icon LinkInputParam

Ƭ InputParam: Object

Icon LinkType declaration

Name	Type
`inputs`	`Input`[]

Icon LinkDefined in

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

Icon LinkMerkleProof

Ƭ MerkleProof: Object

Icon LinkType declaration

Name	Type
`proofIndex`	`BN`
`proofSet`	`string`[]

Icon LinkDefined in

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

Icon LinkMessage

Ƭ Message: Object

A Fuel message

Icon LinkType declaration

Name	Type
`amount`	`BN`
`daHeight`	`BN`
`data`	`BytesLike`
`messageId`	`BytesLike`
`nonce`	`BytesLike`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Icon LinkDefined in

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

Icon LinkMessageCoin

Ƭ MessageCoin: Object

Icon LinkType declaration

Name	Type
`amount`	`BN`
`assetId`	`string`
`daHeight`	`BN`
`nonce`	`BytesLike`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Icon LinkDefined in

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

Icon LinkMessageProof

Ƭ MessageProof: Object

Message Proof

Icon LinkType declaration

Name	Type
`amount`	`BN`
`blockProof`	`MerkleProof`
`commitBlockHeader`	`BlockHeader`
`data`	`string`
`messageBlockHeader`	`BlockHeader`
`messageProof`	`MerkleProof`
`nonce`	`string`
`recipient`	`AbstractAddress`
`sender`	`AbstractAddress`

Icon LinkDefined in

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

Icon LinkMessageTransactionRequestInput

Ƭ MessageTransactionRequestInput: Object

Icon LinkType declaration

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

Icon LinkDefined in

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

Icon LinkNodeInfoAndConsensusParameters

Ƭ NodeInfoAndConsensusParameters: Object

Node information

Icon LinkType declaration

Name	Type
`gasPerByte`	`BN`
`gasPriceFactor`	`BN`
`maxGasPerTx`	`BN`
`minGasPrice`	`BN`
`nodeVersion`	`string`

Icon LinkDefined in

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

Icon LinkOperation

Ƭ Operation: Object

Icon LinkType declaration

Name	Type
`assetsSent?`	`OperationCoin`[]
`calls?`	`OperationFunctionCall`[]
`from?`	`OperationTransactionAddress`
`name?`	`OperationName`
`to?`	`OperationTransactionAddress`

Icon LinkDefined in

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

Icon LinkOperationCoin

Ƭ OperationCoin: Object

Icon LinkType declaration

Name	Type
`amount`	`BNInput`
`assetId`	`string`

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:81 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:86 Icon Link

Icon LinkOperationTransactionAddress

Ƭ OperationTransactionAddress: Object

Icon LinkType declaration

Name	Type
`address`	`string`
`chain?`	`ChainName`
`type`	`AddressType`

Icon LinkDefined in

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

Icon LinkOutputParam

Ƭ OutputParam: Object

Icon LinkType declaration

Name	Type
`outputs`	`Output`[]

Icon LinkDefined in

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

Icon LinkProgramState

Ƭ ProgramState: SuccessStatus["programState"]

Icon LinkDefined in

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

Icon LinkProviderCallParams

Ƭ ProviderCallParams: Object

Provider Call transaction params

Icon LinkType declaration

Name	Type
`utxoValidation?`	`boolean`

Icon LinkDefined in

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

Icon LinkProviderOptions

Ƭ ProviderOptions: Object

Icon LinkType declaration

Name	Type
`cacheUtxo?`	`number`
`fetch?`	(`url`: `string`, `options`: `FetchRequestOptions`) => `Promise`<`unknown`>

Icon LinkDefined in

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

Icon LinkRawCoin

Ƭ RawCoin: Object

Icon LinkType declaration

Name	Type
`amount`	`string`
`assetId`	`string`
`blockCreated`	`string`
`maturity`	`string`
`owner`	`string`
`txCreatedIdx`	`string`
`utxoId`	`string`

Icon LinkDefined in

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

Icon LinkRawMessage

Ƭ RawMessage: Object

Icon LinkType declaration

Name	Type
`amount`	`string`
`assetId`	`string`
`daHeight`	`string`
`data`	`string`
`nonce`	`string`
`recipient`	`string`
`sender`	`string`

Icon LinkDefined in

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

Icon LinkRawPayloadParam

Ƭ RawPayloadParam: Object

Icon LinkType declaration

Name	Type
`rawPayload?`	`string`

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:140 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

Name	Type
`receipts`	`TransactionResultReceipt`[]

Icon LinkDefined in

packages/providers/src/transaction-summary/types.ts:130 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

Name	Type
`fee`	`BN`
`gasPrice`	`BN`
`gasUsed`	`BN`
`minGasPrice`	`BN`

Icon LinkDefined in

packages/providers/src/provider.ts:111 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:83 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:40 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

Name	Type
`TTransactionType`	`void`

Icon LinkType declaration

Name	Type
`blockId?`	`BlockId`
`burnedAssets`	`BurnedAsset`[]
`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?`	`SimplifiedTransactionStatusNameEnum`
`time?`	`string`
`transaction`	`Transaction`<`TTransactionType`>
`type`	`TransactionTypeNameEnum`