Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Added publish option and version up to 2.2.1 #78

Merged
merged 3 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Panacea Javascript SDK

The `panacea-js` is the official [Panacea](https://github.com/medibloc/panacea-core) Javascript SDK written in Typescript, powered by [CosmJS](https://github.com/cosmos/cosmjs).

The `panacea-js` extends the CosmJS in order to provide [Panacea-specific features](https://github.com/medibloc/panacea-core#key-features) (AOL, DID, PNFT).
So, it exposes CosmJS basic functions as they are, such as `connectWithSigner` and `sendTokens`.

## Usage

### Installation

```bash
yarn add @medibloc/panacea-js \
@cosmjs/proto-signing@0.32.3 \
@cosmjs/stargate@0.32.3 \
cosmjs-types@0.9.0
```

### Examples

A list of examples can be found at the [example.md](docs/examples.md).

## Contribution

Install dependencies and build the project.
```bash
yarn install
yarn build
```

To run simple unit tests,
```bash
yarn test
````

To run integration tests with [panacea-core](https://github.com/medibloc/panacea-core), start a `panacea-core` daemon first.
```bash
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:v2.2.0 \
bash /root/scripts/panacea-core/init.sh
```

Then, the integration tests can be run with the following environment variables.
```bash
PANACEAD_ENABLED=true \
TENDERMINT_URL="http://localhost:26657" \
CHAIN_ID="chain-1" \
MNEMONIC="..." \
yarn test
```

For more details, please see the [CI script](.github/workflows/ci.yml).

## License

[Apache-2.0 License](LICENSE)
Loading
Loading