@kontor/kontor-sdk 1.0.0-alpha.0

package/dist/types/wit/wit.d.ts

@@ -0,0 +1,60 @@
+import type { ResolvedRegister } from "./register.js";
+import type { Pretty } from "./type-utils.js";
+export type MBits = 8 | 16 | 32 | 64;
+export type Address = ResolvedRegister["addressType"];
+export type WitContractAddress = "contract-address";
+export type WitInteger = "integer";
+export type WitDecimal = "decimal";
+export type WitTuple = "tuple";
+export type WitError = "error";
+export type WitUnit = "_";
+export type WitBool = "bool";
+export type WitSInt = `s${MBits}`;
+export type WitUInt = `u${MBits}`;
+export type WitString = "string";
+export type WitInt = WitSInt | WitUInt;
+type _BuildOptionTypes<T extends string> = `option<${T}>`;
+export type WitOptionWithoutTuple = _BuildOptionTypes<WitBool | WitSInt | WitUInt | WitString | WitDecimal | WitInteger | WitUnit>;
+export type WitOptionWithTuple = _BuildOptionTypes<WitTuple>;
+export type WitOptionWithList = _BuildOptionTypes<WitList>;
+export type WitOption = WitOptionWithoutTuple | WitOptionWithTuple | WitOptionWithList;
+type _BuildResultTypes<T extends string> = `result<${T}, error>`;
+export type WitResultWithoutTuple = _BuildResultTypes<WitBool | WitSInt | WitUInt | WitString | WitOption | WitInteger | WitDecimal | WitUnit>;
+export type WitResultWithTuple = _BuildResultTypes<WitTuple>;
+export type WitResultWithList = _BuildResultTypes<WitList>;
+export type WitResult = WitResultWithoutTuple | WitResultWithTuple | WitResultWithList;
+type _BuildListTypes<T extends string> = `list<${T}>`;
+export type WitListWithoutTuple = _BuildListTypes<WitBool | WitSInt | WitUInt | WitString | WitInteger | WitDecimal | WitUnit>;
+export type WitListWithTuple = _BuildListTypes<WitTuple>;
+export type WitList = WitListWithoutTuple | WitListWithTuple;
+export type WitStateMutability = "view" | "proc" | "core";
+export type WitParameterKind = "inputs" | "outputs";
+export type WitType = WitContractAddress | WitTuple | WitResult | WitError | WitBool | WitSInt | WitUInt | WitString | WitInteger | WitDecimal | WitList | WitOption;
+type ResolvedWitType = ResolvedRegister["strictWitType"] extends true ? WitType : string;
+export type WitInternalType = ResolvedWitType | `record ${string}`;
+export type WitParameter = Pretty<{
+    type: string;
+    name?: string | undefined;
+    internalType?: WitInternalType | undefined;
+    components?: readonly WitParameter[];
+}>;
+export type WitItemType = "func";
+export type WitFunction = {
+    type: "function";
+    name: string;
+    inputs: readonly WitParameter[];
+    outputs: readonly WitParameter[];
+    payable?: boolean | undefined;
+    context: WitStateMutability;
+};
+export type Wit = readonly WitFunction[];
+export type TypedDataType = Exclude<WitType, WitTuple | WitListWithTuple>;
+export type TypedDataParameter = {
+    name: string;
+    type: TypedDataType | keyof TypedData | `${keyof TypedData}[${string | ""}]`;
+};
+export type TypedData = Pretty<Record<string, readonly TypedDataParameter[]> & {
+    [_ in TypedDataType]?: never;
+}>;
+export {};
+//# sourceMappingURL=wit.d.ts.map

package/dist/types/wit/wit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wit.d.ts","sourceRoot":"","sources":["../../../src/wit/wit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAGrC,MAAM,MAAM,OAAO,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;AAGtD,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AACpD,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC;AACnC,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC;AASnC,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAC/B,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC;AAC/B,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC;AAE1B,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC;AAClC,MAAM,MAAM,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC;AAElC,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;AAGjC,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAIvC,KAAK,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC;AAC1D,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,CACjD,OAAO,GACP,OAAO,GACP,OAAO,GAEP,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,CAEV,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAE3D,MAAM,MAAM,SAAS,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,KAAK,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC;AAEjE,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,CACjD,OAAO,GACP,OAAO,GACP,OAAO,GAEP,SAAS,GACT,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,CAGV,CAAC;AACF,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;AAE3D,MAAM,MAAM,SAAS,GACjB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,CAAC;AAGtB,KAAK,eAAe,CAAC,CAAC,SAAS,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC;AACtD,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAC7C,OAAO,GACP,OAAO,GACP,OAAO,GAEP,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,CAEV,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;AAEzD,MAAM,MAAM,OAAO,GAAG,mBAAmB,GAAG,gBAAgB,CAAC;AAG7D,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEpD,MAAM,MAAM,OAAO,GACf,kBAAkB,GAIlB,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GAEP,SAAS,GACT,UAAU,GACV,UAAU,GAEV,OAAO,GACP,SAAS,CAAC;AAGd,KAAK,eAAe,GAAG,gBAAgB,CAAC,eAAe,CAAC,SAAS,IAAI,GACjE,OAAO,GACP,MAAM,CAAC;AAGX,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,UAAU,MAAM,EAAE,CAAC;AAEnE,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAC3C,UAAU,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,SAAS,YAAY,EAAE,CAAC;IAChC,OAAO,EAAE,SAAS,YAAY,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,OAAO,EAAE,kBAAkB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,GAAG,GAAG,SAAS,WAAW,EAAE,CAAC;AAGzC,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,gBAAgB,CAAC,CAAC;AAE1E,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,GAAG,MAAM,SAAS,GAAG,GAAG,MAAM,SAAS,IAAI,MAAM,GAAG,EAAE,GAAG,CAAC;CAC9E,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,MAAM,CAC5B,MAAM,CAAC,MAAM,EAAE,SAAS,kBAAkB,EAAE,CAAC,GAAG;KAE7C,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,KAAK;CAC7B,CACF,CAAC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@kontor/kontor-sdk",
+  "version": "1.0.0-alpha.0",
+  "author": "Unspendable Labs <dev@unspendablelabs.com>",
+  "description": "The official SDK to the Kontor Bitcoin metaprotocol",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KontorProtocol/kontor-sdk.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "pnpm run clean && pnpm run build:cjs && pnpm run build:esm+types",
+    "build:cjs": "tsc --project tsconfig.build.json --module commonjs --moduleResolution node10 --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm+types": "tsc --project tsconfig.build.json --module nodenext --outDir ./dist/esm --declaration --declarationMap --declarationDir ./dist/types && echo > ./dist/esm/package.json '{\"type\":\"module\",\"sideEffects\":false}'",
+    "check": "biome check --write",
+    "check:types": "tsc --noEmit",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "format": "biome format --write",
+    "test": "vitest"
+  },
+  "files": [
+    "dist",
+    "**/*.ts"
+  ],
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/cjs/exports/index.js",
+  "module": "./dist/esm/exports/index.js",
+  "types": "./dist/types/exports/index.d.ts",
+  "typings": "./dist/types/exports/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/exports/index.d.ts",
+      "import": "./dist/esm/exports/index.js",
+      "default": "./dist/cjs/exports/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "keywords": [],
+  "packageManager": "pnpm@10.19.0",
+  "peerDependencies": {
+    "typescript": ">=5.0.4"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@arktype/attest": "^0.51.0",
+    "@biomejs/biome": "^2.2.7",
+    "@types/bun": "^1.3.0",
+    "vitest": "^4.0.1"
+  },
+  "dependencies": {
+    "@kontor/kontor-ts": "^0.1.0",
+    "@noble/curves": "^2.0.1",
+    "@scure/base": "^2.0.0",
+    "@scure/bip32": "^2.0.1",
+    "@scure/bip39": "^2.0.1",
+    "@scure/btc-signer": "^2.0.1",
+    "micro-packed": "^0.8.0",
+    "sats-connect": "^4.2.1",
+    "zod": "^4.1.12"
+  }
+}

package/src/exports/index.test.ts

@@ -0,0 +1,11 @@
+import { expect, it } from "vitest";
+
+import * as Exports from "./index.js";
+
+it("exports", () => {
+  expect(Object.keys(Exports)).toMatchInlineSnapshot(`
+    [
+      "one",
+    ]
+  `);
+});

package/src/exports/index.ts

@@ -0,0 +1,53 @@
+export { type ParseWit, parseWit } from "../wit/wit-parser/parse-wit.js";
+
+export { nativeToken } from "../sdk/contracts/wits.js";
+
+export { signet } from "../sdk/chains/definitions/index.js";
+
+export {
+  type CustomTransportConfig,
+  type CustomTransport,
+  type CustomTransportErrorType,
+  custom,
+} from "../sdk/clients/transports/custom.js";
+
+export {
+  type HttpTransportConfig,
+  type HttpTransport,
+  type HttpTransportErrorType,
+  http,
+} from "../sdk/clients/transports/http.js";
+
+export {
+  type MnemonicToAccountOptions,
+  type MnemonicToAccountErrorType,
+  mnemonicToAccount,
+} from "../sdk/accounts/mnemonic-to-account.js";
+
+export {
+  type KontorPublicClientConfig,
+  type KontorPublicClient,
+  type CreateKontorPublicClientErrorType,
+  createPublicClient as createKontorPublicClient,
+} from "../sdk/clients/kontor/create-public-client.js";
+
+export {
+  type KontorWalletClientConfig,
+  type KontorWalletClient,
+  type CreateKontorWalletClientErrorType,
+  createWalletClient as createKontorWalletClient,
+} from "../sdk/clients/kontor/create-wallet-client.js";
+
+export {
+  type PublicClientConfig,
+  type PublicClient,
+  type CreatePublicClientErrorType,
+  createPublicClient as createBtcPublicClient,
+} from "../sdk/clients/create-public-client.js";
+
+export {
+  type WalletClientConfig,
+  type WalletClient,
+  type CreateWalletClientErrorType,
+  createWalletClient as createBtcWalletClient,
+} from "../sdk/clients/create-wallet-client.js";

package/src/sdk/accounts/hd-key-to-account.ts

@@ -0,0 +1,46 @@
+import type { ErrorType } from "../errors/utils.js";
+import type { HDKey } from "../types/account.js";
+import { type ToHexErrorType, toHex } from "../utils/encoding/to-hex.js";
+import {
+  type PrivateKeyToAccountErrorType,
+  type PrivateKeyToAccountOptions,
+  privateKeyToAccount,
+} from "./private-key-to-account.js";
+
+import type { HDAccount, HDOptions } from "./types.js";
+
+export type HDKeyToAccountOptions = HDOptions & PrivateKeyToAccountOptions;
+
+export type HDKeyToAccountErrorType =
+  | PrivateKeyToAccountErrorType
+  | ToHexErrorType
+  | ErrorType;
+
+/**
+ * @description Creates an Account from a HD Key.
+ *
+ * @returns A HD Account.
+ */
+export function hdKeyToAccount(
+  hdKey_: HDKey,
+  {
+    coinType = 0, // 0 = mainnet, 1 =
+    accountIndex = 0,
+    addressIndex = 0,
+    changeIndex = 0,
+    path,
+    ...options
+  }: HDKeyToAccountOptions = {},
+): HDAccount {
+  // https://bips.dev/86/
+  const hdKey = hdKey_.derive(
+    path ||
+      `m/86'/${coinType}'/${accountIndex}'/${changeIndex}/${addressIndex}`,
+  );
+  const account = privateKeyToAccount(toHex(hdKey.privateKey!), options);
+  return {
+    ...account,
+    getHdKey: () => hdKey,
+    source: "hd",
+  };
+}

package/src/sdk/accounts/mnemonic-to-account.test.ts

@@ -0,0 +1,99 @@
+import { expect, test } from "vitest";
+
+import { mnemonicToAccount } from "./mnemonic-to-account.js";
+
+const mnemonic = "test test test test test test test test test test test junk";
+
+// TODO: should take a network argument
+test("default", () => {
+  expect(mnemonicToAccount(mnemonic)).toMatchInlineSnapshot(`
+{
+  "address": "tb1pfewlxm8meyyvgjydfu7v8j4ej64symj6ut8sf66h9germp94qgzsgnnjhk",
+  "getHdKey": [Function],
+  "signMessage": [Function],
+  "signPsbt": [Function],
+  "source": "hd",
+  "type": "local",
+  "xOnlyPubKey": "8c7fc6552af4384a13791e63bac79ff2bcfeedf143a88d6dc4b6080a8829cdc1",
+}
+							    `);
+});
+
+// describe('args: addressIndex', () => {
+//   Array.from({ length: 10 }).forEach((_, index) => {
+//     test(`addressIndex: ${index}`, () => {
+//       const account = mnemonicToAccount(mnemonic, {
+//         addressIndex: index,
+//       })
+//       expect(account.address).toEqual(getAddress(accounts[index].address))
+//     })
+//   })
+// })
+//
+// describe('args: path', () => {
+//   Array.from({ length: 10 }).forEach((_, index) => {
+//     test(`path: m/44'/60'/0'/0/${index}`, () => {
+//       const account = mnemonicToAccount(mnemonic, {
+//         path: `m/44'/60'/0'/0/${index}`,
+//       })
+//       expect(account.address).toEqual(getAddress(accounts[index].address))
+//     })
+//   })
+// })
+//
+// test('args: accountIndex', () => {
+//   expect(
+//     mnemonicToAccount(mnemonic, { accountIndex: 1 }).address,
+//   ).toMatchInlineSnapshot('"0x8C8d35429F74ec245F8Ef2f4Fd1e551cFF97d650"')
+//   expect(
+//     mnemonicToAccount(mnemonic, { accountIndex: 2 }).address,
+//   ).toMatchInlineSnapshot('"0x98e503f35D0a019cB0a251aD243a4cCFCF371F46"')
+//   expect(
+//     mnemonicToAccount(mnemonic, { accountIndex: 3 }).address,
+//   ).toMatchInlineSnapshot('"0xCB9fA1eA9b8A3bf422a8639f23Df77ea66020eC2"')
+// })
+//
+// test('args: changeIndex', () => {
+//   expect(
+//     mnemonicToAccount(mnemonic, { changeIndex: 1 }).address,
+//   ).toMatchInlineSnapshot('"0x4b39F7b0624b9dB86AD293686bc38B903142dbBc"')
+//   expect(
+//     mnemonicToAccount(mnemonic, { changeIndex: 2 }).address,
+//   ).toMatchInlineSnapshot('"0xe0Ff44FDb999d485DCFe6B0840f0d14EEA8a08A0"')
+//   expect(
+//     mnemonicToAccount(mnemonic, { changeIndex: 3 }).address,
+//   ).toMatchInlineSnapshot('"0x4E0eBc370cAdc5d152505EA4FEbcf839E7E2D3F8"')
+// })
+//
+// test('sign message', async () => {
+//   const account = mnemonicToAccount(mnemonic)
+//   expect(
+//     await account.signMessage({ message: 'hello world' }),
+//   ).toMatchInlineSnapshot(
+//     '"0xa461f509887bd19e312c0c58467ce8ff8e300d3c1a90b608a760c5b80318eaf15fe57c96f9175d6cd4daad4663763baa7e78836e067d0163e9a2ccf2ff753f5b1b"',
+//   )
+// })
+//
+// test('sign transaction', async () => {
+//   const account = mnemonicToAccount(mnemonic)
+//   expect(
+//     await account.signTransaction({
+//       chainId: 1,
+//       maxFeePerGas: parseGwei('20'),
+//       gas: 21000n,
+//       to: accounts[1].address,
+//       value: parseEther('1'),
+//     }),
+//   ).toMatchInlineSnapshot(
+//     '"0x02f86f0180808504a817c8008252089470997970c51812dc3a010c7d01b50e0d17dc79c8880de0b6b3a764000080c001a0f40a2d2ae9638056cafbe9083c7125edc8555e0e715db0984dd859a5c6dfac57a020f36fd0b32bef4d6d75c62f220e59c5fb60c244ca3b361e750985ee5c3a0931"',
+//   )
+// })
+//
+// test('sign typed data', async () => {
+//   const account = mnemonicToAccount(mnemonic)
+//   expect(
+//     await account.signTypedData({ ...typedData.basic, primaryType: 'Mail' }),
+//   ).toMatchInlineSnapshot(
+//     '"0x32f3d5975ba38d6c2fba9b95d5cbed1febaa68003d3d588d51f2de522ad54117760cfc249470a75232552e43991f53953a3d74edf6944553c6bef2469bb9e5921b"',
+//   )
+// })

package/src/sdk/accounts/mnemonic-to-account.ts

@@ -0,0 +1,30 @@
+import { HDKey } from "@scure/bip32";
+import { mnemonicToSeedSync } from "@scure/bip39";
+
+import type { ErrorType } from "../errors/utils.js";
+import {
+  type HDKeyToAccountErrorType,
+  type HDKeyToAccountOptions,
+  hdKeyToAccount,
+} from "./hd-key-to-account.js";
+import type { HDAccount } from "./types.js";
+
+export type MnemonicToAccountOptions = HDKeyToAccountOptions;
+
+export type MnemonicToAccountErrorType = HDKeyToAccountErrorType | ErrorType;
+
+/**
+ * @description Creates an Account from a mnemonic phrase.
+ *
+ * @returns A HD Account.
+ */
+export function mnemonicToAccount(
+  mnemonic: string,
+  _opts: MnemonicToAccountOptions = {},
+): HDAccount {
+  const seed = mnemonicToSeedSync(mnemonic);
+  return hdKeyToAccount(HDKey.fromMasterSeed(seed), {
+    // TODO: this should not be hardcoded
+    coinType: 1,
+  });
+}

package/src/sdk/accounts/private-key-to-account.ts

@@ -0,0 +1,90 @@
+import { secp256k1 } from "@noble/curves/secp256k1.js";
+import { hex } from "@scure/base";
+
+import type { ErrorType } from "../errors/utils.js";
+import type { BtcNetwork, Hex } from "../types/misc.js";
+
+import {
+  // type ToHexErrorType,
+  toHex,
+} from "../utils/encoding/to-hex.js";
+
+import {
+  // type ToLocalAccountErrorType,
+  toLocalAccount,
+} from "./to-local-account.js";
+
+import type { PrivateKeyAccount } from "./types.js";
+
+import {
+  type PublicKeyToP2TRPaymentErrorType,
+  publicKeyToP2TRPayment,
+} from "./utils/public-key-to-p2tr-payment.js";
+import { signPsbt } from "./utils/sign-psbt.js";
+
+// import { type SignErrorType, sign } from './utils/sign.js'
+// import { signAuthorization } from './utils/signAuthorization.js'
+//
+// import { type SignMessageErrorType, signMessage } from './utils/signMessage.js'
+//
+// import {
+//   type SignTransactionErrorType,
+//   signTransaction,
+// } from './utils/signTransaction.js'
+// import {
+//   type SignTypedDataErrorType,
+//   signTypedData,
+// } from './utils/signTypedData.js'
+//
+export type PrivateKeyToAccountOptions = {};
+//
+export type PrivateKeyToAccountErrorType =
+  | PublicKeyToP2TRPaymentErrorType
+  // | ToAccountErrorType
+  // | ToHexErrorType
+  // | PublicKeyToAddressErrorType
+  // | SignErrorType
+  // | SignMessageErrorType
+  // | SignTransactionErrorType
+  // | SignTypedDataErrorType
+  | ErrorType;
+//
+// /**
+//  * @description Creates an Account from a private key.
+//  *
+//  * @returns A Private Key Account.
+//  */
+
+const signet: BtcNetwork = {
+  bech32: "tb",
+  pubKeyHash: 0x6f, // 111 in decimal
+  scriptHash: 0xc4, // 196 in decimal
+  wif: 0xef, // 239 in decimal
+};
+export function privateKeyToAccount(
+  privateKey: Hex,
+  _options: PrivateKeyToAccountOptions = {},
+): PrivateKeyAccount {
+  const publicKey = toHex(
+    secp256k1.getPublicKey(hex.decode(privateKey.slice(2)), true),
+  );
+
+  // TODO: don't hardcode network
+  const address = publicKeyToP2TRPayment(publicKey.slice(2), signet);
+
+  const account = toLocalAccount({
+    address: address.address,
+    xOnlyPubKey: hex.encode(address.tapInternalKey),
+    signMessage: async (_) => {
+      throw new Error("signMessage not implemented for PrivateKeyAccount");
+    },
+    signPsbt: (params) => {
+      return signPsbt({ privateKey: privateKey.slice(2), ...params });
+    },
+  });
+
+  return {
+    ...account,
+    source: "privateKey",
+  } as PrivateKeyAccount;
+}

package/src/sdk/accounts/to-local-account.ts

@@ -0,0 +1,61 @@
+import type { Address } from "../types/misc.js";
+
+import {
+  InvalidAddressError,
+  type InvalidAddressErrorType,
+} from "../errors/address.js";
+
+import type { ErrorType } from "../errors/utils.js";
+// import {
+//   type IsAddressErrorType,
+//   isAddress,
+// } from "../utils/address/isAddress.js";
+
+import type {
+  AccountSource,
+  CustomSource,
+  JsonRpcAccount,
+  LocalAccount,
+} from "./types.js";
+
+// TODO: replace with real implementation
+type IsAddressErrorType = ErrorType;
+const isAddress = (_: string, __: {}) => true;
+
+type GetAccountReturnType<accountSource extends AccountSource> =
+  | (accountSource extends Address ? JsonRpcAccount : never)
+  | (accountSource extends CustomSource ? LocalAccount : never);
+
+export type ToLocalAccountErrorType =
+  | InvalidAddressErrorType
+  | IsAddressErrorType
+  | ErrorType;
+
+/**
+ * @description Creates an Account from a custom signing implementation.
+ *
+ * @returns A Local Account.
+ */
+export function toLocalAccount<accountSource extends AccountSource>(
+  source: accountSource,
+): GetAccountReturnType<accountSource> {
+  if (typeof source === "string") {
+    if (!isAddress(source, { strict: false }))
+      throw new InvalidAddressError({ address: source });
+    return {
+      address: source,
+      type: "json-rpc",
+    } as GetAccountReturnType<accountSource>;
+  }
+
+  if (!isAddress(source.address, { strict: false }))
+    throw new InvalidAddressError({ address: source.address });
+  return {
+    address: source.address,
+    xOnlyPubKey: source.xOnlyPubKey,
+    signMessage: source.signMessage,
+    signPsbt: source.signPsbt,
+    source: "custom",
+    type: "local",
+  } as GetAccountReturnType<accountSource>;
+}

package/src/sdk/accounts/types.ts

@@ -0,0 +1,72 @@
+import type { OneOf, Prettify } from "../../wit/type-utils.js";
+import type { HDKey } from "../types/account.js";
+import type {
+  Address,
+  Hex,
+  SignableMessage,
+  XOnlyPubKey,
+} from "../types/misc.js";
+import type { SignPsbtParams } from "../types/wbip001.js";
+
+export type Account<
+  address extends Address = Address,
+  xOnlyPubKey extends XOnlyPubKey = XOnlyPubKey,
+> = OneOf<
+  | JsonRpcAccount<address, xOnlyPubKey>
+  | LocalAccount<string, address, xOnlyPubKey>
+>;
+export type AccountSource = Address | CustomSource;
+
+export type CustomSource = {
+  address: Address;
+  xOnlyPubKey: XOnlyPubKey;
+  signMessage: ({ message }: { message: SignableMessage }) => Promise<Hex>;
+  signPsbt: ({ psbt, signInputs, broadcast }: SignPsbtParams) => Promise<{
+    txid: string;
+    psbt: Hex;
+  }>;
+};
+
+export type JsonRpcAccount<
+  address extends Address = Address,
+  xOnlyPubKey extends XOnlyPubKey = XOnlyPubKey,
+> = {
+  address: address;
+  xOnlyPubKey: xOnlyPubKey;
+  type: "json-rpc";
+};
+
+export type LocalAccount<
+  source extends string = string,
+  address extends Address = Address,
+  xOnlyPubKey extends XOnlyPubKey = XOnlyPubKey,
+> = Prettify<
+  CustomSource & {
+    address: address;
+    xOnlyPubKey: xOnlyPubKey;
+    source: source;
+    type: "local";
+  }
+>;
+
+export type PrivateKeyAccount = Prettify<
+  LocalAccount<"privateKey"> & {
+    signPsbt: NonNullable<CustomSource["signPsbt"]>;
+  }
+>;
+
+export type HDAccount = Prettify<
+  LocalAccount<"hd"> & {
+    getHdKey(): HDKey;
+    // TODO(v3): This will be redundant.
+    signPsbt: NonNullable<CustomSource["signPsbt"]>;
+  }
+>;
+
+export type HDOptions = {
+  coinType?: 0 | 1 | undefined;
+  accountIndex?: number | undefined;
+  addressIndex?: number | undefined;
+  changeIndex?: number | undefined;
+  path?: undefined;
+};

package/src/sdk/accounts/utils/parse-account.ts

@@ -0,0 +1,34 @@
+import type { Prettify } from "../../../wit/type-utils.js";
+import type { ErrorType } from "../../errors/utils.js";
+import type { Address, XOnlyPubKey } from "../../types/misc.js";
+import type { Account, JsonRpcAccount } from "../types.js";
+
+export type ParseAccountErrorType = ErrorType;
+
+type AddressAndXOnly = [Address, XOnlyPubKey];
+
+export function parseAccount<
+  accountOrAddress extends AddressAndXOnly | Account,
+>(
+  account: accountOrAddress,
+): accountOrAddress extends [Address, XOnlyPubKey]
+  ? Account
+  : accountOrAddress {
+  if (Array.isArray(account))
+    return {
+      address: account[0],
+      xOnlyPubKey: account[1],
+      type: "json-rpc",
+    } as any;
+  return account as any;
+}
+
+export type ParseAccount<
+  accountOrAddress extends Account | AddressAndXOnly | null | undefined =
+    | Account
+    | AddressAndXOnly
+    | null
+    | undefined,
+> = accountOrAddress extends AddressAndXOnly
+  ? Prettify<JsonRpcAccount<accountOrAddress[0], accountOrAddress[1]>>
+  : accountOrAddress;

package/src/sdk/accounts/utils/public-key-to-p2tr-payment.ts

@@ -0,0 +1,24 @@
+import { p2tr } from "@scure/btc-signer";
+import { hex } from "@scure/base";
+
+import type { ErrorType } from "../../errors/utils.js";
+import type { BtcNetwork, Hex } from "../../types/misc.js";
+
+export type PublicKeyToP2TRPaymentErrorType = ErrorType;
+
+const ecdsaPublicKeyLength = 33;
+
+function ecdsaPublicKeyToSchnorr(pubKey: Uint8Array) {
+  if (pubKey.byteLength !== ecdsaPublicKeyLength)
+    throw new Error(
+      `Invalid public key length. \nExpected ${ecdsaPublicKeyLength} bytes. \nGot ${pubKey.length} `,
+    );
+  return pubKey.slice(1);
+}
+
+export function publicKeyToP2TRPayment(publicKey: Hex, network?: BtcNetwork) {
+  const pubKey = hex.decode(publicKey);
+
+  console.log("pubkey length:", pubKey.length);
+  return p2tr(ecdsaPublicKeyToSchnorr(pubKey), undefined, network);
+}