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

package/src/sdk/actions/kontor/public/proc-contract.ts

@@ -1,8 +1,10 @@
+import type { GetAccountParameter } from "../../../../sdk/types/account.js";
+import type { Account } from "../../../../sdk/accounts/types.js";
 import { Instruction } from "../../../../sdk/types/kontor.js";
 import type { Wit } from "../../../../wit/wit.js";
 import type { KontorPublicClient } from "../../../clients/kontor/create-public-client.js";
 import type { HttpTransport } from "../../../clients/transports/create-http-transport.js";
-import type { Chain } from "../../../types/chain.js";
+import type { Chain, GetChainParameter } from "../../../types/chain.js";
 import type {
   ContractFunctionArgs,
   ContractFunctionName,
@@ -16,6 +18,52 @@ import {
 } from "../../../utils/wit/encode-function-data.js";
 import { callCompose, type CallComposeReturnType } from "./call-compose.js";
 
+// export type WriteContractParameters<
+//   abi extends Abi | readonly unknown[] = Abi,
+//   functionName extends ContractFunctionName<
+//     abi,
+//     'nonpayable' | 'payable'
+//   > = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+//   args extends ContractFunctionArgs<
+//     abi,
+//     'nonpayable' | 'payable',
+//     functionName
+//   > = ContractFunctionArgs<abi, 'nonpayable' | 'payable', functionName>,
+//   chain extends Chain | undefined = Chain | undefined,
+//   account extends Account | undefined = Account | undefined,
+//   chainOverride extends Chain | undefined = Chain | undefined,
+//   ///
+//   allFunctionNames = ContractFunctionName<abi, 'nonpayable' | 'payable'>,
+//   derivedChain extends Chain | undefined = DeriveChain<chain, chainOverride>,
+// > = ContractFunctionParameters<
+//   abi,
+//   'nonpayable' | 'payable',
+//   functionName,
+//   args,
+//   false,
+//   allFunctionNames
+// > &
+//   GetChainParameter<chain, chainOverride> &
+//   Prettify<
+//     GetAccountParameter<account, Account | Address, true, true> &
+//       GetMutabilityAwareValue<
+//         abi,
+//         'nonpayable' | 'payable',
+//         functionName,
+//         FormattedTransactionRequest<derivedChain>['value'],
+//         args
+//       > & {
+//         /** Data to append to the end of the calldata. Useful for adding a ["domain" tag](https://opensea.notion.site/opensea/Seaport-Order-Attributions-ec2d69bf455041a5baa490941aad307f). */
+//         dataSuffix?: Hex | undefined
+//       }
+//   > &
+//   UnionEvaluate<
+//     UnionOmit<
+//       FormattedTransactionRequest<derivedChain>,
+//       'data' | 'from' | 'to' | 'value'
+//     >
+//   >
+
 export type ProcContractParameters<
   wit extends Wit | readonly unknown[] = Wit,
   functionName extends ContractFunctionName<wit, "proc"> = ContractFunctionName<
@@ -27,13 +75,15 @@ export type ProcContractParameters<
     "proc",
     functionName
   > = ContractFunctionArgs<wit, "proc", functionName>,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
 > = ContractFunctionParameters<wit, "proc", functionName, args> & {
-  address?: Address;
-  xOnlyPubKey?: XOnlyPubKey;
   utxos: UtxoId[];
   gas: bigint;
   satsPerVByte: number;
-};
+} & GetChainParameter<chain, chainOverride> &
+  GetAccountParameter<account, Account | [XOnlyPubKey, Address], true, true>;
 
 export type ProcContractReturnType = CallComposeReturnType;
 
@@ -55,8 +105,8 @@ export async function procContract<
     utxos,
     gas,
     satsPerVByte,
-    address = client.account?.address,
-    xOnlyPubKey = client.account?.xOnlyPubKey,
+    chain: chain_ = client.chain,
+    account: account_ = client.account,
     // @ts-ignore
     ...rest
   } = parameters as ProcContractParameters;
@@ -68,14 +118,9 @@ export async function procContract<
     functionName,
   } as EncodeFunctionDataParameters);
 
-  if (!xOnlyPubKey) {
-    // TODO: add custom error
-    throw new Error("x_only_public_key is required");
-  }
-
-  if (!address) {
+  if (!account_) {
     // TODO: add custom error
-    throw new Error("address is required");
+    throw new Error("account is required");
   }
 
   if (utxos.length === 0) {
@@ -91,8 +136,8 @@ export async function procContract<
     )({
       utxos,
       satsPerVByte,
-      address,
-      xOnlyPubKey,
+      account: account_,
+      chain: chain_,
       instruction: Instruction.call({
         contract: contractAddress,
         gasLimit: gas,

package/src/sdk/actions/kontor/wallet/sign-commit.ts

@@ -8,23 +8,33 @@ import type { Chain, GetChainParameter } from "../../../types/chain.js";
 import { getAction } from "../../..//utils/get-action.js";
 import { signPsbt } from "../../wallet/sign-psbt.js";
 import { parseAccount } from "../../../accounts/utils/parse-account.js";
+import type { XOnlyPubKey, Address } from "../../../../sdk/types/misc.js";
+
+export type SignCommitRequest = {
+  psbt: string;
+};
 
 export type SignCommitParameters<
-  chain extends Chain | undefined,
-  account extends Account | undefined,
-> = GetAccountParameter<account> &
-  // TODO: add chainoverride?
-  GetChainParameter<chain> & { psbt: string };
+  chain extends Chain | undefined = Chain,
+  account extends Account | undefined = Account | undefined,
+  chainOverride extends Chain | undefined = Chain | undefined,
+  accountOverride extends Account | [Address, XOnlyPubKey] | undefined =
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined,
+> = SignCommitRequest &
+  GetAccountParameter<account, accountOverride, false, true> &
+  GetChainParameter<chain, chainOverride>;
 
 export type SignCommitReturnType = Transaction;
 
 export async function signCommit<
-  // @ts-ignore
   chain extends Chain | undefined,
   account extends Account | undefined,
+  chainOverride extends Chain | undefined = undefined,
 >(
   client: KontorWalletClient<RpcTransport, chain, account>,
-  parameters: SignCommitParameters<chain, account>,
+  parameters: SignCommitParameters<chain, account, chainOverride>,
 ): Promise<SignCommitReturnType> {
   const {
     account: account_ = client.account,
@@ -33,6 +43,7 @@ export async function signCommit<
   } = parameters;
 
   if (!account_) throw new Error("AccountNotFoundError");
+  // TODO: throw if chain is undefined
 
   const account = parseAccount(account_);
 

package/src/sdk/actions/kontor/wallet/sign-reveal.ts

@@ -18,7 +18,7 @@ import type { ParticipantScripts } from "@kontor/kontor-ts";
 export type SignRevealParameters<
   chain extends Chain | undefined,
   account extends Account | undefined,
-> = GetAccountParameter<account> &
+> = GetAccountParameter<account, account, false> &
   // TODO: add chainoverride?
   GetChainParameter<chain> & {
     psbt: string;

package/src/sdk/clients/decorators/kontor/public.ts

@@ -52,8 +52,8 @@ import type { HttpTransport } from "../../transports/create-http-transport.js";
 
 export type KontorPublicActions<
   _transport extends HttpTransport = HttpTransport,
-  _chain extends Chain | undefined = Chain | undefined,
-  _account extends Account | undefined = Account | undefined,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
 > = {
   viewContract: <
     const wit extends Wit | readonly unknown[],
@@ -83,8 +83,8 @@ export type KontorPublicActions<
     args: BuildComposeQueryParameters<chain>,
   ) => Promise<BuildComposeQueryReturnType>;
 
-  callCompose: <chain extends Chain | undefined>(
-    args: CallComposeParameters<chain>,
+  callCompose: <chainOverride extends Chain | undefined>(
+    args: CallComposeParameters<chain, account, chainOverride>,
   ) => Promise<CallComposeReturnType>;
   inspect: <_chain extends Chain | undefined>(
     args: InspectParameters,

package/src/sdk/clients/decorators/kontor/wallet.ts

@@ -33,8 +33,8 @@ export type KontorWalletActions<
   signPsbt: (
     params: SignPsbtParameters<chain, account>,
   ) => Promise<SignPsbtReturnType>;
-  signCommit: (
-    params: SignCommitParameters<chain, account>,
+  signCommit: <chainOverride extends Chain | undefined>(
+    params: SignCommitParameters<chain, account, chainOverride>,
   ) => Promise<SignCommitReturnType>;
   signReveal: (
     params: SignRevealParameters<chain, account>,

package/src/sdk/clients/kontor/create-public-client.ts

@@ -43,17 +43,17 @@ export type KontorPublicClientConfig<
 export type KontorPublicClient<
   transport extends HttpTransport = HttpTransport,
   chain extends Chain | undefined = Chain | undefined,
-  accountOrAddress extends Account | undefined = Account | undefined,
+  account extends Account | undefined = Account | undefined,
   httpSchema extends HttpSchema | undefined = undefined,
 > = Prettify<
   HttpClient<
     transport,
     chain,
-    accountOrAddress,
+    account,
     httpSchema extends HttpSchema
       ? [...KontorSchemaPublic, ...httpSchema]
       : KontorSchemaPublic,
-    KontorPublicActions
+    KontorPublicActions<transport, chain, account>
   >
 >;
 

package/src/sdk/clients/kontor/create-wallet-client.ts

@@ -44,17 +44,17 @@ export type KontorWalletClientConfig<
 export type KontorWalletClient<
   transport extends RpcTransport = RpcTransport,
   chain extends Chain | undefined = Chain | undefined,
-  accountOrAddress extends Account | undefined = Account | undefined,
+  account extends Account | undefined = Account | undefined,
   rpcSchema extends RpcSchema | undefined = undefined,
 > = Prettify<
   RpcClient<
     transport,
     chain,
-    accountOrAddress,
+    account,
     rpcSchema extends RpcSchema
       ? [...WBIP001Schema, ...rpcSchema]
       : WBIP001Schema,
-    KontorWalletActions
+    KontorWalletActions<chain, account>
   >
 >;
 

package/src/sdk/contracts/wits.ts

@@ -12,10 +12,6 @@ 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>;",
@@ -23,7 +19,7 @@ const nativeTokenRaw = [
   "export balance: func(ctx: borrow<view-context>, acc: string) -> option<decimal>;",
   "export balances: func(ctx: borrow<view-context>) -> list<balance>;",
   "export total-supply: func(ctx: borrow<view-context>) -> decimal;",
-  // "export attach: func(ctx: borrow<proc-context>, vout: u64, amt: decimal) -> result<transfer, error>;",
+  "export attach: func(ctx: borrow<proc-context>, vout: u64, amt: decimal) -> result<transfer, error>;",
   "export detach: func(ctx: borrow<proc-context>) -> result<transfer, error>;",
 ] as const;
 

package/src/sdk/test/e2e.test.ts

@@ -120,8 +120,16 @@ test("e2e kontor wallet client", async () => {
 
   const kontorPublicClient = createKontorPublicClient({
     transport: http("https://signet-staging.kontor.network:35000/api"),
+    chain: signet,
+    account,
+  });
+
+  const kontorWalletClient = createKontorWalletClient({
     account,
     chain: signet,
+    transport: custom({
+      request: async (_args: any) => null,
+    }),
   });
 
   const res = await kontorPublicClient.callCompose({
@@ -132,23 +140,11 @@ test("e2e kontor wallet client", async () => {
     satsPerVByte: 1,
   });
 
-  const kontorWalletClient = createKontorWalletClient({
-    account,
-    // TODO: transport is not used for local account.
-    transport: custom({
-      request: async (_args: any) => null,
-    }),
-  });
-
   const commit: Transaction = await kontorWalletClient.signCommit({
-    account: account,
-    chain: signet,
     psbt: res.result.commit_psbt_hex,
   });
 
   const reveal: Transaction = await kontorWalletClient.signReveal({
-    account: account,
-    chain: signet,
     psbt: res.result.reveal_psbt_hex,
     parcipantScripts: res.result.per_participant,
   });

package/src/sdk/types/chain.ts

@@ -108,3 +108,8 @@ export type GetChainParameter<
   IsUndefined<chain> extends true
     ? { chain: chainOverride | null }
     : { chain?: chainOverride | null | undefined };
+
+export type DeriveChain<
+  chain extends Chain | undefined,
+  chainOverride extends Chain | undefined,
+> = chainOverride extends Chain ? chainOverride : chain;

package/src/sdk/types/contract.test-d.ts

@@ -2,63 +2,35 @@ import { expectTypeOf, test } from "vitest";
 import type {
   ContractFunctionName,
   ContractFunctionArgs,
-  ExtractWitFunctionForArgs,
   ContractFunctionReturnType,
 } from "./contract.js";
 import { nativeToken as nativeToken_ } from "../contracts/wits.js";
 
 const nativeToken = nativeToken_.wit;
 
-type t = ExtractWitFunctionForArgs<
-  typeof nativeToken,
-  "proc",
-  "transfer",
-  [string, [bigint, number]]
->;
-
 test("ContractFunctionName", () => {
   type All = ContractFunctionName<typeof nativeToken>;
   expectTypeOf<All>().toEqualTypeOf<
-    | "issuance"
-    | "hold"
-    | "release"
-    // | "init" // init is not valid
     | "mint"
     | "burn"
     | "transfer"
     | "balance"
     | "balances"
     | "total-supply"
-    // | "attach"
+    | "attach"
     | "detach"
   >;
 
-  type Core = ContractFunctionName<typeof nativeToken, "core">;
-  expectTypeOf<Core>().toEqualTypeOf<"issuance" | "hold" | "release">;
-
   type View = ContractFunctionName<typeof nativeToken, "view">;
   expectTypeOf<View>().toEqualTypeOf<"balance" | "balances" | "total-supply">;
 
   type Proc = ContractFunctionName<typeof nativeToken, "proc">;
   expectTypeOf<Proc>().toEqualTypeOf<
-    | "mint"
-    | "burn"
-    | "transfer"
-    //| "attach"
-    | "detach"
+    "mint" | "burn" | "transfer" | "attach" | "detach"
   >;
 });
 
 test("ContractFunctionArgs", () => {
-  type Issuance = ContractFunctionArgs<typeof nativeToken, "core", "issuance">;
-  expectTypeOf<Issuance>().toEqualTypeOf<readonly [[bigint, number]]>;
-
-  type Hold = ContractFunctionArgs<typeof nativeToken, "core", "hold">;
-  expectTypeOf<Hold>().toEqualTypeOf<readonly [[bigint, number]]>;
-
-  type Release = ContractFunctionArgs<typeof nativeToken, "core", "release">;
-  expectTypeOf<Release>().toEqualTypeOf<readonly [[bigint, number]]>;
-
   type Mint = ContractFunctionArgs<typeof nativeToken, "proc", "mint">;
   expectTypeOf<Mint>().toEqualTypeOf<readonly [[bigint, number]]>;
 
@@ -89,60 +61,6 @@ test("ContractFunctionArgs", () => {
 });
 
 test("ContractFunctionReturnType", () => {
-  type Issuance = ContractFunctionReturnType<
-    typeof nativeToken,
-    "core",
-    "issuance"
-  >;
-  expectTypeOf<Issuance>().toEqualTypeOf<
-    | {
-        ok: false;
-        error: string;
-      }
-    | {
-        ok: true;
-        value: {
-          dst: string;
-          amt: [bigint, number];
-        };
-      }
-  >;
-
-  type Hold = ContractFunctionReturnType<typeof nativeToken, "core", "hold">;
-  expectTypeOf<Hold>().toEqualTypeOf<
-    | {
-        ok: false;
-        error: string;
-      }
-    | {
-        ok: true;
-        value: {
-          src: string;
-          dst: string;
-          amt: [bigint, number];
-        };
-      }
-  >;
-
-  type Release = ContractFunctionReturnType<
-    typeof nativeToken,
-    "core",
-    "release"
-  >;
-  expectTypeOf<Release>().toEqualTypeOf<
-    | {
-        ok: false;
-        error: string;
-      }
-    | {
-        ok: true;
-        value: {
-          src: string;
-          amt: [bigint, number];
-        };
-      }
-  >;
-
   type Mint = ContractFunctionReturnType<typeof nativeToken, "proc", "mint">;
   expectTypeOf<Mint>().toEqualTypeOf<
     | {
@@ -222,25 +140,25 @@ test("ContractFunctionReturnType", () => {
   >;
   expectTypeOf<TotalSupply>().toEqualTypeOf<[bigint, number]>;
 
-  // type Attach = ContractFunctionReturnType<
-  //   typeof nativeToken,
-  //   "proc",
-  //   "attach"
-  // >;
-  // expectTypeOf<Attach>().toEqualTypeOf<
-  //   | {
-  //       ok: false;
-  //       error: string;
-  //     }
-  //   | {
-  //       ok: true;
-  //       value: {
-  //         src: string;
-  //         dst: string;
-  //         amt: [bigint, number];
-  //       };
-  //     }
-  // >;
+  type Attach = ContractFunctionReturnType<
+    typeof nativeToken,
+    "proc",
+    "attach"
+  >;
+  expectTypeOf<Attach>().toEqualTypeOf<
+    | {
+        ok: false;
+        error: string;
+      }
+    | {
+        ok: true;
+        value: {
+          src: string;
+          dst: string;
+          amt: [bigint, number];
+        };
+      }
+  >;
 
   type Detach = ContractFunctionReturnType<
     typeof nativeToken,

package/src/sdk/utils/wit/decode-wit-parameter.ts

@@ -87,6 +87,8 @@ function decoderForParam(p: WitParameter) {
       return listOfDecimalDecoder;
     case "list<tuple>":
       return listOfTupleDecoder(p);
+    case "u64":
+      return u64Decoder;
 
     case "error":
     case "contract-address":
@@ -98,8 +100,6 @@ function decoderForParam(p: WitParameter) {
     case "u8":
     case "u16":
     case "u32":
-    case "u64":
-      return u64Decoder;
     case "integer":
     case "option<string>":
     case "option<bool>":

package/src/sdk/utils/wit/encode-function-data.test-d.ts

@@ -34,18 +34,16 @@ test("native token", () => {
   type P = EncodeFunctionDataParameters<typeof nativeToken.wit>;
 
   expectTypeOf<P["functionName"]>().not.toEqualTypeOf<undefined>();
-
   expectTypeOf<P["functionName"]>().toEqualTypeOf<
-    | "mint"
-    | "issuance"
     | "balance"
     | "transfer"
     | "burn"
-    | "hold"
-    | "release"
+    | "mint"
     | "balances"
     | "total-supply"
+    | "attach"
     | "detach"
-    // | "attach" // TODO: need to handle attach parsing
   >();
+
+  // TODO: fill out tests
 });

package/src/sdk/utils/wit/encode-function-data.test.ts

@@ -2,55 +2,11 @@ import { expect, test } from "vitest";
 import { encodeFunctionData } from "./encode-function-data.js";
 import { parseWit } from "../../../wit/wit-parser/parse-wit.js";
 
-export const nativeToken = parseWit([
-  "record balance { acc: string, amt: decimal }",
-  "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>;",
-  "export transfer: func(ctx: borrow<proc-context>, dst: string, amt: decimal) -> result<transfer, error>;",
-  "export balance: func(ctx: borrow<view-context>, acc: string) -> option<decimal>;",
-  "export balances: func(ctx: borrow<view-context>) -> list<balance>;",
-  "export total-supply: func(ctx: borrow<view-context>) -> decimal;",
-  "export attach: func(ctx: borrow<proc-context>, vout: u64, amt: decimal) -> result<transfer, error>;",
-  "export detach: func(ctx: borrow<proc-context>) -> result<transfer, error>;",
-]);
+import { nativeToken as nativeToken_ } from "../../../sdk/contracts/wits.js";
 
-//TODO: change functionName to func
-test("issuance", () => {
-  expect(
-    encodeFunctionData({
-      wit: nativeToken,
-      functionName: "issuance",
-      args: [[7n, 18]],
-    }),
-  ).toEqual("issuance({r0: 7, r1: 0, r2: 0, r3: 0, sign: plus})");
-});
+export const nativeToken = parseWit(nativeToken_.raw);
 
-test("hold", () => {
-  expect(
-    encodeFunctionData({
-      wit: nativeToken,
-      functionName: "hold",
-      args: [[7n, 18]],
-    }),
-  ).toEqual("hold({r0: 7, r1: 0, r2: 0, r3: 0, sign: plus})");
-});
-
-test("release", () => {
-  expect(
-    encodeFunctionData({
-      wit: nativeToken,
-      functionName: "release",
-      args: [[7n, 18]],
-    }),
-  ).toEqual("release({r0: 7, r1: 0, r2: 0, r3: 0, sign: plus})");
-});
+//TODO: change functionName to func
 
 test("mint", () => {
   expect(

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

@@ -119,6 +119,7 @@ test("ParseRecords", () => {
       {
         readonly name: "values";
         readonly type: "list<contract-address>";
+        readonly internalType: "list<contract-address>";
       },
     ];
   }>();
@@ -306,6 +307,7 @@ test("ParseRecordProperties", () => {
       {
         readonly name: "values";
         readonly type: "list<string>";
+        readonly internalType: "list<string>";
       },
     ]
   >();
@@ -317,6 +319,7 @@ test("ParseRecordProperties", () => {
       {
         readonly name: "values";
         readonly type: "list<tuple>";
+        readonly internalType: "list<contract-address>";
         readonly components: readonly [
           { readonly name: "name"; readonly type: "string" },
           { readonly name: "height"; readonly type: "s64" },