@initia/initia.js 0.2.18 → 0.2.20

package/README.md

@@ -4,7 +4,7 @@ Initia.js is a TypeScript-written JavaScript SDK tailored for the Initia blockch
 ## Main Features
 - **Improved TypeScript Definitions**: Offers comprehensive integration with Initia core data structures for an enhanced developer experience.
 - **Core Layer**: Includes key management, BCS serialization, and support for initia.proto.
-- **Client Layer**: Facilitates API request generation and LCD provider interaction.
+- **Client Layer**: Facilitates API request generation and REST provider interaction.
 
 
 ## Installation
@@ -19,15 +19,15 @@ npm install @initia/initia.js
 
 The usage section of this document provides detailed explanations and code examples of the most commonly used classes of the Initia.js library, which can be utilized both in a Node.js environment and within a browser.
 
-### LCD client 
+### REST client 
 
-**LCD**(Light Client Daemon) class facilitates interaction with the Initia blockchain.
+**REST**(previously LCD) class facilitates interaction with the Initia blockchain.
 
 ```typescript
-import { LCDClient } from '@initia/initia.js';
+import { RESTClient } from '@initia/initia.js';
 
-const lcd = new LCDClient('https://lcd.mahalo-1.initia.xyz', {
-    chainId: 'mahalo-1',
+const rest = new RESTClient('https://rest.testnet.initia.xyz', {
+    chainId: 'initiation-2',
     gasPrices: '0.15uinit', // default gas prices
     gasAdjustment: '1.75',  // default gas adjustment for fee estimation
 });
@@ -159,20 +159,20 @@ const msg = new MsgExecute(
 Create a wallet and sign transaction.  
 
 ```typescript
-import { Wallet, LCDClient, MnemonicKey } from '@initia/initia.js';
+import { Wallet, RESTClient, MnemonicKey } from '@initia/initia.js';
 
 const key = new MnemonicKey({
     mnemonic: 
         'moral wise tape glance grit gentle movie doll omit you pet soon enter year funny gauge digital supply cereal city ring egg repair coyote',
 });
 
-const lcd = new LCDClient('https://lcd.mahalo-1.initia.xyz', {
-    chainId: 'mahalo-1',
+const rest = new RESTClient('https://rest.testnet.initia.xyz', {
+    chainId: 'initiation-2',
     gasPrices: '0.15uinit', // default gas prices
     gasAdjustment: '1.75',  // default gas adjustment for fee estimation
 });
 
-const wallet = new Wallet(lcd, key);
+const wallet = new Wallet(rest, key);
 
 const sendMsg = new MsgSend(
     'init14l3c2vxrdvu6y0sqykppey930s4kufsvt97aeu',   // sender address
@@ -193,7 +193,7 @@ When sending coins with `MsgSend`, sender address should be same with wallet add
 `broadcast()` is the action that sends your transaction to the blockchain code.
 
 ```typescript
-const broadcastResult = await lcd.tx.broadcast(signedTx);
+const broadcastResult = await rest.tx.broadcast(signedTx);
 ```
 
 ### Queries 
@@ -203,7 +203,7 @@ const broadcastResult = await lcd.tx.broadcast(signedTx);
 Query the balance of the account.
 
 ```typescript
-const balances = await lcd.bank.balance('init14l3c2vxrdvu6y0sqykppey930s4kufsvt97aeu');
+const balances = await rest.bank.balance('init14l3c2vxrdvu6y0sqykppey930s4kufsvt97aeu');
 ```
 
 * `viewfunction()`
@@ -211,7 +211,7 @@ const balances = await lcd.bank.balance('init14l3c2vxrdvu6y0sqykppey930s4kufsvt9
 Obtain the return values of a Move view function.
 
 ```typescript
-const res = await lcd.move.viewFunction(
+const res = await rest.move.viewFunction(
     '0x1',                                         // owner of the module
     'dex',                                         // name of the module
     'get_swap_simulation',                         // function name

package/dist/client/LocalInitia.d.ts

@@ -1,6 +1,6 @@
-import { LCDClient } from './lcd/LCDClient';
-import { Wallet } from './lcd/Wallet';
-export declare class LocalInitia extends LCDClient {
+import { RESTClient } from './rest/RESTClient';
+import { Wallet } from './rest/Wallet';
+export declare class LocalInitia extends RESTClient {
     wallets: {
         validator: Wallet;
         test1: Wallet;

package/dist/client/index.d.ts

@@ -1,6 +1,6 @@
-export * from './lcd/APIRequester';
-export * from './lcd/LCDClient';
-export * from './lcd/Wallet';
-export * from './lcd/api';
+export * from './rest/APIRequester';
+export * from './rest/RESTClient';
+export * from './rest/Wallet';
+export * from './rest/api';
 export * from './LocalInitia';
 export * from './WebSocketClient';

package/dist/client/{lcd/LCDClient.d.ts → rest/RESTClient.d.ts}

@@ -3,14 +3,14 @@ import { AuctionAPI, AuthAPI, AuthzAPI, BankAPI, DistributionAPI, EvidenceAPI, E
 import { Wallet } from './Wallet';
 import { Coins } from '../../core';
 import { Key } from '../../key';
-export interface LCDClientConfig {
+export interface RESTClientConfig {
     chainId?: string;
     gasPrices?: Coins.Input;
     gasAdjustment?: string;
 }
-export declare class LCDClient {
+export declare class RESTClient {
     URL: string;
-    config: LCDClientConfig;
+    config: RESTClientConfig;
     apiRequester: APIRequester;
     auction: AuctionAPI;
     auth: AuthAPI;
@@ -42,6 +42,8 @@ export declare class LCDClient {
     tx: TxAPI;
     upgrade: UpgradeAPI;
     wasm: WasmAPI;
-    constructor(URL: string, config?: LCDClientConfig, apiRequester?: APIRequester);
+    constructor(URL: string, config?: RESTClientConfig, apiRequester?: APIRequester);
     wallet(key: Key): Wallet;
 }
+export declare class LCDClient extends RESTClient {
+}

package/dist/client/{lcd → rest}/Wallet.d.ts

@@ -1,13 +1,13 @@
-import { LCDClient } from './LCDClient';
+import { RESTClient } from './RESTClient';
 import { Key } from '../../key';
-import { CreateTxOptions } from '../lcd/api/TxAPI';
+import { CreateTxOptions } from './api/TxAPI';
 import { Tx } from '../../core';
 import { SignMode } from '@initia/initia.proto/cosmos/tx/signing/v1beta1/signing';
 export declare class Wallet {
-    lcd: LCDClient;
+    rest: RESTClient;
     key: Key;
     private accAddress;
-    constructor(lcd: LCDClient, key: Key);
+    constructor(rest: RESTClient, key: Key);
     setAccountAddress(accAddress: string): void;
     accountNumberAndSequence(): Promise<{
         account_number: number;

package/dist/client/{lcd → rest}/api/TxAPI.d.ts

@@ -1,6 +1,6 @@
 import { BaseAPI } from './BaseAPI';
 import { Msg, Tx, Coins, TxInfo, Fee, PublicKey, TxLog, Event } from '../../../core';
-import { LCDClient } from '../LCDClient';
+import { RESTClient } from '../RESTClient';
 import { APIParams, Pagination, PaginationOptions } from '../APIRequester';
 interface Wait {
     height: number;
@@ -162,8 +162,8 @@ export interface TxSearchOptions extends PaginationOptions {
     query: TxSearchQuery[];
 }
 export declare class TxAPI extends BaseAPI {
-    lcd: LCDClient;
-    constructor(lcd: LCDClient);
+    rest: RESTClient;
+    constructor(rest: RESTClient);
     txInfo(txHash: string, params?: APIParams): Promise<TxInfo>;
     create(signers: SignerOptions[], options: CreateTxOptions): Promise<Tx>;
     txInfosByHeight(height: number | undefined): Promise<TxInfo[]>;

package/dist/core/tx/Tx.d.ts

@@ -6,7 +6,7 @@ import { CompactBitArray } from './CompactBitArray';
 import { Msg } from '../Msg';
 import { Fee } from './Fee';
 import { SignatureV2 } from './SignatureV2';
-import { SignerData } from '../../client/lcd/api/TxAPI';
+import { SignerData } from '../../client';
 export declare class Tx {
     body: TxBody;
     auth_info: AuthInfo;