Update examples and small fixes

Comment fixes

Small fixes

Update fixtures after rebase

Update READMEs

Rename parameter -> argument

Author: rkalis

.eslintignore

@@ -3,3 +3,4 @@
 **/grammar/
 /website/
 *.js
+examples/webapp

.eslintrc.js

@@ -2,7 +2,7 @@ module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint'],
-  extends: ['airbnb-typescript'],
+  extends: ['airbnb-typescript/base'],
   parserOptions: {
     project: './tsconfig.json',
     ecmaVersion: 2018,  // Allows for the parsing of modern ECMAScript features

README.md

@@ -53,33 +53,37 @@ npm install cashscript
 
 ### Usage
 ```ts
-import { Contract, ... } from 'cashscript';
+import { Contract, CashCompiler, ... } from 'cashscript';
 ```
 
 ```js
-const { Contract, ... } = require('cashscript');
+const { Contract, CashCompiler, ... } = require('cashscript');
 ```
 
 Using the CashScript SDK, you can import / compile existing contract files, create new instances of these contracts, and interact with these instances:
 
 ```ts
 ...
   // Compile the P2PKH contract
-  const P2PKH = Contract.compile('./p2pkh.cash', 'mainnet');
+  const P2PKH = CashCompiler.compileFile('./p2pkh.cash');
 
-  // Instantiate a new P2PKH contract with constructor arguments: { pkh: pkh }
-  const instance = P2PKH.new(pkh);
+  // Instantiate a network provider for CashScript's network operations
+  const provider = new ElectrumNetworkProvider('mainnet');
+
+  // Create a new P2PKH contract with constructor arguments: { pkh: pkh }
+  const contract = new Contract(P2PKH, [pkh], provider);
 
   // Get contract balance & output address + balance
-  console.log('contract address:', instance.address);
-  console.log('contract balance:', await instance.getBalance());
+  console.log('contract address:', contract.address);
+  console.log('contract balance:', await contract.getBalance());
 
   // Call the spend function with the owner's signature
   // And use it to send 0. 000 100 00 BCH back to the contract's address
-  const txDetails = await instance.functions
+  const txDetails = await contract.functions
     .spend(pk, new SignatureTemplate(keypair))
-    .to(instance.address, 10000)
+    .to(contract.address, 10000)
     .send();
+
   console.log(txDetails);
 ...
 ```

examples/Browser/package.json

@@ -1,7 +1,7 @@
 # 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 exmaple usage of the CashScript SDK with these contracts.
+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 app under [`Browser`](/examples/Browser/).
+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/).
 
 ## 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.
@@ -25,12 +25,12 @@ All `.js` files can be executed with `node`.
 node p2pkh.js
 ```
 
-## Running the browser example
-The browser example can be run from the `Browser/` folder.
+## 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 [`Browser/src/App.js`](/examples/Browser/src/App.js). 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.
+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/Browser/public/favicon.ico

@@ -1,4 +1,4 @@
-pragma cashscript ^0.4.0;
+pragma cashscript ^0.5.0;
 
 /* This is a contract showcasing covenants outside of regular transactional use.
  * It enforces the contract to make an "announcement" on Memo.cash, and send the