tapimo 0.7.0 → 0.7.2

package/dist/internal/EarnVaults.d.ts

@@ -0,0 +1,171 @@
+import type { Chain } from 'viem';
+import * as z from 'zod/mini';
+import * as Viem from './Viem.js';
+/** Zod schemas owned by the Earn vault resolver. */
+export declare namespace schema {
+    /** Schema selecting one onchain Earn vault. */
+    const ResolveInput: z.ZodMiniObject<{
+        chainId: z.ZodMiniPipe<z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>, z.ZodMiniTransform<4217 | 42431, "mainnet" | "testnet">>, z.ZodMiniNumber<unknown>]>, z.ZodMiniNumber<number>>;
+        vaultAddress: z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>;
+    }, z.core.$strict>;
+    /** Schema for live state resolved from one Earn vault. */
+    const Discovery: z.ZodMiniObject<{
+        access: z.ZodMiniOptional<z.ZodMiniObject<{
+            status: z.ZodMiniEnum<{
+                allowlisted: "allowlisted";
+                open: "open";
+            }>;
+        }, z.core.$strict>>;
+        assetToken: z.ZodMiniObject<{
+            address: z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>;
+            currency: z.ZodMiniString<string>;
+            decimals: z.ZodMiniNumber<number>;
+            name: z.ZodMiniString<string>;
+            symbol: z.ZodMiniString<string>;
+        }, z.core.$strict>;
+        capabilities: z.ZodMiniOptional<z.ZodMiniObject<{
+            asyncRedeem: z.ZodMiniBoolean<boolean>;
+            boundedRedeem: z.ZodMiniBoolean<boolean>;
+            deposit: z.ZodMiniBoolean<boolean>;
+            exactWithdraw: z.ZodMiniBoolean<boolean>;
+            inKindDeposit: z.ZodMiniBoolean<boolean>;
+            privateRouting: z.ZodMiniBoolean<boolean>;
+            redeem: z.ZodMiniBoolean<boolean>;
+            routerSwaps: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strict>>;
+        chainId: z.ZodMiniPipe<z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>, z.ZodMiniTransform<4217 | 42431, "mainnet" | "testnet">>, z.ZodMiniNumber<unknown>]>, z.ZodMiniNumber<number>>;
+        engine: z.ZodMiniObject<{
+            address: z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>;
+            type: z.ZodMiniNullable<z.ZodMiniEnum<{
+                erc4626: "erc4626";
+                veda: "veda";
+            }>>;
+            venue: z.ZodMiniNullable<z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>>;
+        }, z.core.$strict>;
+        instantLiquidity: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        sharePrice: z.ZodMiniNullable<z.ZodMiniString<string>>;
+        shareToken: z.ZodMiniObject<{
+            address: z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>;
+            currency: z.ZodMiniString<string>;
+            decimals: z.ZodMiniNumber<number>;
+            name: z.ZodMiniString<string>;
+            symbol: z.ZodMiniString<string>;
+        }, z.core.$strict>;
+        state: z.ZodMiniObject<{
+            depositsPaused: z.ZodMiniBoolean<boolean>;
+            engineShares: z.ZodMiniString<string>;
+            feesActive: z.ZodMiniBoolean<boolean>;
+            isAccountingAligned: z.ZodMiniBoolean<boolean>;
+            openRedeemRequestCount: z.ZodMiniNumber<number>;
+            totalAssets: z.ZodMiniString<string>;
+            totalEarnShares: z.ZodMiniString<string>;
+        }, z.core.$strict>;
+        vaultAddress: z.ZodMiniPipe<z.ZodMiniTemplateLiteral<`0x${string}`>, z.ZodMiniTransform<`0x${string}`, `0x${string}`>>;
+    }, z.core.$strict>;
+}
+/** Live state resolved from an Earn vault. */
+export type Discovery = z.output<typeof schema.Discovery>;
+/** Onchain identity of an Earn vault. */
+export type ResolveInput = z.output<typeof schema.ResolveInput>;
+/** Stable code describing an onchain verification issue. */
+export type VerificationIssueCode = 'chain-mismatch' | 'engine-asset-mismatch' | 'policy-unsupported' | 'read-failed';
+/** One onchain verification issue. */
+export type VerificationIssue = {
+    /** Observed value, when available. */
+    actual?: string | undefined;
+    /** Stable machine-readable issue code. */
+    code: VerificationIssueCode;
+    /** Expected value, when available. */
+    expected?: string | undefined;
+    /** Human-readable issue detail. */
+    message: string;
+};
+/** Token and vault state observed during verification. */
+export type VerificationSnapshot = {
+    /** Asset token observed onchain. */
+    assetToken?: Discovery['assetToken'] | undefined;
+    /** Whether vault supply matches its engine backing. */
+    isSynced?: boolean | undefined;
+    /** Share token observed onchain. */
+    shareToken?: Discovery['shareToken'] | undefined;
+};
+type VerificationMismatch = {
+    /** Issues found while reading the deployment. */
+    issues: readonly VerificationIssue[];
+    /** Token and vault state observed during verification. */
+    snapshot: VerificationSnapshot;
+    /** Indicates that onchain state is incompatible. */
+    status: 'mismatch';
+};
+type VerificationUnavailable = {
+    /** Issue that prevented verification. */
+    issues: readonly VerificationIssue[];
+    /** Indicates that verification could not complete. */
+    status: 'unavailable';
+};
+type VerificationFailure = VerificationMismatch | VerificationUnavailable;
+/** Resolves one Earn vault from its onchain identity. */
+export declare function resolve(options: resolve.ProjectedOptions): Promise<Discovery>;
+/** Resolves every optional Earn vault field. */
+export declare function resolve(options: resolve.Options): Promise<resolve.CompleteDiscovery>;
+export declare namespace resolve {
+    /** Fully resolved Earn vault state. */
+    type CompleteDiscovery = Discovery & {
+        /** Vault share-token access. */
+        access: NonNullable<Discovery['access']>;
+        /** Actions supported by the vault. */
+        capabilities: NonNullable<Discovery['capabilities']>;
+    };
+    /** Optional onchain fields to resolve. */
+    type Include = 'access' | 'capabilities';
+    /** Options for resolving one Earn vault. */
+    type Options = {
+        /** Resolves the onchain client used to read the vault. */
+        getClient: Viem.GetClient;
+        /** Chain and vault identity to resolve. */
+        input: unknown;
+        /** Private zones available to Earn routers. */
+        zones: readonly Chain[];
+    };
+    /** Options for resolving selected optional fields. */
+    type ProjectedOptions = Options & {
+        /** Optional onchain fields to resolve. */
+        include: readonly Include[];
+    };
+}
+/** Infers the supported engine type from its capability fingerprint. */
+export declare function classifyEngineType(options: classifyEngineType.Options): classifyEngineType.ReturnType;
+export declare namespace classifyEngineType {
+    /** Capability fingerprint used to classify an engine. */
+    type Options = {
+        /** Whether queued redemptions are supported. */
+        asyncRedeem: boolean;
+        /** Whether venue-share deposits are supported. */
+        inKindDeposit: boolean;
+    };
+    /** Supported engine type, or null for an unknown fingerprint. */
+    type ReturnType = 'erc4626' | 'veda' | null;
+}
+/** Thrown when an Earn resolver value fails schema validation. */
+export declare class InvalidRegistryError extends Error {
+    name: string;
+}
+/** Thrown when a requested Earn vault does not exist. */
+export declare class NotFoundError extends Error {
+    name: string;
+}
+/** Thrown when onchain verification rejects an Earn vault. */
+export declare class VerificationError extends Error {
+    /** Failed verification result. */
+    result: VerificationFailure;
+    constructor(result: VerificationFailure);
+    name: string;
+}
+export {};
+//# sourceMappingURL=EarnVaults.d.ts.map

package/dist/internal/EarnVaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EarnVaults.d.ts","sourceRoot":"","sources":["../../src/internal/EarnVaults.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAW,KAAK,EAAE,MAAM,MAAM,CAAA;AAE1C,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC,oDAAoD;AACpD,yBAAiB,MAAM,CAAC;IAsItB,+CAA+C;IACxC,MAAM,YAAY;;;;;;sBAWiC,CAAA;IAE1D,0DAA0D;IACnD,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAyDyC,CAAA;CAChE;AAED,8CAA8C;AAC9C,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,SAAS,CAAC,CAAA;AAEzD,yCAAyC;AACzC,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,MAAM,CAAC,YAAY,CAAC,CAAA;AAE/D,4DAA4D;AAC5D,MAAM,MAAM,qBAAqB,GAC7B,gBAAgB,GAChB,uBAAuB,GACvB,oBAAoB,GACpB,aAAa,CAAA;AAEjB,sCAAsC;AACtC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,0CAA0C;IAC1C,IAAI,EAAE,qBAAqB,CAAA;IAC3B,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,mCAAmC;IACnC,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB,GAAG;IACjC,oCAAoC;IACpC,UAAU,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAA;IAChD,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,oCAAoC;IACpC,UAAU,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAA;CACjD,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,iDAAiD;IACjD,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAA;IACpC,0DAA0D;IAC1D,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,oDAAoD;IACpD,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAED,KAAK,uBAAuB,GAAG;IAC7B,yCAAyC;IACzC,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAA;IACpC,sDAAsD;IACtD,MAAM,EAAE,aAAa,CAAA;CACtB,CAAA;AAED,KAAK,mBAAmB,GAAG,oBAAoB,GAAG,uBAAuB,CAAA;AAgDzE,yDAAyD;AACzD,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;AAC9E,gDAAgD;AAChD,wBAAgB,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAUrF,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,uCAAuC;IACvC,KAAK,iBAAiB,GAAG,SAAS,GAAG;QACnC,gCAAgC;QAChC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QACxC,sCAAsC;QACtC,YAAY,EAAE,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAA;KACrD,CAAA;IAED,0CAA0C;IAC1C,KAAK,OAAO,GAAG,QAAQ,GAAG,cAAc,CAAA;IAExC,4CAA4C;IAC5C,KAAK,OAAO,GAAG;QACb,0DAA0D;QAC1D,SAAS,EAAE,IAAI,CAAC,SAAS,CAAA;QACzB,2CAA2C;QAC3C,KAAK,EAAE,OAAO,CAAA;QACd,+CAA+C;QAC/C,KAAK,EAAE,SAAS,KAAK,EAAE,CAAA;KACxB,CAAA;IAED,sDAAsD;IACtD,KAAK,gBAAgB,GAAG,OAAO,GAAG;QAChC,0CAA0C;QAC1C,OAAO,EAAE,SAAS,OAAO,EAAE,CAAA;KAC5B,CAAA;CACF;AAED,wEAAwE;AACxE,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,kBAAkB,CAAC,OAAO,GAClC,kBAAkB,CAAC,UAAU,CAI/B;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,yDAAyD;IACzD,KAAK,OAAO,GAAG;QACb,gDAAgD;QAChD,WAAW,EAAE,OAAO,CAAA;QACpB,kDAAkD;QAClD,aAAa,EAAE,OAAO,CAAA;KACvB,CAAA;IAED,iEAAiE;IACjE,KAAK,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAAA;CAC5C;AAqdD,kEAAkE;AAClE,qBAAa,oBAAqB,SAAQ,KAAK;IACpC,IAAI,SAAoC;CAClD;AAED,yDAAyD;AACzD,qBAAa,aAAc,SAAQ,KAAK;IAC7B,IAAI,SAA6B;CAC3C;AAED,8DAA8D;AAC9D,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,kCAAkC;IAClC,MAAM,EAAE,mBAAmB,CAAA;IAE3B,YAAY,MAAM,EAAE,mBAAmB,EAGtC;IAEQ,IAAI,SAAiC;CAC/C"}