@!tach!/sgejs

SgeJS

SgeJS makes it easy to compose and broadcast Sge and Cosmos messages, with all of the proto encoding handled for you.

install

npm install sge

Table of contents

• sge
  • Install
  • Table of contents
• Usage
  • RPC Clients
  • Composing Messages
  • Cosmos
• Wallets and Signers
  • Creating Signers
  • Broadcasting Messages
• Credits

Usage

RPC Clients

import { sgenetwork } from '@!tach!/sgejs';

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

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

// you can also query the sge modules
const balances = await client.sge.market
    .market({ uid: '2d55a893-163f-41a7-b71f-837912b7b1e9' })

Composing Messages

Import the sge object from sge.

import { sgenetwork } from '@!tach!/sgejs';

const {
    betsByUIDs, /** Queries a list of Bet items filtered by uid list. */
    betsByCreator, /** Queries list of Bet items of a certain creator sorted by timestamp. */
    pendingBets /** Queries list of pending Bet items. */
} = sge.bet;

Cosmos Messages

import { cosmos } from '@!tach!/sgejs';

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

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

const {
    deposit,
} = 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.

Creating Signers

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

• cosmos-kit (recommended)
• keplr
• cosmjs

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 === 'sge-network');
  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);

Credits

Code built with the help of these related projects:

• @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.