@evergonlabs/tmi-protocol-api 0.4.0 → 0.5.0

package/dist/staking-templates/templates/rwa/v0/distributeRewards.js

@@ -0,0 +1,41 @@
+import { describeRoute } from "hono-openapi";
+import { resolver, validator } from "hono-openapi/zod";
+import { z } from "@hono/zod-openapi";
+import { distributeRewards } from "@evergonlabs/tmi-protocol-staking-sdk";
+import { toTransaction, TransactionSchema } from "../../../../common/index.js";
+import { PlatformContractAddress, PoolIdSchema } from "../../../../common/models/platform.js";
+import { rwa } from "../common.js";
+import { Int256Positive } from "@evergonlabs/tmi-utils/models";
+export function createDistributeRewardsRoute(factory) {
+    return factory.createHandlers(describeRoute({
+        summary: "Distribute Rewards",
+        description: "Generates a transaction for Rewards allocation for certain Pool.",
+        tags: [rwa.tag.tag],
+        responses: {
+            200: {
+                description: "Compiled Reward notification transaction details",
+                content: {
+                    "application/json": {
+                        schema: resolver(TransactionSchema),
+                    },
+                },
+            },
+        },
+    }), validator("json", z.object({
+        platform: PlatformContractAddress,
+        poolId: PoolIdSchema,
+        amount: Int256Positive.openapi({
+            description: "Number of Reward Packets to distribute to pool stakers.",
+        }),
+    })), async (c) => {
+        const { platform, poolId, amount } = c.req.valid("json");
+        const transaction = distributeRewards(rwa.template, {
+            platform: platform,
+            data: {
+                poolId: poolId,
+                packets: amount,
+            },
+        });
+        return c.json(toTransaction(transaction), 200);
+    });
+}

package/dist/staking-templates/templates/rwa/v0/index.d.ts

@@ -50,16 +50,16 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     stakeId: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -73,17 +73,17 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     stakeId: string | number | bigint;
                     amount: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -97,17 +97,17 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     poolId: string | number | bigint;
                     amount: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -121,17 +121,17 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     poolId: string | number | bigint;
                     amount: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -145,16 +145,16 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     stakeId: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -168,8 +168,8 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     startDate: string;
+                    platform: `0x${string}`;
                     hardcapAmount: string | number | bigint;
                     distribution: {
                         duration: string | number | bigint;
@@ -189,8 +189,8 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -218,8 +218,8 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };
@@ -229,21 +229,21 @@ export declare function createRWATemplateV0App<E extends Env>(factory: Factory<E
         };
     };
 } & {
-    "/notifyRewards": {
+    "/distributeRewards": {
         $post: {
             input: {
                 json: {
-                    platform: `0x${string}`;
                     poolId: string | number | bigint;
                     amount: string | number | bigint;
+                    platform: `0x${string}`;
                 };
             };
             output: {
                 data: `0x${string}`;
                 to: `0x${string}`;
                 details: {
-                    functionName: string;
                     address: `0x${string}`;
+                    functionName: string;
                     abi: any[];
                     args: any[];
                 };

package/dist/staking-templates/templates/rwa/v0/index.js

@@ -9,7 +9,7 @@ import { createUnstakeRoute } from "../../common/unstake.js";
 import { createGetCreatePoolEventRoute } from "../../common/getCreatePoolEvent.js";
 import { createCreatePoolRoute } from "./createPool.js";
 import { createCreatePlatformRoute } from "./createPlatform.js";
-import { createNotifyRewardsRoute } from "./notifyRewards.js";
+import { createDistributeRewardsRoute } from "./distributeRewards.js";
 export function createRWATemplateV0App(factory) {
     return factory
         .createApp()
@@ -23,5 +23,5 @@ export function createRWATemplateV0App(factory) {
         .post("/unstake", ...createUnstakeRoute(factory, rwa))
         .post("/createPool", ...createCreatePoolRoute(factory))
         .post("/createPlatform", ...createCreatePlatformRoute(factory))
-        .post("/notifyRewards", ...createNotifyRewardsRoute(factory));
+        .post("/distributeRewards", ...createDistributeRewardsRoute(factory));
 }

package/dist/staking-templates/templates/rwa/v0/restake.d.ts

@@ -4,56 +4,56 @@ export declare function createRestakeRoute<E extends Env>(factory: Factory<E>):
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };
 }, 200, "json">>>, import("hono/types").H<Env, string, {
     in: {
         json: {
-            platform: `0x${string}`;
             poolId: string | number | bigint;
             amount: string | number | bigint;
+            platform: `0x${string}`;
         };
     };
     out: {
         json: {
-            platform: `0x${string}`;
             poolId: bigint;
             amount: bigint;
+            platform: `0x${string}`;
         };
     };
 }, Promise<Response & import("hono").TypedResponse<{
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };
 }, 200, "json">>>, import("hono/types").H<import("hono/utils/types").IfAnyThenEmptyObject<E extends Env ? Env extends E ? {} : E : E> & {}, string, {
     in: {
         json: {
-            platform: `0x${string}`;
             poolId: string | number | bigint;
             amount: string | number | bigint;
+            platform: `0x${string}`;
         };
     };
     out: {
         json: {
-            platform: `0x${string}`;
             poolId: bigint;
             amount: bigint;
+            platform: `0x${string}`;
         };
     };
 }, Promise<Response & import("hono").TypedResponse<{
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };

package/dist/staking-templates/templates/rwa/v0/stake.d.ts

@@ -4,56 +4,56 @@ export declare function createStakeRoute<E extends Env>(factory: Factory<E>): [i
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };
 }, 200, "json">>>, import("hono/types").H<Env, string, {
     in: {
         json: {
-            platform: `0x${string}`;
             poolId: string | number | bigint;
             amount: string | number | bigint;
+            platform: `0x${string}`;
         };
     };
     out: {
         json: {
-            platform: `0x${string}`;
             poolId: bigint;
             amount: bigint;
+            platform: `0x${string}`;
         };
     };
 }, Promise<Response & import("hono").TypedResponse<{
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };
 }, 200, "json">>>, import("hono/types").H<import("hono/utils/types").IfAnyThenEmptyObject<E extends Env ? Env extends E ? {} : E : E> & {}, string, {
     in: {
         json: {
-            platform: `0x${string}`;
             poolId: string | number | bigint;
             amount: string | number | bigint;
+            platform: `0x${string}`;
         };
     };
     out: {
         json: {
-            platform: `0x${string}`;
             poolId: bigint;
             amount: bigint;
+            platform: `0x${string}`;
         };
     };
 }, Promise<Response & import("hono").TypedResponse<{
     data: `0x${string}`;
     to: `0x${string}`;
     details: {
-        functionName: string;
         address: `0x${string}`;
+        functionName: string;
         abi: any[];
         args: any[];
     };

package/dist/v0/fractions/index.d.ts

@@ -0,0 +1,68 @@
+import { Factory } from "hono/factory";
+import type { AppContext } from "../../common/context.js";
+export declare function createNetworkStatisticsApp(factory: Factory<AppContext>): import("hono/hono-base").HonoBase<AppContext, {
+    "/holders": {
+        $post: {
+            input: {
+                json: {
+                    chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+                };
+            };
+            output: {
+                [x: string]: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/sales": {
+        $post: {
+            input: {
+                json: {
+                    chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+                };
+            };
+            output: {
+                [x: string]: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/ttv": {
+        $post: {
+            input: {
+                json: {
+                    chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+                };
+            };
+            output: {
+                [x: string]: string;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/": {
+        $post: {
+            input: {
+                json: {
+                    chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+                };
+            };
+            output: {
+                [x: string]: {
+                    holders: number;
+                    sales: number;
+                    ttv: string;
+                };
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+}, "/">;
+//# sourceMappingURL=index.d.ts.map

package/dist/v0/fractions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v0/fractions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAQ1D,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAOtE"}

package/dist/v0/fractions/index.js

@@ -0,0 +1,9 @@
+import { createFractionHoldersCountV0, createSuccessfulSalesCountV0, createTtvV0, createNetworkStatisticsV0, } from "./networkStatistics.route.js";
+export function createNetworkStatisticsApp(factory) {
+    return factory
+        .createApp()
+        .post("/holders", ...createFractionHoldersCountV0(factory))
+        .post("/sales", ...createSuccessfulSalesCountV0(factory))
+        .post("/ttv", ...createTtvV0(factory))
+        .post("/", ...createNetworkStatisticsV0(factory));
+}

package/dist/v0/fractions/networkStatistics.route.d.ts

@@ -0,0 +1,176 @@
+import { Factory } from "hono/factory";
+import { z } from "../../common/zod.js";
+import { AppContext } from "../../common/context.js";
+/**
+ * Response schema for fraction holders count endpoint
+ * Keys can be 'total' or chain IDs (as strings), values are holder counts
+ */
+export declare const FractionHoldersCountSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"total">, z.ZodString]>, z.ZodNumber>;
+/**
+ * Response schema for successful sales count endpoint
+ * Keys can be 'total' or chain IDs (as strings), values are sales counts
+ */
+export declare const SuccessfulSalesCountSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"total">, z.ZodString]>, z.ZodNumber>;
+/**
+ * Response schema for TTV endpoint
+ * Keys can be 'total' or chain IDs (as strings), values are TTV amounts as strings (bigdecimal representation)
+ */
+export declare const TtvSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"total">, z.ZodString]>, z.ZodString>;
+/**
+ * Combined network statistics response schema
+ * Keys can be 'total' or chain IDs (as strings), values are statistics objects
+ */
+export declare const NetworkStatisticsSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"total">, z.ZodString]>, z.ZodObject<{
+    holders: z.ZodNumber;
+    sales: z.ZodNumber;
+    ttv: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    holders: number;
+    sales: number;
+    ttv: string;
+}, {
+    holders: number;
+    sales: number;
+    ttv: string;
+}>>;
+/**
+ * Get the number of unique fraction holders from successful (finalized) sales
+ */
+export declare function createFractionHoldersCountV0(factory: Factory<AppContext>): [import("hono/types").H<any, string, {}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>, import("hono/types").H<import("hono").Env, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>, import("hono/types").H<AppContext, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>];
+/**
+ * Get the number of successful (finalized) fraction sales
+ */
+export declare function createSuccessfulSalesCountV0(factory: Factory<AppContext>): [import("hono/types").H<any, string, {}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>, import("hono/types").H<import("hono").Env, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>, import("hono/types").H<AppContext, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: number;
+}, 200, "json">>>];
+/**
+ * Get the Total Tokenized Value (TTV) - sum of all amounts raised by successful sales in USDC
+ */
+export declare function createTtvV0(factory: Factory<AppContext>): [import("hono/types").H<any, string, {}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: string;
+}, 200, "json">>>, import("hono/types").H<import("hono").Env, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: string;
+}, 200, "json">>>, import("hono/types").H<AppContext, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: string;
+}, 200, "json">>>];
+/**
+ * Get all network statistics in a single call
+ */
+export declare function createNetworkStatisticsV0(factory: Factory<AppContext>): [import("hono/types").H<any, string, {}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: {
+        holders: number;
+        sales: number;
+        ttv: string;
+    };
+}, 200, "json">>>, import("hono/types").H<import("hono").Env, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: {
+        holders: number;
+        sales: number;
+        ttv: string;
+    };
+}, 200, "json">>>, import("hono/types").H<AppContext, string, {
+    in: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+    out: {
+        json: {
+            chainId?: import("@evergonlabs/tmi-protocol-fractions-sdk").TmiChainId | undefined;
+        };
+    };
+}, Promise<Response & import("hono").TypedResponse<{
+    [x: string]: {
+        holders: number;
+        sales: number;
+        ttv: string;
+    };
+}, 200, "json">>>];
+//# sourceMappingURL=networkStatistics.route.d.ts.map

package/dist/v0/fractions/networkStatistics.route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"networkStatistics.route.d.ts","sourceRoot":"","sources":["../../../src/v0/fractions/networkStatistics.route.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAIvC,OAAO,EAAE,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAUrD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4EAIrC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,0BAA0B,4EAIrC,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,SAAS,4EAIpB,CAAC;AAiBH;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;GAMhC,CAAC;AAuJL;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA8CxE;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA8CxE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA8CvD;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAiErE"}