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

package/dist/next/{fractions/vestingRedemptionDynamic → vestingRedemptionDynamic}/index.d.ts

@@ -1,9 +1,9 @@
-export declare const VestingRedemptionDynamicController: import("../../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../../common/context.js").AppContext, import("hono/types").BlankSchema | import("hono/types").MergeSchemaPath<{
+export declare const VestingRedemptionDynamicApi: import("../../common/controller.js").IApi<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, import("hono/types").BlankSchema | import("hono/types").MergeSchemaPath<{
     "/": {
         $post: {
             input: {
                 json: {
-                    chainId: unknown;
+                    chainId: "31337" | "11155111" | "84532" | "72080";
                     adminAddress: string;
                     acceptedFundingTokens: string[];
                     ownerAddress?: string | undefined;
@@ -40,7 +40,7 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    chainId: unknown;
+                    chainId: "31337" | "11155111" | "84532" | "72080";
                     market: string;
                     nft: {
                         contractAddress: string;
@@ -90,8 +90,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                 };
             };
             output: {
@@ -113,8 +115,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                     price: string;
                 };
             };
@@ -134,37 +138,41 @@ export declare const VestingRedemptionDynamicController: import("../../../common
     };
 }, "/setEpochPrice"> | import("hono/types").MergeSchemaPath<{
     "/": {
-        $get: {
+        $post: {
             input: {
-                query: {
-                    chainId: string | string[];
-                    market: string | string[];
-                    campaignId: string | string[];
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    chainId: "31337" | "11155111" | "84532" | "72080";
                 };
             };
             output: {
                 currentEpoch: string;
             };
             outputFormat: "json";
-            status: 200;
+            status: import("hono/utils/http-status").ContentfulStatusCode;
         };
     };
 }, "/getCurrentEpoch"> | import("hono/types").MergeSchemaPath<{
     "/": {
-        $get: {
+        $post: {
             input: {
-                query: {
-                    chainId: string | string[];
-                    market: string | string[];
-                    campaignId: string | string[];
-                    epoch: string | string[];
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    epoch: string;
+                    chainId: "31337" | "11155111" | "84532" | "72080";
                 };
             };
             output: {
                 price: string;
             };
             outputFormat: "json";
-            status: 200;
+            status: import("hono/utils/http-status").ContentfulStatusCode;
         };
     };
 }, "/getPurchasePriceForEpoch"> | import("hono/types").MergeSchemaPath<{
@@ -172,8 +180,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                     amountToProvide: string;
                 };
             };
@@ -193,23 +203,23 @@ export declare const VestingRedemptionDynamicController: import("../../../common
     };
 }, "/purchase"> | import("hono/types").MergeSchemaPath<{
     "/": {
-        $get: {
+        $post: {
             input: {
-                query: {
-                    chainId: string | string[];
-                    hash: string | string[];
+                json: {
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                    hash: string;
                 };
             };
             output: {
-                campaignId: string;
-                nftId: string;
+                campaignId: string & import("zod").$brand<"Int256">;
+                nftId: string & import("zod").$brand<"Int256">;
                 purchaser: `0x${string}`;
-                amountProvided: string;
-                amountAfterFees: string;
-                epochPurchased: string;
+                amountProvided: string & import("zod").$brand<"Int256">;
+                amountAfterFees: string & import("zod").$brand<"Int256">;
+                epochPurchased: string & import("zod").$brand<"Int256">;
             };
             outputFormat: "json";
-            status: 200;
+            status: import("hono/utils/http-status").ContentfulStatusCode;
         };
     };
 }, "/getEpochPurchaseEvent"> | import("hono/types").MergeSchemaPath<{
@@ -217,8 +227,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                     nftId: string;
                 };
             };
@@ -241,8 +253,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                     amountOfFractions: string;
                 };
             };
@@ -262,21 +276,21 @@ export declare const VestingRedemptionDynamicController: import("../../../common
     };
 }, "/requestWithdrawal"> | import("hono/types").MergeSchemaPath<{
     "/": {
-        $get: {
+        $post: {
             input: {
-                query: {
-                    chainId: string | string[];
-                    hash: string | string[];
+                json: {
+                    chainId: "31337" | "11155111" | "84532" | "72080";
+                    hash: string;
                 };
             };
             output: {
-                campaignId: string;
-                nftId: string;
+                campaignId: string & import("zod").$brand<"Int256">;
+                nftId: string & import("zod").$brand<"Int256">;
                 requester: `0x${string}`;
-                amountOfFractions: string;
+                amountOfFractions: string & import("zod").$brand<"Int256">;
             };
             outputFormat: "json";
-            status: 200;
+            status: import("hono/utils/http-status").ContentfulStatusCode;
         };
     };
 }, "/getWithdrawalRequestedEvent"> | import("hono/types").MergeSchemaPath<{
@@ -284,8 +298,10 @@ export declare const VestingRedemptionDynamicController: import("../../../common
         $post: {
             input: {
                 json: {
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
                     nftId: string;
                 };
             };

package/dist/next/{fractions/vestingRedemptionDynamic → vestingRedemptionDynamic}/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/next/fractions/vestingRedemptionDynamic/index.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAgB7C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/index.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkBtC,CAAC"}

package/dist/next/{fractions/vestingRedemptionDynamic → vestingRedemptionDynamic}/index.js

@@ -1,15 +1,19 @@
-import { createController } from "../../../common/controller.js";
-import { ApproveCampaignV0 } from "./approveCampaign.routes.js";
-import { CreateVestingRedemptionDynamicCampaignV0 } from "./createCampaign.routes.js";
-import { DeployVestingRedemptionDynamicMarketV0 } from "./deployMarket.routes.js";
-import { EpochPurchaseV0, ExchangeNftForFractionsV0 } from "./epochPurchase.routes.js";
-import { RequestWithdrawalV0, WithdrawFundsV0 } from "./epochWithdrawal.routes.js";
-import { GetCurrentEpochV0 } from "./getCurrentEpoch.routes.js";
-import { GetEpochPurchaseEventV0 } from "./getEpochPurchaseEvent.routes.js";
-import { GetPurchasePriceForEpochV0 } from "./getPurchasePriceForEpoch.routes.js";
-import { GetWithdrawalRequestedEventV0 } from "./getWithdrawalRequestedEvent.routes.js";
-import { SetEpochPriceV0 } from "./setEpochPrice.routes.js";
-export const VestingRedemptionDynamicController = createController({
+import { ApproveCampaignV0 } from "./approveCampaign.js";
+import { CreateVestingRedemptionDynamicCampaignV0 } from "./createCampaign.js";
+import { DeployVestingRedemptionDynamicMarketV0 } from "./deployMarket.js";
+import { EpochPurchaseV0 } from "./epochPurchase.js";
+import { ExchangeNftForFractionsV0 } from "./exchangeNftForFractions.js";
+import { GetCurrentEpochV0 } from "./getCurrentEpoch.js";
+import { GetEpochPurchaseEventV0 } from "./getEpochPurchaseEvent.js";
+import { GetPurchasePriceForEpochV0 } from "./getPurchasePriceForEpoch.js";
+import { GetWithdrawalRequestedEventV0 } from "./getWithdrawalRequestedEvent.js";
+import { RequestWithdrawalV0 } from "./requestWithdrawal.js";
+import { SetEpochPriceV0 } from "./setEpochPrice.js";
+import { WithdrawFundsV0 } from "./withdrawFunds.js";
+import { createApi } from "../../common/controller.js";
+export const VestingRedemptionDynamicApi = createApi({
+    title: "Vesting & Redemption Dynamic API",
+    description: "Epoch-based campaigns with two-click purchase/withdrawal flows and dynamic pricing",
     build: (factory) => factory
         .createApp()
         .route("/deployMarket", DeployVestingRedemptionDynamicMarketV0.build(factory))

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

@@ -0,0 +1,28 @@
+export declare const RequestWithdrawalV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    amountOfFractions: 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=requestWithdrawal.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requestWithdrawal.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/requestWithdrawal.ts"],"names":[],"mappings":"AA4BA,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;aAc9B,CAAC"}

package/dist/next/vestingRedemptionDynamic/requestWithdrawal.js

@@ -0,0 +1,33 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi";
+import { buildRequestWithdrawalTx } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { RequestWithdrawalConfigSchema } from "./schemas.js";
+import { vrdTag } from "./tag.js";
+import { createController } from "../../common/controller.js";
+import { toTransaction, TransactionSchema } from "../../common/index.js";
+const requestWithdrawalRoute = describeRoute({
+    summary: "Withdrawal step 1 — burn fractions and receive withdrawal receipt NFT",
+    description: "Returns transaction data for the first step of the two-click epoch withdrawal flow. " +
+        "The investor burns their ERC-20 fractions and receives a withdrawal receipt NFT. " +
+        "The investor can then redeem the receipt NFT for funds in the next or any later epoch.",
+    tags: [vrdTag.tag],
+    responses: {
+        200: {
+            description: "Returns transaction data for requesting a withdrawal",
+            content: {
+                "application/json": {
+                    schema: resolver(TransactionSchema),
+                },
+            },
+        },
+    },
+});
+export const RequestWithdrawalV0 = createController({
+    build: (factory) => factory
+        .createApp()
+        .post("/", requestWithdrawalRoute, validator("json", RequestWithdrawalConfigSchema.openapi("RequestWithdrawalRequestSchema")), async (c) => {
+        const config = c.req.valid("json");
+        const tx = buildRequestWithdrawalTx(config);
+        return c.json(toTransaction(tx));
+    }),
+});

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

@@ -0,0 +1,2 @@
+export { ApproveCampaignConfigSchema, CreateVestingRedemptionDynamicFractionsConfigSchema, DeployVestingRedemptionDynamicMarketRequestSchema, EpochPurchaseConfigSchema, ExchangeNftForFractionsConfigSchema, GetCurrentEpochSchema, RequestWithdrawalConfigSchema, SetEpochPriceConfigSchema, WithdrawFundsConfigSchema, } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+//# sourceMappingURL=schemas.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/next/vestingRedemptionDynamic/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,mDAAmD,EACnD,iDAAiD,EACjD,yBAAyB,EACzB,mCAAmC,EACnC,qBAAqB,EACrB,6BAA6B,EAC7B,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,8CAA8C,CAAC"}

package/dist/next/vestingRedemptionDynamic/schemas.js

@@ -0,0 +1 @@
+export { ApproveCampaignConfigSchema, CreateVestingRedemptionDynamicFractionsConfigSchema, DeployVestingRedemptionDynamicMarketRequestSchema, EpochPurchaseConfigSchema, ExchangeNftForFractionsConfigSchema, GetCurrentEpochSchema, RequestWithdrawalConfigSchema, SetEpochPriceConfigSchema, WithdrawFundsConfigSchema, } from "@evergonlabs/tmi-protocol-fractions-sdk/next";

package/dist/next/{fractions/lending/buyback/buyback.routes.d.ts → vestingRedemptionDynamic/setEpochPrice.d.ts}

@@ -1,12 +1,13 @@
-export declare const BuybackV0: import("../../../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../../../common/context.js").AppContext, {
+export declare const SetEpochPriceV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
     "/": {
         $post: {
             input: {
                 json: {
-                    chainId: unknown;
-                    buybackPacketsAmount: string;
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    price: string;
                 };
             };
             output: {
@@ -24,4 +25,4 @@ export declare const BuybackV0: import("../../../../common/controller.js").ICont
         };
     };
 }, "/", "/">>;
-//# sourceMappingURL=buyback.routes.d.ts.map
+//# sourceMappingURL=setEpochPrice.d.ts.map

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

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

package/dist/next/vestingRedemptionDynamic/setEpochPrice.js

@@ -0,0 +1,34 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi";
+import { buildSetEpochPriceTx } from "@evergonlabs/tmi-protocol-fractions-sdk/next";
+import { SetEpochPriceConfigSchema } from "./schemas.js";
+import { vrdTag } from "./tag.js";
+import { createController } from "../../common/controller.js";
+import { toTransaction, TransactionSchema } from "../../common/index.js";
+const route = describeRoute({
+    summary: "Set epoch price for a Vesting & Redemption Dynamic campaign",
+    description: "Returns transaction data for the designated priceSetter to set the price for the next epoch. " +
+        "Calling this advances the epoch counter; investors who purchased in epoch N can exchange " +
+        "their receipt NFTs for fractions starting from epoch N+1. " +
+        "Only the campaign's designated priceSetter may call this function.",
+    tags: [vrdTag.tag],
+    responses: {
+        200: {
+            description: "Returns transaction data for setting the epoch price",
+            content: {
+                "application/json": {
+                    schema: resolver(TransactionSchema),
+                },
+            },
+        },
+    },
+});
+export const SetEpochPriceV0 = createController({
+    build: (factory) => factory
+        .createApp()
+        .post("/", route, validator("json", SetEpochPriceConfigSchema.openapi("SetEpochPriceRequestSchema")), async (c) => {
+        const config = c.req.valid("json");
+        const tx = buildSetEpochPriceTx(config);
+        return c.json(toTransaction(tx));
+    }),
+});

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

@@ -0,0 +1,4 @@
+export declare const vrdTag: {
+    tag: "Vesting & Redemption Dynamic";
+};
+//# sourceMappingURL=tag.d.ts.map

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

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

package/dist/next/vestingRedemptionDynamic/tag.js

@@ -0,0 +1,2 @@
+import { createTag } from "../../common/tag.js";
+export const vrdTag = createTag("Vesting & Redemption Dynamic");

package/dist/next/{fractions/lending/setCollateralPrice/setCollateralPrice.routes.d.ts → vestingRedemptionDynamic/withdrawFunds.d.ts}

@@ -1,11 +1,13 @@
-export declare const SetCollateralPriceV0: import("../../../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../../../common/context.js").AppContext, {
+export declare const WithdrawFundsV0: import("../../common/controller.js").IController<import("hono/hono-base").HonoBase<import("../../common/context.js").AppContext, {
     "/": {
         $post: {
             input: {
                 json: {
-                    collateralPriceInFundingPackets: string;
-                    market: string;
-                    campaignId: string;
+                    campaign: {
+                        market: string;
+                        campaignId: string;
+                    };
+                    nftId: string;
                 };
             };
             output: {
@@ -23,4 +25,4 @@ export declare const SetCollateralPriceV0: import("../../../../common/controller
         };
     };
 }, "/", "/">>;
-//# sourceMappingURL=setCollateralPrice.routes.d.ts.map
+//# sourceMappingURL=withdrawFunds.d.ts.map

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

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

package/dist/next/vestingRedemptionDynamic/withdrawFunds.js

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

package/dist/schemas.d.ts

@@ -0,0 +1,3 @@
+export * from "./fractions/schemas.js";
+export * from "./issuance/schemas.js";
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC"}

package/dist/schemas.js

@@ -0,0 +1,2 @@
+export * from "./fractions/schemas.js";
+export * from "./issuance/schemas.js";