Merge pull request #311 from CashScript/next

Author: rkalis

.cspell.json

@@ -23,6 +23,7 @@
         "bitcore",
         "bitfield",
         "bitfield's",
+        "bitshift",
         "blackie",
         "blockbook",
         "booland",
@@ -82,6 +83,8 @@
         "INPUTINDEX",
         "INPUTSEQUENCENUMBER",
         "ints",
+        "introspected",
+        "introspecting",
         "kalis",
         "keypair",
         "keypairs",
@@ -138,6 +141,7 @@
         "prevouts",
         "priv",
         "pubkey",
+        "pubkeys",
         "pubkeytype",
         "pushbytes",
         "pushdata",
@@ -155,6 +159,7 @@
         "scripthash",
         "sdks",
         "secp",
+        "segwit",
         "setup",
         "sig",
         "sighash",
@@ -185,6 +190,7 @@
         "unary",
         "unlocker",
         "unlockers",
+        "unreached",
         "utxo",
         "utxo's",
         "UTXOBYTECODE",
@@ -199,11 +205,13 @@
         "workdir"
     ],
     "ignoreWords": [
+        "addinput",
         "bitcats",
         "bitcoincashjs",
         "branchup",
         "bchguru",
         "bchn",
+        "c0ffee",
         "cashcompiler",
         "cashninjas",
         "chaingraph",
@@ -215,6 +223,7 @@
         "getrawtransaction",
         "hardhat",
         "hodlvault",
+        "incl",
         "infima",
         "jedex",
         "lichos",
@@ -225,10 +234,12 @@
         "outputnulldata",
         "outputp",
         "pako",
+        "paytaca",
         "popd",
         "pushd",
         "sendrawtransaction",
         "setfiletype",
+        "setlocktime",
         "tada",
         "tapswap",
         "tokenaut",
@@ -245,6 +256,7 @@
         "withopreturn",
         "withtime",
         "XBVJRKV",
+        "zapit",
         "zwets"
     ],
     "ignorePaths": [
@@ -271,5 +283,10 @@
         "**/grammar/**",
         // Do not spellcheck vendor code
         "**/node_modules/**",
+    ],
+    "ignoreRegExpList": [
+        "bitcoincash:.*",
+        "bchreg:.*",
+        "bchtest:.*"
     ]
 }

Dockerfile

@@ -64,24 +64,33 @@ Using the CashScript SDK, you can import contract artifact files, create new ins
   import P2PKH from './p2pkh-artifact.json' with { type: 'json' };
 
   // Instantiate a network provider for CashScript's network operations
-  const provider = new ElectrumNetworkProvider('mainnet');
+  const provider = new ElectrumNetworkProvider('chipnet');
 
   // Create a new P2PKH contract with constructor arguments: { pkh: pkh }
-  const contract = new Contract(P2PKH, [pkh], provider);
+  const contract = new Contract(P2PKH, [pkh], {provider});
 
-  // Get contract balance & output address + balance
+  // Fetch contract utxos
+  const contractUtxos = await contract.getUtxos();
+
+  // Log contract output address + contract utxos
   console.log('contract address:', contract.address);
-  console.log('contract balance:', await contract.getBalance());
+  console.log('contract utxos', contractUtxos);
+
+  // Specify the contract UTXO
+  const selectedContractUtxo = contractUtxos[0]
 
+  // Start building the transaction
   // 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 contract.functions
-    .spend(pk, new SignatureTemplate(keypair))
-    .to(contract.address, 10000)
+  const txDetails = await new TransactionBuilder({ provider })
+    .addInput(selectedContractUtxo, contract.unlock.spend(new SignatureTemplate(keypair)))
+    .addOutput({
+      to: contract.address,
+      amount: 10000n
+    })
     .send();
 
   console.log(txDetails);
-...
 ```
 
 ## Examples

README.md

@@ -1,4 +1,4 @@
-pragma cashscript ^0.10.0;
+pragma cashscript ^0.11.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

examples/announcement.cash

@@ -1,4 +1,4 @@
-import { Contract, ElectrumNetworkProvider } from 'cashscript';
+import { Contract, ElectrumNetworkProvider, Output, TransactionBuilder } from 'cashscript';
 import { compileFile } from 'cashc';
 import { stringify } from '@bitauth/libauth';
 import { URL } from 'url';
@@ -16,20 +16,36 @@ const contract = new Contract(artifact, [], { provider, addressType });
 
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
+const contractUtxos = await contract.getUtxos();
+console.log('contract utxos:', contractUtxos);
 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.
+// Select a contract UTXO to spend from
+const contractInputUtxo = contractUtxos.find(utxo => utxo.satoshis > 10_000n);
+if (!contractInputUtxo) throw new Error('No contract UTXO with enough satoshis found');
+const inputAmount = contractInputUtxo.satoshis;
+
+// Announcement string
 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();
+
+// Construct a changeOutput so the leftover BCH can be send back for another announcement
+const minerFee = 1000n;
+const changeAmount = inputAmount - minerFee;
+const contractChangeOutput: Output = {
+  amount: changeAmount,
+  to: contract.address,
+};
+
+// Send the announcement. Trying to send any other announcement or other change output
+// will fail because of the contract's covenant logic
+const transactionBuilder = new TransactionBuilder({ provider });
+
+transactionBuilder.addInput(contractInputUtxo, contract.unlock.announce());
+transactionBuilder.addOpReturnOutput(['0x6d02', str]);
+if (changeAmount > 1000n) transactionBuilder.addOutput(contractChangeOutput);
+
+const tx = await transactionBuilder.send();
 
 console.log('transaction details:', stringify(tx));

examples/announcement.ts

@@ -21,3 +21,4 @@ export const alicePub = secp256k1.derivePublicKeyCompressed(aliceNode.privateKey
 export const alicePriv = aliceNode.privateKey;
 export const alicePkh = hash160(alicePub);
 export const aliceAddress = encodeCashAddress({ prefix: 'bchtest', type: 'p2pkh', payload: alicePkh, throwErrors: true }).address;
+export const aliceTokenAddress = encodeCashAddress({ prefix: 'bchtest', type: 'p2pkhWithTokens', payload: alicePkh, throwErrors: true }).address;

examples/common-js.js

@@ -1,4 +1,4 @@
-pragma cashscript ^0.10.0;
+pragma cashscript ^0.11.0;
 
 // This contract forces HODLing until a certain price target has been reached
 // A minimum block is provided to ensure that oracle price entries from before this block are disregarded

examples/hodl_vault.cash

@@ -1,5 +1,5 @@
 import { stringify } from '@bitauth/libauth';
-import { Contract, SignatureTemplate, ElectrumNetworkProvider } from 'cashscript';
+import { Contract, SignatureTemplate, ElectrumNetworkProvider, TransactionBuilder, Output } from 'cashscript';
 import { compileFile } from 'cashc';
 import { URL } from 'url';
 
@@ -24,16 +24,44 @@ const contract = new Contract(artifact, parameters, { provider });
 
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
+const contractUtxos = await contract.getUtxos();
+console.log('contract utxos:', contractUtxos);
 console.log('contract balance:', await contract.getBalance());
 
+const currentBlockHeight = await provider.getBlockHeight();
+console.log('current block height:', currentBlockHeight);
+
+// Select a contract UTXO to spend from
+const contractInputUtxo = contractUtxos.find(utxo => utxo.satoshis > 10_000n);
+if (!contractInputUtxo) throw new Error('No contract UTXO with enough satoshis found');
+const inputAmount = contractInputUtxo.satoshis;
+
 // Produce new oracle message and signature
 const oracleMessage = oracle.createMessage(100000n, 30000n);
 const oracleSignature = oracle.signMessage(oracleMessage);
 
+// construct an output
+const outputAmount = 1000n;
+const output: Output = { amount: outputAmount, to: contract.address };
+
+// Construct a changeOutput
+const minerFee = 1000n;
+const changeAmount = inputAmount - outputAmount - minerFee;
+const changeOutput: Output = {
+  amount: changeAmount,
+  to: contract.address,
+};
+
+const aliceTemplate = new SignatureTemplate(alicePriv);
+
 // Spend from the vault
-const tx = await contract.functions
-  .spend(new SignatureTemplate(alicePriv), oracleSignature, oracleMessage)
-  .to(contract.address, 1000n)
-  .send();
+const transactionBuilder = new TransactionBuilder({ provider });
+
+transactionBuilder.setLocktime(currentBlockHeight);
+transactionBuilder.addInput(contractInputUtxo, contract.unlock.spend(aliceTemplate, oracleSignature, oracleMessage));
+transactionBuilder.addOutput(output);
+if (changeAmount > 1000n) transactionBuilder.addOutput(changeOutput);
+
+const tx = await transactionBuilder.send();
 
 console.log(stringify(tx));

examples/hodl_vault.ts

@@ -1,4 +1,4 @@
-pragma cashscript ^0.10.0;
+pragma cashscript ^0.11.0;
 
 /* This is an unofficial CashScript port of Licho's Mecenas contract. It is
  * not compatible with Licho's EC plugin, but rather meant as a demonstration
@@ -7,7 +7,7 @@ pragma cashscript ^0.10.0;
  */
 contract Mecenas(bytes20 recipient, bytes20 funder, int pledge/*, int period */) {
     function receive() {
-        // require(tx.age >= period);
+        // require(this.age >= period);
 
         // Check that the first output sends to the recipient
         require(tx.outputs[0].lockingBytecode == new LockingBytecodeP2PKH(recipient));

examples/mecenas.cash

@@ -1,5 +1,5 @@
 import { stringify } from '@bitauth/libauth';
-import { Contract, ElectrumNetworkProvider } from 'cashscript';
+import { Contract, ElectrumNetworkProvider, Output, TransactionBuilder } from 'cashscript';
 import { compileFile } from 'cashc';
 import { URL } from 'url';
 
@@ -15,21 +15,44 @@ const provider = new ElectrumNetworkProvider('chipnet');
 // Instantiate a new contract using the compiled artifact and network provider
 // AND providing the constructor parameters:
 // (recipient: alicePkh, funder: bobPkh, pledge: 10000)
-const contract = new Contract(artifact, [alicePkh, bobPkh, 10000n], { provider });
+const pledgeAmount = 10_000n;
+const contract = new Contract(artifact, [alicePkh, bobPkh, pledgeAmount], { provider });
 
 // Get contract balance & output address + balance
 console.log('contract address:', contract.address);
+const contractUtxos = await contract.getUtxos();
+console.log('contract utxos:', contractUtxos);
 console.log('contract balance:', await contract.getBalance());
 console.log('contract opcount:', contract.opcount);
 console.log('contract bytesize:', contract.bytesize);
 
+// Select a contract UTXO to spend from
+const contractInputUtxo = contractUtxos.find(utxo => utxo.satoshis > 10_000n);
+if (!contractInputUtxo) throw new Error('No contract UTXO with enough satoshis found');
+const inputAmount = contractInputUtxo.satoshis;
+
+const receiverOutput: Output = {
+  amount: 10_000n,
+  to: aliceAddress,
+};
+
+// Construct the changeOutput
+const minerFee = 1000n;
+const changeAmount = inputAmount - pledgeAmount - minerFee;
+const contractChangeOutput: Output = {
+  amount: changeAmount,
+  to: contract.address,
+};
+
 // Call the transfer function with any signature
 // Will send one pledge amount to alice, and send change back to the contract
 // Manually set fee to 1000 because this is hardcoded in the contract
-const tx = await contract.functions
-  .receive()
-  .to(aliceAddress, 10000n)
-  .withHardcodedFee(1000n)
-  .send();
+const transactionBuilder = new TransactionBuilder({ provider });
+
+transactionBuilder.addInput(contractInputUtxo, contract.unlock.receive());
+transactionBuilder.addOutput(receiverOutput);
+if (changeAmount > pledgeAmount + minerFee) transactionBuilder.addOutput(contractChangeOutput);
+
+const tx = await transactionBuilder.send();
 
 console.log('transaction details:', stringify(tx));