@upshiftfinance/sdk 0.3.0 → 0.5.0

package/README.md

@@ -154,7 +154,7 @@ src.ts/
 │   ├── evm/             # EVM adapter (approve, deposit, redeem, read helpers)
 │   ├── solana/          # Solana program adapters
 │   ├── stellar/         # Stellar vault adapters
-│   └── sui/             # Sui config and chain-identity helpers
+│   └── sui/             # Sui client, contract targets, vault reads and actions
 ├── evm/                 # EVM cross-chain (LayerZero OVault)
 ├── modules/             # Feature modules
 │   ├── vaults/          # Vault read operations
@@ -174,7 +174,7 @@ src.ts/
 - **EVM Chains**: Ethereum, Arbitrum, Base, BSC, Avalanche, and more — `wagmi/viem` and `ethers` signers supported
 - **Solana**: Native Solana program support with full vault functionality
 - **Stellar**: Stellar vault deposit, redeem, and position queries
-- **Sui**: chain ID `-2`, address and version (`sui-0`) recognition; vault reads are not supported yet
+- **Sui**: chain ID `-2`; vault reads (`getVault`, `getVaults`), share positions (`getVaultPositions({ suiWallet })`), deposit and instant redeem (`sdk.sui.vaultDeposit`, `sdk.sui.vaultRedeem`). Pass `sui.packageId`, `sui.originalPackageId` and `sui.registryId` until the SDK ships the contract IDs
 - Unified interface across all chains
 
 ### Vault Versions
@@ -183,6 +183,7 @@ src.ts/
 - `evm-2`: Current EVM vault architecture (separate receipt tokens)
 - `sol-0`: Solana program-based vaults
 - `stellar-0`: Stellar-based vaults
+- `sui-0`: Sui Move vaults
 
 ### Data Enrichment
 
@@ -337,6 +338,9 @@ if (walletClient) sdk.evm.setSigner(walletClient);
 
 | Method | Description |
 | --- | --- |
+| `vaultDeposit(options)` | Build an unsigned deposit (dry-run first) |
+| `vaultRedeem(options)` | Build an unsigned instant redemption (dry-run first) |
+| `executeTransaction({ bytes, signature })` | Execute a wallet-signed transaction and wait for it |
 | `isSuiAddress(address)` | Whether a string is a Sui address / object ID (`0x` + 64 hex) |
 | `isSuiVault(chainId)` | Whether a chain ID is Sui's (`-2`) |
 | `network`, `rpcUrl` | The `sui` config passed to `new UpshiftSDK({ sui })` |

package/esm/index.d.mts

@@ -0,0 +1,15 @@
+/**
+ * Type entry for ESM consumers of `@upshiftfinance/sdk` (paired with
+ * `esm/index.mjs`).
+ *
+ * The declaration rollup `lib/sdk.d.ts` describes a CommonJS module. Under
+ * ESM-mode TypeScript (`module: node16 | nodenext`), a default import of a CJS
+ * declaration resolves to the whole `module.exports`, so
+ * `new UpshiftSDK()` failed to typecheck ("This expression is not
+ * constructable"). `import = require` reads the CJS module as-is, letting us
+ * re-export its `default` (the `UpshiftSDK` class) as the ESM default.
+ */
+import sdk = require('../lib/sdk.js');
+
+export * from '../lib/sdk.js';
+export default sdk.default;

package/esm/index.mjs

@@ -0,0 +1,18 @@
+/**
+ * ESM entry point for `@upshiftfinance/sdk`.
+ *
+ * The SDK is compiled to CommonJS (`lib/index.js`), where the default export
+ * lives on `exports.default`. Node's ESM loader (and tools that follow it:
+ * Vite SSR, vitest, tsx, plain `node` with `"type": "module"`) maps a default
+ * import of a CJS module to the whole `module.exports` object, so
+ * `import UpshiftSDK from '@upshiftfinance/sdk'` returned a namespace object
+ * and `new UpshiftSDK()` threw "UpshiftSDK is not a constructor".
+ *
+ * This wrapper re-exports the same CJS module instance (no dual-package
+ * hazard: one copy of every class, cache, and `instanceof` check) and binds
+ * its `default` to the `UpshiftSDK` class.
+ */
+import cjs from '../lib/index.js';
+
+export * from '../lib/index.js';
+export default cjs.default;

package/lib/abis/KycRegistry.d.ts

@@ -0,0 +1,109 @@
+/** ABI for the Upshift `KycRegistry` (one per chain): wallet status and record reads, the vault entry/exit checks, and the check-side errors. */
+export declare const ABI_KYC_REGISTRY: readonly [{
+    readonly type: "function";
+    readonly name: "statusOf";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "enum IKycRegistry.Status";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getRecord";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple";
+        readonly internalType: "struct IKycRegistry.Record";
+        readonly components: readonly [{
+            readonly name: "blocked";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }, {
+            readonly name: "verifiedAt";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "expiresAt";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }, {
+            readonly name: "revokedAt";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "canEnter";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "ok";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "canExit";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "ok";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isExempt";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "error";
+    readonly name: "KycIneligible";
+    readonly inputs: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "status";
+        readonly type: "uint8";
+        readonly internalType: "enum IKycRegistry.Status";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "WalletBlocked";
+    readonly inputs: readonly [{
+        readonly name: "wallet";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}];

package/lib/abis/KycRegistry.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ABI_KYC_REGISTRY = void 0;
+/** ABI for the Upshift `KycRegistry` (one per chain): wallet status and record reads, the vault entry/exit checks, and the check-side errors. */
+exports.ABI_KYC_REGISTRY = [
+    {
+        type: 'function',
+        name: 'statusOf',
+        inputs: [{ name: 'wallet', type: 'address', internalType: 'address' }],
+        outputs: [
+            { name: '', type: 'uint8', internalType: 'enum IKycRegistry.Status' },
+        ],
+        stateMutability: 'view',
+    },
+    {
+        type: 'function',
+        name: 'getRecord',
+        inputs: [{ name: 'wallet', type: 'address', internalType: 'address' }],
+        outputs: [
+            {
+                name: '',
+                type: 'tuple',
+                internalType: 'struct IKycRegistry.Record',
+                components: [
+                    { name: 'blocked', type: 'bool', internalType: 'bool' },
+                    { name: 'verifiedAt', type: 'uint256', internalType: 'uint256' },
+                    { name: 'expiresAt', type: 'uint256', internalType: 'uint256' },
+                    { name: 'revokedAt', type: 'uint256', internalType: 'uint256' },
+                ],
+            },
+        ],
+        stateMutability: 'view',
+    },
+    {
+        type: 'function',
+        name: 'canEnter',
+        inputs: [{ name: 'addr', type: 'address', internalType: 'address' }],
+        outputs: [{ name: 'ok', type: 'bool', internalType: 'bool' }],
+        stateMutability: 'view',
+    },
+    {
+        type: 'function',
+        name: 'canExit',
+        inputs: [{ name: 'addr', type: 'address', internalType: 'address' }],
+        outputs: [{ name: 'ok', type: 'bool', internalType: 'bool' }],
+        stateMutability: 'view',
+    },
+    {
+        type: 'function',
+        name: 'isExempt',
+        inputs: [{ name: 'addr', type: 'address', internalType: 'address' }],
+        outputs: [{ name: '', type: 'bool', internalType: 'bool' }],
+        stateMutability: 'view',
+    },
+    {
+        type: 'error',
+        name: 'KycIneligible',
+        inputs: [
+            { name: 'addr', type: 'address', internalType: 'address' },
+            {
+                name: 'status',
+                type: 'uint8',
+                internalType: 'enum IKycRegistry.Status',
+            },
+        ],
+    },
+    {
+        type: 'error',
+        name: 'WalletBlocked',
+        inputs: [{ name: 'wallet', type: 'address', internalType: 'address' }],
+    },
+];
+//# sourceMappingURL=KycRegistry.js.map

package/lib/abis/index.d.ts

@@ -32,3 +32,4 @@ export * from './TokenizedVaultV2SenderAllocationWhitelist';
 export * from './RwaRedeemSubaccount';
 export * from './OFT';
 export * from './SwapRouter';
+export * from './KycRegistry';

package/lib/abis/index.js

@@ -48,4 +48,5 @@ __exportStar(require("./TokenizedVaultV2SenderAllocationWhitelist"), exports);
 __exportStar(require("./RwaRedeemSubaccount"), exports);
 __exportStar(require("./OFT"), exports);
 __exportStar(require("./SwapRouter"), exports);
+__exportStar(require("./KycRegistry"), exports);
 //# sourceMappingURL=index.js.map