@evergonlabs/tmi-protocol-api 0.11.0-rc.0 → 0.11.0-rc.2

package/dist/next/vestingRedemptionDynamic/epochPurchase.js

@@ -0,0 +1,34 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi";
+import { buildEpochPurchaseTx } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { EpochPurchaseConfigSchema } from "./schemas.js";
+import { vrdTag } from "./tag.js";
+import { createController } from "../../common/controller.js";
+import { toTransaction, TransactionSchema } from "../../common/index.js";
+const purchaseRoute = describeRoute({
+    summary: "Purchase step 1 — provide funds and receive receipt NFT",
+    description: "Returns transaction data for the first step of the two-click epoch purchase flow. " +
+        "The investor provides funding packets and receives a purchase receipt NFT. " +
+        "Prerequisites: investor must hold the INVESTOR role, and must have approved " +
+        "the market to spend their ERC-20 payment tokens.",
+    tags: [vrdTag.tag],
+    responses: {
+        200: {
+            description: "Returns transaction data for the epoch purchase",
+            content: {
+                "application/json": {
+                    schema: resolver(TransactionSchema),
+                },
+            },
+        },
+    },
+});
+export const EpochPurchaseV0 = createController({
+    build: (factory) => factory
+        .createApp()
+        .post("/", purchaseRoute, validator("json", EpochPurchaseConfigSchema.openapi("EpochPurchaseConfigSchema")), async (c) => {
+        const config = c.req.valid("json");
+        const tx = buildEpochPurchaseTx(config);
+        return c.json(toTransaction(tx));
+    }),
+});

package/dist/next/vestingRedemptionDynamic/exchangeNftForFractions.d.ts

@@ -0,0 +1,28 @@
+export declare const ExchangeNftForFractionsV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    nftId: string;
+                };
+            };
+            output: {
+                data: `0x${string}`;
+                to: `0x${string}`;
+                details: {
+                    functionName: string;
+                    address: `0x${string}`;
+                    abi: any[];
+                    args: any[];
+                };
+            };
+            outputFormat: "json";
+            status: import("hono/utils/http-status").ContentfulStatusCode;
+        };
+    };
+}, "/", "/">>;
+//# sourceMappingURL=exchangeNftForFractions.d.ts.map

package/dist/next/vestingRedemptionDynamic/exchangeNftForFractions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exchangeNftForFractions.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/exchangeNftForFractions.ts"],"names":[],"mappings":"AA6BA,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;aAcpC,CAAC"}

package/dist/next/vestingRedemptionDynamic/exchangeNftForFractions.js

@@ -0,0 +1,34 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi";
+import { buildExchangeNftForFractionsTx } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { ExchangeNftForFractionsConfigSchema } from "./schemas.js";
+import { vrdTag } from "./tag.js";
+import { createController } from "../../common/controller.js";
+import { toTransaction, TransactionSchema } from "../../common/index.js";
+const exchangeRoute = describeRoute({
+    summary: "Purchase step 2 — burn receipt NFT and receive ERC-20 fractions",
+    description: "Returns transaction data for the second step of the two-click epoch purchase flow. " +
+        "The investor burns their purchase receipt NFT and receives ERC-20 fractions priced at epoch N+1, " +
+        "where N is the epoch in which the receipt was minted. " +
+        "This can only be called after the price setter has advanced the epoch at least once since the purchase.",
+    tags: [vrdTag.tag],
+    responses: {
+        200: {
+            description: "Returns transaction data for the NFT exchange",
+            content: {
+                "application/json": {
+                    schema: resolver(TransactionSchema),
+                },
+            },
+        },
+    },
+});
+export const ExchangeNftForFractionsV0 = createController({
+    build: (factory) => factory
+        .createApp()
+        .post("/", exchangeRoute, validator("json", ExchangeNftForFractionsConfigSchema.openapi("ExchangeNftForFractionsRequestSchema")), async (c) => {
+        const config = c.req.valid("json");
+        const tx = buildExchangeNftForFractionsTx(config);
+        return c.json(toTransaction(tx));
+    }),
+});

package/dist/next/vestingRedemptionDynamic/getCurrentEpoch.d.ts

@@ -0,0 +1,21 @@
+export declare const GetCurrentEpochV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                };
+            };
+            output: {
+                currentEpoch: string;
+            };
+            outputFormat: "json";
+            status: import("hono/utils/http-status").ContentfulStatusCode;
+        };
+    };
+}, "/", "/">>;
+//# sourceMappingURL=getCurrentEpoch.d.ts.map

package/dist/next/vestingRedemptionDynamic/getCurrentEpoch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrentEpoch.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/getCurrentEpoch.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;aAoC5B,CAAC"}

package/dist/next/{fractions/vestingRedemptionDynamic/getCurrentEpoch.routes.js → vestingRedemptionDynamic/getCurrentEpoch.js}

@@ -1,31 +1,22 @@
 import { describeRoute } from "hono-openapi";
 import { resolver, validator } from "hono-openapi";
 import { readContract } from "viem/actions";
-import { z } from "zod";
 import { buildGetCurrentEpochCall } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
 import { Int256Json } from "@evergonlabs/tmi-utils/models";
-import { getPublicClient } from "../../../common/blockchain.js";
-import { createController } from "../../../common/controller.js";
-import { AddressSchema, NextFractionsChainId } from "../../../common/index.js";
-import { Int256BigInt } from "../../../common/int256.js";
-const QuerySchema = z.object({
-    chainId: NextFractionsChainId.openapi({
-        param: { name: "chainId", in: "query" },
-    }),
-    market: AddressSchema.openapi({
-        param: { name: "market", in: "query" },
-        description: "Address of the Vesting & Redemption Dynamic market",
-    }),
-    campaignId: Int256BigInt().openapi({
-        param: { name: "campaignId", in: "query" },
-        description: "Campaign ID",
-    }),
-});
+import { GetCurrentEpochSchema as _GetCurrentEpochSchema } from "./schemas.js";
+import { vrdTag } from "./tag.js";
+import { getPublicClient } from "../../common/blockchain.js";
+import { createController } from "../../common/controller.js";
+import { NextFractionsChainId } from "../../common/index.js";
+const GetCurrentEpochSchema = _GetCurrentEpochSchema
+    .extend({ chainId: NextFractionsChainId })
+    .openapi("GetCurrentEpochSchema");
 export const GetCurrentEpochV0 = createController({
-    build: (factory) => factory.createApp().get("/", describeRoute({
+    build: (factory) => factory.createApp().post("/", describeRoute({
         summary: "Get current epoch",
         description: "Returns the current epoch number for a Vesting & Redemption Dynamic campaign.",
-        tags: ["Vesting & Redemption Dynamic"],
+        tags: [vrdTag.tag],
         responses: {
             200: {
                 description: "Returns the current epoch number",
@@ -38,15 +29,15 @@ export const GetCurrentEpochV0 = createController({
                 },
             },
         },
-    }), validator("query", QuerySchema), async (c) => {
-        const { chainId, market, campaignId } = c.req.valid("query");
+    }), validator("json", GetCurrentEpochSchema), async (c) => {
+        const { chainId, campaign } = c.req.valid("json");
         const publicClient = getPublicClient(chainId, c.env.config);
         // account must be the diamond address itself so msg.sender == address(this),
         // satisfying the OnlyInternalDelegateCall modifier on the facet.
         const result = await readContract(publicClient, {
-            ...buildGetCurrentEpochCall(market, campaignId),
-            account: market,
+            ...buildGetCurrentEpochCall({ campaign }),
+            account: campaign.market,
         });
-        return c.json({ currentEpoch: result.toString() }, 200);
+        return c.json({ currentEpoch: result.toString() });
     }),
 });

package/dist/next/vestingRedemptionDynamic/getEpochPurchaseEvent.d.ts

@@ -0,0 +1,24 @@
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
+export declare const GetEpochPurchaseEventV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                    hash: string;
+                };
+            };
+            output: {
+                campaignId: string & z.core.$brand<"Int256">;
+                nftId: string & z.core.$brand<"Int256">;
+                purchaser: `0x${string}`;
+                amountProvided: string & z.core.$brand<"Int256">;
+                amountAfterFees: string & z.core.$brand<"Int256">;
+                epochPurchased: string & z.core.$brand<"Int256">;
+            };
+            outputFormat: "json";
+            status: import("hono/utils/http-status").ContentfulStatusCode;
+        };
+    };
+}, "/", "/">>;
+//# sourceMappingURL=getEpochPurchaseEvent.d.ts.map

package/dist/next/vestingRedemptionDynamic/getEpochPurchaseEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getEpochPurchaseEvent.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/getEpochPurchaseEvent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,qCAAqC,CAAC;AAgBxD,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;aAiDlC,CAAC"}

package/dist/next/{fractions/vestingRedemptionDynamic/getEpochPurchaseEvent.routes.js → vestingRedemptionDynamic/getEpochPurchaseEvent.js}

@@ -1,26 +1,25 @@
 import { describeRoute } from "hono-openapi";
 import { resolver, validator } from "hono-openapi";
 import { waitForTransactionReceipt } from "viem/actions";
-import { z } from "zod";
 import { parseNftPurchasedEvent } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
-import { Int256Json } from "@evergonlabs/tmi-utils/models";
-import { getPublicClient } from "../../../common/blockchain.js";
-import { createController } from "../../../common/controller.js";
-import { HttpError } from "../../../common/http-error.js";
-import { AddressSchema, HashSchema, NextFractionsChainId } from "../../../common/index.js";
-const QuerySchema = z.object({
-    chainId: NextFractionsChainId.openapi({
-        param: { name: "chainId", in: "query" },
-    }),
-    hash: HashSchema.openapi({
-        param: { name: "hash", in: "query" },
-    }),
-});
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
+import { Int256Json, toInt256Json } from "@evergonlabs/tmi-utils/models";
+import { vrdTag } from "./tag.js";
+import { getPublicClient } from "../../common/blockchain.js";
+import { createController } from "../../common/controller.js";
+import { HttpError } from "../../common/http-error.js";
+import { AddressSchema, HashSchema, NextFractionsChainId } from "../../common/index.js";
+const GetEpochPurchaseEventSchema = z
+    .object({
+    chainId: NextFractionsChainId,
+    hash: HashSchema,
+})
+    .openapi("GetEpochPurchaseEventSchema");
 export const GetEpochPurchaseEventV0 = createController({
-    build: (factory) => factory.createApp().get("/", describeRoute({
+    build: (factory) => factory.createApp().post("/", describeRoute({
         summary: "Get NftPurchased event",
         description: "Gets the transaction by hash and parses the `NftPurchased` event emitted during step 1 of the two-click epoch purchase flow.",
-        tags: ["Vesting & Redemption Dynamic"],
+        tags: [vrdTag.tag],
         responses: {
             200: {
                 description: "Returns parsed NftPurchased event data",
@@ -38,8 +37,8 @@ export const GetEpochPurchaseEventV0 = createController({
                 },
             },
         },
-    }), validator("query", QuerySchema), async (c) => {
-        const params = c.req.valid("query");
+    }), validator("json", GetEpochPurchaseEventSchema), async (c) => {
+        const params = c.req.valid("json");
         const receipt = await waitForTransactionReceipt(getPublicClient(params.chainId, c.env.config), {
             hash: params.hash,
         });
@@ -48,13 +47,13 @@ export const GetEpochPurchaseEventV0 = createController({
             throw new UnableParseNftPurchasedEvent();
         }
         return c.json({
-            campaignId: result.campaignId.toString(),
-            nftId: result.nftId.toString(),
+            campaignId: toInt256Json(result.campaignId),
+            nftId: toInt256Json(result.nftId),
             purchaser: result.purchaser,
-            amountProvided: result.amountProvided.toString(),
-            amountAfterFees: result.amountAfterFees.toString(),
-            epochPurchased: result.epochPurchased.toString(),
-        }, 200);
+            amountProvided: toInt256Json(result.amountProvided),
+            amountAfterFees: toInt256Json(result.amountAfterFees),
+            epochPurchased: toInt256Json(result.epochPurchased),
+        });
     }),
 });
 class UnableParseNftPurchasedEvent extends HttpError {

package/dist/next/vestingRedemptionDynamic/getPurchasePriceForEpoch.d.ts

@@ -0,0 +1,22 @@
+export declare const GetPurchasePriceForEpochV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    epoch: string;
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                };
+            };
+            output: {
+                price: string;
+            };
+            outputFormat: "json";
+            status: import("hono/utils/http-status").ContentfulStatusCode;
+        };
+    };
+}, "/", "/">>;
+//# sourceMappingURL=getPurchasePriceForEpoch.d.ts.map

package/dist/next/vestingRedemptionDynamic/getPurchasePriceForEpoch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPurchasePriceForEpoch.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/getPurchasePriceForEpoch.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;aAwCrC,CAAC"}

package/dist/next/vestingRedemptionDynamic/getPurchasePriceForEpoch.js

@@ -0,0 +1,45 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi";
+import { readContract } from "viem/actions";
+import { buildGetPurchasePriceForEpochCall, GetPurchasePriceForEpochSchema as _GetPurchasePriceForEpochSchema, } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
+import { Int256Json } from "@evergonlabs/tmi-utils/models";
+import { vrdTag } from "./tag.js";
+import { getPublicClient } from "../../common/blockchain.js";
+import { createController } from "../../common/controller.js";
+import { NextFractionsChainId } from "../../common/index.js";
+const GetPurchasePriceForEpochSchema = _GetPurchasePriceForEpochSchema
+    .extend({ chainId: NextFractionsChainId })
+    .openapi("GetPurchasePriceForEpochSchema");
+export const GetPurchasePriceForEpochV0 = createController({
+    build: (factory) => factory.createApp().post("/", describeRoute({
+        summary: "Get purchase price for epoch",
+        description: "Returns the purchase price (in funding packets per 10^18 fraction token units) recorded for a specific epoch in a Vesting & Redemption Dynamic campaign.",
+        tags: [vrdTag.tag],
+        responses: {
+            200: {
+                description: "Returns the epoch price",
+                content: {
+                    "application/json": {
+                        schema: resolver(z.object({
+                            price: Int256Json.openapi({
+                                description: "Price in funding packets per 10^18 fraction token units",
+                                example: "1000000000000000000",
+                            }),
+                        })),
+                    },
+                },
+            },
+        },
+    }), validator("json", GetPurchasePriceForEpochSchema), async (c) => {
+        const { chainId, campaign, epoch } = c.req.valid("json");
+        const publicClient = getPublicClient(chainId, c.env.config);
+        // account must be the diamond address itself so msg.sender == address(this),
+        // satisfying the OnlyInternalDelegateCall modifier on the facet.
+        const result = await readContract(publicClient, {
+            ...buildGetPurchasePriceForEpochCall({ campaign, epoch }),
+            account: campaign.market,
+        });
+        return c.json({ price: result.toString() });
+    }),
+});

package/dist/next/vestingRedemptionDynamic/getWithdrawalRequestedEvent.d.ts

@@ -0,0 +1,22 @@
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
+export declare const GetWithdrawalRequestedEventV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                    hash: string;
+                };
+            };
+            output: {
+                campaignId: string & z.core.$brand<"Int256">;
+                nftId: string & z.core.$brand<"Int256">;
+                requester: `0x${string}`;
+                amountOfFractions: string & z.core.$brand<"Int256">;
+            };
+            outputFormat: "json";
+            status: import("hono/utils/http-status").ContentfulStatusCode;
+        };
+    };
+}, "/", "/">>;
+//# sourceMappingURL=getWithdrawalRequestedEvent.d.ts.map

package/dist/next/vestingRedemptionDynamic/getWithdrawalRequestedEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWithdrawalRequestedEvent.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/getWithdrawalRequestedEvent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,qCAAqC,CAAC;AAgBxD,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;aA6CxC,CAAC"}

package/dist/next/{fractions/vestingRedemptionDynamic/getWithdrawalRequestedEvent.routes.js → vestingRedemptionDynamic/getWithdrawalRequestedEvent.js}

@@ -1,26 +1,25 @@
 import { describeRoute } from "hono-openapi";
 import { resolver, validator } from "hono-openapi";
 import { waitForTransactionReceipt } from "viem/actions";
-import { z } from "zod";
 import { parseWithdrawalRequestedEvent } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
-import { Int256Json } from "@evergonlabs/tmi-utils/models";
-import { getPublicClient } from "../../../common/blockchain.js";
-import { createController } from "../../../common/controller.js";
-import { HttpError } from "../../../common/http-error.js";
-import { AddressSchema, HashSchema, NextFractionsChainId } from "../../../common/index.js";
-const QuerySchema = z.object({
-    chainId: NextFractionsChainId.openapi({
-        param: { name: "chainId", in: "query" },
-    }),
-    hash: HashSchema.openapi({
-        param: { name: "hash", in: "query" },
-    }),
-});
+import { z } from "@evergonlabs/tmi-protocol-utils/zod";
+import { Int256Json, toInt256Json } from "@evergonlabs/tmi-utils/models";
+import { vrdTag } from "./tag.js";
+import { getPublicClient } from "../../common/blockchain.js";
+import { createController } from "../../common/controller.js";
+import { HttpError } from "../../common/http-error.js";
+import { AddressSchema, HashSchema, NextFractionsChainId } from "../../common/index.js";
+const GetWithdrawalRequestedEventSchema = z
+    .object({
+    chainId: NextFractionsChainId,
+    hash: HashSchema,
+})
+    .openapi("GetWithdrawalRequestedEventSchema");
 export const GetWithdrawalRequestedEventV0 = createController({
-    build: (factory) => factory.createApp().get("/", describeRoute({
+    build: (factory) => factory.createApp().post("/", describeRoute({
         summary: "Get WithdrawalRequested event",
         description: "Gets the transaction by hash and parses the `WithdrawalRequested` event emitted during step 1 of the two-click epoch withdrawal flow.",
-        tags: ["Vesting & Redemption Dynamic"],
+        tags: [vrdTag.tag],
         responses: {
             200: {
                 description: "Returns parsed WithdrawalRequested event data",
@@ -36,8 +35,8 @@ export const GetWithdrawalRequestedEventV0 = createController({
                 },
             },
         },
-    }), validator("query", QuerySchema), async (c) => {
-        const params = c.req.valid("query");
+    }), validator("json", GetWithdrawalRequestedEventSchema), async (c) => {
+        const params = c.req.valid("json");
         const receipt = await waitForTransactionReceipt(getPublicClient(params.chainId, c.env.config), {
             hash: params.hash,
         });
@@ -46,11 +45,11 @@ export const GetWithdrawalRequestedEventV0 = createController({
             throw new UnableParseWithdrawalRequestedEvent();
         }
         return c.json({
-            campaignId: result.campaignId.toString(),
-            nftId: result.nftId.toString(),
+            campaignId: toInt256Json(result.campaignId),
+            nftId: toInt256Json(result.nftId),
             requester: result.requester,
-            amountOfFractions: result.amountOfFractions.toString(),
-        }, 200);
+            amountOfFractions: toInt256Json(result.amountOfFractions),
+        });
     }),
 });
 class UnableParseWithdrawalRequestedEvent extends HttpError {