@coinlist-co/react 0.12.2-rc.4851c6a → 0.12.2-rc.4cc3d7e

package/dist/{time-Bzgi6FbG.d.ts → time-BgR3LVER.d.ts}

@@ -19,6 +19,17 @@ type ClientId = Newtype<string, 'ClientId'>;
 declare const ClientId: (value: string) => ClientId;
 type ClientSecret = Newtype<string, 'ClientSecret'>;
 declare const ClientSecret: (value: string) => ClientSecret;
+/**
+ * The PKCE pair a finished authorization hands from the browser to the
+ * partner's backend: `CoinListClient#auth.completeOAuth` produces it, and
+ * `CoinListServer#auth.completeOAuth` exchanges it for a session.
+ */
+type AuthorizationGrant = {
+    /** The short-lived authorization code parsed out of the redirect URL. */
+    code: AuthorizationCode;
+    /** The `code_verifier` the browser generated when starting the flow. */
+    codeVerifier: CodeVerifier;
+};
 
 /**
  * A classified wallet or transaction failure. The SDK derives this from
@@ -401,6 +412,12 @@ declare const AsyncOfferDetail: {
 type CoinListTokenSaleOfferDetail = OfferDetailBase & OfferEditorial & {
     type: 'coinlist::token_sale';
     logoUrl: string;
+    /**
+     * Every chain this sale takes participations on, with the contract a
+     * participation's approval names as its spender. Empty means it takes
+     * participations nowhere.
+     */
+    fundingContracts: OfferFundingContract[];
 };
 type SuperstateSwapOfferDetail = OfferDetailBase & OfferEditorial & {
     type: 'superstate::swap';
@@ -546,6 +563,19 @@ type OfferVaultContract = {
     chain: Chain;
     address: EvmContractAddress;
 };
+/**
+ * A chain a CoinList token sale takes participations on, with the contract a
+ * participation's approval names as its spender: the sale pulls the payment
+ * through that allowance once it settles.
+ *
+ * Its own type rather than an {@link OfferVaultContract}, although the shape
+ * is the same, because the meaning is not: nothing is sent to this contract
+ * at checkout, it is only approved.
+ */
+type OfferFundingContract = {
+    chain: Chain;
+    address: EvmContractAddress;
+};
 
 /**
  * One vault: a share token on one chain. What the status and position reads
@@ -559,13 +589,14 @@ type CentrifugeVaultRef = {
     chain: EthereumChain;
 };
 /**
- * Which leg of a vault trade: `invest` turns the funding token into shares,
- * `redeem` turns shares back into the funding token. Each wallet holds one
- * pooled position per vault per direction, and a claim settles one of them.
+ * Which side of a vault trade: `deposit` (buy) turns the funding token into
+ * shares, `redeem` (sell) turns shares back into the funding token. The
+ * contract's own names. Each wallet holds one pooled position per vault per
+ * direction, and a claim settles one of them.
  *
  * @alpha
  */
-type CentrifugeClaimDirection = 'invest' | 'redeem';
+type CentrifugeClaimDirection = 'deposit' | 'redeem';
 /**
  * Why a deposit cannot be placed on a vault right now. Kept verbatim from the
  * wire: frontline publishes it as a closed set for clients to branch on.
@@ -579,13 +610,6 @@ type CentrifugeOrderReason = 'vault_unlinked' | 'vault_halted' | 'proxy_not_perm
  * @alpha
  */
 type CentrifugeVaultReason = Exclude<CentrifugeOrderReason, 'below_minimum'>;
-/**
- * Where a wallet stands on a vault. Not a lifecycle - see
- * {@link CentrifugeVaultPosition.status}.
- *
- * @alpha
- */
-type CentrifugePositionStatus = 'none' | 'pending' | 'partially_filled' | 'filled' | 'claimed';
 /**
  * Whether a deposit can be placed, as one union rather than the wire's
  * `can_order` beside `reasons`: a blocked answer always says why, and an
@@ -675,97 +699,93 @@ type CentrifugeVaultClaimTransaction = CentrifugeVaultTransactionCore & {
     claimableShares: BlockchainAmount;
 };
 /**
- * One wallet's standing on one vault: what it put in, what has settled, and
- * what it can claim. The endpoint a returning user lands on, and the one that
- * says whether to offer the claim.
+ * The funding token a vault is paid in, in that token's decimals. Nominally
+ * distinct from {@link CentrifugeShares}: the two legs settle in opposite
+ * units, and the compiler, not a comment, keeps one from standing in for the
+ * other.
+ *
+ * @alpha
+ */
+type CentrifugeAssets = BlockchainAmount & {
+    readonly [centrifugeUnit]: 'assets';
+};
+/** @alpha */
+declare const CentrifugeAssets: (amount: BlockchainAmount) => CentrifugeAssets;
+/**
+ * A vault's share token, in its decimals. See {@link CentrifugeAssets}.
+ *
+ * @alpha
+ */
+type CentrifugeShares = BlockchainAmount & {
+    readonly [centrifugeUnit]: 'shares';
+};
+/** @alpha */
+declare const CentrifugeShares: (amount: BlockchainAmount) => CentrifugeShares;
+/**
+ * The phantom key {@link CentrifugeAssets} and {@link CentrifugeShares} are
+ * told apart by. A second key rather than a second `Newtype`, because
+ * `BlockchainAmount` already spends the `Newtype` brand: two brands on one key
+ * intersect to `never`, and the units would become assignable to each other.
+ */
+declare const centrifugeUnit: unique symbol;
+/**
+ * One wallet's Deposit (buy) standing on one vault, read from the proxy.
  *
- * The amounts are independent of each other: each piece of a request settles
- * and is claimed on its own, so a wallet can be pending, claimable and claimed
- * at once. There is no per-fulfilment breakdown; settlement pools every
- * fulfilment into one {@link averagePrice}.
+ * The proxy keeps one pooled position per wallet: a FIFO slice of the vault's
+ * queue, which the fund fills on its own schedule. `pending` and `claimable`
+ * coexist - a fill can cover part of the slice - and neither says anything
+ * about earlier claims.
+ *
+ * Both are in the funding token, the unit the proxy tracks a deposit in. The
+ * shares a claim pays are not here: the proxy publishes no claim price, and
+ * its spot `convertToShares` is documented as not being one.
  *
  * @alpha
  */
-type CentrifugeVaultPosition = {
+type CentrifugeDepositPosition = {
     chain: EthereumChain;
-    symbol: AssetSymbol;
+    /** The CoinList proxy the position lives on. */
+    proxy: EvmContractAddress;
     walletAddress: EvmWalletAddress;
-    /**
-     * Derived by frontline from the amounts. Not a lifecycle: a new request
-     * moves it back to `pending` while earlier shares stay claimed.
-     */
-    status: CentrifugePositionStatus;
-    /** Funding token ever requested. */
-    requested: BlockchainAmount;
-    /** Of {@link requested}, what is still queued. */
-    pending: BlockchainAmount;
-    /** Of {@link requested}, what has been fulfilled. */
-    filledAssets: BlockchainAmount;
-    /** Shares the fulfilments earned. Held by the proxy until claimed. */
-    earnedShares: BlockchainAmount;
-    claimedShares: BlockchainAmount;
-    /** Non-zero means a claim will return calldata. */
-    claimableShares: BlockchainAmount;
-    /**
-     * What the wallet holds on the share token. Can exceed
-     * {@link claimedShares}: shares acquired any other way count here.
-     */
-    shareBalance: BlockchainAmount;
-    /** Pooled rate over everything claimed. Null before the first claim. */
-    averagePrice: DecimalString | null;
-    /** Centrifuge froze this wallet on the share token. Blocks claiming. */
-    frozen: boolean;
-    asOf: Date;
+    /** Still queued, not yet filled: `pendingDepositRequest`. */
+    pending: CentrifugeAssets;
+    /** Filled and not yet claimed: `claimableDepositRequest`. A claim takes it all. */
+    claimable: CentrifugeAssets;
 };
 /**
- * One wallet's standing on the redeem side of a vault: shares queued to sell,
- * and the funding token a fill has made claimable. The mirror of
- * {@link CentrifugeVaultPosition}, and as independent of it: a wallet can be
- * investing and redeeming on the same vault at once.
- *
- * TODO(frontline, ENG-1909): built against a guessed wire shape - see
- * `CentrifugeVaultRedeemPositionDto`.
+ * One wallet's Redeem (sell) standing on one vault, read from the proxy. The
+ * mirror of {@link CentrifugeDepositPosition}, in shares, and as independent
+ * of it: a wallet can deposit and redeem on one vault at once.
  *
  * @alpha
  */
-type CentrifugeVaultRedeemPosition = {
+type CentrifugeRedeemPosition = {
     chain: EthereumChain;
-    symbol: AssetSymbol;
+    /** The CoinList proxy the position lives on. */
+    proxy: EvmContractAddress;
     walletAddress: EvmWalletAddress;
-    status: CentrifugePositionStatus;
-    /** Shares still queued for redemption. */
-    pending: BlockchainAmount;
-    /**
-     * Funding token a claim would pay out now. An estimate: the vault prices the
-     * claimable shares at the claim. Non-zero means a claim returns calldata.
-     */
-    claimableAssets: BlockchainAmount;
-    /** Centrifuge froze this wallet on the share token. Blocks claiming. */
-    frozen: boolean;
-    asOf: Date;
+    /** Still queued, not yet filled: `pendingRedeemRequest`. */
+    pending: CentrifugeShares;
+    /** Filled and not yet claimed: `claimableRedeemRequest`. A claim takes it all. */
+    claimable: CentrifugeShares;
 };
 /**
- * One wallet's position on one leg of a vault trade, tagged with the leg. The
- * two legs are read from two endpoints and settle in opposite units - the
- * invest leg queues the funding token and pays out shares, the redeem leg the
- * reverse - so the tag is what says which unit each figure is in.
+ * One wallet's position on one side of a vault trade, tagged with the side.
+ * The two sides are tracked in opposite units - the funding token for
+ * `deposit`, shares for `redeem` - so the tag is what says which unit each
+ * figure is in.
  *
  * @alpha
  */
 type CentrifugeVaultLeg = {
-    direction: 'invest';
-    position: CentrifugeVaultPosition;
+    direction: 'deposit';
+    position: CentrifugeDepositPosition;
 } | {
     direction: 'redeem';
-    position: CentrifugeVaultRedeemPosition;
+    position: CentrifugeRedeemPosition;
 };
 /** @alpha */
 declare const CentrifugeVaultLeg: {
-    /**
-     * What a claim on the leg would collect: shares for `invest`, the funding
-     * token for `redeem`.
-     */
-    claimable: (leg: CentrifugeVaultLeg) => BlockchainAmount;
     /** Whether the leg has anything queued or anything ready to claim. */
     isActive: (leg: CentrifugeVaultLeg) => boolean;
 };
@@ -779,7 +799,7 @@ declare const CentrifugeVaultLeg: {
 type CentrifugeVaultLegId = Newtype<string, 'CentrifugeVaultLegId'>;
 /** @alpha */
 declare const CentrifugeVaultLegId: {
-    /** Addresses compare case-insensitively: frontline echoes them lower case. */
+    /** Addresses compare case-insensitively: a host may pass either case. */
     of: (leg: CentrifugeVaultLeg) => CentrifugeVaultLegId;
 };
 /**
@@ -797,6 +817,96 @@ type CentrifugeVaultClaimProceedsTransaction = CentrifugeVaultTransactionCore &
     claimableAssets: BlockchainAmount;
 };
 
+/**
+ * An absolute URL to a logo image in the token registry. Registry image URLs
+ * are content-fingerprinted and served immutable, so a value is safe to cache
+ * for as long as you hold it.
+ */
+type TokenLogoUrl = Newtype<string, 'TokenLogoUrl'>;
+declare const TokenLogoUrl: (value: string) => TokenLogoUrl;
+type TokenLogoImage = {
+    url: TokenLogoUrl;
+    width: number;
+    height: number;
+};
+/**
+ * `VECTOR` is a single SVG. `RASTER` has webp variants at 32/64/128/256/512px
+ * widths (never wider than the original): use the smallest one that covers
+ * your render size, or `original` if none does.
+ */
+type TokenLogo = {
+    kind: 'VECTOR';
+    url: TokenLogoUrl;
+} | {
+    kind: 'RASTER';
+    original: TokenLogoImage;
+    variants: TokenLogoImage[];
+};
+/**
+ * Display metadata for one token, from CoinList's public token registry.
+ *
+ * Keyed by `(chain, address)` — never by symbol, which can collide. The
+ * registry is curated: a token missing from it is an expected answer, not an
+ * error, so lookups return `null` rather than throwing.
+ */
+type TokenMetadata = {
+    identifier: TokenIdentifier;
+    name: string;
+    symbol: AssetSymbol;
+    decimals: AssetDecimals;
+    logo: TokenLogo;
+    /** Dark-theme logo; `null` when the registry configures none. */
+    logoDark: TokenLogo | null;
+};
+
+/**
+ * One chain a vault offer runs on, with everything a screen needs to read and
+ * show a position there: the proxy every request and claim goes through, the
+ * share token it issues, and the funding token it is paid in.
+ *
+ * The share token's `symbol` is the one amounts are labelled with. Vault
+ * routes are keyed by the offer's asset code, from `centrifugeShareSymbol`.
+ *
+ * @alpha
+ */
+type CentrifugeVault = {
+    chain: EthereumChain;
+    proxy: EvmContractAddress;
+    share: TokenMetadata;
+    funding: TokenMetadata;
+};
+/**
+ * The vaults an offer runs on, or why a chain could not be resolved: one
+ * entry per `vaultContracts` chain, in the offer's order.
+ *
+ * @alpha
+ */
+type CentrifugeVaultResolution = {
+    type: 'resolved';
+    vault: CentrifugeVault;
+} | {
+    type: 'unresolved';
+    chain: OfferToken['chain'];
+    /** Which token the offer or the registry could not name. */
+    missing: 'share-token' | 'funding-token' | 'evm-chain';
+};
+/**
+ * Resolves each chain of a vault offer to its share and funding tokens.
+ *
+ * The offer names tokens by role and address only - the share token as
+ * `vault`, the coin it is paid in as `funding` - so `lookup` turns each into
+ * metadata. A function rather than a registry snapshot, so this module does
+ * not depend on where the metadata comes from.
+ *
+ * A chain whose tokens cannot be named is reported rather than dropped: its
+ * position cannot be read without the symbol, and a caller has to know it is
+ * not showing it. When a chain lists several funding tokens, the first one
+ * `lookup` knows wins - a vault is priced in one.
+ *
+ * @alpha
+ */
+declare function resolveCentrifugeVaults(offer: CentrifugeVaultOfferDetail, lookup: (token: OfferToken) => TokenMetadata | null): CentrifugeVaultResolution[];
+
 /** @alpha */
 type GetCentrifugeVaultStatusParams = {
     /** Share token symbol of the vault, e.g. `deJTRSY`. */
@@ -821,6 +931,17 @@ type CentrifugeWalletParams = GetCentrifugeVaultStatusParams & {
      */
     walletAddress: EvmWalletAddress;
 };
+/**
+ * A chain read of one wallet on one vault. The vault is the resolved one:
+ * its proxy is what the views live on, and its tokens' decimals scale the
+ * amounts, so neither is read again.
+ *
+ * @alpha
+ */
+type ReadCentrifugePositionParams = {
+    vault: CentrifugeVault;
+    walletAddress: EvmWalletAddress;
+};
 /**
  * What `POST /v1/centrifuge/vault/invest` is asked for: the wallet that will
  * broadcast the request and fund it, plus the deposit.
@@ -838,7 +959,9 @@ type BuildCentrifugeVaultBuyParams = CentrifugeWalletParams & {
 /**
  * Centrifuge vault reads and claims: the vault-wide ordering gate, each
  * wallet's position per direction, and the calldata that claims a filled
- * request.
+ * request - e.g. `coinlist.centrifuge.getVaultStatus({ ... })`. Broadcasting a
+ * request or a claim needs a wallet, so that half is client-only, on
+ * `ClientCentrifugeNamespace`.
  *
  * The reads are free to poll - none spends an attestation, so a client may
  * call them while the user sizes a deposit or waits on a fill.
@@ -853,21 +976,27 @@ type BuildCentrifugeVaultBuyParams = CentrifugeWalletParams & {
  * timer. Broadcasting the buy calldata places a request. It does not buy
  * shares.
  *
- * Every method requires `AuthState === 'logged-in'` and throws
+ * Every Frontline method requires `AuthState === 'logged-in'` and throws
  * {@link NotAuthenticatedError} otherwise.
+ * {@link CentrifugeNamespace.readDepositPosition} and
+ * {@link CentrifugeNamespace.readRedeemPosition} read the proxy over RPC and
+ * do not; through CoinList's RPC proxy a logged-out read fails with its 401.
  *
  * @alpha
  */
 interface CentrifugeNamespace {
     getVaultStatus(params: GetCentrifugeVaultStatusParams): Promise<CentrifugeVaultStatus>;
-    /** The wallet's invest position: funding queued, shares claimable. */
-    getPosition(params: CentrifugeWalletParams): Promise<CentrifugeVaultPosition>;
     /**
-     * The wallet's redeem position: shares queued, funding claimable.
-     *
-     * TODO(frontline, ENG-1909): built against a guessed endpoint.
+     * The wallet's Deposit (buy) standing on the vault: funding token still
+     * queued, and funding token filled and ready to claim. A wallet that has
+     * never touched the vault reads as zeroes.
+     */
+    readDepositPosition(params: ReadCentrifugePositionParams): Promise<CentrifugeDepositPosition>;
+    /**
+     * The wallet's Redeem (sell) standing on the vault: shares still queued,
+     * and shares filled and ready to claim.
      */
-    getRedeemPosition(params: CentrifugeWalletParams): Promise<CentrifugeVaultRedeemPosition>;
+    readRedeemPosition(params: ReadCentrifugePositionParams): Promise<CentrifugeRedeemPosition>;
     /**
      * Calldata claiming every claimable share. Broadcast it from
      * `params.walletAddress`: the proxy credits the sender.
@@ -910,14 +1039,6 @@ interface PaginatedResponse<T> {
 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 = 'prepared' | 'pending' | 'submitted' | 'completed' | 'failed' | 'remit_submitted' | 'remitted' | 'remit_failed';
 /** Domain model for a participation returned by CoinList APIs. */
@@ -936,14 +1057,20 @@ type Participation = {
     displayAmount: string;
     /** Asset metadata for the participation amount. */
     asset: Asset;
-    /** Funding chain identifier. */
-    chain: Blockchain;
+    /**
+     * The chain the participation is funded on, or null when frontline names
+     * one this SDK does not model yet. Lenient on purpose: participations are
+     * listed, and one record on a newer chain must not fail the whole list -
+     * the same reason `isChain` drops what it cannot name elsewhere, except a
+     * participation is the user's own money and is kept rather than dropped.
+     */
+    chain: Chain | null;
     /** 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;
+    walletAddress: EvmWalletAddress | null;
 };
 /** Parameters required to create a new participation. */
 type CreateParticipationParams = {
@@ -951,10 +1078,10 @@ type CreateParticipationParams = {
     offerId: OfferId;
     /** Offer option selected for participation. */
     offerOptionId: OfferOptionId;
-    /** Blockchain for funding. */
-    chain: Blockchain;
+    /** Chain the participation is funded on. */
+    chain: EthereumChain;
     /** Wallet address that funds the participation. */
-    walletAddress: WalletAddress;
+    walletAddress: EvmWalletAddress;
     /**
      * Decimal token amount to participate with (e.g. `"100"` for 100 USDC), NOT
      * raw base units. The backend rescales this by the asset's decimals to verify
@@ -977,8 +1104,11 @@ interface ParticipationsPaginationParams extends PaginationParams {
 
 /**
  * Read/write operations for token sales: listing and reading the current user's
- * participations, and recording a new one. The on-chain execution flow
- * (`executeTokenSale`) is layered on top of this in the client-side namespace.
+ * participations, and recording a new one - e.g. `coinlist.tokenSale.list()`.
+ *
+ * The on-chain purchase, `ClientCoinListTokenSaleNamespace.execute`, is
+ * layered on top of this in the client-side namespace and is not available on
+ * `CoinListServer`, since it needs a wallet to sign with.
  */
 interface CoinListTokenSaleNamespace {
     /**
@@ -1332,7 +1462,10 @@ type BuildOndoSellParams = BuildOndoSwapParamsCore & {
 };
 
 /**
- * Ondo swap reads, plus the write that turns one into a fillable transaction.
+ * Ondo swap reads - whether an asset is tradable right now and what it costs,
+ * e.g. `coinlist.ondo.getQuote({ ... })` - plus the writes that turn a quote
+ * into a fillable transaction. Approving and broadcasting need a wallet, so
+ * they are client-only, on `ClientOndoNamespace`.
  *
  * The two reads are free to poll - neither spends an attestation, so a client
  * may call them while the user edits an order. The two builders are not:
@@ -1486,8 +1619,8 @@ type SwapStatus = {
  */
 type AllowWalletResponse = {
     action: 'broadcast_transaction';
-    to: EvmContractAddress;
-    data: HexEncodedTransactionData;
+    /** Broadcast as-is: the allow-list call, already encoded. */
+    tx: Tx;
 } | {
     action: 'none';
     alreadyAllowed: boolean;
@@ -1495,7 +1628,9 @@ type AllowWalletResponse = {
 
 /**
  * Read/write operations for the on-chain swap flow: quoting a swap, inspecting
- * contract state, and proving/allow-listing wallet ownership.
+ * contract state, and allow-listing a proven wallet - e.g.
+ * `coinlist.superstate.getOutputToken({ contractAddress, chain })`. The
+ * wallet-driven flows are client-only, on `ClientSuperstateSwapNamespace`.
  *
  * Every read here is a contract call the SDK makes itself. By default those go
  * through CoinList's authenticated JSON-RPC proxy, so a logged-out caller gets
@@ -1569,6 +1704,29 @@ type KycToken = {
     token: string;
 };
 
+type CreateKycTokenParams = {
+    /**
+     * Sumsub verification level to run. Defaults to the backend's standard
+     * level.
+     */
+    levelName?: KycLevelName;
+    /**
+     * Resets the Sumsub applicant first, so an already-approved level can be
+     * executed again (e.g. to update stale PII). Pass the `kycReset` value from
+     * the requirement status, and never on mid-flow token refreshes.
+     */
+    reset?: boolean;
+};
+type SubmitDocumentParams = {
+    /** Currently only `tax_certification` (W-8BEN / W-8BEN-E). */
+    documentType: DocumentType;
+    /**
+     * Signing-form values keyed by the document's DocuSeal field names,
+     * forwarded verbatim to pre-fill the document.
+     */
+    fields: Record<string, string>;
+};
+
 /** Whether the PII belongs to an individual or a company/trust entity. */
 type PiiKind = 'person' | 'company';
 /** ISO 3166-1 alpha-2 country code (e.g. `'US'`). */
@@ -1628,33 +1786,11 @@ type RequirementStatusInfo = {
     kycReset?: boolean;
 };
 
-type CreateKycTokenParams = {
-    /**
-     * Sumsub verification level to run. Defaults to the backend's standard
-     * level.
-     */
-    levelName?: KycLevelName;
-    /**
-     * Resets the Sumsub applicant first, so an already-approved level can be
-     * executed again (e.g. to update stale PII). Pass the `kycReset` value from
-     * the requirement status, and never on mid-flow token refreshes.
-     */
-    reset?: boolean;
-};
-type SubmitDocumentParams = {
-    /** Currently only `tax_certification` (W-8BEN / W-8BEN-E). */
-    documentType: DocumentType;
-    /**
-     * Signing-form values keyed by the document's DocuSeal field names,
-     * forwarded verbatim to pre-fill the document.
-     */
-    fields: Record<string, string>;
-};
 /**
  * Everything a user must satisfy before they can participate in an offer:
  * reading the checklist and its live statuses, and the operations that satisfy
- * individual requirements — identity verification (KYC) and tax-document
- * signing.
+ * individual requirements - identity verification (KYC) and tax-document
+ * signing. E.g. `coinlist.requirements.statuses(offerId)`.
  *
  * Wallet requirements (`external_wallet`, `whitelisted_wallet`) are satisfied
  * through `WalletsNamespace` instead, since wallet proofs are also used
@@ -1782,11 +1918,13 @@ type RemoveOptionAddressParams = {
     /** Binding to remove, as returned by {@link WalletsNamespace.list}. */
     addressId: OfferOptionAddressId;
 };
+
 /**
  * The user's external wallets: proving ownership of one, binding it to an
- * offer option, and managing those bindings.
+ * offer option, and managing those bindings - e.g.
+ * `coinlist.wallets.list({ offerId, offerOptionId })`.
  *
- * Ownership proof is a provider-agnostic primitive — the swap flow uses the
+ * Ownership proof is a provider-agnostic primitive - the swap flow uses the
  * same challenge to allow-list a wallet — so it lives here rather than being
  * duplicated per product namespace.
  *
@@ -1820,11 +1958,12 @@ interface WalletsNamespace {
 
 /**
  * Reads over CoinList's offers: the catalogue a user can browse, and the full
- * detail of a single offer.
+ * detail of a single offer - e.g. `coinlist.offers.list()` or
+ * `coinlist.offers.get(offerId)`.
  *
  * Every method requires an authenticated user and throws
  * {@link NotAuthenticatedError} otherwise. On the server, the same reads are
- * additionally available with an app-level token — see
+ * additionally available with an app-level token - see
  * `ServerOffersNamespace`.
  */
 interface OffersNamespace {
@@ -1861,7 +2000,8 @@ type GetTokenBalanceParams = {
 /**
  * Generic ERC-20 reads shared across on-chain flows (swap, token sale): the
  * allowance an owner has granted a spender, and the raw token balance an owner
- * holds. These are plain token reads, not tied to any single product flow.
+ * holds. These are plain token reads, not tied to any single product flow -
+ * e.g. `coinlist.erc20.getBalance({ ... })`.
  *
  * Read from the chain rather than from a CoinList endpoint. By default that
  * goes through CoinList's authenticated JSON-RPC proxy, so a logged-out caller
@@ -1883,55 +2023,16 @@ interface Erc20Namespace {
 }
 
 /**
- * An absolute URL to a logo image in the token registry. Registry image URLs
- * are content-fingerprinted and served immutable, so a value is safe to cache
- * for as long as you hold it.
- */
-type TokenLogoUrl = Newtype<string, 'TokenLogoUrl'>;
-declare const TokenLogoUrl: (value: string) => TokenLogoUrl;
-type TokenLogoImage = {
-    url: TokenLogoUrl;
-    width: number;
-    height: number;
-};
-/**
- * `VECTOR` is a single SVG. `RASTER` has webp variants at 32/64/128/256/512px
- * widths (never wider than the original): use the smallest one that covers
- * your render size, or `original` if none does.
- */
-type TokenLogo = {
-    kind: 'VECTOR';
-    url: TokenLogoUrl;
-} | {
-    kind: 'RASTER';
-    original: TokenLogoImage;
-    variants: TokenLogoImage[];
-};
-/**
- * Display metadata for one token, from CoinList's public token registry.
- *
- * Keyed by `(chain, address)` — never by symbol, which can collide. The
- * registry is curated: a token missing from it is an expected answer, not an
- * error, so lookups return `null` rather than throwing.
- */
-type TokenMetadata = {
-    identifier: TokenIdentifier;
-    name: string;
-    symbol: AssetSymbol;
-    decimals: AssetDecimals;
-    logo: TokenLogo;
-    /** Dark-theme logo; `null` when the registry configures none. */
-    logoDark: TokenLogo | null;
-};
-
-/**
- * Token display metadata — name, symbol, decimals, and logos — from
+ * Token display metadata - name, symbol, decimals, and logos - from
  * CoinList's public token registry, keyed by {@link TokenIdentifier} (the
- * same chain + address pairs `Offer.tokens` carries).
+ * same chain + address pairs `Offer.tokens` carries) - e.g.
+ * `coinlist.tokens.get({ chain, address })` for an entry of `Offer.tokens`,
+ * or `coinlist.tokens.list()` for the whole catalogue in one request.
  *
  * Unlike the other namespaces, this one is public: no method requires an
- * authenticated user, and nothing here touches the CoinList API — reads go to
- * the registry's CDN.
+ * authenticated user, and nothing here touches the CoinList API - reads go to
+ * the registry's CDN. On `CoinListServer` it therefore also works with a
+ * read-only `SessionStore`.
  */
 interface TokensNamespace {
     /**
@@ -2505,13 +2606,15 @@ interface Config {
     readonly redirectUri: RedirectUri;
     /**
      * Recommended to leave undefined. Used to change the CoinList environment;
-     * default is production.
+     * default is production. An empty string throws a `ValidationError` when
+     * the client is built: omit the field to use the default.
      */
     readonly baseUrl?: string;
     /**
      * Recommended to leave undefined. Overrides the base URL of the public
      * token registry backing `coinlist.tokens`; default is the production
-     * registry.
+     * registry. An empty string throws a `ValidationError` when the client is
+     * built: omit the field to use the default.
      */
     readonly tokensBaseUrl?: string;
     /**
@@ -2602,8 +2705,6 @@ interface Config {
     readonly onSessionExpired?: () => Promise<void>;
 }
 
-type ClientCredentialsOAuth = Newtype<OAuthAccessToken, 'ClientCredentialsOAuth'>;
-declare const ClientCredentialsOAuth: (value: OAuthAccessToken) => ClientCredentialsOAuth;
 type OAuthAccessToken = {
     value: string;
     expiresAt: Date;
@@ -2653,4 +2754,4 @@ declare const Seconds: {
     toMillis: (value: Seconds) => Millis;
 };
 
-export { type PinoLoggerOptions as $, AuthorizationCode as A, BlockchainAmount as B, CodeVerifier as C, StablecoinSymbol as D, EthereumChain as E, type Erc20Asset as F, type OfferType as G, type CoinListTokenSaleOfferDetail as H, type OfferDetail as I, CentrifugeVaultLegId as J, type CentrifugeVaultOfferDetail as K, Seconds as L, type AsyncOfferType as M, AsyncOfferDetail as N, type OfferVaultContract as O, type Participation as P, type Offer as Q, type RequirementsNamespace as R, type SwapQuote as S, type TokensNamespace as T, type TokenMetadata as U, type RequirementStatusInfo as V, type WalletError as W, type KycLevelName as X, type RequirementType as Y, type RequirementStatusValue as Z, RequirementId as _, AssetSymbol as a, type GetOndoQuoteParams as a$, type Logger as a0, type BuildCentrifugeVaultBuyParams as a1, type BuildOndoBuyParams as a2, type OndoSwapOfferDetail as a3, type BuildOndoSellParams as a4, type OndoQuote as a5, type OndoQuoteSize as a6, type OndoTradingStatus as a7, AssetDecimals as a8, type SuperstateSwapOfferDetail as a9, type CentrifugeOrderability as aA, type CentrifugePositionStatus as aB, type CentrifugeVaultClaimProceedsTransaction as aC, type CentrifugeVaultClaimTransaction as aD, type CentrifugeVaultOffer as aE, type CentrifugeVaultPosition as aF, type CentrifugeVaultReason as aG, type CentrifugeVaultRedeemPosition as aH, type CentrifugeVaultTransactionCore as aI, type CentrifugeWalletParams as aJ, Chain as aK, type CoinListTokenSaleOffer as aL, type ConnectExternalWalletParams as aM, type CreateKycTokenParams as aN, type CreateParticipationParams as aO, type CreateWalletOwnershipChallengeParams as aP, Cursor as aQ, type DebugEvent as aR, DecimalString as aS, type DocumentFormType as aT, type DocumentSubmissionStatus as aU, type DocumentType as aV, ETHEREUM_CHAINS as aW, EpochMillis as aX, type FaqItem as aY, type FrontlineEventId as aZ, type GetCentrifugeVaultStatusParams as a_, CentrifugeVaultLeg as aa, type CentrifugeVaultRef as ab, OfferOptionAddressId as ac, type DocumentSubmission as ad, type CentrifugeVaultStatus as ae, type TokenIdentifier as af, type OAuthSession as ag, ClientCredentialsOAuth as ah, type PaginationParams as ai, type PaginatedResponse as aj, ClientSecret as ak, type RequestId as al, ClientId as am, RedirectUri as an, CodeChallenge as ao, PKCEState as ap, type SwapStatus as aq, KnownAssetSymbol as ar, type AllowWalletParams as as, type AllowWalletResponse as at, type Asset as au, AssetCode as av, type BaseEvent as aw, Blockchain as ax, type BuildOndoSwapParamsCore as ay, type CentrifugeOrderReason as az, EvmContractAddress as b, type Tx as b$, type GetOndoTradingStatusParams as b0, type GetSwapAuthorizationParams as b1, type GetSwapPreviewParams as b2, type GetSwapQuoteParams as b3, type GetTokenAllowanceParams as b4, type GetTokenBalanceParams as b5, HexEncodedTransactionData as b6, Isin as b7, Iso2CountryCode as b8, type KycToken as b9, type ParticipationsPaginationParams as bA, PauseFlags as bB, type Pii as bC, type PiiAddress as bD, type PiiJurisdiction as bE, type PiiKind as bF, type ProductionLogLevel as bG, type RedactedWalletError as bH, type RemoveOptionAddressParams as bI, type RequirementActionNeededReason as bJ, type RpcConfig as bK, type RpcFailureReason as bL, SOLANA_CHAINS as bM, STABLE_DECIMALS as bN, type SafeEvent as bO, type SafeFields as bP, SolanaChain as bQ, type SubmitDocumentParams as bR, type SuperstateSwapOffer as bS, type SwapContractRef as bT, type SwapPreview as bU, type TermItem as bV, Ticker as bW, type TokenLogo as bX, type TokenLogoImage as bY, TokenLogoUrl as bZ, type TokenRole as b_, type Link as ba, type ListOptionAddressesParams as bb, type LogBinding as bc, type LogBindings as bd, type LogCause as be, type LogLevel as bf, type LogScope as bg, type LogValue as bh, MAX_ASSET_DECIMALS as bi, MAX_UINT_256 as bj, type Milestone as bk, Millis as bl, type Newtype as bm, OAuthRefreshToken as bn, type OfferBase as bo, type OfferDetailBase as bp, type OfferEditorial as bq, type OfferOption as br, OfferOptionSlug as bs, OfferSlug as bt, type OfferToken as bu, type OndoQuoteDuration as bv, type OndoSellOutcome as bw, type OndoSwapOffer as bx, ParticipationId as by, type ParticipationStatus as bz, type CentrifugeVaultBuyTransaction as c, type Uint256 as c0, type UnredactedFields as c1, WalletAddress as c2, type WalletOwnershipChallenge as c3, type WalletOwnershipChallengeParamsBase as c4, type WalletProtocol as c5, assertUint256 as c6, isChain as c7, isOfferType as c8, parseUint256 as c9, type CentrifugeClaimDirection as d, type CentrifugeNamespace as e, OfferId as f, OfferOptionId as g, AssetId as h, type CoinListTokenSaleNamespace as i, type OfferSwapContract as j, type OndoBuyTransaction as k, type OndoSellTransaction as l, type OndoNamespace as m, type OndoSwapTransactionCore as n, type OrderBookSide as o, Bps as p, EvmWalletAddress as q, type SuperstateSwapNamespace as r, type Requirement as s, type WalletChallengeType as t, type OfferOptionAddress as u, type WalletsNamespace as v, type Config as w, type OAuthAccessToken as x, type OffersNamespace as y, type Erc20Namespace as z };
+export { type CentrifugeVaultStatus as $, type AuthorizationGrant as A, BlockchainAmount as B, type CentrifugeVaultBuyTransaction as C, type Offer as D, EthereumChain as E, type TokenMetadata as F, type OfferDetail as G, type Erc20Asset as H, CentrifugeVaultLegId as I, type CentrifugeVaultOfferDetail as J, Seconds as K, AsyncOfferDetail as L, type RequirementStatusInfo as M, type KycLevelName as N, type OfferVaultContract as O, type Participation as P, type RequirementType as Q, type RequirementsNamespace as R, StablecoinSymbol as S, type TokensNamespace as T, type RequirementStatusValue as U, RequirementId as V, type WalletError as W, type PinoLoggerOptions as X, type Logger as Y, AuthorizationCode as Z, CodeVerifier as _, AssetSymbol as a, type GetCentrifugeVaultStatusParams as a$, type CentrifugeVaultRef as a0, type BuildOndoBuyParams as a1, type OndoSwapOfferDetail as a2, type BuildOndoSellParams as a3, type OndoQuote as a4, type OndoQuoteSize as a5, type OndoTradingStatus as a6, AssetDecimals as a7, type SuperstateSwapOfferDetail as a8, CentrifugeVaultLeg as a9, type CentrifugeOrderReason as aA, type CentrifugeOrderability as aB, type CentrifugeRedeemPosition as aC, CentrifugeShares as aD, type CentrifugeVaultClaimProceedsTransaction as aE, type CentrifugeVaultClaimTransaction as aF, type CentrifugeVaultOffer as aG, type CentrifugeVaultReason as aH, type CentrifugeVaultResolution as aI, type CentrifugeVaultTransactionCore as aJ, type CentrifugeWalletParams as aK, Chain as aL, type CoinListTokenSaleOffer as aM, type ConnectExternalWalletParams as aN, type CreateKycTokenParams as aO, type CreateParticipationParams as aP, type CreateWalletOwnershipChallengeParams as aQ, Cursor as aR, type DebugEvent as aS, DecimalString as aT, type DocumentFormType as aU, type DocumentSubmissionStatus as aV, type DocumentType as aW, ETHEREUM_CHAINS as aX, EpochMillis as aY, type FaqItem as aZ, type FrontlineEventId as a_, type CentrifugeVault as aa, OfferOptionAddressId as ab, type DocumentSubmission as ac, type TokenIdentifier as ad, type OAuthSession as ae, type PaginationParams as af, type PaginatedResponse as ag, ClientSecret as ah, ClientId as ai, RedirectUri as aj, CodeChallenge as ak, PKCEState as al, type RequestId as am, type SwapStatus as an, KnownAssetSymbol as ao, type AllowWalletParams as ap, type AllowWalletResponse as aq, type Asset as ar, AssetCode as as, AssetId as at, type AsyncOfferType as au, type BaseEvent as av, type BuildCentrifugeVaultBuyParams as aw, type BuildOndoSwapParamsCore as ax, CentrifugeAssets as ay, type CentrifugeDepositPosition as az, EvmContractAddress as b, type TokenLogo as b$, type GetOndoQuoteParams as b0, type GetOndoTradingStatusParams as b1, type GetSwapAuthorizationParams as b2, type GetSwapPreviewParams as b3, type GetSwapQuoteParams as b4, type GetTokenAllowanceParams as b5, type GetTokenBalanceParams as b6, HexEncodedTransactionData as b7, Isin as b8, Iso2CountryCode as b9, type OndoSwapOffer as bA, ParticipationId as bB, type ParticipationStatus as bC, type ParticipationsPaginationParams as bD, PauseFlags as bE, type Pii as bF, type PiiAddress as bG, type PiiJurisdiction as bH, type PiiKind as bI, type ProductionLogLevel as bJ, type ReadCentrifugePositionParams as bK, type RedactedWalletError as bL, type RemoveOptionAddressParams as bM, type RequirementActionNeededReason as bN, type RpcConfig as bO, type RpcFailureReason as bP, SOLANA_CHAINS as bQ, STABLE_DECIMALS as bR, type SafeEvent as bS, type SafeFields as bT, SolanaChain as bU, type SubmitDocumentParams as bV, type SuperstateSwapOffer as bW, type SwapContractRef as bX, type SwapPreview as bY, type TermItem as bZ, Ticker as b_, type KycToken as ba, type Link as bb, type ListOptionAddressesParams as bc, type LogBinding as bd, type LogBindings as be, type LogCause as bf, type LogLevel as bg, type LogScope as bh, type LogValue as bi, MAX_ASSET_DECIMALS as bj, MAX_UINT_256 as bk, type Milestone as bl, Millis as bm, type Newtype as bn, OAuthRefreshToken as bo, type OfferBase as bp, type OfferDetailBase as bq, type OfferEditorial as br, type OfferFundingContract as bs, type OfferOption as bt, OfferOptionSlug as bu, OfferSlug as bv, type OfferToken as bw, type OfferType as bx, type OndoQuoteDuration as by, type OndoSellOutcome as bz, type CentrifugeClaimDirection as c, type TokenLogoImage as c0, TokenLogoUrl as c1, type TokenRole as c2, type Tx as c3, type Uint256 as c4, type UnredactedFields as c5, type WalletOwnershipChallenge as c6, type WalletOwnershipChallengeParamsBase as c7, type WalletProtocol as c8, assertUint256 as c9, isChain as ca, isOfferType as cb, parseUint256 as cc, resolveCentrifugeVaults as cd, type CentrifugeNamespace as d, type CoinListTokenSaleOfferDetail as e, OfferOptionId as f, type CoinListTokenSaleNamespace as g, type OfferSwapContract as h, type OndoBuyTransaction as i, type OndoSellTransaction as j, type OndoNamespace as k, type OndoSwapTransactionCore as l, type OrderBookSide as m, OfferId as n, type SwapQuote as o, Bps as p, EvmWalletAddress as q, type SuperstateSwapNamespace as r, type Requirement as s, type WalletChallengeType as t, type OfferOptionAddress as u, type WalletsNamespace as v, type Config as w, type OAuthAccessToken as x, type OffersNamespace as y, type Erc20Namespace as z };