Skip to content

web3gamesofficial/open-runtime-module-library

 
 

Repository files navigation

open-runtime-module-library

Crates.io codecov GitHub

The Open Runtime Module Library (ORML) is a community maintained collection of Substrate runtime modules.

Runtime Modules Overview

  • orml-auction
    • Auction module that implements Auction trait.
  • orml-currencies
    • Provide MultiCurrency implementation using pallet-balances and orml-tokens module.
  • orml-gradually-update
    • Provides way to adjust numeric parameter gradually over a period of time.
  • orml-nft
    • Non-fungible-token module provides basic functions to create and manager NFT(non fungible token) such as create_class, transfer, mint, burn, destroy_class.
  • orml-oracle
    • Oracle module that makes off-chain data available on-chain.
  • orml-tokens
    • Fungible tokens module that implements MultiCurrency trait.
  • orml-traits
    • Shared traits including BasicCurrency, MultiCurrency, Auction and more.
  • orml-utilities
    • Various utilities including OrderSet.
  • orml-vesting
    • Provides scheduled balance locking mechanism, in a graded vesting way.
  • orml-xcm-support
    • Provides traits, types, and implementations to support XCM integration.
  • 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

Example

Checkout orml-workshop for example usage.

Development

Makefile targets

  • make check
    • Type check the code, without std feature, excluding tests.
  • make check-tests
    • Type check the code, with std feature, including tests.
  • make test
    • Run tests.

Cargo.toml

ORML use Cargo.dev.toml to avoid workspace conflicts with project cargo config. To use cargo commands in ORML workspace, create Cargo.toml by running

  • cp Cargo.dev.toml Cargo.toml, or
  • make Cargo.toml, or
  • change the command to make dev-check etc which does the copy. (For the full list of make commands, check Makefile)

Web3 Foundation Grant Project

ORML is part of the bigger Open-Web3-Stack initiative, that is currently under a General Grant from Web3 Foundation. See Application details here. The 1st milestone has been delivered.

Projects using ORML

In alphabetical order

About

Substrate Open Runtime Module Library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 99.4%
  • Other 0.6%