README.md

@sei-js/core

A library for Sei written in Typescript.

Installation

yarn add @sei-js/core or npm install @sei-js/core

Modules

Module	Link
Wallet	learn more
Client	learn more

Wallet

import { connect, SUPPORTED_WALLETS } from '@sei-js/core/wallet

Property	Type	Description
connect()	(walletKey: string) => { accounts, offlineSigner}	Async function to connect to input wallet
SUPPORTED_WALLETS	string[]	A list of currently supported wallets which can be passed to connect()
getChainSuggest	(chainId?: string, restUrl?: string, rpcUrl?: string) -> object	A pre defined object to be passed to a wallets experimentalChainSuggest function. Takes optional parameters for chainId, restUrl, and rpcUrl.

Client

Query Client

The query client is used to query data from modules via REST endpoints.

import { QueryClient } from '@sei-js/core';

const queryClient = await QueryClient.getQueryClient(rpcEndpoint);

// Getting the market summary from the Sei dex module
queryClient.seiprotocol.seichain.dex.getMarketSummary(params)

// Getting user balances from the Cosmos bank module
queryClient.cosmos.bank.v1beta1.allBalances({ address})

Signing Client

The signing client provides a way to sign and broadcast transactions on Sei.

Use getSigningClient to get your SigningStargateClient, with the Sei proto/amino messages loaded in.

import { SigningClient } from '@sei-js/core';

const client = await SigningClient.getSigningClient({
  rpcEndpoint,
  signer // OfflineSigner
});

Example

import { SigningClient  } from '@sei-js/core';
import { DirectSecp256k1HdWallet } from '@sei-js/proto/node_modules/@cosmjs/proto-signing';
import {
    calculateFee,
    GasPrice,
    coin
  } from "@sei-js/proto/node_modules/@cosmjs/stargate";

(async () => {
    // Setup wallet
    const wallet = await DirectSecp256k1HdWallet.fromMnemonic("your mnemonic", {
        prefix: "sei",
    })

    const [{ address: signerAddress }] = await wallet.getAccounts();

    // Network config
    const rpcEndpoint = "https://sei-chain-incentivized.com/sei-chain-tm/";
    
    // Setup client
    const client = await SigningClient.getSigningClient(rpcEndpoint, wallet);

    // Setup fee
    const gasPrice = GasPrice.fromString("0.025usei"); 
    const executeFee = calculateFee(200_000, gasPrice);

    // Send some token
    const result = await client.sendTokens(signerAddress, signerAddress, [coin("1000","usei")], executeFee)
    console.log(result)
   
    // Sign and broadcast custom message
    const msg = {
        typeUrl: "/seiprotocol.seichain.....", //need custom your typeUrl on seiprotocol and body
        value: {
        //    your body msg
        }
    }

    const otherResult = await client.signAndBroadcast(signerAddress, [msg], executeFee)
    console.log(otherResult)
})()

Related packages

@sei-js/react - A react helper library for common @sei-js/core functions

@sei-js/proto - TypeScript library for Sei protobufs generated using Telescope