@lombard.finance/sdk-common 4.0.0 → 4.1.0-canary.11

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var u=Object.create;var s=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var d=Object.getOwnPropertyNames;var l=Object.getPrototypeOf,b=Object.prototype.hasOwnProperty;var S=(t,i,e,c)=>{if(i&&typeof i=="object"||typeof i=="function")for(let n of d(i))!b.call(t,n)&&n!==e&&s(t,n,{get:()=>i[n],enumerable:!(c=p(i,n))||c.enumerable});return t};var a=(t,i,e)=>(e=t!=null?u(l(t)):{},S(i||!t||!t.__esModule?s(e,"default",{value:t,enumerable:!0}):e,t));Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o={prod:"prod",testnet:"testnet",stage:"stage",dev:"dev",ibc:"ibc"},g=o.prod,y=["evm","bitcoin","solana","sui","starknet"];let r=null;const E=async()=>{try{const t=await import("bitcoinjs-lib"),i=await import("@bitcoinerlab/secp256k1");try{t.initEccLib(i)}catch(e){if(!/already initialized/i.test(String(e)))throw e}return t}catch(t){throw r=null,new Error(`Failed to initialize bitcoinjs-lib: ${t instanceof Error?t.message:String(t)}. Ensure bitcoinjs-lib and @bitcoinerlab/secp256k1 peer dependencies are installed.`)}},v=async()=>(r||(r=E()),r);async function w(t,i=o.prod){const e=await v();return`0x${e.address.toOutputScript(t,i===o.prod?e.networks.bitcoin:e.networks.testnet).toString("hex")}`}exports.DEFAULT_ENV=g;exports.Env=o;exports.ProviderKeys=y;exports.getOutputScript=w;
+"use strict";var p=Object.create;var s=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var d=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,l=Object.prototype.hasOwnProperty;var E=(t,i,e,c)=>{if(i&&typeof i=="object"||typeof i=="function")for(let n of d(i))!l.call(t,n)&&n!==e&&s(t,n,{get:()=>i[n],enumerable:!(c=u(i,n))||c.enumerable});return t};var a=(t,i,e)=>(e=t!=null?p(S(t)):{},E(i||!t||!t.__esModule?s(e,"default",{value:t,enumerable:!0}):e,t));Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o={prod:"prod",testnet:"testnet",stage:"stage",dev:"dev",ibc:"ibc"},T=o.prod,I=["evm","bitcoin","solana","sui","starknet"];let r=null;const b=async()=>{try{const t=await import("bitcoinjs-lib"),i=await import("@bitcoinerlab/secp256k1");try{t.initEccLib(i)}catch(e){if(!/already initialized/i.test(String(e)))throw e}return t}catch(t){throw r=null,new Error(`Failed to initialize bitcoinjs-lib: ${t instanceof Error?t.message:String(t)}. Ensure bitcoinjs-lib and @bitcoinerlab/secp256k1 peer dependencies are installed.`)}},A=async()=>(r||(r=b()),r);async function g(t,i=o.prod){const e=await A();return`0x${e.address.toOutputScript(t,i===o.prod?e.networks.bitcoin:e.networks.testnet).toString("hex")}`}const _={syncComplete:"VERIFICATION_STATUS_SYNC_COMPLETE",pending:"VERIFICATION_STATUS_PENDING",completeValid:"VERIFICATION_STATUS_COMPLETE_VALID"};exports.DEFAULT_ENV=T;exports.Env=o;exports.ProviderKeys=I;exports.VERIFICATION_STATUS=_;exports.getOutputScript=g;

package/dist/index.js

@@ -1,10 +1,10 @@
-const r = {
+const o = {
   prod: "prod",
   testnet: "testnet",
   stage: "stage",
   dev: "dev",
   ibc: "ibc"
-}, p = r.prod, u = [
+}, p = o.prod, u = [
   "evm",
   "bitcoin",
   "solana",
@@ -12,7 +12,7 @@ const r = {
   "starknet"
 ];
 let n = null;
-const o = async () => {
+const r = async () => {
   try {
     const t = await import("bitcoinjs-lib"), e = await import("@bitcoinerlab/secp256k1");
     try {
@@ -27,17 +27,26 @@ const o = async () => {
       `Failed to initialize bitcoinjs-lib: ${t instanceof Error ? t.message : String(t)}. Ensure bitcoinjs-lib and @bitcoinerlab/secp256k1 peer dependencies are installed.`
     );
   }
-}, c = async () => (n || (n = o()), n);
-async function d(t, e = r.prod) {
+}, c = async () => (n || (n = r()), n);
+async function d(t, e = o.prod) {
   const i = await c();
   return `0x${i.address.toOutputScript(
     t,
-    e === r.prod ? i.networks.bitcoin : i.networks.testnet
+    e === o.prod ? i.networks.bitcoin : i.networks.testnet
   ).toString("hex")}`;
 }
+const l = {
+  /** Synchronous verification finished — JWT is in this same response. */
+  syncComplete: "VERIFICATION_STATUS_SYNC_COMPLETE",
+  /** Async verification started — poll with the returned `verification_id`. */
+  pending: "VERIFICATION_STATUS_PENDING",
+  /** Async verification succeeded — JWT is in the poll response. */
+  completeValid: "VERIFICATION_STATUS_COMPLETE_VALID"
+};
 export {
   p as DEFAULT_ENV,
-  r as Env,
+  o as Env,
   u as ProviderKeys,
+  l as VERIFICATION_STATUS,
   d as getOutputScript
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lombard.finance/sdk-common",
-  "version": "4.0.0",
+  "version": "4.1.0-canary.11",
   "description": "Shared utilities and types for the Lombard SDK packages",
   "exports": {
     ".": {

package/src/modules.ts

@@ -72,8 +72,10 @@ export interface SdkModule<TId extends string = string, TService = unknown> {
  * }
  * ```
  */
-export interface ChainModule<TChain extends string = string, TService = unknown>
-  extends SdkModule<TChain, TService> {
+export interface ChainModule<
+  TChain extends string = string,
+  TService = unknown,
+> extends SdkModule<TChain, TService> {
   /** Chain type this module provides services for */
   chain: TChain;
 }
@@ -94,8 +96,10 @@ export type ModuleId<TModule> =
 /**
  * Extract service type from a module by ID
  */
-export type ServiceOf<TModule extends SdkModule<string, unknown>, TId extends string> =
-  TModule extends SdkModule<TId, infer TService> ? TService : never;
+export type ServiceOf<
+  TModule extends SdkModule<string, unknown>,
+  TId extends string,
+> = TModule extends SdkModule<TId, infer TService> ? TService : never;
 
 /**
  * @deprecated Use ServiceOf instead

package/src/services/auth.ts

@@ -0,0 +1,127 @@
+/**
+ * Wallet Auth Service
+ *
+ * Contract for the wallet-based authentication flow used by the Lombard
+ * backend (v2):
+ *
+ *   1. `requestChallenge` — server returns a payload the wallet must sign.
+ *   2. `verifySignature`  — server validates the signature and issues a JWT.
+ *   3. `revokeToken`      — invalidates a JWT server-side (e.g. on disconnect).
+ *
+ * Signing the challenge with the user's wallet is intentionally NOT part of
+ * this contract — signing primitives are chain-specific and live in the
+ * corresponding chain SDK packages.
+ */
+
+/**
+ * Supported chain identifiers accepted by the auth API.
+ *
+ * Free-form string to stay open to chains added on the backend before the
+ * SDK is updated. Common values: `'ethereum'`, `'solana'`, `'sui'`,
+ * `'starknet'`, `'cosmos'`.
+ */
+export type WalletAuthChain = string;
+
+export interface WalletChallengeRequest {
+  /** Wallet address performing the auth flow. */
+  address: string;
+  /** Chain the address belongs to. */
+  chain: WalletAuthChain;
+}
+
+export interface WalletChallengeResponse {
+  /** Random nonce embedded in the payload. */
+  nonce: string;
+  /** Chain-specific payload the user must sign with their wallet. */
+  payload: string;
+  /** ISO-8601 timestamp when this challenge expires. */
+  expiresAt: string;
+}
+
+export interface WalletVerifyRequest {
+  address: string;
+  /** The payload returned by `requestChallenge`. */
+  payload: string;
+  /** Signature produced by the wallet over `payload`. */
+  signature: string;
+  chain: WalletAuthChain;
+  /**
+   * Required for chains where the public key cannot be recovered from the
+   * signature (Starknet, Cosmos). Ignored elsewhere.
+   */
+  publicKey?: string;
+}
+
+/**
+ * Verification status returned by `/v2/auth/wallet/verify` and its polling
+ * endpoint. EVM EOAs / Sui / Solana verify synchronously and get a JWT
+ * immediately; EVM smart-contract wallets and Starknet verify asynchronously
+ * (the signature is checked on-chain), so the caller must poll for the JWT.
+ */
+export const VERIFICATION_STATUS = {
+  /** Synchronous verification finished — JWT is in this same response. */
+  syncComplete: 'VERIFICATION_STATUS_SYNC_COMPLETE',
+  /** Async verification started — poll with the returned `verification_id`. */
+  pending: 'VERIFICATION_STATUS_PENDING',
+  /** Async verification succeeded — JWT is in the poll response. */
+  completeValid: 'VERIFICATION_STATUS_COMPLETE_VALID',
+} as const;
+
+/** Token pair issued once verification succeeds (sync or async). */
+export interface WalletVerifyResult {
+  /** JWT bound to the verified wallet address. */
+  jwt: string;
+  /** ISO-8601 timestamp when the JWT expires. */
+  expiresAt: string;
+}
+
+/**
+ * Outcome of `POST /v2/auth/wallet/verify`: either an immediate token
+ * (`complete`, sync path) or a `verificationId` to poll while the signature is
+ * verified on-chain (`pending`, async path).
+ */
+export type WalletVerifyResponse =
+  | ({ kind: 'complete' } & WalletVerifyResult)
+  | { kind: 'pending'; verificationId: string };
+
+export interface RevokeWalletTokenRequest {
+  /** JWT to invalidate server-side. */
+  jwt: string;
+}
+
+export interface PollWalletVerificationRequest {
+  /** Id returned by `verifySignature` when the result is `pending`. */
+  verificationId: string;
+}
+
+/**
+ * Wallet auth service contract. Implementations live in `@lombard.finance/sdk`.
+ */
+export interface WalletAuthService {
+  /** Request a challenge payload for the given wallet. */
+  requestChallenge(
+    params: WalletChallengeRequest,
+  ): Promise<WalletChallengeResponse>;
+
+  /**
+   * Submit a signed challenge. Resolves with a JWT (`complete`) on the sync
+   * path, or a `verificationId` (`pending`) that must be polled via
+   * `pollVerification` on the async path.
+   */
+  verifySignature(params: WalletVerifyRequest): Promise<WalletVerifyResponse>;
+
+  /**
+   * Poll the async verification endpoint until the on-chain signature check
+   * settles, resolving with the JWT. Only needed when `verifySignature`
+   * returns a `pending` result.
+   */
+  pollVerification(
+    params: PollWalletVerificationRequest,
+  ): Promise<WalletVerifyResult>;
+
+  /**
+   * Invalidate a JWT server-side. Best-effort: implementations may swallow
+   * network errors so callers can always clear local state.
+   */
+  revokeToken(params: RevokeWalletTokenRequest): Promise<void>;
+}

package/src/services/index.ts

@@ -13,6 +13,7 @@
 
 // Core services (provided by sdk)
 export * from './api';
+export * from './auth';
 export * from './btc';
 export * from './evm';