@coinlist-co/react 0.12.1 → 0.12.2-rc.31c2f50

package/dist/{tokens-namespace-CIWBtgt2.d.cts → tokens-namespace-D_XSpiS-.d.cts}

@@ -873,6 +873,19 @@ type HttpRequestAttributes = {
     /** Zero-based attempt index: 0 = first request, 1 = first retry, etc. */
     retryAttempt?: number;
     renewAttempted?: boolean;
+    /**
+     * `false` opts a request out of `requestRetryMiddleware`. For exchanges
+     * that must never be replayed: a refresh token is single-use, so re-sending
+     * one whose first attempt reached the server presents a token that has
+     * already been rotated away.
+     */
+    retryable?: boolean;
+    /**
+     * The user access token `attachSessionMiddleware` put on this request, so
+     * that a 401 can say *which* token was refused. Absent when the request
+     * went out with no user token.
+     */
+    sentWith?: OAuthAccessToken;
     clientCredentials?: ClientCredentialsOAuth;
 };
 
@@ -1061,6 +1074,45 @@ interface Config {
      * See {@link RpcConfig}.
      */
     readonly rpc?: RpcConfig;
+    /**
+     * Called when the SDK has **confirmed** that the user's CoinList session is
+     * gone - its refresh token expired or was revoked - so you can clear your
+     * own state and show a sign-in entry point.
+     *
+     * Confirmed, because the backend answers "rotated a moment ago by a
+     * concurrent request" and "dead" identically. A single rejection is only a
+     * suspicion: the SDK acts on it only once the same session is rejected again
+     * after a settle window, so a lost refresh race never signs a user out.
+     *
+     * Each environment reports what it confirmed itself, so it fires in the
+     * one that drove the confirmation:
+     *
+     * - **`CoinListClient`**: fires when the SDK moves from `'logged-in'` to
+     *   `'logged-out'` because your `getAccessToken` answered `null` (or the
+     *   very token the API just refused) twice, a second apart.
+     * - **`CoinListServer`**: fires when the same process sees a refresh token
+     *   rejected twice, 5 to 60 seconds apart, or an expired session that
+     *   carries no refresh token. The SDK clears the session from your
+     *   `SessionStore` just before. The browser's confirmation, through your
+     *   `getAccessToken` endpoint, comes a second after the first rejection, so
+     *   it does not reach this verdict: when the browser drives renewal, expect
+     *   the `CoinListClient` callback, and this one only if a later request
+     *   presents the dead session 5 to 60 seconds on.
+     *
+     * It never fires on `auth.logout()`, on a 5xx, a timeout or a network
+     * failure - those mean the SDK could not find out, not that the session
+     * ended. Per environment it fires at most once per session, within a
+     * 60-second memory: the server remembers a verdict for 60 seconds per
+     * process (per JavaScript module instance, so Next.js middleware and route
+     * handlers count separately). The same dead session presented again after
+     * that, or to another instance, can be reported again, so make your handler
+     * idempotent.
+     *
+     * It is called on the next microtask and not awaited. A rejection is
+     * logged and dropped, so it cannot fail or delay the request that
+     * discovered the expiry. A synchronous handler is written `async () => {}`.
+     */
+    readonly onSessionExpired?: () => Promise<void>;
 }
 
 /**
@@ -1215,13 +1267,13 @@ type InternalDebugEvent = {
  * union makes a `switch` over it exhaustive: adding a provider without
  * handling it becomes a compile error.
  */
-type OfferTypeDto = 'coinlist::token_sale' | 'superstate::swap' | 'ondo::swap';
+type OfferTypeDto = 'coinlist::token_sale' | 'superstate::swap' | 'ondo::swap' | 'centrifuge::vault';
 /**
  * One variant per {@link OfferTypeDto}, mirroring frontline#1365, which keys
  * `GET /v1/offers` on `type`. Read `type` first: it decides which of the
  * fields below mean anything.
  */
-type OfferDto = CoinListTokenSaleOfferDto | SuperstateSwapOfferDto | OndoSwapOfferDto;
+type OfferDto = CoinListTokenSaleOfferDto | SuperstateSwapOfferDto | OndoSwapOfferDto | CentrifugeVaultOfferDto;
 type OfferBaseDto = {
     id: string;
     slug: string;
@@ -1238,15 +1290,16 @@ type OfferEditorialDto = {
     starts_at: string;
 };
 /**
- * What an Ondo swap sends in place of {@link OfferEditorialDto}. It trades
- * continuously and runs no campaign, so the keys arrive as `null` and carry
- * nothing. Declared so a fixture can describe the real payload; no `fromDto`
- * reads them.
+ * What an Ondo swap or a Centrifuge vault sends in place of
+ * {@link OfferEditorialDto}. Neither runs a campaign, so the keys arrive as
+ * `null` and carry nothing, and the backend may stop sending them at all.
+ * Declared so a fixture can describe the real payload; no `fromDto` reads
+ * them.
  */
 type OfferNoEditorialDto = {
-    tagline: null;
-    banner_url: null;
-    starts_at: null;
+    tagline?: null;
+    banner_url?: null;
+    starts_at?: null;
 };
 type CoinListTokenSaleOfferDto = OfferBaseDto & OfferEditorialDto & {
     type: 'coinlist::token_sale';
@@ -1262,8 +1315,17 @@ type OndoSwapOfferDto = OfferBaseDto & OfferNoEditorialDto & {
     /** Publishing a swap does not require anyone to upload artwork for it. */
     logo_url: string | null;
 };
+type CentrifugeVaultOfferDto = OfferBaseDto & OfferNoEditorialDto & {
+    type: 'centrifuge::vault';
+    /** Publishing a vault does not require anyone to upload artwork for it. */
+    logo_url: string | null;
+};
 type OfferTokenDto = {
-    role: 'funding' | 'distribution' | 'swap';
+    /**
+     * `vault` is the share token a `centrifuge::vault` offer issues for
+     * deposits, as `swap` is the token a swap offer trades into.
+     */
+    role: 'funding' | 'distribution' | 'swap' | 'vault';
     chain: string;
     address: string;
 };
@@ -1294,10 +1356,16 @@ type OndoSwapOffer = OfferBase & {
     /** Null when nobody has uploaded artwork: a swap publishes without it. */
     logoUrl: string | null;
 };
+type CentrifugeVaultOffer = OfferBase & {
+    type: 'centrifuge::vault';
+    /** Null when nobody has uploaded artwork: a vault publishes without it. */
+    logoUrl: string | null;
+};
 /**
  * A curated sale window and the hand-authored copy that goes with it. Every
  * variant that runs such a campaign carries all three, validated; an Ondo swap
- * trades continuously, runs none, and carries none.
+ * trades continuously and a Centrifuge vault takes deposits continuously, so
+ * neither runs one and neither carries any.
  */
 type OfferEditorial = {
     tagline: string;
@@ -1317,7 +1385,7 @@ declare const OfferEditorial: {
  * `type` before reading anything beyond {@link OfferBase} - an Ondo swap has
  * no `startsAt` to read, and the compiler says so.
  */
-type Offer = CoinListTokenSaleOffer | SuperstateSwapOffer | OndoSwapOffer;
+type Offer = CoinListTokenSaleOffer | SuperstateSwapOffer | OndoSwapOffer | CentrifugeVaultOffer;
 declare const Offer: {
     fromDto: (dto: OfferDto) => Offer;
     /**
@@ -1330,7 +1398,11 @@ declare const Offer: {
      */
     listFromDto: (dtos: OfferDto[]) => Offer[];
 };
-type TokenRole = 'funding' | 'distribution' | 'swap';
+/**
+ * `vault` is the share token a `centrifuge::vault` offer issues for deposits,
+ * as `swap` is the token a swap offer trades into.
+ */
+type TokenRole = 'funding' | 'distribution' | 'swap' | 'vault';
 type OfferToken = {
     role: TokenRole;
     chain: Chain;
@@ -1445,16 +1517,16 @@ type CreateParticipationDto = {
  * One variant per `OfferTypeDto`, the same split as `OfferDto` with what
  * `GET /v1/offers/:id` adds on top. Read `type` first.
  */
-type OfferDetailDto = CoinListTokenSaleOfferDetailDto | SuperstateSwapOfferDetailDto | OndoSwapOfferDetailDto;
-type CoinListTokenSaleOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & {
+type OfferDetailDto = CoinListTokenSaleOfferDetailDto | SuperstateSwapOfferDetailDto | OndoSwapOfferDetailDto | CentrifugeVaultOfferDetailDto;
+type CoinListTokenSaleOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & OfferDetailNoVaultContractsDto & {
     type: 'coinlist::token_sale';
     logo_url: string;
 };
-type SuperstateSwapOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & {
+type SuperstateSwapOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & OfferDetailNoVaultContractsDto & {
     type: 'superstate::swap';
     logo_url: string | null;
 };
-type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & {
+type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & OfferDetailNoVaultContractsDto & {
     type: 'ondo::swap';
     logo_url: string | null;
     /**
@@ -1463,6 +1535,19 @@ type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & {
      */
     swap_contracts: OfferDetailSwapContractDto[];
 };
+type CentrifugeVaultOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & OfferDetailNoSwapContractsDto & {
+    type: 'centrifuge::vault';
+    logo_url: string | null;
+    /**
+     * Every chain this vault takes deposits on, with the CoinList proxy each
+     * request goes through. `[]` is an answer - "deposits nowhere", which is
+     * every vault until a proxy is deployed - and a missing key is not.
+     */
+    vault_contracts: OfferDetailVaultContractDto[];
+};
+type OfferDetailNoVaultContractsDto = {
+    vault_contracts?: OfferDetailVaultContractDto[];
+};
 /**
  * An offer that does not settle through a CoinList swap contract sends `[]`
  * or no key at all, and either way there is nothing to read. Declared so a
@@ -1529,6 +1614,10 @@ type OfferDetailSwapContractDto = {
     chain: string;
     address: string;
 };
+type OfferDetailVaultContractDto = {
+    chain: string;
+    address: string;
+};
 
 type Ticker = Newtype<string, 'Ticker'>;
 declare const Ticker: (value: string) => Ticker;
@@ -1566,6 +1655,16 @@ type OndoSwapOfferDetail = OfferDetailBase & {
      */
     swapContracts: OfferSwapContract[];
 };
+type CentrifugeVaultOfferDetail = OfferDetailBase & {
+    type: 'centrifuge::vault';
+    /** Null when nobody has uploaded artwork: a vault publishes without it. */
+    logoUrl: string | null;
+    /**
+     * Every chain this vault takes deposits on, with the CoinList proxy each
+     * request goes through. Empty means it takes deposits nowhere yet.
+     */
+    vaultContracts: OfferVaultContract[];
+};
 type OfferDetailBase = {
     id: OfferId;
     slug: OfferSlug;
@@ -1643,13 +1742,38 @@ type OfferSwapContract = {
 declare const OfferSwapContract: {
     fromDto: (dto: OfferDetailSwapContractDto) => OfferSwapContract;
 };
+/**
+ * A chain a Centrifuge vault takes deposits on, with the CoinList proxy the
+ * request goes through. Not a token, so the token registry knows nothing about
+ * it: it is the spender the user approves the funding token to, and the `to`
+ * the buy and claim transactions are sent to.
+ *
+ * Its own type rather than an {@link OfferSwapContract}, although the shape is
+ * the same, because the meaning is not: a swap contract serves every Ondo
+ * asset on its chain, while a proxy belongs to one offer on one chain, so the
+ * same chain carries a different address on every vault.
+ */
+type OfferVaultContract = {
+    chain: Chain;
+    address: EvmContractAddress;
+};
+declare const OfferVaultContract: {
+    fromDto: (dto: OfferDetailVaultContractDto) => OfferVaultContract;
+    /**
+     * Drops every proxy on a chain this SDK does not name, as
+     * `OfferToken.listFromDto` does: frontline publishes the full offer-token
+     * chain list, which runs ahead of {@link Chain}, and one unmodelled chain
+     * should not throw away the proxies the SDK can use.
+     */
+    listFromDto: (dtos: OfferDetailVaultContractDto[]) => OfferVaultContract[];
+};
 /**
  * An offer as `GET /v1/offers/:id` serves it: the same union on `type` as
  * {@link Offer}, each variant carrying only the fields that mean something
  * for it. Narrow on `type` before reading anything beyond
  * {@link OfferDetailBase}.
  */
-type OfferDetail = CoinListTokenSaleOfferDetail | SuperstateSwapOfferDetail | OndoSwapOfferDetail;
+type OfferDetail = CoinListTokenSaleOfferDetail | SuperstateSwapOfferDetail | OndoSwapOfferDetail | CentrifugeVaultOfferDetail;
 declare const OfferDetail: {
     fromDto: (dto: OfferDetailDto) => OfferDetail;
 };
@@ -2436,6 +2560,17 @@ declare const OndoSellTransaction: {
  */
 interface OndoNamespace {
     getTradingStatus(params: GetOndoTradingStatusParams): Promise<OndoTradingStatus>;
+    /**
+     * An indicative price for `params`' size, from Ondo's live market.
+     *
+     * Ondo refuses to quote while the market is closed or paused, or the asset
+     * is paused or closed for the session - including for about a minute at
+     * every US session change, when `getTradingStatus` may still have reported
+     * the asset tradable. The request then rejects with a 409 carrying
+     * `code: "not_tradable"`; tell it apart from a failure with
+     * {@link isOndoNotTradableError}. Retrying before the market opens fails the
+     * same way.
+     */
     getQuote(params: GetOndoQuoteParams): Promise<OndoQuote>;
     /**
      * Builds a purchase for a specific wallet and deposit: spends an attestation
@@ -3298,4 +3433,4 @@ declare class TokensNamespaceImpl implements TokensNamespace {
     list(chain?: EthereumChain): Promise<TokenMetadata[]>;
 }
 
-export { OndoTradingStatus as $, AuthorizationCode as A, BlockchainAmount as B, CodeVerifier as C, TokenMetadata as D, type Erc20Namespace as E, type OfferType as F, type OndoSwapOfferDetail as G, type CoinListTokenSaleOfferDetail as H, type SuperstateSwapOfferDetail as I, Offer as J, RequirementStatusInfo as K, type Logger as L, type RequirementType as M, type RequirementStatusValue as N, OfferId as O, Participation as P, OfferOptionAddress as Q, type RequirementsNamespace as R, type SuperstateSwapNamespace as S, type TokensNamespace as T, type UniversalNamespaceContext as U, RequirementId as V, type WalletError as W, type KycLevelName as X, DocumentSubmission as Y, type WalletChallengeType as Z, type PinoLoggerOptions as _, EthereumChain as a, type GetTokenBalanceParams as a$, AssetDecimals as a0, type BuildOndoBuyParams as a1, type BuildOndoSellParams as a2, OndoQuote as a3, type OndoQuoteSize as a4, type TokenIdentifier as a5, OfferOptionAddressId as a6, TokenLogo as a7, type DebugEvent as a8, type FrontlineEventId as a9, type Newtype as aA, type AllowWalletParams as aB, AllowWalletResponse as aC, Asset as aD, AssetCode as aE, Blockchain as aF, type BuildOndoSwapParamsCore as aG, Chain as aH, ClientId as aI, CodeChallenge as aJ, type CoinListTokenSaleOffer as aK, ConnectExternalWalletParams as aL, type CreateKycTokenParams as aM, CreateParticipationParams as aN, CreateWalletOwnershipChallengeParams as aO, Cursor as aP, type DocumentFormType as aQ, type DocumentSubmissionStatus as aR, type DocumentType as aS, ETHEREUM_CHAINS as aT, Erc20NamespaceImpl as aU, FaqItem as aV, type GetOndoQuoteParams as aW, type GetOndoTradingStatusParams as aX, type GetSwapAuthorizationParams as aY, type GetSwapPreviewParams as aZ, type GetTokenAllowanceParams as a_, HttpError as aa, type HttpResponse as ab, KycToken as ac, type LogBinding as ad, type LogBindings as ae, type LogCause as af, type LogLevel as ag, type LogScope as ah, type LogValue as ai, type ProductionLogLevel as aj, RedactedWalletError as ak, type RequestId as al, type RpcFailureReason as am, type SafeEvent as an, type SafeFields as ao, type UnredactedFields as ap, OAuthSession as aq, ClientCredentialsOAuth as ar, ClientSecret as as, type Sender as at, PaginationParams as au, PaginatedResponse as av, DecimalString as aw, SwapStatus as ax, type Uint256 as ay, KnownAssetSymbol as az, EvmContractAddress as b, HexEncodedTransactionData as b0, Isin as b1, Iso2CountryCode as b2, Link as b3, type ListOptionAddressesParams as b4, MAX_ASSET_DECIMALS as b5, MAX_UINT_256 as b6, Milestone as b7, OAuthRefreshToken as b8, type OfferBase as b9, SOLANA_CHAINS as bA, STABLE_DECIMALS as bB, SolanaChain as bC, type SubmitDocumentParams as bD, type SuperstateSwapOffer as bE, type SwapContractRef as bF, SwapPreview as bG, TermItem as bH, Ticker as bI, type TokenLogoImage as bJ, TokenLogoUrl as bK, type TokenRole as bL, TokensNamespaceImpl as bM, type Tx as bN, WalletAddress as bO, WalletOwnershipChallenge as bP, type WalletProtocol as bQ, WalletsNamespaceImpl as bR, apiErrorCode as bS, assertUint256 as bT, isChain as bU, isOfferType as bV, parseUint256 as bW, type OfferDetailBase as ba, OfferEditorial as bb, OfferOption as bc, OfferOptionSlug as bd, OfferSlug as be, OfferToken as bf, OffersNamespaceImpl as bg, type OndoQuoteDuration as bh, type OndoSellOutcome as bi, type OndoSwapOffer as bj, PKCEState as bk, type PaginatedResponseDto as bl, ParticipationId as bm, type ParticipationStatus as bn, ParticipationsPaginationParams as bo, PauseFlags as bp, Pii as bq, PiiAddress as br, PiiJurisdiction as bs, type PiiKind as bt, type QueryParamValue as bu, type QueryParamValues as bv, RedirectUri as bw, type RemoveOptionAddressParams as bx, type RequirementActionNeededReason as by, type RpcConfig as bz, type CoinListTokenSaleNamespace as c, OfferOptionId as d, AssetId as e, CoinListTokenSaleNamespaceImpl as f, type OndoNamespace as g, AssetSymbol as h, OfferSwapContract as i, OndoBuyTransaction as j, OndoSellTransaction as k, type OndoSwapTransactionCore as l, type OrderBookSide as m, OndoNamespaceImpl as n, type WalletsNamespace as o, Bps as p, EvmWalletAddress as q, SuperstateSwapNamespaceImpl as r, Requirement as s, RequirementsNamespaceImpl as t, type Config as u, type OAuthAccessToken as v, type OffersNamespace as w, StablecoinSymbol as x, type Erc20Asset as y, OfferDetail as z };
+export { type PinoLoggerOptions as $, AuthorizationCode as A, BlockchainAmount as B, CodeVerifier as C, TokenMetadata as D, type Erc20Namespace as E, type CentrifugeVaultOfferDetail as F, type OfferType as G, type OndoSwapOfferDetail as H, type CoinListTokenSaleOfferDetail as I, type SuperstateSwapOfferDetail as J, Offer as K, type Logger as L, RequirementStatusInfo as M, type RequirementType as N, OfferId as O, Participation as P, type RequirementStatusValue as Q, type RequirementsNamespace as R, type SuperstateSwapNamespace as S, type TokensNamespace as T, type UniversalNamespaceContext as U, OfferOptionAddress as V, type WalletError as W, RequirementId as X, type KycLevelName as Y, DocumentSubmission as Z, type WalletChallengeType as _, EthereumChain as a, type GetSwapAuthorizationParams as a$, OndoTradingStatus as a0, AssetDecimals as a1, type BuildOndoBuyParams as a2, type BuildOndoSellParams as a3, OndoQuote as a4, type OndoQuoteSize as a5, type TokenIdentifier as a6, OfferOptionAddressId as a7, TokenLogo as a8, type DebugEvent as a9, KnownAssetSymbol as aA, type Tx as aB, type Newtype as aC, type AllowWalletParams as aD, AllowWalletResponse as aE, Asset as aF, AssetCode as aG, Blockchain as aH, type BuildOndoSwapParamsCore as aI, type CentrifugeVaultOffer as aJ, Chain as aK, ClientId as aL, CodeChallenge as aM, type CoinListTokenSaleOffer as aN, ConnectExternalWalletParams as aO, type CreateKycTokenParams as aP, CreateParticipationParams as aQ, CreateWalletOwnershipChallengeParams as aR, Cursor as aS, type DocumentFormType as aT, type DocumentSubmissionStatus as aU, type DocumentType as aV, ETHEREUM_CHAINS as aW, Erc20NamespaceImpl as aX, FaqItem as aY, type GetOndoQuoteParams as aZ, type GetOndoTradingStatusParams as a_, type FrontlineEventId as aa, HttpError as ab, type HttpResponse as ac, KycToken as ad, type LogBinding as ae, type LogBindings as af, type LogCause as ag, type LogLevel as ah, type LogScope as ai, type LogValue as aj, type ProductionLogLevel as ak, RedactedWalletError as al, type RequestId as am, type RpcFailureReason as an, type SafeEvent as ao, type SafeFields as ap, type UnredactedFields as aq, OAuthSession as ar, ClientCredentialsOAuth as as, type Sender as at, PaginationParams as au, PaginatedResponse as av, ClientSecret as aw, DecimalString as ax, SwapStatus as ay, type Uint256 as az, EvmContractAddress as b, type GetSwapPreviewParams as b0, type GetTokenAllowanceParams as b1, type GetTokenBalanceParams as b2, HexEncodedTransactionData as b3, Isin as b4, Iso2CountryCode as b5, Link as b6, type ListOptionAddressesParams as b7, MAX_ASSET_DECIMALS as b8, MAX_UINT_256 as b9, RedirectUri as bA, type RemoveOptionAddressParams as bB, type RequirementActionNeededReason as bC, type RpcConfig as bD, SOLANA_CHAINS as bE, STABLE_DECIMALS as bF, SolanaChain as bG, type SubmitDocumentParams as bH, type SuperstateSwapOffer as bI, type SwapContractRef as bJ, SwapPreview as bK, TermItem as bL, Ticker as bM, type TokenLogoImage as bN, TokenLogoUrl as bO, type TokenRole as bP, TokensNamespaceImpl as bQ, WalletAddress as bR, WalletOwnershipChallenge as bS, type WalletProtocol as bT, WalletsNamespaceImpl as bU, apiErrorCode as bV, assertUint256 as bW, isChain as bX, isOfferType as bY, parseUint256 as bZ, Milestone as ba, OAuthRefreshToken as bb, type OfferBase as bc, type OfferDetailBase as bd, OfferEditorial as be, OfferOption as bf, OfferOptionSlug as bg, OfferSlug as bh, OfferToken as bi, OfferVaultContract as bj, OffersNamespaceImpl as bk, type OndoQuoteDuration as bl, type OndoSellOutcome as bm, type OndoSwapOffer as bn, PKCEState as bo, type PaginatedResponseDto as bp, ParticipationId as bq, type ParticipationStatus as br, ParticipationsPaginationParams as bs, PauseFlags as bt, Pii as bu, PiiAddress as bv, PiiJurisdiction as bw, type PiiKind as bx, type QueryParamValue as by, type QueryParamValues as bz, type CoinListTokenSaleNamespace as c, OfferOptionId as d, AssetId as e, CoinListTokenSaleNamespaceImpl as f, type OndoNamespace as g, AssetSymbol as h, OfferSwapContract as i, OndoBuyTransaction as j, OndoSellTransaction as k, type OndoSwapTransactionCore as l, type OrderBookSide as m, OndoNamespaceImpl as n, type WalletsNamespace as o, Bps as p, EvmWalletAddress as q, SuperstateSwapNamespaceImpl as r, Requirement as s, RequirementsNamespaceImpl as t, type Config as u, type OAuthAccessToken as v, type OffersNamespace as w, StablecoinSymbol as x, type Erc20Asset as y, OfferDetail as z };

package/dist/{tokens-namespace-CIWBtgt2.d.ts → tokens-namespace-D_XSpiS-.d.ts}

@@ -873,6 +873,19 @@ type HttpRequestAttributes = {
     /** Zero-based attempt index: 0 = first request, 1 = first retry, etc. */
     retryAttempt?: number;
     renewAttempted?: boolean;
+    /**
+     * `false` opts a request out of `requestRetryMiddleware`. For exchanges
+     * that must never be replayed: a refresh token is single-use, so re-sending
+     * one whose first attempt reached the server presents a token that has
+     * already been rotated away.
+     */
+    retryable?: boolean;
+    /**
+     * The user access token `attachSessionMiddleware` put on this request, so
+     * that a 401 can say *which* token was refused. Absent when the request
+     * went out with no user token.
+     */
+    sentWith?: OAuthAccessToken;
     clientCredentials?: ClientCredentialsOAuth;
 };
 
@@ -1061,6 +1074,45 @@ interface Config {
      * See {@link RpcConfig}.
      */
     readonly rpc?: RpcConfig;
+    /**
+     * Called when the SDK has **confirmed** that the user's CoinList session is
+     * gone - its refresh token expired or was revoked - so you can clear your
+     * own state and show a sign-in entry point.
+     *
+     * Confirmed, because the backend answers "rotated a moment ago by a
+     * concurrent request" and "dead" identically. A single rejection is only a
+     * suspicion: the SDK acts on it only once the same session is rejected again
+     * after a settle window, so a lost refresh race never signs a user out.
+     *
+     * Each environment reports what it confirmed itself, so it fires in the
+     * one that drove the confirmation:
+     *
+     * - **`CoinListClient`**: fires when the SDK moves from `'logged-in'` to
+     *   `'logged-out'` because your `getAccessToken` answered `null` (or the
+     *   very token the API just refused) twice, a second apart.
+     * - **`CoinListServer`**: fires when the same process sees a refresh token
+     *   rejected twice, 5 to 60 seconds apart, or an expired session that
+     *   carries no refresh token. The SDK clears the session from your
+     *   `SessionStore` just before. The browser's confirmation, through your
+     *   `getAccessToken` endpoint, comes a second after the first rejection, so
+     *   it does not reach this verdict: when the browser drives renewal, expect
+     *   the `CoinListClient` callback, and this one only if a later request
+     *   presents the dead session 5 to 60 seconds on.
+     *
+     * It never fires on `auth.logout()`, on a 5xx, a timeout or a network
+     * failure - those mean the SDK could not find out, not that the session
+     * ended. Per environment it fires at most once per session, within a
+     * 60-second memory: the server remembers a verdict for 60 seconds per
+     * process (per JavaScript module instance, so Next.js middleware and route
+     * handlers count separately). The same dead session presented again after
+     * that, or to another instance, can be reported again, so make your handler
+     * idempotent.
+     *
+     * It is called on the next microtask and not awaited. A rejection is
+     * logged and dropped, so it cannot fail or delay the request that
+     * discovered the expiry. A synchronous handler is written `async () => {}`.
+     */
+    readonly onSessionExpired?: () => Promise<void>;
 }
 
 /**
@@ -1215,13 +1267,13 @@ type InternalDebugEvent = {
  * union makes a `switch` over it exhaustive: adding a provider without
  * handling it becomes a compile error.
  */
-type OfferTypeDto = 'coinlist::token_sale' | 'superstate::swap' | 'ondo::swap';
+type OfferTypeDto = 'coinlist::token_sale' | 'superstate::swap' | 'ondo::swap' | 'centrifuge::vault';
 /**
  * One variant per {@link OfferTypeDto}, mirroring frontline#1365, which keys
  * `GET /v1/offers` on `type`. Read `type` first: it decides which of the
  * fields below mean anything.
  */
-type OfferDto = CoinListTokenSaleOfferDto | SuperstateSwapOfferDto | OndoSwapOfferDto;
+type OfferDto = CoinListTokenSaleOfferDto | SuperstateSwapOfferDto | OndoSwapOfferDto | CentrifugeVaultOfferDto;
 type OfferBaseDto = {
     id: string;
     slug: string;
@@ -1238,15 +1290,16 @@ type OfferEditorialDto = {
     starts_at: string;
 };
 /**
- * What an Ondo swap sends in place of {@link OfferEditorialDto}. It trades
- * continuously and runs no campaign, so the keys arrive as `null` and carry
- * nothing. Declared so a fixture can describe the real payload; no `fromDto`
- * reads them.
+ * What an Ondo swap or a Centrifuge vault sends in place of
+ * {@link OfferEditorialDto}. Neither runs a campaign, so the keys arrive as
+ * `null` and carry nothing, and the backend may stop sending them at all.
+ * Declared so a fixture can describe the real payload; no `fromDto` reads
+ * them.
  */
 type OfferNoEditorialDto = {
-    tagline: null;
-    banner_url: null;
-    starts_at: null;
+    tagline?: null;
+    banner_url?: null;
+    starts_at?: null;
 };
 type CoinListTokenSaleOfferDto = OfferBaseDto & OfferEditorialDto & {
     type: 'coinlist::token_sale';
@@ -1262,8 +1315,17 @@ type OndoSwapOfferDto = OfferBaseDto & OfferNoEditorialDto & {
     /** Publishing a swap does not require anyone to upload artwork for it. */
     logo_url: string | null;
 };
+type CentrifugeVaultOfferDto = OfferBaseDto & OfferNoEditorialDto & {
+    type: 'centrifuge::vault';
+    /** Publishing a vault does not require anyone to upload artwork for it. */
+    logo_url: string | null;
+};
 type OfferTokenDto = {
-    role: 'funding' | 'distribution' | 'swap';
+    /**
+     * `vault` is the share token a `centrifuge::vault` offer issues for
+     * deposits, as `swap` is the token a swap offer trades into.
+     */
+    role: 'funding' | 'distribution' | 'swap' | 'vault';
     chain: string;
     address: string;
 };
@@ -1294,10 +1356,16 @@ type OndoSwapOffer = OfferBase & {
     /** Null when nobody has uploaded artwork: a swap publishes without it. */
     logoUrl: string | null;
 };
+type CentrifugeVaultOffer = OfferBase & {
+    type: 'centrifuge::vault';
+    /** Null when nobody has uploaded artwork: a vault publishes without it. */
+    logoUrl: string | null;
+};
 /**
  * A curated sale window and the hand-authored copy that goes with it. Every
  * variant that runs such a campaign carries all three, validated; an Ondo swap
- * trades continuously, runs none, and carries none.
+ * trades continuously and a Centrifuge vault takes deposits continuously, so
+ * neither runs one and neither carries any.
  */
 type OfferEditorial = {
     tagline: string;
@@ -1317,7 +1385,7 @@ declare const OfferEditorial: {
  * `type` before reading anything beyond {@link OfferBase} - an Ondo swap has
  * no `startsAt` to read, and the compiler says so.
  */
-type Offer = CoinListTokenSaleOffer | SuperstateSwapOffer | OndoSwapOffer;
+type Offer = CoinListTokenSaleOffer | SuperstateSwapOffer | OndoSwapOffer | CentrifugeVaultOffer;
 declare const Offer: {
     fromDto: (dto: OfferDto) => Offer;
     /**
@@ -1330,7 +1398,11 @@ declare const Offer: {
      */
     listFromDto: (dtos: OfferDto[]) => Offer[];
 };
-type TokenRole = 'funding' | 'distribution' | 'swap';
+/**
+ * `vault` is the share token a `centrifuge::vault` offer issues for deposits,
+ * as `swap` is the token a swap offer trades into.
+ */
+type TokenRole = 'funding' | 'distribution' | 'swap' | 'vault';
 type OfferToken = {
     role: TokenRole;
     chain: Chain;
@@ -1445,16 +1517,16 @@ type CreateParticipationDto = {
  * One variant per `OfferTypeDto`, the same split as `OfferDto` with what
  * `GET /v1/offers/:id` adds on top. Read `type` first.
  */
-type OfferDetailDto = CoinListTokenSaleOfferDetailDto | SuperstateSwapOfferDetailDto | OndoSwapOfferDetailDto;
-type CoinListTokenSaleOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & {
+type OfferDetailDto = CoinListTokenSaleOfferDetailDto | SuperstateSwapOfferDetailDto | OndoSwapOfferDetailDto | CentrifugeVaultOfferDetailDto;
+type CoinListTokenSaleOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & OfferDetailNoVaultContractsDto & {
     type: 'coinlist::token_sale';
     logo_url: string;
 };
-type SuperstateSwapOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & {
+type SuperstateSwapOfferDetailDto = OfferDetailBaseDto & OfferEditorialDto & OfferDetailNoSwapContractsDto & OfferDetailNoVaultContractsDto & {
     type: 'superstate::swap';
     logo_url: string | null;
 };
-type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & {
+type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & OfferDetailNoVaultContractsDto & {
     type: 'ondo::swap';
     logo_url: string | null;
     /**
@@ -1463,6 +1535,19 @@ type OndoSwapOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & {
      */
     swap_contracts: OfferDetailSwapContractDto[];
 };
+type CentrifugeVaultOfferDetailDto = OfferDetailBaseDto & OfferNoEditorialDto & OfferDetailNoSwapContractsDto & {
+    type: 'centrifuge::vault';
+    logo_url: string | null;
+    /**
+     * Every chain this vault takes deposits on, with the CoinList proxy each
+     * request goes through. `[]` is an answer - "deposits nowhere", which is
+     * every vault until a proxy is deployed - and a missing key is not.
+     */
+    vault_contracts: OfferDetailVaultContractDto[];
+};
+type OfferDetailNoVaultContractsDto = {
+    vault_contracts?: OfferDetailVaultContractDto[];
+};
 /**
  * An offer that does not settle through a CoinList swap contract sends `[]`
  * or no key at all, and either way there is nothing to read. Declared so a
@@ -1529,6 +1614,10 @@ type OfferDetailSwapContractDto = {
     chain: string;
     address: string;
 };
+type OfferDetailVaultContractDto = {
+    chain: string;
+    address: string;
+};
 
 type Ticker = Newtype<string, 'Ticker'>;
 declare const Ticker: (value: string) => Ticker;
@@ -1566,6 +1655,16 @@ type OndoSwapOfferDetail = OfferDetailBase & {
      */
     swapContracts: OfferSwapContract[];
 };
+type CentrifugeVaultOfferDetail = OfferDetailBase & {
+    type: 'centrifuge::vault';
+    /** Null when nobody has uploaded artwork: a vault publishes without it. */
+    logoUrl: string | null;
+    /**
+     * Every chain this vault takes deposits on, with the CoinList proxy each
+     * request goes through. Empty means it takes deposits nowhere yet.
+     */
+    vaultContracts: OfferVaultContract[];
+};
 type OfferDetailBase = {
     id: OfferId;
     slug: OfferSlug;
@@ -1643,13 +1742,38 @@ type OfferSwapContract = {
 declare const OfferSwapContract: {
     fromDto: (dto: OfferDetailSwapContractDto) => OfferSwapContract;
 };
+/**
+ * A chain a Centrifuge vault takes deposits on, with the CoinList proxy the
+ * request goes through. Not a token, so the token registry knows nothing about
+ * it: it is the spender the user approves the funding token to, and the `to`
+ * the buy and claim transactions are sent to.
+ *
+ * Its own type rather than an {@link OfferSwapContract}, although the shape is
+ * the same, because the meaning is not: a swap contract serves every Ondo
+ * asset on its chain, while a proxy belongs to one offer on one chain, so the
+ * same chain carries a different address on every vault.
+ */
+type OfferVaultContract = {
+    chain: Chain;
+    address: EvmContractAddress;
+};
+declare const OfferVaultContract: {
+    fromDto: (dto: OfferDetailVaultContractDto) => OfferVaultContract;
+    /**
+     * Drops every proxy on a chain this SDK does not name, as
+     * `OfferToken.listFromDto` does: frontline publishes the full offer-token
+     * chain list, which runs ahead of {@link Chain}, and one unmodelled chain
+     * should not throw away the proxies the SDK can use.
+     */
+    listFromDto: (dtos: OfferDetailVaultContractDto[]) => OfferVaultContract[];
+};
 /**
  * An offer as `GET /v1/offers/:id` serves it: the same union on `type` as
  * {@link Offer}, each variant carrying only the fields that mean something
  * for it. Narrow on `type` before reading anything beyond
  * {@link OfferDetailBase}.
  */
-type OfferDetail = CoinListTokenSaleOfferDetail | SuperstateSwapOfferDetail | OndoSwapOfferDetail;
+type OfferDetail = CoinListTokenSaleOfferDetail | SuperstateSwapOfferDetail | OndoSwapOfferDetail | CentrifugeVaultOfferDetail;
 declare const OfferDetail: {
     fromDto: (dto: OfferDetailDto) => OfferDetail;
 };
@@ -2436,6 +2560,17 @@ declare const OndoSellTransaction: {
  */
 interface OndoNamespace {
     getTradingStatus(params: GetOndoTradingStatusParams): Promise<OndoTradingStatus>;
+    /**
+     * An indicative price for `params`' size, from Ondo's live market.
+     *
+     * Ondo refuses to quote while the market is closed or paused, or the asset
+     * is paused or closed for the session - including for about a minute at
+     * every US session change, when `getTradingStatus` may still have reported
+     * the asset tradable. The request then rejects with a 409 carrying
+     * `code: "not_tradable"`; tell it apart from a failure with
+     * {@link isOndoNotTradableError}. Retrying before the market opens fails the
+     * same way.
+     */
     getQuote(params: GetOndoQuoteParams): Promise<OndoQuote>;
     /**
      * Builds a purchase for a specific wallet and deposit: spends an attestation
@@ -3298,4 +3433,4 @@ declare class TokensNamespaceImpl implements TokensNamespace {
     list(chain?: EthereumChain): Promise<TokenMetadata[]>;
 }
 
-export { OndoTradingStatus as $, AuthorizationCode as A, BlockchainAmount as B, CodeVerifier as C, TokenMetadata as D, type Erc20Namespace as E, type OfferType as F, type OndoSwapOfferDetail as G, type CoinListTokenSaleOfferDetail as H, type SuperstateSwapOfferDetail as I, Offer as J, RequirementStatusInfo as K, type Logger as L, type RequirementType as M, type RequirementStatusValue as N, OfferId as O, Participation as P, OfferOptionAddress as Q, type RequirementsNamespace as R, type SuperstateSwapNamespace as S, type TokensNamespace as T, type UniversalNamespaceContext as U, RequirementId as V, type WalletError as W, type KycLevelName as X, DocumentSubmission as Y, type WalletChallengeType as Z, type PinoLoggerOptions as _, EthereumChain as a, type GetTokenBalanceParams as a$, AssetDecimals as a0, type BuildOndoBuyParams as a1, type BuildOndoSellParams as a2, OndoQuote as a3, type OndoQuoteSize as a4, type TokenIdentifier as a5, OfferOptionAddressId as a6, TokenLogo as a7, type DebugEvent as a8, type FrontlineEventId as a9, type Newtype as aA, type AllowWalletParams as aB, AllowWalletResponse as aC, Asset as aD, AssetCode as aE, Blockchain as aF, type BuildOndoSwapParamsCore as aG, Chain as aH, ClientId as aI, CodeChallenge as aJ, type CoinListTokenSaleOffer as aK, ConnectExternalWalletParams as aL, type CreateKycTokenParams as aM, CreateParticipationParams as aN, CreateWalletOwnershipChallengeParams as aO, Cursor as aP, type DocumentFormType as aQ, type DocumentSubmissionStatus as aR, type DocumentType as aS, ETHEREUM_CHAINS as aT, Erc20NamespaceImpl as aU, FaqItem as aV, type GetOndoQuoteParams as aW, type GetOndoTradingStatusParams as aX, type GetSwapAuthorizationParams as aY, type GetSwapPreviewParams as aZ, type GetTokenAllowanceParams as a_, HttpError as aa, type HttpResponse as ab, KycToken as ac, type LogBinding as ad, type LogBindings as ae, type LogCause as af, type LogLevel as ag, type LogScope as ah, type LogValue as ai, type ProductionLogLevel as aj, RedactedWalletError as ak, type RequestId as al, type RpcFailureReason as am, type SafeEvent as an, type SafeFields as ao, type UnredactedFields as ap, OAuthSession as aq, ClientCredentialsOAuth as ar, ClientSecret as as, type Sender as at, PaginationParams as au, PaginatedResponse as av, DecimalString as aw, SwapStatus as ax, type Uint256 as ay, KnownAssetSymbol as az, EvmContractAddress as b, HexEncodedTransactionData as b0, Isin as b1, Iso2CountryCode as b2, Link as b3, type ListOptionAddressesParams as b4, MAX_ASSET_DECIMALS as b5, MAX_UINT_256 as b6, Milestone as b7, OAuthRefreshToken as b8, type OfferBase as b9, SOLANA_CHAINS as bA, STABLE_DECIMALS as bB, SolanaChain as bC, type SubmitDocumentParams as bD, type SuperstateSwapOffer as bE, type SwapContractRef as bF, SwapPreview as bG, TermItem as bH, Ticker as bI, type TokenLogoImage as bJ, TokenLogoUrl as bK, type TokenRole as bL, TokensNamespaceImpl as bM, type Tx as bN, WalletAddress as bO, WalletOwnershipChallenge as bP, type WalletProtocol as bQ, WalletsNamespaceImpl as bR, apiErrorCode as bS, assertUint256 as bT, isChain as bU, isOfferType as bV, parseUint256 as bW, type OfferDetailBase as ba, OfferEditorial as bb, OfferOption as bc, OfferOptionSlug as bd, OfferSlug as be, OfferToken as bf, OffersNamespaceImpl as bg, type OndoQuoteDuration as bh, type OndoSellOutcome as bi, type OndoSwapOffer as bj, PKCEState as bk, type PaginatedResponseDto as bl, ParticipationId as bm, type ParticipationStatus as bn, ParticipationsPaginationParams as bo, PauseFlags as bp, Pii as bq, PiiAddress as br, PiiJurisdiction as bs, type PiiKind as bt, type QueryParamValue as bu, type QueryParamValues as bv, RedirectUri as bw, type RemoveOptionAddressParams as bx, type RequirementActionNeededReason as by, type RpcConfig as bz, type CoinListTokenSaleNamespace as c, OfferOptionId as d, AssetId as e, CoinListTokenSaleNamespaceImpl as f, type OndoNamespace as g, AssetSymbol as h, OfferSwapContract as i, OndoBuyTransaction as j, OndoSellTransaction as k, type OndoSwapTransactionCore as l, type OrderBookSide as m, OndoNamespaceImpl as n, type WalletsNamespace as o, Bps as p, EvmWalletAddress as q, SuperstateSwapNamespaceImpl as r, Requirement as s, RequirementsNamespaceImpl as t, type Config as u, type OAuthAccessToken as v, type OffersNamespace as w, StablecoinSymbol as x, type Erc20Asset as y, OfferDetail as z };
+export { type PinoLoggerOptions as $, AuthorizationCode as A, BlockchainAmount as B, CodeVerifier as C, TokenMetadata as D, type Erc20Namespace as E, type CentrifugeVaultOfferDetail as F, type OfferType as G, type OndoSwapOfferDetail as H, type CoinListTokenSaleOfferDetail as I, type SuperstateSwapOfferDetail as J, Offer as K, type Logger as L, RequirementStatusInfo as M, type RequirementType as N, OfferId as O, Participation as P, type RequirementStatusValue as Q, type RequirementsNamespace as R, type SuperstateSwapNamespace as S, type TokensNamespace as T, type UniversalNamespaceContext as U, OfferOptionAddress as V, type WalletError as W, RequirementId as X, type KycLevelName as Y, DocumentSubmission as Z, type WalletChallengeType as _, EthereumChain as a, type GetSwapAuthorizationParams as a$, OndoTradingStatus as a0, AssetDecimals as a1, type BuildOndoBuyParams as a2, type BuildOndoSellParams as a3, OndoQuote as a4, type OndoQuoteSize as a5, type TokenIdentifier as a6, OfferOptionAddressId as a7, TokenLogo as a8, type DebugEvent as a9, KnownAssetSymbol as aA, type Tx as aB, type Newtype as aC, type AllowWalletParams as aD, AllowWalletResponse as aE, Asset as aF, AssetCode as aG, Blockchain as aH, type BuildOndoSwapParamsCore as aI, type CentrifugeVaultOffer as aJ, Chain as aK, ClientId as aL, CodeChallenge as aM, type CoinListTokenSaleOffer as aN, ConnectExternalWalletParams as aO, type CreateKycTokenParams as aP, CreateParticipationParams as aQ, CreateWalletOwnershipChallengeParams as aR, Cursor as aS, type DocumentFormType as aT, type DocumentSubmissionStatus as aU, type DocumentType as aV, ETHEREUM_CHAINS as aW, Erc20NamespaceImpl as aX, FaqItem as aY, type GetOndoQuoteParams as aZ, type GetOndoTradingStatusParams as a_, type FrontlineEventId as aa, HttpError as ab, type HttpResponse as ac, KycToken as ad, type LogBinding as ae, type LogBindings as af, type LogCause as ag, type LogLevel as ah, type LogScope as ai, type LogValue as aj, type ProductionLogLevel as ak, RedactedWalletError as al, type RequestId as am, type RpcFailureReason as an, type SafeEvent as ao, type SafeFields as ap, type UnredactedFields as aq, OAuthSession as ar, ClientCredentialsOAuth as as, type Sender as at, PaginationParams as au, PaginatedResponse as av, ClientSecret as aw, DecimalString as ax, SwapStatus as ay, type Uint256 as az, EvmContractAddress as b, type GetSwapPreviewParams as b0, type GetTokenAllowanceParams as b1, type GetTokenBalanceParams as b2, HexEncodedTransactionData as b3, Isin as b4, Iso2CountryCode as b5, Link as b6, type ListOptionAddressesParams as b7, MAX_ASSET_DECIMALS as b8, MAX_UINT_256 as b9, RedirectUri as bA, type RemoveOptionAddressParams as bB, type RequirementActionNeededReason as bC, type RpcConfig as bD, SOLANA_CHAINS as bE, STABLE_DECIMALS as bF, SolanaChain as bG, type SubmitDocumentParams as bH, type SuperstateSwapOffer as bI, type SwapContractRef as bJ, SwapPreview as bK, TermItem as bL, Ticker as bM, type TokenLogoImage as bN, TokenLogoUrl as bO, type TokenRole as bP, TokensNamespaceImpl as bQ, WalletAddress as bR, WalletOwnershipChallenge as bS, type WalletProtocol as bT, WalletsNamespaceImpl as bU, apiErrorCode as bV, assertUint256 as bW, isChain as bX, isOfferType as bY, parseUint256 as bZ, Milestone as ba, OAuthRefreshToken as bb, type OfferBase as bc, type OfferDetailBase as bd, OfferEditorial as be, OfferOption as bf, OfferOptionSlug as bg, OfferSlug as bh, OfferToken as bi, OfferVaultContract as bj, OffersNamespaceImpl as bk, type OndoQuoteDuration as bl, type OndoSellOutcome as bm, type OndoSwapOffer as bn, PKCEState as bo, type PaginatedResponseDto as bp, ParticipationId as bq, type ParticipationStatus as br, ParticipationsPaginationParams as bs, PauseFlags as bt, Pii as bu, PiiAddress as bv, PiiJurisdiction as bw, type PiiKind as bx, type QueryParamValue as by, type QueryParamValues as bz, type CoinListTokenSaleNamespace as c, OfferOptionId as d, AssetId as e, CoinListTokenSaleNamespaceImpl as f, type OndoNamespace as g, AssetSymbol as h, OfferSwapContract as i, OndoBuyTransaction as j, OndoSellTransaction as k, type OndoSwapTransactionCore as l, type OrderBookSide as m, OndoNamespaceImpl as n, type WalletsNamespace as o, Bps as p, EvmWalletAddress as q, SuperstateSwapNamespaceImpl as r, Requirement as s, RequirementsNamespaceImpl as t, type Config as u, type OAuthAccessToken as v, type OffersNamespace as w, StablecoinSymbol as x, type Erc20Asset as y, OfferDetail as z };