README.md

gazelle-substrate

This repository contains L1 adapter code for Substrate. L1 adaptor is the adaptor to support any blockchain for Gazelle client. Please also see "What L1 adaptor is".

Packages

@cryptoeconomicslab/substrate-adaptor

L1 Adaptor implementation.

@cryptoeconomicslab/substrate-cli

CLI Plasma Light Client.

@cryptoeconomicslab/substrate-plasma-light-client

Initializer of Plasma Light Client.

@cryptoeconomicslab/substrate-plasma-aggregator

Plasma Aggregator.

Development

Install

npm i
lerna bootstrap

How to test

npm test

Docmentation

• Document root of framework
• API Reference of Substrate L1 Adaptor

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

1. Ensure that tests pass and code is lint free: npm run lint
2. Update the README.md if any changes invalidate its current content.
3. Include any tests for new functionality.
4. Reference any revelant issues in your PR comment.

NOTE: Be sure to merge the latest from "upstream" before making a pull request!