Add TypeScript build process

rkalis · rkalis · commit ced1267aa869 · 2019-06-07T16:12:13.000+09:00
- Fix tsconfig file to compile to dist/
- Add JS example + update README
- Update package.json to reflect these changes
- Update package.json for npm publish
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 src/compiler/grammar
 test.ts
+dist/
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
-.btcdeb_history
 test.ts
+dist/
 
 **/.DS_Store
 /**/.project
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -2,7 +2,9 @@
 
 [![Build Status](https://travis-ci.org/Bitcoin-com/cashscript.svg)](https://travis-ci.org/Bitcoin-com/cashscript)
 [![Coverage Status](https://img.shields.io/codecov/c/github/Bitcoin-com/cashscript.svg)](https://codecov.io/gh/Bitcoin-com/cashscript/)
-![GitHub](https://img.shields.io/github/license/Bitcoin-com/cashscript.svg)
+[![NPM Version](https://img.shields.io/npm/v/cashscript.svg)](https://www.npmjs.com/package/cashscript)
+[![NPM Monthly Downloads](https://img.shields.io/npm/dm/cashscript.svg)](https://www.npmjs.com/package/cashscript)
+[![NPM License](https://img.shields.io/npm/l/cashscript.svg)](https://www.npmjs.com/package/cashscript)
 
 CashScript is a high level language enabling basic smart contract functionality on Bitcoin Cash. We love the Ethereum development ecosystem, and with CashScript we want to bring part of that workflow into the Bitcoin Cash ecosystem.
 
@@ -42,9 +44,23 @@ The "Hello World" of cash contracts is defining the P2PKH pattern inside a cash
 Note that not all of these examples have been tested to work, and are also still a work in progress.
 
 ### Running the examples
-All `.ts` files in the [`examples/`](/examples) directory can be easily executed with `ts-node`.
+To run the examples, clone this repository.
 
+```bash
+git clone git@github.com:Bitcoin-com/cashscript.git
+cd cashscript
 ```
+
+All `.ts` files in the [`examples/`](/examples) directory can then be easily executed with `ts-node`.
+
+```bash
 npm install -g ts-node
 ts-node examples/p2pkh.ts
 ```
+
+All `.js` files can be easily executed with `node`. Be sure to compile the TypeScript source code first, so it can be used from JavaScript.
+
+```bash
+yarn / npm install
+node examples/p2pkh.js
+```
diff --git a/examples/p2pkh.js b/examples/p2pkh.js
@@ -0,0 +1,36 @@
+const { BITBOX } = require('bitbox-sdk');
+const path = require('path');
+const { Contract, Sig } = require('..');
+
+(async () => {
+  const network = 'testnet';
+  const bitbox = new BITBOX({ restURL: 'https://trest.bitcoin.com/v2/' });
+
+  const rootSeed = bitbox.Mnemonic.toSeed('CashScript');
+  const hdNode = bitbox.HDNode.fromSeed(rootSeed, network);
+  const keypair = bitbox.HDNode.toKeyPair(hdNode);
+
+  const pk = bitbox.ECPair.toPublicKey(keypair);
+  const pkh = bitbox.Crypto.hash160(pk);
+
+  const P2PKH = Contract.fromCashFile(path.join(__dirname, 'p2pkh.cash'), network);
+  const instance = P2PKH.new(pkh);
+  const contractBalance = await instance.getBalance();
+
+  console.log('contract address:', instance.address);
+  console.log('contract balance:', contractBalance);
+
+  // Send to one output
+  const tx = await instance.functions.spend(pk, new Sig(keypair, 0x01))
+    .send(instance.address, 10000);
+
+  console.log('transaction details:', tx);
+
+  // Send to multiple outputs
+  const tx2 = await instance.functions.spend(pk, new Sig(keypair, 0x01)).send([
+    { to: instance.address, amount: 10000 },
+    { to: instance.address, amount: 20000 },
+  ]);
+
+  console.log('transaction details:', tx2);
+})();
diff --git a/examples/p2pkh.ts b/examples/p2pkh.ts
@@ -29,10 +29,11 @@ import { Contract, Instance, Sig } from '..';
   console.log('transaction details:', tx);
 
   // Send to multiple outputs
-  const tx2 = await instance.functions.spend(pk, new Sig(keypair, 0x01)).send([
-    { to: instance.address, amount: 10000 },
-    { to: instance.address, amount: 20000 },
-  ]);
+  const tx2: TxnDetailsResult = await instance.functions.spend(pk, new Sig(keypair, 0x01))
+    .send([
+      { to: instance.address, amount: 10000 },
+      { to: instance.address, amount: 20000 },
+    ]);
 
   console.log('transaction details:', tx2);
 })();
diff --git a/examples/transfer_with_timeout.ts b/examples/transfer_with_timeout.ts
@@ -2,8 +2,7 @@ import { BITBOX } from 'bitbox-sdk';
 import { TxnDetailsResult } from 'bitcoin-com-rest';
 import { ECPair, HDNode } from 'bitcoincashjs-lib';
 import * as path from 'path';
-import { Contract, Sig } from '../src/sdk/cashscript-sdk';
-import { Instance } from '../src/sdk/Contract';
+import { Contract, Instance, Sig } from '..';
 
 (async (): Promise<any> => {
   const network: string = 'testnet';
diff --git a/package.json b/package.json
@@ -1,37 +1,17 @@
 {
   "name": "cashscript",
+  "description": "⚖️ Easily write and interact with Cash Contracts on Bitcoin Cash",
   "version": "0.1.0-beta.1",
-  "description": "",
-  "main": "index.ts",
-  "directories": {
-    "doc": "docs"
-  },
-  "files": [
-    "src/",
-    "index.ts"
-  ],
-  "scripts": {
-    "antlr": "antlr4ts -visitor -listener src/compiler/grammar/CashScript.g4",
-    "test": "nyc mocha",
-    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "lint": "eslint . --ext .ts"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Bitcoin-com/cashscript.git"
-  },
   "author": "Rosco Kalis <rosco@bitcoin.com>",
-  "contributors": [
-    "Gabriel Cardona <gabriel@bitcoin.com>"
-  ],
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/Bitcoin-com/cashscript/issues"
   },
-  "homepage": "https://github.com/Bitcoin-com/cashscript#readme",
+  "contributors": [
+    "Gabriel Cardona <gabriel@bitcoin.com>"
+  ],
   "dependencies": {
     "antlr4ts": "^0.5.0-alpha.3",
-    "bitbox-sdk": "8.3.2",
+    "bitbox-sdk": "^8.4.0",
     "bitcoincashjs-lib": "Bitcoin-com/bitcoincashjs-lib#v4.0.1",
     "delay": "^4.2.0"
   },
@@ -53,5 +33,40 @@
     "source-map-support": "^0.5.12",
     "ts-node": "^8.1.0",
     "typescript": "^3.4.5"
-  }
+  },
+  "directories": {
+    "doc": "docs",
+    "example": "examples",
+    "lib": "src",
+    "test": "test"
+  },
+  "files": [
+    "dist/"
+  ],
+  "homepage": "https://github.com/Bitcoin-com/cashscript#readme",
+  "keywords": [
+    "bitcoin",
+    "bitcoin cash",
+    "cash contracts",
+    "compiler",
+    "programming language",
+    "sdk",
+    "smart contracts"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Bitcoin-com/cashscript.git"
+  },
+  "scripts": {
+    "antlr": "antlr4ts -visitor -listener src/compiler/grammar/CashScript.g4",
+    "build": "tsc",
+    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
+    "lint": "eslint . --ext .ts",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test && npm run lint",
+    "test": "nyc mocha"
+  },
+  "types": "dist/index.d.ts"
 }
diff --git a/src/sdk/ABI.ts b/src/sdk/ABI.ts
@@ -1,7 +1,7 @@
 import { Ast } from '../compiler/ast/AST';
 import { Type } from '../compiler/ast/Type';
 import { Script } from '../compiler/generation/Script';
-import pkg from '../../package.json';
+import * as pkg from '../../package.json';
 
 export interface AbiParameter {
   name: string;
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,6 +9,9 @@
         "experimentalDecorators": true,     /* Enables experimental support for ES7 decorators. */
         "typeRoots" : ["node_modules/@types", "src/lib"],
         "resolveJsonModule": true,
-        "esModuleInterop": true,
-    }
+        "declaration": true,
+        "outDir": "dist/",
+        "moduleResolution": "node",
+    },
+    "include": ["index.ts"],
 }
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`src/compiler/grammar`
`2`	`2`	`test.ts`
	`3`	`+dist/`