当前位置：首页 > 软件库 > Web3 > 区块链 >

cosmosjs

⭐ CosmosJS - Cosmos JavaScript Library

授权协议 MIT License

开发语言

所属分类 Web3、区块链

软件类型开源软件

地区不详

投递者法烨烨

操作系统跨平台

开源组织无

适用人群未知

软件概览

CosmosJS - Cosmos JavaScript Library

⭐ Developed / Developing by Cosmostation

A JavasSript Open Source Library for Cosmoshub, IRISnet, Starname, and Akash Network.

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.

⚠️ If you need for classic version for amino signing, download a version under v0.9.7

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 (Protobuf)

npm install @cosmostation/cosmosjs

Yarn (Protobuf)

yarn add @cosmostation/cosmosjs

NPM (Amino)

https://github.com/cosmostation/cosmosjs/tree/classic

npm install @cosmostation/cosmosjs@0.9.7

Yarn (Amino)

https://github.com/cosmostation/cosmosjs/tree/classic

yarn add @cosmostation/cosmosjs@0.9.7

Import

import { Cosmos } from "../src/index.js";

Usage

You need to import Cosmos-sdk Protobuf message file as js. It is created by protocgen.sh.
@cosmostation/cosmosjs@0.10.0+ is running above nodejs v14+
You can run with this option for ES6.

$ node --es-module-specifier-resolution=node example/cosmoshub.js

Import the message file that is converted from Cosmos-sdk proto.

import message from "../src/messages/proto";

Stargate-final: Generate Cosmos address from mnemonic

const mnemonic = "..."
const chainId = "cosmoshub-4";
const cosmos = new Cosmos(lcdUrl, chainId);

cosmos.setPath("m/44'/118'/0'/0/0");
const address = cosmos.getAddress(mnemonic);

Generate both privKey and pubKeyAny that are needed for signing.

const privKey = cosmos.getECPairPriv(mnemonic);
const pubKeyAny = cosmos.getPubKeyAny(privKey);

Transfer ATOM to designated address.

Make sure to input proper type, account number, and sequence of the cosmos account to generate protobuf structure. You can get those account information on blockchain. Protobuf signing is different from Amino signing.

cosmos.getAccounts(address).then(data => {
	// signDoc = (1)txBody + (2)authInfo
	// ---------------------------------- (1)txBody ----------------------------------
	const msgSend = new message.cosmos.bank.v1beta1.MsgSend({
		from_address: address,
		to_address: "cosmos1jf874x5vr6wkza6ahvamck4sy4w76aq4w9c4s5",
		amount: [{ denom: "uatom", amount: String(100000) }]		// 6 decimal places (1000000 uatom = 1 ATOM)
	});

	const msgSendAny = new message.google.protobuf.Any({
		type_url: "/cosmos.bank.v1beta1.MsgSend",
		value: message.cosmos.bank.v1beta1.MsgSend.encode(msgSend).finish()
	});

	const txBody = new message.cosmos.tx.v1beta1.TxBody({ messages: [msgSendAny], memo: "" });

	// --------------------------------- (2)authInfo ---------------------------------
	const signerInfo = new message.cosmos.tx.v1beta1.SignerInfo({
		public_key: pubKeyAny,
		mode_info: { single: { mode: message.cosmos.tx.signing.v1beta1.SignMode.SIGN_MODE_DIRECT } },
		sequence: data.account.sequence
	});

	const feeValue = new message.cosmos.tx.v1beta1.Fee({
		amount: [{ denom: "uatom", amount: String(5000) }],
		gas_limit: 200000
	});

	const authInfo = new message.cosmos.tx.v1beta1.AuthInfo({ signer_infos: [signerInfo], fee: feeValue });

	...
});

Sign transaction by using stdSignMsg and broadcast by using /cosmos/tx/v1beta1/txs REST API

const signedTxBytes = cosmos.sign(txBody, authInfo, data.account.account_number, privKey);
cosmos.broadcast(signedTxBytes).then(response => console.log(response));

Official LCD url(https://api.cosmos.network).

This rest server URL may be disabled at any time. In order to maintain stable blockchain service, it is recommended to prepare your rest server.
Setting up the rest server: (https://hub.cosmos.network/main/gaia-tutorials/join-mainnet.html#enable-the-rest-api)

Supporting Message Types (Updating...)

We will continue to update the protobuf signing structure.

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