npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@starport/client-js

v0.1.58

Published

A generic JS client for the Websocket, high-level (Cosmos) and low-level (Tendermint) APIs

Downloads

18

Readme

@starport/client-js

This package implements a generic JS client wrapper for the Tendermint RPC, Tendermint WebSocket, and Cosmos SDK APIs.

Install

npm install client-js

Usage

import Client from '@starport/client-js'

const client = new Client({
                  apiAddr: 'http://localhost:1317',        // Replace with Cosmos API node address
                  rpcAddr: 'http://localhost:26657',       // Replace with Tendermint RPC node address
                  wsAddr: 'ws://localhost:26657/websocket' // Replace with Tendermint WS node address
                });

The client implements EventEmitter, runs a periodic connectivity test, and emits the following events based on the connection state:

  • 'api-status' : true/false
  • 'rpc-status' : true/false
  • 'ws-status' : true/false

You can listen for and handle those events in your app in the standard way:

client.on('api-status', (status) => { 
  // Handle API status here
});
client.on('rpc-status', (status) => { 
  // Handle RPC status here
});
client.on('ws-status', (status) => { 
  // Handle WS status here
});

The client also provides methods to switch the nodes used in an existing instance:

client.switchAPI('<new_api_node_address>');
client.switchRPC('<new_rpc_node_address>');
client.switchWS('<new_ws_node_address>');

The client automatically subscribes to new block events and emits the events for handling:

client.on('newblock',(block) => {
  //handle incoming block here
})

Additional features

The client provides a useSigner() method to connect a signer or wallet using the CosmJS OfflineDirectSigner interface.

To access the resulting CosmJS signing client, use the .signingClient property. To access the signer, use the .signer property.

Using the client .switchRPC() method reinstantiates the signing client appropriately.

const signer = await DirectSecp256k1HdWallet.fromMnemonic(mymnemonic) // or any other object implementing the OfflineDirectSigner interface

await client.useSigner(signer)

const [account] = await client.signer.getAccounts();

const recipient = "cosmos1xv9tklw7d82sezh9haa573wufgy59vmwe6xxe5";

const amount = {
  denom: "uatom",
  amount: "1",
};

const result = await client.signingClient.sendTokens(account.address, recipient, [amount], "Memo Message");

Finally, the client provides two querying methods for the Cosmos SDK API:

query()

.query(endpoint,queryparams)

A basic wrapper around Axios. For example, to query the bank module for an address's balances:

let balances = await client.query('/cosmos/bank/v1beta1/balances/','cosmos1xv9tklw7d82sezh9haa573wufgy59vmwe6xxe5');

request()

.request({
    body: body,
    path: path,
    query: query,
    method: method,
  })

This helper method is compatible with the swagger-typescript-api API classes that are generated with --single-http-client by using their Swagger definitions if the generated API classes exist for your chain endpoints.