@starport/client-js
Advanced tools
Comparing version 0.1.36 to 0.1.37
{ | ||
"name": "@starport/client-js", | ||
"version": "0.1.36", | ||
"version": "0.1.37", | ||
"description": "A generic JS client for the Websocket, high-level (Cosmos) and low-level (Tendermint) APIs", | ||
@@ -49,3 +49,4 @@ "author": "Tendermint, Inc <hello@tendermint.com>", | ||
"reconnecting-websocket": "^4.4.0" | ||
} | ||
}, | ||
"gitHead": "c7ad5edd391a9884d29991db27a6c49509ba872d" | ||
} |
# `@starport/client-js` | ||
Implements a generic JS client wrapper for the Tendermint RPC, Tendermint WS and Cosmos REST APIs. | ||
This package implements a generic JS client wrapper for the Tendermint RPC, Tendermint WebSocket, and Cosmos SDK APIs. | ||
@@ -23,3 +23,3 @@ ## Install | ||
The client implements EventEmitter and runs a periodic connectivity test so will emit the following events based on the connection state: | ||
The client implements EventEmitter, runs a periodic connectivity test, and emits the following events based on the connection state: | ||
@@ -30,3 +30,3 @@ * 'api-status' : true/false | ||
You can listen for and handle those in your application in the standard way: | ||
You can listen for and handle those events in your app in the standard way: | ||
@@ -53,3 +53,3 @@ ``` | ||
The client automatically subscribes to new block events and emits those for handling: | ||
The client automatically subscribes to new block events and emits the events for handling: | ||
@@ -64,7 +64,7 @@ ``` | ||
Client provides a `useSigner()` method to connect a signer/wallet implementing the CosmJS OfflineDirectSigner interface (https://cosmos.github.io/cosmjs/latest/proto-signing/interfaces/signer.offlinedirectsigner.html). | ||
The client provides a `useSigner()` method to connect a signer or wallet using the [CosmJS OfflineDirectSigner interface](https://cosmos.github.io/cosmjs/latest/proto-signing/interfaces/signer.offlinedirectsigner.html). | ||
The resulting CosmJS signing client (https://cosmos.github.io/cosmjs/latest/stargate/classes/signingstargateclient.signingstargateclient-1.html) is accessible via the `.signingClient` property while the signer is accessible via the `.signer` property. | ||
To access the resulting [CosmJS signing client](https://cosmos.github.io/cosmjs/latest/stargate/classes/signingstargateclient.signingstargateclient-1.html), use the `.signingClient` property. To access the signer, use the `.signer` property. | ||
Using the client's `.switchRPC()` method mentioned above will reinstantiate the signing client appropriately. | ||
Using the client `.switchRPC()` method reinstantiates the signing client appropriately. | ||
@@ -88,3 +88,3 @@ ``` | ||
Finally, the client provides two querying methods for the cosmos API: | ||
Finally, the client provides two querying methods for the Cosmos SDK API: | ||
@@ -95,3 +95,3 @@ ### query() | ||
A VERY basic wrapper around axios, so querying the bank module for an address's balances would be: | ||
A basic wrapper around Axios. For example, to query the bank module for an address's balances: | ||
@@ -112,2 +112,2 @@ ``` | ||
A helper method compatible with the swagger-typescript-api API classes generated with the `--single-http-client` if you have generated API classes for your chain's endpoints via their swagger definitions. | ||
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. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
56055
107