@upshiftfinance/sdk 0.3.0 → 0.4.0

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,
@@ -735,11 +750,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 +774,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 +798,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 +984,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 +1011,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 +1231,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 +1312,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 +1325,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 +1350,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 +1399,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 +1674,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 +1728,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,