Miss any of our Open RFC calls?Watch the recordings here! »

@openstfoundation/mosaic-contracts

0.10.0-beta.2 • Public • Published

💠 Mosaic Contracts

Build master Build develop npm version Discuss on Discourse Chat on Gitter

Mosaic is a parallelization schema for decentralized applications. It composes heterogeneous blockchain systems into one another. Decentralized applications can use Mosaic to compute over a composed network of multiple blockchain systems in parallel.

Mosaic enables building scalable blockchain token economies through the bidirectional transposition of ERC20 tokens on one blockchain, the origin chain, and a utility token representation on another blockchain, the auxiliary chain.

The protocol defines a set of actions that together perform atomic token transfers across two blockchains using gateway contracts. A gateway for a given EIP20 token is comprised of a EIP20Gateway contract on origin, a corresponding EIP20CoGateway contract on auxiliary, and and an ERC20 utility token contract on auxiliary that mints and burns utility tokens to atomically mirror tokens staked and unstaked on the origin chain.

Atomicity is achieved using a 2-phase message passing architecture between the chains. Messages are declared on the source chain, and confirmed on the target chain with Patricia Merkle proofs once the source chain is finalized. Once messages are confirmed on the target chain, they can efficiently progressed with a hashlock. Messages can also be reverted if they are not yet completed on the target chain.

You can read the draft of the mosaic whitepaper or the original OpenST whitepaper.

Instructions

For JS Consumers

Installation

npm install @openstfoundation/mosaic-contracts

Usage

// Load the contracts' meta-data from the package:
const {
  Anchor,
  CoGatewayUtilityTokenInterface,
  EIP20CoGateway,
  EIP20Gateway,
  EIP20Interface,
  EIP20Token,
  GatewayLib,
  MerklePatriciaProof,
  MessageBus,
  Organization,
  OrganizationInterface,
  Organized,
  OSTPrime,
  StateRootInterface,
  UtilityToken,
  UtilityTokenInterface,
} = require('@openstfoundation/mosaic-contracts');
 
// Access the ABIs and BINs directly on the contracts. For example:
const anchorAbi = Anchor.abi;
const anchorBinary = Anchor.bin;

For Direct Users

This section is only required if you want to set up a new mosaic chain.

Installation

git clone git@github.com:OpenSTFoundation/mosaic-contracts.git
cd mosaic-contracts
npm install
npm run compile-all

Usage

There is a deployment tool available for deployment and set-up:

node ./tools/blue_deployment/index.js

⚠️ Note that this feature is still very experimental ⚠️

Related Work

mosaic.js uses this package to provide a JavaScript abstraction layer of the mosaic contracts. You can use mosaic.js directly to deploy the contracts and interact with them.

Contributing

Set-up

git clone git@github.com:OpenSTFoundation/mosaic-contracts.git
cd mosaic-contracts
npm install
npm run compile-all
npm run ganache
npm run test
 
# Requires docker, stop ganache first: 
npm run test:integration

Guidelines

There are multiple ways to contribute to this project. However, before contributing, please first review the Code of Conduct.

We track our issues on GitHub.

To contribute code, please ensure that your submissions adhere to the Style Guide; please also be aware that this project is under active development and we have not yet established firm contribution guidelines or acceptance criteria.

Community

Install

npm i @openstfoundation/mosaic-contracts

DownloadsWeekly Downloads

1

Version

0.10.0-beta.2

License

Apache-2.0

Unpacked Size

228 kB

Total Files

6

Homepage

openst.org/

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar