@upshiftfinance/sdk 0.0.0-stage → 0.2.0

package/lib/adapters/sui/constants.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUI_VAULT_CONTRACTS = exports.SUI_GRPC_URLS = exports.SUI_COIN_REGISTRY_ID = exports.SUI_CLOCK_ID = exports.SUI_CHAIN_ID = void 0;
+// Canonical definition lives in `core/constants/web3.ts` so `core/` can
+// recognise the Sui chain ID without importing the adapter layer. Re-exported
+// here to keep `adapters/sui/constants` import sites unchanged.
+var web3_1 = require("../../core/constants/web3");
+Object.defineProperty(exports, "SUI_CHAIN_ID", { enumerable: true, get: function () { return web3_1.SUI_CHAIN_ID; } });
+/** Sui's shared `Clock` system object, passed to time-dependent vault calls. */
+exports.SUI_CLOCK_ID = '0x6';
+/** Sui's shared `CoinRegistry` system object (coin metadata / currencies). */
+exports.SUI_COIN_REGISTRY_ID = '0xc';
+/**
+ * Mysten's public fullnodes, which serve gRPC-web. The SDK talks gRPC-web so
+ * the same code runs in browsers; a consumer `rpcUrl` goes in front of these as
+ * the primary (see `resolveSuiNetworkConfig`).
+ */
+exports.SUI_GRPC_URLS = {
+    mainnet: 'https://fullnode.mainnet.sui.io:443',
+    testnet: 'https://fullnode.testnet.sui.io:443',
+};
+/**
+ * Built-in contract IDs per network. Empty until the contracts are published
+ * there: until then callers pass `packageId`, `originalPackageId` and
+ * `registryId` through `new UpshiftSDK({ sui })`.
+ */
+exports.SUI_VAULT_CONTRACTS = {
+    mainnet: {},
+    testnet: {},
+};
+//# sourceMappingURL=constants.js.map

package/lib/adapters/sui/index.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Sui Adapter for Upshift SDK
+ *
+ * @module SuiAdapter
+ */
+import type { ISuiConfig, ISuiNetwork } from '../../types';
+import * as SuiClient from './client';
+import * as SuiConstants from './constants';
+import * as SuiTargets from './targets';
+import * as SuiUtils from './utils';
+export declare const Sui: {
+    utils: typeof SuiUtils;
+    constants: typeof SuiConstants;
+    client: typeof SuiClient;
+    targets: typeof SuiTargets;
+};
+/**
+ * Sui Adapter for Upshift SDK.
+ *
+ * Holds the Sui configuration passed to `new UpshiftSDK({ sui })` and the Sui
+ * chain-identity helpers. It makes no network calls.
+ *
+ * @example
+ * ```ts
+ * const sdk = new UpshiftSDK({ appName: 'my-app', sui: { network: 'testnet' } });
+ * sdk.sui.network; // 'testnet'
+ * sdk.sui.isSuiAddress(vault.address);
+ * ```
+ */
+declare class SuiAdapter {
+    private readonly _config;
+    /**
+     * @param config - Optional Sui settings; omit to target Sui mainnet.
+     */
+    constructor(config?: ISuiConfig);
+    /** The SDK's Sui chain ID, `-2` (same as the backend's `chain` for Sui vaults). */
+    get chainId(): number;
+    /** Configured Sui network; `'mainnet'` unless the SDK was built with another. */
+    get network(): ISuiNetwork;
+    /** Configured RPC endpoint override, or `undefined` when none was given. */
+    get rpcUrl(): string | undefined;
+    /**
+     * Check whether a string is a Sui address or object ID (`0x` + 64 hex chars).
+     *
+     * @param address - Candidate address.
+     * @returns `true` for the long, 64-hex-digit form only.
+     */
+    isSuiAddress(address: string): boolean;
+    /**
+     * Check whether a chain ID is Sui's (`-2`).
+     *
+     * @param chainId - Numeric chain ID, e.g. a backend vault row's `chain`.
+     * @returns `true` only for `-2`.
+     */
+    isSuiVault(chainId: number): boolean;
+}
+export default SuiAdapter;

package/lib/adapters/sui/index.js

@@ -0,0 +1,100 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sui = void 0;
+const SuiClient = __importStar(require("./client"));
+const SuiConstants = __importStar(require("./constants"));
+const SuiTargets = __importStar(require("./targets"));
+const SuiUtils = __importStar(require("./utils"));
+exports.Sui = {
+    utils: SuiUtils,
+    constants: SuiConstants,
+    client: SuiClient,
+    targets: SuiTargets,
+};
+/**
+ * Sui Adapter for Upshift SDK.
+ *
+ * Holds the Sui configuration passed to `new UpshiftSDK({ sui })` and the Sui
+ * chain-identity helpers. It makes no network calls.
+ *
+ * @example
+ * ```ts
+ * const sdk = new UpshiftSDK({ appName: 'my-app', sui: { network: 'testnet' } });
+ * sdk.sui.network; // 'testnet'
+ * sdk.sui.isSuiAddress(vault.address);
+ * ```
+ */
+class SuiAdapter {
+    _config;
+    /**
+     * @param config - Optional Sui settings; omit to target Sui mainnet.
+     */
+    constructor(config = {}) {
+        this._config = { ...config };
+    }
+    /** The SDK's Sui chain ID, `-2` (same as the backend's `chain` for Sui vaults). */
+    get chainId() {
+        return SuiConstants.SUI_CHAIN_ID;
+    }
+    /** Configured Sui network; `'mainnet'` unless the SDK was built with another. */
+    get network() {
+        return this._config.network ?? 'mainnet';
+    }
+    /** Configured RPC endpoint override, or `undefined` when none was given. */
+    get rpcUrl() {
+        return this._config.rpcUrl;
+    }
+    /**
+     * Check whether a string is a Sui address or object ID (`0x` + 64 hex chars).
+     *
+     * @param address - Candidate address.
+     * @returns `true` for the long, 64-hex-digit form only.
+     */
+    isSuiAddress(address) {
+        return SuiUtils.isSuiAddress(address);
+    }
+    /**
+     * Check whether a chain ID is Sui's (`-2`).
+     *
+     * @param chainId - Numeric chain ID, e.g. a backend vault row's `chain`.
+     * @returns `true` only for `-2`.
+     */
+    isSuiVault(chainId) {
+        return SuiUtils.isSuiVault(chainId);
+    }
+}
+exports.default = SuiAdapter;
+//# sourceMappingURL=index.js.map

package/lib/adapters/sui/targets.d.ts

@@ -0,0 +1,171 @@
+/**
+ * Move-call targets for the Upshift Sui vault package.
+ *
+ * One table names every package function the SDK calls, together with the Move
+ * parameter list it expects. The target helpers read the module and function
+ * from it, and the contracts drift check
+ * (`packages/sdk/scripts/check-sui-contracts-drift.mjs`) compares the parameter
+ * lists with the Move sources at the commit pinned in
+ * `packages/sdk/.sui-vaults-contracts-pin`, so a contract change that would
+ * break a call fails CI instead of a user's transaction.
+ *
+ * @module SuiTargets
+ */
+import type { ISuiConfig } from '../../types';
+import { type ISuiVaultContracts } from './constants';
+/** A package function the SDK calls, with the Move signature it relies on. */
+export interface ISuiVaultTargetSpec {
+    /** Move module inside the `upshift_vault` package. */
+    module: 'coin_entry' | 'vault' | 'withdrawal';
+    /** Function name inside `module`. */
+    function: string;
+    /**
+     * Parameter types as written in the Move source, without names (for example
+     * `&mut Vault<Asset, Share>`). Checked against the pinned contracts.
+     */
+    params: readonly string[];
+}
+/**
+ * Every `upshift_vault` function the SDK calls, keyed by a stable name.
+ *
+ * Vault functions take the `<Asset, Share>` type arguments built by
+ * {@link suiVaultTypeArguments}; `withdrawal::share` takes `<Share>` only.
+ */
+export declare const SUI_VAULT_TARGETS: {
+    readonly deposit: {
+        readonly module: "coin_entry";
+        readonly function: "deposit";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "Coin<Asset>", "&mut TxContext"];
+    };
+    readonly depositChecked: {
+        readonly module: "coin_entry";
+        readonly function: "deposit_checked";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "Coin<Asset>", "u64", "&mut TxContext"];
+    };
+    readonly redeem: {
+        readonly module: "coin_entry";
+        readonly function: "redeem";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "Coin<Share>", "&mut TxContext"];
+    };
+    readonly redeemChecked: {
+        readonly module: "coin_entry";
+        readonly function: "redeem_checked";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "Coin<Share>", "u64", "&mut TxContext"];
+    };
+    readonly requestWithdrawal: {
+        readonly module: "coin_entry";
+        readonly function: "request_withdrawal";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "Coin<Share>", "u64", "address", "Option<address>", "&Clock", "&TxContext"];
+    };
+    readonly cancelWithdrawal: {
+        readonly module: "coin_entry";
+        readonly function: "cancel_withdrawal";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "WithdrawalRequest<Share>", "&mut TxContext"];
+    };
+    readonly shareWithdrawalRequest: {
+        readonly module: "withdrawal";
+        readonly function: "share";
+        readonly params: readonly ["WithdrawalRequest<Share>"];
+    };
+    readonly finalizeWithdrawal: {
+        readonly module: "vault";
+        readonly function: "finalize_withdrawal";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "WithdrawalRequest<Share>", "&Clock", "&TxContext"];
+    };
+    readonly finalizeWithdrawalChecked: {
+        readonly module: "vault";
+        readonly function: "finalize_withdrawal_checked";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "WithdrawalRequest<Share>", "u64", "&Clock", "&TxContext"];
+    };
+    readonly chargeManagementFee: {
+        readonly module: "vault";
+        readonly function: "charge_management_fee";
+        readonly params: readonly ["&mut Vault<Asset, Share>", "&Registry", "&Clock"];
+    };
+    readonly totalAssets: {
+        readonly module: "vault";
+        readonly function: "total_assets";
+        readonly params: readonly ["&Vault<Asset, Share>", "&Registry"];
+    };
+    readonly totalSupply: {
+        readonly module: "vault";
+        readonly function: "total_supply";
+        readonly params: readonly ["&Vault<Asset, Share>"];
+    };
+    readonly sharePrice: {
+        readonly module: "vault";
+        readonly function: "share_price";
+        readonly params: readonly ["&Vault<Asset, Share>", "&Registry"];
+    };
+    readonly previewDeposit: {
+        readonly module: "vault";
+        readonly function: "preview_deposit";
+        readonly params: readonly ["&Vault<Asset, Share>", "&Registry", "u64"];
+    };
+    readonly previewRedemption: {
+        readonly module: "vault";
+        readonly function: "preview_redemption";
+        readonly params: readonly ["&Vault<Asset, Share>", "&Registry", "u64", "bool"];
+    };
+};
+/** Name of a package function the SDK calls; a key of {@link SUI_VAULT_TARGETS}. */
+export type ISuiVaultTarget = keyof typeof SUI_VAULT_TARGETS;
+/** A fully qualified move-call target: `<package>::<module>::<function>`. */
+export type ISuiMoveCallTarget = `${string}::${string}::${string}`;
+/**
+ * Resolve the Upshift vault contract IDs for a Sui config: each `sui` override
+ * wins over the SDK's built-in ID for the network.
+ *
+ * @param config - The `sui` config passed to `new UpshiftSDK({ sui })`.
+ * @returns The package, original package and Registry IDs for the network.
+ * @throws {@link UpshiftValidationError} (`INVALID_INPUT`) when an ID is
+ *   missing for the network — the SDK ships none until the contracts are
+ *   published there — or is not a long-form Sui ID (`0x` + 64 hex chars).
+ * @example
+ * ```ts
+ * const contracts = resolveSuiVaultContracts({
+ *   network: 'testnet',
+ *   packageId: '0x…',
+ *   originalPackageId: '0x…',
+ *   registryId: '0x…',
+ * });
+ * ```
+ */
+export declare function resolveSuiVaultContracts(config?: ISuiConfig): ISuiVaultContracts;
+/**
+ * Build the move-call target for a package function, on the latest package.
+ *
+ * @param contracts - Contract IDs from {@link resolveSuiVaultContracts}.
+ * @param target - Which package function to call.
+ * @returns `<packageId>::<module>::<function>`, ready for `tx.moveCall`.
+ * @example
+ * ```ts
+ * tx.moveCall({
+ *   target: suiMoveCallTarget(contracts, 'deposit'),
+ *   typeArguments: suiVaultTypeArguments(assetType, shareType),
+ *   arguments: [tx.object(vaultId), tx.object(contracts.registryId), coin],
+ * });
+ * ```
+ */
+export declare function suiMoveCallTarget(contracts: Pick<ISuiVaultContracts, 'packageId'>, target: ISuiVaultTarget): ISuiMoveCallTarget;
+/**
+ * Type arguments for a vault function: `[Asset, Share]`, in that order.
+ *
+ * @param assetCoinType - Move type of the deposit coin, e.g. `0x…::usdc::USDC`.
+ * @param shareCoinType - Move type of the vault's share coin.
+ * @returns `[assetCoinType, shareCoinType]`.
+ */
+export declare function suiVaultTypeArguments(assetCoinType: string, shareCoinType: string): [string, string];
+/**
+ * The on-chain Move type of a vault object, which names the original package.
+ *
+ * Matches the `type` a fullnode reports for the object: type arguments joined
+ * by a bare comma, as the node prints them. Pass coin types in the node's
+ * long form (`0x` + 64 hex chars) for an exact string match.
+ *
+ * @param contracts - Contract IDs from {@link resolveSuiVaultContracts}.
+ * @param assetCoinType - Move type of the deposit coin.
+ * @param shareCoinType - Move type of the vault's share coin.
+ * @returns `<originalPackageId>::vault::Vault<Asset,Share>`.
+ */
+export declare function suiVaultObjectType(contracts: Pick<ISuiVaultContracts, 'originalPackageId'>, assetCoinType: string, shareCoinType: string): string;

package/lib/adapters/sui/targets.js

@@ -0,0 +1,225 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUI_VAULT_TARGETS = void 0;
+exports.resolveSuiVaultContracts = resolveSuiVaultContracts;
+exports.suiMoveCallTarget = suiMoveCallTarget;
+exports.suiVaultTypeArguments = suiVaultTypeArguments;
+exports.suiVaultObjectType = suiVaultObjectType;
+const errors_1 = require("../../core/errors");
+const chain_address_1 = require("../../core/helpers/chain-address");
+const constants_1 = require("./constants");
+/**
+ * Every `upshift_vault` function the SDK calls, keyed by a stable name.
+ *
+ * Vault functions take the `<Asset, Share>` type arguments built by
+ * {@link suiVaultTypeArguments}; `withdrawal::share` takes `<Share>` only.
+ */
+exports.SUI_VAULT_TARGETS = {
+    deposit: {
+        module: 'coin_entry',
+        function: 'deposit',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'Coin<Asset>',
+            '&mut TxContext',
+        ],
+    },
+    depositChecked: {
+        module: 'coin_entry',
+        function: 'deposit_checked',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'Coin<Asset>',
+            'u64',
+            '&mut TxContext',
+        ],
+    },
+    redeem: {
+        module: 'coin_entry',
+        function: 'redeem',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'Coin<Share>',
+            '&mut TxContext',
+        ],
+    },
+    redeemChecked: {
+        module: 'coin_entry',
+        function: 'redeem_checked',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'Coin<Share>',
+            'u64',
+            '&mut TxContext',
+        ],
+    },
+    requestWithdrawal: {
+        module: 'coin_entry',
+        function: 'request_withdrawal',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'Coin<Share>',
+            'u64',
+            'address',
+            'Option<address>',
+            '&Clock',
+            '&TxContext',
+        ],
+    },
+    cancelWithdrawal: {
+        module: 'coin_entry',
+        function: 'cancel_withdrawal',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'WithdrawalRequest<Share>',
+            '&mut TxContext',
+        ],
+    },
+    shareWithdrawalRequest: {
+        module: 'withdrawal',
+        function: 'share',
+        params: ['WithdrawalRequest<Share>'],
+    },
+    finalizeWithdrawal: {
+        module: 'vault',
+        function: 'finalize_withdrawal',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'WithdrawalRequest<Share>',
+            '&Clock',
+            '&TxContext',
+        ],
+    },
+    finalizeWithdrawalChecked: {
+        module: 'vault',
+        function: 'finalize_withdrawal_checked',
+        params: [
+            '&mut Vault<Asset, Share>',
+            '&Registry',
+            'WithdrawalRequest<Share>',
+            'u64',
+            '&Clock',
+            '&TxContext',
+        ],
+    },
+    chargeManagementFee: {
+        module: 'vault',
+        function: 'charge_management_fee',
+        params: ['&mut Vault<Asset, Share>', '&Registry', '&Clock'],
+    },
+    totalAssets: {
+        module: 'vault',
+        function: 'total_assets',
+        params: ['&Vault<Asset, Share>', '&Registry'],
+    },
+    totalSupply: {
+        module: 'vault',
+        function: 'total_supply',
+        params: ['&Vault<Asset, Share>'],
+    },
+    sharePrice: {
+        module: 'vault',
+        function: 'share_price',
+        params: ['&Vault<Asset, Share>', '&Registry'],
+    },
+    previewDeposit: {
+        module: 'vault',
+        function: 'preview_deposit',
+        params: ['&Vault<Asset, Share>', '&Registry', 'u64'],
+    },
+    previewRedemption: {
+        module: 'vault',
+        function: 'preview_redemption',
+        params: ['&Vault<Asset, Share>', '&Registry', 'u64', 'bool'],
+    },
+};
+/**
+ * Resolve the Upshift vault contract IDs for a Sui config: each `sui` override
+ * wins over the SDK's built-in ID for the network.
+ *
+ * @param config - The `sui` config passed to `new UpshiftSDK({ sui })`.
+ * @returns The package, original package and Registry IDs for the network.
+ * @throws {@link UpshiftValidationError} (`INVALID_INPUT`) when an ID is
+ *   missing for the network — the SDK ships none until the contracts are
+ *   published there — or is not a long-form Sui ID (`0x` + 64 hex chars).
+ * @example
+ * ```ts
+ * const contracts = resolveSuiVaultContracts({
+ *   network: 'testnet',
+ *   packageId: '0x…',
+ *   originalPackageId: '0x…',
+ *   registryId: '0x…',
+ * });
+ * ```
+ */
+function resolveSuiVaultContracts(config = {}) {
+    const network = config.network ?? 'mainnet';
+    const defaults = constants_1.SUI_VAULT_CONTRACTS[network];
+    const resolved = {
+        packageId: config.packageId ?? defaults.packageId,
+        originalPackageId: config.originalPackageId ?? defaults.originalPackageId,
+        registryId: config.registryId ?? defaults.registryId,
+    };
+    for (const [field, value] of Object.entries(resolved)) {
+        if (!value) {
+            throw new errors_1.UpshiftValidationError('INVALID_INPUT', `Sui ${network}: no ${field} for the Upshift vault contracts. ` +
+                `Pass it as \`sui.${field}\` in new UpshiftSDK({ sui }).`, { context: { network, field } });
+        }
+        if (!(0, chain_address_1.isSuiAddress)(value)) {
+            throw new errors_1.UpshiftValidationError('INVALID_INPUT', `Sui ${network}: ${field} must be a long-form Sui ID (0x + 64 hex chars).`, { context: { network, field } });
+        }
+    }
+    return resolved;
+}
+/**
+ * Build the move-call target for a package function, on the latest package.
+ *
+ * @param contracts - Contract IDs from {@link resolveSuiVaultContracts}.
+ * @param target - Which package function to call.
+ * @returns `<packageId>::<module>::<function>`, ready for `tx.moveCall`.
+ * @example
+ * ```ts
+ * tx.moveCall({
+ *   target: suiMoveCallTarget(contracts, 'deposit'),
+ *   typeArguments: suiVaultTypeArguments(assetType, shareType),
+ *   arguments: [tx.object(vaultId), tx.object(contracts.registryId), coin],
+ * });
+ * ```
+ */
+function suiMoveCallTarget(contracts, target) {
+    const spec = exports.SUI_VAULT_TARGETS[target];
+    return `${contracts.packageId}::${spec.module}::${spec.function}`;
+}
+/**
+ * Type arguments for a vault function: `[Asset, Share]`, in that order.
+ *
+ * @param assetCoinType - Move type of the deposit coin, e.g. `0x…::usdc::USDC`.
+ * @param shareCoinType - Move type of the vault's share coin.
+ * @returns `[assetCoinType, shareCoinType]`.
+ */
+function suiVaultTypeArguments(assetCoinType, shareCoinType) {
+    return [assetCoinType, shareCoinType];
+}
+/**
+ * The on-chain Move type of a vault object, which names the original package.
+ *
+ * Matches the `type` a fullnode reports for the object: type arguments joined
+ * by a bare comma, as the node prints them. Pass coin types in the node's
+ * long form (`0x` + 64 hex chars) for an exact string match.
+ *
+ * @param contracts - Contract IDs from {@link resolveSuiVaultContracts}.
+ * @param assetCoinType - Move type of the deposit coin.
+ * @param shareCoinType - Move type of the vault's share coin.
+ * @returns `<originalPackageId>::vault::Vault<Asset,Share>`.
+ */
+function suiVaultObjectType(contracts, assetCoinType, shareCoinType) {
+    return `${contracts.originalPackageId}::vault::Vault<${assetCoinType},${shareCoinType}>`;
+}
+//# sourceMappingURL=targets.js.map

package/lib/adapters/sui/utils.d.ts

@@ -0,0 +1,8 @@
+export { isSuiAddress } from '../../core/helpers/chain-address';
+/**
+ * Whether `chainId` is the SDK's Sui chain ID ({@link SUI_CHAIN_ID}, `-2`).
+ *
+ * @param chainId - Numeric chain ID, e.g. a backend vault row's `chain`.
+ * @returns `true` only for `-2`.
+ */
+export declare function isSuiVault(chainId: number): boolean;

package/lib/adapters/sui/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSuiAddress = void 0;
+exports.isSuiVault = isSuiVault;
+const constants_1 = require("./constants");
+var chain_address_1 = require("../../core/helpers/chain-address");
+Object.defineProperty(exports, "isSuiAddress", { enumerable: true, get: function () { return chain_address_1.isSuiAddress; } });
+/**
+ * Whether `chainId` is the SDK's Sui chain ID ({@link SUI_CHAIN_ID}, `-2`).
+ *
+ * @param chainId - Numeric chain ID, e.g. a backend vault row's `chain`.
+ * @returns `true` only for `-2`.
+ */
+function isSuiVault(chainId) {
+    return chainId === constants_1.SUI_CHAIN_ID;
+}
+//# sourceMappingURL=utils.js.map

package/lib/core/analytics/app-name.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Validate an `appName` slug at SDK boundary points (the `UpshiftSDK`
+ * constructor and the standalone {@link initializeSentry} entry point).
+ *
+ * Rules (kept intentionally narrow so the value is safe to use as a Sentry
+ * tag, an HTTP header value, and a filesystem-safe identifier — this is
+ * why we accept slugs only, not display names):
+ *  - non-empty after trim
+ *  - 3..64 characters
+ *  - only `[a-zA-Z0-9._-]`
+ *  - not shaped like an EVM address (`0x` + 40 hex chars) — an address
+ *    passes the character rules but is a high-cardinality wallet
+ *    identifier, not an application name. This also catches callers of
+ *    `initializeSentry` still passing the pre-v9 positional argument
+ *    order, where a wallet address occupied the slot `appName` now holds.
+ *
+ * Throws a descriptive `UpshiftValidationError` (code `INVALID_INPUT`) that
+ * names the failed rule and includes a remediation hint pointing at the
+ * docs link.
+ *
+ * @param value - The candidate app name, as received from the caller.
+ * @returns The trimmed, validated slug.
+ * @throws UpshiftValidationError when the value is missing, empty,
+ *   mis-typed, out of the 3–64 length range, contains disallowed
+ *   characters, or is shaped like an EVM address.
+ */
+export declare function validateAppName(value: unknown): string;