❤
npm
Sign UpSign In

@hyperledger/cacti-plugin-ledger-connector-stellar
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

@hyperledger/cacti-plugin-ledger-connector-stellar

This plugin provides Cacti a way to interact with Stellar networks. Using this we can perform:

  • Deploy Smart-contracts over the network.
  • Build and sign transactions.
  • Invoke smart-contract functions that we have deployed on the network.

Summary

Getting Started

Clone the git repository on your local machine. Follow these instructions that will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

In the root of the Cacti project to install the dependencies execute the command:

npm run enable-corepack
yarn configure

Compiling

In the project root folder, run this command to compile the plugin and create the dist directory:

yarn tsc

Architecture

The Stellar Ledger Connector offers a variaty of endpoints to handle specific actions for a given Stellar network.

deploy-contract endpoint

This endpoint is responsible for deploying smart contracts to Soroban (Stellar's smart contract platform).

Core Aspects:

  • Input: Accepts either a compiled WASM buffer or a WASM hash.

    • wasmBuffer: Uploads compiled code to Stellar, generates a on-chain WASM hash, then deploys the contract. Refer to the Stellar documentation for further detail on this process.
    • wasmHash: Directly deploys the contract using the existing WASM hash.
    • transactionInvocation: An object containing data about how the transaction should be assembled and executed.

  • Output: An object containing the on-chain WASM hash and a unique contract ID of the newly deployed instance.

run-soroban-transaction endpoint

This endpoint is responsible for invoking smart contracts on Soroban (Stellar's smart contract platform) to either change or read a ledger state.

Core Aspects:

  • Input: Accepts either a compiled WASM buffer or a WASM hash.
    • contractId: The unique contract id of the contract instance to be invoked.
    • method: The name of the contract method being invoked.
    • methodArgs: An object containing the arguments accepted by the method.
    • specXdr: An array containing the contract specification in XDR format.
    • transactionInvocation: An object containing data about how the transaction should be assembled and executed.
    • readOnly: A flag to indicate when the transaction should not alter ledger state. When true, the transaction will only be simulated based on the current ledger state and provide an up-to-date output without registering the transaction to the ledger, ensuring no fees are consumed.
  • Output: An object containing the response of the transaction invocation.
    • result: The direct output of the invoked contract method.

Usage

Initialization

To use this import public-api and create new PluginFactoryLedgerConnector. Then use it to create a connector.

const factory = new PluginFactoryLedgerConnector({
  pluginImportType: PluginImportType.LOCAL,
});
const connector: PluginLedgerConnectorStellar = await factory.create({
  networkConfig,
  pluginRegistry: new PluginRegistry({}),
  instanceId: uuidV4(),
});

A key element of the connector intialization is the provided networkConfig object. It follows the standard format defined in the open source library Stellar Plus and can be assembled by the CustomNet() function provided by it as well as the most common network environments for Stellar such as the TestNet() for Stellar testnet or FutureNet() for early features and protocol changes validation.

When using the Stellar Test Ledger provided under the Cacti Test tooling, the network can be assembled using the CustomNet() function combined with the test ledger getNetworkConfiguration() method. Once the test ledger has been fully started, it exposes the configuration parameters for all its services. See the following example:

const stellarTestLedger = new StellarTestLedger({ logLevel });

await stellarTestLedger.start();
const networkConfig = CustomNet(
  await stellarTestLedger.getNetworkConfiguration(),
);

Making Calls

One can make calls through the connector to the plugin API:

async deployContract(req: DeployContractV1Request):Promise<DeployContractV1Response>;

Call example to deploy a contract:

const deployOut = await connector.deployContract({
  wasmBuffer: wasmBuffer.toString("base64"),
  transactionInvocation: {
    header: {
      source: deployerAccount.getPublicKey(),
      fee: 100,
      timeout: 30,
    },
    signers: [deployerAccount.getSecretKey()],
  },
});

Call example to invoke a contract and return the output value:

const res = await connector.runSorobanTransaction({
  contractId,
  method: "balance",
  methodArgs: {
    id: adminAccount.getPublicKey(),
  },
  specXdr: tokenSpec,
  readOnly: true,
  transactionInvocation: {
    header: {
      source: adminAccount.getPublicKey(),
      fee: 100,
      timeout: 30,
    },
    signers: [adminAccount.getSecretKey()],
  },
});

Running the container

Launch container with plugin configuration as an environment variable:

docker run \
  --rm \
  --publish 3000:3000 \
  --publish 4000:4000 \
  --env AUTHORIZATION_PROTOCOL='NONE' \
  --env AUTHORIZATION_CONFIG_JSON='{}' \
  --env GRPC_TLS_ENABLED=false \
  --env API_TLS_CERT_PEM=- \
  --env API_TLS_CLIENT_CA_PEM=- \
  --env API_TLS_KEY_PEM=- \
  --env API_TLS_ENABLED=false \
  --env API_MTLS_ENABLED=false \
  --env API_HOST=0.0.0.0 \
  --env LOG_LEVEL=INFO \
  --env PLUGINS='[{"packageName": "@hyperledger/cacti-plugin-ledger-connector-stellar", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": { "instanceId": "some-unique-stellar-connector-instance-id", "networkConfig": {}}}]' \
  ghcr.io/hyperledger/cactus-cmd-api-server:2024-07-03t18-38-45-dev-65adc3255

Notice that in the command above we've left the networkConfig parameter as an empty object. If you'd like the Stellar connector plugin to connect to a specific ledger then fill out the details of networkConfig accordingly.

Launch container with plugin configuration as a CLI argument:

docker run \
  --rm \
  --publish 3000:3000 \
  --publish 4000:4000 \
  --env AUTHORIZATION_PROTOCOL='NONE' \
  --env AUTHORIZATION_CONFIG_JSON='{}' \
  --env GRPC_TLS_ENABLED=false \
  --env API_TLS_CERT_PEM=- \
  --env API_TLS_CLIENT_CA_PEM=- \
  --env API_TLS_KEY_PEM=- \
  --env API_TLS_ENABLED=false \
  --env API_MTLS_ENABLED=false \
  --env API_HOST=0.0.0.0 \
  --env LOG_LEVEL=INFO \
  ghcr.io/hyperledger/cactus-cmd-api-server:2024-07-03t18-38-45-dev-65adc3255 \
    node index.js \
    --plugins='[{"packageName": "@hyperledger/cacti-plugin-ledger-connector-stellar", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": { "networkConfig":{}, "instanceId": "some-unique-stellar-connector-instance-id"}}]'

Launch container with configuration file mounted from host machine:

echo '{"plugins": [{"packageName": "@hyperledger/cacti-plugin-ledger-connector-stellar", "type": "org.hyperledger.cactus.plugin_import_type.LOCAL", "action": "org.hyperledger.cactus.plugin_import_action.INSTALL",  "options": { "networkConfig":{}, "instanceId": "some-unique-stellar-connector-instance-id"}}]}' > .cacti-config.json
docker run \
  --rm \
  --publish 3000:3000 \
  --publish 4000:4000 \
  --env AUTHORIZATION_PROTOCOL='NONE' \
  --env AUTHORIZATION_CONFIG_JSON='{}' \
  --env GRPC_TLS_ENABLED=false \
  --env API_TLS_CERT_PEM=- \
  --env API_TLS_CLIENT_CA_PEM=- \
  --env API_TLS_KEY_PEM=- \
  --env API_TLS_ENABLED=false \
  --env API_MTLS_ENABLED=false \
  --env API_HOST=0.0.0.0 \
  --env LOG_LEVEL=INFO \
  --mount type=bind,source="$(pwd)"/.cacti-config.json,target=/.cacti-config.json \
  cas \
    node index.js \
    --config-file=/.cacti-config.json

Testing API calls with the container

Don't have a Stellar network on hand to test with? Test or develop against our Stellar All-In-One container by importing the StellarTestLedger from cacti-test-tooling. It will deploy and manage a docker image based on Stellar quickstart.

Usage Example(refer to the integration tests for further examples):

import { StellarTestLedger } from "@hyperledger/cactus-test-tooling";
import { Network } from "stellar-plus/lib/stellar-plus";

const logLevel: LogLevelDesc = "TRACE";
const stellarTestLedger = new StellarTestLedger({ logLevel });

await stellarTestLedger.start();
const networkConfig = Network.CustomNet(
  await stellarTestLedger.getNetworkConfiguration(),
);

// Here use the networkConfig object to connect to
// your test ledger and run your tests.

await stellarTestLedger.stop();
await stellarTestLedger.destroy();

In this example, the StellarTestLedger is used to pull up a fresh new ledger with no history and all of its required services to interact with the network. In conjunction with the stellar-plus library, the method getNetworkConfiguration is used to get all services data and instantiate an object that can be used with all tools in Stellar Plus to directly interact with the test ledger.

Prometheus Exporter

This class creates a prometheus exporter, which scrapes the transactions (total transaction count) for the use cases incorporating the use of Stellar connector plugin.

Prometheus Exporter Usage

The prometheus exporter object is initialized in the PluginLedgerConnectorStellar class constructor itself, so instantiating the object of the PluginLedgerConnectorStellar class, gives access to the exporter object. You can also initialize the prometheus exporter object seperately and then pass it to the IPluginLedgerConnectorStellarOptions interface for PluginLedgerConnectorStellar constructor.

getPrometheusMetricsV1 function returns the prometheus exporter metrics, currently displaying the total transaction count, which currently increments everytime a Stellar transaction is executed through the connector internal methods. This includes the methods

  • deployContract
  • runSorobanTransaction()

Prometheus Integration

To use Prometheus with this exporter make sure to install Prometheus main component. Once Prometheus is setup, the corresponding scrape_config needs to be added to the prometheus.yml

- job_name: 'stellar_ledger_connector_exporter'
  metrics_path: api/v1/plugins/@hyperledger/cacti-plugin-ledger-connector-stellar/get-prometheus-exporter-metrics
  scrape_interval: 5s
  static_configs:
    - targets: ['{host}:{port}']

Here the host:port is where the prometheus exporter metrics are exposed. The test cases (For example, packages/cacti-plugin-ledger-connector-stellar/src/test/typescript/unit/get-open-api-spec-v1-connector-stellar.test.ts) exposes it over 0.0.0.0 and a random port(). The random port can be found in the running logs of the test case and looks like (42379 in the below mentioned URL) Metrics URL: http://0.0.0.0:42379/api/v1/plugins/@hyperledger/cacti-plugin-ledger-connector-stellar/get-prometheus-exporter-metrics

Once edited, you can start the prometheus service by referencing the above edited prometheus.yml file. On the prometheus graphical interface (defaulted to http://localhost:9090), choose Graph from the menu bar, then select the Console tab. From the Insert metric at cursor drop down, select cacti_stellar_total_tx_count and click execute

Helper code

response.type.ts

This file contains the various responses of the metrics.

data-fetcher.ts

This file contains functions encasing the logic to process the data points

metrics.ts

This file lists all the prometheus metrics and what they are used for.

Running the tests

To check that all has been installed correctly and that the pugin has no errors run the tests:

  • Run this command at the project's root:
yarn jest packages/cacti-plugin-ledger-connector-stellar/

Contributing

We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!

Please review CONTRIBUTING.md to get started.

License

This distribution is published under the Apache License Version 2.0 found in the LICENSE file.

Acknowledgments

Readme

Keywords

Package Sidebar

Install

npm i @hyperledger/cacti-plugin-ledger-connector-stellar

Repository

github.com/hyperledger/cacti

Homepage

github.com/hyperledger/cacti#readme

Weekly Downloads

9

Version

2.0.0

License

Apache-2.0

Unpacked Size

310 kB

Total Files

67

Last publish

Collaborators

  • hyperledger-lf
  • hyperledger-ghci
  • openwalletfoundation
Try on RunKit
Report malware