@ritbit/v4-client-js 2.1.11 → 2.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ritbit/v4-client-js",
-  "version": "2.1.11",
+  "version": "2.2.2",
   "description": "General client library for the new RITBIT Chain",
   "main": "build/cjs/src/index.js",
   "module": "build/esm/src/index.js",
@@ -57,7 +57,7 @@
     "@cosmjs/tendermint-rpc": "^0.32.4",
     "@cosmjs/utils": "^0.32.4",
     "@osmonauts/lcd": "^0.6.0",
-    "@ritbit/v4-proto": "1.9.0",
+    "@ritbit/v4-proto": "^2.0.3",
     "@scure/bip32": "^1.1.5",
     "@scure/bip39": "^1.1.1",
     "axios": "1.1.3",

package/src/clients/constants.ts

@@ -108,6 +108,9 @@ export const TYPE_URL_MSG_UNDELEGATE = '/cosmos.staking.v1beta1.MsgUndelegate';
 export const TYPE_URL_MSG_WITHDRAW_DELEGATOR_REWARD =
   '/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward';
 
+// x/bridge
+export const TYPE_URL_MSG_INITIATE_WITHDRAWAL = '/ritbit.bridge.MsgInitiateWithdrawal';
+
 // x/accountplus
 export const TYPE_URL_MSG_ADD_AUTHENTICATOR = '/ritbit.accountplus.MsgAddAuthenticator';
 export const TYPE_URL_MSG_REMOVE_AUTHENTICATOR = '/ritbit.accountplus.MsgRemoveAuthenticator';

package/src/clients/lib/registry.ts

@@ -22,6 +22,7 @@ import {
   MsgDepositToMegavault,
   MsgWithdrawFromMegavault,
 } from '@ritbit/v4-proto/src/codegen/ritbit/vault/tx';
+import { MsgInitiateWithdrawal } from '@ritbit/v4-proto/src/codegen/ritbit/bridge/tx';
 
 import {
   TYPE_URL_MSG_PLACE_ORDER,
@@ -41,6 +42,7 @@ import {
   TYPE_URL_MSG_CREATE_MARKET_PERMISSIONLESS,
   TYPE_URL_MSG_ADD_AUTHENTICATOR,
   TYPE_URL_MSG_REMOVE_AUTHENTICATOR,
+  TYPE_URL_MSG_INITIATE_WITHDRAWAL,
 } from '../constants';
 
 export const registry: ReadonlyArray<[string, GeneratedType]> = [];
@@ -82,6 +84,9 @@ export function generateRegistry(): Registry {
     [TYPE_URL_MSG_ADD_AUTHENTICATOR, MsgAddAuthenticator as GeneratedType],
     [TYPE_URL_MSG_REMOVE_AUTHENTICATOR, MsgRemoveAuthenticator as GeneratedType],
 
+    // bridge
+    [TYPE_URL_MSG_INITIATE_WITHDRAWAL, MsgInitiateWithdrawal as GeneratedType],
+
     // default types
     ...defaultRegistryTypes,
   ]);

package/src/clients/modules/get.ts

@@ -19,6 +19,10 @@ import Long from 'long';
 import protobuf from 'protobufjs';
 
 import { bigIntToBytes } from '../../lib/helpers';
+import {
+  computeUnlockedAmount,
+  decodeVestingFromAny,
+} from '../../lib/vesting';
 import { PAGE_REQUEST } from '../constants';
 import { UnexpectedClientError } from '../lib/errors';
 import {
@@ -324,13 +328,14 @@ export class Get {
   }
 
   /**
-   * @description Get Account for an address or the promise is rejected if the account
-   * does not exist on-chain.
+   * @description Get raw account (Any) for an address or the promise is rejected if the account
+   * does not exist on-chain. Use this when you need vesting/account type details (e.g. decoding
+   * ContinuousVestingAccount) instead of the normalized Account from getAccount.
    *
    * @throws UnexpectedClientError if a malformed response is returned with no GRPC error.
-   * @returns An account for a given address.
+   * @returns The raw account as protobuf Any (typeUrl + value).
    */
-  async getAccount(address: string): Promise<Account> {
+  async getAccountRaw(address: string): Promise<Any> {
     const requestData: Uint8Array = Uint8Array.from(
       AuthModule.QueryAccountRequest.encode({ address }).finish(),
     );
@@ -341,13 +346,43 @@ export class Get {
     );
     const rawAccount: Any | undefined = AuthModule.QueryAccountResponse.decode(data).account;
 
-    // The promise should have been rejected if the rawAccount was undefined.
     if (rawAccount === undefined) {
       throw new UnexpectedClientError();
     }
+    return rawAccount;
+  }
+
+  /**
+   * @description Get Account for an address or the promise is rejected if the account
+   * does not exist on-chain.
+   *
+   * @throws UnexpectedClientError if a malformed response is returned with no GRPC error.
+   * @returns An account for a given address.
+   */
+  async getAccount(address: string): Promise<Account> {
+    const rawAccount = await this.getAccountRaw(address);
     return accountFromAny(rawAccount);
   }
 
+  /**
+   * @description Get unlocked native amount for a vesting account (by denom).
+   * Uses getAccountRaw and decodes vesting types (Continuous/Delayed/Periodic/Base).
+   * @returns Unlocked amount in base units (string), or undefined if not vesting or denom not found.
+   */
+  async getAccountVesting(
+    address: string,
+    nativeDenom: string
+  ): Promise<string | undefined> {
+    try {
+      const raw = await this.getAccountRaw(address);
+      const info = decodeVestingFromAny(raw);
+      if (!info) return undefined;
+      return computeUnlockedAmount(info, nativeDenom);
+    } catch {
+      return undefined;
+    }
+  }
+
   /**
    * @description Get equity tier limit configuration.
    *

package/src/clients/modules/proto-includes.ts

@@ -31,3 +31,4 @@ export * from '@ritbit/v4-proto/src/codegen/ritbit/sending/transfer';
 export * from '@ritbit/v4-proto/src/codegen/ritbit/assets/genesis';
 export * from '@ritbit/v4-proto/src/codegen/ritbit/assets/asset';
 export * from '@ritbit/v4-proto/src/codegen/ritbit/listing/tx';
+export * from '@ritbit/v4-proto/src/codegen/ritbit/bridge/tx';

package/src/index.ts

@@ -7,6 +7,11 @@ export * as onboarding from './lib/onboarding';
 export * as tradingKeyUtils from './lib/trading-key-utils';
 export * as utils from './lib/utils';
 export * as validation from './lib/validation';
+export {
+  type VestingInfo,
+  decodeVestingFromAny,
+  computeUnlockedAmount,
+} from './lib/vesting';
 
 export { CompositeClient } from './clients/composite-client';
 export { FaucetClient } from './clients/faucet-client';

package/src/lib/vesting.ts

@@ -0,0 +1,119 @@
+import { Any } from 'cosmjs-types/google/protobuf/any';
+import * as Vesting from 'cosmjs-types/cosmos/vesting/v1beta1/vesting';
+
+/**
+ * Нормализованная информация о вестинг-аккаунте, достаточная для расчёта
+ * разблокированной суммы. Типы Continuous/Delayed/Periodic/Base сводятся к этому виду.
+ */
+export interface VestingInfo {
+  /** Монеты original_vesting (деном + количество в base units). */
+  originalVesting: Array<{ denom: string; amount: string }>;
+  /** Начало вестинга (Unix секунды). */
+  startTimeSec: number;
+  /** Конец вестинга (Unix секунды). */
+  endTimeSec: number;
+}
+
+const VESTING_TYPE_URLS = [
+  '/cosmos.vesting.v1beta1.ContinuousVestingAccount',
+  '/cosmos.vesting.v1beta1.DelayedVestingAccount',
+  '/cosmos.vesting.v1beta1.PeriodicVestingAccount',
+  '/cosmos.vesting.v1beta1.BaseVestingAccount',
+] as const;
+
+function bigintToNumber(value: bigint | undefined): number {
+  if (value == null || value === undefined) return 0;
+  return Number(value);
+}
+
+/**
+ * Декодирует сырой аккаунт (Any из getAccountRaw) в VestingInfo.
+ * Возвращает null, если тип аккаунта не vesting или нет original_vesting.
+ */
+export function decodeVestingFromAny(raw: Any): VestingInfo | null {
+  const { typeUrl, value } = raw;
+  if (!VESTING_TYPE_URLS.some((u) => typeUrl === u)) {
+    return null;
+  }
+  try {
+    switch (typeUrl) {
+      case '/cosmos.vesting.v1beta1.ContinuousVestingAccount': {
+        const acc = Vesting.ContinuousVestingAccount.decode(value);
+        const base = acc.baseVestingAccount;
+        if (!base?.originalVesting?.length) return null;
+        return {
+          originalVesting: base.originalVesting.map((c) => ({
+            denom: c.denom,
+            amount: c.amount,
+          })),
+          startTimeSec: bigintToNumber(acc.startTime),
+          endTimeSec: bigintToNumber(base.endTime),
+        };
+      }
+      case '/cosmos.vesting.v1beta1.DelayedVestingAccount': {
+        const acc = Vesting.DelayedVestingAccount.decode(value);
+        const base = acc.baseVestingAccount;
+        if (!base?.originalVesting?.length) return null;
+        return {
+          originalVesting: base.originalVesting.map((c) => ({
+            denom: c.denom,
+            amount: c.amount,
+          })),
+          startTimeSec: 0,
+          endTimeSec: bigintToNumber(base.endTime),
+        };
+      }
+      case '/cosmos.vesting.v1beta1.PeriodicVestingAccount': {
+        const acc = Vesting.PeriodicVestingAccount.decode(value);
+        const base = acc.baseVestingAccount;
+        if (!base?.originalVesting?.length) return null;
+        return {
+          originalVesting: base.originalVesting.map((c) => ({
+            denom: c.denom,
+            amount: c.amount,
+          })),
+          startTimeSec: bigintToNumber(acc.startTime),
+          endTimeSec: bigintToNumber(base.endTime),
+        };
+      }
+      case '/cosmos.vesting.v1beta1.BaseVestingAccount': {
+        const base = Vesting.BaseVestingAccount.decode(value);
+        if (!base?.originalVesting?.length) return null;
+        return {
+          originalVesting: base.originalVesting.map((c) => ({
+            denom: c.denom,
+            amount: c.amount,
+          })),
+          startTimeSec: 0,
+          endTimeSec: bigintToNumber(base.endTime),
+        };
+      }
+      default:
+        return null;
+    }
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Считает разблокированную сумму в base units для денома по VestingInfo.
+ * Линейная разблокировка от startTimeSec до endTimeSec.
+ */
+export function computeUnlockedAmount(
+  info: VestingInfo,
+  denom: string
+): string | undefined {
+  const entry = info.originalVesting.find((c) => c.denom === denom);
+  if (!entry) return undefined;
+  const total = BigInt(entry.amount);
+  const { startTimeSec, endTimeSec } = info;
+  if (startTimeSec === 0 && endTimeSec === 0) return entry.amount;
+  const nowSec = Math.floor(Date.now() / 1000);
+  if (nowSec <= startTimeSec) return '0';
+  if (nowSec >= endTimeSec) return entry.amount;
+  const period = endTimeSec - startTimeSec;
+  const elapsed = nowSec - startTimeSec;
+  const unlocked = (total * BigInt(elapsed)) / BigInt(period);
+  return String(unlocked);
+}