@oasisprotocol/privana-sdk 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { A as Address, B as Bytes32, H as HexString, I as IntegerLike, a as HostedAuthResponseMode, S as SignOnRampUrlRequest, b as SignOnRampUrlResponse, C as CreateOnRampIntentRequest, c as CreateOnRampIntentResponse, U as UpdateOnRampRequest, d as UpdateOnRampResponse, P as PendingOnRampsResponse, N as NetworkConfig, T as TokenConfig } from './on-ramp-DIAOtdeU.js';
+export { e as NETWORK_CONFIG, f as Network, O as OnRampRecord, g as OnRampStatus, h as getAccountingContract, i as getApiUrl, j as getChainId, n as normalizeAddress, k as normalizeHex } from './on-ramp-DIAOtdeU.js';
 import { WalletClient, Address as Address$1 } from 'viem';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
@@ -5,56 +7,6 @@ import { ReactNode, ComponentProps, ReactElement } from 'react';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
 
-var networks = {
-	testnet: {
-		chainId: 23295,
-		name: "Sapphire Testnet",
-		accountingContract: "0xaF8e5de153A584528B57DD4B9B0195956BBDF571",
-		apiUrl: "https://testnet.privana.finance"
-	},
-	mainnet: {
-		chainId: 23294,
-		name: "Sapphire Mainnet",
-		accountingContract: "0x0000000000000000000000000000000000000000",
-		apiUrl: ""
-	}
-};
-var config = {
-	networks: networks
-};
-
-type Address = `0x${string}`;
-type Bytes32 = `0x${string}`;
-type HexString = `0x${string}`;
-type IntegerLike = string | number;
-type HostedAuthResponseMode = 'web_message' | 'redirect';
-type Network = keyof typeof config.networks;
-interface NetworkConfig {
-    chainId: number;
-    name: string;
-    accountingContract: Address;
-    apiUrl: string;
-}
-declare const NETWORK_CONFIG: {
-    readonly testnet: {
-        readonly accountingContract: Address;
-        readonly chainId: number;
-        readonly name: string;
-        readonly apiUrl: string;
-    };
-    readonly mainnet: {
-        readonly accountingContract: Address;
-        readonly chainId: number;
-        readonly name: string;
-        readonly apiUrl: string;
-    };
-};
-declare function getChainId(network: Network): number;
-declare function getAccountingContract(network: Network): Address;
-declare function getApiUrl(network: Network): string;
-declare function normalizeHex(value: string): HexString;
-declare function normalizeAddress(value: string): Address;
-
 interface HostedAuthConfig {
     clientId: string;
     redirectUri: string;
@@ -85,15 +37,6 @@ interface HostedAuthCallbackError {
 }
 type HostedAuthCallback = HostedAuthCallbackSuccess | HostedAuthCallbackError;
 
-interface TokenConfig {
-    id: Bytes32;
-    symbol: string;
-    decimals: number;
-    contract: Address;
-    name: string;
-    chainId: number;
-}
-
 interface ChainConfig {
     id: number;
     name: string;
@@ -438,6 +381,10 @@ declare class PrivanaClient {
     exchangeHostedAuthCode(request: HostedAuthTokenExchangeRequest): Promise<HostedAuthTokenExchangeResponse>;
     refreshJwtSession(request: JwtRefreshRequest): Promise<JwtRefreshResponse>;
     logoutJwtSession(request?: JwtLogoutRequest): Promise<JwtLogoutResponse>;
+    signOnRampUrl(request: SignOnRampUrlRequest): Promise<SignOnRampUrlResponse>;
+    createOnRampIntent(request: CreateOnRampIntentRequest): Promise<CreateOnRampIntentResponse>;
+    updateOnRamp(transactionId: string, request: UpdateOnRampRequest): Promise<UpdateOnRampResponse>;
+    getPendingOnRamps(): Promise<PendingOnRampsResponse>;
     setPrivateReadToken(token: string): void;
     getPrivateReadToken(): string | undefined;
     clearPrivateReadToken(): void;
@@ -840,6 +787,60 @@ interface UseDepositResult {
 }
 declare function useDeposit(options?: UseDepositOptions): UseDepositResult;
 
+interface VerificationContext {
+    /** On-chain transfer that funded the user's Privana deposit address. */
+    hash: `0x${string}`;
+    /** Chain the transfer was mined on. */
+    chainId: number;
+    /** Transferred amount in base units (matches the deposit's token decimals). */
+    amount: bigint;
+}
+interface UseDepositVerificationOptions {
+    /** Fired when the deposit is credited inside the Privana accounting module. */
+    onCredited?: (txHash: string, response: DepositCheckResponse) => void;
+    /** Fired when polling exceeds `pollTimeout` (the deposit may still be processing). */
+    onCheckTimeout?: (txHash: string) => void;
+    onError?: (error: Error) => void;
+    /** Polling interval in ms (default: 5000). */
+    pollInterval?: number;
+    /** Retry interval in ms while the source-chain tx is waiting finality (default: pollInterval). */
+    finalityRetryInterval?: number;
+    /** Max time to wait for credit confirmation in ms (default: 180000). */
+    pollTimeout?: number;
+}
+interface UseDepositVerificationResult {
+    /** True while phase 1 (checkDeposit) or phase 2 (status polling) is in flight. */
+    isVerifying: boolean;
+    /** True if polling timed out before a terminal status. */
+    didTimeout: boolean;
+    /**
+     * True when the on-chain transfer exists but the API verification step failed.
+     * Funds are still at the deposit address; call `retryVerification()` to re-run
+     * without re-sending the transfer.
+     */
+    verificationFailed: boolean;
+    error: Error | null;
+    /** Current transfer hash being verified, if any. */
+    txHash: `0x${string}` | undefined;
+    /** Kick off Phase 1 (checkDeposit) + Phase 2 (poll getDepositStatus) for the given context. */
+    verify: (ctx: VerificationContext) => Promise<void>;
+    /** Re-run verification against the existing context (after a transient API failure). */
+    retryVerification: () => Promise<void>;
+    /** Discard local tracking (the deposit may still be credited in the background). */
+    reset: () => void;
+}
+/**
+ * Phase 1 (POST /deposits/check) + Phase 2 (poll /deposits/status) of the
+ * Privana deposit flow, decoupled from the wallet-signing half. Use this
+ * directly when the on-chain transfer to the deposit address came from
+ * somewhere other than the connected wallet — e.g. a fiat on-ramp that
+ * delivers straight to the deposit address.
+ *
+ * For the full deposit flow (get address → wallet transfer → verify) use
+ * `useDeposit`, which composes this hook internally.
+ */
+declare function useDepositVerification(options?: UseDepositVerificationOptions): UseDepositVerificationResult;
+
 interface UseWithdrawOptions {
     onSuccess?: (response: TransactionSubmissionResponse) => void;
     /** Called when withdrawal is submitted to the backend */
@@ -1093,4 +1094,4 @@ declare function Skeleton({ className, ...props }: React.ComponentProps<'div'>):
 declare function getTokenIcon(symbol: string, size?: number): react_jsx_runtime.JSX.Element;
 declare function getChainIcon(chainId: number, size?: number): react_jsx_runtime.JSX.Element;
 
-export { AccountingApiError, type Address, type BalanceResponse, type BatchBalancesRequest, type BatchBalancesResponse, Button, type Bytes32, type ChainConfig, type DepositAddressRequest, type DepositAddressResponse, type DepositCheckRequest, type DepositCheckResponse, type DepositParams, type EIP712Domain, type ExpiredLocksResponse, HOSTED_AUTH_CLOCK_SKEW_MS, type HexString, type HistoryEntry, type HistoryKind, type HistoryRequest, type HistoryResponse, type HostedAuthAuthorizeUrlRequest, type HostedAuthCallback, type HostedAuthCallbackError, type HostedAuthCallbackSuccess, type HostedAuthConfig, HostedAuthError, type HostedAuthPendingTransaction, HostedAuthRequiredError, type HostedAuthResponseMode, type HostedAuthSession, HostedAuthStateMismatchError, type HostedAuthTokenExchangeRequest, type HostedAuthTokenExchangeResponse, HttpClient, type HttpClientConfig, type IntegerLike, type JwtLogoutRequest, type JwtLogoutResponse, type JwtRefreshRequest, type JwtRefreshResponse, LOCK_TYPES, type LockFundsParams, type LockFundsRequest, type LockInfo, type LockMessage, type LockNonceResponse, type LockedFundsResponse, MODIFY_LOCK_TYPES, type MinDepositAmounts, type ModifyLockMessage, type ModifyLockNonceResponse, type ModifyLockParams, type ModifyLockRequest, NETWORK_CONFIG, type Network, type NetworkConfig, NetworkError, type PendingWithdrawalsResponse, PrivanaButton, type PrivanaButtonProps, PrivanaClient, type PrivanaClientConfig, type PrivanaContextValue, PrivanaInlineModal, PrivanaModal, PrivanaProvider, type PrivanaProviderProps, SUPPORTED_CHAINS, type SignLockParams, type SignModifyLockParams, type SignTransferLockedParams, type SignTransferParams, type SignWithdrawFromLockParams, type SignWithdrawParams, type SiweAuthConfig, type SiweAuthContextValue, SiweAuthProvider, type SiweAuthProviderProps, type SiweAuthSession, type SiweAuthTokens, type SiweDomainResponse, type SiweLoginRequest, type SiweLoginResponse, type SiweNonceResponse, Skeleton, TRANSFER_LOCKED_TYPES, TRANSFER_TYPES, type TokenBalance, type TokenConfig, type TokenInfoResponse, type TokenListResponse, type TokensStatus, type TotalLockedBalanceResponse, type TransactionSubmissionResponse, type TransferFundsRequest, type TransferLockedFundsRequest, type TransferLockedMessage, type TransferLockedNonceResponse, type TransferLockedParams, type TransferMessage, type TransferNonceResponse, type TransferParams, type UnlockAllExpiredRequest, type UnlockFundsParams, type UnlockFundsRequest, type UseBalanceOptions, type UseBalanceResult, type UseBatchBalancesOptions, type UseBatchBalancesResult, type UseDepositOptions, type UseDepositResult, type UseExpiredLocksOptions, type UseExpiredLocksResult, type UseHistoryOptions, type UseHistoryResult, type UseHostedRedirectAuthResult, type UseLockFundsOptions, type UseLockFundsResult, type UseLockedFundsOptions, type UseLockedFundsResult, type UseModifyLockOptions, type UseModifyLockResult, type UsePendingWithdrawalsOptions, type UsePendingWithdrawalsResult, type UseTokenInfoOptions, type UseTokenInfoResult, type UseTokenListOptions, type UseTokenListResult, type UseTotalLockedBalanceOptions, type UseTotalLockedBalanceResult, type UseTransferOptions, type UseTransferResult, type UseUnlockFundsOptions, type UseUnlockFundsResult, type UseWithdrawOptions, type UseWithdrawResult, ValidationError, WITHDRAW_FROM_LOCK_TYPES, WITHDRAW_TYPES, type WithdrawFromLockMessage, type WithdrawFromLockRequest, type WithdrawMessage, type WithdrawParams, type WithdrawStep, type WithdrawalInfo, type WithdrawalInfoResponse, type WithdrawalNonceResponse, type WithdrawalRequest, applyRefreshResponse, buildHostedAuthSession, buttonVariants, clearHostedAuthPendingTransaction, createDomain, createHostedAuthPendingStorageKey, createHostedAuthState, createHostedAuthStorageKey, createLockExpiry, createPkceChallenge, createPkceVerifier, getAccountingContract, getApiUrl, getChainById, getChainIcon, getChainId, getExplorerAddressUrl, getTokenIcon, isHostedAuthRefreshActive, isHostedAuthSessionActive, normalizeAddress, normalizeHex, parseHostedAuthCallback, persistHostedAuthPendingTransaction, readHostedAuthPendingTransaction, readStoredHostedAuthSession, signLockMessage, signModifyLockMessage, signTransferLockedMessage, signTransferMessage, signWithdrawFromLockMessage, signWithdrawMessage, stripHostedAuthCallbackParams, syncHostedAuthSessionToClient, useBalance, useBatchBalances, useDeposit, useExpiredLocks, useHistory, useHostedRedirectAuth, useLockFunds, useLockedFunds, useModifyLock, usePendingWithdrawals, usePrivanaClient, usePrivanaContext, useSafeAccount, useSafePrivanaContext, useSiweAuth, useTokenInfo, useTokenList, useTotalLockedBalance, useTransfer, useUnlockFunds, useWithdraw };
+export { AccountingApiError, Address, type BalanceResponse, type BatchBalancesRequest, type BatchBalancesResponse, Button, Bytes32, type ChainConfig, CreateOnRampIntentRequest, CreateOnRampIntentResponse, type DepositAddressRequest, type DepositAddressResponse, type DepositCheckRequest, type DepositCheckResponse, type DepositParams, type EIP712Domain, type ExpiredLocksResponse, HOSTED_AUTH_CLOCK_SKEW_MS, HexString, type HistoryEntry, type HistoryKind, type HistoryRequest, type HistoryResponse, type HostedAuthAuthorizeUrlRequest, type HostedAuthCallback, type HostedAuthCallbackError, type HostedAuthCallbackSuccess, type HostedAuthConfig, HostedAuthError, type HostedAuthPendingTransaction, HostedAuthRequiredError, HostedAuthResponseMode, type HostedAuthSession, HostedAuthStateMismatchError, type HostedAuthTokenExchangeRequest, type HostedAuthTokenExchangeResponse, HttpClient, type HttpClientConfig, IntegerLike, type JwtLogoutRequest, type JwtLogoutResponse, type JwtRefreshRequest, type JwtRefreshResponse, LOCK_TYPES, type LockFundsParams, type LockFundsRequest, type LockInfo, type LockMessage, type LockNonceResponse, type LockedFundsResponse, MODIFY_LOCK_TYPES, type MinDepositAmounts, type ModifyLockMessage, type ModifyLockNonceResponse, type ModifyLockParams, type ModifyLockRequest, NetworkConfig, NetworkError, PendingOnRampsResponse, type PendingWithdrawalsResponse, PrivanaButton, type PrivanaButtonProps, PrivanaClient, type PrivanaClientConfig, type PrivanaContextValue, PrivanaInlineModal, PrivanaModal, PrivanaProvider, type PrivanaProviderProps, SUPPORTED_CHAINS, type SignLockParams, type SignModifyLockParams, SignOnRampUrlRequest, SignOnRampUrlResponse, type SignTransferLockedParams, type SignTransferParams, type SignWithdrawFromLockParams, type SignWithdrawParams, type SiweAuthConfig, type SiweAuthContextValue, SiweAuthProvider, type SiweAuthProviderProps, type SiweAuthSession, type SiweAuthTokens, type SiweDomainResponse, type SiweLoginRequest, type SiweLoginResponse, type SiweNonceResponse, Skeleton, TRANSFER_LOCKED_TYPES, TRANSFER_TYPES, type TokenBalance, TokenConfig, type TokenInfoResponse, type TokenListResponse, type TokensStatus, type TotalLockedBalanceResponse, type TransactionSubmissionResponse, type TransferFundsRequest, type TransferLockedFundsRequest, type TransferLockedMessage, type TransferLockedNonceResponse, type TransferLockedParams, type TransferMessage, type TransferNonceResponse, type TransferParams, type UnlockAllExpiredRequest, type UnlockFundsParams, type UnlockFundsRequest, UpdateOnRampRequest, UpdateOnRampResponse, type UseBalanceOptions, type UseBalanceResult, type UseBatchBalancesOptions, type UseBatchBalancesResult, type UseDepositOptions, type UseDepositResult, type UseDepositVerificationOptions, type UseDepositVerificationResult, type UseExpiredLocksOptions, type UseExpiredLocksResult, type UseHistoryOptions, type UseHistoryResult, type UseHostedRedirectAuthResult, type UseLockFundsOptions, type UseLockFundsResult, type UseLockedFundsOptions, type UseLockedFundsResult, type UseModifyLockOptions, type UseModifyLockResult, type UsePendingWithdrawalsOptions, type UsePendingWithdrawalsResult, type UseTokenInfoOptions, type UseTokenInfoResult, type UseTokenListOptions, type UseTokenListResult, type UseTotalLockedBalanceOptions, type UseTotalLockedBalanceResult, type UseTransferOptions, type UseTransferResult, type UseUnlockFundsOptions, type UseUnlockFundsResult, type UseWithdrawOptions, type UseWithdrawResult, ValidationError, type VerificationContext, WITHDRAW_FROM_LOCK_TYPES, WITHDRAW_TYPES, type WithdrawFromLockMessage, type WithdrawFromLockRequest, type WithdrawMessage, type WithdrawParams, type WithdrawStep, type WithdrawalInfo, type WithdrawalInfoResponse, type WithdrawalNonceResponse, type WithdrawalRequest, applyRefreshResponse, buildHostedAuthSession, buttonVariants, clearHostedAuthPendingTransaction, createDomain, createHostedAuthPendingStorageKey, createHostedAuthState, createHostedAuthStorageKey, createLockExpiry, createPkceChallenge, createPkceVerifier, getChainById, getChainIcon, getExplorerAddressUrl, getTokenIcon, isHostedAuthRefreshActive, isHostedAuthSessionActive, parseHostedAuthCallback, persistHostedAuthPendingTransaction, readHostedAuthPendingTransaction, readStoredHostedAuthSession, signLockMessage, signModifyLockMessage, signTransferLockedMessage, signTransferMessage, signWithdrawFromLockMessage, signWithdrawMessage, stripHostedAuthCallbackParams, syncHostedAuthSessionToClient, useBalance, useBatchBalances, useDeposit, useDepositVerification, useExpiredLocks, useHistory, useHostedRedirectAuth, useLockFunds, useLockedFunds, useModifyLock, usePendingWithdrawals, usePrivanaClient, usePrivanaContext, useSafeAccount, useSafePrivanaContext, useSiweAuth, useTokenInfo, useTokenList, useTotalLockedBalance, useTransfer, useUnlockFunds, useWithdraw };