CosmJS
CosmJS is the Swiss Army knife to power JavaScript based client solutions ranging from Web apps/explorers over browser extensions to server-side clients like faucets/scrapers in the Cosmos ecosystem.
"Cosm" is short for Cosmos and "JS" is short for runs everywhere – we actually develop in TypeScript.
Packages
CosmJS is a library that consists of many smaller npm packages within the @cosmjs namespace, a so called monorepo. Here are some of them to get an idea:
| Package | Description | Latest |
|---|---|---|
| @cosmjs/sdk38 | A client library for the Cosmos SDK 0.38 |  |
| @cosmjs/faucet | A faucet application for node.js |  |
| @cosmjs/cosmwasm | Client for chains with the CosmWasm module enabled |  |
| @cosmjs/crypto | Cryptography for blockchain projects, e.g. hashing (SHA-2, Keccak256, Ripemd160), signing (secp256k1, ed25519), HD key derivation (BIPO39, SLIP-0010), KDFs and symmetric encryption for key storage (PBKDF2, Argon2, XChaCha20Poly1305) |  |
| @cosmjs/encoding | Encoding helpers for blockchain projects |  |
| @cosmjs/math | Safe integers; decimals for handling financial amounts |  |
Modularity
We're pretty proud of the modularity and a clean dependency tree in this monorepo. This ensures software quality on our side and lets users pick exactly what they need. Here you see how everything fits together (every item is a npm package; right depends on left):
Supported JS environments
Currently the codebase supports the following runtime environments:
- Node.js 10+
- Modern browsers (Chromium/Firefox/Safari, no Internet Explorer or Edge Spartan)
- Browser extensions (Chromium/Firefox)
Our current JavaScript target standard is ES2017, giving us native async/await support. We use WebAssembly to implement certain cryptographic functions.
We're happy to adjust this list according to users' needs as long as you don't ask for Internet Explorer support. If your environment does not support Wasm, we can work on a solution with swapable implementations.
Roadmap
In addition to the development board and our release milestones, we maintain a higher level roadmap in this Trello board.
Development
Requires Node 10+. For best results, use yarn. The basic commands are:
yarn install
# compile the code
yarn build
# run unit tests
yarn test
# format and lint the code
yarn format && yarn lint
Integration tests
To run the entire test suite, you need to run a local blockchain to test against. We use wasmd for both CosmWasm tests and as a generic Cosmos SDK 0.38 blockchain. This should work on any Linux/OSX system with docker installed:
./scripts/wasmd/start.sh
./scripts/wasmd/init.sh
WASMD_ENABLED=1 yarn test
./scripts/wasmd/stop.sh