Cosmosjs
⭐ CosmosJS - Cosmos JavaScript Library
Install / Use
/learn @oraichain/CosmosjsREADME
:star: Was developed: Oraichain
:warning: This repository is now archived because Cosmjs developed by Cosmos is more widely used. This repo offers no different use cases, and shall be referenced as a studying tool for Web3.
A JavasSript Open Source Library for Oraichain, Cosmos Network and other Cosmos based networks using the latest Cosmos SDK Stargate version upgrade.
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.
Installation
In order to fully use this library, you need to run a local or remote network with at least a validator node and set up its rest server, which acts as an intermediary between the front-end and the node
NPM
npm install @oraichain/cosmosjs
Yarn
yarn add @oraichain/cosmosjs
Import
NodeJS
const Cosmos = require("@oraichain/cosmosjs").default;
ES6 module
import Cosmos from "@oraichain/cosmosjs";
Usage
- Cosmos: Generate Cosmos address from mnemonic
const Cosmos = require("@oraichain/cosmosjs").default;
const lcdUrl = "http://localhost:1317";
const chainId = "Oraichain";
const mnemonic = "foo bar";
const toAddr = "orai1x6xl5kls4xkmkv3rst5tndmxtqt0u8dxhnw7cg";
const amount = 10;
const fees = 100;
const message = Cosmos.message;
const cosmos = new Cosmos(lcdUrl, chainId);
cosmos.setBech32MainPrefix('orai');
const childKey = cosmos.getChildKey(mnemonic);
const address = cosmos.getAddress(mnemonic);
Transfer ORAI to designated address.
const msgSend = new message.cosmos.bank.v1beta1.MsgSend({
from_address: cosmos.getAddress(childKey),
to_address: toAddr,
amount: [{ denom: cosmos.bech32MainPrefix, amount: String(amount) }]
});
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: ''
});
try {
const response = cosmos.submit(childKey, txBody, 'BROADCAST_MODE_BLOCK', isNaN(fees) ? 0 : parseInt(fees)).then((response) => { console.log(response) });
} catch (ex) {
console.log(ex);
}
Run the script
Assume the filename is demo.js. Run:
node demo.js
Supporting Message Types (Updating...)
- Since we have Typescript, you can easily know which message types the library supports. We will update the list of message types often.
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
- Official Website
- Mintscan Explorer
- Web Wallet
- Android Wallet
- iOS Wallet
- Telegram - International
- Kakao - Koreans
Oraichain's Services and Community
Contributors ✨
Thanks goes to these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://www.cosmostation.io/"><img src="https://avatars3.githubusercontent.com/u/34641838?v=4" width="100px;" alt=""/><br /><sub><b>Booyoun</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=Booyoun-Kim" title="Code">💻</a> <a href="https://github.com/cosmostation/cosmosjs/issues?q=author%3ABooyoun-Kim" title="Bug reports">🐛</a> <a href="#maintenance-Booyoun-Kim" title="Maintenance">🚧</a></td> <td align="center"><a href="https://github.com/ducphamle2"><img src="https://avatars.githubusercontent.com/u/44611780?v=4" width="100px;" alt=""/><br /><sub><b>Le Duc Pham</b></sub></a><br /><a href="https://github.com/oraichain/cosmosjs/commits?author=ducphamle2" title="Code">💻</a></td> <td align="center"><a href="https://github.com/tubackkhoa"><img src="https://avatars.githubusercontent.com/u/5299269?v=4" width="100px;" alt=""/><br /><sub><b>Thanh Tu Pham</b></sub></a><br /><a href="https://github.com/oraichain/cosmosjs/commits?author=tubackkhoa" title="Code">💻</a></td> <td align="center"><a href="https://jaybdev.net"><img src="https://avatars1.githubusercontent.com/u/20435620?v=4" width="100px;" alt=""/><br /><sub><b>JayB</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=kogisin" title="Code">💻</a> <a href="https://github.com/cosmostation/cosmosjs/commits?author=kogisin" title="Documentation">📖</a> <a href="#maintenance-kogisin" title="Maintenance">🚧</a></td> <td align="center"><a href="https://clovers.network"><img src="https://avatars2.githubusercontent.com/u/964052?v=4" width="100px;" alt=""/><br /><sub><b>billy rennekamp</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=okwme" title="Code">💻</a> <a href="https://github.com/cosmostation/cosmosjs/issues?q=author%3Aokwme" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/tonyfeung"><img src="https://avatars3.githubusercontent.com/u/5483234?v=4" width="100px;" alt=""/><br /><sub><b>Tony Phuong Nguyen</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=tonyfeung" title="Code">💻</a></td> <td align="center"><a href="https://github.com/Tosch110"><img src="https://avatars2.githubusercontent.com/u/8368497?s=460&u=f82d3c518432276c191dc00f1524b7d8098bf828&v=4" width="100px;" alt=""/><br /><sub><b>Tobias Schwarz</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=Tosch110" title="Code">💻</a></td> <td align="center"><a href="https://github.com/scottburch"><img src="https://avatars3.githubusercontent.com/u/103808?s=460&v=4" width="100px;" alt=""/><br /><sub><b> Scott Burch</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=scottburch" title="Maintenance">🚧</a></td> <td align="center"><a href="https://github.com/okwme"><img src="https://avatars0.githubusercontent.com/u/1866496?s=460&v=4" width="100px;" alt=""/><br /><sub><b>billy rennekamp</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=okwme" title="Maintenance">🚧</a></td> <td align="center"><a href="https://github.com/pgrimaud"><img src="https://avatars3.githubusercontent.com/u/5483234?v=4" width="100px;" alt=""/><br /><sub><b>Pierre Grimaud</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=pgrimaud" title="Maintenance">🚧</a></td> <td align="center"><a href="https://github.com/levackt"><img src="https://avatars3.githubusercontent.com/u/10286403?s=460&v=4" width="100px;" alt=""/><br /><sub><b>Taariq Levack</b></sub></a><br /><a href="https://github.com/cosmostation/cosmosjs/commits?author=levackt" title="Maintenance">🚧</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!
Related Skills
node-connect
346.4kDiagnose OpenClaw node connection and pairing failures for Android, iOS, and macOS companion apps
frontend-design
107.2kCreate distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.
openai-whisper-api
346.4kTranscribe audio via OpenAI Audio Transcriptions API (Whisper).
qqbot-media
346.4kQQBot 富媒体收发能力。使用 <qqmedia> 标签,系统根据文件扩展名自动识别类型(图片/语音/视频/文件)。
