@kontor/kontor-sdk 1.0.0-alpha.24 → 1.0.0-alpha.27

package/src/wit/wit-parser/parse-wit.test.ts

@@ -2,195 +2,475 @@ import { expectTypeOf, describe, expect, test } from "vitest";
 
 import type { ParseWit } from "./parse-wit.js";
 import { parseWit } from "./parse-wit.js";
-// import type { nativeToken } from "../../sdk/contracts/wits.js";
-//
-//
-//
-// type t =  ParseWit<typeof nativeToken.raw>;
-//
+import { nativeToken } from "../../sdk/contracts/wits.js";
 
-test("ParseWit (types)", () => {
-  // type-level assertions
+expectTypeOf<ParseWit<typeof nativeToken.raw>>().toEqualTypeOf<
+  readonly [
+    {
+      readonly name: "mint";
+      readonly type: "function";
+      readonly context: "proc";
+      readonly inputs: readonly [
+        {
+          readonly name: "amt";
+          readonly type: "decimal";
+          readonly internalType: "decimal";
+        },
+      ];
+      readonly outputs: readonly [
+        {
+          readonly type: "result<tuple, error>";
+          readonly internalType: "result<mint, error>";
 
-  expectTypeOf<
-    ParseWit<
-      [
-        "record contract-address {  name: string, height: s64, tx-index: s64 }",
-        "export fib: func(ctx: borrow<proc-context>, arith-address: contract-address, n: u64) -> u64;",
-        // "export fib-of-sub: func(ctx: borrow<proc-context>, arith-address: contract-address, x: string, y: string) -> result<u64, error>;",
-        // "export cached-values: func(ctx: borrow<view-context>) -> list<u64>;",
-      ]
-    >
-  >().toEqualTypeOf<
-    readonly [
+          readonly components: readonly [
+            {
+              readonly name: "dst";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+    {
+      readonly name: "burn";
+      readonly type: "function";
+      readonly context: "proc";
+      readonly inputs: readonly [
+        {
+          readonly name: "amt";
+          readonly type: "decimal";
+          readonly internalType: "decimal";
+        },
+      ];
+      readonly outputs: readonly [
+        {
+          readonly type: "result<tuple, error>";
+          readonly internalType: "result<burn, error>";
+
+          readonly components: readonly [
+            {
+              readonly name: "src";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+    {
+      readonly name: "transfer";
+      readonly type: "function";
+      readonly context: "proc";
+      readonly inputs: readonly [
+        {
+          readonly name: "dst";
+          readonly type: "string";
+          readonly internalType: "string";
+        },
+        {
+          readonly name: "amt";
+          readonly type: "decimal";
+          readonly internalType: "decimal";
+        },
+      ];
+      readonly outputs: readonly [
+        {
+          readonly type: "result<tuple, error>";
+          readonly internalType: "result<transfer, error>";
+
+          readonly components: readonly [
+            {
+              readonly name: "src";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "dst";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+    {
+      readonly name: "balance";
+      readonly type: "function";
+      readonly context: "view";
+      readonly inputs: readonly [
+        {
+          readonly name: "acc";
+          readonly type: "string";
+          readonly internalType: "string";
+        },
+      ];
+      readonly outputs: readonly [
+        {
+          readonly type: "option<decimal>";
+          readonly internalType: "option<decimal>";
+        },
+      ];
+    },
+
+    {
+      readonly name: "balances";
+      readonly type: "function";
+      readonly context: "view";
+      readonly inputs: readonly [];
+      readonly outputs: readonly [
+        {
+          readonly type: "list<tuple>";
+          readonly internalType: "list<balance>";
+          readonly components: readonly [
+            {
+              readonly name: "acc";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+
+    {
+      readonly name: "total-supply";
+      readonly type: "function";
+      readonly context: "view";
+      readonly inputs: readonly [];
+      readonly outputs: readonly [
+        {
+          readonly type: "decimal";
+          readonly internalType: "decimal";
+        },
+      ];
+    },
+    {
+      readonly name: "attach";
+      readonly type: "function";
+      readonly context: "proc";
+      readonly inputs: readonly [
+        {
+          readonly name: "vout";
+          readonly type: "u64";
+          readonly internalType: "u64";
+        },
+        {
+          readonly name: "amt";
+          readonly type: "decimal";
+          readonly internalType: "decimal";
+        },
+      ];
+      readonly outputs: readonly [
+        {
+          readonly type: "result<tuple, error>";
+          readonly internalType: "result<transfer, error>";
+          readonly components: readonly [
+            {
+              readonly name: "src";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "dst";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+    {
+      readonly name: "detach";
+      readonly type: "function";
+      readonly context: "proc";
+      readonly inputs: readonly [];
+      readonly outputs: readonly [
+        {
+          readonly type: "result<tuple, error>";
+          readonly internalType: "result<transfer, error>";
+          readonly components: readonly [
+            {
+              readonly name: "src";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "dst";
+              readonly type: "string";
+              readonly internalType: "string";
+            },
+            {
+              readonly name: "amt";
+              readonly type: "decimal";
+              readonly internalType: "decimal";
+            },
+          ];
+        },
+      ];
+    },
+  ]
+>();
+
+describe("parseWit (runtime)", () => {
+  test("parses nativeToken WIT into the expected ABI shape", () => {
+    const out = parseWit(nativeToken.raw);
+
+    expect(out).toEqual([
       {
-        readonly name: "fib";
-        readonly type: "function";
-        readonly context: "proc";
-        readonly inputs: readonly [
+        name: "init",
+        type: "function",
+        context: "proc",
+        inputs: [],
+        outputs: [],
+      },
+      {
+        name: "mint",
+        type: "function",
+        context: "proc",
+        inputs: [
           {
-            readonly name: "arith-address";
-            readonly type: "tuple";
-            readonly internalType: "contract-address";
-            readonly components: readonly [
-              {
-                readonly name: "name";
-                readonly type: "string";
-                readonly internalType: "string";
-              },
+            name: "amt",
+            type: "decimal",
+            internalType: "decimal",
+          },
+        ],
+        outputs: [
+          {
+            type: "result<tuple, error>",
+            internalType: "result<mint, error>",
+            components: [
               {
-                readonly name: "height";
-                readonly type: "s64";
-                readonly internalType: "s64";
+                name: "dst",
+                type: "string",
+                internalType: "string",
               },
               {
-                readonly name: "tx-index";
-                readonly type: "s64";
-                readonly internalType: "s64";
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
               },
-            ];
-          },
-          {
-            readonly name: "n";
-            readonly type: "u64";
-            readonly internalType: "u64";
+            ],
           },
-        ];
-        readonly outputs: readonly [
-          { readonly type: "u64"; readonly internalType: "u64" },
-        ];
+        ],
       },
-      // {
-      //   readonly name: "fib-of-sub";
-      //   readonly type: "function";
-      //   readonly context: "proc";
-      //   readonly inputs: readonly [
-      //     {
-      //       readonly name: "arith-address";
-      //       readonly type: "tuple";
-      //       readonly internalType: "contract-address";
-      //
-      //       readonly components: readonly [
-      //         {
-      //           readonly name: "name";
-      //           readonly type: "string";
-      //           readonly internalType: "string";
-      //         },
-      //         {
-      //           readonly name: "height";
-      //           readonly type: "s64";
-      //           readonly internalType: "s64";
-      //         },
-      //         {
-      //           readonly name: "tx-index";
-      //           readonly type: "s64";
-      //           readonly internalType: "s64";
-      //         },
-      //       ];
-      //     },
-      //     {
-      //       readonly name: "x";
-      //       readonly type: "string";
-      //       readonly internalType: "string";
-      //     },
-      //     {
-      //       readonly name: "y";
-      //       readonly type: "string";
-      //       readonly internalType: "string";
-      //     },
-      //   ];
-      //   readonly outputs: readonly [
-      //     {
-      //       readonly type: "result<u64, error>";
-      //       readonly internalType: "result<u64, error>";
-      //     },
-      //   ];
-      // },
-      // {
-      //   readonly name: "cached-values";
-      //   readonly type: "function";
-      //   readonly context: "view";
-      //   readonly inputs: readonly [];
-      //   readonly outputs: readonly [
-      //     { readonly type: "list<u64>"; readonly internalType: "list<u64>" },
-      //   ];
-      // },
-    ]
-  >();
-});
-
-describe("parseWit (runtime)", () => {
-  test("parses proc + view functions and strips ctx from inputs", () => {
-    const input = [
-      // TODO: build in record defs should be defined under the hood
-      "record contract-address {  name: string, height: s64, tx-index: s64 }",
-      "export fib: func(ctx: borrow<proc-context>, arith-address: contract-address, n: u64) -> u64;",
-      "export fib-of-sub: func(ctx: borrow<proc-context>, arith-address: contract-address, x: string, y: string) -> result<u64, error>;",
-      "export cached-values: func(ctx: borrow<view-context>) -> list<u64>;",
-      "export return-option: func(ctx: borrow<view-context>) -> option<u64>;",
-    ] as const;
-
-    const out = parseWit(input);
-
-    expect(out).toEqual([
       {
-        name: "fib",
+        name: "burn",
         type: "function",
         context: "proc",
         inputs: [
           {
-            name: "arith-address",
-            type: "tuple",
-            internalType: "contract-address",
+            name: "amt",
+            type: "decimal",
+            internalType: "decimal",
+          },
+        ],
+        outputs: [
+          {
+            type: "result<tuple, error>",
+            internalType: "result<burn, error>",
             components: [
-              { name: "name", type: "string", internalType: "string" },
-              { name: "height", type: "s64", internalType: "s64" },
-              { name: "tx-index", type: "s64", internalType: "s64" },
+              {
+                name: "src",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
+              },
             ],
           },
-          { name: "n", type: "u64", internalType: "u64" },
         ],
-        outputs: [{ type: "u64", internalType: "u64" }],
       },
       {
-        name: "fib-of-sub",
+        name: "transfer",
         type: "function",
         context: "proc",
         inputs: [
           {
-            name: "arith-address",
-            type: "tuple",
-            internalType: "contract-address",
-
+            name: "dst",
+            type: "string",
+            internalType: "string",
+          },
+          {
+            name: "amt",
+            type: "decimal",
+            internalType: "decimal",
+          },
+        ],
+        outputs: [
+          {
+            type: "result<tuple, error>",
+            internalType: "result<transfer, error>",
             components: [
-              { name: "name", type: "string", internalType: "string" },
-              { name: "height", type: "s64", internalType: "s64" },
-              { name: "tx-index", type: "s64", internalType: "s64" },
+              {
+                name: "src",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "dst",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
+              },
             ],
           },
-          { name: "x", type: "string", internalType: "string" },
-          { name: "y", type: "string", internalType: "string" },
+        ],
+      },
+      {
+        name: "balance",
+        type: "function",
+        context: "view",
+        inputs: [
+          {
+            name: "acc",
+            type: "string",
+            internalType: "string",
+          },
         ],
         outputs: [
           {
-            type: "result<u64, error>",
-            internalType: "result<u64, error>",
+            type: "option<decimal>",
+            internalType: "option<decimal>",
           },
         ],
       },
       {
-        name: "cached-values",
+        name: "balances",
         type: "function",
         context: "view",
         inputs: [],
-        outputs: [{ type: "list<u64>", internalType: "list<u64>" }],
+        outputs: [
+          {
+            type: "list<tuple>",
+            internalType: "list<balance>",
+            components: [
+              {
+                name: "acc",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
+              },
+            ],
+          },
+        ],
       },
       {
-        name: "return-option",
+        name: "total-supply",
         type: "function",
         context: "view",
         inputs: [],
-        outputs: [{ type: "option<u64>", internalType: "option<u64>" }],
+        outputs: [
+          {
+            type: "decimal",
+            internalType: "decimal",
+          },
+        ],
+      },
+      {
+        name: "attach",
+        type: "function",
+        context: "proc",
+        inputs: [
+          {
+            name: "vout",
+            type: "u64",
+            internalType: "u64",
+          },
+          {
+            name: "amt",
+            type: "decimal",
+            internalType: "decimal",
+          },
+        ],
+        outputs: [
+          {
+            type: "result<tuple, error>",
+            internalType: "result<transfer, error>",
+            components: [
+              {
+                name: "src",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "dst",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
+              },
+            ],
+          },
+        ],
+      },
+      {
+        name: "detach",
+        type: "function",
+        context: "proc",
+        inputs: [],
+        outputs: [
+          {
+            type: "result<tuple, error>",
+            internalType: "result<transfer, error>",
+            components: [
+              {
+                name: "src",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "dst",
+                type: "string",
+                internalType: "string",
+              },
+              {
+                name: "amt",
+                type: "decimal",
+                internalType: "decimal",
+              },
+            ],
+          },
+        ],
       },
     ]);
   });

package/src/wit/wit-parser/parse-wit.ts

@@ -10,21 +10,6 @@ import type { Signatures } from "./core/types/signatures.js";
 import type { ParseRecords } from "./core/types/records.js";
 import type { ParseSignature } from "./core/types/utils.js";
 
-/**
- * Parses human-readable ABI into JSON {@link Abi}
- *
- * @param signatures - Human-readable ABI
- * @returns Parsed {@link Abi}
- *
- * @example
- * type Result = ParseAbi<
- *   // ^? type Result = readonly [{ name: "balanceOf"; type: "function"; stateMutability:...
- *   [
- *     'function balanceOf(address owner) view returns (uint256)',
- *     'event Transfer(address indexed from, address indexed to, uint256 amount)',
- *   ]
- * >
- */
 export type ParseWit<signatures extends readonly string[]> =
   string[] extends signatures
     ? Wit // If `T` was not able to be inferred (e.g. just `string[]`), return `Abi`

package/test/src/wits.ts

@@ -5,10 +5,6 @@ export const nativeTokenRaw = [
   "record transfer { src: string, dst: string, amt: decimal }",
   "record burn { src: string, amt: decimal }",
   "record mint { dst: string, amt: decimal }",
-
-  "export issuance: func(ctx: borrow<core-context>, amt: decimal) -> result<mint, error>;",
-  "export hold: func(ctx: borrow<core-context>, amt: decimal) -> result<transfer, error>;",
-  "export release: func(ctx: borrow<core-context>, burn-amt: decimal) -> result<burn, error>;",
   "export init: func(ctx: borrow<proc-context>);",
   "export mint: func(ctx: borrow<proc-context>, amt: decimal) -> result<mint, error>;",
   "export burn: func(ctx: borrow<proc-context>, amt: decimal) -> result<burn, error>;",