Internal Module

Version Internal 1.4.1

Table of Contents

Overview

Internal methods for SDK / FEE integration

Methods

initialize

This is an private RPC method.

Initialize the SDK / FEE session.

Parameters:

Param Type Required Description
version SemanticVersion true The semantic version of the SDK.

Result:

InitializeResult

Capabilities:

Role Capability
uses xrn:firebolt:capability:lifecycle:initialize

Examples

Default Example

JSON-RPC:

Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Internal.initialize",
  "params": {
    "version": {
      "major": 1,
      "minor": 0,
      "patch": 0,
      "readable": "Firebolt SDK 1.0.0"
    }
  }
}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "version": {
      "major": 1,
      "minor": 0,
      "patch": 0,
      "readable": "Firebolt FEE 1.0.0"
    }
  }
}

Types

InitializeResult

type InitializeResult = {
  version: SemanticVersion // The semantic version of the FEE.
}

See also:

SemanticVersion