jay-network 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,216 @@
+import * as _cosmjs_stargate from '@cosmjs/stargate';
+import { SigningStargateClient, StdFee } from '@cosmjs/stargate';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+
+/**
+ * Static chain configuration for The Jay Network.
+ */
+declare const JAY_CHAIN_ID = "thejaynetwork";
+declare const JAY_CHAIN_NAME = "Jay Network";
+declare const JAY_DENOM = "ujay";
+declare const JAY_SYMBOL = "JAY";
+declare const JAY_DECIMALS = 6;
+declare const JAY_PREFIX = "yjay";
+/** Public proxied endpoints. */
+declare const DEFAULT_RPC = "https://pixture.thejaynetwork.com/rpc";
+declare const DEFAULT_REST = "https://pixture.thejaynetwork.com/rest";
+/**
+ * Keplr-compatible chain registration object.
+ * Pass to `window.keplr.experimentalSuggestChain(JAY_CHAIN_INFO)`.
+ */
+declare const JAY_CHAIN_INFO: {
+    readonly chainId: "thejaynetwork";
+    readonly chainName: "Jay Network";
+    readonly rpc: "https://pixture.thejaynetwork.com/rpc";
+    readonly rest: "https://pixture.thejaynetwork.com/rest";
+    readonly bip44: {
+        readonly coinType: 118;
+    };
+    readonly bech32Config: {
+        readonly bech32PrefixAccAddr: "yjay";
+        readonly bech32PrefixAccPub: "yjaypub";
+        readonly bech32PrefixValAddr: "yjayvaloper";
+        readonly bech32PrefixValPub: "yjayvaloperpub";
+        readonly bech32PrefixConsAddr: "yjayvalcons";
+        readonly bech32PrefixConsPub: "yjayvalconspub";
+    };
+    readonly currencies: readonly [{
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+    }];
+    readonly feeCurrencies: readonly [{
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+        readonly gasPriceStep: {
+            readonly low: 0.01;
+            readonly average: 0.025;
+            readonly high: 0.04;
+        };
+    }];
+    readonly stakeCurrency: {
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+    };
+};
+interface JaySdkOptions {
+    /** Tendermint RPC endpoint. Defaults to the public proxy. */
+    rpc?: string;
+    /** Cosmos REST (LCD) endpoint. Defaults to the public proxy. */
+    rest?: string;
+}
+
+/** Convert a human JAY amount to base micro-units (ujay). */
+declare function toMicro(amount: string | number, decimals?: number): string;
+/** Convert base micro-units (ujay) to a human-readable JAY amount. */
+declare function fromMicro(amount: string | number, decimals?: number): string;
+/** Build a coin object for the native JAY token. */
+declare function jayCoin(amount: string | number, denom?: string): {
+    denom: string;
+    amount: string;
+};
+/** Re-encode any bech32 address to a different prefix (e.g. yjay -> cosmos). */
+declare function reEncodeAddress(address: string, prefix: string): string;
+/** Derive the validator operator (valoper) address from an account address. */
+declare function toValoper(accountAddress: string): string;
+/** True when the account address operates the given validator operator address. */
+declare function isValidatorOperator(accountAddress: string, valoperAddress: string): boolean;
+/** Validate a Jay Network (yjay) bech32 address. */
+declare function isValidJayAddress(address: string): boolean;
+/** Shorten an address for display: yjay1abc…wxyz */
+declare function shortenAddress(address: string, head?: number, tail?: number): string;
+
+/**
+ * Read-only client for The Jay Network.
+ * Wraps the Cosmos REST (LCD) and Tendermint RPC endpoints — no wallet required.
+ */
+declare class JayClient {
+    readonly rpc: string;
+    readonly rest: string;
+    constructor(options?: JaySdkOptions);
+    private getJson;
+    /** Latest block height and time from the RPC status endpoint. */
+    getLatestBlock(): Promise<{
+        height: string;
+        time: string;
+    }>;
+    /** Node sync / network identity info. */
+    getNodeInfo(): Promise<any>;
+    /** All balances for an address. Amounts are in base units (ujay). */
+    getBalances(address: string): Promise<Array<{
+        denom: string;
+        amount: string;
+    }>>;
+    /** Native JAY balance as a human-readable string. */
+    getJayBalance(address: string): Promise<string>;
+    /** Bonded validators (optionally filter by status). */
+    getValidators(status?: string): Promise<any>;
+    /** A single validator by operator (valoper) address. */
+    getValidator(valoperAddress: string): Promise<any>;
+    /** All delegations for a delegator. */
+    getDelegations(delegatorAddress: string): Promise<any>;
+    /** Pending staking rewards for a delegator across all validators. */
+    getRewards(delegatorAddress: string): Promise<any>;
+    /** Validator commission accrued by an operator. */
+    getValidatorCommission(valoperAddress: string): Promise<string>;
+    /** Governance proposals (optionally filter by status). */
+    getProposals(status?: string): Promise<any>;
+    /** A single governance proposal by id. */
+    getProposal(proposalId: string | number): Promise<any>;
+    /** Total token supply. */
+    getSupply(): Promise<any>;
+    /** Open IBC transfer channels. */
+    getIbcChannels(): Promise<any>;
+    /** Resolve an `ibc/<hash>` denom to its base denom + path. */
+    resolveIbcDenom(denom: string): Promise<{
+        baseDenom: string;
+        path: string;
+    }>;
+}
+
+type VoteOption = 'VOTE_OPTION_YES' | 'VOTE_OPTION_ABSTAIN' | 'VOTE_OPTION_NO' | 'VOTE_OPTION_NO_WITH_VETO';
+/**
+ * Signing client for The Jay Network.
+ * Build one from a wallet's offline signer (Keplr/JAY Wallet/mnemonic).
+ *
+ * @example
+ * const signer = await window.keplr.getOfflineSignerAuto('thejaynetwork')
+ * const jay = await JaySigningClient.connect(signer, address)
+ * await jay.delegate(valoperAddress, '10')
+ */
+declare class JaySigningClient {
+    private readonly client;
+    readonly address: string;
+    private constructor();
+    /** Connect using an offline signer and the sender address. */
+    static connect(signer: OfflineSigner, address: string, options?: JaySdkOptions): Promise<JaySigningClient>;
+    /** Underlying CosmJS client for advanced use. */
+    get raw(): SigningStargateClient;
+    private broadcast;
+    /** Send JAY to another address. */
+    send(to: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Delegate (stake) JAY to a validator. */
+    delegate(valoperAddress: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Undelegate (unstake) JAY from a validator. */
+    undelegate(valoperAddress: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Move stake from one validator to another. */
+    redelegate(srcValoper: string, dstValoper: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Claim staking rewards from one validator. */
+    claimRewards(valoperAddress: string, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Claim staking rewards from many validators in one tx. */
+    claimAllRewards(valoperAddresses: string[], memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Withdraw a validator operator's accrued commission. */
+    withdrawCommission(valoperAddress: string, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Vote on a governance proposal (gov v1). */
+    vote(proposalId: string | number, option: VoteOption, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** IBC transfer of JAY to another chain. */
+    ibcTransfer(params: {
+        sourceChannel: string;
+        receiver: string;
+        amount: string | number;
+        denom?: string;
+        timeoutMinutes?: number;
+    }, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Disconnect the underlying client. */
+    disconnect(): void;
+}
+
+export { DEFAULT_REST, DEFAULT_RPC, JAY_CHAIN_ID, JAY_CHAIN_INFO, JAY_CHAIN_NAME, JAY_DECIMALS, JAY_DENOM, JAY_PREFIX, JAY_SYMBOL, JayClient, type JaySdkOptions, JaySigningClient, type VoteOption, fromMicro, isValidJayAddress, isValidatorOperator, jayCoin, reEncodeAddress, shortenAddress, toMicro, toValoper };

package/dist/index.d.ts

@@ -0,0 +1,216 @@
+import * as _cosmjs_stargate from '@cosmjs/stargate';
+import { SigningStargateClient, StdFee } from '@cosmjs/stargate';
+import { OfflineSigner } from '@cosmjs/proto-signing';
+
+/**
+ * Static chain configuration for The Jay Network.
+ */
+declare const JAY_CHAIN_ID = "thejaynetwork";
+declare const JAY_CHAIN_NAME = "Jay Network";
+declare const JAY_DENOM = "ujay";
+declare const JAY_SYMBOL = "JAY";
+declare const JAY_DECIMALS = 6;
+declare const JAY_PREFIX = "yjay";
+/** Public proxied endpoints. */
+declare const DEFAULT_RPC = "https://pixture.thejaynetwork.com/rpc";
+declare const DEFAULT_REST = "https://pixture.thejaynetwork.com/rest";
+/**
+ * Keplr-compatible chain registration object.
+ * Pass to `window.keplr.experimentalSuggestChain(JAY_CHAIN_INFO)`.
+ */
+declare const JAY_CHAIN_INFO: {
+    readonly chainId: "thejaynetwork";
+    readonly chainName: "Jay Network";
+    readonly rpc: "https://pixture.thejaynetwork.com/rpc";
+    readonly rest: "https://pixture.thejaynetwork.com/rest";
+    readonly bip44: {
+        readonly coinType: 118;
+    };
+    readonly bech32Config: {
+        readonly bech32PrefixAccAddr: "yjay";
+        readonly bech32PrefixAccPub: "yjaypub";
+        readonly bech32PrefixValAddr: "yjayvaloper";
+        readonly bech32PrefixValPub: "yjayvaloperpub";
+        readonly bech32PrefixConsAddr: "yjayvalcons";
+        readonly bech32PrefixConsPub: "yjayvalconspub";
+    };
+    readonly currencies: readonly [{
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+    }];
+    readonly feeCurrencies: readonly [{
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+        readonly gasPriceStep: {
+            readonly low: 0.01;
+            readonly average: 0.025;
+            readonly high: 0.04;
+        };
+    }];
+    readonly stakeCurrency: {
+        readonly coinDenom: "JAY";
+        readonly coinMinimalDenom: "ujay";
+        readonly coinDecimals: 6;
+    };
+};
+interface JaySdkOptions {
+    /** Tendermint RPC endpoint. Defaults to the public proxy. */
+    rpc?: string;
+    /** Cosmos REST (LCD) endpoint. Defaults to the public proxy. */
+    rest?: string;
+}
+
+/** Convert a human JAY amount to base micro-units (ujay). */
+declare function toMicro(amount: string | number, decimals?: number): string;
+/** Convert base micro-units (ujay) to a human-readable JAY amount. */
+declare function fromMicro(amount: string | number, decimals?: number): string;
+/** Build a coin object for the native JAY token. */
+declare function jayCoin(amount: string | number, denom?: string): {
+    denom: string;
+    amount: string;
+};
+/** Re-encode any bech32 address to a different prefix (e.g. yjay -> cosmos). */
+declare function reEncodeAddress(address: string, prefix: string): string;
+/** Derive the validator operator (valoper) address from an account address. */
+declare function toValoper(accountAddress: string): string;
+/** True when the account address operates the given validator operator address. */
+declare function isValidatorOperator(accountAddress: string, valoperAddress: string): boolean;
+/** Validate a Jay Network (yjay) bech32 address. */
+declare function isValidJayAddress(address: string): boolean;
+/** Shorten an address for display: yjay1abc…wxyz */
+declare function shortenAddress(address: string, head?: number, tail?: number): string;
+
+/**
+ * Read-only client for The Jay Network.
+ * Wraps the Cosmos REST (LCD) and Tendermint RPC endpoints — no wallet required.
+ */
+declare class JayClient {
+    readonly rpc: string;
+    readonly rest: string;
+    constructor(options?: JaySdkOptions);
+    private getJson;
+    /** Latest block height and time from the RPC status endpoint. */
+    getLatestBlock(): Promise<{
+        height: string;
+        time: string;
+    }>;
+    /** Node sync / network identity info. */
+    getNodeInfo(): Promise<any>;
+    /** All balances for an address. Amounts are in base units (ujay). */
+    getBalances(address: string): Promise<Array<{
+        denom: string;
+        amount: string;
+    }>>;
+    /** Native JAY balance as a human-readable string. */
+    getJayBalance(address: string): Promise<string>;
+    /** Bonded validators (optionally filter by status). */
+    getValidators(status?: string): Promise<any>;
+    /** A single validator by operator (valoper) address. */
+    getValidator(valoperAddress: string): Promise<any>;
+    /** All delegations for a delegator. */
+    getDelegations(delegatorAddress: string): Promise<any>;
+    /** Pending staking rewards for a delegator across all validators. */
+    getRewards(delegatorAddress: string): Promise<any>;
+    /** Validator commission accrued by an operator. */
+    getValidatorCommission(valoperAddress: string): Promise<string>;
+    /** Governance proposals (optionally filter by status). */
+    getProposals(status?: string): Promise<any>;
+    /** A single governance proposal by id. */
+    getProposal(proposalId: string | number): Promise<any>;
+    /** Total token supply. */
+    getSupply(): Promise<any>;
+    /** Open IBC transfer channels. */
+    getIbcChannels(): Promise<any>;
+    /** Resolve an `ibc/<hash>` denom to its base denom + path. */
+    resolveIbcDenom(denom: string): Promise<{
+        baseDenom: string;
+        path: string;
+    }>;
+}
+
+type VoteOption = 'VOTE_OPTION_YES' | 'VOTE_OPTION_ABSTAIN' | 'VOTE_OPTION_NO' | 'VOTE_OPTION_NO_WITH_VETO';
+/**
+ * Signing client for The Jay Network.
+ * Build one from a wallet's offline signer (Keplr/JAY Wallet/mnemonic).
+ *
+ * @example
+ * const signer = await window.keplr.getOfflineSignerAuto('thejaynetwork')
+ * const jay = await JaySigningClient.connect(signer, address)
+ * await jay.delegate(valoperAddress, '10')
+ */
+declare class JaySigningClient {
+    private readonly client;
+    readonly address: string;
+    private constructor();
+    /** Connect using an offline signer and the sender address. */
+    static connect(signer: OfflineSigner, address: string, options?: JaySdkOptions): Promise<JaySigningClient>;
+    /** Underlying CosmJS client for advanced use. */
+    get raw(): SigningStargateClient;
+    private broadcast;
+    /** Send JAY to another address. */
+    send(to: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Delegate (stake) JAY to a validator. */
+    delegate(valoperAddress: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Undelegate (unstake) JAY from a validator. */
+    undelegate(valoperAddress: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Move stake from one validator to another. */
+    redelegate(srcValoper: string, dstValoper: string, amount: string | number, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Claim staking rewards from one validator. */
+    claimRewards(valoperAddress: string, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Claim staking rewards from many validators in one tx. */
+    claimAllRewards(valoperAddresses: string[], memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Withdraw a validator operator's accrued commission. */
+    withdrawCommission(valoperAddress: string, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Vote on a governance proposal (gov v1). */
+    vote(proposalId: string | number, option: VoteOption, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** IBC transfer of JAY to another chain. */
+    ibcTransfer(params: {
+        sourceChannel: string;
+        receiver: string;
+        amount: string | number;
+        denom?: string;
+        timeoutMinutes?: number;
+    }, memo?: string, fee?: StdFee): Promise<{
+        txHash: string;
+        height: number;
+        raw: _cosmjs_stargate.DeliverTxResponse;
+    }>;
+    /** Disconnect the underlying client. */
+    disconnect(): void;
+}
+
+export { DEFAULT_REST, DEFAULT_RPC, JAY_CHAIN_ID, JAY_CHAIN_INFO, JAY_CHAIN_NAME, JAY_DECIMALS, JAY_DENOM, JAY_PREFIX, JAY_SYMBOL, JayClient, type JaySdkOptions, JaySigningClient, type VoteOption, fromMicro, isValidJayAddress, isValidatorOperator, jayCoin, reEncodeAddress, shortenAddress, toMicro, toValoper };