Class: ScriptRequest<TData, TResult>
@fuel-ts/program.ScriptRequest
ScriptRequest provides functionality to encode and decode script data and results.
Type parameters
| Name | Type | Description |
|---|---|---|
TData | void | Type of the script data. |
TResult | void | Type of the script result. |
Constructors
constructor
• new ScriptRequest<TData, TResult>(bytes, scriptDataEncoder, scriptResultDecoder): ScriptRequest<TData, TResult>
Creates an instance of the ScriptRequest class.
Type parameters
| Name | Type |
|---|---|
TData | void |
TResult | void |
Parameters
| Name | Type | Description |
|---|---|---|
bytes | BytesLike | The bytes of the script. |
scriptDataEncoder | (data: TData) => EncodedScriptCall | The script data encoder function. |
scriptResultDecoder | (scriptResult: ScriptResult) => TResult | The script result decoder function. |
Returns
ScriptRequest<TData, TResult>
Defined in
Properties
bytes
• bytes: Uint8Array
The bytes of the script.
Defined in
scriptDataEncoder
• scriptDataEncoder: (data: TData) => EncodedScriptCall
A function to encode the script data.
Type declaration
▸ (data): EncodedScriptCall
Parameters
| Name | Type |
|---|---|
data | TData |
Returns
EncodedScriptCall
Defined in
scriptResultDecoder
• scriptResultDecoder: (scriptResult: ScriptResult) => TResult
A function to decode the script result.
Type declaration
▸ (scriptResult): TResult
Parameters
| Name | Type |
|---|---|
scriptResult | ScriptResult |
Returns
TResult
Defined in
Methods
decodeCallResult
▸ decodeCallResult(callResult, logs?): TResult
Decodes the result of a script call.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
callResult | CallResult | undefined | The CallResult from the script call. |
logs | any[] | [] | Optional logs associated with the decoding. |
Returns
TResult
The decoded result.
Defined in
encodeScriptData
▸ encodeScriptData(data): Uint8Array
Encodes the data for a script call.
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | The script data. |
Returns
Uint8Array
The encoded data.
Defined in
getScriptDataOffset
▸ getScriptDataOffset(maxInputs): number
Gets the script data offset.
Parameters
| Name | Type | Description |
|---|---|---|
maxInputs | number | The maxInputs value from the chain's consensus params. |
Returns
number
The script data offset.
Defined in
getScriptDataOffsetWithScriptBytes
▸ getScriptDataOffsetWithScriptBytes(byteLength, maxInputs): number
Gets the script data offset for the given bytes.
Parameters
| Name | Type | Description |
|---|---|---|
byteLength | number | The byte length of the script. |
maxInputs | number | The maxInputs value from the chain's consensus params. |
Returns
number
The script data offset.