Skip to content

Latest commit

 

History

History
139 lines (95 loc) · 4.71 KB

README.md

File metadata and controls

139 lines (95 loc) · 4.71 KB

Kagami (Teacher and Exemplar and/or Looking glass)

Kagami is a tool used to generate and validate automatically generated data files that are shipped with Iroha.

Build

From anywhere in the repository, run:

cargo build --bin kagami

This will place kagami inside the target/debug/ directory (from the root of the repository).

Usage

Run Kagami:

kagami <SUBCOMMAND>

Subcommands

Command Description
crypto Generate cryptographic key pairs
docs Generate a Markdown reference of configuration parameters
genesis Generate the default genesis block that is used in tests
schema Generate the schema used for code generation in Iroha SDKs
tokens Generate a list of predefined permission tokens and their parameters
help Print the help message for the tool or a subcommand

crypto

The crypto command generate cryptographic key pairs using the given algorithm and either private key or seed.

Option Description Default value Type
--algorithm The algorithm used to generate the key-pair: ed25519, secp256k1, bls_normal, bls_small ed25519 String
--private_key The private_key used to generate the key-pair Not applicable String
--seed The seed used to generate the key-pair Not applicable String

You can also choose to output the key-pair in JSON format:

Flag Description
--json A flag to specify whether or not to output the key-pair in JSON format.
By default, the generated key-pair is printed to stdout not in JSON format.

crypto usage examples

  • Generate a key pair:

    ./kagami crypto
    Expand to see the output 
    Kagami. To see help run with `--help`.
No flags specified, generating key-pair.
Public key (multihash): ed0120232adec551bfa1856279ebccc3c3a09783c516478f4cbb2f42f342614bec7601
Private key: a1e2c094496dd53ea103f1423b90ccb7d65ff25ab46f5fa1643c14e6010f7f75232adec551bfa1856279ebccc3c3a09783c516478f4cbb2f42f342614bec7601
Digest function: ed25519

  • Generate a key pair from a given seed:

    ./kagami crypto --seed <seed>

  • Generate a key with the secp256k1 algorithm and a given private key (b32129af69b829a88ab9bac60b2a33cc57f8843e93aae0478e93f2285059c236):

    ./kagami crypto --algorithm secp256k1 --private-key "b32129af69b829a88ab9bac60b2a33cc57f8843e93aae0478e93f2285059c236"
    Expand to see the output 
    Public key (multihash): e70121031c59a9cabaf58f3b8a6157362b9f6feac3dd47ee947fbf2f335805e1a7f96bde
Private key: b32129af69b829a88ab9bac60b2a33cc57f8843e93aae0478e93f2285059c236
Digest function: secp256k1

genesis

  • Generate a genesis block in JSON format:

    kagami genesis

  • Generate a genesis block in JSON format and write the output to the specified file:

    kagami genesis >genesis.json

schema

  • Generate the schema in JSON format:

    kagami schema

  • Generate the schema in JSON format and write the output to the specified file:

    kagami schema >schema.json

docs

Generate peer configuration reference in a Markdown format:

kagami docs

The output should be identical to the reference configuration.

tokens

  • Generate a list of predefined permission tokens and their parameters:

    kagami tokens

  • Generate a list of predefined permission tokens and their parameters and write the output to the specified JSON file:

    kagami tokens >tokens.json