passphrase derivation + encryption + storage lib

.github/CODEOWNERS

@@ -32,7 +32,9 @@
 /packages/jellyfish-transaction-signature/      @fuxingloh @ivan-zynesis
 /packages/jellyfish-wallet/                     @fuxingloh @ivan-zynesis @monstrobishi
 /packages/jellyfish-wallet-classic/             @fuxingloh @ivan-zynesis @monstrobishi
+/packages/jellyfish-wallet-encrypted/           @fuxingloh @ivan-zynesis
 /packages/jellyfish-wallet-mnemonic/            @fuxingloh @ivan-zynesis
+
 /packages/testcontainers/                       @fuxingloh
 /packages/testing/                              @fuxingloh @canonbrother
 

.github/governance.yml

@@ -49,6 +49,7 @@ issue:
         - jellyfish-transaction-builder
         - jellyfish-transaction-signature
         - jellyfish-wallet
+        - jellyfish-wallet-encrypted
         - jellyfish-wallet-classic
         - jellyfish-wallet-mnemonic
         - testcontainers

.github/labeler.yml

@@ -61,6 +61,11 @@ labels:
     matcher:
       files: "packages/jellyfish-transaction-signature/**"
 
+  - label: area/jellyfish-wallet-encrypted
+    sync: true
+    matcher:
+      files: "packages/jellyfish-wallet-encrypted/**"
+
   - label: area/jellyfish-wallet-classic
     sync: true
     matcher:

.github/labels.yml

@@ -80,6 +80,8 @@
   name: area/jellyfish-wallet
 - color: fbca04
   name: area/jellyfish-wallet-classic
+- color: fbca04
+  name: area/jellyfish-wallet-encrypted
 - color: fbca04
   name: area/jellyfish-wallet-mnemonic
 - color: fbca04

README.md

@@ -89,6 +89,7 @@ Package                                            | Description
 `@defichain/jellyfish-transaction-builder`         | Provides a high-high level abstraction for constructing transaction ready to be broadcast for DeFi Blockchain.
 `@defichain/jellyfish-wallet-classic`              | WalletClassic implements a simple, single elliptic pair wallet.
 `@defichain/jellyfish-wallet`                      | Jellyfish wallet is a managed wallet, where account can get discovered from an HD seed.
+`@defichain/jellyfish-wallet-encrypted`            | Library to encrypt MnemonicHdNode as EncryptedMnemonicHdNode. Able to perform as MnemonicHdNode with passphrase known. 
 `@defichain/jellyfish-wallet-mnemonic`             | MnemonicHdNode implements the WalletHdNode from jellyfish-wallet; a CoinType-agnostic HD Wallet for noncustodial DeFi.
 `@defichain/testcontainers`                        | Provides a lightweight, throw away instances for DeFiD node provisioned automatically in a Docker container.
 `@defichain/testing`                               | Provides rich test fixture setup functions for effective and effortless testing.

jest.config.js

@@ -12,6 +12,7 @@ module.exports = {
     '@defichain/jellyfish-transaction-builder': '<rootDir>/packages/jellyfish-transaction-builder/src',
     '@defichain/jellyfish-transaction': '<rootDir>/packages/jellyfish-transaction/src',
     '@defichain/jellyfish-wallet-classic': '<rootDir>/packages/jellyfish-wallet-classic/src',
+    '@defichain/jellyfish-wallet-encrypted': '<rootDir>/packages/jellyfish-wallet-encrypted/src',
     '@defichain/jellyfish-wallet-mnemonic': '<rootDir>/packages/jellyfish-wallet-mnemonic/src',
     '@defichain/jellyfish-wallet': '<rootDir>/packages/jellyfish-wallet/src',
     '@defichain/testcontainers': '<rootDir>/packages/testcontainers/src',

packages/jellyfish-wallet-encrypted/README.md

@@ -0,0 +1,7 @@
+[![npm](https://img.shields.io/npm/v/@defichain/jellyfish-wallet-encrypted)](https://www.npmjs.com/package/@defichain/jellyfish-wallet-encrypted/v/latest)
+[![npm@next](https://img.shields.io/npm/v/@defichain/jellyfish-wallet-encrypted/next)](https://www.npmjs.com/package/@defichain/jellyfish-wallet-encrypted/v/next)
+
+# @defichain/jellyfish-wallet-encrypted
+
+This is an extended wallet hd node which has similar interface as @defichain/jellyfish-wallet-mnemonic. The library assists caller to encrypt mnemonic seed into provided storage. See example/demo.ts for more detail.
+

packages/jellyfish-wallet-encrypted/__tests__/scrypt-storage.test.ts

@@ -0,0 +1,100 @@
+import { ScryptStorage, Storage, SimpleScryptsy } from '../src'
+
+class MockStorage implements Storage {
+  inMemory: string | undefined
+  async getter (): Promise<string|undefined> {
+    return this.inMemory
+  }
+
+  async setter (encrypted: string | undefined): Promise<void> {
+    this.inMemory = encrypted
+  }
+}
+// Mock storage
+let scryptStorage: ScryptStorage
+const encryptedSeedStorage = new MockStorage()
+const seedHashStorage = new MockStorage()
+
+const scryptProvider = new SimpleScryptsy()
+
+// 32 bytes
+const samplePrivateKey = 'e9873d79c6d87dc0fb6a5778633389f4e93213303da61f20bd67fc233aa33262'
+
+beforeEach(async () => {
+  scryptStorage = new ScryptStorage(scryptProvider, encryptedSeedStorage, seedHashStorage)
+  await encryptedSeedStorage.setter(undefined)
+  await seedHashStorage.setter(undefined)
+})
+
+it('Should be able to encrypt / decrypt', async () => {
+  const pass = 'password'
+
+  const privateKey = Buffer.from(samplePrivateKey, 'hex')
+  await scryptStorage.encrypt(privateKey, pass)
+
+  // encrypted data stored
+  expect(await encryptedSeedStorage.getter()).not.toStrictEqual(null)
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted?.toString('hex')).toStrictEqual(samplePrivateKey)
+})
+
+it('Should be able to encrypt / decrypt - simple passphrase', async () => {
+  // let say a 6 digit pin
+  const pass = '135790'
+
+  const privateKey = Buffer.from(samplePrivateKey, 'hex')
+  await scryptStorage.encrypt(privateKey, pass)
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted?.toString('hex')).toStrictEqual(samplePrivateKey)
+})
+
+it('decrypt() - should return null when no data in storage', async () => {
+  // let say a 6 digit pin
+  const pass = 'password'
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted).toStrictEqual(null)
+})
+
+it('Should work with variable data length - long', async () => {
+  const longData = samplePrivateKey + samplePrivateKey + samplePrivateKey + samplePrivateKey
+  const pass = 'password'
+
+  const data = Buffer.from(longData, 'hex')
+  await scryptStorage.encrypt(data, pass)
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted?.toString('hex')).toStrictEqual(longData)
+})
+
+it('Should work with variable data length - short', async () => {
+  const shortData = 'ffaa'
+  const pass = 'password'
+
+  const data = Buffer.from(shortData, 'hex')
+  await scryptStorage.encrypt(data, pass)
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted?.toString('hex')).toStrictEqual(shortData)
+})
+
+it('Should reject "odd" number long data, only accept "even" number long data', async () => {
+  const pass = 'password'
+
+  const fourBytes = 'eeffaabb'
+  await scryptStorage.encrypt(Buffer.from(fourBytes, 'hex'), pass)
+
+  const threeBytes = 'ffaabb'
+  const data = Buffer.from(threeBytes, 'hex')
+  await expect(async () => {
+    await scryptStorage.encrypt(data, pass)
+  }).rejects.toThrow('Data length must be even number')
+
+  const padded = Buffer.from('00' + threeBytes, 'hex')
+  await scryptStorage.encrypt(padded, pass)
+
+  const decrypted = await scryptStorage.decrypt(pass)
+  expect(decrypted?.toString('hex')).toStrictEqual(padded.toString('hex'))
+})

packages/jellyfish-wallet-encrypted/__tests__/scryptsy.test.ts

@@ -0,0 +1,38 @@
+import { SimpleScryptsy } from '../src'
+
+describe('passphraseToKey()', () => {
+  it('Should be able to generate from random (same) passphrase into multiple desired length secret', () => {
+    const scryptsy = new SimpleScryptsy()
+    const secret1 = scryptsy.passphraseToKey('random password', Buffer.from('abcd', 'hex'), 64)
+    expect(secret1.length).toStrictEqual(64)
+
+    const secret2 = scryptsy.passphraseToKey('random password', Buffer.from('abcd', 'hex'), 40)
+    expect(secret2.length).toStrictEqual(40)
+  })
+
+  it('Configurable params (difficulty)', () => {
+    const easy = new SimpleScryptsy({
+      N: 16384, // 2 ^ 14
+      r: 8,
+      p: 1
+    })
+
+    const hard = new SimpleScryptsy({
+      N: 16384, // 2 ^ 14
+      r: 8,
+      p: 8
+    })
+
+    const easyStart = Date.now()
+    easy.passphraseToKey('random password', Buffer.from('abcd', 'hex'), 32)
+    const easyTime = Date.now() - easyStart
+
+    const hardStart = Date.now()
+    hard.passphraseToKey('random password', Buffer.from('abcd', 'hex'), 32)
+    const hardTime = Date.now() - hardStart
+
+    // significantly slower
+    // technically it is 8x harder, but they can be processed in parallel
+    expect(hardTime).toBeGreaterThan(easyTime * 2)
+  })
+})

packages/jellyfish-wallet-encrypted/jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  testEnvironment: 'node',
+  testMatch: [
+    '**/__tests__/**/*.test.ts'
+  ],
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true,
+  clearMocks: true,
+  testTimeout: 120000
+}

packages/jellyfish-wallet-encrypted/package.json

@@ -0,0 +1,45 @@
+{
+  "private": false,
+  "name": "@defichain/jellyfish-wallet-encrypted",
+  "version": "0.0.0",
+  "description": "A collection of TypeScript + JavaScript tools and libraries for DeFi Blockchain developers to build decentralized finance on Bitcoin",
+  "keywords": [
+    "DeFiChain",
+    "DeFi",
+    "Blockchain",
+    "API",
+    "Bitcoin"
+  ],
+  "repository": "DeFiCh/jellyfish",
+  "bugs": "https://github.com/DeFiCh/jellyfish/issues",
+  "license": "MIT",
+  "contributors": [
+    {
+      "name": "DeFiChain Foundation",
+      "email": "engineering@defichain.com",
+      "url": "https://defichain.com/"
+    },
+    {
+      "name": "DeFi Blockchain Contributors"
+    },
+    {
+      "name": "DeFi Jellyfish Contributors"
+    }
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -b ./tsconfig.build.json"
+  },
+  "dependencies": {
+    "@defichain/jellyfish-crypto": "0.0.0",
+    "@defichain/jellyfish-wallet": "0.0.0",
+    "scryptsy": "^2.1.0"
+  },
+  "devDependencies": {
+    "@types/scryptsy": "^2.0.0"
+  }
+}

packages/jellyfish-wallet-encrypted/src/index.ts

@@ -0,0 +1,2 @@
+export * from './scryptsy'
+export * from './scrypt_storage'