bsv-bap 0.0.1

package/jest.config.ts

@@ -0,0 +1,196 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/9k/tb80d9g96wddlz7zqg43nhwm0000gp/T/jest_dy",
+
+  // Automatically clear mock calls, instances and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  setupFiles: [
+    "./setup-jest.js",
+  ],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/jsdoc.json

@@ -0,0 +1,16 @@
+{
+  "title": "Bux Javascript client",
+  "source": {
+    "includePattern": ".+\\.ts(doc|x)?$",
+    "excludePattern": ".+\\.(test|spec).ts"
+  },
+  "plugins": [
+    "node_modules/better-docs/typescript"
+  ],
+  "tags": {
+    "allowUnknownTags": ["optional"]
+  },
+  "opts": {
+    "template": "node_modules/better-docs"
+  }
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "bsv-bap",
+  "version": "0.0.1",
+  "description": "BAP npm module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitcoinSchema/bap.git"
+  },
+  "license": "Open BSV",
+  "precommit": "test",
+  "main": "dist/typescript-npm-package.cjs.js",
+  "module": "dist/typescript-npm-package.esm.js",
+  "browser": "dist/typescript-npm-package.umd.js",
+  "scripts": {
+    "build": "rollup -c",
+    "build:types": "tsc -p ./tsconfig.json --outDir build --declaration true && api-extractor run",
+    "clean": "rimraf ./build ./dist ./docs",
+    "deploy": "bun run pub --access public",
+    "dev": "rollup -c -w",
+    "docs": "rimraf ./docs && jsdoc src -r -c jsdoc.json -d docs",
+    "prebuild:types": "rimraf ./build",
+    "predocs": "rimraf ./docs",
+    "pub": "bun run build && bun run publish",
+    "lint": "eslint ./src",
+    "lintfix": "eslint ./src --fix",
+    "testquiet": "jest --detectOpenHandles --forceExit --silent",
+    "testwatch": "jest --watchAll --collectCoverage --logHeapUsage --detectOpenHandles",
+    "test": "bun run lint && bun test",
+    "test-watch": "bun run testwatch",
+    "check": "./node_modules/.bin/npm-check -u",
+    "prepare": "bun run clean && bun run lint && bun test && bun run build"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.5",
+    "@babel/plugin-transform-runtime": "^7.19.1",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-commonjs": "^22.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^14.0.0",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/bsv": "github:chainbow/bsv-types",
+    "@types/jest": "^29.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.38.1",
+    "@typescript-eslint/parser": "^5.38.1",
+    "babel-jest": "^29.0.0",
+    "bsv": "^1.5.6",
+    "eslint": "^8.24.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.22.1",
+    "jest": "^26.6.3",
+    "jest-cli": "^26.6.3",
+    "jest-fetch-mock": "^3.0.3",
+    "jest-slow-test-reporter": "^1.0.0",
+    "npm-check": "5.9.2",
+    "pre-commit": "^1.2.2",
+    "regenerator-runtime": "^0.13.7",
+    "rimraf": "3.0.2",
+    "rollup": "^2.70.0",
+    "rollup-plugin-dts": "^4.2.0",
+    "rollup-plugin-exclude-dependencies-from-bundle": "^1.1.22",
+    "rollup-plugin-node-builtins": "^2.1.2",
+    "rollup-plugin-polyfill-node": "^0.10.0",
+    "run-sequence": "2.2.1",
+    "ts-node": "^10.4.0",
+    "tslib": "^2.3.1",
+    "typedoc": "^0.23.1",
+    "typescript": "^4.6.2"
+  },
+  "dependencies": {
+    "@bsv/sdk": "^1.1.19",
+    "@types/randombytes": "^2.0.3",
+    "node-fetch": "^2.6.1",
+    "randombytes": "^2.1.0"
+  },
+  "peerDependencies": {
+    "bsv": "^1.5.6"
+  }
+}

package/rollup.config.js

@@ -0,0 +1,64 @@
+import resolve from "@rollup/plugin-node-resolve";
+import commonjs from "@rollup/plugin-commonjs";
+import typescript from "@rollup/plugin-typescript";
+import json from "@rollup/plugin-json";
+import nodePolyfills from 'rollup-plugin-polyfill-node';
+import excludeDependenciesFromBundle from "rollup-plugin-exclude-dependencies-from-bundle";
+import dts from 'rollup-plugin-dts';
+import builtins from 'rollup-plugin-node-builtins';
+import pkg from "./package.json";
+
+export default [
+  // browser-friendly UMD build
+  {
+    input: "src/index.ts",
+    output: {
+      name: "typescriptNpmPackage",
+      file: pkg.browser,
+      format: "umd",
+      sourcemap: true,
+    },
+    external: ['bsv'],
+    plugins: [
+      builtins(),
+      resolve({
+        skip: ['bsv'],
+        browser: true,
+        preferBuiltins: true,
+      }),
+      commonjs(),
+      json(),
+      typescript({tsconfig: "./tsconfig.json", sourceMap: false}),
+      nodePolyfills(),
+    ],
+  },
+
+  // CommonJS (for Node) and ES module (for bundlers) build.
+  // (We could have three entries in the configuration array
+  // instead of two, but it's quicker to generate multiple
+  // builds from a single configuration where possible, using
+  // an array for the `output` option, where we can specify
+  // `file` and `format` for each target)
+  {
+    input: "src/index.ts",
+    output: [
+      {file: pkg.main, format: "cjs", sourcemap: true},
+      {file: pkg.module, format: "es", sourcemap: true},
+    ],
+    plugins: [
+      typescript({tsconfig: "./tsconfig.json", sourceMap: false}),
+      excludeDependenciesFromBundle({peerDependencies: true}),
+    ],
+  },
+
+  {
+    // path to your declaration files root
+    input: './dist/src/index.d.ts',
+    output: [
+      {file: 'dist/typescript-npm-package.cjs.d.ts', format: 'es'},
+      {file: 'dist/typescript-npm-package.esm.d.ts', format: 'es'},
+      {file: 'dist/typescript-npm-package.umd.d.ts', format: 'es'}
+    ],
+    plugins: [dts()],
+  },
+];

package/setup-jest.js

@@ -0,0 +1 @@
+require('jest-fetch-mock').enableMocks()

package/src/README.md

@@ -0,0 +1,80 @@
+# Bitcoin Attestation Protocol - BAP
+> A simple protocol to create a chain of trust for any kind of information on the Bitcoin blockchain
+
+Javascript classes for working with identities and attestations.
+
+**NOTE: This is work in progress and more documentation will follow.**
+
+# BAP
+
+The BAP class is a wrapper around all BAP functions, including managing IDs and attestations.
+
+```shell
+npm install bitcoin-bap --save
+```
+
+Example creating a new ID:
+```javascript
+const HDPrivateKey = 'xprv...';
+const bap = new BAP(HDPrivateKey);
+
+// Create a new identity
+const newId = bap.newId();
+// set the name of the ID
+newId.name = 'Social media identity';
+// set a description for this ID
+newId.description = 'Pseudonymous identity to use on social media sites';
+// set identity attributes
+newId.addAttribute('name', 'John Doe');
+newId.addAttribute('email', 'john@doe.com');
+
+// export the identities for storage
+const encryptedExport = bap.exportIds();
+```
+
+Signing:
+```javascript
+const HDPrivateKey = 'xprv...';
+const bap = new BAP(HDPrivateKey);
+const identity = bap.getId("<identityKey>");
+
+// B protocol data
+const opReturn = [
+  Buffer.from('19HxigV4QyBv3tHpQVcUEQyq1pzZVdoAut').toString('hex'),
+  Buffer.from('Hello World!').toString('hex'),
+  Buffer.from('text/plain').toString('hex'),
+  Buffer.from('utf8').toString('hex'),
+];
+// signOpReturnWithAIP expects and returns hex values
+const signedOpReturn = identity.signOpReturnWithAIP(opReturn);
+```
+
+Encryption, every identity has a separate encryption/decryption key:
+```javascript
+const HDPrivateKey = 'xprv...';
+const bap = new BAP(HDPrivateKey);
+const identity = bap.getId("<identityKey>");
+
+const publicKey = identity.getEncryptionPublicKey();
+
+const cipherText = identity.encrypt('Hello World!');
+
+const text = identity.decrypt(cipherText);
+```
+
+The encryption uses `ECIES` from the `@bsv/sdk` library:
+```javascript
+import { ECIES, Utils } from '@bsv/sdk'
+const { toArray, toBase64 } = Utils;
+
+return toBase64(bitcoreEncrypt(toArray(stringData)));
+```
+
+Other examples:
+```javascript
+// List the identity keys of all id's 
+const idKeys = bap.listIds();
+
+// get a certain id
+const id = bap.getId(idKeys[0]);
+```

package/src/attributes.json

@@ -0,0 +1,119 @@
+// https://schema.org/Person
+{
+  "name": {
+    "type": "string",
+    "description": "Full name of user"
+  },
+  "givenName": {
+    "type": "string",
+    "description": "Given name as shown in official documents"
+  },
+  "familyName": {
+    "type": "string",
+    "description": "Family name as shown in official documents"
+  },
+  "alternateName": {
+    "type": "string",
+    "description": "A self chosen nickname"
+  },
+  "gender": {
+    "type": "string",
+    "description": "Male / Female / other / ... - https://schema.org/GenderType"
+  },
+  "birthDate": {
+    "type": "string",
+    "description": "Birthday of the user - YYYY-MM-DD - https://schema.org/Date"
+  },
+  "email": {
+    "type": "string",
+    "description": "Email address of the the user"
+  },
+  "telephone": {
+    "type": "string",
+    "description": "Phone number of the user - international format +14255551212 (https://www.itu.int/rec/T-REC-E.164-201011-I/en)"
+  },
+  "mobile": {
+    "type": "string",
+    "description": "Mobile phone number of the user - international format +14255551212 (https://www.itu.int/rec/T-REC-E.164-201011-I/en) - NOTE, not defined in schema.org"
+  },
+  "address": {
+    "type": "string",
+    "description": "Address of the user - to be verified the address should be the full address as shown on local postage, from authorities - new lines allowed - https://schema.org/address"
+  },
+  "country": {
+    "type": "string",
+    "description": "ISO 3166-1 3-letter country code of the users residence"
+  },
+  "nationality": {
+    "type": "string",
+    "description": "ISO 3166-1 3-letter country code of the users nationality"
+  },
+  "website": {
+    "type": "string",
+    "description": "Website address of the the user - not defined at schema.org"
+  },
+  "avatar": {
+    "type": "string",
+    "description": "URL of the users avatar - can be a base64 URI - not defined at schema.org"
+  },
+  "passportNr": {
+    "type": "string",
+    "description": "Document number of the passport of the user - not defined at schema.org"
+  },
+  "passportExpiration": {
+    "type": "string",
+    "description": "Passport expiration date - YYYY-MM-DD - not defined at schema.org"
+  },
+  "passportCountry": {
+    "type": "string",
+    "description": "ISO 3166-1 3-letter country code of the passport issuer - not defined at schema.org"
+  },
+  "driversLicenseNr": {
+    "type": "string",
+    "description": "Document number of the drivers license of the user - not defined at schema.org"
+  },
+  "driversLicenseExpiration": {
+    "type": "string",
+    "description": "Expiration date of the drivers license of the user - not defined at schema.org"
+  },
+  "driversLicenseCountry": {
+    "type": "string",
+    "description": "ISO 3166-1 3-letter country code of the passport issuer - not defined at schema.org"
+  },
+  "socialSecurityNr": {
+    "type": "string",
+    "description": "Social security number of the user - not defined at schema.org"
+  },
+  "uniKey": {
+    "type": "string",
+    "description": "A hash of all the attributes of a persons passport, to create a deterministic unique id for the user that can be used across identities - not defined at schema.org"
+  },
+  "uniKeyExpirationDate": {
+    "type": "string",
+    "description": "The expiration date of the document used to create the uniKey - the nonce of the uniKeyExpirationDate should be the uniKey hash"
+  },
+  "isHuman": {
+    "type": "number",
+    "description": "Whether this ID is a real human - this can be used to attest this is not a bot - not defined at schema.org"
+  },
+  "over18": {
+    "type": "number",
+    "description": "1 if the user is over 18 - not defined at schema.org"
+  },
+  "over19": {
+    "type": "number",
+    "description": "1 if the user is over 19 - not defined at schema.org"
+  },
+  "over20": {
+    "type": "number",
+    "description": "1 if the user is over 20 - not defined at schema.org"
+  },
+  "over21": {
+    "type": "number",
+    "description": "1 if the user is over 21 - not defined at schema.org"
+  },
+  "over25": {
+    "type": "number",
+    "description": "1 if the user is over 25 - not defined at schema.org"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,11 @@
+export const BAP_BITCOM_ADDRESS = '1BAPSuaPnfGnSBM3GLV9yhxUdYe4vGbdMT';
+export const BAP_BITCOM_ADDRESS_HEX = `0x${Buffer.from(BAP_BITCOM_ADDRESS).toString('hex')}`;
+export const AIP_BITCOM_ADDRESS = '15PciHG22SNLQJXMoSUaWVi7WSqc7hCfva';
+export const AIP_BITCOM_ADDRESS_HEX = `0x${Buffer.from(AIP_BITCOM_ADDRESS).toString('hex')}`;
+export const BAP_SERVER = 'https://bap.network/api/v1';
+export const MAX_INT = 2147483648 - 1; // 0x80000000
+
+// This is just a choice for this library and could be anything else if so needed/wanted
+// but it is advisable to use the same derivation between libraries for compatibility
+export const SIGNING_PATH_PREFIX = 'm/424150\'/0\'/0\''; // BAP in hex
+export const ENCRYPTION_PATH = `m/424150'/${MAX_INT}'/${MAX_INT}'`;