hyperledger/iroha-javascript

JavaScript library for Iroha, a Distributed Ledger Technology (blockchain) platform.

Iroha2 JavaScript

JavaScript SDK for Iroha 2.

The Iroha 2 JavaScript library includes the following packages:

• @iroha2/client submits requests to the Iroha peer
• @iroha2/crypto-*:
  • @iroha2/crypto-core provides unified crypto interface for Iroha 2
  • @iroha2/crypto-target-node provides compiled crypto WASM for the Node.js environment
  • @iroha2/crypto-target-web provides compiled crypto WASM for native Web (ESM)
  • @iroha2/crypto-target-bundler provides compiled crypto WASM to use with bundlers such as Webpack
• @iroha2/data-model provides SCALE codecs for Iroha 2 data model

Other packages you can find in this repository:

• @iroha2/docs-recipes contains code samples used in documentation
• @iroha2/data-model-schema contains Iroha 2 Schema
• @iroha2/i64-fixnum handles operations with fixed-point numbers

Installation

The packages are published under the @iroha2 scope into Iroha Nexus Registry. To install them using npm/pnpm, follow these steps:

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 these packages as any other NPM package:

   npm i @iroha2/client
   yarn add @iroha2/data-model
   pnpm add @iroha2/crypto-target-web

Get Started

Check out Hyperledger Iroha 2 Tutorial that introduces you to Iroha 2 concepts and features and provides you with a step-by-step guide for JavaScript/TypeScript.

Maintenance

Make sure you have installed Node.js v16.17 or v18. As for a package manager, this project uses PNPM.

Also make sure you have installed the following version of Rust toolchain:

rustup default nightly-2023-06-25

Before working with the repository, install the necessary packages:

pnpm install

Scripts

Most tasks are defined via Jake, a JavaScript build tool. To explore available tasks, run:

pnpm jake -t

However, some tasks are defined directly in package.json and could be run with pnpm run:

• Check or fix lint errors:

  pnpm lint
  pnpm lint --fix

• Fix formatting:

  pnpm format:fix

Each monorepo package might have its own scripts and tasks. You can find the package details in a README for that package.

Manually update reference Iroha version

1. Update packages/iroha-source/config.js:

   export default {
     origin: 'https://github.com/hyperledger/iroha.git',
     rev: '52dc18cd81bdc1d1906ffeecb666dd9b2eb27955',
   }

2. Perform full-featured repo check, running:

   pnpm jake run-all-checks

3. If something is broken, fix it!

4. If you are going to publish updated SDK, update packages/client/README.md and packages/data-model/README.md. In the beginning they have the following note:

   This package targets hyperledger/iroha at current iroha2-lts branch, which has a hash b783f10fa7de26ed1fdd4c526bd162f8636f1a65.

   Put here a new Iroha 2 reference commit information.

SDK Compatibility Matrix Tests

There are certain integration tests that are part of the Compatibility Matrix endeavour. To read more about it, follow the client Node integration tests.

iroha-javascript's Issues

convert to grpc+flatbuffers

The SDK needs to be built to work with grpc and handle flatbuffers natively

see: grpc/grpc-experiments#159

Use `scale-codec` JS library instead of polkadot's legacy

Examples for the documentation

Hello.

I'd like to add the common language guide to the Iroha documentation.
Since Iroha-JS very convenient for the users, it is necessary for the examples.

How stable are the examples displayed in the JavaScript tutorial?

I am mostly interested in:

• Loading the JSON configuration for Iroha so it could be used by the JavaScript library
• Client setup, given the configuration above
• Registering an Iroha domain
• Registering an Iroha account
• Registering an asset
• Minting an asset mentioned above
• Listing domains / accounts / assets, displaying an output

Potentially, it'll be great to enable these examples as tests, marking the parts useful for the end user with the comments.

Refactor Events API in SCALE

Add multisignature test(-s)

Multisignature transactions are essential and not obvious to build. It would be useful to have multisignature e2e tests in SDK both to implement that complexity at least once, and to include that code into the documentation (hyperledger/iroha-2-docs#258)

Perform Permissions with Typescript SDK

Looking for performing permission instruction with typescript, i am not able to found documentation about it in Typescript.

npm init

During setup the project on your machine, please make sure that you have initialize npm before install any npm package. Because of npm package modulo update. We should update the README.md file

getting Unsupported Operation for transfers

I'm getting the following error (from node logs):

2023-11-28T19:06:08.554860Z  WARN consensus: iroha_core::block::pending: Transaction validation failed
reason=Validation failed caused_by=Some(NotPermitted("TransferExpr { source_id:
AssetId(energy##matias@cognition), object: 12_u32, destination_id: AssetId(energy##pepe@cognition) }:
Unsupported operation"))

This is my dev setup:

• Node: stable-2.0.0-pre-rc.20
• iroha2/client: 7.0.0
• iroha2/data-model: 7.0.0

This is my code:

const transfer = async (from, to, asset, quantity) => {
  logger.info(`[srv] transfer ${from} to ${to} ${quantity} of ${asset} ...`);

  const [senderAccName, senderDomainId] = from.split('@');
  const senderAccId = sugar.accountId(senderAccName, senderDomainId);

  const [receiverAccName, receiverDomainId] = to.split('@');
  const receiverAccId = sugar.accountId(receiverAccName, receiverDomainId);

  const [assetName, assetDomainId] = asset.split('#');
  const assetDefId = sugar.assetDefinitionId(assetName, assetDomainId);

  const { IdBox } = datamodel;
  const { assetId } = sugar;

  const senderIdBox = IdBox('AssetId', assetId(senderAccId, assetDefId));
  const receiverIdBox = IdBox('AssetId', assetId(receiverAccId, assetDefId));
  const value = sugar.value.numericU32(quantity);

  const transferAsset = sugar.instruction.transfer(
    senderIdBox,
    value,
    receiverIdBox
  );

  const instr = sugar.executable.instructions(transferAsset);
  const { pre, client } = _clientFactory('matias', 'cognition');
  try {
    const data = await client.submitExecutable(pre, instr);
    logger.info('[srv] transfer completed ...');
    return { data };
  } catch (error) {
    console.log(error);
    return { error: error.message };
  }
};

Additional information:

• I get the same result without using the sugar package.
• I can transfer with no problem using CLI, with the same config file, to the same node running on a local Docker instance.

The node is created from the following Dockerfile:

# Use the official hyperledger/iroha2 base image with the specified version
FROM hyperledger/iroha2:stable-2.0.0-pre-rc.20

# Set environment variables
ENV TORII_P2P_ADDR 0.0.0.0:1337
ENV TORII_API_URL 0.0.0.0:8080
ENV TORII_TELEMETRY_URL 0.0.0.0:8180
ENV IROHA_PUBLIC_KEY "ed01201C61FAF8FE94E253B93114240394F79A607B7FA55F9E5A41EBEC74B88055768B"
ENV IROHA_PRIVATE_KEY '{"digest_function": "ed25519", "payload": "282ED9F3CF92811C3818DBC4AE594ED59DC1A2F78E4241E31924E101D6B1FB831C61FAF8FE94E253B93114240394F79A607B7FA55F9E5A41EBEC74B88055768B"}'
ENV SUMERAGI_TRUSTED_PEERS '[{"address":"0.0.0.0:1337", "public_key": "ed01201C61FAF8FE94E253B93114240394F79A607B7FA55F9E5A41EBEC74B88055768B"}]'
ENV IROHA_GENESIS_ACCOUNT_PUBLIC_KEY "ed01203F4E3E98571B55514EDC5CCF7E53CA7509D89B2868E62921180A6F57C2F4E255"
ENV IROHA_GENESIS_ACCOUNT_PRIVATE_KEY '{"digest_function": "ed25519", "payload": "038AE16B219DA35AA036335ED0A43C28A2CC737150112C78A7B8034B9D99C9023F4E3E98571B55514EDC5CCF7E53CA7509D89B2868E62921180A6F57C2F4E255"}'
ENV IROHA_GENESIS_WAIT_FOR_PEERS_RETRY_COUNT_LIMIT 100
ENV IROHA_GENESIS_WAIT_FOR_PEERS_RETRY_PERIOD_MS 500
ENV IROHA_GENESIS_GENESIS_SUBMISSION_DELAY_MS 1000

# Expose the required ports
EXPOSE 1337 8080 8180

# Set the working directory
WORKDIR /opt/iroha_data

# Copy the configuration files
COPY ./configs/peer/stable /config

# Command to run on container startup
CMD ["iroha", "--submit-genesis"]

And executed like this:

docker build -t local-iroha .
docker run -d -p 8080:8080 -p 1337:1337 -p 8180:8100  local-iroha

Add utility methods to build, sign, and send a transaction

Add utility methods to build, sign, and send a transaction. Something like:

• createTransactionPayload
  • The request was canceled because your example helped them @0x009922
• signTransactionPayload
• submitVersionedTransaction

Generate data model as Markdown and track in in Git

Description

Currently, both __schema__.json and __generated__.json are gitignored. However, if some kind of schema reflection is tracked, it would help:

• to be more mindful about schema changes during PRs
• to quickly review schema without looking into published packages, right on GitHub or whatever

Move to HL-provided runners

Use iroha-ubuntu-latest in CI/CD

Fix deps for `@iroha2/crypto-target-*`

Now each target has @iroha2/crypto-core as a dev dependency, but actually it is a major dependency.

Add versioning matrix

Motivation

Currently, it is hard to understand how to get the right version of SDK according to the version of Iroha. Having some source of information would help.

Draft design

• Table contents:

  Iroha	@iroha2/client & @iroha2/data-model	Iroha commit
  2.0.0-pre-rc.9	4.0.0, 4.1.0	e3cd89b

• Table should be put in a place independent from the code. Otherwise, it might be not trivial to understand where to patch and where to look for the source of truth, especially when some older versions get patches.

Feature proposal: evaluate `Expression` on type-level

Expression is a data-model structure that allows to build simple or complex expressions that are evaluated to something at runtime in Iroha.

TODO: show expression examples

Currently Expression implementation in TypeScript is completely dynamic and cannot guarantee that built Expression will not fail to evaluate at runtime. However, I think that evaluation mechanism is pretty determined, and Expression can be described as type-strong discriminated unions, thus, it is possible to develop a type that will compute the resulting type of an expression based on its shape.

I think this feature requires, first of all, improvement of @scale-codec/definition-compiler so it will generate enum factories that builds a concrete enum variant instead of telling TypeScript that build value is any of variants:

// now:

const val1 = OptionStr('Some', '4')
// type: OptionStr

// should be:

const val2 = OptionStr('Some', '4')
// type (roughly): { tag: 'Some', content: '4' } 

This change will allow to give TypeScript precise information about the built enums.

Secondly, iroha-javascript should provide:

export type EvaluateExpression<E extends Expression> = ... // evaluation prediction

Finally, there should be convenient builders that leverate this util type and will allow to build instructions with checked expressions, which should give a huve DX improvement.

Related issue in Java SDK:

• hyperledger/iroha-java#159

Producing a pending transaction will not give any output, which results in a non-terminating condition

I tried to produce a pending transaction. (Below is the case when we have quorum == 2, but only request the command with 1 private key.)

It has been successfully produced if I check it via getpendingTransaction().

However, the thing here is that (See figure 1 again) it does not give any output. The code is stuck and unable for us to execute any new lines of code.

Remove `accountId` from the `Signer`

Description

Signer class has accountId field within it. It is located there so that Client can access it.

I think it doesn't make sense. Signer should be constructed only from a key pair, because it is the only one essential part for making signatures.

How to utilize `generateKeyPairWithConfiguration`

This might be rather a Q&A issue than a bug reporting.

Steps to Reproduce

Clone the reporting repository https://github.com/outSH/iroha2_check/tree/7e148419ae1d886a1f41b045bcc4dda1e379bfff and

tsx generate-key.ts

Expected Behavior

The script, which is trying to utilize generateKeyPairWithConfiguration, successfully runs

Actual Behavior

As described in the script https://github.com/outSH/iroha2_check/blob/7e148419ae1d886a1f41b045bcc4dda1e379bfff/generate-key.ts

Possible Causes

Possible Solution

Move WASM singleton from `@iroha2/client` to `@iroha2/crypto-core`

Description

Currently, @iroha2/client provides a mechanism to inject the crypto instance into the library, so that all crypto-related functions will work after that:

import { setCrypto } from '@iroha2/client'
import { crypto } from '@iroha2/crypto-target-node'

setCrypto(crypto)

The proposal is to move this singleton to the @iroha2/crypto-core package, because it seems to make more sense:

import { setCryptoWasm } from '@iroha2/crypto-core'
import { cryptoWasm } from '@iroha2/crypto-target-node'

setCryptoWasm(cryptoWasm)

After that, it will be probably possible to move all "interface wrap" into the single core package, and each crypto-target-* package will be a simple WASM exporter

Benefits

• More intuitive API: the crypto part is moved to the crypto package
• Simpler code base - no complicated wrap bundling for each target

Drawbacks

There might be some unexpected limitations, needs research.

Enhance Crypto WASM interface

• Add hex-related methods (to extract hex strings directly from WASM)
• Make API more functional; avoid free-able objects as much as possible, or expose efficient pure methods for the most common cases
• Use original iroha_crypto if possible
• Documentation

Unexpected type (Quantity / Fixed)

Matías Salimbene reported an issue with types in Iroha JS SDK today.

Transaction validation failed reason=Validation failed caused_by=Some(InstructionFailed(Evaluate(Type(AssetValueType(Mismatch { expected: Fixed, actual: Quantity })))))

The valueType is correctly registered as Quantity (not Fixed).

    "value_type": {
        "enum": {
            "tag": "Quantity"
        }
    }

Additionaly, Matías gets an error if he doesn't provide the quantity with decimal precision, i.e quantity: "100" fails, but quantity:"100.0" is fine. He'd like to know whether this should be expected.

Provided context:

• Peer: stable-2.0.0-pre-rc.20
• client/data model: ^7.0.0

Webpack issues/recommendation

• Do not include vendor libraries at irohajs bundle.
• Distinct configuration for web & nodejs client.

Error in ensureDomainExistence function: "Decode data for discriminant 85 is undefined"

Today, Youssef Mohammad reported an error occuring with Iroha-JS in Iroha Telegram.

Log

js
file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/core/dist/lib.mjs:583
  throw new Error(`Decode data for discriminant ${discriminant} is undefined; decoders schema: ${formatDecoders(decoders)}`);
        ^

Error: Decode data for discriminant 85 is undefined; decoders schema: 0 => Decode(...), 1 => Signature(...), 2 => Permission(...), 3 => Evaluate(...), 4 => Find(...), 5 => Conversion(...)
  at decodeEnum (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/core/dist/lib.mjs:583:11)
  at file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/core/dist/lib.mjs:590:22
  at trackDecode (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/definition-runtime/dist/lib.mjs:19:61)
  at decodeTracked (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/definition-runtime/dist/lib.mjs:238:37)
  at WalkerImpl.decode (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/core/dist/lib.mjs:16:19)
  at Function.fromBuffer (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@scale-codec/definition-runtime/dist/lib.mjs:243:37)
  at Client.request (file:///C:/Users/ASUS/Desktop/crowd-funding/node_modules/@iroha2/client/dist/lib.mjs:350:42)
  at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
  at async ensureDomainExistence (file:///C:/Users/ASUS/Desktop/crowd-funding/client.js:120:18)
  at async file:///C:/Users/ASUS/Desktop/crowd-funding/client.js:136:1

Node.js v18.9.0

Details reported:

• A bare-metal version of Iroha
• iroha2-stable branch
• Git commit hash for Iroha: eec85ce9
• @iroha2/client ver. 2.0.2
• Distro running Iroha peer(s): Ubuntu 20.04.5 LTS
• Distro running the client: Windows 10
• uname -a output: Linux Hyper 5.4.0-125-generic #141-Ubuntu SMP Wed Aug 10 13:42:03 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux

ReDoS

Introduced through: [email protected] › [email protected] › [email protected]
Remediation: No remediation path available.
Introduced through: [email protected] › [email protected] › [email protected] › [email protected]
Remediation: No remediation path available.

Store asset information is incomplete when querying with JS Api (works with iroha_client_cli)

I'm working to stores assets and currently I'm able to register an asset definition of type store, and then set it data with SetKeyValueExpr, but when I query said information, it isn't returned:

Example, this is what I get with the API:

{
        "id": {
            "definition_id": {
                "name": "datastore",
                "domain_id": {
                    "name": "spaceai"
                }
            },
            "account_id": {
                "domain_id": {
                    "name": "spaceai"
                },
                "name": "admin"
            }
        },
        "value": {
            "enum": {
                "tag": "Store",
                "content": {
                    "map": {}
                }
            }
        }
    }

I cannot see the information I've registered. But I can if I query with iroha_cli_client:

{
    "id": "datastore##admin@spaceai",
    "value": {
      "Store": {
        "key": {
          "String": "value"
        },
        "marco": {
          "String": "polo"
        },
        "ping": {
          "String": "pong"
        }
      }
    }
  }

My environment:

• Iroha version=2.0.0-pre-rc.20 git_commit_sha="8fa9bc0"
• API/datamodel:
  • "@iroha2/client": "^7.0.0",
  • "@iroha2/data-model": "^7.0.0",
• Samd ID/Credentials used for both.

And this is the code used to query data with the API:

const getAsset = async (filter) => {
  logger.info(`[srv] getAsset ... ${filter || 'all'}`);

  const { pre, client } = _clientFactory('admin', 'spaceai');

  const query = sugar.find.allAssets();

  try {
    const result = await client.requestWithQueryBox(pre, query);

    const { tag, content } = result;
    if (tag !== 'Ok') return { error: content.enum.content.enum.content };

    if (filter) {
      const asset = result
        .as('Ok')
        .batch.enum.as('Vec')
        .map((x) => x.enum.as('Identifiable').enum.as('Asset'))
        .find((x) => x.id.definition_id.name === filter); // [!code hl]

      return { data: asset || 'not found' };
    }

    const assets = result
      .as('Ok')
      .batch.enum.as('Vec')
      .map((x) => x.enum.as('Identifiable').enum.as('Asset'));

    return { data: assets };
  } catch (error) {
    console.log(error);
    return { error: error.message };
  }
};

Fix `@iroha2/data-model-schema` package, bundle it

Description

This package has broken dependencies (they are not specified correctly) and not all its API is exposed. In the meanwhile, it is useful e.g. for the documentation to re-use types from this package.

Also, it seems that TupleStruct variant is not used anymore.

Make client transport-agnostic

Using some concrete HTTP and WebSocket client limits some usage possibilities.

For HTTP client uses native Fetch API in browser and node-fetch in node. It is quite lightweight, but it has a set of drawbacks:

• To put some custom header, client should expose a separate API for it
• To use some advanced fetch api like request abortion, client should expose a separate API for it

And this list can go on and on. It is not a nice decision to handle each possible API extension by extending the client (i.e. iroha client) itself. It would be much nicer if client provides a toolchain to build requests and to handle responses for them.

For WebSocket client currently uses the same approach - native WebSocket in browser, and ws in node. It has the same set of drawbacks. And it can be solved in the same way.

Develop e2e-tests with actual Iroha peer(s)

Get transaction hash from `Client.submit()`

Description

Transaction hash might be needed to listen for related events after its submitting.

Currently submit methods returns Promise<void>, but it can return a shortcut to get the hash of the submitted transaction.

How it might look like

const txResult = await client.submit(...)
const hash: Uint8Array = txResult.transactionHash()

transactionHash() is a function to avoid unnecessary hash computations when it is not really needed.

Include hex utilities into SDK

Motivation

It is very common to serialise and deserialise bytes to HEX format while working with SDK. So, it makes sense to export a couple of functions for that.

Adding the means to generalize the code style

Hello.

It would help the review process if we established a common style for Iroha-JS, for example, using Prettier. It was added long ago for Iroha 2 and I think that copying that idea to the I1 branch would be nice.

[Q] will this package works in react native?

Hi,

Can anyone confirm or infirm if this package works with react native?
Thanks

Move grpc from devDependencies to dependencies

grpc is a dependency of iroha-helpers (irohaV1) but it's listed under devDependencies instead of dependencies. This causes error when user doesn't have grpc installed. Issue occured at our project (Hyperledger Cacti) when we updated from deprecated grpc to grpc-js.

To reproduce initialize empty TS nodejs project, npm i iroha-helpers (only), compile the following:

import { QueryService_v1Client as QueryService } from "iroha-helpers/lib/proto/endpoint_grpc_pb";

console.log(QueryService.toString());

And run. Error printed:

Error: Cannot find module 'grpc'
Require stack:
- /home/vagrant/tmp/iroha-check/node_modules/iroha-helpers/lib/proto/endpoint_grpc_pb.js
- /home/vagrant/tmp/iroha-check/index.js
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:995:15)
    at Function.Module._load (node:internal/modules/cjs/loader:841:27)
    at Module.require (node:internal/modules/cjs/loader:1067:19)
    at require (node:internal/modules/cjs/helpers:103:18)
    at Object.<anonymous> (/home/vagrant/tmp/iroha-check/node_modules/iroha-helpers/lib/proto/endpoint_grpc_pb.js:9:12)
    at Module._compile (node:internal/modules/cjs/loader:1165:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1219:10)
    at Module.load (node:internal/modules/cjs/loader:1043:32)
    at Function.Module._load (node:internal/modules/cjs/loader:878:12)
    at Module.require (node:internal/modules/cjs/loader:1067:19) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    '/home/vagrant/tmp/iroha-check/node_modules/iroha-helpers/lib/proto/endpoint_grpc_pb.js',
    '/home/vagrant/tmp/iroha-check/index.js'
  ]
}

Make code files compliant with the following license requirements

https://wiki.hyperledger.org/community/copyright-and-license-policy?s[]=license
https://www.hyperledger.org/about/charter #13

Actualize packages, use the new definition compiler in the data model

• Use @scale-codec/definition-compiler in @iroha2/data-model
• Handle FixedPoint<i64> type in the data model and test it with an actual Iroha2 peer
• Ensure that all tests are passing with an actual Iroha2 peer

Create a MAINTAINERS.md file

Example: https://github.com/hyperledger-labs/solang/blob/main/MAINTAINERS.md Example of a pointer: https://github.com/hyperledger-labs/homebrew-solang/blob/main/MAINTAINERS.md

`@iroha2/crypto-target-web` doesn't work with Vite out of the box

Issue

This code fails in Vite:

import { init } from '@iroha2/crypto-target-web'

await init()

Reproduction

https://github.com/0x009922/iroha-js-sdk-issue-104-repro

It includes error details.

Workaround

Using ?url suffix:

import { init } from '@iroha2/crypto-target-web'
import WASM_URL from '@iroha2/crypto-target-web/wasm-pkg/iroha_crypto_bg.wasm?url'

init(WASM_URL).then(() => {/* ... */})

Implement sort for some Maps, Sets and Vecs

The issue is that some structs, like Signatures, are sorted. That is, no matter in what order entries are inserted in the map or set (in Rust), when the map or set is encoded, its entries are sorted using PartialEq trait. It is wise - the exact encoded form has impact on hashing and signing (which could have BTreeMap metadata, for example). The ordered encoding ensures consistent output despite the insertion order.

The problem is that the JavaScript SDK doesn't perform sorting on encoding, so, signature check failures might be thrown by Iroha if SDK users don't sort some structs content on their own.

Utilities to generate keypair from seed and build transaction with existing payload

Request

There are two tasks:

• Provide utility to generate key pairs with some seed as input;
• Provide opportunity to build transaction using an existing payload as raw bytes.

Key pairs generation

The most efficient way to reach this goal and an ultimative solution for this is to completely port iroha_crypto crate into WASM. It is a big task and requires a lot of refactoring in Rust's sources.

Building transaction

I guess the solution for this will be a special TransactionBuilder helper that will provide several ways to build a transaction. I don't know how it will be looks like because it depends on how the new @iroha/crypto package will looks like.

Expose "append signature" utility

Description

Appending signature to an existing SignedTransaction is a common operation for multisignature workflows.

The API should look like this:

import { Signer, appendTransactionSignature } from '@iroha2/client'
import { datamodel } from '@iroha2/data-model'

/** @type {datamodel.VersionedSignedTransaction} */
let tx

tx = appendTransactionSignature(tx, keypair)

// or through `Signer`
tx = new Signer(keypair).appendTransactionSignature(tx)

readme doesn't match source

Readme needs to be updated to show the inputs into functions.

Add a check that block height is >= 1

const getBlocksListener = async () => {
    const stream = await Torii.listenForBlocksStream(pre, {
      // 1 is genesis block, which is committed before each test
      height: 0n,
    });

    return {
      /**
       * Do an operation that should trigger a block commit,
       * and wait until the block is emitted
       */

      awaitBlockCommit: async (fn) => {
        await Promise.all([stream.ee.once('block'), fn()]);
      },
    };
  };

  await blocks.awaitBlockCommit(async () => {
      await client.submitExecutable(pre, exec);
    });

This code results in a cryptic error message:

iroha::torii::routing: Failed to subscribe to blocks stream error=Error during versioned message decoding 

This happens because the code uses 0 instead of 1 to get the genesis block. Inside listenForBlocksStream we should check that the given height is in bounds before sending the request to the node

Proposal: throw explanatory errors in case of decoding errors

@iroha2/data-model is built on a particular version of Iroha 2, and there might be compatibility issues with other version of how structures are (de)serialised. It might cause confusing errors like #126.

I propose to wrap places where @iroha2/client makes Torii requests and decodes their responses with code that catches possible decoding errors and prints a meaningful warning with text like "this library targets Iroha 2 version xxx - please ensure that you're communicating with Iroha of the same version".

Online API documentation

It would be nice to generate TypeDoc for the whole SDK so it will be possible to explore the API of all packages online.

Is this library still being maintained?

Last commit was nine months ago, the link to the latest release is not working and you can't even import it into a vanilla node.js project using the github url due to the fact that there's only a .ts file.

Is this project (and HL Iroha along with it) going anywhere?

Fix problem of Colleagues from Fujitsu

Our colleagues from Fujitsu have asked us to provide assistance in setting up their Iroha interoperability. Their work can be found here.

https://github.com/outSH/iroha2_check

@0x009922, @antyas mentioned that you are working on something similar.

No Tx Hash on transfer asset

How I get the tx hash of submitted transaction using transferAsset function?

Enable Block Streaming API test back

It was disabled due to bug in Iroha 2 encountered during development.

Here is the test:

iroha-javascript/packages/client/test/integration/test-node/multiple.spec.ts

Line 529 in f90aaff

test.skip('When committing 3 blocks sequentially, nothing fails', async () => {

Fix packages included files

Client package tarball contents:

npm notice 📦  @iroha2/[email protected]
npm notice === Tarball Contents === 
npm notice 2.4kB  test/integration/test-node/node_modules/.bin/cross-env      
npm notice 2.4kB  test/integration/test-node/node_modules/.bin/cross-env-shell
npm notice 2.4kB  test/integration/test-node/node_modules/.bin/esr            
npm notice 2.0kB  test/integration/test-node/node_modules/.bin/vitest         
npm notice 337B   test/integration/test-web/index.html                        
npm notice 1.4kB  dist-tsc/blocks-stream.js                                   
npm notice 8.2kB  dist-tsc/client.js                                          
npm notice 712B   dist-tsc/collect-garbage.js                                 
npm notice 838B   test/integration/test-web/cypress/support/commands.js       
npm notice 418B   dist-tsc/const.js                                           
npm notice 135B   dist-tsc/crypto-singleton.js                                
npm notice 1.4kB  dist-tsc/events.js                                          
npm notice 996B   test/integration/test-web/cypress/plugins/index.js          
npm notice 670B   test/integration/test-web/cypress/support/index.js          
npm notice 14.6kB dist/lib.cjs.js                                             
npm notice 12.5kB dist/lib.esm.js                                             
npm notice 283B   dist-tsc/lib.js                                             
npm notice 2.7kB  dist-tsc/util.js                                            
npm notice 156B   api-extractor.json                                          
npm notice 488B   test/integration/config/client_config.json                  
npm notice 68B    test/integration/test-web/cypress.json                      
npm notice 1.9kB  package.json                                                
npm notice 481B   test/integration/test-node/package.json                     
npm notice 1.1kB  test/integration/test-web/package.json                      
npm notice 1.3kB  test/integration/config/peer_config.json                    
npm notice 2.4kB  test/integration/config/peer_genesis.json                   
npm notice 151B   test/integration/test-web/cypress/tsconfig.json             
npm notice 382B   test/integration/test-web/tsconfig.json                     
npm notice 203B   tsconfig.json                                               
npm notice 1.1kB  test/integration/test-node/node_modules/.pnpm-debug.log     
npm notice 610B   dist-tsc/blocks-stream.d.ts.map                             
npm notice 2.3kB  dist-tsc/client.d.ts.map                                    
npm notice 404B   dist-tsc/collect-garbage.d.ts.map                           
npm notice 398B   dist-tsc/const.d.ts.map                                     
npm notice 270B   dist-tsc/crypto-singleton.d.ts.map                          
npm notice 610B   dist-tsc/events.d.ts.map                                    
npm notice 23.8kB dist/lib.cjs.js.map                                         
npm notice 200B   dist-tsc/lib.d.ts.map                                       
npm notice 23.3kB dist/lib.esm.js.map                                         
npm notice 914B   dist-tsc/util.d.ts.map                                      
npm notice 2.4kB  CHANGELOG.md                                                
npm notice 120B   test/integration/test-node/CHANGELOG.md                     
npm notice 188B   test/integration/test-web/CHANGELOG.md                      
npm notice 741B   README.md                                                   
npm notice 303B   test/integration/README.md                                  
npm notice 637B   dist-tsc/blocks-stream.d.ts                                 
npm notice 1.9kB  src/blocks-stream.ts                                        
npm notice 2.7kB  dist-tsc/client.d.ts                                        
npm notice 9.4kB  src/client.ts                                               
npm notice 1.2kB  test/integration/test-web/src/client.ts                     
npm notice 324B   dist-tsc/collect-garbage.d.ts                               
npm notice 820B   src/collect-garbage.ts                                      
npm notice 527B   dist-tsc/const.d.ts                                         
npm notice 410B   src/const.ts                                                
npm notice 250B   dist-tsc/crypto-singleton.d.ts                              
npm notice 277B   src/crypto-singleton.ts                                     
npm notice 90B    test/integration/test-web/src/crypto.ts                     
npm notice 251B   test/integration/test-web/etc/dev-peer-server.ts            
npm notice 276B   test/integration/test-web/src/env.d.ts                      
npm notice 632B   dist-tsc/events.d.ts                                        
npm notice 1.7kB  src/events.ts                                               
npm notice 317B   test/integration/config/index.ts                            
npm notice 192B   src/json-bigint-shim.d.ts                                   
npm notice 316B   dist-tsc/lib.d.ts                                           
npm notice 4.8kB  dist/lib.d.ts                                               
npm notice 280B   src/lib.ts                                                  
npm notice 977B   test/integration/test-web/cypress/integration/main.ts       
npm notice 276B   test/integration/test-web/src/main.ts                       
npm notice 141B   test/integration/test-web/etc/meta.ts                       
npm notice 13.6kB test/integration/test-node/multiple.spec.ts                 
npm notice 200B   test/integration/prepare-peer.ts                            
npm notice 554B   test/integration/test-web/etc/test-run.ts                   
npm notice 859B   dist-tsc/util.d.ts                                          
npm notice 2.9kB  src/util.ts                                                 
npm notice 106B   test/integration/util.ts                                    
npm notice 1.3kB  test/integration/test-web/vite.config.ts                    
npm notice 162B   test/integration/test-node/vitest.config.ts                 
npm notice 375B   test/integration/test-web/src/App.vue                       
npm notice 1.7kB  test/integration/test-web/src/components/CreateDomain.vue   
npm notice 2.0kB  test/integration/test-web/src/components/Listener.vue       
npm notice 491B   test/integration/test-web/src/components/StatusChecker.vue  
npm notice 64B    test/integration/test-web/pnpm-global/5/pnpm-lock.yaml      
npm notice 11.3kB LICENSE                                                     
npm notice === Tarball Details === 
npm notice name:          @iroha2/client                          
npm notice version:       1.2.0                                   
npm notice package size:  38.7 kB                                 
npm notice unpacked size: 185.1 kB                                
npm notice shasum:        c470713a0ebf68566a1d210337ee7efa4b2eea57
npm notice integrity:     sha512-MfVY8ctMlFSfv[...]1nieBy/Ner17w==
npm notice total files:   83                                      
npm notice 
+ @iroha2/[email protected]

It is not OK. Other packages should be inspected as well.

Broken demo link

It seems demo link has been broken on README.
Where can I find it?

Expose raw schema and related utilities from the data model package