This plugin provides Cacti
a way to interact with Sawtooth networks. Using this we can perform:
- Check plugin and sawtooth node status.
- Monitor new blocks and transactions on the ledger.
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.
In the root of the project to install the dependencies execute the command:
npm run configure
Before running the connector please ensure that Sawtooth node is running and that connector will have direct access to it. Access through a proxy is not supported yet (see https://sawtooth.hyperledger.org/docs/1.2/sysadmin_guide/rest_auth_proxy.html). To use this import public-api and create new PluginLedgerConnectorSawtooth.
const connector = new PluginLedgerConnectorSawtooth({
instanceId: uuidV4(),
logLevel: testLogLevel,
sawtoothRestApiEndpoint: ledgerRestApi,
watchBlocksPollTime,
});
You can make calls through the connector to the plugin API:
async getStatus(): Promise<StatusResponseV1>
Please note that deployContract()
and transact()
, although available to call, are not implemented and will throw error on runtime!
All connector API endpoints are defined in open-api specification. You can use SawtoothApiClient to call remote sawtooth connector functions. It also contain additional utility functions to ease integration.
See DefaultApi for up-to-date listing of supported endpoints.
- getStatusV1
- watchBlocksV1
To check that all has been installed correctly and that the plugin has no errors run jest test suites.
- Run this command at the project's root:
npx jest cactus-plugin-ledger-connector-sawtooth
Launch container with plugin configuration as an environment variable:
# FIXME
Launch container with plugin configuration as a CLI argument:
# FIXME
Launch container with configuration file mounted from host machine:
# FIXME
# FIXME
We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!
Please review CONTRIBUTING.md to get started.
This distribution is published under the Apache License Version 2.0 found in the LICENSE file.
- This plugin uses Sawtooth REST API OpenAPI specification from https://sawtooth.hyperledger.org/docs/1.2/rest_api/openapi/. We did some changes to the original spec in order to simplify request handling (e.g. change type, mark fields as requried, etc...)