@unifold/core 0.1.46 → 0.1.47

package/dist/index.d.mts

@@ -308,6 +308,7 @@ interface OnrampSessionRequest {
     wallet_address: string;
     subdivision_code?: string;
     redirect_url?: string;
+    external_id?: string;
 }
 interface OnrampSessionResponse {
     url: string;
@@ -754,6 +755,46 @@ declare function buildHypercoreTransaction(request: BuildHypercoreTransactionReq
  */
 declare function sendHypercoreTransaction(request: SendHypercoreTransactionRequest, publishableKey?: string): Promise<SendHypercoreTransactionResponse>;
 
+/**
+ * Generate a KSUID-like prefixed ID without external dependencies.
+ * Format: `{prefix}_{base62(4-byte-timestamp + 16-random-bytes)}` (27 chars after prefix).
+ */
+declare function generatePrefixedKSUID(prefix: string): string;
+
+/** Event types emitted by the deposit flow, following `resource.action` convention */
+declare enum DepositEventType {
+    ONRAMP_SESSION_CREATED = "onramp_session.created"
+}
+/** `data.object` payload for {@link DepositEventType.ONRAMP_SESSION_CREATED} */
+interface OnrampSessionCreatedData {
+    externalId: string;
+}
+/** Map from event type to its `data.object` shape */
+interface DepositEventDataMap {
+    [DepositEventType.ONRAMP_SESSION_CREATED]: OnrampSessionCreatedData;
+}
+/**
+ * Event envelope emitted by the deposit flow, inspired by the server-side
+ * webhook payload shape: top-level metadata (`id`, `type`, `created`) with
+ * the resource nested under `data.object`.
+ *
+ * Uses `sevt_` prefix for IDs to distinguish from backend webhook `evt_` IDs.
+ */
+type DepositEvent = {
+    [K in DepositEventType]: {
+        id: string;
+        type: K;
+        created: number;
+        data: {
+            object: DepositEventDataMap[K];
+        };
+    };
+}[DepositEventType];
+/** Convenience type for a fully-typed `onramp_session.created` event */
+type OnrampSessionCreatedEvent = Extract<DepositEvent, {
+    type: DepositEventType.ONRAMP_SESSION_CREATED;
+}>;
+
 /**
  * User IP information interface
  */
@@ -874,4 +915,4 @@ declare const i18n: {
 };
 type I18nStrings = typeof i18n;
 
-export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AutoSwapRequest, type AutoSwapResponse, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type ChainType, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type FeaturedToken, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActionType, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IpAddressResponse, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, createDepositAddress, createExchangeSession, createOnrampSession, getAddressBalance, getAddressBalances, getApiBaseUrl, getChainName, getDefaultOnrampToken, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, retrievePaymentIntent, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, useUserIp, verifyRecipientAddress };
+export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AutoSwapRequest, type AutoSwapResponse, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type ChainType, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type FeaturedToken, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActionType, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IpAddressResponse, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, createDepositAddress, createExchangeSession, createOnrampSession, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getChainName, getDefaultOnrampToken, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, retrievePaymentIntent, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, useUserIp, verifyRecipientAddress };

package/dist/index.d.ts

@@ -308,6 +308,7 @@ interface OnrampSessionRequest {
     wallet_address: string;
     subdivision_code?: string;
     redirect_url?: string;
+    external_id?: string;
 }
 interface OnrampSessionResponse {
     url: string;
@@ -754,6 +755,46 @@ declare function buildHypercoreTransaction(request: BuildHypercoreTransactionReq
  */
 declare function sendHypercoreTransaction(request: SendHypercoreTransactionRequest, publishableKey?: string): Promise<SendHypercoreTransactionResponse>;
 
+/**
+ * Generate a KSUID-like prefixed ID without external dependencies.
+ * Format: `{prefix}_{base62(4-byte-timestamp + 16-random-bytes)}` (27 chars after prefix).
+ */
+declare function generatePrefixedKSUID(prefix: string): string;
+
+/** Event types emitted by the deposit flow, following `resource.action` convention */
+declare enum DepositEventType {
+    ONRAMP_SESSION_CREATED = "onramp_session.created"
+}
+/** `data.object` payload for {@link DepositEventType.ONRAMP_SESSION_CREATED} */
+interface OnrampSessionCreatedData {
+    externalId: string;
+}
+/** Map from event type to its `data.object` shape */
+interface DepositEventDataMap {
+    [DepositEventType.ONRAMP_SESSION_CREATED]: OnrampSessionCreatedData;
+}
+/**
+ * Event envelope emitted by the deposit flow, inspired by the server-side
+ * webhook payload shape: top-level metadata (`id`, `type`, `created`) with
+ * the resource nested under `data.object`.
+ *
+ * Uses `sevt_` prefix for IDs to distinguish from backend webhook `evt_` IDs.
+ */
+type DepositEvent = {
+    [K in DepositEventType]: {
+        id: string;
+        type: K;
+        created: number;
+        data: {
+            object: DepositEventDataMap[K];
+        };
+    };
+}[DepositEventType];
+/** Convenience type for a fully-typed `onramp_session.created` event */
+type OnrampSessionCreatedEvent = Extract<DepositEvent, {
+    type: DepositEventType.ONRAMP_SESSION_CREATED;
+}>;
+
 /**
  * User IP information interface
  */
@@ -874,4 +915,4 @@ declare const i18n: {
 };
 type I18nStrings = typeof i18n;
 
-export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AutoSwapRequest, type AutoSwapResponse, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type ChainType, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type FeaturedToken, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActionType, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IpAddressResponse, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, createDepositAddress, createExchangeSession, createOnrampSession, getAddressBalance, getAddressBalances, getApiBaseUrl, getChainName, getDefaultOnrampToken, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, retrievePaymentIntent, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, useUserIp, verifyRecipientAddress };
+export { ActionType, type AddressBalanceResponse, type AddressBalancesResponse, type AddressValidationFailureCode, type AddressValidationMetadata, type AutoSwapRequest, type AutoSwapResponse, type BuildHypercoreTransactionRequest, type BuildHypercoreTransactionResponse, type BuildSolanaTransactionRequest, type BuildSolanaTransactionResponse, type ChainType, type CreateDepositAddressRequest, type CreateExchangeSessionRequest, type CreateExchangeSessionResponse, type DefaultTokenChain, type DefaultTokenMetadata, type DefaultTokenResponse, type DepositAddressResponse, type DepositEvent, DepositEventType, type DepositQuote, type DepositQuoteRequest, type DestinationToken, type DestinationTokenChain, type ExchangeProviderInfo, type ExchangeProvidersResponse, type ExchangeSessionStartParams, type ExchangeWalletAddress, ExecutionStatus, type FeaturedToken, type FiatCurrenciesResponse, type FiatCurrency, type GetExchangesQuery, type HypercoreActionType, type HypercoreActivationRequest, type HypercoreActivationResponse, type I18nStrings, type IconUrl, IneligibilityReason, type IpAddressResponse, type OnrampQuote, type OnrampQuotesRequest, type OnrampQuotesResponse, type OnrampSessionCreatedData, type OnrampSessionCreatedEvent, type OnrampSessionRequest, type OnrampSessionResponse, type PaymentIntent, type PaymentIntentDepositAddress, type PaymentIntentExecutionsResponse, type PaymentNetwork, type PollExecutionsRequest, type PollExecutionsResponse, type ProjectConfigResponse, type QueryExecutionsRequest, type QueryExecutionsResponse, SOLANA_USDC_ADDRESS, type SendHypercoreTransactionRequest, type SendHypercoreTransactionResponse, type SendSolanaTransactionRequest, type SendSolanaTransactionResponse, type SupportedChain, type SupportedDepositTokensResponse, type SupportedDestinationTokensResponse, type SupportedToken, type TokenBalance, type TokenChain, type TokenChainIconUrl, type TokenChainsResponse, type TokenIconUrl, type TokenInfo, type TokenMetadata, type UserIpInfo, type VerifyAddressRequest, type VerifyAddressResponse, type Wallet, buildHypercoreTransaction, buildSolanaTransaction, checkHypercoreActivation, createDepositAddress, createExchangeSession, createOnrampSession, generatePrefixedKSUID, getAddressBalance, getAddressBalances, getApiBaseUrl, getChainName, getDefaultOnrampToken, getDepositQuote, getExchangeSessionStartUrl, getExchanges, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getOnrampSessionStartUrl, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getSupportedDestinationTokens, getTokenChains, getTokenMetadata, getWalletByChainType, i18n, listPaymentIntentExecutions, pollDirectExecutions, queryExecutions, retrievePaymentIntent, sendHypercoreTransaction, sendSolanaTransaction, setApiConfig, useUserIp, verifyRecipientAddress };

package/dist/index.js

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   ActionType: () => ActionType,
+  DepositEventType: () => DepositEventType,
   ExecutionStatus: () => ExecutionStatus,
   IneligibilityReason: () => IneligibilityReason,
   SOLANA_USDC_ADDRESS: () => SOLANA_USDC_ADDRESS,
@@ -30,6 +31,7 @@ __export(index_exports, {
   createDepositAddress: () => createDepositAddress,
   createExchangeSession: () => createExchangeSession,
   createOnrampSession: () => createOnrampSession,
+  generatePrefixedKSUID: () => generatePrefixedKSUID,
   getAddressBalance: () => getAddressBalance,
   getAddressBalances: () => getAddressBalances,
   getApiBaseUrl: () => getApiBaseUrl,
@@ -358,6 +360,9 @@ function getOnrampSessionStartUrl(request, publishableKey) {
   if (request.subdivision_code) {
     params.append("subdivision_code", request.subdivision_code);
   }
+  if (request.external_id) {
+    params.append("external_id", request.external_id);
+  }
   return `${API_BASE_URL}/v1/public/onramps/sessions/start?${params.toString()}`;
 }
 async function getDefaultOnrampToken(params, publishableKey) {
@@ -748,6 +753,42 @@ async function sendHypercoreTransaction(request, publishableKey) {
   return response.json();
 }
 
+// src/lib/utils.ts
+function generatePrefixedKSUID(prefix) {
+  const BASE62 = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+  const KSUID_EPOCH = 14e8;
+  const timestampSeconds = Math.floor(Date.now() / 1e3) - KSUID_EPOCH;
+  const payload = new Uint8Array(20);
+  payload[0] = timestampSeconds >>> 24 & 255;
+  payload[1] = timestampSeconds >>> 16 & 255;
+  payload[2] = timestampSeconds >>> 8 & 255;
+  payload[3] = timestampSeconds & 255;
+  if (typeof crypto !== "undefined" && crypto.getRandomValues) {
+    crypto.getRandomValues(payload.subarray(4));
+  } else {
+    for (let i = 4; i < 20; i++) {
+      payload[i] = Math.floor(Math.random() * 256);
+    }
+  }
+  let value = 0n;
+  for (const byte of payload) {
+    value = value << 8n | BigInt(byte);
+  }
+  let encoded = "";
+  while (value > 0n) {
+    encoded = BASE62[Number(value % 62n)] + encoded;
+    value = value / 62n;
+  }
+  encoded = encoded.padStart(27, "0");
+  return `${prefix}_${encoded}`;
+}
+
+// src/lib/events.ts
+var DepositEventType = /* @__PURE__ */ ((DepositEventType2) => {
+  DepositEventType2["ONRAMP_SESSION_CREATED"] = "onramp_session.created";
+  return DepositEventType2;
+})(DepositEventType || {});
+
 // src/hooks/use-user-ip.ts
 var import_react_query = require("@tanstack/react-query");
 function useUserIp() {
@@ -880,6 +921,7 @@ var i18n = en_default;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ActionType,
+  DepositEventType,
   ExecutionStatus,
   IneligibilityReason,
   SOLANA_USDC_ADDRESS,
@@ -889,6 +931,7 @@ var i18n = en_default;
   createDepositAddress,
   createExchangeSession,
   createOnrampSession,
+  generatePrefixedKSUID,
   getAddressBalance,
   getAddressBalances,
   getApiBaseUrl,

package/dist/index.mjs

@@ -292,6 +292,9 @@ function getOnrampSessionStartUrl(request, publishableKey) {
   if (request.subdivision_code) {
     params.append("subdivision_code", request.subdivision_code);
   }
+  if (request.external_id) {
+    params.append("external_id", request.external_id);
+  }
   return `${API_BASE_URL}/v1/public/onramps/sessions/start?${params.toString()}`;
 }
 async function getDefaultOnrampToken(params, publishableKey) {
@@ -682,6 +685,42 @@ async function sendHypercoreTransaction(request, publishableKey) {
   return response.json();
 }
 
+// src/lib/utils.ts
+function generatePrefixedKSUID(prefix) {
+  const BASE62 = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+  const KSUID_EPOCH = 14e8;
+  const timestampSeconds = Math.floor(Date.now() / 1e3) - KSUID_EPOCH;
+  const payload = new Uint8Array(20);
+  payload[0] = timestampSeconds >>> 24 & 255;
+  payload[1] = timestampSeconds >>> 16 & 255;
+  payload[2] = timestampSeconds >>> 8 & 255;
+  payload[3] = timestampSeconds & 255;
+  if (typeof crypto !== "undefined" && crypto.getRandomValues) {
+    crypto.getRandomValues(payload.subarray(4));
+  } else {
+    for (let i = 4; i < 20; i++) {
+      payload[i] = Math.floor(Math.random() * 256);
+    }
+  }
+  let value = 0n;
+  for (const byte of payload) {
+    value = value << 8n | BigInt(byte);
+  }
+  let encoded = "";
+  while (value > 0n) {
+    encoded = BASE62[Number(value % 62n)] + encoded;
+    value = value / 62n;
+  }
+  encoded = encoded.padStart(27, "0");
+  return `${prefix}_${encoded}`;
+}
+
+// src/lib/events.ts
+var DepositEventType = /* @__PURE__ */ ((DepositEventType2) => {
+  DepositEventType2["ONRAMP_SESSION_CREATED"] = "onramp_session.created";
+  return DepositEventType2;
+})(DepositEventType || {});
+
 // src/hooks/use-user-ip.ts
 import { useQuery } from "@tanstack/react-query";
 function useUserIp() {
@@ -813,6 +852,7 @@ var en_default = {
 var i18n = en_default;
 export {
   ActionType,
+  DepositEventType,
   ExecutionStatus,
   IneligibilityReason,
   SOLANA_USDC_ADDRESS,
@@ -822,6 +862,7 @@ export {
   createDepositAddress,
   createExchangeSession,
   createOnrampSession,
+  generatePrefixedKSUID,
   getAddressBalance,
   getAddressBalances,
   getApiBaseUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unifold/core",
-  "version": "0.1.46",
+  "version": "0.1.47",
   "description": "Unifold Core SDK - Core types, API client, and business logic",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",