Skip to content

Latest commit

 

History

History

data-model-schema

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-schema

The @iroha2/data-model-schema contains the source data model schema of Iroha 2 and its type definitions.

Note: this package is a pure TypeScript package, i.e. it is not pre-bundled, but it exports source TypeScript files. It works fine out-of-the-box with tools like Vite or tsx.

Target version

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

Usage

import { SCHEMA, type Schema } from '@iroha2/data-model-schema'

where:

  • SCHEMA is the original JSON of the data model schema
  • type Schema is a generalised type definition which applies to SCHEMA

Installation

The packages are published under the @iroha2 scope into Iroha Nexus Registry. To install data-model-schema 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-schema package:

    npm i @iroha2/data-model-schema