Move to ESM-only + Libauth v2 (#142)

Author: rkalis

.cspell.json

@@ -14,6 +14,7 @@
         "bchjs",
         "bchreg",
         "bchtest",
+        "bigints",
         "bitauth",
         "bitbox",
         "bitbox's",
@@ -225,6 +226,7 @@
         "**.pdf",
         // Do not spellcheck generated code
         "**/dist/**",
+        "**/dist-test/**",
         "**/coverage/**",
         "**/build/**",
         "**/.docusaurus/**",

.eslintignore

@@ -1,6 +1,8 @@
 **/dist/
+**/dist-test/
 **/node_modules/
 **/grammar/
 /website/
 *.js
+*.cjs
 examples/webapp

.eslintrc.js renamed to .eslintrc.cjs

@@ -1,12 +1,15 @@
+const path = require('path');
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint'],
   extends: ['airbnb-typescript/base'],
   parserOptions: {
-    project: './tsconfig.json',
+    project: path.join(__dirname, 'tsconfig.json'),
     ecmaVersion: 2018,  // Allows for the parsing of modern ECMAScript features
     sourceType: 'module',  // Allows for the use of imports
+    extraFileExtensions: ['.cjs'],
   },
   env: {
     'jest': true,
@@ -43,6 +46,6 @@ module.exports = {
     'max-classes-per-file': 0, // Multiple classes in one file are allowed (e.g. Errors)
     '@typescript-eslint/no-redeclare': 0, // I sometimes name variables an types the same
     'linebreak-style': 0, // Ignore linebreak lints https://stackoverflow.com/a/43008668/1129108
-    'import/extensions': ['error', 'always'], // ESM requires file extensins
+    'import/extensions': ['error', 'always'], // ESM requires file extensions
   },
 }

.gitignore

@@ -1,6 +1,7 @@
 lerna-debug.log
 npm-debug.log
 **/dist/
+**/dist-test/
 **/node_modules/
 
 **/.DS_Store

README.md

@@ -48,16 +48,12 @@ npm install cashscript
 import { Contract, ... } from 'cashscript';
 ```
 
-```js
-const { Contract, ... } = require('cashscript');
-```
-
 Using the CashScript SDK, you can import contract artifact files, create new instances of these contracts, and interact with these instances:
 
 ```ts
 ...
   // Import the P2PKH artifact
-  const P2PKH = require('./p2pkh-artifact.json');
+  import P2PKH from './p2pkh-artifact.json' assert { type: 'json' };
 
   // Instantiate a network provider for CashScript's network operations
   const provider = new ElectrumNetworkProvider('mainnet');

examples/PriceOracle.ts

@@ -1,20 +1,20 @@
-import { Script, Crypto } from 'bitbox-sdk';
-import { ECPair } from 'bitcoincashjs-lib';
-import { SignatureAlgorithm } from 'cashscript';
+import { padMinimallyEncodedVmNumber, flattenBinArray, secp256k1 } from '@bitauth/libauth';
+import { encodeInt, sha256 } from '@cashscript/utils';
 
 export class PriceOracle {
-  constructor(public keypair: ECPair) {}
+  constructor(public privateKey: Uint8Array) {}
 
   // Encode a blockHeight and bchUsdPrice into a byte sequence of 8 bytes (4 bytes per value)
-  createMessage(blockHeight: number, bchUsdPrice: number): Buffer {
-    const lhs = Buffer.alloc(4, 0);
-    const rhs = Buffer.alloc(4, 0);
-    new Script().encodeNumber(blockHeight).copy(lhs);
-    new Script().encodeNumber(bchUsdPrice).copy(rhs);
-    return Buffer.concat([lhs, rhs]);
+  createMessage(blockHeight: bigint, bchUsdPrice: bigint): Uint8Array {
+    const encodedBlockHeight = padMinimallyEncodedVmNumber(encodeInt(blockHeight), 4);
+    const encodedBchUsdPrice = padMinimallyEncodedVmNumber(encodeInt(bchUsdPrice), 4);
+
+    return flattenBinArray([encodedBlockHeight, encodedBchUsdPrice]);
   }
 
-  signMessage(message: Buffer): Buffer {
-    return this.keypair.sign(new Crypto().sha256(message), SignatureAlgorithm.SCHNORR).toRSBuffer();
+  signMessage(message: Uint8Array): Uint8Array {
+    const signature = secp256k1.signMessageHashSchnorr(this.privateKey, sha256(message));
+    if (typeof signature === 'string') throw new Error();
+    return signature;
   }
 }

examples/README.md

@@ -1,36 +1,26 @@
 # CashScript examples
 This folder contains a number of example CashScript contracts to show off its functionality and usage. The `.cash` files contain example contracts, and the `.ts`/`.js` files contain example usage of the CashScript SDK with these contracts.
 
-The "Hello World" of cash contracts is defining the P2PKH pattern inside a cash contract, which can be found under [`p2pkh.cash`](/examples/p2pkh.cash). Its usage can be found under [`p2pkh.ts`](/examples/p2pkh.ts). To showcase web usage of the CashScript SDK, the `p2pkh.cash` contract has also been integrated into a very simple React webapp under [`webapp`](/examples/webapp/).
+The "Hello World" of cash contracts is defining the P2PKH pattern inside a cash contract, which can be found under [`p2pkh.cash`](/examples/p2pkh.cash). Its usage can be found under [`p2pkh.ts`](/examples/p2pkh.ts).
 
 ## Running the examples
 To run the examples, clone this repository and navigate to the `examples/` directory. Since the examples depend on the SDK, be sure to run `yarn` inside the `examples/` directory, which installs all required packages.
 
 ```bash
-git clone [email protected]:Bitcoin-com/cashscript.git
+git clone [email protected]:CashScript/cashscript.git
 cd cashscript/examples
 yarn
 ```
 
-All `.ts` files can then be executed with `ts-node`.
+All `.ts` files can then be executed with `ts-node-esm`.
 
 ```bash
 npm install -g ts-node
-ts-node p2pkh.ts
+ts-node-esm p2pkh.ts
 ```
 
 All `.js` files can be executed with `node`.
 
 ```bash
 node p2pkh.js
 ```
-
-## Running the webapp example
-The webapp example can be run from the `webapp/` folder.
-
-```bash
-yarn
-yarn start
-```
-
-This will display a simple webapp that allows you to create a P2PKH contract from a specific seed phrase and use the contract to send BCH. The code can be found in [`webapp/src/App.ts`](/examples/webapp/src/App.ts). Note that the `.cash` file has to be read, and then passed into the CashScript SDK, rather than passing just the file path into the SDK.

examples/announcement.ts

@@ -1,41 +1,34 @@
 import { Contract, ElectrumNetworkProvider } from 'cashscript';
 import { compileFile } from 'cashc';
-import path from 'path';
 import { stringify } from '@bitauth/libauth';
+import { URL } from 'url';
 
-run();
-export async function run(): Promise<void> {
-  try {
-    // Compile the Announcement contract to an artifact object
-    const artifact = compileFile(path.join(__dirname, 'announcement.cash'));
+// Compile the Announcement contract to an artifact object
+const artifact = compileFile(new URL('announcement.cash', import.meta.url));
 
-    // Initialise a network provider for network operations on MAINNET
-    const provider = new ElectrumNetworkProvider();
+// Initialise a network provider for network operations on MAINNET
+const provider = new ElectrumNetworkProvider();
 
-    // Instantiate a new contract using the compiled artifact and network provider
-    // AND providing the constructor parameters (none)
-    const contract = new Contract(artifact, [], provider);
+// Instantiate a new contract using the compiled artifact and network provider
+// AND providing the constructor parameters (none)
+const contract = new Contract(artifact, [], provider);
 
-    // Get contract balance & output address + balance
-    console.log('contract address:', contract.address);
-    console.log('contract balance:', await contract.getBalance());
-    console.log('contract opcount:', contract.opcount);
-    console.log('contract bytesize:', contract.bytesize);
+// Get contract balance & output address + balance
+console.log('contract address:', contract.address);
+console.log('contract balance:', await contract.getBalance());
+console.log('contract opcount:', contract.opcount);
+console.log('contract bytesize:', contract.bytesize);
 
-    // Send the announcement. Trying to send any other announcement will fail because
-    // the contract's covenant logic. Uses a hardcoded fee and minChange so that
-    // change is only sent back to the contract if there's enough leftover
-    // for another announcement.
-    const str = 'A contract may not injure a human being or, through inaction, allow a human being to come to harm.';
-    const tx = await contract.functions
-      .announce()
-      .withOpReturn(['0x6d02', str])
-      .withHardcodedFee(1000)
-      .withMinChange(1000)
-      .send();
+// Send the announcement. Trying to send any other announcement will fail because
+// the contract's covenant logic. Uses a hardcoded fee and minChange so that
+// change is only sent back to the contract if there's enough leftover
+// for another announcement.
+const str = 'A contract may not injure a human being or, through inaction, allow a human being to come to harm.';
+const tx = await contract.functions
+  .announce()
+  .withOpReturn(['0x6d02', str])
+  .withHardcodedFee(1000n)
+  .withMinChange(1000n)
+  .send();
 
-    console.log('transaction details:', stringify(tx));
-  } catch (e) {
-    console.log(e);
-  }
-}
+console.log('transaction details:', stringify(tx));

examples/common-js.js

@@ -0,0 +1,23 @@
+import { hash160 } from '@cashscript/utils';
+import {
+  deriveHdPrivateNodeFromSeed,
+  deriveHdPath,
+  secp256k1,
+  encodeCashAddress,
+} from '@bitauth/libauth';
+import bip39 from 'bip39';
+
+// This is duplicated from common.ts because it is not possible to import from a .ts file in p2pkh.js
+
+// Generate entropy from BIP39 mnemonic phrase and initialise a root HD-wallet node
+const seed = await bip39.mnemonicToSeed('CashScript Examples');
+const rootNode = deriveHdPrivateNodeFromSeed(seed, true);
+const baseDerivationPath = "m/44'/145'/0'/0";
+
+// Derive Alice's private key, public key, public key hash and address
+const aliceNode = deriveHdPath(rootNode, `${baseDerivationPath}/0`);
+if (typeof aliceNode === 'string') throw new Error();
+export const alicePub = secp256k1.derivePublicKeyCompressed(aliceNode.privateKey);
+export const alicePriv = aliceNode.privateKey;
+export const alicePkh = hash160(alicePub);
+export const aliceAddress = encodeCashAddress('bchtest', 'p2pkh', alicePkh);

examples/common.ts

@@ -0,0 +1,39 @@
+import { hash160 } from '@cashscript/utils';
+import {
+  deriveHdPrivateNodeFromSeed,
+  deriveHdPath,
+  secp256k1,
+  encodeCashAddress,
+} from '@bitauth/libauth';
+import bip39 from 'bip39';
+import { PriceOracle } from './PriceOracle.js';
+
+// Generate entropy from BIP39 mnemonic phrase and initialise a root HD-wallet node
+const seed = await bip39.mnemonicToSeed('CashScript Examples');
+const rootNode = deriveHdPrivateNodeFromSeed(seed, true);
+const baseDerivationPath = "m/44'/145'/0'/0";
+
+// Derive Alice's private key, public key, public key hash and address
+const aliceNode = deriveHdPath(rootNode, `${baseDerivationPath}/0`);
+if (typeof aliceNode === 'string') throw new Error();
+export const alicePub = secp256k1.derivePublicKeyCompressed(aliceNode.privateKey) as Uint8Array;
+export const alicePriv = aliceNode.privateKey;
+export const alicePkh = hash160(alicePub);
+export const aliceAddress = encodeCashAddress('bchtest', 'p2pkh', alicePkh);
+
+// Derive Bob's private key, public key, public key hash and address
+const bobNode = deriveHdPath(rootNode, `${baseDerivationPath}/1`);
+if (typeof bobNode === 'string') throw new Error();
+export const bobPub = secp256k1.derivePublicKeyCompressed(bobNode.privateKey) as Uint8Array;
+export const bobPriv = bobNode.privateKey;
+export const bobPkh = hash160(bobPub);
+export const bobAddress = encodeCashAddress('bchtest', 'p2pkh', bobPkh);
+
+// Initialise a price oracle with a private key
+const oracleNode = deriveHdPath(rootNode, `${baseDerivationPath}/2`);
+if (typeof oracleNode === 'string') throw new Error();
+export const oraclePub = secp256k1.derivePublicKeyCompressed(oracleNode.privateKey) as Uint8Array;
+export const oraclePriv = oracleNode.privateKey;
+export const oracle = new PriceOracle(oracleNode.privateKey);
+export const oraclePkh = hash160(oraclePub);
+export const oracleAddress = encodeCashAddress('bchtest', 'p2pkh', oraclePkh);

examples/hodl_vault.ts

@@ -1,51 +1,39 @@
 import { stringify } from '@bitauth/libauth';
-import { BITBOX } from 'bitbox-sdk';
 import { Contract, SignatureTemplate, ElectrumNetworkProvider } from 'cashscript';
 import { compileFile } from 'cashc';
-import path from 'path';
-import { PriceOracle } from './PriceOracle.js';
-
-run();
-async function run(): Promise<void> {
-  // Initialise BITBOX
-  const bitbox = new BITBOX();
-
-  // Initialise HD node and owner's keypair
-  const rootSeed = bitbox.Mnemonic.toSeed('CashScript');
-  const hdNode = bitbox.HDNode.fromSeed(rootSeed);
-
-  const owner = bitbox.HDNode.toKeyPair(bitbox.HDNode.derive(hdNode, 0));
-  const ownerPk = bitbox.ECPair.toPublicKey(owner);
-
-  // Initialise price oracle with a keypair
-  const oracleKeypair = bitbox.HDNode.toKeyPair(bitbox.HDNode.derive(hdNode, 1));
-  const oraclePk = bitbox.ECPair.toPublicKey(oracleKeypair);
-  const oracle = new PriceOracle(oracleKeypair);
-
-  // Compile the HodlVault contract to an artifact object
-  const artifact = compileFile(path.join(__dirname, 'hodl_vault.cash'));
-
-  // Initialise a network provider for network operations on TESTNET3
-  const provider = new ElectrumNetworkProvider('testnet3');
-
-  // Instantiate a new contract using the compiled artifact and network provider
-  // AND providing the constructor parameters
-  const parameters = [ownerPk, oraclePk, 597000, 30000];
-  const contract = new Contract(artifact, parameters, provider);
-
-  // Get contract balance & output address + balance
-  console.log('contract address:', contract.address);
-  console.log('contract balance:', await contract.getBalance());
-
-  // Produce new oracle message and signature
-  const oracleMessage = oracle.createMessage(597000, 30000);
-  const oracleSignature = oracle.signMessage(oracleMessage);
-
-  // Spend from the vault
-  const tx = await contract.functions
-    .spend(new SignatureTemplate(owner), oracleSignature, oracleMessage)
-    .to(contract.address, 1000)
-    .send();
-
-  console.log(stringify(tx));
-}
+import { URL } from 'url';
+
+// Import keys and price oracle from common.ts
+import {
+  alicePriv,
+  alicePub,
+  oracle,
+  oraclePub,
+} from './common.js';
+
+// Compile the HodlVault contract to an artifact object
+const artifact = compileFile(new URL('hodl_vault.cash', import.meta.url));
+
+// Initialise a network provider for network operations on TESTNET4
+const provider = new ElectrumNetworkProvider('testnet4');
+
+// Instantiate a new contract using the compiled artifact and network provider
+// AND providing the constructor parameters
+const parameters = [alicePub, oraclePub, 100000n, 30000n];
+const contract = new Contract(artifact, parameters, provider);
+
+// Get contract balance & output address + balance
+console.log('contract address:', contract.address);
+console.log('contract balance:', await contract.getBalance());
+
+// Produce new oracle message and signature
+const oracleMessage = oracle.createMessage(100000n, 30000n);
+const oracleSignature = oracle.signMessage(oracleMessage);
+
+// Spend from the vault
+const tx = await contract.functions
+  .spend(new SignatureTemplate(alicePriv), oracleSignature, oracleMessage)
+  .to(contract.address, 1000n)
+  .send();
+
+console.log(stringify(tx));