feat: init

michaelmcshinsky · michaelmcshinsky · commit 3a82976e34b7 · 2022-11-14T21:15:09.000-07:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -0,0 +1,32 @@
+name: CI
+on: [push]
+jobs:
+  build:
+    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node: ['16.x']
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Use Node ${{ matrix.node }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install deps and build (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Test
+        run: yarn test --ci --coverage --maxWorkers=2
+
+      - name: Build
+        run: yarn build
diff --git a/.github/workflows/size.yml b/.github/workflows/size.yml
@@ -0,0 +1,12 @@
+name: size
+on: [pull_request]
+jobs:
+  size:
+    runs-on: ubuntu-latest
+    env:
+      CI_JOB_NUMBER: 1
+    steps:
+      - uses: actions/checkout@v1
+      - uses: andresz1/size-limit-action@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+*.log
+.DS_Store
+node_modules
+dist
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement.. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version [1.4](https://www.contributor-covenant.org version/1/4/code-of-conduct/code_of_conduct.md) and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hypereon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,71 @@
+![Hypereon Message Banner](https://github.com/HypereonLabs/message/raw/master/media/repo-banner.png)
+
+# Hypereon - Message
+
+JavaScript functions for signing and verifying messages.
+
+## Installation
+
+```bash
+npm install @hypereon/message;
+```
+
+## Usage
+
+### Sign a message
+
+```javascript
+import { sign } from '@hypereon/message';
+
+const privateKey = 'L4rK1yDtCWekvXuE6oXD9jCYfFNV2cWRpVuPLBcCU2z8TrisoyY1';
+const message = 'This is an example of a signed message.';
+
+const signature = sign({ message, privateKey });
+// Expected Result: H9L5yLFjti0QTHhPyFrZCT1V/MMnBtXKmoiKDZ78NDBjERki6ZTQZdSMCtkgoNmp17By9ItJr8o7ChX0XxY91nk=
+```
+
+### Verify a message
+
+```javascript
+import { verify } from '@hypereon/message';
+
+const address = '<public_address_of_private_key_wif>';
+const message = 'This is an example of a signed message.';
+const signature = '<generated_signature_from_sign>';
+
+const isVerified = verify({ address, message, signature });
+```
+
+Message signing defaults to Bitcoin '\u0018Bitcoin Signed Message:\n'. See `@hypereon/message` for message prefixes to sign for a different blockchain.
+
+```javascript
+import { sign, verify } from '@hypereon/message';
+import message from '@hypereon/message';
+
+const { messagePrefix } = message.ltc.main;
+
+const signature = sign({
+  privateKey: '...',
+  message: '...',
+  messagePrefix,
+});
+
+const isVerified = verify({
+  address: '...',
+  message: '...',
+  signature: '...',
+  messagePrefix,
+});
+```
+
+## Contributing
+
+If you're interested in contributing, please read the [contributing docs](https://github.com/HypereonLabs/message/blob/master/CONTRIBUTING.md) before submitting a pull request.
+
+## Authors
+
+- [@mikemcshinsky](https://twitter.com/mikemcshinsky) – [Magitek](https://magitek.dev)
+
+## License
+
+[MIT](/LICENSE) License
diff --git a/media/repo-banner.png b/media/repo-banner.png
diff --git a/package.json b/package.json
@@ -0,0 +1,66 @@
+{
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "start": "tsdx watch",
+    "build": "tsdx build",
+    "test": "tsdx test",
+    "lint": "tsdx lint",
+    "prepare": "tsdx build",
+    "size": "size-limit",
+    "analyze": "size-limit --why"
+  },
+  "peerDependencies": {},
+  "husky": {
+    "hooks": {
+      "pre-commit": "tsdx lint"
+    }
+  },
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "name": "@hypereon/message",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HypereonLabs/message.git"
+  },
+  "author": "Hypereon",
+  "module": "dist/message.esm.js",
+  "size-limit": [
+    {
+      "path": "dist/message.cjs.production.min.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "dist/message.esm.js",
+      "limit": "10 KB"
+    }
+  ],
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^8.1.0",
+    "husky": "^8.0.2",
+    "size-limit": "^8.1.0",
+    "tsdx": "^0.14.1",
+    "tslib": "^2.4.1",
+    "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "bitcoinjs-message": "^2.2.0",
+    "coinkey": "^3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/src/global.d.ts b/src/global.d.ts
@@ -0,0 +1,2 @@
+declare module 'bitcoinjs-message';
+declare module 'coinkey';
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,65 @@
+import bitcoinMessage from 'bitcoinjs-message';
+import CoinKey from 'coinkey';
+import { Sign, Verify } from './types';
+
+/**
+ * Sign for proof of ownership of wallet address.
+ * @param param
+ * @param {string} param.message Hash used for signing your message.
+ * @param {string|Buffer} param.privateKey Wallet Import Format (WIF) string or private key Buffer.
+ * @param {boolean=} param.compressed
+ * @param {string=} [param.messagePrefix=\u0018Bitcoin Signed Message:\n] Message prefix used by the blockchain for signing.
+ * @param {any=} sigOptions Pass in any option after the initial object to make use of additional https://github.com/bitcoinjs/bitcoinjs-message parameters.
+ * @returns A base64 encoded string representation of the signature.
+ */
+export function sign(
+  {
+    message,
+    privateKey,
+    compressed = true,
+    messagePrefix = '\u0018Bitcoin Signed Message:\n',
+  }: Sign,
+  ...sigOptions: any
+): string | null {
+  try {
+    const privateKeyWif =
+      typeof privateKey === 'string'
+        ? CoinKey.fromWif(privateKey).privateKey
+        : privateKey;
+    const signature = bitcoinMessage.sign(
+      message,
+      privateKeyWif,
+      compressed,
+      messagePrefix,
+      ...sigOptions
+    );
+    return signature.toString('base64');
+  } catch (e) {
+    console.log('e', e);
+    return null;
+  }
+}
+
+/**
+ * Verify the ownership of the address.
+ * @param param
+ * @param {string} param.message Message used to generate signature.
+ * @param {string} param.address Address submitted for proof of ownership.
+ * @param {string} param.signature Signature generated from address and message.
+ * @param {string} [param.messagePrefix=\u0018Bitcoin Signed Message:\n] Message prefix used by the blockchain for verifying.
+ * @returns
+ */
+export function verify({
+  message,
+  address,
+  signature,
+  messagePrefix = '\u0018Bitcoin Signed Message:\n',
+}: Verify): boolean {
+  try {
+    const m = Buffer.from(message).toString('ascii');
+    const result = bitcoinMessage.verify(m, address, signature, messagePrefix);
+    return result;
+  } catch {
+    return false;
+  }
+}
diff --git a/src/types.ts b/src/types.ts
@@ -0,0 +1,13 @@
+export type Sign = {
+  message: string;
+  privateKey: string | Buffer;
+  compressed?: boolean;
+  messagePrefix?: string;
+};
+
+export type Verify = {
+  message: string;
+  address: string;
+  signature: string;
+  messagePrefix?: string;
+};
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -0,0 +1,28 @@
+import { sign, verify } from '../src';
+
+describe('message sign and verify', () => {
+  const privateKeyWIF = 'QVD3x1RPiWPvyxbTsfxVwaYLyeBZrQvjhZ2aZJUsbuRgsEAGpNQ2';
+  const message = 'Hello World';
+  const signature =
+    'H+6akpUg+O3bti+VNKA6odVnKhzlkZ0d2BOhwrp5T+i1XTPTBlLrsaXtBkO1O8cpe0ingWoh31Lpxf2S5jgvf2o=';
+  const address = 'DGG6AicS4Qg8Y3UFtcuwJqbuRZ3Q7WtYXv';
+
+  it('should sign a message for bitcoin', () => {
+    const result = sign({
+      privateKey: privateKeyWIF,
+      message,
+    });
+
+    expect(result).toEqual(signature);
+  });
+
+  it('should verify a message for bitcoin', () => {
+    const result = verify({
+      address,
+      message,
+      signature,
+    });
+
+    expect(result).toBe(true);
+  });
+});
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +*.log
 +.DS_Store
 +node_modules
 +dist
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+declare module 'bitcoinjs-message';`
	`2`	`+declare module 'coinkey';`