@bandprotocol/bandchain.js

TypeScript library for Cosmos SDK and BandChain

install

``sh
npm install @bandprotocol/bandchain.js
`

Table of contents

- @bandprotocol/bandchain.js
- install
- Table of contents
- Usage
- RPC Clients
- Composing Messages
- IBC Messages
- Cosmos Messages
- Connecting with Wallets and Signing Messages
- Initializing the Stargate Client
- Creating Signers
- Amino Signer
- Proto Signer
- Broadcasting Messages
- Advanced Usage
- Developing
- Codegen
- Publishing
- Related
- Credits
- Disclaimer

Usage

$3

`js
import { band } from "@bandprotocol/bandchain.js";

const { createRPCQueryClient } = band.ClientFactory;
const client = await createRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });

// now you can query the cosmos modules
const balance = await client.cosmos.bank.v1beta1.allBalances({
address: "band1addresshere",
});

// you can also query the band modules
const oracleScript = await client.band.oracle.v1.oracleScript({
oracleScriptId: BigInt(37),
});
`

$3

Import the band object from @bandprotocol/bandchain.js.

`js
import { band } from "@bandprotocol/bandchain.js";

const { requestData, reportData, createDataSource } =
band.oracle.v1.MessageComposer.withTypeUrl;
`

#### IBC Messages

`js
import { ibc } from "@bandprotocol/bandchain.js";

const { transfer } = ibc.applications.transfer.v1.MessageComposer.withTypeUrl;
`

#### Cosmos Messages

`js
import { cosmos } from "@bandprotocol/bandchain.js";

const {
fundCommunityPool,
setWithdrawAddress,
withdrawDelegatorReward,
withdrawValidatorCommission,
} = cosmos.distribution.v1beta1.MessageComposer.fromPartial;

const { multiSend, send } = cosmos.bank.v1beta1.MessageComposer.fromPartial;

const {
beginRedelegate,
createValidator,
delegate,
editValidator,
undelegate,
} = cosmos.staking.v1beta1.MessageComposer.fromPartial;

const { deposit, submitProposal, vote, voteWeighted } =
cosmos.gov.v1beta1.MessageComposer.fromPartial;
`

Connecting with Wallets and Signing Messages

⚡️ For web interfaces, we recommend using cosmos-kit. Continue below to see how to manually construct signers and clients.

Here are the docs on creating signers in cosmos-kit that can be used with Keplr and other wallets.

$3

Use getSigningBandClient to get your SigningStargateClient, with the proto/amino messages full-loaded. No need to manually add amino types, just require and initialize the client:

`js
import { getSigningBandClient } from "@bandprotocol/bandchain.js";

const stargateClient = await getSigningBandClient({
rpcEndpoint,
signer, // OfflineSigner
});
`

$3

To broadcast messages, you can create signers with a variety of options:

- cosmos-kit (recommended)
- keplr
- cosmjs

$3

Likely you'll want to use the Amino, so unless you need proto, you should use this one:

`js
import { getOfflineSignerAmino as getOfflineSigner } from "cosmjs-utils";
`

$3

`js
import { getOfflineSignerProto as getOfflineSigner } from "cosmjs-utils";
`

WARNING: NOT RECOMMENDED TO USE PLAIN-TEXT MNEMONICS. Please take care of your security and use best practices such as AES encryption and/or methods from 12factor applications.

`js
import { chains } from "chain-registry";

const mnemonic =
"unfold client turtle either pilot stock floor glow toward bullet car science";
const chain = chains.find(({ chain_name }) => chain_name === "band");
const signer = await getOfflineSigner({
mnemonic,
chain,
});
`

$3

Now that you have your stargateClient, you can broadcast messages:

`js
const { send } = cosmos.bank.v1beta1.MessageComposer.withTypeUrl;

const msg = send({
amount: [
{
denom: 'coin',
amount: '1000'
}
],
toAddress: address,
fromAddress: address
});

const fee: StdFee = {
amount: [
{
denom: 'coin',
amount: '864'
}
],
gas: '86364'
};
const response = await stargateClient.signAndBroadcast(address, [msg], fee);
`

Advanced Usage

If you want to manually construct a stargate client

`js
import { OfflineSigner, GeneratedType, Registry } from "@cosmjs/proto-signing";
import { AminoTypes, SigningStargateClient } from "@cosmjs/stargate";

import {
cosmosAminoConverters,
cosmosProtoRegistry,
cosmwasmAminoConverters,
cosmwasmProtoRegistry,
ibcProtoRegistry,
ibcAminoConverters,
bandAminoConverters,
bandProtoRegistry
} from 'bandchain.js';

const signer: OfflineSigner = / create your signer (see above) /
const rpcEndpint = 'https://rpc.cosmos.directory/band'; // or another URL

const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
...cosmosProtoRegistry,
...cosmwasmProtoRegistry,
...ibcProtoRegistry,
...bandProtoRegistry
];

const aminoConverters = {
...cosmosAminoConverters,
...cosmwasmAminoConverters,
...ibcAminoConverters,
...bandAminoConverters
};

const registry = new Registry(protoRegistry);
const aminoTypes = new AminoTypes(aminoConverters);

const stargateClient = await SigningStargateClient.connectWithSigner(rpcEndpoint, signer, {
registry,
aminoTypes
});
`

Developing

When first cloning the repo:

`
yarn
yarn build
`

$3

Look inside of scripts/codegen.ts and configure the settings for bundling your SDK and contracts into @bandprotocol/bandchain.js:

`
yarn codegen
`

$3

To publish, use lerna:

`
lerna publish
`

You can publish patch, minor, or major versions:

`
lerna publish minor
`

If you absolutely need to publish manually using npm, ensure to do it this way, and publish from the dist/ directory for proper tree-shaking module paths:

`
cd ./packages/
yarn build
cd dist
npm publish
``

Related

Checkout these related projects:

- @cosmology/telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
- @cosmwasm/ts-codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.
- chain-registry Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
- cosmos-kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
- create-cosmos-app Set up a modern Cosmos app by running one command.
- interchain-ui The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
- starship Unified Testing and Development for the Interchain.

Credits

🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.