LaconicNetwork/cosmjs-util
7
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Add doc comment to LcdClient

Browse Source
This commit is contained in:
Simon Warta 2020-07-07 07:52:16 +02:00
parent e6ac24a301
commit 375d30ee52
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
packages/sdk38/src/lcdclient.ts
View File

@ -52,6 +52,18 @@ function parseAxiosError(err: AxiosError): never {
}
}
/**
* A client to the LCD's (light client daemon) API.
* This light client connects to Tendermint (i.e. the chain), encodes/decodes Amino data for us and provides a convenient JSON interface.
*
* This _JSON over HTTP_ API is sometimes referred to as "REST" or "RPC", which are both misleading terms
* for the same thing.
*
* Please note that the client to the LCD can not verify light client proofs. When using this,
* you need to trust the API provider as well as the network connection between client and API.
*
* @see https://cosmos.network/rpc
*/
export class LcdClient {
/** Constructs an LCD client with 0 modules */
public static withModules(options: LcdClientBaseOptions): LcdClient;

12
packages/sdk38/types/lcdclient.d.ts vendored
View File

@ -18,6 +18,18 @@ export interface LcdClientBaseOptions {
readonly apiUrl: string;
readonly broadcastMode?: BroadcastMode;
}
/**
* A client to the LCD's (light client daemon) API.
* This light client connects to Tendermint (i.e. the chain), encodes/decodes Amino data for us and provides a convenient JSON interface.
*
* This _JSON over HTTP_ API is sometimes referred to as "REST" or "RPC", which are both misleading terms
* for the same thing.
*
* Please note that the client to the LCD can not verify light client proofs. When using this,
* you need to trust the API provider as well as the network connection between client and API.
*
* @see https://cosmos.network/rpc
*/
export declare class LcdClient {
/** Constructs an LCD client with 0 modules */
static withModules(options: LcdClientBaseOptions): LcdClient;