@kontor/kontor-sdk 1.0.0-alpha.0

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

@@ -0,0 +1,81 @@
+import type { RpcSchema } from "../types/rpc-schema.js";
+import type { RpcTransport } from "./transports/create-rpc-transport.js";
+import {
+  type RpcClient,
+  type RpcClientConfig,
+  type CreateClientErrorType,
+  createRpcClient,
+} from "./base/create-rpc-client.js";
+
+import type { Chain } from "../types/chain.js";
+import type { Account } from "../accounts/types.js";
+import type { Address, XOnlyPubKey } from "../types/misc.js";
+import type { Prettify } from "../../wit/type-utils.js";
+import type { BtcRpcSchema } from "../types/btc-rpc.js";
+
+import { type PublicActions, publicActions } from "./decorators/public.js";
+import type { ErrorType } from "../errors/utils.js";
+import type { ParseAccount } from "../types/account.js";
+
+export type PublicClientConfig<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  Pick<
+    RpcClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+    | "cacheTime"
+    | "chain"
+    | "key"
+    | "name"
+    | "pollingInterval"
+    | "rpcSchema"
+    | "transport"
+  >
+>;
+
+export type PublicClient<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  RpcClient<
+    transport,
+    chain,
+    accountOrAddress,
+    rpcSchema extends RpcSchema
+      ? [...BtcRpcSchema, ...rpcSchema]
+      : BtcRpcSchema,
+    PublicActions
+  >
+>;
+
+export type CreatePublicClientErrorType = CreateClientErrorType | ErrorType;
+
+export function createPublicClient<
+  transport extends RpcTransport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  // TODO: should we be more geneic here?
+  rpcSchema extends BtcRpcSchema | undefined = undefined,
+>(
+  parameters: PublicClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+): PublicClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema> {
+  const { key = "btc-rpc", name = "BTC-RPC Client" } = parameters;
+  const client = createRpcClient({
+    ...parameters,
+    key,
+    name,
+    type: "btc-rpc-client",
+  }) as any; // TODO: figure out what deal is with this any
+
+  return client.extend(publicActions) as any;
+}

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

@@ -0,0 +1,86 @@
+import type { RpcSchema } from "../types/rpc-schema.js";
+import type { RpcTransport } from "./transports/create-rpc-transport.js";
+import {
+  type RpcClient,
+  type RpcClientConfig,
+  type CreateClientErrorType,
+  createRpcClient,
+} from "./base/create-rpc-client.js";
+import type { Chain } from "../types/chain.js";
+import type { Account } from "../accounts/types.js";
+import type { Address, XOnlyPubKey } from "../types/misc.js";
+import type { Prettify } from "../../wit/type-utils.js";
+import type { WBIP001Schema } from "../types/wbip001.js";
+
+import type { ErrorType } from "../errors/utils.js";
+import type { ParseAccount } from "../types/account.js";
+import { walletActions, type WalletActions } from "./decorators/wallet.js";
+
+export type WalletClientConfig<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | [Address, XOnlyPubKey] | undefined =
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  Pick<
+    RpcClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+    | "account"
+    | "cacheTime"
+    | "chain"
+    | "key"
+    | "name"
+    | "pollingInterval"
+    | "rpcSchema"
+    | "transport"
+  >
+>;
+
+export type WalletClient<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  RpcClient<
+    transport,
+    chain,
+    accountOrAddress,
+    rpcSchema extends RpcSchema
+      ? [...WBIP001Schema, ...rpcSchema]
+      : WBIP001Schema,
+    WalletActions
+  >
+>;
+
+export type CreateWalletClientErrorType = CreateClientErrorType | ErrorType;
+
+export function createWalletClient<
+  transport extends RpcTransport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  rpcSchema extends WBIP001Schema | undefined = undefined,
+>(
+  parameters: WalletClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+): WalletClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema> {
+  const { key = "btc-rpc", name = "BTC-RPC Client" } = parameters;
+  const client = createRpcClient({
+    ...parameters,
+    key,
+    name,
+    type: "btcRpcClient",
+  }) as any;
+
+  // TODO: fix any if possible
+  return client.extend(walletActions) as WalletClient<
+    transport,
+    chain,
+    ParseAccount<accountOrAddress>,
+    rpcSchema
+  >;
+}

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

@@ -0,0 +1,110 @@
+import type { Wit } from "../../../../wit/wit.js";
+import type { Account } from "../../../accounts/types.js";
+import {
+  viewContract,
+  type ViewContractParameters,
+  type ViewContractReturnType,
+} from "../../../actions/kontor/public/view-contract.js";
+
+import {
+  procContract,
+  type ProcContractParameters,
+  type ProcContractReturnType,
+} from "../../../actions/kontor/public/proc-contract.js";
+
+import {
+  callView,
+  type CallViewParameters,
+  type CallViewReturnType,
+} from "../../../actions/kontor/public/call-view.js";
+
+import {
+  callProc,
+  type CallProcParameters,
+  type CallProcReturnType,
+} from "../../../actions/kontor/public/call-proc.js";
+
+import {
+  buildInstruction,
+  type BuildInstructionParameters,
+  type BuildInstructionReturnType,
+} from "../../../actions/kontor/public/build-instruction.js";
+
+import {
+  buildComposeCall,
+  type BuildComposeCallParameters,
+  type BuildComposeCallReturnType,
+} from "../../../actions/kontor/public/build-compose-call.js";
+
+import {
+  inspect,
+  type InspectParameters,
+  type InspectReturnType,
+} from "../../../actions/kontor/public/inspect.js";
+
+import type { Chain } from "../../../types/chain.js";
+import type {
+  ContractFunctionArgs,
+  ContractFunctionName,
+} from "../../../types/contract.js";
+import type { KontorPublicClient } from "../../kontor/create-public-client.js";
+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,
+> = {
+  viewContract: <
+    const wit extends Wit | readonly unknown[],
+    functionName extends ContractFunctionName<wit, "view">,
+    const args extends ContractFunctionArgs<wit, "view", functionName>,
+  >(
+    args: ViewContractParameters<wit, functionName, args>,
+  ) => Promise<ViewContractReturnType<wit, functionName, args>>;
+
+  procContract: <
+    const wit extends Wit | readonly unknown[],
+    functionName extends ContractFunctionName<wit, "proc">,
+    const args extends ContractFunctionArgs<wit, "proc", functionName>,
+  >(
+    args: ProcContractParameters<wit, functionName, args>,
+  ) => Promise<ProcContractReturnType>;
+
+  callView: <chain extends Chain | undefined>(
+    args: CallViewParameters<chain>,
+  ) => Promise<CallViewReturnType>;
+
+  buildInstruction: <chain extends Chain | undefined>(
+    args: BuildInstructionParameters<chain>,
+  ) => Promise<BuildInstructionReturnType>;
+
+  buildComposeCall: <chain extends Chain | undefined>(
+    args: BuildComposeCallParameters<chain>,
+  ) => Promise<BuildComposeCallReturnType>;
+
+  callProc: <chain extends Chain | undefined>(
+    args: CallProcParameters<chain>,
+  ) => Promise<CallProcReturnType>;
+  inspect: <_chain extends Chain | undefined>(
+    args: InspectParameters,
+  ) => Promise<InspectReturnType>;
+};
+
+export function kontorPublicActions<
+  transport extends HttpTransport = HttpTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+>(
+  client: KontorPublicClient<transport, chain, account>,
+): KontorPublicActions<transport, chain, account> {
+  return {
+    viewContract: (args) => viewContract(client, args),
+    procContract: (args) => procContract(client, args),
+    callView: (args) => callView(client, args),
+    callProc: (args) => callProc(client, args),
+    buildInstruction: (args) => buildInstruction(client, args),
+    buildComposeCall: (args) => buildComposeCall(client, args),
+    inspect: (args) => inspect(client, args),
+  };
+}

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

@@ -0,0 +1,57 @@
+import type { Account } from "../../../accounts/types.js";
+import type { Chain } from "../../../types/chain.js";
+import type { RpcTransport } from "../../transports/create-rpc-transport.js";
+
+import {
+  getAddresses,
+  type GetAddressesReturnType,
+} from "../../../actions/wallet/get-addresses.js";
+
+import {
+  signPsbt,
+  type SignPsbtReturnType,
+  type SignPsbtParameters,
+} from "../../../actions/wallet/sign-psbt.js";
+
+import {
+  signCommit,
+  type SignCommitReturnType,
+  type SignCommitParameters,
+} from "../../../actions/kontor/wallet/sign-commit.js";
+import type { KontorWalletClient } from "../../kontor/create-wallet-client.js";
+import {
+  signReveal,
+  type SignRevealParameters,
+  type SignRevealReturnType,
+} from "../../../actions/kontor/wallet/sign-reveal.js";
+
+export type KontorWalletActions<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = {
+  getAddresses: () => Promise<GetAddressesReturnType>;
+  signPsbt: (
+    params: SignPsbtParameters<chain, account>,
+  ) => Promise<SignPsbtReturnType>;
+  signCommit: (
+    params: SignCommitParameters<chain, account>,
+  ) => Promise<SignCommitReturnType>;
+  signReveal: (
+    params: SignRevealParameters<chain, account>,
+  ) => Promise<SignRevealReturnType>;
+};
+
+export function walletActions<
+  transport extends RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+>(
+  client: KontorWalletClient<transport, chain, account>,
+): KontorWalletActions<chain, account> {
+  return {
+    getAddresses: () => getAddresses(client),
+    signPsbt: (params) => signPsbt(client, params),
+    signCommit: (params) => signCommit(client, params),
+    signReveal: (params) => signReveal(client, params),
+  };
+}

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

@@ -0,0 +1,35 @@
+import type { Account } from "../../accounts/types.js";
+import type { Chain } from "../../types/chain.js";
+import type { Address, XOnlyPubKey } from "../../types/misc.js";
+import type { RpcTransport } from "../transports/create-rpc-transport.js";
+
+import {
+  type SendRawTransactionParams,
+  type SendRawTransactionReturnType,
+  sendRawTransaction,
+} from "../../actions/public/send-raw-transaction.js";
+import type { PublicClient as PublicClient } from "../create-public-client.js";
+
+export type PublicActions<
+  _chain extends Chain | undefined = Chain | undefined,
+  _account extends Account | [Address, XOnlyPubKey] | undefined =
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined,
+> = {
+  sendRawTransaction: (
+    parameters: SendRawTransactionParams,
+  ) => Promise<SendRawTransactionReturnType>;
+};
+
+export function publicActions<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+>(
+  client: PublicClient<transport, chain, account>,
+): PublicActions<chain, account> {
+  return {
+    sendRawTransaction: (args) => sendRawTransaction(client, args),
+  };
+}

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

@@ -0,0 +1,37 @@
+import type { Account } from "../../accounts/types.js";
+import type { Chain } from "../../types/chain.js";
+import type { RpcTransport } from "../transports/create-rpc-transport.js";
+import type { WalletClient } from "../create-wallet-client.js";
+import {
+  getAddresses,
+  type GetAddressesReturnType,
+} from "../../actions/wallet/get-addresses.js";
+
+import {
+  signPsbt,
+  type SignPsbtReturnType,
+  type SignPsbtParameters,
+} from "../../actions/wallet/sign-psbt.js";
+
+export type WalletActions<
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+> = {
+  getAddresses: () => Promise<GetAddressesReturnType>;
+  signPsbt: (
+    params: SignPsbtParameters<chain, account>,
+  ) => Promise<SignPsbtReturnType>;
+};
+
+export function walletActions<
+  transport extends RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+>(
+  client: WalletClient<transport, chain, account>,
+): WalletActions<chain, account> {
+  return {
+    getAddresses: () => getAddresses(client),
+    signPsbt: (params) => signPsbt(client, params),
+  };
+}

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

@@ -0,0 +1,48 @@
+import { expect, test } from "vitest";
+import { createPublicClient } from "./create-public-client.js";
+
+import { http } from "../transports/http.js";
+
+test("creates", async () => {
+  const { uid, ...client } = createPublicClient({
+    transport: http("https://signet.kontor.network:35000/api"),
+  });
+
+  expect(client).toMatchInlineSnapshot(`
+    {
+      "account": undefined,
+      "buildComposeCall": [Function],
+      "buildInstruction": [Function],
+      "cacheTime": 4000,
+      "callProc": [Function],
+      "callView": [Function],
+      "chain": undefined,
+      "extend": [Function],
+      "key": "kontor-http",
+      "name": "KONTOR-HTTP Client",
+      "pollingInterval": 4000,
+      "procContract": [Function],
+      "request": [Function],
+      "transport": {
+        "fetchOptions": undefined,
+        "key": "http",
+        "name": "HTTP Transport",
+        "request": [Function],
+        "retryCount": 3,
+        "retryDelay": 150,
+        "timeout": 10000,
+        "type": "http",
+        "url": "https://signet.kontor.network:35000/api",
+      },
+      "type": "kontor-http-client",
+      "viewContract": [Function],
+    }
+  `);
+
+  const x = await client.callView({
+    contractAddress: "token_0_0",
+    wave: "balances()",
+  });
+
+  console.log({ x });
+});

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

@@ -0,0 +1,97 @@
+import type { Prettify } from "../../../wit/type-utils.js";
+import type { Account } from "../../accounts/types.js";
+import type { Chain } from "../../types/chain.js";
+import type { HttpSchema } from "../../types/http-schema.js";
+import type { KontorSchemaPublic } from "../../types/kontor.js";
+import type { XOnlyPubKey, Address } from "../../types/misc.js";
+import {
+  type KontorPublicActions,
+  kontorPublicActions,
+} from "../decorators/kontor/public.js";
+import {
+  createHttpClient,
+  type CreateClientErrorType,
+  type HttpClient,
+  type HttpClientConfig,
+} from "../base/create-http-client.js";
+import type { HttpTransport } from "../transports/create-http-transport.js";
+import type { ErrorType } from "../../errors/utils.js";
+import type { ParseAccount } from "../../accounts/utils/parse-account.js";
+
+export type KontorPublicClientConfig<
+  transport extends HttpTransport = HttpTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  httpSchema extends HttpSchema | undefined = undefined,
+> = Prettify<
+  Pick<
+    HttpClientConfig<transport, chain, accountOrAddress, httpSchema>,
+    | "cacheTime"
+    | "chain"
+    | "key"
+    | "name"
+    | "pollingInterval"
+    | "httpSchema"
+    | "transport"
+    | "account"
+  >
+>;
+
+export type KontorPublicClient<
+  transport extends HttpTransport = HttpTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = Account | undefined,
+  httpSchema extends HttpSchema | undefined = undefined,
+> = Prettify<
+  HttpClient<
+    transport,
+    chain,
+    accountOrAddress,
+    httpSchema extends HttpSchema
+      ? [...KontorSchemaPublic, ...httpSchema]
+      : KontorSchemaPublic,
+    KontorPublicActions
+  >
+>;
+
+export type CreateKontorPublicClientErrorType =
+  | CreateClientErrorType
+  | ErrorType;
+
+export function createPublicClient<
+  transport extends HttpTransport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  // TODO: should we be more geneic here?
+  httpSchema extends KontorSchemaPublic | undefined = undefined,
+>(
+  parameters: KontorPublicClientConfig<
+    transport,
+    chain,
+    accountOrAddress,
+    httpSchema
+  >,
+): KontorPublicClient<
+  transport,
+  chain,
+  ParseAccount<accountOrAddress>,
+  httpSchema
+> {
+  const { key = "kontor-http", name = "KONTOR-HTTP Client" } = parameters;
+
+  const client = createHttpClient({
+    ...parameters,
+    key,
+    name,
+    type: "kontor-http-client",
+  }) as any;
+  // TODO: refactor this any
+
+  return client.extend(kontorPublicActions);
+}

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

@@ -0,0 +1,101 @@
+import type { RpcSchema } from "../../types/rpc-schema.js";
+import type { RpcTransport } from "../transports/create-rpc-transport.js";
+import {
+  type RpcClient,
+  type RpcClientConfig,
+  type CreateClientErrorType,
+  createRpcClient,
+} from "../base/create-rpc-client.js";
+import type { Chain } from "../../types/chain.js";
+import type { Account } from "../../accounts/types.js";
+import type { Address, XOnlyPubKey } from "../../types/misc.js";
+import type { Prettify } from "../../../wit/type-utils.js";
+import type { WBIP001Schema } from "../../types/wbip001.js";
+
+import type { ErrorType } from "../../errors/utils.js";
+import type { ParseAccount } from "../../types/account.js";
+import {
+  walletActions,
+  type KontorWalletActions,
+} from "../decorators/kontor/wallet.js";
+
+export type KontorWalletClientConfig<
+  walletTransport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | [Address, XOnlyPubKey] | undefined =
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  Pick<
+    RpcClientConfig<walletTransport, chain, accountOrAddress, rpcSchema>,
+    | "account"
+    | "cacheTime"
+    | "chain"
+    | "key"
+    | "name"
+    | "pollingInterval"
+    | "rpcSchema"
+    | "transport"
+  >
+>;
+
+export type KontorWalletClient<
+  transport extends RpcTransport = RpcTransport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = undefined,
+> = Prettify<
+  RpcClient<
+    transport,
+    chain,
+    accountOrAddress,
+    rpcSchema extends RpcSchema
+      ? [...WBIP001Schema, ...rpcSchema]
+      : WBIP001Schema,
+    KontorWalletActions
+  >
+>;
+
+export type CreateKontorWalletClientErrorType =
+  | CreateClientErrorType
+  | ErrorType;
+
+export function createWalletClient<
+  transport extends RpcTransport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends
+    | Account
+    | [Address, XOnlyPubKey]
+    | undefined = undefined,
+  rpcSchema extends WBIP001Schema | undefined = undefined,
+>(
+  parameters: KontorWalletClientConfig<
+    transport,
+    chain,
+    accountOrAddress,
+    rpcSchema
+  >,
+): KontorWalletClient<
+  transport,
+  chain,
+  ParseAccount<accountOrAddress>,
+  rpcSchema
+> {
+  const { key = "btc-rpc", name = "BTC-RPC Client" } = parameters;
+  const client = createRpcClient({
+    ...parameters,
+    key,
+    name,
+    type: "btcRpcClient",
+  }) as any;
+
+  // TODO: fix any if possible
+  return client.extend(walletActions) as KontorWalletClient<
+    transport,
+    chain,
+    ParseAccount<accountOrAddress>,
+    rpcSchema
+  >;
+}