@coinlist-co/react 0.11.0 → 0.11.1-rc.22d81d4

package/dist/collections-DrJFEDHl.d.cts

@@ -0,0 +1,116 @@
+import { ay as ClientId, be as RedirectUri, az as CodeChallenge, b3 as PKCEState, C as CodeVerifier, n as EvmWalletAddress, a as EthereumChain, bx as Tx, B as BlockchainAmount, bn as SwapPreview, Q as AssetDecimals, ar as Newtype } from './config-C6vlghJY.cjs';
+import { Hex, Abi, Hash, TransactionReceipt } from 'viem';
+
+type PKCEParams = {
+    clientId: ClientId;
+    responseType: 'code';
+    redirectUri: RedirectUri;
+    codeChallenge: CodeChallenge;
+    codeChallengeMethod: 'S256';
+    state: PKCEState;
+    codeVerifier: CodeVerifier;
+};
+type PKCEConfig = {
+    clientId: ClientId;
+    redirectUri: RedirectUri;
+};
+/**
+ * Generates PKCE parameters for an OAuth2 authorization code flow.
+ * Pure crypto — no React, no DOM beyond Web Crypto API. Safe to use
+ * in server-side code and Next.js middleware.
+ */
+declare function generatePKCEParams(config: PKCEConfig): Promise<PKCEParams>;
+
+type WriteContractParams = {
+    abi: Abi;
+    address: `0x${string}`;
+    functionName: string;
+    args?: readonly unknown[];
+    value?: bigint;
+    chain: EthereumChain;
+};
+type BroadcastTxParams = Tx & {
+    chain: EthereumChain;
+};
+/**
+ * The signing-only wallet capability: address + `signMessage`. This is all the
+ * external-wallet ownership proof needs (see `useConnectWallet`), so hosts can
+ * satisfy that flow without implementing on-chain capabilities. The richer
+ * {@link EvmWallet} extends this for swap flows.
+ *
+ * SDK users implement this against their own wallet stack (e.g. viem, wagmi,
+ * Privy). `signMessage` throws on failure and the SDK classifies it.
+ */
+interface EvmSigner {
+    readonly address: EvmWalletAddress;
+    signMessage(message: string): Promise<Hex>;
+}
+/**
+ * The full on-chain wallet the SDK needs to run the swap flows: an
+ * {@link EvmSigner} plus contract writes, raw-tx broadcast, and confirmation.
+ * SDK users implement this against their own wallet stack (e.g. viem, wagmi,
+ * Privy).
+ *
+ * Methods throw on failure. The SDK catches and classifies the thrown error
+ * (viem's `UserRejectedRequestError`, `InsufficientFundsError`, timeouts, …)
+ * into a typed {@link WalletError}, so implementers can simply let their wallet
+ * library's errors propagate.
+ */
+interface EvmWallet extends EvmSigner {
+    writeContract(params: WriteContractParams): Promise<Hash>;
+    broadcastRawTx(params: BroadcastTxParams): Promise<Hash>;
+    awaitTx(hash: Hash, chain: EthereumChain): Promise<TransactionReceipt>;
+}
+/**
+ * The host-provided wallet the ownership flow signs with: the signing-only
+ * {@link EvmSigner} plus the {@link EthereumChain} the signature is proven on.
+ * `chain` rides on the wallet (not the offer) because the binding is
+ * chain-agnostic: it only records which EVM chain signed.
+ */
+type ConnectWallet = EvmSigner & {
+    readonly chain: EthereumChain;
+};
+
+/**
+ * A read-only quote for a swap as domain amounts: how much goes in, the
+ * protocol fee, and how much would come out. Derived from the raw
+ * {@link SwapPreview} the swap contract returns.
+ */
+type SwapQuote = {
+    inputTokenAmount: BlockchainAmount;
+    fee: BlockchainAmount;
+    outputTokenAmount: BlockchainAmount;
+};
+declare const SwapQuote: {
+    /**
+     * Assembles a {@link SwapQuote} from a raw contract {@link SwapPreview}. The
+     * input and fee are denominated in the input token; the output in the output
+     * token.
+     */
+    fromPreview: (preview: SwapPreview, inputDecimals: AssetDecimals, outputDecimals: AssetDecimals) => SwapQuote;
+};
+
+type FormattedAmountUi = Newtype<string, 'FormattedAmountUi'>;
+declare const FormattedAmountUi: (value: string) => FormattedAmountUi;
+type FormattedPercentUi = Newtype<string, 'FormattedPercentUi'>;
+declare const FormattedPercentUi: (value: string) => FormattedPercentUi;
+type TxExplorerUrl = Newtype<string, 'TxExplorerUrl'>;
+declare const TxExplorerUrl: (value: string) => TxExplorerUrl;
+/**
+ * A wallet address shortened for display (e.g. `0x1234…5678`). Keeps a
+ * `0x${string}` base but drops the runtime `0x` narrowing.
+ */
+type ShortenedWalletAddress = Newtype<`0x${string}`, 'ShortenedWalletAddress'>;
+declare const ShortenedWalletAddress: (value: string) => ShortenedWalletAddress;
+type FormattedAmountAssetUi = Newtype<string, 'FormattedAmountAssetUi'>;
+declare const FormattedAmountAssetUi: (value: string) => FormattedAmountAssetUi;
+type AssetIconUrl = Newtype<string, 'AssetIconUrl'>;
+declare const AssetIconUrl: (value: string) => AssetIconUrl;
+
+/**
+ * An array guaranteed to hold at least one element. Use it where an empty list
+ * would be a bug (e.g. the set of assets a swap always offers).
+ */
+type NonEmptyArray<T> = [T, ...T[]];
+
+export { AssetIconUrl as A, type BroadcastTxParams as B, type ConnectWallet as C, type EvmWallet as E, FormattedAmountAssetUi as F, type NonEmptyArray as N, type PKCEConfig as P, SwapQuote as S, TxExplorerUrl as T, type WriteContractParams as W, ShortenedWalletAddress as a, FormattedPercentUi as b, type EvmSigner as c, FormattedAmountUi as d, type PKCEParams as e, generatePKCEParams as g };

package/dist/collections-pLtrj6fw.d.ts

@@ -0,0 +1,116 @@
+import { ay as ClientId, be as RedirectUri, az as CodeChallenge, b3 as PKCEState, C as CodeVerifier, n as EvmWalletAddress, a as EthereumChain, bx as Tx, B as BlockchainAmount, bn as SwapPreview, Q as AssetDecimals, ar as Newtype } from './config-C6vlghJY.js';
+import { Hex, Abi, Hash, TransactionReceipt } from 'viem';
+
+type PKCEParams = {
+    clientId: ClientId;
+    responseType: 'code';
+    redirectUri: RedirectUri;
+    codeChallenge: CodeChallenge;
+    codeChallengeMethod: 'S256';
+    state: PKCEState;
+    codeVerifier: CodeVerifier;
+};
+type PKCEConfig = {
+    clientId: ClientId;
+    redirectUri: RedirectUri;
+};
+/**
+ * Generates PKCE parameters for an OAuth2 authorization code flow.
+ * Pure crypto — no React, no DOM beyond Web Crypto API. Safe to use
+ * in server-side code and Next.js middleware.
+ */
+declare function generatePKCEParams(config: PKCEConfig): Promise<PKCEParams>;
+
+type WriteContractParams = {
+    abi: Abi;
+    address: `0x${string}`;
+    functionName: string;
+    args?: readonly unknown[];
+    value?: bigint;
+    chain: EthereumChain;
+};
+type BroadcastTxParams = Tx & {
+    chain: EthereumChain;
+};
+/**
+ * The signing-only wallet capability: address + `signMessage`. This is all the
+ * external-wallet ownership proof needs (see `useConnectWallet`), so hosts can
+ * satisfy that flow without implementing on-chain capabilities. The richer
+ * {@link EvmWallet} extends this for swap flows.
+ *
+ * SDK users implement this against their own wallet stack (e.g. viem, wagmi,
+ * Privy). `signMessage` throws on failure and the SDK classifies it.
+ */
+interface EvmSigner {
+    readonly address: EvmWalletAddress;
+    signMessage(message: string): Promise<Hex>;
+}
+/**
+ * The full on-chain wallet the SDK needs to run the swap flows: an
+ * {@link EvmSigner} plus contract writes, raw-tx broadcast, and confirmation.
+ * SDK users implement this against their own wallet stack (e.g. viem, wagmi,
+ * Privy).
+ *
+ * Methods throw on failure. The SDK catches and classifies the thrown error
+ * (viem's `UserRejectedRequestError`, `InsufficientFundsError`, timeouts, …)
+ * into a typed {@link WalletError}, so implementers can simply let their wallet
+ * library's errors propagate.
+ */
+interface EvmWallet extends EvmSigner {
+    writeContract(params: WriteContractParams): Promise<Hash>;
+    broadcastRawTx(params: BroadcastTxParams): Promise<Hash>;
+    awaitTx(hash: Hash, chain: EthereumChain): Promise<TransactionReceipt>;
+}
+/**
+ * The host-provided wallet the ownership flow signs with: the signing-only
+ * {@link EvmSigner} plus the {@link EthereumChain} the signature is proven on.
+ * `chain` rides on the wallet (not the offer) because the binding is
+ * chain-agnostic: it only records which EVM chain signed.
+ */
+type ConnectWallet = EvmSigner & {
+    readonly chain: EthereumChain;
+};
+
+/**
+ * A read-only quote for a swap as domain amounts: how much goes in, the
+ * protocol fee, and how much would come out. Derived from the raw
+ * {@link SwapPreview} the swap contract returns.
+ */
+type SwapQuote = {
+    inputTokenAmount: BlockchainAmount;
+    fee: BlockchainAmount;
+    outputTokenAmount: BlockchainAmount;
+};
+declare const SwapQuote: {
+    /**
+     * Assembles a {@link SwapQuote} from a raw contract {@link SwapPreview}. The
+     * input and fee are denominated in the input token; the output in the output
+     * token.
+     */
+    fromPreview: (preview: SwapPreview, inputDecimals: AssetDecimals, outputDecimals: AssetDecimals) => SwapQuote;
+};
+
+type FormattedAmountUi = Newtype<string, 'FormattedAmountUi'>;
+declare const FormattedAmountUi: (value: string) => FormattedAmountUi;
+type FormattedPercentUi = Newtype<string, 'FormattedPercentUi'>;
+declare const FormattedPercentUi: (value: string) => FormattedPercentUi;
+type TxExplorerUrl = Newtype<string, 'TxExplorerUrl'>;
+declare const TxExplorerUrl: (value: string) => TxExplorerUrl;
+/**
+ * A wallet address shortened for display (e.g. `0x1234…5678`). Keeps a
+ * `0x${string}` base but drops the runtime `0x` narrowing.
+ */
+type ShortenedWalletAddress = Newtype<`0x${string}`, 'ShortenedWalletAddress'>;
+declare const ShortenedWalletAddress: (value: string) => ShortenedWalletAddress;
+type FormattedAmountAssetUi = Newtype<string, 'FormattedAmountAssetUi'>;
+declare const FormattedAmountAssetUi: (value: string) => FormattedAmountAssetUi;
+type AssetIconUrl = Newtype<string, 'AssetIconUrl'>;
+declare const AssetIconUrl: (value: string) => AssetIconUrl;
+
+/**
+ * An array guaranteed to hold at least one element. Use it where an empty list
+ * would be a bug (e.g. the set of assets a swap always offers).
+ */
+type NonEmptyArray<T> = [T, ...T[]];
+
+export { AssetIconUrl as A, type BroadcastTxParams as B, type ConnectWallet as C, type EvmWallet as E, FormattedAmountAssetUi as F, type NonEmptyArray as N, type PKCEConfig as P, SwapQuote as S, TxExplorerUrl as T, type WriteContractParams as W, ShortenedWalletAddress as a, FormattedPercentUi as b, type EvmSigner as c, FormattedAmountUi as d, type PKCEParams as e, generatePKCEParams as g };