@ixo/ixo-multiclient-sdk

ixo-MultiClient-SDK

One ixo client to rule them all, One ixo client to find, One ixo client to bring them all, and in impact bind them

install

npm install ixo-multiclient-sdk

yarn add  ixo-multiclient-sdk

Table of contents

• ixo-MultiClient-SDK
  • install
  • Table of contents
  • Usage
    • RPC Clients
    • Composing Messages
      • IBC Messages
      • Cosmos Messages
  • Connecting with Wallets and Signing Messages
    • Initializing the Stargate Client
    • Proto Signer
    • Broadcasting Messages
  • Advanced Usage
  • Developing
    • Codegen
    • Publishing
  • Credits
  • Disclaimer

Usage

RPC Clients

import { ixo } from "ixo-multiclient-sdk";

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

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

// you can also query the ixo modules
const balances = await client.ixo.exchange.v1beta1.exchangeBalances();

Composing Messages

Import the ixo object from ixo.

import { ixo } from "ixo-multiclient-sdk";

const { createSpotLimitOrder, createSpotMarketOrder, deposit } =
  ixo.exchange.v1beta1.MessageComposer.withTypeUrl;

Because of the current structure of ixo's blockchain, we had to modify the telescope generation of ts files, thus the above example wont work. For the ixo namespace please define message using the types from the namespace itself and not from the MessageComposer, eg:

import { ixo } from "ixo-multiclient-sdk";

const message = {
  typeUrl: "/iid.MsgCreateIidDocument",
  value: ixo.iid.MsgCreateIidDocument.fromPartial({
    id: did,
    verifications: [
      ixo.iid.Verification.fromPartial({
        relationships: ["authentication"],
        method: ixo.iid.VerificationMethod.fromPartial({
          id: did,
          type: "EcdsaSecp256k1VerificationKey2019",
          publicKeyMultibase: "F" + toHex(pubkey),
          controller: controller,
        }),
      }),
    ],
    signer: address,
    controllers: [did],
  }),
};

Please have a look at the tests folder to see examples of all the messages and how to format!

IBC Messages

import { ibc } from "ixo-multiclient-sdk";

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

Cosmos Messages

import { cosmos } from "ixo-multiclient-sdk";

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


## Connecting with Wallets and Signing Messages

⚡️ For web interfaces, we recommend using [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit). Continue below to see how to manually construct signers and clients.

Here are the docs on [creating signers](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react#signing-clients) in cosmos-kit that can be used with Keplr and other wallets.

### Initializing the Stargate Client

Use `getSigningixoClient` 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 { getSigningixoClient } from "ixo-multiclient-sdk";

const stargateClient = await getSigningixoClient({
  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";

Please note that the custom signing client exported and creatable under createClient only support Direct Proto signing through the rpc endpoint!!

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 === "ixo");
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: "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 create a stargate client, please use the function createClient that is exported from package as it will create a stargate client for you with all the needed registries included and ed key signing capabilities, please note taht only direct signing is supported and not amino signing, so pass in a OfflineDirectSigner when createing client.

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,
    cosmwasmAminoConverters,
    cosmwasmProtoRegistry,
    ibcProtoRegistry,
    ibcAminoConverters,
    ixoAminoConverters,
    ixoProtoRegistry
} from 'ixo';

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

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

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

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

Codegen

Contract schemas live in ./contracts, and protos in ./proto. Look inside of scripts/codegen.js and configure the settings for bundling your SDK and contracts into ixo-multiclient-sdk:

yarn codegen

Publishing

Build the types and then publish:

yarn build:ts
yarn publish

Credits

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

Code built with the help of these related projects:

• @cosmwasm/ts-codegen for generated CosmWasm contract Typescript classes
• @osmonauts/telescope a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
• cosmos-kit A wallet connector for the Cosmos ⚛️

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 or software using the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.