@kontor/kontor-sdk 1.0.0-alpha.19 → 1.0.0-alpha.20

package/src/wit/wit-parser/core/records.test.ts

@@ -9,27 +9,29 @@ test("parse records", () => {
     ]),
   ).toEqual({
     "contract-address": [
-      { name: "name", type: "string" },
-      { name: "height", type: "s64" },
-      { name: "tx-index", type: "s64" },
+      { name: "name", type: "string", internalType: "string" },
+      { name: "height", type: "s64", internalType: "s64" },
+      { name: "tx-index", type: "s64", internalType: "s64" },
     ],
     "token-pair": [
       {
         type: "tuple",
         name: "a",
+        internalType: "contract-address",
         components: [
-          { name: "name", type: "string" },
-          { name: "height", type: "s64" },
-          { name: "tx-index", type: "s64" },
+          { name: "name", type: "string", internalType: "string" },
+          { name: "height", type: "s64", internalType: "s64" },
+          { name: "tx-index", type: "s64", internalType: "s64" },
         ],
       },
       {
         type: "tuple",
         name: "b",
+        internalType: "contract-address",
         components: [
-          { name: "name", type: "string" },
-          { name: "height", type: "s64" },
-          { name: "tx-index", type: "s64" },
+          { name: "name", type: "string", internalType: "string" },
+          { name: "height", type: "s64", internalType: "s64" },
+          { name: "tx-index", type: "s64", internalType: "s64" },
         ],
       },
     ],
@@ -38,7 +40,9 @@ test("parse records", () => {
 
 test("generic", () => {
   expect(parseRecords(["record generic {  values: list<string> }"])).toEqual({
-    generic: [{ name: "values", type: "list<string>" }],
+    generic: [
+      { name: "values", type: "list<string>", internalType: "list<string>" },
+    ],
   });
 });
 
@@ -50,10 +54,16 @@ test("generic", () => {
     ]),
   ).toEqual({
     "contract-address": [
-      { type: "string", name: "name" },
-      { type: "s64", name: "height" },
-      { type: "s64", name: "tx-index" },
+      { name: "name", type: "string", internalType: "string" },
+      { name: "height", type: "s64", internalType: "s64" },
+      { name: "tx-index", type: "s64", internalType: "s64" },
+    ],
+    generic: [
+      {
+        name: "values",
+        type: "list<contract-address>",
+        internalType: "list<contract-address>",
+      },
     ],
-    generic: [{ name: "values", type: "list<contract-address>" }],
   });
 });

package/src/wit/wit-parser/core/types/records.test-d.ts

@@ -1,5 +1,6 @@
 import { expectTypeOf, test } from "vitest";
 
+// TODO: audit discrepancies in this whole file
 import type {
   ParseRecords,
   ParseRecord,
@@ -25,28 +26,65 @@ test("ParseRecords", () => {
     >
   >().toEqualTypeOf<{
     "contract-address": readonly [
-      { readonly name: "name"; readonly type: "string" },
-      { readonly name: "height"; readonly type: "s64" },
-      { readonly name: "tx-index"; readonly type: "s64" },
+      {
+        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";
+      },
     ];
 
     "token-pair": readonly [
       {
         readonly type: "tuple";
         readonly name: "a";
+        // TODO: should include internalType
         readonly components: readonly [
-          { readonly name: "name"; readonly type: "string" },
-          { readonly name: "height"; readonly type: "s64" },
-          { readonly name: "tx-index"; readonly type: "s64" },
+          {
+            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 type: "tuple";
         readonly name: "b";
         readonly components: readonly [
-          { readonly name: "name"; readonly type: "string" },
-          { readonly name: "height"; readonly type: "s64" },
-          { readonly name: "tx-index"; readonly type: "s64" },
+          {
+            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";
+          },
         ];
       },
     ];
@@ -60,9 +98,21 @@ test("ParseRecords", () => {
     >
   >().toEqualTypeOf<{
     "contract-address": readonly [
-      { readonly name: "name"; readonly type: "string" },
-      { readonly name: "height"; readonly type: "s64" },
-      { readonly name: "tx-index"; readonly type: "s64" },
+      {
+        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";
+      },
     ];
 
     "token-pair": readonly [
@@ -95,9 +145,21 @@ test("ParseRecord", () => {
   >().toEqualTypeOf<{
     readonly name: "contract-address";
     readonly components: [
-      { readonly name: "name"; readonly type: "string" },
-      { readonly name: "height"; readonly type: "s64" },
-      { readonly name: "tx-index"; readonly type: "s64" },
+      {
+        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";
+      },
     ];
   }>();
 
@@ -106,8 +168,16 @@ test("ParseRecord", () => {
   >().toEqualTypeOf<{
     readonly name: "token-pair";
     readonly components: [
-      { readonly name: "a"; readonly type: "contract-address" },
-      { readonly name: "b"; readonly type: "contract-address" },
+      {
+        readonly name: "a";
+        readonly type: "contract-address";
+        readonly internalType: "contract-address";
+      },
+      {
+        readonly name: "b";
+        readonly type: "contract-address";
+        readonly internalType: "contract-address";
+      },
     ];
   }>();
 
@@ -122,19 +192,40 @@ test("ParseRecord", () => {
       {
         readonly type: "tuple";
         readonly name: "a";
+        readonly internalType: "contract-address";
         readonly components: readonly [
-          { readonly name: "name"; readonly type: "string" },
-          { readonly name: "height"; readonly type: "s64" },
-          { readonly name: "tx-index"; readonly type: "s64" },
+          {
+            // TODO: why aren't we getting internalType here
+            readonly name: "name";
+            readonly type: "string";
+          },
+          {
+            readonly name: "height";
+            readonly type: "s64";
+          },
+          {
+            readonly name: "tx-index";
+            readonly type: "s64";
+          },
         ];
       },
       {
         readonly type: "tuple";
         readonly name: "b";
+        readonly internalType: "contract-address";
         readonly components: readonly [
-          { readonly name: "name"; readonly type: "string" },
-          { readonly name: "height"; readonly type: "s64" },
-          { readonly name: "tx-index"; readonly type: "s64" },
+          {
+            readonly name: "name";
+            readonly type: "string";
+          },
+          {
+            readonly name: "height";
+            readonly type: "s64";
+          },
+          {
+            readonly name: "tx-index";
+            readonly type: "s64";
+          },
         ];
       },
     ];
@@ -146,9 +237,21 @@ test("ParseRecordProperties", () => {
     ParseRecordProperties<"name: string, height: s64, tx-index: s64">
   >().toEqualTypeOf<
     [
-      { readonly name: "name"; readonly type: "string" },
-      { readonly name: "height"; readonly type: "s64" },
-      { readonly name: "tx-index"; readonly type: "s64" },
+      {
+        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";
+      },
     ]
   >();
 
@@ -156,8 +259,16 @@ test("ParseRecordProperties", () => {
     ParseRecordProperties<"a: contract-address, b: contract-address">
   >().toEqualTypeOf<
     [
-      { readonly name: "a"; readonly type: "contract-address" },
-      { readonly name: "b"; readonly type: "contract-address" },
+      {
+        readonly name: "a";
+        readonly type: "contract-address";
+        readonly internalType: "contract-address";
+      },
+      {
+        readonly name: "b";
+        readonly type: "contract-address";
+        readonly internalType: "contract-address";
+      },
     ]
   >();
 
@@ -168,6 +279,7 @@ test("ParseRecordProperties", () => {
       {
         readonly type: "tuple";
         readonly name: "a";
+        readonly internalType: "contract-address";
         readonly components: readonly [
           { readonly name: "name"; readonly type: "string" },
           { readonly name: "height"; readonly type: "s64" },
@@ -177,6 +289,7 @@ test("ParseRecordProperties", () => {
       {
         readonly type: "tuple";
         readonly name: "b";
+        readonly internalType: "contract-address";
         readonly components: readonly [
           { readonly name: "name"; readonly type: "string" },
           { readonly name: "height"; readonly type: "s64" },

package/src/wit/wit-parser/core/types/utils.test-d.ts

@@ -46,30 +46,36 @@ test("ParseWitParameter", () => {
   assertType<ParseWitParameter<"ctx: borrow<proc-context>">>({
     name: "ctx",
     type: "borrow<proc-context>",
+    internalType: "borrow<proc-context>",
   });
 
   assertType<ParseWitParameter<"arith-address: contract-address">>({
     name: "arith-address",
     type: "contract-address",
+    internalType: "contract-address",
   });
 
   assertType<ParseWitParameter<"n: u64">>({
     name: "n",
     type: "u64",
+    internalType: "u64",
   });
 
   assertType<ParseWitParameter<"u64">>({
     type: "u64",
+    internalType: "u64",
   });
 
   assertType<ParseWitParameter<"x: string">>({
     name: "x",
     type: "string",
+    internalType: "string",
   });
 
   assertType<ParseWitParameter<"y: string">>({
     name: "y",
     type: "string",
+    internalType: "string",
   });
 
   assertType<ParseWitParameter<"option-string: option<string>">>({
@@ -91,15 +97,18 @@ test("ParseWitParameter", () => {
 
   assertType<ParseWitParameter<"contract-address">>({
     type: "contract-address",
+    internalType: "contract-address",
   });
   assertType<ParseWitParameter<"ctx: borrow<view-context>">>({
     name: "ctx",
     type: "borrow<view-context>",
+    internalType: "borrow<view-context>",
   });
 
   assertType<ParseWitParameter<"arith-address: contract-address">>({
     name: "arith-address",
     type: "contract-address",
+    internalType: "contract-address",
   });
 });
 
@@ -149,12 +158,17 @@ test("Parse Signature", () => {
     name: "fib",
     context: "proc",
     inputs: [
-      { name: "arith-address", type: "contract-address" },
+      {
+        name: "arith-address",
+        type: "contract-address",
+        internalType: "contract-address",
+      },
       { name: "n", type: "list<u64>" },
     ],
     outputs: [
       {
         type: "u64",
+        internalType: "u64",
       },
     ],
   });
@@ -165,12 +179,17 @@ test("Parse Signature", () => {
     name: "fib",
     context: "proc",
     inputs: [
-      { name: "arith-address", type: "contract-address" },
+      {
+        name: "arith-address",
+        type: "contract-address",
+        internalType: "contract-address",
+      },
       { name: "n", type: "list<u64>" },
     ],
     outputs: [
       {
         type: "contract-address",
+        internalType: "contract-address",
       },
     ],
   });
@@ -184,12 +203,14 @@ test("Parse Signature", () => {
       {
         name: "arith-address",
         type: "contract-address",
+        internalType: "contract-address",
       },
       { name: "n", type: "list<u64>" },
     ],
     outputs: [
       {
         type: "contract-address",
+        internalType: "contract-address",
       },
     ],
   });

package/src/wit/wit-parser/core/types/utils.ts

@@ -26,9 +26,13 @@ type GetComponents<T> = T extends { components: infer C }
 type AsTupleFromRecord<T extends string, Opts extends ParseOptions> =
   HasRecords<Opts> extends true
     ? T extends keyof RecordsOf<Opts>
-      ? Readonlyify<{ type: "tuple"; components: RecordsOf<Opts>[T] }>
-      : Readonlyify<{ type: T }>
-    : Readonlyify<{ type: T }>;
+      ? Readonlyify<{
+          type: "tuple";
+          components: RecordsOf<Opts>[T];
+          internalType: T;
+        }>
+      : Readonlyify<{ type: T; internalType: T }>
+    : Readonlyify<{ type: T; internalType: T }>;
 
 type SplitResultInner<S extends string> = S extends `${infer L}, ${infer R}`
   ? [Trim<L>, Trim<R>]
@@ -40,44 +44,6 @@ type MaybeResultComponents<
   _Err extends { type: string },
 > = Ok extends { components: infer _C } ? GetComponents<Ok> : {};
 
-// type MaybeResultComponents<
-//   L extends { type: string },
-//   R extends { type: string },
-// > = L extends { components: infer _LC }
-//   ? R extends { components: infer _RC }
-//     ? {
-//         readonly components: [
-//           {
-//             readonly name: "left";
-//             readonly type: L["type"];
-//           } & GetComponents<L>,
-//           {
-//             readonly name: "right";
-//             readonly type: R["type"];
-//           } & GetComponents<R>,
-//         ];
-//       }
-//     : {
-//         readonly components: [
-//           {
-//             readonly name: "left";
-//             readonly type: L["type"];
-//           } & GetComponents<L>,
-//           { readonly name: "right"; readonly type: R["type"] },
-//         ];
-//       }
-//   : R extends { components: infer _RC }
-//     ? {
-//         readonly components: [
-//           { readonly name: "left"; readonly type: L["type"] },
-//           {
-//             readonly name: "right";
-//             readonly type: R["type"];
-//           } & GetComponents<R>,
-//         ];
-//       }
-//     : {}; // neither side has components → omit components entirely
-
 type MapGenericType<T extends string, Opts extends ParseOptions> =
   // list<...>
   T extends `list<${infer U}>`
@@ -103,6 +69,7 @@ type MapGenericType<T extends string, Opts extends ParseOptions> =
               ? Readonlyify<
                   {
                     type: `result<${LMapped["type"]}, ${RMapped["type"]}>`;
+                    internalType: T;
                   } & MaybeResultComponents<LMapped, RMapped>
                 >
               : never

package/src/wit/wit-parser/core/utils.test.ts

@@ -28,16 +28,19 @@ describe("parseFunctionSignature", () => {
           {
             name: "arith-address",
             type: "contract-address",
+            internalType: "contract-address",
           },
           {
             name: "n",
             type: "u64",
+            internalType: "u64",
           },
         ],
         name: "fib",
         outputs: [
           {
             type: "u64",
+            internalType: "u64",
           },
         ],
         type: "function",
@@ -53,6 +56,7 @@ describe("parseFunctionSignature", () => {
         outputs: [
           {
             type: "list<u64>",
+            internalType: "list<u64>",
           },
         ],
         type: "function",
@@ -70,6 +74,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "ctx",
         type: "borrow<proc-context>",
+        internalType: "borrow<proc-context>",
       },
     },
     {
@@ -77,6 +82,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "arith-address",
         type: "tuple",
+        internalType: "contract-address",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },
@@ -89,6 +95,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "n",
         type: "u64",
+        internalType: "u64",
       },
     },
     {
@@ -96,6 +103,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "y",
         type: "string",
+        internalType: "string",
       },
     },
     {
@@ -103,6 +111,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "list-of-strings",
         type: "list<string>",
+        internalType: "list<string>",
       },
     },
     {
@@ -110,6 +119,7 @@ describe("parseWitParameter", () => {
       expected: {
         name: "arith-addresses",
         type: "list<tuple>",
+        internalType: "list<contract-address>",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },
@@ -121,6 +131,7 @@ describe("parseWitParameter", () => {
       parameter: "list<contract-address>",
       expected: {
         type: "list<tuple>",
+        internalType: "list<contract-address>",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },
@@ -132,6 +143,7 @@ describe("parseWitParameter", () => {
       parameter: "option<contract-address>",
       expected: {
         type: "option<tuple>",
+        internalType: "option<contract-address>",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },
@@ -143,6 +155,7 @@ describe("parseWitParameter", () => {
       parameter: "result<contract-address, error>",
       expected: {
         type: "result<tuple, error>",
+        internalType: "result<contract-address, error>",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },
@@ -154,6 +167,7 @@ describe("parseWitParameter", () => {
       parameter: "result<list<contract-address>, error>",
       expected: {
         type: "result<list<tuple>, error>",
+        internalType: "result<list<contract-address>, error>",
         components: [
           { name: "name", type: "string" },
           { name: "height", type: "s64" },

package/src/wit/wit-parser/core/utils.ts

@@ -152,6 +152,7 @@ export function parseWitParameter(param: string, options?: ParseOptions) {
 
   const witParameter: WitParameter = {
     type: `${type}${match.array ?? ""}`,
+    internalType: match.type,
     ...(name as { name: string }),
     ...components,
   };