@upshiftfinance/sdk 0.3.0 → 0.5.0

package/lib/types/index.d.ts

@@ -10,3 +10,4 @@ export * from './vaults';
 export * from './points';
 export * from './sub-accounts';
 export * from './api';
+export * from './kyc';

package/lib/types/index.js

@@ -25,4 +25,5 @@ __exportStar(require("./vaults"), exports);
 __exportStar(require("./points"), exports);
 __exportStar(require("./sub-accounts"), exports);
 __exportStar(require("./api"), exports);
+__exportStar(require("./kyc"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/kyc.d.ts

@@ -0,0 +1,61 @@
+import type { IAddress } from './web3';
+/**
+ * A wallet's status in a chain's `KycRegistry`. `active` may deposit and
+ * withdraw, `expired` (lapsed or revoked) may only withdraw, `blocked` may do
+ * neither, and `none` has never been approved on that chain.
+ */
+export type IKycStatus = 'none' | 'active' | 'expired' | 'blocked';
+/** A wallet's raw `KycRegistry` record. Timestamps are Unix seconds; `0` means never. */
+export interface IKycRecord {
+    /** Set by a writer or the owner; only the owner clears it. */
+    blocked: boolean;
+    /** When KYC was verified. */
+    verifiedAt: number;
+    /** The record is `active` strictly before this time. */
+    expiresAt: number;
+    /** A record verified at or before this time reads `expired`. */
+    revokedAt: number;
+}
+/** Options for {@link getKycStatus} and {@link getKycRecord}. */
+export interface IKycWalletOptions {
+    /** EVM chain ID whose `KycRegistry` to read. */
+    chainId: number;
+    /** The wallet to look up. */
+    wallet: IAddress;
+    /** RPC endpoint for `chainId`. */
+    rpcUrl: string;
+}
+/** A one-time SIWE challenge from `GET /kyc/challenge`. Valid for 600 s. */
+export interface IKycChallenge {
+    /** The wallet that must sign `message`. */
+    wallet: IAddress;
+    /** EVM chain ID the challenge is bound to. */
+    chainId: number;
+    /** Single-use nonce. Never reuse it after a session call. */
+    nonce: string;
+    /** Unix seconds. Send back exactly as received. */
+    issuedAt: number;
+    /** Unix seconds. Send back exactly as received. */
+    expiry: number;
+    /** The EIP-4361 message to `personal_sign`, verbatim. */
+    message: string;
+}
+/** Options for {@link createKycSession}: a challenge plus its signature. */
+export interface ICreateKycSessionOptions extends Omit<IKycChallenge, 'message'> {
+    /** `personal_sign` signature of the challenge `message`, `0x`-prefixed. */
+    signature: string;
+}
+/** The backend's verdict on a KYC identity. */
+export type IKycIdentityStatus = 'pending' | 'approved' | 'rejected_retry' | 'rejected_final' | 'revoked' | 'blocked';
+/** A KYC session from `POST /kyc/session`. */
+export interface IKycSession {
+    /** Sumsub WebSDK access token. */
+    accessToken: string;
+    /** Refreshes `accessToken` without a new signature for 4 h. */
+    sessionToken: string;
+    /** Sumsub applicant ID. */
+    externalUserId: string;
+    /** Sumsub verification level. */
+    levelName: string;
+    identityStatus: IKycIdentityStatus;
+}

package/lib/types/kyc.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=kyc.js.map

package/lib/types/vaults.d.ts

@@ -361,6 +361,8 @@ export interface IVault {
     isFeatured: boolean;
     isSpotlighted?: boolean;
     withdrawalOnly?: boolean;
+    /** Whether depositors must be `active` in the chain's `KycRegistry` (backend `requires_kyc`). */
+    requiresKyc?: boolean;
     isVisible: boolean;
     reserveTarget: number;
     reserveTolerance: number;

package/lib/types/webserver.d.ts

@@ -614,6 +614,11 @@ export interface ITokenizedVault {
      * absent as `false`.
      */
     swaps_enabled?: boolean;
+    /**
+     * Whether depositors must be `active` in the chain's `KycRegistry`. Absent
+     * on API responses from before the flag existed; treat absent as `false`.
+     */
+    requires_kyc?: boolean;
     is_visible: boolean;
     weekly_performance_fee_bps: number;
     platform_fee_override: {

package/package.json

@@ -1,8 +1,24 @@
 {
   "name": "@upshiftfinance/sdk",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "main": "lib/index.js",
   "types": "lib/sdk.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./esm/index.d.mts",
+        "default": "./esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/sdk.d.ts",
+        "default": "./lib/index.js"
+      },
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json",
+    "./lib/*.js": "./lib/*.js",
+    "./lib/*": "./lib/*.js"
+  },
   "keywords": [
     "upshift",
     "sdk",
@@ -21,7 +37,9 @@
   "files": [
     "lib/**/*.js",
     "lib/**/*.d.ts",
-    "lib/**/*.json"
+    "lib/**/*.json",
+    "esm/index.mjs",
+    "esm/index.d.mts"
   ],
   "sideEffects": [
     "./lib/polyfills.js"
@@ -71,6 +89,7 @@
     "test:jest:coverage": "tsc && jest --config jest.config.unit.js --coverage",
     "test:forknet": "node tests/forknet/run.mjs",
     "test:solana-localnet": "node tests/solana-localnet/run.mjs",
+    "test:sui-localnet": "node tests/sui-localnet/run.mjs",
     "test:solana-idl": "jest --config jest.config.idl-drift.js",
     "clean": "rm -rf ./lib",
     "format": "biome check --write .",