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

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/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/wit/wit-parser/core/utils.ts

@@ -16,10 +16,7 @@ export type ParseOptions = {
   records?: RecordLookup;
   type?: WitItemType | "record";
 };
-//
-// export const witParameterRegex =
-//   /^(?:(?<name>[a-z][a-z0-9-]*)\s*:\s*)?(?<type>(?:borrow|list|option|result|tuple)\s*<[\s\S]+>|[a-z][a-z0-9-]*|(?:record|variant|flags|enum)\s*\{[\s\S]*\})$/;
-//
+
 export const witParameterRegex =
   /^(?:(?<name>[a-z][a-z0-9-]*)\s*:\s*)?(?<type>_|(?:borrow|list|option|result|tuple)\s*<[\s\S]+>|[a-z][a-z0-9-]*|(?:record|variant|flags|enum)\s*\{[\s\S]*\})$/;
 
@@ -60,7 +57,6 @@ export function parseWitParameter(param: string, options?: ParseOptions) {
   if (match.name && isWitKeyword(match.name))
     throw new WitProtectedKeywordError({ param, name: match.name });
 
-  // TODO: smell
   const name = match.name ? { name: match.name } : {};
   const records = options?.records ?? {};
   let type: string;

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`