@atomicfinance/types 4.0.0 → 4.0.1

package/.yalc/@node-dlc/bitcoin/lib/Wif.ts

@@ -0,0 +1,77 @@
+import { Base58Check } from './Base58Check';
+
+export type WifDecodeResult = {
+  privateKey: Buffer;
+  compressed: boolean;
+  prefix: number;
+};
+
+export class Wif {
+  /**
+   * Encodes a private key using the WIF format. Can encode with compressed
+   * or uncompressed format and can be for testnet or mainnet.
+   *
+   * Mainnet prefix: 0x80
+   * Testnet prefix: 0xef
+   *
+   * Algorithm for WIF is:
+   * 1. Start with the prefix
+   * 2. Encode the secret in 32-byte big-endian format
+   * 3. If the SEC format used for the public key address was compressed add
+   *    a suffix of 0x01
+   * 4. Combine wthe prefix from #1, serialized secret from #2, and suffix from #3
+   * 5. Do hash256 of the result from #4 and get the first 4 bytes
+   * 6. Take the combination of #4 and #5 and encode it with Base58
+   *
+   * @param privateKey a 32-byte private key as a big-endian buffer
+   * @param compressed default of true
+   * @param testnet default of false
+   */
+  public static encode(
+    privateKey: Buffer,
+    compressed = true,
+    testnet = false,
+  ): string {
+    // 1. prefix
+    const prefix = Buffer.from([testnet ? 0xef : 0x80]);
+
+    // 2. encode as 32-byte big-endian number
+
+    // 3. suffix
+    const suffix = compressed ? Buffer.from([0x01]) : Buffer.alloc(0);
+
+    // 4. combine 1, 2, and 3
+    return Base58Check.encode(Buffer.concat([prefix, privateKey, suffix]));
+  }
+
+  /**
+   * To decode a WIF value, we must first decode the base58check
+   * input. If this validates then we need to split the resulting
+   * buffer of data into two or three parts.
+   *
+   * The first byte is the prefix
+   * The next 32-bytes are the private key
+   *
+   *
+   * @param buf
+   */
+  public static decode(input: string): WifDecodeResult {
+    const raw = Base58Check.decode(input);
+
+    if (raw.length !== 33 && raw.length !== 34) {
+      throw new Error('Invalid WIF encoding');
+    }
+
+    // prefix is the first byte
+    const prefix = raw[0];
+
+    // next 32-bytes are the private key
+    const privateKey = raw.slice(1, 33);
+
+    // check for compressed byte
+    const compressed = raw.length === 34 && raw[33] === 0x01;
+
+    // return our result object
+    return { privateKey, compressed, prefix };
+  }
+}

package/.yalc/@node-dlc/bitcoin/lib/Witness.ts

@@ -0,0 +1,65 @@
+import { BufferWriter, StreamReader } from '@node-dlc/bufio';
+
+import { ICloneable } from './ICloneable';
+
+/**
+ * Represents segregated witness data. This data is nothing more than a
+ * buffer.
+ */
+export class Witness implements ICloneable<Witness> {
+  /**
+   * Parses witness data
+   * @param reader
+   */
+  public static parse(reader: StreamReader): Witness {
+    const len = reader.readVarInt();
+    const data = reader.readBytes(Number(len));
+    return new Witness(data);
+  }
+
+  /**
+   * Hex-encoded Witness data. This method interally creates a
+   * StreamReader and uses the parse function
+   * @param hex encoded as a string
+   */
+  public static fromHex(hex: string): Witness {
+    return Witness.parse(StreamReader.fromHex(hex));
+  }
+
+  constructor(readonly data: Buffer) {}
+
+  /**
+   * Serializes witness data into a buffer in the format:
+   *
+   * [varint] length
+   * [length] data
+   */
+  public serialize(): Buffer {
+    const writer = new BufferWriter();
+    writer.writeVarInt(this.data.length);
+    writer.writeBytes(this.data);
+    return writer.toBuffer();
+  }
+
+  /**
+   * Returns the string of a piece of witness data
+   */
+  public toString(): string {
+    return this.data.toString('hex');
+  }
+
+  /**
+   * Returns the string of a piece of witness data
+   */
+  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+  public toJSON() {
+    return this.toString();
+  }
+
+  /**
+   * Clone via deep copy
+   */
+  public clone(): Witness {
+    return new Witness(Buffer.from(this.data));
+  }
+}

package/.yalc/@node-dlc/bitcoin/lib/index.ts

@@ -0,0 +1,28 @@
+export * from './Amount';
+export * from './Base58';
+export * from './Base58Check';
+export * from './BitcoinError';
+export * from './BitcoinErrorCode';
+export * from './Block';
+export * from './HashByteOrder';
+export * from './HashValue';
+export * from './ICloneable';
+export * from './LexicographicalSorters';
+export * from './LockTime';
+export * from './OpCodes';
+export * from './OutPoint';
+export * from './Script';
+export * from './ScriptCmd';
+export * from './Sequence';
+export * from './SigHashType';
+export * from './SizeResult';
+export * from './Sorter';
+export * from './Stack';
+export * from './TimeLockMode';
+export * from './Tx';
+export * from './TxBuilder';
+export * from './TxIn';
+export * from './TxOut';
+export * from './Value';
+export * from './Wif';
+export * from './Witness';

package/.yalc/@node-dlc/bitcoin/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@node-dlc/bitcoin",
+  "version": "1.0.1",
+  "description": "DLC bitcoin",
+  "scripts": {
+    "test": "../../node_modules/.bin/nyc --reporter=lcov --reporter=text --extension=.ts ../../node_modules/.bin/mocha --require ts-node/register --recursive \"__tests__/**/*.spec.*\"",
+    "lint": "../../node_modules/.bin/eslint --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
+    "lint:fix": "../../node_modules/.bin/eslint --fix --ignore-path ../../.eslintignore  -c ../../.eslintrc.js .",
+    "build": "../../node_modules/.bin/tsc --project tsconfig.json"
+  },
+  "keywords": [
+    "dlc",
+    "bitcoin"
+  ],
+  "author": "Atomic Finance <info@atomic.finance>",
+  "homepage": "https://github.com/atomicfinance/node-dlc/tree/master/packages/bitcoin",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/atomicfinance/node-dlc.git"
+  },
+  "dependencies": {
+    "@node-dlc/bufio": "^1.0.1",
+    "@node-dlc/crypto": "^1.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "yalcSig": "66e5ab6938272fbda17f5a659e259926"
+}

package/.yalc/@node-dlc/bitcoin/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "skipLibCheck": true
+  },
+  "include": ["./lib"]
+}

package/.yalc/@node-dlc/bitcoin/yalc.sig

@@ -0,0 +1 @@
+66e5ab6938272fbda17f5a659e259926