@cosmostation/cosmosjs
A JavasSript Open Source Library for Cosmos Network, IRISnet, and Kava
Last updated 23 days ago by cosmostation .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @cosmostation/cosmosjs 
SYNC missed versions from official npm registry.

All Contributors

Cosmostation logo

CosmosJS - Cosmos JavaScript Library

:star: Developed / Developing by Cosmostation

A JavasSript Open Source Library for Cosmos Network, IRISnet and Kava

This library supports cosmos address generation and verification. It enables you to create an offline signature functions of different types of transaction messages. It will eventually support all the other blockchains that are based on Tendermint in the future, such as IOV and others.

MIT NPM

Installation

In order to fully use this library, you need to run a local or remote full node and set up its rest server, which acts as an intermediary between the front-end and the full-node

NPM

npm install @cosmostation/cosmosjs

Yarn

yarn add @cosmostation/cosmosjs

Browser Distribution

CosmosJS supports browserify.

Import

NodeJS

const cosmosjs = require("@cosmostation/cosmosjs");

Browser

<script src='js/cosmosjs-bundle.js'></script>

Usage

  • Cosmos: Generate Cosmos address from mnemonic
const cosmosjs = require("@cosmostation/cosmosjs");

const chainId = "cosmoshub-3";
const cosmos = cosmosjs.network(lcdUrl, chainId);

const mnemonic = "..."
cosmos.setPath("m/44'/118'/0'/0/0");
const address = cosmos.getAddress(mnemonic);
const ecpairPriv = cosmos.getECPairPriv(mnemonic);
  • Iris
const cosmosjs = require("@cosmostation/cosmosjs");

const chainId = "irishub";
const iris = cosmosjs.network(lcdUrl, chainId);
iris.setBech32MainPrefix("iaa");
  • Kava
const cosmosjs = require("@cosmostation/cosmosjs");

const chainId = "kava-2";
const kava = cosmosjs.network(lcdUrl, chainId);
kava.setBech32MainPrefix("kava");

Generate ECPairPriv value that is needed for signing signatures

const ecpairPriv = cosmos.getECPairPriv(mnemonic);

Transfer ATOM to designated address.

  • Make sure to input proper type, account number, and sequence of the cosmos account to generate StdSignMsg. You can get those account information on blockchain
  • Above 0.5.0 version, CosmosJS follows the exact same json format as Cosmos SDK defines.
cosmos.getAccounts(address).then(data => {
	let stdSignMsg = cosmos.newStdMsg({
		msgs: [
			{
				type: "cosmos-sdk/MsgSend",
				value: {
					amount: [
						{
							amount: String(100000),
							denom: "uatom"
						}
					],
					from_address: address,
					to_address: "cosmos18vhdczjut44gpsy804crfhnd5nq003nz0nf20v"
				}
			}
		],
		chain_id: chainId,
		fee: { amount: [ { amount: String(5000), denom: "uatom" } ], gas: String(200000) },
		memo: "",
		account_number: String(data.result.value.account_number),
		sequence: String(data.result.value.sequence)
	});

	...
})

Sign transaction by using stdSignMsg and broadcast by using /txs REST API

const signedTx = cosmos.sign(stdSignMsg, ecpairPriv);
cosmos.broadcast(signedTx).then(response => console.log(response));

Cosmostation offers LCD url(https://lcd-cosmos-free.cosmostation.io).

  • API Rate Limiting: 10 requests per second

Supporting Message Types (Updating...)

Documentation

This library is simple and easy to use. We don't have any formal documentation yet other than examples. Ask for help if our examples aren't enough to guide you

Contribution

  • Contributions, suggestions, improvements, and feature requests are always welcome

When opening a PR with a minor fix, make sure to add #trivial to the title/description of said PR.

Cosmostation's Services and Community

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Booyoun

???? ???? ????

JayB

???? ???? ????

billy rennekamp

???? ????

Tony Phuong Nguyen

????

This project follows the all-contributors specification. Contributions of any kind welcome!

Current Tags

  • 0.5.6                                ...           latest (23 days ago)

20 Versions

  • 0.5.6                                ...           23 days ago
  • 0.5.5                                ...           2 months ago
  • 0.5.4                                ...           2 months ago
  • 0.5.3                                ...           3 months ago
  • 0.5.2                                ...           4 months ago
  • 0.5.1                                ...           4 months ago
  • 0.4.5                                ...           5 months ago
  • 0.4.4                                ...           5 months ago
  • 0.4.3                                ...           6 months ago
  • 0.4.2                                ...           6 months ago
  • 0.4.1                                ...           7 months ago
  • 0.4.0                                ...           8 months ago
  • 0.3.1                                ...           9 months ago
  • 0.3.0                                ...           10 months ago
  • 0.2.3                                ...           10 months ago
  • 0.2.2                                ...           a year ago
  • 0.2.0                                ...           a year ago
  • 0.1.2                                ...           a year ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 47
Last Day 1
Last Week 23
Last Month 19
Dependencies (6)
Dev Dependencies (1)

Copyright 2014 - 2016 © taobao.org |