@upshiftfinance/sdk 0.0.0-stage → 0.2.0

package/lib/types/vaults.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwapRouterVaultType = exports.VaultRedemptionStatus = void 0;
+var VaultRedemptionStatus;
+(function (VaultRedemptionStatus) {
+    VaultRedemptionStatus["AWAITING_COOLDOWN"] = "awaiting_cooldown";
+    VaultRedemptionStatus["READY_TO_CLAIM"] = "ready_to_claim";
+    /**
+     * Solana withdrawal queue only: the request's fulfillment window has closed.
+     * It can no longer be claimed, only cancelled, which returns its shares.
+     */
+    VaultRedemptionStatus["EXPIRED"] = "expired";
+})(VaultRedemptionStatus || (exports.VaultRedemptionStatus = VaultRedemptionStatus = {}));
+/**
+ * Numeric vault-type tag used by the on-chain `SwapRouter` to branch between
+ * the ERC-4626 (`deposit(uint256, address)`) and multi-asset
+ * (`deposit(address, uint256, address)`) deposit interfaces.
+ *
+ * Values match the contract's `VAULT_TYPE_ERC4626` / `VAULT_TYPE_TOKENIZED_VAULT_V2`
+ * constants exactly. The v2 router has no vault registry, so the caller passes
+ * this on every deposit. SDK callers normally do not pass it: the SDK derives
+ * it from the vault version (a multi-asset `evm-2` vault is
+ * `TokenizedVaultV2`, any other EVM vault `ERC4626`).
+ */
+var SwapRouterVaultType;
+(function (SwapRouterVaultType) {
+    SwapRouterVaultType[SwapRouterVaultType["ERC4626"] = 1] = "ERC4626";
+    SwapRouterVaultType[SwapRouterVaultType["TokenizedVaultV2"] = 2] = "TokenizedVaultV2";
+})(SwapRouterVaultType || (exports.SwapRouterVaultType = SwapRouterVaultType = {}));
+//# sourceMappingURL=vaults.js.map

package/lib/types/web3.d.ts

@@ -0,0 +1,100 @@
+import type { Commitment } from '@solana/web3.js';
+import type { Signer, Provider } from 'ethers';
+export type IAddress = `0x${string}`;
+/**
+ * Address type for vault contracts across all supported chains.
+ * EVM vaults use `0x`-prefixed hex addresses, Solana vaults use base58,
+ * and Stellar vaults use 56-character base32 addresses (G/C prefix).
+ *
+ * Use this instead of `IAddress` when the address may belong to any chain.
+ */
+export type VaultAddress = string;
+export type IChainId = number;
+export type ChainType = 'evm' | 'solana' | 'sui' | 'stellar';
+/** Runtime type guard for ChainType values (e.g. at API deserialization boundaries). */
+export declare function isChainType(value: unknown): value is ChainType;
+export type IChainObj = {
+    chainId: number;
+    name: string;
+    explorer: string;
+};
+export type INormalizedNumber = {
+    normalized: string;
+    raw: string;
+};
+export type IExplorerType = 'tx' | 'address' | 'token';
+export type IContractRunner = Signer | Provider;
+export type IProvidersConfig = Partial<Record<IChainId, string>>;
+export type IInfuraOptions = {
+    chainId: IChainId;
+    apiKey: string;
+};
+export type ISolanaNetwork = 'devnet' | 'mainnet-beta' | 'testnet' | 'localnet';
+export type IStellarNetwork = 'mainnet' | 'testnet';
+/** Sui network a vault lives on; matches the backend's `sui_vault_metadata.network_name`. */
+export type ISuiNetwork = 'mainnet' | 'testnet';
+export interface ISolanaConfig {
+    rpcUrl: string;
+    network: ISolanaNetwork;
+    /**
+     * Commitment for every Solana read *and* for the confirmation of every
+     * Solana write, so the two always describe the same chain state.
+     *
+     * Defaults to `'finalized'` — unchanged from the commitment the SDK has
+     * always inherited from the RPC. Pass `'confirmed'` for a markedly faster
+     * round trip (seconds rather than tens of seconds), accepting that the state
+     * you act on can still, in principle, be rolled back.
+     *
+     * Only read from this object. Configuring Solana through the legacy
+     * `providers` map instead leaves the commitment at its default, since this
+     * type requires `rpcUrl` and `network` alongside it.
+     */
+    commitment?: Commitment;
+}
+/**
+ * Stellar-specific configuration for `new UpshiftSDK({ stellar })`. All
+ * fields are optional — omit it entirely to target Stellar mainnet through the
+ * SDK's built-in public Soroban RPC endpoints.
+ */
+export interface IStellarConfig {
+    /**
+     * Override Soroban RPC endpoint (e.g. a consumer's keyed Alchemy URL). When
+     * set it becomes the primary, with the SDK's built-in public endpoints kept
+     * behind it as failover. Optional — omit to use the public endpoints.
+     */
+    rpcUrl?: string;
+    /** Stellar network; defaults to mainnet when omitted. */
+    network?: IStellarNetwork;
+}
+/**
+ * Sui-specific configuration for `new UpshiftSDK({ sui })`. All fields are
+ * optional — omit it entirely to target Sui mainnet.
+ */
+export interface ISuiConfig {
+    /**
+     * Override Sui gRPC endpoint (e.g. a consumer's keyed provider URL). It must
+     * serve gRPC-web, which the SDK uses so the same code runs in browsers. When
+     * set it becomes the primary, with the SDK's built-in public fullnode kept
+     * behind it as failover. Optional — omit to use the public fullnode.
+     */
+    rpcUrl?: string;
+    /** Sui network; defaults to `'mainnet'` when omitted. */
+    network?: ISuiNetwork;
+    /**
+     * Latest published ID of the `upshift_vault` Move package — the ID move calls
+     * target. Overrides the SDK's default for `network`; required until the SDK
+     * ships one. Long form: `0x` + 64 hex chars.
+     */
+    packageId?: string;
+    /**
+     * Original (first-published) ID of the `upshift_vault` package. Move types
+     * keep it across upgrades, so it names the vault's on-chain type. Overrides
+     * the SDK's default for `network`; required until the SDK ships one.
+     */
+    originalPackageId?: string;
+    /**
+     * Object ID of the shared `upshift_vault::registry::Registry`. Overrides the
+     * SDK's default for `network`; required until the SDK ships one.
+     */
+    registryId?: string;
+}

package/lib/types/web3.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isChainType = isChainType;
+const VALID_CHAIN_TYPES = new Set([
+    'evm',
+    'solana',
+    'sui',
+    'stellar',
+]);
+/** Runtime type guard for ChainType values (e.g. at API deserialization boundaries). */
+function isChainType(value) {
+    return typeof value === 'string' && VALID_CHAIN_TYPES.has(value);
+}
+//# sourceMappingURL=web3.js.map