Skip to content

Latest commit

 

History

History

data-model

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
etc
etc
 
 
src
src
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

@iroha2/data-model

The @iroha2/data-model packages contains generated SCALE-definitions for Iroha 2 Data Model.

Target version

This version of package targets Iroha 2.0.0-pre-rc.20.

Installation

The packages are published under the @iroha2 scope into Iroha Nexus Registry. To install data-model with npm/pnpm:

  1. Configure your package manager to fetch scoped packages from Nexus Registry.

    # FILE: .npmrc
@iroha2:registry=https://nexus.iroha.tech/repository/npm-group/

  2. Install the data-model package:

    npm i @iroha2/data-model

Usage

TODO: write extended usage documentation

Known issues

Entries ordering in BTreeMap and BTreeSet

In Rust, these structs assume that items are PartialOrd-ordered while encoding to ensure consistency for signatures creation. The JS library doesn't provide this feature and you should put entries in the correct order by yourself.