@coinlist-co/react 0.5.1 → 0.9.0

package/dist/requirement-C2w45Q11.d.ts

@@ -0,0 +1,969 @@
+import { Hex } from 'viem';
+
+declare const __brand: unique symbol;
+type Newtype<Base, Branding> = Base & {
+    readonly [__brand]: Branding;
+};
+
+type EthereumChain = 'ethereum_mainnet' | 'ethereum_sepolia';
+/**
+ * Protocol a wallet binding is scoped to. EVM-only for now: an EVM address
+ * binds once per option regardless of which EVM chain proved ownership.
+ * Frontline's enum also has `:solana`, but we don't handle Solana bindings yet,
+ * so this stays `'ethereum'` until Solana support lands.
+ */
+type WalletProtocol = 'ethereum';
+/**
+ * EVM addresses keep a `0x${string}` base so they stay assignable to the
+ * `0x${string}` shapes that on-chain libraries (viem/wagmi) expect. We only
+ * drop the runtime `0x` narrowing: values are trusted at the boundary and
+ * branded via the constructor.
+ */
+type EvmWalletAddress = Newtype<`0x${string}`, 'EvmWalletAddress'>;
+declare const EvmWalletAddress: (value: string) => EvmWalletAddress;
+type EvmContractAddress = Newtype<`0x${string}`, 'EvmContractAddress'>;
+declare const EvmContractAddress: (value: string) => EvmContractAddress;
+type HexEncodedTransactionData = Newtype<`0x${string}`, 'HexEncodedTransactionData'>;
+declare const HexEncodedTransactionData: (value: string) => HexEncodedTransactionData;
+type AssetDecimals = Newtype<number, 'AssetDecimals'>;
+declare const AssetDecimals: (value: number) => AssetDecimals;
+declare const MAX_UINT_256: bigint;
+/**
+ * A non-negative integer within uint256 bounds. Kept unbranded (a plain
+ * `bigint`) so raw on-chain amounts flow in without ceremony; bounds are
+ * enforced where it matters (see {@link combineAmounts}).
+ */
+type Uint256 = bigint;
+/**
+ * Asserts a raw bigint falls within uint256 bounds, throwing otherwise. Use at
+ * on-chain arithmetic boundaries (bps math, price computation) where a computed
+ * value could underflow below zero or overflow above 2^256-1.
+ */
+declare const assertUint256: (value: bigint) => Uint256;
+type BlockchainAmount = Newtype<{
+    raw: Uint256;
+    decimals: AssetDecimals;
+}, 'BlockchainAmount'>;
+/**
+ * Constructs a {@link BlockchainAmount} and exposes arithmetic helpers.
+ * TypeScript has no operator overloading, so use `BlockchainAmount.add(a, b)`
+ * instead of `+`/`-` on the objects directly.
+ */
+declare const BlockchainAmount: ((value: {
+    raw: Uint256;
+    decimals: AssetDecimals;
+}) => BlockchainAmount) & {
+    add: (a: BlockchainAmount, b: BlockchainAmount) => BlockchainAmount;
+    sub: (a: BlockchainAmount, b: BlockchainAmount) => BlockchainAmount;
+};
+type AssetSymbol = Newtype<string, 'AssetSymbol'>;
+declare const AssetSymbol: (value: string) => AssetSymbol;
+/**
+ * A stablecoin symbol is an {@link AssetSymbol} narrowed to the coins we
+ * support. It shares the `AssetSymbol` brand so it stays assignable to it.
+ */
+type StablecoinSymbol = Newtype<'USDC' | 'USDT', 'AssetSymbol'>;
+declare const StablecoinSymbol: (value: "USDC" | "USDT") => StablecoinSymbol;
+type KnownAssetSymbol = StablecoinSymbol;
+declare const KnownAssetSymbol: (value: "USDC" | "USDT") => StablecoinSymbol;
+type Erc20Asset = {
+    name: string;
+    symbol: AssetSymbol;
+    decimals: AssetDecimals;
+};
+type Bps = Newtype<bigint, 'Bps'>;
+declare const Bps: (value: bigint) => Bps;
+
+/**
+ * Raw JSON models for the on-chain swap endpoints. uint256 values are encoded
+ * as decimal strings because they can exceed the safe integer range of JSON
+ * consumers.
+ */
+type WalletAuthorizationDto = {
+    object: 'wallet_authorization';
+    authorized: boolean;
+};
+type SwapPreviewDto = {
+    object: 'swap_preview';
+    pay_input_amount: string;
+    fee: string;
+    receive_output_amount: string;
+};
+type SwapStatusDto = {
+    object: 'swap_status';
+    stopped: string;
+    swap_level: string;
+};
+type TokenAllowanceDto = {
+    object: 'token_allowance';
+    allowance: string;
+};
+type TokenBalanceDto = {
+    object: 'token_balance';
+    balance: string;
+};
+type AllowWalletResponseDto = {
+    action: 'broadcast_transaction';
+    to: string;
+    data: string;
+} | {
+    action: 'none';
+    already_allowed: boolean;
+};
+
+/**
+ * Whether a wallet is authorized to interact with a given swap contract.
+ */
+type SwapAuthorization = {
+    authorized: boolean;
+};
+declare const SwapAuthorization: {
+    fromDto: (dto: WalletAuthorizationDto) => SwapAuthorization;
+};
+/**
+ * A read-only quote for a swap: how much goes in, the protocol fee, and how
+ * much would come out. All amounts are raw on-chain integers (uint256).
+ */
+type SwapPreview = {
+    inputAmount: Uint256;
+    fee: Uint256;
+    outputAmount: Uint256;
+};
+declare const SwapPreview: {
+    fromDto: (dto: SwapPreviewDto) => SwapPreview;
+};
+/**
+ * The on-chain state of a swap contract.
+ *
+ * - `stopped`: non-zero when the contract is paused/halted.
+ * - `swapLevel`: the current swap level/tier.
+ */
+type SwapStatus = {
+    stopped: Uint256;
+    swapLevel: Uint256;
+};
+declare const SwapStatus: {
+    fromDto: (dto: SwapStatusDto) => SwapStatus;
+};
+/**
+ * The ERC-20 allowance an owner has granted a spender for a token.
+ */
+type TokenAllowance = {
+    allowance: Uint256;
+};
+declare const TokenAllowance: {
+    fromDto: (dto: TokenAllowanceDto) => TokenAllowance;
+};
+/**
+ * The raw ERC-20 balance an owner holds of a token (uint256).
+ */
+type TokenBalance = {
+    balance: Uint256;
+};
+declare const TokenBalance: {
+    fromDto: (dto: TokenBalanceDto) => TokenBalance;
+};
+/**
+ * The backend's response to an allow-wallet request. Either the caller must
+ * broadcast an on-chain transaction to complete allow-listing, or nothing is
+ * required because the wallet is already allowed.
+ */
+type AllowWalletResponse = {
+    action: 'broadcast_transaction';
+    to: EvmContractAddress;
+    data: HexEncodedTransactionData;
+} | {
+    action: 'none';
+    alreadyAllowed: boolean;
+};
+declare const AllowWalletResponse: {
+    fromDto: (dto: AllowWalletResponseDto) => AllowWalletResponse;
+};
+
+/**
+ * OAuth 2.0 token response (RFC 6749 §5.1).
+ * Maps to OpenAPI schema OauthToken.
+ */
+type OAuthSessionDto = {
+    access_token: string;
+    expires_in: number;
+    refresh_token?: string;
+};
+
+type ClientCredentialsOAuth = Newtype<OAuthAccessToken, 'ClientCredentialsOAuth'>;
+declare const ClientCredentialsOAuth: (value: OAuthAccessToken) => ClientCredentialsOAuth;
+type OAuthAccessToken = {
+    value: string;
+    expiresAt: Date;
+};
+type OAuthRefreshToken = Newtype<string, 'OAuthRefreshToken'>;
+declare const OAuthRefreshToken: (value: string) => OAuthRefreshToken;
+type OAuthSession = {
+    accessToken: OAuthAccessToken;
+    refreshToken?: OAuthRefreshToken;
+};
+declare const OAuthSession: {
+    fromDto: (dto: OAuthSessionDto) => OAuthSession;
+};
+
+type HttpRequestAttributes = {
+    protected?: boolean;
+    userAgent?: boolean;
+    idempotencyKey?: boolean;
+    /** Zero-based attempt index: 0 = first request, 1 = first retry, etc. */
+    retryAttempt?: number;
+    renewAttempted?: boolean;
+    clientCredentials?: ClientCredentialsOAuth;
+};
+
+type QueryParamValue = string | number | boolean | null | undefined;
+type QueryParamValues = QueryParamValue | QueryParamValue[];
+type HttpRequest<TBody = unknown> = {
+    method: 'GET';
+    url: string;
+    queryParams?: Record<string, QueryParamValues>;
+    headers?: Record<string, string>;
+    attributes?: HttpRequestAttributes;
+    redirect?: RequestRedirect;
+} | {
+    method: 'POST';
+    url: string;
+    queryParams?: Record<string, QueryParamValues>;
+    headers?: Record<string, string>;
+    body: TBody;
+    attributes?: HttpRequestAttributes;
+    redirect?: RequestRedirect;
+} | {
+    method: 'DELETE';
+    url: string;
+    queryParams?: Record<string, QueryParamValues>;
+    headers?: Record<string, string>;
+    attributes?: HttpRequestAttributes;
+    redirect?: RequestRedirect;
+};
+
+/**
+ * Structural interface satisfied by both {@link AuthenticatedApiClient} and
+ * {@link ApiClient}. Used by the shared frontline API functions so they can
+ * be called from either the client or server without any browser dependencies.
+ */
+interface Sender {
+    send<T>(request: HttpRequest): Promise<T>;
+}
+
+interface SharedNamespaceContext {
+    readonly api: Sender;
+    ensureUserAuthenticated(): Promise<void>;
+}
+
+type OfferDto = {
+    id: string;
+    slug: string;
+    tagline: string | null | undefined;
+    banner_url: string | null | undefined;
+    logo_url: string | null | undefined;
+    starts_at: string;
+    ends_at: string;
+};
+
+type OfferId = Newtype<string, 'OfferId'>;
+declare const OfferId: (value: string) => OfferId;
+type OfferSlug = Newtype<string, 'OfferSlug'>;
+declare const OfferSlug: (value: string) => OfferSlug;
+type Offer = {
+    id: OfferId;
+    slug: OfferSlug;
+    tagline: string | null;
+    bannerUrl: string | null;
+    logoUrl: string | null;
+    startsAt: Date;
+    endsAt: Date;
+};
+declare const Offer: {
+    fromDto: (dto: OfferDto) => Offer;
+};
+
+/** Challenge kinds accepted by `POST /v1/wallet-ownership`. */
+type WalletOwnershipChallengeTypeDto = 'plain' | 'siwe';
+/**
+ * Request body for `POST /v1/wallet-ownership`. `challenge_type` defaults to
+ * `plain` on the backend; the SIWE fields (`domain`, `uri`, `statement`) are
+ * required only when `challenge_type` is `siwe` and must be absent otherwise.
+ */
+type CreateWalletOwnershipChallengeDto = {
+    wallet_address: string;
+    chain: string;
+    challenge_type?: WalletOwnershipChallengeTypeDto;
+    domain?: string;
+    uri?: string;
+    statement?: string;
+};
+/** Response body for `POST /v1/wallet-ownership`. */
+type WalletOwnershipChallengeDto = {
+    message: string;
+    expires_at: string;
+};
+
+/** Fields common to every wallet-ownership challenge request. */
+type WalletOwnershipChallengeParamsBase = {
+    /** Wallet address to prove ownership of. */
+    walletAddress: EvmWalletAddress;
+    /** Chain the wallet belongs to. */
+    chain: EthereumChain;
+};
+/**
+ * How the ownership challenge is framed: a plain message or a Sign-In With
+ * Ethereum challenge. Extracted as its own type so SDK consumers can pass it as
+ * a standalone param without reaching into the {@link CreateWalletOwnershipChallengeParams}
+ * union.
+ */
+type WalletChallengeType = CreateWalletOwnershipChallengeParams['challengeType'];
+/**
+ * A single-use ownership challenge returned by `POST /v1/wallet-ownership`.
+ * The consumer signs {@link message} with their wallet, then submits the
+ * signature to connect the wallet to an offer option.
+ */
+type WalletOwnershipChallenge = {
+    /** The message the wallet must sign. */
+    message: string;
+    /** When the challenge expires and can no longer be consumed. */
+    expiresAt: Date;
+};
+declare const WalletOwnershipChallenge: {
+    /** Maps the API DTO into the SDK wallet-ownership-challenge domain model. */
+    fromDto: (dto: WalletOwnershipChallengeDto) => WalletOwnershipChallenge;
+};
+/**
+ * Parameters for requesting a wallet-ownership challenge. Modeled as a
+ * discriminated union on `challengeType` so a `siwe` challenge must carry
+ * `domain`/`uri`/`statement`, matching the backend contract at compile time.
+ */
+type CreateWalletOwnershipChallengeParams = (WalletOwnershipChallengeParamsBase & {
+    /** A bare message the wallet signs. */
+    challengeType: 'plain';
+}) | (WalletOwnershipChallengeParamsBase & {
+    /** Marks this as a Sign-In With Ethereum challenge. */
+    challengeType: 'siwe';
+    /** The requesting site's hostname (e.g. `example.com`). */
+    domain: string;
+    /** The requesting site's URI. */
+    uri: string;
+    /** Human-readable statement shown in the signing prompt. */
+    statement: string;
+});
+declare const CreateWalletOwnershipChallengeParams: {
+    /**
+     * Maps challenge-request params into the API DTO payload. The discriminated
+     * union guarantees SIWE fields are present exactly when `challengeType` is
+     * `siwe`, so the mapping narrows on the discriminant.
+     */
+    toDto: (params: CreateWalletOwnershipChallengeParams) => CreateWalletOwnershipChallengeDto;
+};
+
+/** Parameters shared by contract reads scoped to a chain. */
+type SwapContractRef = {
+    contractAddress: EvmContractAddress;
+    chain: EthereumChain;
+};
+type GetSwapAuthorizationParams = SwapContractRef & {
+    walletAddress: EvmWalletAddress;
+};
+type GetSwapPreviewParams = SwapContractRef & {
+    inputToken: EvmContractAddress;
+    amount: bigint;
+};
+type GetTokenAllowanceParams = {
+    tokenAddress: EvmContractAddress;
+    owner: EvmWalletAddress;
+    spender: EvmContractAddress;
+    chain: EthereumChain;
+};
+type GetTokenBalanceParams = {
+    tokenAddress: EvmContractAddress;
+    owner: EvmWalletAddress;
+    chain: EthereumChain;
+};
+type AllowWalletParams = {
+    offerId: OfferId;
+    walletAddress: EvmWalletAddress;
+    chain: EthereumChain;
+    signature: string;
+};
+/**
+ * Read/write operations for the on-chain swap flow: quoting a swap, inspecting
+ * contract state, checking token allowances, and proving/allow-listing wallet
+ * ownership.
+ */
+interface CoinListSwapNamespace {
+    /**
+     * Checks whether a wallet is authorized to swap against the given contract.
+     */
+    getAuthorization(params: GetSwapAuthorizationParams): Promise<SwapAuthorization>;
+    /**
+     * Fetches a read-only quote for swapping `amount` of `inputToken`.
+     */
+    getPreview(params: GetSwapPreviewParams): Promise<SwapPreview>;
+    /**
+     * Reads the current on-chain state of a swap contract.
+     */
+    getStatus(params: SwapContractRef): Promise<SwapStatus>;
+    /**
+     * Reads the ERC-20 allowance an `owner` has granted a `spender`.
+     */
+    getTokenAllowance(params: GetTokenAllowanceParams): Promise<TokenAllowance>;
+    /**
+     * Reads the raw ERC-20 balance an `owner` holds of a token.
+     */
+    getTokenBalance(params: GetTokenBalanceParams): Promise<TokenBalance>;
+    /**
+     * Reads the ERC-20 output token a swap contract pays out.
+     */
+    getOutputToken(params: SwapContractRef): Promise<Erc20Asset>;
+    /**
+     * Requests a single-use challenge the user must sign to prove wallet
+     * ownership, via `POST /v1/wallet-ownership`. Supports both `plain` and
+     * `siwe` challenges. This is the same operation as the top-level
+     * `createWalletOwnershipChallenge`, scoped under the swap namespace for the
+     * allow-wallet flow.
+     */
+    requestWalletOwnershipChallenge(params: CreateWalletOwnershipChallengeParams): Promise<WalletOwnershipChallenge>;
+    /**
+     * Submits a signed wallet-ownership challenge to allow-list the wallet for
+     * an offer, identified by its offer id.
+     */
+    allowWallet(params: AllowWalletParams): Promise<AllowWalletResponse>;
+}
+declare class SwapNamespaceImpl implements CoinListSwapNamespace {
+    private readonly ctx;
+    constructor(ctx: SharedNamespaceContext);
+    getAuthorization(params: GetSwapAuthorizationParams): Promise<SwapAuthorization>;
+    getPreview(params: GetSwapPreviewParams): Promise<SwapPreview>;
+    getStatus(params: SwapContractRef): Promise<SwapStatus>;
+    getTokenAllowance(params: GetTokenAllowanceParams): Promise<TokenAllowance>;
+    getTokenBalance(params: GetTokenBalanceParams): Promise<TokenBalance>;
+    getOutputToken(params: SwapContractRef): Promise<Erc20Asset>;
+    requestWalletOwnershipChallenge(params: CreateWalletOwnershipChallengeParams): Promise<WalletOwnershipChallenge>;
+    allowWallet(params: AllowWalletParams): Promise<AllowWalletResponse>;
+}
+
+type AuthorizationCode = Newtype<string, 'AuthorizationCode'>;
+declare const AuthorizationCode: (value: string) => AuthorizationCode;
+type CodeVerifier = Newtype<string, 'CodeVerifier'>;
+declare const CodeVerifier: (value: string) => CodeVerifier;
+type CodeChallenge = Newtype<string, 'CodeChallenge'>;
+declare const CodeChallenge: (value: string) => CodeChallenge;
+type PKCEState = Newtype<string, 'PKCEState'>;
+declare const PKCEState: (value: string) => PKCEState;
+type RedirectUri = Newtype<string, 'RedirectUri'>;
+declare const RedirectUri: (value: string) => RedirectUri;
+type ClientId = Newtype<string, 'ClientId'>;
+declare const ClientId: (value: string) => ClientId;
+type ClientSecret = Newtype<string, 'ClientSecret'>;
+declare const ClientSecret: (value: string) => ClientSecret;
+
+type Cursor = Newtype<string, 'Cursor'>;
+declare const Cursor: (value: string) => Cursor;
+interface PaginatedResponseDto<T> {
+    data: T[];
+    starting_after?: string;
+    starting_before?: string;
+}
+declare function fetchAllPages<A, P extends PaginationParams = PaginationParams>(fetchPage: (params: P) => Promise<PaginatedResponse<A>>, baseParams?: Omit<P, keyof PaginationParams>): Promise<A[]>;
+interface PaginatedResponse<T> {
+    data: T[];
+    startingAfter: Cursor | null;
+    startingBefore: Cursor | null;
+}
+declare const PaginatedResponse: {
+    fromDto: <A, B>(dto: PaginatedResponseDto<A>, itemMapper: (item: A) => B) => PaginatedResponse<B>;
+};
+/**
+ * Cursor-based pagination input used when requesting paginated API resources.
+ * Set `after` or `before` to navigate relative to a known cursor, and `limit`
+ * to control the maximum number of returned items.
+ */
+interface PaginationParams {
+    before?: Cursor;
+    after?: Cursor;
+    limit?: number;
+}
+declare const PaginationParams: {
+    toQueryParams: (params: PaginationParams) => Record<string, QueryParamValue>;
+};
+
+interface Config {
+    /** OAuth2 public identifier. */
+    readonly clientId: ClientId;
+    /**
+     * OAuth2 redirect URI. Recommended to point to a frontend page where
+     * {@link CoinListClient#completeOauth} can be called to complete the PKCE
+     * flow on the client side.
+     */
+    readonly redirectUri: RedirectUri;
+    /**
+     * Recommended to leave undefined. Used to change the CoinList environment;
+     * default is production.
+     */
+    readonly baseUrl?: string;
+}
+
+type DocumentSubmissionStatusDto = 'INITIALIZED' | 'SENT' | 'VIEWED' | 'COMPLETED' | 'DECLINED' | 'EXPIRED';
+type DocumentFormTypeDto = 'w8_ben' | 'w8_ben_e';
+type DocumentSubmissionDto = {
+    object: 'document_submission';
+    status: DocumentSubmissionStatusDto;
+    form_type: DocumentFormTypeDto;
+};
+
+/** Document types that can be signed via {@link CoinListClient.submitDocument}. */
+type DocumentType = 'tax_certification';
+/** Signing-state machine status for a document submission. */
+type DocumentSubmissionStatus = DocumentSubmissionStatusDto;
+/** The tax form derived from the entity's kind (individual vs company/trust). */
+type DocumentFormType = DocumentFormTypeDto;
+/** Result of starting (or resuming) a document signing submission. */
+type DocumentSubmission = {
+    status: DocumentSubmissionStatus;
+    formType: DocumentFormType;
+};
+declare const DocumentSubmission: {
+    fromDto: (dto: DocumentSubmissionDto) => DocumentSubmission;
+};
+
+type KycTokenDto = {
+    object: 'kyc_token';
+    token: string;
+};
+
+/**
+ * Sumsub verification level name. Determines which screens the Sumsub WebSDK
+ * shows (levels are configured in the Sumsub dashboard). The backend
+ * prescribes the level (and whether the applicant must be reset first) in the
+ * requirement statuses response — clients never compute levels themselves.
+ */
+type KycLevelName = string;
+/** Short-lived Sumsub WebSDK access token scoped to the current user. */
+type KycToken = {
+    token: string;
+};
+declare const KycToken: {
+    fromDto: (dto: KycTokenDto) => KycToken;
+};
+
+type AssetDto = {
+    code: string;
+    fractional_digits: number;
+    id: string;
+    name: string;
+};
+
+type AssetId = Newtype<string, 'AssetId'>;
+declare const AssetId: (value: string) => AssetId;
+type AssetCode = Newtype<string, 'AssetCode'>;
+declare const AssetCode: (value: string) => AssetCode;
+type Asset = {
+    id: AssetId;
+    code: AssetCode;
+    name: string;
+    fractionalDigits: number;
+};
+declare const Asset: {
+    fromDto: (dto: AssetDto) => Asset;
+};
+
+type OfferDetailDto = {
+    asset: AssetDto;
+    faqs: OfferDetailFaqDto[];
+    funding_assets: AssetDto[];
+    id: string;
+    links: OfferDetailLinkDto[];
+    milestones: OfferDetailMilestoneDto[];
+    name: string;
+    object: 'offer_details';
+    options: OfferDetailOptionDto[];
+    slug: string;
+    terms: OfferDetailTermDto[];
+    about: string | null | undefined;
+    banner_url: string | null | undefined;
+    category: string | null | undefined;
+    ends_at: string;
+    logo_url: string | null | undefined;
+    starts_at: string;
+    tagline: string | null | undefined;
+};
+type OfferDetailFaqDto = {
+    answer: string | null;
+    question: string | null;
+};
+type OfferDetailLinkDto = {
+    label: string | null;
+    url: string | null;
+};
+type OfferDetailMilestoneDto = {
+    name: string | null;
+    schedule: string | null;
+    status: 'completed' | 'active' | 'upcoming';
+};
+type OfferDetailOptionDto = {
+    bid_increment: number | null;
+    floor_price_usd: number | null;
+    id: string;
+    minimum_purchase_usd: number | null;
+    price_usd: string | null;
+    sale_agreement_url: string | null;
+    slug: string;
+    total_token_supply: number | null;
+};
+type OfferDetailTermDto = {
+    key: string | null;
+    value: string | null;
+};
+
+type OfferOptionId = Newtype<string, 'OfferOptionId'>;
+declare const OfferOptionId: (value: string) => OfferOptionId;
+type OfferOptionSlug = Newtype<string, 'OfferOptionSlug'>;
+declare const OfferOptionSlug: (value: string) => OfferOptionSlug;
+type OfferDetail = {
+    id: OfferId;
+    slug: OfferSlug;
+    name: string;
+    asset: Asset;
+    fundingAssets: Asset[];
+    about: string | null;
+    tagline: string | null;
+    bannerUrl: string | null;
+    logoUrl: string | null;
+    category: string | null;
+    startsAt: Date;
+    endsAt: Date;
+    faqs: FaqItem[];
+    links: Link[];
+    milestones: Milestone[];
+    options: OfferOption[];
+    terms: TermItem[];
+};
+declare const OfferDetail: {
+    fromDto: (dto: OfferDetailDto) => OfferDetail;
+};
+type OfferOption = {
+    id: OfferOptionId;
+    slug: OfferOptionSlug;
+    bidIncrement: number | null;
+    floorPriceUsd: number | null;
+    minimumPurchaseUsd: number | null;
+    priceUsd: string | null;
+    saleAgreementUrl: string | null;
+    totalTokenSupply: number | null;
+};
+declare const OfferOption: {
+    fromDto: (dto: OfferDetailOptionDto) => OfferOption;
+};
+type FaqItem = {
+    question: string | null;
+    answer: string | null;
+};
+declare const FaqItem: {
+    fromDto: (dto: OfferDetailFaqDto) => FaqItem;
+};
+type Link = {
+    label: string | null;
+    url: string | null;
+};
+declare const Link: {
+    fromDto: (dto: OfferDetailLinkDto) => Link;
+};
+type TermItem = {
+    key: string | null;
+    value: string | null;
+};
+declare const TermItem: {
+    fromDto: (dto: OfferDetailTermDto) => TermItem;
+};
+type Milestone = {
+    name: string | null;
+    schedule: string | null;
+    status: 'completed' | 'active' | 'upcoming';
+};
+declare const Milestone: {
+    fromDto: (dto: OfferDetailMilestoneDto) => Milestone;
+};
+
+/** Request body for `POST /v1/offers/:offer_id/addresses`. */
+type CreateOfferOptionAddressDto = {
+    offer_option_id: string;
+    wallet_address: string;
+    chain: string;
+    signature: string;
+};
+/** Binding object returned by the `/v1/offers/:offer_id/addresses` resource. */
+type OfferOptionAddressDto = {
+    id: string;
+    offer_option_id: string;
+    address: string;
+    protocol: WalletProtocol;
+    created_at: string;
+};
+
+/** Unique identifier for a proven wallet binding on an offer option. */
+type OfferOptionAddressId = Newtype<string, 'OfferOptionAddressId'>;
+/** Casts a string into a typed {@link OfferOptionAddressId}. */
+declare const OfferOptionAddressId: (value: string) => OfferOptionAddressId;
+/**
+ * A user's external wallet, proven via a wallet-ownership challenge and bound
+ * to an offer option. Returned by the `/v1/offers/:offer_id/addresses` resource.
+ */
+type OfferOptionAddress = {
+    /** Unique binding id. */
+    id: OfferOptionAddressId;
+    /** Offer option the wallet is bound to. */
+    offerOptionId: OfferOptionId;
+    /** The connected external wallet address. */
+    address: EvmWalletAddress;
+    /**
+     * Protocol the binding is scoped to. An EVM address binds once per option
+     * regardless of which EVM chain proved ownership.
+     */
+    protocol: WalletProtocol;
+    /** When the binding was created. */
+    createdAt: Date;
+};
+declare const OfferOptionAddress: {
+    /** Maps the API DTO into the SDK offer-option-address domain model. */
+    fromDto: (dto: OfferOptionAddressDto) => OfferOptionAddress;
+};
+/** Parameters required to connect a proven external wallet to an offer option. */
+type ConnectExternalWalletParams = {
+    /** Offer option to bind the wallet to. */
+    offerOptionId: OfferOptionId;
+    /** External wallet address that was proven. */
+    walletAddress: EvmWalletAddress;
+    /** Chain the ownership was proven on. */
+    chain: EthereumChain;
+    /** Signature of the wallet-ownership challenge message. */
+    signature: Hex;
+};
+declare const ConnectExternalWalletParams: {
+    /** Maps connect-wallet params into the API DTO payload. */
+    toDto: (params: ConnectExternalWalletParams) => CreateOfferOptionAddressDto;
+};
+
+type ParticipationStatusDto = 'prepared' | 'pending' | 'submitted' | 'completed' | 'failed' | 'remit_submitted' | 'remitted' | 'remit_failed';
+type ParticipationDto = {
+    object: 'participation';
+    id: string;
+    offer_id: string;
+    offer_option_id: string;
+    status: ParticipationStatusDto;
+    amount: string;
+    amount_string: string;
+    asset: AssetDto;
+    chain: string;
+    inserted_at: string | null | undefined;
+    updated_at: string | null | undefined;
+    wallet_address: string | null | undefined;
+};
+type CreateParticipationDto = {
+    offer_id: string;
+    offer_option_id: string;
+    chain: string;
+    wallet_address: string;
+    amount: string;
+    asset_id: string;
+    approval_transaction_hash: string | null | undefined;
+};
+
+/** Unique identifier for a participation. */
+type ParticipationId = Newtype<string, 'ParticipationId'>;
+/** Casts a string into a typed {@link ParticipationId}. */
+declare const ParticipationId: (value: string) => ParticipationId;
+/** Blockchain identifier for where a participation is funded. */
+type Blockchain = Newtype<string, 'Blockchain'>;
+/** Casts a string into a typed {@link Blockchain}. */
+declare const Blockchain: (value: string) => Blockchain;
+/** Wallet address used for a participation. */
+type WalletAddress = Newtype<`0x${string}`, 'WalletAddress'>;
+/** Casts a `0x`-prefixed string into a typed {@link WalletAddress}. */
+declare const WalletAddress: (value: `0x${string}`) => WalletAddress;
+/** Possible participation lifecycle states returned by the API. */
+type ParticipationStatus = ParticipationStatusDto;
+/** Pagination params for listing participations, with an optional offer filter. */
+interface ParticipationsPaginationParams extends PaginationParams {
+    offerId?: OfferId;
+}
+declare const ParticipationsPaginationParams: {
+    toQueryParams: (params: ParticipationsPaginationParams) => Record<string, QueryParamValue>;
+};
+/** Domain model for a participation returned by CoinList APIs. */
+type Participation = {
+    /** Unique participation id. */
+    id: ParticipationId;
+    /** Parent offer id. */
+    offerId: OfferId;
+    /** Selected offer option id. */
+    offerOptionId: OfferOptionId;
+    /** Current processing status. */
+    status: ParticipationStatus;
+    /** Raw participation amount from API. */
+    amount: string;
+    /** Human-readable formatted amount from API. */
+    displayAmount: string;
+    /** Asset metadata for the participation amount. */
+    asset: Asset;
+    /** Funding chain identifier. */
+    chain: Blockchain;
+    /** Creation timestamp, if returned by API. */
+    insertedAt: Date | null;
+    /** Last update timestamp, if returned by API. */
+    updatedAt: Date | null;
+    /** Wallet used for participation, blank values normalized to null. */
+    walletAddress: WalletAddress | null;
+};
+declare const Participation: {
+    /** Maps API DTO shape into the SDK participation domain model. */
+    fromDto: (dto: ParticipationDto) => Participation;
+};
+/** Parameters required to create a new participation. */
+type CreateParticipationParams = {
+    /** Offer to participate in. */
+    offerId: OfferId;
+    /** Offer option selected for participation. */
+    offerOptionId: OfferOptionId;
+    /** Blockchain for funding. */
+    chain: Blockchain;
+    /** Wallet address that funds the participation. */
+    walletAddress: WalletAddress;
+    /** Raw amount to participate with. */
+    amount: string;
+    /** Funding asset id. */
+    assetId: AssetId;
+    /** Approval transaction hash of allowance transaction. */
+    approvalTransactionHash: string;
+};
+declare const CreateParticipationParams: {
+    /** Maps participation creation params into API DTO payload. */
+    toDto: (params: CreateParticipationParams) => CreateParticipationDto;
+};
+
+type PiiKindDto = 'person' | 'company';
+type PiiJurisdictionDto = {
+    iso_2: string;
+    name: string | null;
+};
+type PiiAddressDto = {
+    street: string | null;
+    city: string | null;
+    state: string | null;
+    postal_code: string | null;
+    country: string | null;
+};
+type PiiDto = {
+    object: 'user_pii';
+    kind: PiiKindDto;
+    full_legal_name: string | null;
+    date_of_birth: string | null;
+    jurisdiction: PiiJurisdictionDto | null;
+    tax_id: string | null;
+    permanent_address: PiiAddressDto;
+};
+
+/** Whether the PII belongs to an individual or a company/trust entity. */
+type PiiKind = PiiKindDto;
+/** ISO 3166-1 alpha-2 country code (e.g. `'US'`). */
+type Iso2CountryCode = Newtype<string, 'Iso2CountryCode'>;
+declare const Iso2CountryCode: (value: string) => Iso2CountryCode;
+/** Jurisdiction derived from the entity's address country. */
+type PiiJurisdiction = {
+    iso2: Iso2CountryCode;
+    name: string | null;
+};
+declare const PiiJurisdiction: {
+    fromDto: (dto: PiiJurisdictionDto) => PiiJurisdiction;
+};
+/** Permanent address on file for the entity. */
+type PiiAddress = {
+    street: string | null;
+    city: string | null;
+    state: string | null;
+    postalCode: string | null;
+    country: string | null;
+};
+declare const PiiAddress: {
+    fromDto: (dto: PiiAddressDto) => PiiAddress;
+};
+/**
+ * The current user's PII, used to pre-fill tax forms such as the W-8BEN.
+ * Fields the entity hasn't provided are `null`.
+ */
+type Pii = {
+    kind: PiiKind;
+    fullLegalName: string | null;
+    dateOfBirth: string | null;
+    jurisdiction: PiiJurisdiction | null;
+    taxId: string | null;
+    permanentAddress: PiiAddress;
+};
+declare const Pii: {
+    fromDto: (dto: PiiDto) => Pii;
+};
+
+type RequirementTypeDto = 'kyc_approved' | 'identity_verified' | 'proof_of_address' | 'source_of_funds' | 'external_wallet' | 'whitelisted_wallet' | 'jurisdiction' | 'accreditation' | 'document';
+type RequirementDto = {
+    object: 'requirement';
+    id: string;
+    type: RequirementTypeDto;
+    details: Record<string, unknown> | null;
+};
+type RequirementStatusValueDto = 'not_started' | 'in_progress' | 'action_needed' | 'completed' | 'rejected';
+type RequirementActionNeededReasonDto = 'kyc_not_verified' | 'update_pii_data';
+/**
+ * Object form of a requirement status, used when the status carries extra
+ * data: the action-needed reason and/or the Sumsub flow that resolves the
+ * requirement (kyc_level + kyc_reset, forwarded to the kyc-token endpoint).
+ */
+type RequirementStatusObjectDto = {
+    status: RequirementStatusValueDto;
+    action?: RequirementActionNeededReasonDto;
+    kyc_level?: string;
+    kyc_reset?: boolean;
+};
+type RequirementStatusesDto = {
+    object: 'requirement_statuses';
+    offer_id: string;
+    statuses: Record<string, RequirementStatusValueDto | RequirementStatusObjectDto>;
+};
+
+type RequirementId = Newtype<string, 'RequirementId'>;
+declare const RequirementId: (value: string) => RequirementId;
+type RequirementType = RequirementTypeDto;
+type RequirementStatusValue = RequirementStatusValueDto;
+type RequirementActionNeededReason = RequirementActionNeededReasonDto;
+type Requirement = {
+    id: RequirementId;
+    type: RequirementType;
+    details: Record<string, unknown> | null;
+};
+declare const Requirement: {
+    fromDto: (dto: RequirementDto) => Requirement;
+};
+type RequirementStatusInfo = {
+    id: RequirementId;
+    status: RequirementStatusValue;
+    /** Why the requirement needs action (KYC-backed requirements only). */
+    action: RequirementActionNeededReason | null;
+    /**
+     * The Sumsub verification level that resolves this requirement, prescribed
+     * by the backend. Present exactly when an inline Sumsub flow can be started.
+     */
+    kycLevel?: KycLevelName;
+    /**
+     * Whether the Sumsub applicant must be reset before starting the flow
+     * (redoing an already-approved level, e.g. to update stale PII). Forward to
+     * the kyc-token request as-is.
+     */
+    kycReset?: boolean;
+};
+declare const RequirementStatusInfo: {
+    fromStatusesDto: (dto: RequirementStatusesDto) => RequirementStatusInfo[];
+};
+
+export { Asset as $, AuthorizationCode as A, Bps as B, type CoinListSwapNamespace as C, type DocumentType as D, EvmWalletAddress as E, AssetDecimals as F, StablecoinSymbol as G, OAuthSession as H, ClientCredentialsOAuth as I, ClientSecret as J, type KycLevelName as K, AssetSymbol as L, SwapStatus as M, type Newtype as N, OfferId as O, PaginationParams as P, KnownAssetSymbol as Q, Requirement as R, SwapNamespaceImpl as S, ClientId as T, type Uint256 as U, RedirectUri as V, WalletOwnershipChallenge as W, CodeChallenge as X, PKCEState as Y, type AllowWalletParams as Z, AllowWalletResponse as _, type EthereumChain as a, AssetCode as a0, AssetId as a1, Blockchain as a2, Cursor as a3, type DocumentFormType as a4, type DocumentSubmissionStatus as a5, FaqItem as a6, type GetSwapAuthorizationParams as a7, type GetSwapPreviewParams as a8, type GetTokenAllowanceParams as a9, fetchAllPages as aA, type GetTokenBalanceParams as aa, HexEncodedTransactionData as ab, Iso2CountryCode as ac, Link as ad, MAX_UINT_256 as ae, Milestone as af, OAuthRefreshToken as ag, OfferOption as ah, OfferOptionSlug as ai, OfferSlug as aj, type PaginatedResponseDto as ak, type ParticipationStatus as al, PiiAddress as am, PiiJurisdiction as an, type PiiKind as ao, type RequirementActionNeededReason as ap, RequirementId as aq, SwapAuthorization as ar, type SwapContractRef as as, SwapPreview as at, TermItem as au, TokenAllowance as av, TokenBalance as aw, WalletAddress as ax, type WalletProtocol as ay, assertUint256 as az, EvmContractAddress as b, BlockchainAmount as c, CodeVerifier as d, type Config as e, type OAuthAccessToken as f, Offer as g, PaginatedResponse as h, OfferDetail as i, Participation as j, ParticipationsPaginationParams as k, ParticipationId as l, CreateParticipationParams as m, CreateWalletOwnershipChallengeParams as n, ConnectExternalWalletParams as o, OfferOptionAddress as p, OfferOptionId as q, OfferOptionAddressId as r, RequirementStatusInfo as s, Pii as t, DocumentSubmission as u, KycToken as v, type WalletChallengeType as w, type RequirementType as x, type RequirementStatusValue as y, type Erc20Asset as z };