Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 4.18 KB

open-web3-stack-and-orml.md

File metadata and controls

58 lines (42 loc) · 4.18 KB
Raw

Open-Web3-Stack & ORML

Open Web3 Stack is a common-good collection of libraries to accelerate application development on Substrate. It aims to provide application building blocks that are common for most specialist chains.

Open Web3 Stack contains the following repos

  • Open Runtime Module Library (ORML) where we implemented all the commonly used pallets, modules
  • Open-web3.js - frontend SDK for using extended Substrate logic from ORML
  • Guardian - a worker for monitoring and executing certain tasks
  • Rococo-community: a hosted environment for testing parachains and cross-chain communication

ORML

Find out more here.

  • orml-traits
    • Shared traits including BasicCurrency, MultiCurrency, Auction and more.
  • orml-utilities
    • Various utilities including OrderSet.
  • orml-tokens
    • Fungible tokens module that implements MultiCurrency trait.
  • orml-currencies
    • Provide MultiCurrency implementation using pallet-balances and orml-tokens module.
  • orml-nft
    • Non-fungible-token module provides basic functions to create and manager NFT(non fungible token)
  • orml-oracle
    • Oracle module that makes off-chain data available on-chain.
  • orml-auction
    • Auction module that implements Auction trait.
  • orml-vesting
    • Provides scheduled balance locking mechanism, in a graded vesting way.
  • orml-gradually-update
    • Provides way to adjust numeric parameter gradually over a period of time.
  • orml-xtokens
    • Provides way to do cross-chain assets transfer.
    • Step-by-Step guide to make XCM cross-chain fungible asset transfer available on your parachain
  • orml-xcm-support
    • Provides traits, types, and implementations to support XCM integration.

Guardian

With Guardian, with mere configuration, you can set up a number of automatic tasks for monitoring and executing commands for a chain of concern. A task can be monitoring margin positions with conditions (if collateral ratio < 110%) then trigger actions (e.g. post warning message to database service, or execute a script to add position).

Here're the examples and relevant documentation.

Open-web3.js

Open-web3 is a bunch of frontend packages that allow to interact with orml, indexer and oracles. Find out more here.

Testnet

The TL;DR is, we recommend to use Chopsticks and create your own testnet.

Chopsticks is a testing client that can fork a Substrate network with ease, with Chopsticks, you can fork Acala (or even two parachains on both sides of a cross-chain transfer) at a specific block height and start interact/test with it. As the 'testnet' is forked when needed, it will have the latest runtime and latest code, you can test with confident that your code will behave the same in production if it is going live now.

Get started here.

P.S. In case you are looking for it, Rococo parachain testnet is retired.