@upshiftfinance/sdk 0.3.0 → 0.5.0

package/lib/modules/vaults/getters.js

@@ -88,6 +88,8 @@ const SolanaConstants = __importStar(require("../../adapters/solana/constants"))
 const withdrawal_queue_1 = require("../../adapters/solana/withdrawal-queue");
 const web3_js_1 = require("@solana/web3.js");
 const StellarGetters = __importStar(require("../../adapters/stellar/getters"));
+const SuiGetters = __importStar(require("../../adapters/sui/getters"));
+const chain_address_1 = require("../../core/helpers/chain-address");
 const utils_3 = require("../../adapters/stellar/utils");
 const constants_1 = require("../../adapters/stellar/constants");
 const EVM = __importStar(require("../../adapters/evm"));
@@ -160,6 +162,10 @@ async function getVault({ vault, loans = false, allocations = false, options, lo
                 returnedVault = await StellarGetters.getStellarVault(tokenizedVault, options);
                 break;
             }
+            case 'sui-0': {
+                returnedVault = await SuiGetters.getSuiVault(tokenizedVault, options);
+                break;
+            }
             case 'evm-2': {
                 returnedVault = await EVM.getEvmVaultV2(tokenizedVault, options);
                 break;
@@ -179,7 +185,15 @@ async function getVault({ vault, loans = false, allocations = false, options, lo
         // caller sees the same throw either way, so it is recorded as a breadcrumb
         // rather than a billed Sentry issue. Everything else stays at error.
         (0, core_1.logChainError)('getVault', err, (0, core_1.isRetryableRpcError)(err) || (0, core_1.isEmptyViewResponse)(err), { vault });
-        throw new Error(`#getVault::${vault}: ${err?.message}`);
+        // Typed SDK errors (rate limit, server, validation, …) pass through
+        // unchanged so callers can branch on `instanceof` / `code` and Sentry
+        // groups them by class. Anything else is wrapped in a typed error with the
+        // original kept as `cause`; the `#getVault::` message is unchanged.
+        if (err instanceof errors_1.UpshiftSDKError)
+            throw err;
+        throw new errors_1.UpshiftSDKError('UNKNOWN', `#getVault::${vault}: ${err?.message}`, {
+            cause: err,
+        });
     }
     // Loans enrichment stays EVM-only — there is no non-EVM loan book to read.
     // Allocations additionally covers Stellar (Untangled) and Solana (Octav, per
@@ -968,9 +982,9 @@ async function readSolanaRedemptions(input) {
 }
 async function getVaultAvailableRedemptions({ vault, wallet, options, prefetchedReads, }) {
     try {
-        // Stellar vaults don't support on-chain redemptions yet
-        if ((0, utils_3.isStellarAddress)(vault)) {
-            core_1.Logger.log.warn('getVaultAvailableRedemptions', `Available redemptions is not yet supported for Stellar vaults: ${vault}`);
+        // Stellar and Sui vaults don't support on-chain redemptions yet
+        if ((0, utils_3.isStellarAddress)(vault) || (0, chain_address_1.isSuiAddress)(vault)) {
+            core_1.Logger.log.warn('getVaultAvailableRedemptions', `Available redemptions is not yet supported for this vault: ${vault}`);
             return {
                 availableRedemptions: [],
                 pendingRedemptions: [],
@@ -1305,9 +1319,9 @@ async function getVaultAvailableRedemptions({ vault, wallet, options, prefetched
 }
 async function getVaultRedemptionHistory({ vault, wallet, lookbackBlocks, options, }) {
     try {
-        // Stellar vaults: no on-chain redemption history yet
-        if ((0, utils_3.isStellarAddress)(vault)) {
-            core_1.Logger.log.warn('getVaultRedemptionHistory', `Redemption history is not yet supported for Stellar vaults: ${vault}`);
+        // Stellar and Sui vaults: no on-chain redemption history yet
+        if ((0, utils_3.isStellarAddress)(vault) || (0, chain_address_1.isSuiAddress)(vault)) {
+            core_1.Logger.log.warn('getVaultRedemptionHistory', `Redemption history is not yet supported for this vault: ${vault}`);
             return [];
         }
         // setup
@@ -1481,7 +1495,7 @@ Object.defineProperty(exports, "getSwapRouterDepositResult", { enumerable: true,
 /**
  * Vault Positions
  */
-async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, options, prefetchedReads, }) {
+async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, suiWallet, options, prefetchedReads, }) {
     try {
         const tokenizedVaults = await (0, core_1.fetchTokenizedVault)(vault ? vault : undefined, options?.headers, false, false);
         if (!tokenizedVaults || tokenizedVaults.length === 0) {
@@ -1594,6 +1608,52 @@ async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, o
                         walletBalance: balance,
                     };
                 }
+                if ((0, chain_address_1.isSuiAddress)(v.address)) {
+                    // The contract gives shares the deposit coin's decimals.
+                    const decimals = v.sui_vault_metadata?.deposit_token_decimals;
+                    const shareCoinType = v.sui_vault_metadata?.share_coin_type;
+                    const network = v.sui_vault_metadata?.network_name;
+                    let balance = (0, core_1.toNormalizedBn)(0, decimals ?? 0);
+                    let redemptions = {
+                        availableRedemptions: [],
+                        pendingRedemptions: [],
+                    };
+                    // No metadata at all: a legacy Ember/Gamma vault, nothing to read.
+                    if (suiWallet && (0, chain_address_1.isSuiAddress)(suiWallet) && v.sui_vault_metadata) {
+                        if (decimals == null || !shareCoinType || !network) {
+                            // Without the share type or its decimals there is nothing to
+                            // read or no way to scale it: fail the row, don't show zero.
+                            throw new errors_1.UpshiftValidationError('INVALID_INPUT', 'getVaultPositions: Sui vault is missing sui_vault_metadata share type, decimals or network', { context: { vault: v.address } });
+                        }
+                        const ref = SuiGetters.suiVaultRefFromRow(v);
+                        const [shares, queued] = await Promise.all([
+                            SuiGetters.getSuiShareBalance(suiWallet, shareCoinType, network, options.sui),
+                            // Shares escrowed in withdrawal requests have left the wallet.
+                            // A failed request read keeps the balance, as on Solana.
+                            ref
+                                ? SuiGetters.getSuiPositionRedemptions(ref, suiWallet, decimals, options.sui).catch((error) => {
+                                    core_1.Logger.log.warn('getVaultPositions', 'Sui withdrawal requests unread — position shows the share balance only', { vault: v.address, error });
+                                    return redemptions;
+                                })
+                                : redemptions,
+                        ]);
+                        balance = (0, core_1.toNormalizedBn)(shares, decimals);
+                        redemptions = queued;
+                    }
+                    return {
+                        vault: v.address,
+                        // Any queued request, waiting or claimable, marks the position
+                        // REDEEM, as on Solana.
+                        status: renderStatus([
+                            ...redemptions.availableRedemptions,
+                            ...redemptions.pendingRedemptions,
+                        ], balance),
+                        availableRedemptions: redemptions.availableRedemptions,
+                        pendingRedemptions: redemptions.pendingRedemptions,
+                        redeemable: (0, core_1.toNormalizedBn)(0),
+                        walletBalance: balance,
+                    };
+                }
                 // create provider
                 const provider = (0, core_1.createProvider)(options.rpcUrl);
                 // version split logic
@@ -1709,6 +1769,7 @@ async function getVaultPositions({ vault, wallet, solanaWallet, stellarWallet, o
             wallet,
             solanaWallet,
             stellarWallet,
+            suiWallet,
         });
         throw new Error(`#getVaultPositions::${vault}:${e?.message}`);
     }
@@ -1897,6 +1958,14 @@ async function getVaultTvl({ vault, options, historical, }) {
                     },
                 ];
             }
+            if (version === 'sui-0') {
+                return [
+                    {
+                        value: (0, utils_1.backendTvlToNormalizedBn)(_vaultExists?.latest_reported_tvl, _vaultExists?.sui_vault_metadata?.deposit_token_decimals ?? 0),
+                        timestamp: new Date().toISOString(),
+                    },
+                ];
+            }
             if (version === 'stellar-0') {
                 const stellarDecimals = _vaultExists?.stellar_vault_metadata?.deposit_token_decimals ??
                     constants_1.STELLAR_FALLBACK_DECIMALS;
@@ -1957,7 +2026,9 @@ async function getVaultTvl({ vault, options, historical, }) {
             // historical tvl
             // check vault version early to guard non-EVM chains
             const version = (0, core_1.getVaultVersionV2)(_vaultExists);
-            if (version === 'stellar-0' || version === 'sol-0') {
+            if (version === 'stellar-0' ||
+                version === 'sol-0' ||
+                version === 'sui-0') {
                 core_1.Logger.log.warn('getVaultTvl:historical', 'Historical TVL not supported for non-EVM vaults', { vault, version });
                 return [];
             }
@@ -2349,7 +2420,8 @@ async function getYieldLastRealizedOn({ vault, options, }) {
                 break;
             }
             case 'sol-0':
-            case 'stellar-0': {
+            case 'stellar-0':
+            case 'sui-0': {
                 return 0;
             }
             default: {

package/lib/modules/vaults/main.d.ts

@@ -7,7 +7,7 @@
  * Export getters
  */
 export * from './getters';
-import type { IAddress, IChainId, IGetOriginInfoOptions, INormalizedNumber, IOriginInfo, IVaultHistoricalParams, IVaultPosition, IVaultUserHistoryItem } from '../../types';
+import type { IAddress, IChainId, IGetOriginInfoOptions, IKycRecord, IKycStatus, IKycWalletOptions, INormalizedNumber, IOriginInfo, IVaultHistoricalParams, IVaultPosition, IVaultUserHistoryItem } from '../../types';
 import type SolanaAdapter from '../../adapters/solana';
 import { UpshiftBase, type IUpshiftBase } from '../../core';
 import { type IContractWriteOptions, type INativeDepositOptions } from './write.actions';
@@ -27,6 +27,8 @@ export declare class UpshiftVaults extends UpshiftBase {
      * vaults (see `IVaultBaseOptions.stellarRpc`).
      */
     private _stellarRpc?;
+    /** The SDK's `sui` config, for Sui vault reads (see `IVaultBaseOptions.sui`). */
+    private _sui?;
     constructor(baseConfig: IUpshiftBase, solana: SolanaAdapter);
     /**
      * @description deposit underlying token into the specified pool with adapter support. This is for when we cannot pass in a signer in sdk and need to do so as an arg
@@ -240,8 +242,10 @@ export declare class UpshiftVaults extends UpshiftBase {
         solanaWallet?: string;
         stellarWallet?: string;
         /**
-         * Sui wallet address (`0x` + 64 hex chars). Validated now; Sui positions
-         * are not read yet, so passing it does not add Sui vaults to the result.
+         * Sui wallet address (`0x` + 64 hex chars). Its share balance and its
+         * pending withdrawal requests (as redemptions) are read for each Sui vault:
+         * one balance read plus, when the SDK has the contract IDs, one object read
+         * (one more per further 25 requests the wallet has made on the vault).
          */
         suiWallet?: string;
         options?: IVaultBaseOptions;
@@ -408,6 +412,40 @@ export declare class UpshiftVaults extends UpshiftBase {
      * ```
      */
     getOriginInfo(options: Omit<IGetOriginInfoOptions, 'rpcUrl'>): Promise<IOriginInfo>;
+    /**
+     * Read a wallet's KYC status through this instance's provider for
+     * `chainId`. See {@link getKycStatus}.
+     *
+     * @param options - `chainId` and `wallet`.
+     * @returns The wallet's {@link IKycStatus}.
+     * @throws UpshiftValidationError (`INVALID_CHAIN`) when no provider is
+     *   configured or no registry is deployed for `chainId`;
+     *   (`INVALID_ADDRESS`) for a malformed wallet.
+     * @throws UpshiftSDKError when the `statusOf` read fails.
+     * @worstCaseRpcCalls 1
+     * @example
+     * ```ts
+     * const status = await upshiftSdk.getKycStatus({ chainId: 1, wallet });
+     * ```
+     */
+    getKycStatus(options: Omit<IKycWalletOptions, 'rpcUrl'>): Promise<IKycStatus>;
+    /**
+     * Read a wallet's raw KYC record through this instance's provider for
+     * `chainId`. See {@link getKycRecord}.
+     *
+     * @param options - `chainId` and `wallet`.
+     * @returns The wallet's {@link IKycRecord}.
+     * @throws UpshiftValidationError (`INVALID_CHAIN`) when no provider is
+     *   configured or no registry is deployed for `chainId`;
+     *   (`INVALID_ADDRESS`) for a malformed wallet.
+     * @throws UpshiftSDKError when the `getRecord` read fails.
+     * @worstCaseRpcCalls 1
+     * @example
+     * ```ts
+     * const record = await upshiftSdk.getKycRecord({ chainId: 1, wallet });
+     * ```
+     */
+    getKycRecord(options: Omit<IKycWalletOptions, 'rpcUrl'>): Promise<IKycRecord>;
     /**
      * @function getStakingPositions gets all available reward staking positions
      * @param wallet optionally passed user wallet address

package/lib/modules/vaults/main.js

@@ -77,6 +77,8 @@ class UpshiftVaults extends core_1.UpshiftBase {
      * vaults (see `IVaultBaseOptions.stellarRpc`).
      */
     _stellarRpc;
+    /** The SDK's `sui` config, for Sui vault reads (see `IVaultBaseOptions.sui`). */
+    _sui;
     constructor(baseConfig, solana) {
         super(baseConfig);
         this.solanaService = solana;
@@ -87,6 +89,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 network: baseConfig.stellar.network ?? 'mainnet',
             }
             : undefined;
+        this._sui = baseConfig.sui;
         this.headers = {
             'x-environment': this.monitoring?.['x-environment'],
             'x-user-id': this.monitoring?.['x-user-id'],
@@ -134,8 +137,10 @@ class UpshiftVaults extends core_1.UpshiftBase {
         // if (!(this.authorized && this.upshiftKey)) // @todo: commented out for integrators
         const allVaults = await (0, core_1.fetchTokenizedVaults)(undefined, this.headers, options?.loadSubaccounts, options?.loadSnapshots);
         const vaultsPerAvailableProviders = allVaults.filter((v) => 
-        // Stellar vaults are backend-only (no RPC provider required)
+        // Stellar and Sui vaults use their own endpoints, not this.providers.
+        // Sui rows without sui_vault_metadata are legacy Ember/Gamma vaults.
         v?.chain_type === 'stellar' ||
+            (v?.chain_type === 'sui' && !!v.sui_vault_metadata) ||
             // Solana vaults use this.solanaService (not this.providers). Without
             // an explicit pass-through here they get silently dropped on any
             // instance whose ACTIVE_RPC_URLS() doesn't register chainId -1.
@@ -202,6 +207,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     rpcUrl,
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -294,6 +300,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     rpcUrl: this.providers?.[v.chain],
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -361,7 +368,6 @@ class UpshiftVaults extends core_1.UpshiftBase {
         //     `Vault input parameter is not an address: ${String(vault)}`,
         //   );
         (0, core_1.assertKnownChainId)(chainId, this.providers, 'getVault');
-        (0, core_1.assertSuiReadsSupported)(chainId, vault, 'getVault');
         (0, core_1.assertEvmProviderConfigured)(chainId, this.providers, 'getVault');
         // get vault data
         const vaultResponse = await (0, getters_1.getVault)({
@@ -376,6 +382,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     : this.activeNetwork?.rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -404,6 +411,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                         : this.activeNetwork?.rpcUrl,
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -453,6 +461,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
             chainId: chainId,
             solanaService: this.solanaService,
             stellarRpc: this._stellarRpc,
+            sui: this._sui,
             headers: this.headers,
         });
         return vaultResponse;
@@ -486,6 +495,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
             chainId: chainId,
             solanaService: this.solanaService,
             stellarRpc: this._stellarRpc,
+            sui: this._sui,
             headers: this.headers,
         });
         return vaultResponse;
@@ -519,6 +529,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     : this.activeNetwork?.rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -601,6 +612,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
             throw new Error('Vault input parameter is undefined.');
         if (!(0, ethers_1.isAddress)(vault) &&
             !(0, utils_2.isStellarAddress)(vault) &&
+            !(0, chain_address_1.isSuiAddress)(vault) &&
             !utils_1.SolanaUtils.isSolanaAddress(vault))
             throw new Error(`Vault input parameter is not an address: ${String(vault)}`);
         return await (0, getters_1.getVaultAvailableRedemptions)({
@@ -612,6 +624,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     : this.activeNetwork?.rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -654,7 +667,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
             throw new Error('Not authorized.');
         if (!vault)
             throw new Error('Vault input parameter is undefined.');
-        if (!(0, ethers_1.isAddress)(vault) && !(0, utils_2.isStellarAddress)(vault)) {
+        if (!(0, ethers_1.isAddress)(vault) && !(0, utils_2.isStellarAddress)(vault) && !(0, chain_address_1.isSuiAddress)(vault)) {
             throw new Error(`Vault input parameter is not an address: ${String(vault)}`);
         }
         return await (0, getters_1.getVaultRedemptionHistory)({
@@ -705,12 +718,14 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 wallet,
                 solanaWallet,
                 stellarWallet,
+                suiWallet,
                 options: {
                     rpcUrl: chainId
                         ? this.providers?.[chainId]
                         : this.activeNetwork?.rpcUrl,
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -723,7 +738,9 @@ class UpshiftVaults extends core_1.UpshiftBase {
         }
         const allVaults = await (0, core_1.fetchTokenizedVaults)(undefined, this.headers, false, false);
         if (chainId) {
-            const vaultsPerChain = allVaults.filter((v) => v.chain === chainId);
+            // Sui rows without sui_vault_metadata are legacy Ember/Gamma vaults.
+            const vaultsPerChain = allVaults.filter((v) => v.chain === chainId &&
+                !(v.chain_type === 'sui' && !v.sui_vault_metadata));
             // Batch balanceOf/lagDuration via Multicall3 before the per-vault
             // fan-out; un-batched vaults fall back to their own reads.
             const prefetchedReads = await (0, prefetch_1.prefetchVaultPositionReads)({
@@ -735,11 +752,13 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 vault: v.address,
                 solanaWallet,
                 stellarWallet,
+                suiWallet,
                 wallet,
                 options: {
                     rpcUrl: this.providers?.[v.chain],
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -757,8 +776,10 @@ class UpshiftVaults extends core_1.UpshiftBase {
             return final;
         }
         const vaultsPerAvailableProviders = allVaults.filter((v) => 
-        // Stellar vaults are backend-only (no RPC provider required)
+        // Stellar and Sui vaults use their own endpoints, not this.providers.
+        // Sui rows without sui_vault_metadata are legacy Ember/Gamma vaults.
         v?.chain_type === 'stellar' ||
+            (v?.chain_type === 'sui' && !!v.sui_vault_metadata) ||
             // Solana vaults use this.solanaService (not this.providers). Without
             // this clause every Solana position is dropped on any instance where
             // ACTIVE_RPC_URLS() doesn't register chainId -1 — which is exactly
@@ -779,11 +800,13 @@ class UpshiftVaults extends core_1.UpshiftBase {
             vault: v.address,
             solanaWallet,
             stellarWallet,
+            suiWallet,
             wallet,
             options: {
                 rpcUrl: this.providers?.[v.chain],
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -963,6 +986,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     : this.requireActiveNetwork().rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -989,6 +1013,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                     : this.requireActiveNetwork().rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -1208,6 +1233,52 @@ class UpshiftVaults extends core_1.UpshiftBase {
             rpcUrl: this.providers[options.chainId],
         });
     }
+    /**
+     * Read a wallet's KYC status through this instance's provider for
+     * `chainId`. See {@link getKycStatus}.
+     *
+     * @param options - `chainId` and `wallet`.
+     * @returns The wallet's {@link IKycStatus}.
+     * @throws UpshiftValidationError (`INVALID_CHAIN`) when no provider is
+     *   configured or no registry is deployed for `chainId`;
+     *   (`INVALID_ADDRESS`) for a malformed wallet.
+     * @throws UpshiftSDKError when the `statusOf` read fails.
+     * @worstCaseRpcCalls 1
+     * @example
+     * ```ts
+     * const status = await upshiftSdk.getKycStatus({ chainId: 1, wallet });
+     * ```
+     */
+    async getKycStatus(options) {
+        (0, core_1.assertEvmProviderConfigured)(options.chainId, this.providers, 'getKycStatus');
+        return (0, core_1.getKycStatus)({
+            ...options,
+            rpcUrl: this.providers[options.chainId],
+        });
+    }
+    /**
+     * Read a wallet's raw KYC record through this instance's provider for
+     * `chainId`. See {@link getKycRecord}.
+     *
+     * @param options - `chainId` and `wallet`.
+     * @returns The wallet's {@link IKycRecord}.
+     * @throws UpshiftValidationError (`INVALID_CHAIN`) when no provider is
+     *   configured or no registry is deployed for `chainId`;
+     *   (`INVALID_ADDRESS`) for a malformed wallet.
+     * @throws UpshiftSDKError when the `getRecord` read fails.
+     * @worstCaseRpcCalls 1
+     * @example
+     * ```ts
+     * const record = await upshiftSdk.getKycRecord({ chainId: 1, wallet });
+     * ```
+     */
+    async getKycRecord(options) {
+        (0, core_1.assertEvmProviderConfigured)(options.chainId, this.providers, 'getKycRecord');
+        return (0, core_1.getKycRecord)({
+            ...options,
+            rpcUrl: this.providers[options.chainId],
+        });
+    }
     /**
      * @function getStakingPositions gets all available reward staking positions
      * @param wallet optionally passed user wallet address
@@ -1243,7 +1314,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
             throw new Error('Not authorized.');
         if (!vault)
             throw new Error('Pool input parameter is undefined.');
-        if (!(0, ethers_1.isAddress)(vault) && !(0, utils_2.isStellarAddress)(vault))
+        if (!(0, ethers_1.isAddress)(vault) && !(0, utils_2.isStellarAddress)(vault) && !(0, chain_address_1.isSuiAddress)(vault))
             throw new Error(`Pool input parameter is not an address: ${String(vault)}`);
         const resolvedChainId = chainId ?? this.activeNetwork?.chainId;
         const rpcUrl = chainId
@@ -1256,6 +1327,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 chainId: resolvedChainId,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -1280,6 +1352,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 rpcUrl: rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -1328,6 +1401,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                         : rpcUrl || this.requireActiveNetwork().rpcUrl,
                     solanaService: this.solanaService,
                     stellarRpc: this._stellarRpc,
+                    sui: this._sui,
                     env: this.monitoring?.env,
                     upshiftKey: this.keys?.upshift,
                     subgraphKey: this.keys?.graph,
@@ -1602,6 +1676,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 rpcUrl: chainId ? this.providers?.[chainId] : this.activeNetwork.rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,
@@ -1655,6 +1730,7 @@ class UpshiftVaults extends core_1.UpshiftBase {
                 rpcUrl,
                 solanaService: this.solanaService,
                 stellarRpc: this._stellarRpc,
+                sui: this._sui,
                 env: this.monitoring?.env,
                 upshiftKey: this.keys?.upshift,
                 subgraphKey: this.keys?.graph,

package/lib/modules/vaults/types.d.ts

@@ -1,5 +1,5 @@
 import type { Connection } from '@solana/web3.js';
-import type { IAddress, IEnv, ISolanaNetwork, IStellarNetwork, IWSMonitorHeaders } from '../../types';
+import type { IAddress, IEnv, ISolanaNetwork, IStellarNetwork, ISuiConfig, IWSMonitorHeaders } from '../../types';
 /**
  * Structural interface for the Solana adapter surface used by vault operations.
  * Avoids importing the concrete SolanaAdapter class to prevent circular dependencies.
@@ -63,6 +63,12 @@ export interface IVaultBaseOptions {
         rpcUrl: string;
         network: IStellarNetwork;
     };
+    /**
+     * The SDK's `sui` config for Sui vault reads: endpoint override and contract
+     * IDs. Applied only to vaults on its `network`; other Sui vaults use the
+     * built-in endpoint and contract IDs.
+     */
+    sui?: ISuiConfig;
     headers?: IWSMonitorHeaders;
     /**
      * Portfolio mode: when true, the per-vault EVM getter does NOT null out a

package/lib/modules/vaults/utils.js

@@ -209,7 +209,8 @@ async function getYieldLastRealizedOn(provider, vaultAddress) {
             break;
         }
         case 'sol-0':
-        case 'stellar-0': {
+        case 'stellar-0':
+        case 'sui-0': {
             return 0;
         }
         default: {
@@ -392,6 +393,7 @@ function buildBackendVault(tokenizedVault, overrides) {
         isFeatured: tokenizedVault.is_featured || false,
         isSpotlighted: tokenizedVault.is_spotlighted ?? false,
         withdrawalOnly: tokenizedVault.withdrawal_only ?? false,
+        requiresKyc: tokenizedVault.requires_kyc ?? false,
         isVisible: tokenizedVault.is_visible || false,
         reserveTarget: tokenizedVault.reserve_target || 0,
         reserveTolerance: tokenizedVault.reserve_tolerance || 0,
@@ -527,6 +529,7 @@ async function buildFormattedVault(provider, tokenizedVault, contractCalls) {
         isFeatured: tokenizedVault.is_featured,
         withdrawalOnly: tokenizedVault.withdrawal_only ?? false,
         isSpotlighted: tokenizedVault.is_spotlighted ?? false,
+        requiresKyc: tokenizedVault.requires_kyc ?? false,
         isVisible: tokenizedVault.is_visible,
         reserveTarget: tokenizedVault.reserve_target,
         reserveTolerance: tokenizedVault.reserve_tolerance,