carbon-js-sdk 0.11.13 → 0.11.14-beta.2

package/README.md

@@ -1,85 +1,85 @@
-### Carbon Typescript SDK ###
-
-# Get Started
-
-Try out the [examples](./examples/). The project has to be built before you can start running the examples
-
-```bash
-
-# install ts-node, typescript
-npm i -g ts-node typescript
-
-# install local dependencies
-yarn
-
-# build the SDK
-yarn build
-
-# run connect SDK example
-ts-node examples/connect_sdk
-
-```
-
-## Initializing CarbonSDK
-
-```typescript
-
-  const sdk = await CarbonSDK.instance({
-    network: CarbonSDK.Network.LocalHost,
-
-    // optionally provide a set of network configuration overrides
-    // to overwrite default parameters for a selected network.
-    config: {
-      tmRpcUrl: TRPC_ENDPOINT,
-    },
-  });
-
-  // connect SDK with mnemonic
-  const sdk1 = await sdk.connectWithMnemonic(mnemonics);
-
-  // connect SDK with private key
-  const sdk2 = await sdk.connectWithPrivateKey(privateKey);
-
-  // connect SDK with custom signer (ideal for ledger/ext wallet implementation)
-  // see `CarbonSigner` for more information
-  const sdk3 = await sdk.connectWithSigner(signer, bech32Address);
-
-```
-
-# Updating protobuf codecs
-
-Protobuf type definitions are generated automatically and should not be manually modified (i.e. every file in `src/codec` should not be manually edited).
-Runs the scripts [update-proto.sh](./scripts/update-proto.sh) followed by [generate-registry.sh](./scripts/generate-registry.sh)
-
-This assumes that a packaged `./proto-ts.tar.gz` is available in the project directory. Download it from Carbon chain repo if it is not available.
-
-```bash
-  yarn run sync-proto
-```
-
-To generate the tar ball on Carbon chain project:
-
-Install `buf` if you have not:
-```bash
-  # https://docs.buf.build/installation
-  brew tap bufbuild/buf
-  brew install buf
-```
-
-Run script to generate codec:
-```bash
-  make gen-codecs
-```
-
-The tar file will be generated at `<Carbon Project>/gen/proto-ts.tar.gz`. You can copy that file to `<Carbon SDK Project>/proto-ts.tar.gz` and proceed with above `sync-proto` step.
-
-Or run this in this project directory
-```bash
-# runs `cp ~/go/src/github.com/Switcheo/carbon/gen/proto-ts.tar.gz .`
-yarn run cp-proto
-```
-
-Eventually the `proto-ts.tar.gz` will be packaged as a release file in `Carbon` repository. A script will be added automatically download the latest released codecs and update the SDK.
-
-# Contributing to Carbon SDK
-{wip}
+### Carbon Typescript SDK ###
+
+# Get Started
+
+Try out the [examples](./examples/). The project has to be built before you can start running the examples
+
+```bash
+
+# install ts-node, typescript
+npm i -g ts-node typescript
+
+# install local dependencies
+yarn
+
+# build the SDK
+yarn build
+
+# run connect SDK example
+ts-node examples/connect_sdk
+
+```
+
+## Initializing CarbonSDK
+
+```typescript
+
+  const sdk = await CarbonSDK.instance({
+    network: CarbonSDK.Network.LocalHost,
+
+    // optionally provide a set of network configuration overrides
+    // to overwrite default parameters for a selected network.
+    config: {
+      tmRpcUrl: TRPC_ENDPOINT,
+    },
+  });
+
+  // connect SDK with mnemonic
+  const sdk1 = await sdk.connectWithMnemonic(mnemonics);
+
+  // connect SDK with private key
+  const sdk2 = await sdk.connectWithPrivateKey(privateKey);
+
+  // connect SDK with custom signer (ideal for ledger/ext wallet implementation)
+  // see `CarbonSigner` for more information
+  const sdk3 = await sdk.connectWithSigner(signer, bech32Address);
+
+```
+
+# Updating protobuf codecs
+
+Protobuf type definitions are generated automatically and should not be manually modified (i.e. every file in `src/codec` should not be manually edited).
+Runs the scripts [update-proto.sh](./scripts/update-proto.sh) followed by [generate-registry.sh](./scripts/generate-registry.sh)
+
+This assumes that a packaged `./proto-ts.tar.gz` is available in the project directory. Download it from Carbon chain repo if it is not available.
+
+```bash
+  yarn run sync-proto
+```
+
+To generate the tar ball on Carbon chain project:
+
+Install `buf` if you have not:
+```bash
+  # https://docs.buf.build/installation
+  brew tap bufbuild/buf
+  brew install buf
+```
+
+Run script to generate codec:
+```bash
+  make gen-codecs
+```
+
+The tar file will be generated at `<Carbon Project>/gen/proto-ts.tar.gz`. You can copy that file to `<Carbon SDK Project>/proto-ts.tar.gz` and proceed with above `sync-proto` step.
+
+Or run this in this project directory
+```bash
+# runs `cp ~/go/src/github.com/Switcheo/carbon/gen/proto-ts.tar.gz .`
+yarn run cp-proto
+```
+
+Eventually the `proto-ts.tar.gz` will be packaged as a release file in `Carbon` repository. A script will be added automatically download the latest released codecs and update the SDK.
+
+# Contributing to Carbon SDK
+{wip}

package/lib/CarbonSDK.d.ts

@@ -1,154 +1,157 @@
-/// <reference types="node" />
-import { Network, NetworkConfig, Network as _Network } from "./constant";
-import { Tendermint37Client } from "@cosmjs/tendermint-rpc";
-import * as clients from "./clients";
-import { CarbonQueryClient, ETHClient, HydrogenClient, InsightsQueryClient, NEOClient, TokenClient, ZILClient } from "./clients";
-import GasFee from "./clients/GasFee";
-import GrpcQueryClient from "./clients/GrpcQueryClient";
-import N3Client from "./clients/N3Client";
-import { AdminModule, AllianceModule, BankModule, BrokerModule, CDPModule, CoinModule, ERC20Module, EvmMergeModule, EvmModule, FeeModule, GovModule, IBCModule, LeverageModule, LiquidityPoolModule, MarketModule, OracleModule, OrderModule, PerpspoolModule, PositionModule, ProfileModule, SubAccountModule, XChainModule } from "./modules";
-import { GrantModule } from "./modules/grant";
-import { StakingModule } from "./modules/staking";
-import { CosmosLedger, Keplr, LeapExtended } from "./provider";
-import { MetaMask } from "./provider/metamask/MetaMask";
-import { CarbonSigner, CarbonWallet, CarbonWalletGenericOpts, MetaMaskWalletOpts } from "./wallet";
-export { CarbonTx } from "./util";
-export { CarbonSigner, CarbonSignerTypes, CarbonWallet, CarbonWalletGenericOpts, CarbonWalletInitOpts } from "./wallet";
-export * as Carbon from "./codec/carbon-models";
-export interface CarbonSDKOpts {
-    network: Network;
-    tmClient: Tendermint37Client;
-    wallet?: CarbonWallet;
-    chainId?: string;
-    evmChainId?: string;
-    token?: TokenClient;
-    query?: CarbonQueryClient;
-    hydrogen?: HydrogenClient;
-    insights?: InsightsQueryClient;
-    config?: Partial<NetworkConfig>;
-    grpcQueryClient?: GrpcQueryClient;
-    useTmAbciQuery?: boolean;
-    defaultTimeoutBlocks?: number;
-    gasFee?: GasFee;
-}
-export interface CarbonSDKInitOpts {
-    network: Network;
-    tmClient?: Tendermint37Client;
-    config?: Partial<NetworkConfig>;
-    wallet?: CarbonWallet;
-    skipInit?: boolean;
-    defaultTimeoutBlocks?: number;
-    /**
-     * temporary flag to disable GRPC Query client service when required
-     * TODO: Deprecate when grpc query client is implemented across all networks
-     */
-    useTmAbciQuery?: boolean;
-}
-export interface OverrideConfig {
-    chainId: string;
-    evmChainId: string;
-}
-/**
- * Carbon SDK
- *
- *
- */
-declare class CarbonSDK {
-    static DEFAULT_NETWORK: Network;
-    static DenomPrefix: {
-        LPToken: string;
-        CDPToken: string;
-    };
-    readonly query: CarbonQueryClient;
-    readonly useTmAbciQuery: boolean;
-    insights: InsightsQueryClient;
-    hydrogen: HydrogenClient;
-    wallet?: CarbonWallet;
-    gasFee?: GasFee;
-    network: Network;
-    configOverride: Partial<NetworkConfig>;
-    networkConfig: NetworkConfig;
-    tmClient: Tendermint37Client;
-    token: TokenClient;
-    admin: AdminModule;
-    alliance: AllianceModule;
-    order: OrderModule;
-    lp: LiquidityPoolModule;
-    erc20: ERC20Module;
-    perpspool: PerpspoolModule;
-    grant: GrantModule;
-    subaccount: SubAccountModule;
-    profile: ProfileModule;
-    cdp: CDPModule;
-    leverage: LeverageModule;
-    market: MarketModule;
-    broker: BrokerModule;
-    position: PositionModule;
-    coin: CoinModule;
-    oracle: OracleModule;
-    gov: GovModule;
-    staking: StakingModule;
-    bank: BankModule;
-    fee: FeeModule;
-    ibc: IBCModule;
-    xchain: XChainModule;
-    evm: EvmModule;
-    evmmerge: EvmMergeModule;
-    neo: NEOClient;
-    eth: ETHClient;
-    bsc: ETHClient;
-    arbitrum: ETHClient;
-    polygon: ETHClient;
-    okc: ETHClient;
-    zil: ZILClient;
-    n3: N3Client;
-    chainId: string;
-    evmChainId: string;
-    constructor(opts: CarbonSDKOpts);
-    static instance(opts?: CarbonSDKInitOpts): Promise<CarbonSDK>;
-    static instanceWithWallet(wallet: CarbonWallet, sdkOpts?: CarbonSDKInitOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithPrivateKey(privateKey: string | Buffer, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithMnemonic(mnemonic: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithSigner(signer: CarbonSigner, publicKeyBase64: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithLedger(ledger: CosmosLedger, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithKeplr(keplr: Keplr, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithLeap(leap: LeapExtended, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    static instanceWithMetamask(metamask: MetaMask, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts, metamaskWalletOpts?: MetaMaskWalletOpts): Promise<ConnectedCarbonSDK>;
-    static instanceViewOnly(bech32Address: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    initialize(): Promise<CarbonSDK>;
-    getGasFee(): Promise<GasFee>;
-    clone(): CarbonSDK;
-    generateOpts(): CarbonSDKOpts;
-    connect(wallet: CarbonWallet): Promise<ConnectedCarbonSDK>;
-    disconnect(): CarbonSDK;
-    connectWithPrivateKey(privateKey: string | Buffer, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithMnemonic(mnemonic: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithSigner(signer: CarbonSigner, publicKeyBase64: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithLedger(ledger: CosmosLedger, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithKeplr(keplr: Keplr, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithLeap(leap: LeapExtended, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    connectWithMetamask(metamask: MetaMask, opts?: CarbonWalletGenericOpts, metamaskWalletOpts?: MetaMaskWalletOpts): Promise<ConnectedCarbonSDK>;
-    connectViewOnly(bech32Address: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
-    getConfig(): NetworkConfig;
-    getTokenClient(): TokenClient;
-    getConnectedWallet(): CarbonWallet;
-    log(...args: any[]): void;
-    private checkWallet;
-    static parseNetwork: (network: string, defaultNetwork?: Network | null) => Network | null;
-}
-export declare class ConnectedCarbonSDK extends CarbonSDK {
-    wallet: CarbonWallet;
-    constructor(wallet: CarbonWallet, opts: CarbonSDKOpts);
-    clone(): ConnectedCarbonSDK;
-}
-declare namespace CarbonSDK {
-    export import Network = _Network;
-    export import CarbonQueryClient = clients.CarbonQueryClient;
-    export import ETHClient = clients.ETHClient;
-    export import HydrogenClient = clients.HydrogenClient;
-    export import InsightsQueryClient = clients.InsightsQueryClient;
-    export import NEOClient = clients.NEOClient;
-    export import TokenClient = clients.TokenClient;
-    export import ZILClient = clients.ZILClient;
-}
-export default CarbonSDK;
+/// <reference types="node" />
+import { Network, NetworkConfig, Network as _Network } from "./constant";
+import { Tendermint37Client } from "@cosmjs/tendermint-rpc";
+import * as clients from "./clients";
+import { CarbonQueryClient, ETHClient, HydrogenClient, InsightsQueryClient, NEOClient, TokenClient, ZILClient } from "./clients";
+import GasFee from "./clients/GasFee";
+import GrpcQueryClient from "./clients/GrpcQueryClient";
+import N3Client from "./clients/N3Client";
+import { AdminModule, AllianceModule, BankModule, BrokerModule, CDPModule, CoinModule, ERC20Module, EvmMergeModule, EvmModule, FeeModule, GovModule, IBCModule, LeverageModule, LiquidityPoolModule, MarketModule, OracleModule, OrderModule, PerpspoolModule, PositionModule, ProfileModule, SubAccountModule, XChainModule } from "./modules";
+import { GrantModule } from "./modules/grant";
+import { StakingModule } from "./modules/staking";
+import { CosmosLedger, Keplr, LeapExtended } from "./provider";
+import { MetaMask } from "./provider/metamask/MetaMask";
+import { CarbonSigner, CarbonWallet, CarbonWalletGenericOpts, MetaMaskWalletOpts } from "./wallet";
+export { CarbonTx } from "./util";
+export { CarbonSigner, CarbonSignerTypes, CarbonWallet, CarbonWalletGenericOpts, CarbonWalletInitOpts } from "./wallet";
+export * as Carbon from "./codec/carbon-models";
+import RainbowKitAccount, { RainbowKitWalletOpts } from "./provider/rainbowKit/RainbowKitAccount";
+export interface CarbonSDKOpts {
+    network: Network;
+    tmClient: Tendermint37Client;
+    wallet?: CarbonWallet;
+    chainId?: string;
+    evmChainId?: string;
+    token?: TokenClient;
+    query?: CarbonQueryClient;
+    hydrogen?: HydrogenClient;
+    insights?: InsightsQueryClient;
+    config?: Partial<NetworkConfig>;
+    grpcQueryClient?: GrpcQueryClient;
+    useTmAbciQuery?: boolean;
+    defaultTimeoutBlocks?: number;
+    gasFee?: GasFee;
+}
+export interface CarbonSDKInitOpts {
+    network: Network;
+    tmClient?: Tendermint37Client;
+    config?: Partial<NetworkConfig>;
+    wallet?: CarbonWallet;
+    skipInit?: boolean;
+    defaultTimeoutBlocks?: number;
+    /**
+     * temporary flag to disable GRPC Query client service when required
+     * TODO: Deprecate when grpc query client is implemented across all networks
+     */
+    useTmAbciQuery?: boolean;
+}
+export interface OverrideConfig {
+    chainId: string;
+    evmChainId: string;
+}
+/**
+ * Carbon SDK
+ *
+ *
+ */
+declare class CarbonSDK {
+    static DEFAULT_NETWORK: Network;
+    static DenomPrefix: {
+        LPToken: string;
+        CDPToken: string;
+    };
+    readonly query: CarbonQueryClient;
+    readonly useTmAbciQuery: boolean;
+    insights: InsightsQueryClient;
+    hydrogen: HydrogenClient;
+    wallet?: CarbonWallet;
+    gasFee?: GasFee;
+    network: Network;
+    configOverride: Partial<NetworkConfig>;
+    networkConfig: NetworkConfig;
+    tmClient: Tendermint37Client;
+    token: TokenClient;
+    admin: AdminModule;
+    alliance: AllianceModule;
+    order: OrderModule;
+    lp: LiquidityPoolModule;
+    erc20: ERC20Module;
+    perpspool: PerpspoolModule;
+    grant: GrantModule;
+    subaccount: SubAccountModule;
+    profile: ProfileModule;
+    cdp: CDPModule;
+    leverage: LeverageModule;
+    market: MarketModule;
+    broker: BrokerModule;
+    position: PositionModule;
+    coin: CoinModule;
+    oracle: OracleModule;
+    gov: GovModule;
+    staking: StakingModule;
+    bank: BankModule;
+    fee: FeeModule;
+    ibc: IBCModule;
+    xchain: XChainModule;
+    evm: EvmModule;
+    evmmerge: EvmMergeModule;
+    neo: NEOClient;
+    eth: ETHClient;
+    bsc: ETHClient;
+    arbitrum: ETHClient;
+    polygon: ETHClient;
+    okc: ETHClient;
+    zil: ZILClient;
+    n3: N3Client;
+    chainId: string;
+    evmChainId: string;
+    constructor(opts: CarbonSDKOpts);
+    static instance(opts?: CarbonSDKInitOpts): Promise<CarbonSDK>;
+    static instanceWithWallet(wallet: CarbonWallet, sdkOpts?: CarbonSDKInitOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithPrivateKey(privateKey: string | Buffer, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithMnemonic(mnemonic: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithSigner(signer: CarbonSigner, publicKeyBase64: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithLedger(ledger: CosmosLedger, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithKeplr(keplr: Keplr, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithLeap(leap: LeapExtended, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithMetamask(metamask: MetaMask, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts, metamaskWalletOpts?: MetaMaskWalletOpts): Promise<ConnectedCarbonSDK>;
+    static instanceWithRainbowKit(rainbowKit: RainbowKitAccount, sdkOpts: CarbonSDKInitOpts | undefined, rainbowKitWalletOpts: RainbowKitWalletOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    static instanceViewOnly(bech32Address: string, sdkOpts?: CarbonSDKInitOpts, walletOpts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    initialize(): Promise<CarbonSDK>;
+    getGasFee(): Promise<GasFee>;
+    clone(): CarbonSDK;
+    generateOpts(): CarbonSDKOpts;
+    connect(wallet: CarbonWallet): Promise<ConnectedCarbonSDK>;
+    disconnect(): CarbonSDK;
+    connectWithPrivateKey(privateKey: string | Buffer, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithMnemonic(mnemonic: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithSigner(signer: CarbonSigner, publicKeyBase64: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithLedger(ledger: CosmosLedger, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithKeplr(keplr: Keplr, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithLeap(leap: LeapExtended, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectWithMetamask(metamask: MetaMask, opts?: CarbonWalletGenericOpts, metamaskWalletOpts?: MetaMaskWalletOpts): Promise<ConnectedCarbonSDK>;
+    connectWithRainbowKit(rainbowKit: RainbowKitAccount, rainbowKitWalletOpts: RainbowKitWalletOpts, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    connectViewOnly(bech32Address: string, opts?: CarbonWalletGenericOpts): Promise<ConnectedCarbonSDK>;
+    getConfig(): NetworkConfig;
+    getTokenClient(): TokenClient;
+    getConnectedWallet(): CarbonWallet;
+    log(...args: any[]): void;
+    private checkWallet;
+    static parseNetwork: (network: string, defaultNetwork?: Network | null) => Network | null;
+}
+export declare class ConnectedCarbonSDK extends CarbonSDK {
+    wallet: CarbonWallet;
+    constructor(wallet: CarbonWallet, opts: CarbonSDKOpts);
+    clone(): ConnectedCarbonSDK;
+}
+declare namespace CarbonSDK {
+    export import Network = _Network;
+    export import CarbonQueryClient = clients.CarbonQueryClient;
+    export import ETHClient = clients.ETHClient;
+    export import HydrogenClient = clients.HydrogenClient;
+    export import InsightsQueryClient = clients.InsightsQueryClient;
+    export import NEOClient = clients.NEOClient;
+    export import TokenClient = clients.TokenClient;
+    export import ZILClient = clients.ZILClient;
+}
+export default CarbonSDK;