2.0.1 • Published 10 months ago

kiijs-sdk v2.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Getting Started

kiijs is a library written in TypeScript used for interacting with kiichain. The library provides classes and methods to conveniently send transactions, query data, and wallet management. The library is implemented based on gRPC-web protocol which sends HTTP/1.5 or HTTP/2 requests to a gRPC proxy server, before serving them as HTTP/2 to gRPC server.

The library support both Node.js and browsers.

Installation

Install with npm

npm install kiijs

Install with yarn

yarn add kiijs

Getting Started

Below is a simple example for querying an account's balances:

import {KiiStargateQueryClient} from "../kiijs/client";

async function main() {

  // connect to Kiichain test network using rpc
  const rpcEndpoint = "https://a.testnet.kiivalidator.com:26658/";
  const client = await KiiStargateQueryClient.connect(
    rpcEndpoint
  );
  
  // show all coin balances
  const address = "kii1s0jekzmfy3ejmf75lh0xfc2zl3958lfk8gqtws";
  const balance = await client.getAllBalances(address);
  console.log('balance', balance);
}

Documentation

The full documentation can be found here.

Examples

Under the example directory, you can find examples of basic ledger interactions using kiijs, such as transferring tokens, staking, and deploying.

Contributing

All contributions are very welcome! Remember, contribution is not only PRs and code, but any help with docs or helping other developers solve their issues are very appreciated!

Read below to learn how you can take part in the KiiJS-SDK project.

Code of Conduct

Please be sure to read and follow our Code of Conduct. By participating, you are expected to uphold this code.

Contribution Guidelines

Read our contribution guidelines to learn about our issue and pull request submission processes, coding rules, and more.

Development Guidelines

Read our development guidelines to learn about the development processes and workflows.

Issues, Questions and Discussions

We use GitHub Issues for tracking requests and bugs, and GitHub Discussions for general questions and discussion.