jellyfish-transaction-signature

.github/CODEOWNERS

@@ -25,6 +25,7 @@
 /packages/jellyfish-transaction/src/script/defi/            @fuxingloh @canonbrother @ivan-zynesis @monstrobishi
 
 /packages/jellyfish-transaction-builder/        @fuxingloh @ivan-zynesis @monstrobishi
+/packages/jellyfish-transaction-signature/      @ivan-zynesis
 /packages/jellyfish-wallet/                     @fuxingloh
 /packages/jellyfish-wallet-mnemonic/            @fuxingloh
 /packages/testcontainers/                       @fuxingloh

.github/governance.yml

@@ -42,6 +42,7 @@ issue:
         - jellyfish-network
         - jellyfish-transaction
         - jellyfish-transaction-builder
+        - jellyfish-transaction-signature
         - jellyfish-wallet
         - jellyfish-wallet-mnemonic
         - testcontainers

.github/labeler.yml

@@ -56,6 +56,11 @@ labels:
     matcher:
       files: "packages/jellyfish-transaction-builder/**"
 
+  - label: area/jellyfish-transaction-signature
+    sync: true
+    matcher:
+      files: "packages/jellyfish-transaction-signature/**"
+
   - label: area/jellyfish-wallet-mnemonic
     sync: true
     matcher:

.github/labels.yml

@@ -74,6 +74,8 @@
   name: area/jellyfish-transaction
 - color: fbca04
   name: area/jellyfish-transaction-builder
+- color: fbca04
+  name: area/jellyfish-transaction-signature
 - color: fbca04
   name: area/jellyfish-wallet
 - color: fbca04

README.md

@@ -94,6 +94,7 @@ Package                                            | Description
 `@defichain/jellyfish-network`                     | Contains DeFi blockchain various network configuration for mainnet, testnet and regtest.
 `@defichain/jellyfish-transaction`                 | Dead simple modern stateless raw transaction composer for the DeFi Blockchain.
 `@defichain/jellyfish-transaction-builder`         | Provides a high-high level abstraction for constructing transaction ready to be broadcast for DeFi Blockchain.
+`@defichain/jellyfish-transaction-signature`       | Stateless utility library to perform transaction signing.
 `@defichain/jellyfish-wallet`                      | Jellyfish wallet is a managed wallet, where account can get discovered from an HD seed.
 `@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.

jest.config.js

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

packages/jellyfish-transaction-builder/__tests__/raw_crafting.ts

@@ -5,9 +5,9 @@ import {
   CTransactionSegWit,
   DeFiTransactionConstants,
   Transaction,
-  TransactionSigner,
   OP_CODES
 } from '@defichain/jellyfish-transaction'
+import { TransactionSigner } from '@defichain/jellyfish-transaction-signature'
 import { WIF, HASH160 } from '@defichain/jellyfish-crypto'
 import { SmartBuffer } from 'smart-buffer'
 

packages/jellyfish-transaction-builder/package.json

@@ -39,10 +39,14 @@
   },
   "dependencies": {
     "@defichain/jellyfish-crypto": "0.0.0",
-    "@defichain/jellyfish-transaction": "0.0.0"
+    "@defichain/jellyfish-transaction": "0.0.0",
+    "@defichain/jellyfish-transaction-signature": "0.0.0",
+    "smart-buffer": "^4.1.0"
   },
   "devDependencies": {
+    "@defichain/jellyfish-address": "0.0.0",
     "@defichain/jellyfish-api-jsonrpc": "0.0.0",
+    "@defichain/jellyfish-network": "0.0.0",
     "@defichain/testcontainers": "0.0.0",
     "@defichain/testing": "0.0.0"
   }

packages/jellyfish-transaction-builder/src/txn/txn_builder.ts

@@ -1,11 +1,11 @@
 import {
   DeFiTransactionConstants, OP_CODES,
   Script,
-  SignInputOption,
   Transaction,
   TransactionSegWit,
-  TransactionSigner, Vin, Vout, OP_DEFI_TX
+  Vin, Vout, OP_DEFI_TX
 } from '@defichain/jellyfish-transaction'
+import { TransactionSigner, SignInputOption } from '@defichain/jellyfish-transaction-signature'
 import { BigNumber } from 'bignumber.js'
 import { EllipticPairProvider, FeeRateProvider, Prevout, PrevoutProvider } from '../provider'
 import { calculateFeeP2WPKH } from './txn_fee'

packages/jellyfish-transaction-builder/tsconfig.build.json

@@ -8,6 +8,11 @@
     "rootDir": "./src",
   },
   "references": [
+    {"path": "../jellyfish-address/tsconfig.build.json"},
+    {"path": "../jellyfish-crypto/tsconfig.build.json"},
+    {"path": "../jellyfish-network/tsconfig.build.json"},
+    {"path": "../jellyfish-transaction/tsconfig.build.json"},
+    {"path": "../jellyfish-transaction-signature/tsconfig.build.json"},
     {"path": "../jellyfish-api-jsonrpc/tsconfig.build.json"},
     {"path": "../testcontainers/tsconfig.build.json"},
     {"path": "../testing/tsconfig.build.json"}

packages/jellyfish-transaction-signature/README.md

@@ -0,0 +1,12 @@
+[![npm](https://img.shields.io/npm/v/@defichain/jellyfish-transaction-signature)](https://www.npmjs.com/package/@defichain/jellyfish-transaction-signature/v/latest)
+[![npm@next](https://img.shields.io/npm/v/@defichain/jellyfish-transaction-signature/next)](https://www.npmjs.com/package/@defichain/jellyfish-transaction-signature/v/next)
+
+# @defichain/jellyfish-transaction-signature
+
+Stateless utility library to perform transaction signing.
+
+## Prior-art
+
+- https://github.com/ilyavf/tx-builder
+- https://github.com/bitpay/bitcore
+- https://github.com/bitcoinjs/bitcoinjs-lib

packages/jellyfish-transaction/__tests__/tx_signature/sign_input.test.ts → packages/jellyfish-transaction-signature/__tests__/sign_input.test.ts

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js'
-import { OP_CODES, OP_PUSHDATA, SIGHASH, Transaction, TransactionSigner, Vout } from '../../src'
-
+import { OP_CODES, OP_PUSHDATA, SIGHASH, Transaction, Vout } from '@defichain/jellyfish-transaction'
 import { SHA256, HASH160, Elliptic } from '@defichain/jellyfish-crypto'
+import { TransactionSigner } from '../src'
 
 describe('sign single input', () => {
   const transaction: Transaction = {

packages/jellyfish-transaction/__tests__/tx_signature/sign_transaction.test.ts → packages/jellyfish-transaction-signature/__tests__/sign_transaction.test.ts

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js'
-import { OP_CODES, OP_PUSHDATA, DeFiTransactionConstants, SIGHASH, Transaction, TransactionSigner, Vout } from '../../src'
-
+import { OP_CODES, OP_PUSHDATA, DeFiTransactionConstants, SIGHASH, Transaction, Vout } from '@defichain/jellyfish-transaction'
 import { Elliptic } from '@defichain/jellyfish-crypto'
+import { TransactionSigner } from '../src'
 
 describe('sign transaction', () => {
   const transaction: Transaction = {

packages/jellyfish-transaction-signature/__tests__/tx/p2wpkh_1_to_1.test.ts

@@ -0,0 +1,40 @@
+import BigNumber from 'bignumber.js'
+import { SmartBuffer } from 'smart-buffer'
+import { Bech32, WIF } from '@defichain/jellyfish-crypto'
+import { OP_CODES, CTransaction, CTransactionSegWit } from '@defichain/jellyfish-transaction'
+import { SignInputOption, TransactionSigner } from '../../src'
+
+// From Address P2WPKH
+const input = {
+  bech32: 'bcrt1qykj5fsrne09yazx4n72ue4fwtpx8u65zac9zhn',
+  privKey: 'cQSsfYvYkK5tx3u1ByK2ywTTc9xJrREc1dd67ZrJqJUEMwgktPWN'
+}
+
+const unsigned = '0400000001346faf87ccf6fe45463831a23054780d78e4a6decab10575aba212d2e087eb3d0000000000ffffffff010065cd1d000000001600144ab4391ce5a732e36139e72d79a28e01b7b080340000000000'
+const signed = '04000000000101346faf87ccf6fe45463831a23054780d78e4a6decab10575aba212d2e087eb3d0000000000ffffffff010065cd1d000000001600144ab4391ce5a732e36139e72d79a28e01b7b0803400024730440220691a0adc945ae033716e7025235b19618a579545874521d3d70faffcbe95971602200dd1886fe71ab5ab447077680bf891c8faeede9c52e15c0b3789e128899b320e012103987aec2e508e124468f0f07a836d185b329026e7aaf75be48cf12be8f18cbe8100000000'
+
+it('sign transaction', async () => {
+  const txUnsigned = new CTransaction(
+    SmartBuffer.fromBuffer(Buffer.from(unsigned, 'hex'))
+  )
+
+  const inputs: SignInputOption[] = [{
+    prevout: {
+      script: {
+        stack: [
+          OP_CODES.OP_0,
+          OP_CODES.OP_PUSHDATA(Bech32.toHash160(input.bech32, 'bcrt', 0x00), 'little')
+        ]
+      },
+      value: new BigNumber('10'),
+      tokenId: 0
+    },
+    ellipticPair: WIF.asEllipticPair(input.privKey)
+  }]
+  const txSigned = new CTransactionSegWit(await TransactionSigner.sign(txUnsigned, inputs))
+
+  const toBuffer = new SmartBuffer()
+  txSigned.toBuffer(toBuffer)
+
+  expect(toBuffer.toBuffer().toString('hex')).toStrictEqual(signed)
+})

packages/jellyfish-transaction-signature/__tests__/tx/p2wpkh_1_to_2.test.ts

@@ -0,0 +1,40 @@
+import BigNumber from 'bignumber.js'
+import { SmartBuffer } from 'smart-buffer'
+import { Bech32, WIF } from '@defichain/jellyfish-crypto'
+import { OP_CODES, CTransaction, CTransactionSegWit } from '@defichain/jellyfish-transaction'
+import { SignInputOption, TransactionSigner } from '../../src'
+
+// From Address P2WPKH
+const input = {
+  bech32: 'bcrt1qykj5fsrne09yazx4n72ue4fwtpx8u65zac9zhn',
+  privKey: 'cQSsfYvYkK5tx3u1ByK2ywTTc9xJrREc1dd67ZrJqJUEMwgktPWN'
+}
+
+const unsigned = '040000000193c90783761bf94838ced5a8313eb355c3bdd053cdbdbb3f9e0f3dbc3243609b0000000000ffffffff020065cd1d000000001600144ab4391ce5a732e36139e72d79a28e01b7b080340080ce341d0000000016001425a544c073cbca4e88d59f95ccd52e584c7e6a820000000000'
+const signed = '0400000000010193c90783761bf94838ced5a8313eb355c3bdd053cdbdbb3f9e0f3dbc3243609b0000000000ffffffff020065cd1d000000001600144ab4391ce5a732e36139e72d79a28e01b7b080340080ce341d0000000016001425a544c073cbca4e88d59f95ccd52e584c7e6a82000247304402201142c461b7b52323654710b14074928dd8e623d75141f9eb8c2132b7cb2d47c202202883fde993e1ecf0cf3955235522e9fe948b523b568d0e6b427f83c6f1b3efd9012103987aec2e508e124468f0f07a836d185b329026e7aaf75be48cf12be8f18cbe8100000000'
+
+it('sign transaction', async () => {
+  const txUnsigned = new CTransaction(
+    SmartBuffer.fromBuffer(Buffer.from(unsigned, 'hex'))
+  )
+
+  const inputs: SignInputOption[] = [{
+    prevout: {
+      script: {
+        stack: [
+          OP_CODES.OP_0,
+          OP_CODES.OP_PUSHDATA(Bech32.toHash160(input.bech32, 'bcrt', 0x00), 'little')
+        ]
+      },
+      value: new BigNumber('10'),
+      tokenId: 0
+    },
+    ellipticPair: WIF.asEllipticPair(input.privKey)
+  }]
+  const txSigned = new CTransactionSegWit(await TransactionSigner.sign(txUnsigned, inputs))
+
+  const toBuffer = new SmartBuffer()
+  txSigned.toBuffer(toBuffer)
+
+  expect(toBuffer.toBuffer().toString('hex')).toStrictEqual(signed)
+})

packages/jellyfish-transaction-signature/jest.config.js

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