@fuel-ts/program v0.94.1 • Docs
@fuel-ts/program
Type Aliases
CallConfig<T>
CallConfig<
T>:object
Represents configuration for calling a contract function.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | unknown | Type of the function's arguments. |
Type declaration
| Name | Type | Defined in |
|---|---|---|
args | T | types.ts:60 |
callParameters | CallParams | types.ts:56 |
externalAbis | Record<string, JsonAbi> | types.ts:59 |
forward | CoinQuantity | types.ts:58 |
func | FunctionFragment | types.ts:54 |
program | AbstractProgram | types.ts:55 |
txParameters | TxParams | types.ts:57 |
Defined in
types.ts:53
CallParams
CallParams:
Partial<object>
Represents call parameters for a contract call.
Type declaration
| Name | Type | Defined in |
|---|---|---|
forward | CoinQuantityLike | types.ts:32 |
gasLimit | BigNumberish | types.ts:33 |
Defined in
types.ts:31
ContractCall
ContractCall:
object
Represents a contract call.
Type declaration
| Name | Type | Defined in |
|---|---|---|
amount | BigNumberish | types.ts:22 |
assetId | BytesLike | types.ts:23 |
contractId | AbstractAddress | types.ts:19 |
data | BytesLike | types.ts:20 |
externalContractsAbis | Record<string, JsonAbi> | types.ts:25 |
fnSelectorBytes | Uint8Array | types.ts:21 |
gas | BigNumberish | types.ts:24 |
Defined in
types.ts:18
DryRunResult<TReturn>
DryRunResult<
TReturn>:object
Type Parameters
| Type Parameter |
|---|
TReturn |
Type declaration
| Name | Type | Defined in |
|---|---|---|
callResult | CallResult | types.ts:123 |
functionScopes | InvocationScopeLike[] | types.ts:124 |
gasUsed | BN | types.ts:120 |
isMultiCall | boolean | types.ts:122 |
value | TReturn | types.ts:121 |
Defined in
types.ts:119
FunctionResult<TReturn>
FunctionResult<
TReturn>:object
Type Parameters
| Type Parameter |
|---|
TReturn |
Type declaration
| Name | Type | Defined in |
|---|---|---|
functionScopes | InvocationScopeLike[] | types.ts:114 |
gasUsed | BN | types.ts:110 |
isMultiCall | boolean | types.ts:112 |
logs | any[] | types.ts:108 |
program | AbstractProgram | types.ts:111 |
transactionId | string | types.ts:113 |
transactionResponse | TransactionResponse | types.ts:115 |
transactionResult | TransactionResult<Script> | types.ts:116 |
value | TReturn | types.ts:109 |
Defined in
types.ts:106
InvocationScopeLike<T>
InvocationScopeLike<
T>:object
Represents a like object of InvocationScope with a method to get its call configuration.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | unknown | Type of the function's arguments. |
Type declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
getCallConfig | CallConfig<T> | Get the call configuration for this invocation scope. | types.ts:96 |
Defined in
types.ts:91
TransactionCostOptions
TransactionCostOptions:
Partial<object>
Represents options for calculating the transaction cost.
Type declaration
| Name | Type | Defined in |
|---|---|---|
fundTransaction | boolean | types.ts:103 |
Defined in
types.ts:102
TxParams
TxParams:
Partial<object>
Represents transaction parameters for a contract call.
Type declaration
| Name | Type | Defined in |
|---|---|---|
gasLimit | BigNumberish | types.ts:41 |
maturity | number | types.ts:42 |
maxFee | BigNumberish | types.ts:43 |
tip | BigNumberish | types.ts:40 |
variableOutputs | number | types.ts:45 |
witnessLimit | BigNumberish | types.ts:44 |
Defined in
types.ts:39