Git Product home page Git Product logo

iroha-javascript's Introduction

npm version minified size Iroha 1.3.0

iroha-helpers

Some functions which will help you to interact with Hyperledger Iroha from your JS program.

Trying an example

  1. Clone this repository
  2. Run Iroha http://iroha.readthedocs.io/en/latest/getting_started/
  3. Run grpc-web-proxy for iroha https://gitlab.com/snippets/1713665
  4. yarn build && npx ts-node example/index.ts

Installation

Using npm:

$ npm i iroha-helpers

Using yarn:

$ yarn add iroha-helpers

Example

In an example directory you can find index.ts and chain.ts files. These files demonstrate main features of iroha-helpers. In the chain.ts you can find how to build transaction with several commands and how to deal with batch.

Node.js

With node.js you should create connection to iroha by using QueryService and CommandService from endpoint_grpc_pb. Also you should provide grpc credentials as a second argument.

IROHA_ADDRESS - Address of iroha grpc (usually ends on 50051) Ex. http://localhost:50051

import grpc from '@grpc/grpc-js'
import {
  QueryService_v1Client as QueryService,
  CommandService_v1Client as CommandService
} from 'iroha-helpers/lib/proto/endpoint_grpc_pb'

const commandService = new CommandService(
  IROHA_ADDRESS,
  grpc.credentials.createInsecure()
)

Browser

With browser you should create connection to iroha by using QueryService and CommandService from endpoint_pb_service.

IROHA_ADDRESS - Address of grpc-web-proxy (usually ends on 8081) Ex. http://localhost:8081

import {
  CommandService_v1Client as CommandService,
  QueryService_v1Client as QueryService
} from 'iroha-helpers/lib/proto/endpoint_pb_service'

const commandService = new CommandService(IROHA_ADDRESS)
const queryService = new QueryService(IROHA_ADDRESS)

Create transaction

To create transaction you can call command from list of commands or create your own from scratch or use transaction builder.

import { TxBuilder } from 'iroha-helpers/lib/chain'

new TxBuilder()
  .createAccount({
    accountName: 'user1',
    domainId: 'test',
    publicKey: '0000000000000000000000000000000000000000000000000000000000000000'
  })
  .addMeta('admin@test', 1)
  .send(commandService)
  .then(res => console.log(res))
  .catch(err => console.error(res))

Create batch

import { TxBuilder, BatchBuilder } from 'iroha-helpers/lib/chain'

const firstTx = new TxBuilder()
  .createAccount({
    accountName: 'user1',
    domainId: 'test',
    publicKey: '0000000000000000000000000000000000000000000000000000000000000000'
  })
  .addMeta('admin@test', 1)
  .tx

const secondTx = new TxBuilder()
  .createAccount({
    accountName: 'user2',
    domainId: 'test',
    publicKey: '0000000000000000000000000000000000000000000000000000000000000000'
  })
  .addMeta('admin@test', 1)
  .tx

new BatchBuilder([
  firstTx,
  secondTx
])
  .setBatchMeta(0)
  .sign([adminPriv], 0)
  .sign([adminPriv], 1)
  .send(commandService)
  .then(res => console.log(res))
  .catch(err => console.error(err))

Commands

For usage of any command you need to provide commandOptions as a first argument.

const commandOptions = {
  privateKeys: [''], // Array of private keys in hex format
  creatorAccountId: '', // Account id, ex. admin@test
  quorum: 1,
  commandService: null,
  timeoutLimit: 5000 // Set timeout limit
}

Queries

For usage of any query you need to provide queryOptions as a first argument.

const queryOptions = {
  privateKey: '', // Private key in hex format
  creatorAccountId: '', // Account id, ex. admin@test
  queryService: null,
  timeoutLimit: 5000 // Set timeout limit
}

Known issues

  • Please be careful: API might and WILL change.

TODO

  • Add tests
  • Integration tests with Iroha
  • Add more documentation

iroha-javascript's People

Contributors

dependabot[bot] avatar takemiyamakoto avatar denisnikiforov avatar pobepto avatar stefashkaa avatar theofilis avatar yashrajdesai avatar dominious1 avatar ryjones avatar safinsaf avatar stinger112 avatar 6londe avatar baziorek avatar neewy avatar petermetz avatar pawlak00 avatar liralemur avatar 6r1d avatar omahs avatar appetrosyan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.