@pollar/react 0.10.1-rc.1 → 0.10.1-rc.11

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { pollarPaths, PollarClient, PollarClientConfig, PollarAdapters, OnStorageDegrade, WalletInfo, PollarLoginOptions, SessionsState, TransactionState, TxBuildBody, BuildOutcome, SubmitOutcome, SignOutcome, StellarNetwork, WalletBalanceState, EnabledAssetsState, TrustlineOutcome, TxHistoryState, SwapVenue, SwapToken, SwapQuoteParams, SwapQuote, PollarAdapter, WalletId, KycStatus as KycStatus$1, RampQuote, AuthState, KycProvider, KycStartResponse, RampDirection, RampCountry, RampTxStatus, EnabledAssetRecord, WalletBalanceRecord, SwapProvider, DistributionRulesState, DistributionRule } from '@pollar/core';
+import { pollarPaths, PollarClient, PollarClientConfig, PollarAdapters, OnStorageDegrade, WalletInfo, PollarLoginOptions, SessionsState, TransactionState, TxBuildBody, BuildOutcome, SubmitOutcome, SignOutcome, StellarNetwork, WalletBalanceState, EnabledAssetsState, TrustlineOutcome, TxHistoryState, SwapVenue, SwapToken, SwapQuoteParams, SwapQuote, EarnProviderId, EarnOpportunity, EarnPositionParams, EarnPosition, EarnTxParams, PollarAdapter, WalletId, KycStatus as KycStatus$1, RampQuote, AuthState, KycProvider, KycStartResponse, RampDirection, RampCountry, RampTxStatus, EnabledAssetRecord, WalletBalanceRecord, SwapProvider, DistributionRulesState, DistributionRule } from '@pollar/core';
 export { AuthProviderContext, PollarAuthProvider, SessionsState } from '@pollar/core';
 import { ReactNode } from 'react';
 
@@ -115,6 +115,33 @@ interface PollarContextValue {
     }) => Promise<SubmitOutcome>;
     /** Open the swap modal. */
     openSwapModal: () => void;
+    /**
+     * The yield providers this app exposes to end-users (empty = Earn disabled,
+     * hide Earn UI). Mirrors {@link PollarClient.getEarnProviders}.
+     */
+    getEarnProviders: () => Promise<EarnProviderId[]>;
+    /**
+     * The vaults (DeFindex) or pools (Blend) a provider exposes, with live APY.
+     * Mirrors {@link PollarClient.getEarnOpportunities}.
+     */
+    getEarnOpportunities: (provider: EarnProviderId) => Promise<EarnOpportunity[]>;
+    /**
+     * The connected wallet's position (balance + APY) in a vault/pool. Read-only.
+     * Mirrors {@link PollarClient.getEarnPosition}.
+     */
+    getEarnPosition: (params: EarnPositionParams) => Promise<EarnPosition>;
+    /**
+     * Deposit into a vault/pool (asset amount). Drives the transaction state
+     * machine. Mirrors {@link PollarClient.earnDeposit}.
+     */
+    earnDeposit: (params: EarnTxParams) => Promise<SubmitOutcome>;
+    /**
+     * Withdraw from a vault/pool (amount in the position `withdrawUnit`). Mirrors
+     * {@link PollarClient.earnWithdraw}.
+     */
+    earnWithdraw: (params: EarnTxParams) => Promise<SubmitOutcome>;
+    /** Open the Earn modal. */
+    openEarnModal: () => void;
     openDistributionRulesModal: () => void;
     adapters?: PollarAdapters;
 }
@@ -169,7 +196,11 @@ interface WalletButtonTemplateProps {
     wrapperRef: React.RefObject<HTMLDivElement>;
     isInProgress: boolean;
     walletType: WalletId | null;
+    /** Show the "Create account" action (external wallet not yet on-chain, IMMEDIATE funding). */
+    showCreateAccount: boolean;
+    creatingAccount: boolean;
     onToggleOpen: () => void;
+    onCreateAccount: () => void;
     onCopy: () => void;
     onWalletBalance: () => void;
     onTxHistory: () => void;
@@ -182,7 +213,7 @@ interface WalletButtonTemplateProps {
     onLogout: () => void;
     onLogin: () => void;
 }
-declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, onToggleOpen, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
+declare function WalletButtonTemplate({ walletAddress, accentColor, open, copied, dropdownBg, dropdownBorder, itemColor, wrapperRef, isInProgress, showCreateAccount, creatingAccount, onToggleOpen, onCreateAccount, onCopy, onWalletBalance, onTxHistory, onSend, onReceive, onSessions, onKyc, onRamp, onDistributionRules, onLogout, onLogin, }: WalletButtonTemplateProps): react_jsx_runtime.JSX.Element;
 
 interface KycModalProps {
     onClose: () => void;
@@ -232,6 +263,11 @@ interface SwapModalProps {
 }
 declare function SwapModal({ onClose }: SwapModalProps): react_jsx_runtime.JSX.Element;
 
+interface EarnModalProps {
+    onClose: () => void;
+}
+declare function EarnModal({ onClose }: EarnModalProps): react_jsx_runtime.JSX.Element;
+
 interface ReceiveModalProps {
     onClose: () => void;
 }
@@ -304,11 +340,24 @@ interface KycModalTemplateProps {
     isLoading: boolean;
     onSelectProvider: (provider: KycProvider) => void;
     onDoneVerifying: () => void;
+    onRefresh: () => void;
     onClose: () => void;
 }
-declare function KycModalTemplate({ theme, accentColor, step, providers, selectedProvider, session, kycStatus, isLoading, onSelectProvider, onDoneVerifying, onClose, }: KycModalTemplateProps): react_jsx_runtime.JSX.Element;
+declare function KycModalTemplate({ theme, accentColor, step, providers, selectedProvider, session, kycStatus, isLoading, onSelectProvider, onDoneVerifying, onRefresh, onClose, }: KycModalTemplateProps): react_jsx_runtime.JSX.Element;
 
-type RampStep = 'input' | 'loading_quote' | 'select_route' | 'status' | 'error';
+type RampStep = 'input' | 'loading_quote' | 'select_route' | 'contact' | 'status' | 'error';
+/** A field a provider declares (via the quote) that the client must collect. */
+interface RampFieldSpec {
+    key: string;
+    label: string;
+    type: 'text' | 'email' | 'tel' | 'select';
+    bankType?: 'CLABE' | 'PIX' | 'PSE' | 'ACH' | 'BREB';
+    /** For `type: 'select'` — dropdown choices (e.g. Stereum's Bolivian banks). */
+    options?: {
+        value: string;
+        label: string;
+    }[];
+}
 interface RampWidgetTemplateProps {
     theme: string;
     accentColor: string;
@@ -317,6 +366,8 @@ interface RampWidgetTemplateProps {
     amount: string;
     currency: string;
     country: string;
+    requiredFields: RampFieldSpec[];
+    fieldValues: Record<string, string>;
     countries: RampCountry[];
     countriesLoading: boolean;
     refreshing: boolean;
@@ -325,23 +376,29 @@ interface RampWidgetTemplateProps {
     provider: string;
     txStatus: RampTxStatus | null;
     kycUrl: string | null;
+    tosUrl: string | null;
     stellarTxHash: string | null;
+    /** Stellar Expert URL for `stellarTxHash` (network-aware); null when unknown. */
+    explorerUrl: string | null;
+    depositInstructions: Record<string, unknown> | null;
     canComplete: boolean;
     completing: boolean;
     errorMsg: string | null;
     onDirectionChange: (d: RampDirection) => void;
     onAmountChange: (v: string) => void;
-    onCurrencyChange: (v: string) => void;
+    onFieldChange: (key: string, value: string) => void;
     onCountryChange: (v: string) => void;
     onFindRoute: () => void;
     onSelectQuote: (q: RampQuote) => void;
+    onContactContinue: () => void;
     onOpenKyc: () => void;
+    onOpenTos: () => void;
     onCompleteWithdraw: () => void;
     onRetry: () => void;
     onRefresh: () => void;
     onClose: () => void;
 }
-declare function RampWidgetTemplate({ theme, accentColor, step, direction, amount, currency, country, countries, countriesLoading, refreshing, quotes, isLoading, provider, txStatus, kycUrl, stellarTxHash, canComplete, completing, errorMsg, onDirectionChange, onAmountChange, onCurrencyChange, onCountryChange, onFindRoute, onSelectQuote, onOpenKyc, onCompleteWithdraw, onRetry, onRefresh, onClose, }: RampWidgetTemplateProps): react_jsx_runtime.JSX.Element;
+declare function RampWidgetTemplate({ theme, accentColor, step, direction, amount, currency, country, requiredFields, fieldValues, countries, countriesLoading, refreshing, quotes, isLoading, provider, txStatus, kycUrl, tosUrl, stellarTxHash, explorerUrl, depositInstructions, canComplete, completing, errorMsg, onDirectionChange, onAmountChange, onFieldChange, onCountryChange, onFindRoute, onSelectQuote, onContactContinue, onOpenKyc, onOpenTos, onCompleteWithdraw, onRetry, onRefresh, onClose, }: RampWidgetTemplateProps): react_jsx_runtime.JSX.Element;
 
 interface TransactionModalTemplateProps {
     theme: string;
@@ -430,6 +487,7 @@ interface SendModalTemplateProps {
     isInProgress: boolean;
     onClose: () => void;
     onBack: () => void;
+    onRefresh: () => void;
     onSelectAsset: (asset: WalletBalanceRecord) => void;
     onAmountChange: (value: string) => void;
     onDestinationChange: (value: string) => void;
@@ -440,7 +498,7 @@ interface SendModalTemplateProps {
     onRetry: () => void;
     onDone: () => void;
 }
-declare function SendModalTemplate({ theme, accentColor, step, txTitle, assets, selectedAsset, amount, destination, formError, isLoadingBalance, transaction, showXdr, copied, explorerUrl, walletType, showBack, isInProgress, onClose, onBack, onSelectAsset, onAmountChange, onDestinationChange, onSubmit, onSignAndSend, onToggleXdr, onCopyHash, onRetry, onDone, }: SendModalTemplateProps): react_jsx_runtime.JSX.Element;
+declare function SendModalTemplate({ theme, accentColor, step, txTitle, assets, selectedAsset, amount, destination, formError, isLoadingBalance, transaction, showXdr, copied, explorerUrl, walletType, showBack, isInProgress, onClose, onBack, onRefresh, onSelectAsset, onAmountChange, onDestinationChange, onSubmit, onSignAndSend, onToggleXdr, onCopyHash, onRetry, onDone, }: SendModalTemplateProps): react_jsx_runtime.JSX.Element;
 
 /** A selectable asset in the sell/buy pickers, normalized across balance/enabled records. */
 interface SwapAssetOption {
@@ -534,4 +592,4 @@ interface DistributionRulesModalTemplateProps {
 }
 declare function DistributionRulesModalTemplate({ theme, accentColor, state, claimingId, claimErrors, claimedIds, onRefresh, onClaim, onClose, }: DistributionRulesModalTemplateProps): react_jsx_runtime.JSX.Element;
 
-export { type AuthModalProps, DistributionRulesModal, DistributionRulesModalTemplate, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type PollarConfig, PollarProvider, type PollarStyles, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, createPollarAdapterHook, usePollar };
+export { type AuthModalProps, DistributionRulesModal, DistributionRulesModalTemplate, EarnModal, EnabledAssetsModal, EnabledAssetsModalTemplate, type EnabledAssetsModalTemplateProps, KycModal, KycModalTemplate, KycStatus, type KycStep, type LoginButtonProps, LoginModalTemplate, type PollarConfig, PollarProvider, type PollarStyles, type RampStep, RampWidget, RampWidgetTemplate, ReceiveModal, ReceiveModalTemplate, type ReceiveModalTemplateProps, RouteDisplay, SendModal, SendModalTemplate, type SendModalTemplateProps, SessionsModal, SessionsModalTemplate, type SessionsModalTemplateProps, type SwapAssetOption, SwapModal, SwapModalTemplate, type SwapModalTemplateProps, TransactionModalTemplate, type TransactionModalTemplateProps, TxHistoryModalTemplate, TxStatusView, type TxStatusViewProps, WalletBalanceModal, WalletBalanceModalTemplate, type WalletBalanceModalTemplateProps, WalletButton, WalletButtonTemplate, type WalletButtonTemplateProps, createPollarAdapterHook, usePollar };