@unification-com/fundjs

FUND JS

install

npm install @unification-com/fundjs

Table of contents

• @unification-com/fundjs
  • Install
  • Table of contents
• Usage
  • RPC Clients
  • Composing Messages
    • Cosmos, CosmWasm, and IBC
      • CosmWasm
      • IBC
      • Cosmos
• Wallets and Signers
  • Stargate Client
  • Creating Signers
  • Broadcasting Messages
• Advanced Usage
• Developing
• Codegen
• Publishing
• Related
• Credits

Usage

RPC Clients

import { mainchain, ibc } from '@unification-com/fundjs';

const { createRPCQueryClient: createMainchainRPCQueryClient } = mainchain.ClientFactory;
const { createRPCQueryClient: createIbcRPCQueryClient } = ibc.ClientFactory;
const mcClient = await createMainchainRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });

// now you can query the cosmos modules
const balance = await mcClient.cosmos.bank.v1beta1
    .allBalances({ address: 'und123abc...' });

// you can also query the unification mainchain modules
const streams = await mcClient.mainchain.stream.v1.streams()

// ICB has its own client
const ibcClient = await createIbcRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });

// also with Cosmos endpoints
const balance1 = await ibcClient.cosmos.bank.v1beta1
  .allBalances({ address: 'und123abc...' });

// and IBC endpoints
const channels = await ibcClient.ibc.core.channel.v1.channels()

Composing Messages

Import the mainchain object from @unification-com/fundjs.

import { mainchain } from '@unification-com/fundjs';

const {
  createStream,
  claimStream,
  topUpDeposit,
  updateFlowRate,
  cancelStream
} = unification.stream.v1.MessageComposer.withTypeUrl;

IBC Messages

import { ibc } from '@unification-com/fundjs';

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

Cosmos Messages

import { cosmos } from '@unification-com/fundjs';

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.

Initializing the Stargate Client

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

import { getSigningMainchainClient } from '@unification-com/fundjs';

const stargateMcClient = await getSigningMainchainClient({
  rpcEndpoint,
  signer // OfflineSigner
});

Cosmos and IBC will require their own signing clients, which contain their respective proto/amino messages

import { getSigningIbcClient, getSigningCosmosClient } from '@unification-com/fundjs';

const stargateIbcClient = await getSigningIbcClient({
  rpcEndpoint,
  signer // OfflineSigner
});

const stargateCosmosClient = await getSigningCosmosClient({
  rpcEndpoint,
  signer // OfflineSigner
});

Creating Signers

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

• cosmos-kit (recommended)
• keplr
• cosmjs

Amino Signer

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

import { getOfflineSignerAmino as getOfflineSigner } from 'cosmjs-utils';

Proto Signer

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.

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 === 'unification');
  const signer = await getOfflineSigner({
    mnemonic,
    chain
  });

Broadcasting Messages

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

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

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

const fee: StdFee = {
    amount: [
    {
        denom: 'coin',
        amount: '864'
    }
    ],
    gas: '86364'
};

// we need to use the Cosmos client to correctly encode & sign
const response = await stargateCosmosClient.signAndBroadcast(address, [msg], fee);

Advanced Usage

If you want to manually construct a stargate client

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

import { 
    cosmosAminoConverters,
    cosmosProtoRegistry,
    ibcProtoRegistry,
    ibcAminoConverters,
    mainchainAminoConverters,
    mainchainProtoRegistry
} from '@unification-com/fundjs';

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

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

const aminoConverters = {
    ...cosmosAminoConverters,
    ...ibcAminoConverters,
    ...mainchainAminoConverters
};

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:

git submodule init
git submodule update
yarn
yarn build

Codegen

Look inside of scripts/codegen.ts and configure the settings for bundling your SDK and contracts into @unification-com/fundjs:

yarn codegen

Publishing

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/<your-telescope-module>
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.