@bsv/sdk 1.0.0

package/jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['dist/']
+}

package/mod.ts

@@ -0,0 +1,8 @@
+export * from "./src/primitives/index.js"
+export * from "./src/script/index.js"
+export * from "./src/script/templates/index.js"
+export * from "./src/transaction/index.js"
+export * from "./src/transaction/fee-models/index.js"
+export * from "./src/transaction/broadcasters/index.js"
+export * from "./src/messages/index.js"
+export * from "./src/compat/index.js"

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@bsv/sdk",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "BSV Blockchain Standard Development Kit",
+  "main": "dist/cjs/mod.js",
+  "module": "dist/esm/mod.js",
+  "types": "dist/types/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/mod.d.ts",
+      "import": "./dist/esm/mod.js",
+      "require": "./dist/cjs/mod.js"
+    },
+    "./*.ts": {
+      "types": "./dist/types/src/*.d.ts",
+      "import": "./dist/esm/src/*.js",
+      "require": "./dist/cjs/src/*.js"
+    },
+    "./primitives": {
+      "import": "./dist/esm/src/primitives/index.js",
+      "require": "./dist/cjs/src/primitives/index.js",
+      "types": "./dist/types/src/primitives/index.d.ts"
+    },
+    "./primitives/*": {
+      "import": "./dist/esm/src/primitives/*.js",
+      "require": "./dist/cjs/src/primitives/*.js",
+      "types": "./dist/types/src/primitives/*.d.ts"
+    },
+    "./script": {
+      "import": "./dist/esm/src/script/index.js",
+      "require": "./dist/cjs/src/script/index.js",
+      "types": "./dist/types/src/script/index.d.ts"
+    },
+    "./script/*": {
+      "import": "./dist/esm/src/script/*.js",
+      "require": "./dist/cjs/src/script/*.js",
+      "types": "./dist/types/src/script/*.d.ts"
+    },
+    "./script/templates": {
+      "import": "./dist/esm/src/script/templates/index.js",
+      "require": "./dist/cjs/src/script/templates/index.js",
+      "types": "./dist/types/src/script/templates/index.d.ts"
+    },
+    "./script/templates/*": {
+      "import": "./dist/esm/src/script/templates/*.js",
+      "require": "./dist/cjs/src/script/templates/*.js",
+      "types": "./dist/types/src/script/templates/*.d.ts"
+    },
+    "./transaction": {
+      "import": "./dist/esm/src/transaction/index.js",
+      "require": "./dist/cjs/src/transaction/index.js",
+      "types": "./dist/types/src/transaction/index.d.ts"
+    },
+    "./transaction/*": {
+      "import": "./dist/esm/src/transaction/*.js",
+      "require": "./dist/cjs/src/transaction/*.js",
+      "types": "./dist/types/src/transaction/*.d.ts"
+    },
+    "./transaction/broadcaster": {
+      "import": "./dist/esm/src/transaction/broadcaster/index.js",
+      "require": "./dist/cjs/src/transaction/broadcaster/index.js",
+      "types": "./dist/types/src/transaction/broadcaster/index.d.ts"
+    },
+    "./transaction/broadcaster/*": {
+      "import": "./dist/esm/src/transaction/broadcaster/*.js",
+      "require": "./dist/cjs/src/transaction/broadcaster/*.js",
+      "types": "./dist/types/src/transaction/broadcaster/*.d.ts"
+    },
+    "./transaction/fee-model": {
+      "import": "./dist/esm/src/transaction/fee-model/index.js",
+      "require": "./dist/cjs/src/transaction/fee-model/index.js",
+      "types": "./dist/types/src/transaction/fee-model/index.d.ts"
+    },
+    "./transaction/fee-model/*": {
+      "import": "./dist/esm/src/transaction/fee-model/*.js",
+      "require": "./dist/cjs/src/transaction/fee-model/*.js",
+      "types": "./dist/types/src/transaction/fee-model/*.d.ts"
+    },
+    "./messages": {
+      "import": "./dist/esm/src/messages/index.js",
+      "require": "./dist/cjs/src/messages/index.js",
+      "types": "./dist/types/src/messages/index.d.ts"
+    },
+    "./messages/*": {
+      "import": "./dist/esm/src/messages/*.js",
+      "require": "./dist/cjs/src/messages/*.js",
+      "types": "./dist/types/src/messages/*.d.ts"
+    },
+    "./compat": {
+      "import": "./dist/esm/src/compat/index.js",
+      "require": "./dist/cjs/src/compat/index.js",
+      "types": "./dist/types/src/compat/index.d.ts"
+    },
+    "./compat/*": {
+      "import": "./dist/esm/src/compat/*.js",
+      "require": "./dist/cjs/src/compat/*.js",
+      "types": "./dist/types/src/compat/*.d.ts"
+    }
+  },
+  "scripts": {
+    "test": "npm run build && jest",
+    "test:watch": "npm run build && jest --watch",
+    "test:coverage": "npm run build && jest --coverage",
+    "lint": "ts-standard --fix src/**/*.ts",
+    "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
+    "dev": "tsc -b -w",
+    "prepublish": "npm run build",
+    "doc": "ts2md --inputFilename=src/script/index.ts --outputFilename=docs/script.md --filenameSubString=script --firstHeadingLevel=1 && ts2md --inputFilename=src/primitives/index.ts --outputFilename=docs/primitives.md --filenameSubString=primitives --firstHeadingLevel=1 && ts2md --inputFilename=src/transaction/index.ts --outputFilename=docs/transaction.md --filenameSubString=transaction --firstHeadingLevel=1 && ts2md --inputFilename=src/messages/index.ts --outputFilename=docs/messages.md --filenameSubString=messages --firstHeadingLevel=1 && ts2md --inputFilename=src/compat/index.ts --outputFilename=docs/compat.md --filenameSubString=compat --firstHeadingLevel=1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bitcoin-sv/sdk.git"
+  },
+  "keywords": [
+    "BSV",
+    "Blockchain",
+    "SDK",
+    "Bitcoin",
+    "SV"
+  ],
+  "author": "BSV Blockchain Association",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "bugs": {
+    "url": "https://github.com/bitcoin-sv/sdk/issues"
+  },
+  "homepage": "https://github.com/bitcoin-sv/sdk#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "ts-standard": "^12.0.2",
+    "ts2md": "^0.2.0",
+    "tsconfig-to-dual-package": "^1.2.0",
+    "typescript": "^5.2.2"
+  }
+}

package/src/compat/BSM.ts

@@ -0,0 +1,51 @@
+import BigNumber from '../primitives/BigNumber.js'
+import { Writer, toArray } from '../primitives/utils.js'
+import * as ECDSA from '../primitives/ECDSA.js'
+import * as Hash from '../primitives/Hash.js'
+import PrivateKey from '../primitives/PrivateKey.js'
+import PublicKey from '../primitives/PublicKey.js'
+import Signature from '../primitives/Signature.js'
+
+const prefix = 'Bitcoin Signed Message:\n'
+
+/**
+ * Generates a SHA256 double-hash of the prefixed message.
+ * @deprecated Replaced by BRC-77 which uses a more secure and private method for message signing.
+ * @param messageBuf The message buffer to be hashed.
+ * @returns The double-hash of the prefixed message as a number array.
+ */
+export const magicHash = (messageBuf: number[]): number[] => {
+    const bw = new Writer()
+    bw.writeVarIntNum(prefix.length)
+    bw.write(toArray(prefix, 'utf8'))
+    bw.writeVarIntNum(messageBuf.length)
+    bw.write(messageBuf)
+    const buf = bw.toArray()
+    const hashBuf = Hash.hash256(buf) as number[]
+    return hashBuf
+}
+
+/**
+ * Signs a BSM message using the given private key.
+ * @deprecated Replaced by BRC-77 which employs BRC-42 key derivation and BRC-43 invoice numbers for enhanced security and privacy.
+ * @param message The message to be signed as a number array.
+ * @param privateKey The private key used for signing the message.
+ * @returns The signature object.
+ */
+export const sign = (message: number[], privateKey: PrivateKey): Signature => {
+    const hashBuf = magicHash(message)
+    return ECDSA.sign(new BigNumber(hashBuf), privateKey, true)
+}
+
+/**
+ * Verifies a BSM signed message using the given public key.
+ * @deprecated Replaced by BRC-77 which provides privately-verifiable signatures and avoids key reuse.
+ * @param message The message to be verified as a number array.
+ * @param sig The signature object.
+ * @param pubKey The public key for verification.
+ * @returns True if the signature is valid, false otherwise.
+ */
+export const verify = (message: number[], sig: Signature, pubKey: PublicKey): boolean => {
+    const hashBuf = magicHash(message)
+    return ECDSA.verify(new BigNumber(hashBuf), sig, pubKey)
+}