medibloc / panacea-js

Official client-side JavaScript library for the MediBloc platform.

Panacea Javascript SDK

The panacea-js is the official Panacea Javascript SDK written in Typescript, powered by CosmJS.

The panacea-js extends the CosmJS in order to provide Panacea-specific features (AOL, DID, and so on). So, it exposes CosmJS basic functions as they are, such as connectWithSigner and sendTokens.

Usage

Installation

yarn add @medibloc/panacea-js \
  @cosmjs/[email protected] \
  @cosmjs/[email protected] \
  [email protected]

Examples

A list of examples can be found at the example.md.

Contribution

Install dependencies and build the project.

yarn install
yarn build

To run simple unit tests,

yarn test

To run integration tests with panacea-core, start a panacea-core daemon first.

docker run --rm -d \
  -e CHAIN_ID="chain-1" \
  -e MNEMONIC="..." \
  -p 26657:26657 \
  -v $(pwd)/scripts:/root/scripts \
  --name core \
  ghcr.io/medibloc/panacea-core:master \
  bash /root/scripts/panacea-core/init.sh

Then, the integration tests can be run with the following environment variables.

PANACEAD_ENABLED=true \
TENDERMINT_URL="http://localhost:26657" \
CHAIN_ID="chain-1" \
MNEMONIC="..." \
yarn test

For more details, please see the CI script.

License

Apache-2.0 License

panacea-js's Issues

Follow up the new Cosmos REST spec

At cosmos-sdk v0.36.0, many breaking changes were introduced, regards to the HTTP response format.
cosmos/cosmos-sdk#4536
cosmos/cosmos-sdk#4837
https://github.com/cosmos/cosmos-sdk/blob/master/CHANGELOG.md#breaking-changes

To use the panacea-core v1.3.1 which uses the new cosmos-sdk, this Javascript SDK must be upgraded.

Related to medibloc/panacea-java#8

Need a way to check if TxResponse is successful

BroadcastReq req = new BroadcastReq(tx, "block");
TxResponse res = client.broadcast(req);

When the broadcast mode is block, the TxResponse could contain an error message if tx is failed:

TxResponse[height=0,txHash=34CD44AD255B896F8B9C34EE89E00E0C8E3A7B305BF825515BD88174E07E1239,code=4,data=<null>,rawLog={"codespace":"sdk","code":4,"message":"signature verification failed; verify correct account sequence and chain-id"},info=<null>,gasWanted=<null>,gasUsed=20421,codespace=<null>,timestamp=<null>,tx=<null>]

If it's not okay to make broadcast() throws an Exception in this case, we need to provide the way to check if tx was successful, at least.

Wrap responses using proper classes

Except DID operations, all responses are Javascript plain objects.
It's not good to handle breaking changes from CosmosSDK REST API. Also, it's not good for usability.

Define proper Typescript classes and wrap all responses.

Escape HTML characters for JSON marshalling when signing on transactions

This issue was found from Panacea Java SDK: medibloc/panacea-java#16.
Check whether that is also valid for this panacea-js.

Follow up the latest DID spec: @context, verificationMethod, controller, authentication

Refer to medibloc/panacea-core#44, medibloc/panacea-core#45

Web3 Keystore compatibility

There is already a TODO:

panacea-js/src/crypto/index.js

Line 167 in 960607d

// TODO @ggomma check compatibility with old panacea-js

This code uses

• key derivation function: pbkdf2
• cipher algorithm: aes-256-ctr

However, Web3 Secret Storage Definition says the cipher algorithm should be aes-128-ctr, not aes-256-ctr.

All minimally-compliant implementations must support the AES-128-CTR algorithm

On the contrary, panacea-core uses

• key derivation function: scrypt
• cipher algorithm: aes-128-ctr

I would suggest that the cipher algorithm of panacea-js should be replaced with aes-128-ctr.
Also, for the compatibility with panacea-core, we need to decided the KDF (pbkdf2 vs scrypt).

If panacea-js has being used for many services, the backward-compatibility would be a critical issue.
If it's the problem, I can modify panacea-core because the keystore is used only for DID in panacea-core. There's no backward-compatibility issue. But still, the cipher algorithm should be aes-128-ctr.

Support DID operations

• for Dynamic Agreement project with SNUH.
• Higher priority than other Panacea SDKs.

Migrate to Typescript

Tx Messages are getting complicated, especially DID stuff.
For better/safe maintainability, I'd suggest to migration from Javascript to Typescript.

The code base is not small. So, let's start with small stuff by keeping the backward-compatibility.
For example, most class constructors are accepting an any or a Record<string,any>.
We might need to keep them as they are, because some clients are using those constructors.

Behind the scene, we can prepare the ultimate type-safe version gradually.
Then, we can deploy the brand-new version when it's ready.

Support Panacea v2