v0.5.0

cashc compiler

• 🛠️ Replace BITBOX with Libauth.

CashScript SDK

CashScript used to be very tightly coupled with BITBOX. This proved to be problematic after maintenance for BITBOX was stopped. The main objective of this update is to allow CashScript to be used with many different BCH libraries.

• ✨ Add withoutChange() function to disable change outputs for a transaction.
• ✨ SignatureTemplate can now be used with BITBOX keypairs, bitcore-lib-cash private keys, WIF strings, and raw private key buffers, rather than only BITBOX.
• 💥 Remove Sig alias for SignatureTemplate that was deprecated in v0.4.1.
• 💥 BREAKING: Refactor contract instantiation flow
  • A contract is now instantiated by providing a compiled artifact, constructor arguments and an optional network provider.
  • Anyone can implement the NetworkProvider interface to create a custom provider. The CashScript SDK offers three providers out of the box: one based on electrum-cash (default), one based on FullStack.cash' infrastructure, and one based on BITBOX. See the NetworkProvider docs for details.
  • See the migration notes for details on migrating from the old contract instantiation flow.
• 💥 BREAKING: Remove the artifacts 'networks' field and .deployed() functionality, This proved to be confusing and is better suited to be handled outside of the CashScript SDK.
• 💥 BREAKING: .send() now returns a libauth Transaction instead of a BITBOX Transaction object. Alternatively a raw flag can be passed into the function to return a raw hex string.
• 🛠️ Removed BITBOX as a dependency in favour of libauth for utility functions.

---

https://twitter.com/RoscoKalis/status/1298645699559596033

v0.4.4

cashc compiler

• 🐛 Fix a bug where covenants would not always get verified correctly when the first require(checkSig(...)) statement was inside a branch.

v0.4.3

cashc compiler

• 🐎 Add additional compiler optimisations.

v0.4.2

cashc compiler

• 🐛 Re-add accidentally removed README

CashScript SDK

• 🐛 Re-add accidentally removed README

v0.4.1

cashc compiler

• 🐎 Add optimisations to bitwise operators.
• 🐚 New CLI arguments.
  • Add --opcount|-c flag that displays the number of opcodes in the compiled bytecode.
  • Add --size|-s flag that displays the size in bytes of the compiled bytecode.
• 🔣 Add trailing comma support.

CashScript SDK

• 📛 Rename Sig to SignatureTemplate to better convey its meaning.
  • Sig still exists for backward compatibility, but is deprecated and will be removed in a later release.

---

https://twitter.com/RoscoKalis/status/1267440143624884227

v0.4.0

cashc compiler

• ✨ - Add .reverse() member function to bytes and string types.
• ✨ - Add bitwise operators &, ^, |.
• ✨ - Allow casting int to variable size bytes based on size parameter.
• 💥 BREAKING: Casting from int to unbounded bytes type now does not perform OP_NUM2BIN. Instead it is a purely semantic cast to signal that an integer value should be treated as a bytes value.
• 🏇 Compiler optimisations.
  • Use NUMEQUALVERIFY for the final function in a contract.
  • Only drop the final VERIFY if the remaining stack size is less than 5.
  • Precalculate OutputNullData argument size.
• 🐛 Fix a bug where return type of sha1 was incorrectly marked as bytes32.
• 🐛 Data.decodeBool only treated numerical zero as false, now any zero-representation is considered false (e.g. 0x0000, -0, ...).

CashScript SDK

• ✨ Add ability to provide hardcoded inputs to the transaction rather than use CashScript's coin selection (authored by @maikelmclauflin through #61).
• 💥 BREAKING: Refactor the transaction flow to a fluent API
  • Remove the TxOptions argument and other arguments to the Transaction send() function.
  • Instead these parameters are passed in through fluent functions from(), to(), withOpReturn(), withAge(), withTime(), withHardcodedFee(), withFeePerByte() and withMinChange().
  • After specifying at least one output with either to() or withOpReturn()the transaction is ready. From here the transaction can be sent to the network with the send() function, the transaction hex can be returned with the build() function, or the meep debugging command can be returned with the meep() function.
• 💥 Remove Contract.fromCashFile() and Contract.fromArtifact() which were deprecated in favour or Contract.compile() and Contract.import() in v0.2.2.

Migration

This update contains several breaking changes. See the migration notes for a full migration guide.

---

https://twitter.com/RoscoKalis/status/1264921879346917376

v0.3.3

cashc compiler

• 🐛 Fix bug where variables could not reliably be used inside OutputNullData instantiation.

---

https://twitter.com/RoscoKalis/status/1224389493769342979

v0.3.2

cashc compiler

• ✨ Add OutputNullData(bytes[] chunks), an output type to enforce OP_RETURN outputs.
• 🐚 CLI improvements
  • The --output|-o flag is now optional, if it is omitted or manually set to -, the artifact will be written to stdout rather than a file.
  • Add --asm|-A flag that outputs only Script in ASM format instead of a full JSON artifact.
  • Add --hex|-h flag that outputs only Script in hex format instead of a full JSON artifact.
  • Add --args|-a flag that allows you to specify constructor arguments that are added to the generated bytecode.
    • ⚠️ The CLI does not perform type checking on these arguments, so it is recommended to use the CashScript SDK for type safety.
• 🐛 Fix a compilation bug that allowed compilation of "unverified covenants" (#56).
• 🐛 Fix a compilation bug that allowed compilation of OutputP2PKH(...) without new keyword (#57).

CashScript SDK

• 🌐 Browser support! You can now use CashScript inside web projects. Filesystem-based functionality such as compilation from file are not supported due to the nature of web, so CashScript files have to be read in a different way (e.g. Fetch API) and then passed into the CashScript SDK.
• 👛 Add minChange to transaction options. If this minChange is not reached, the change will be added to the transaction fee instead.

---

https://twitter.com/RoscoKalis/status/1223280232343515136

v0.3.1

cashc compiler

• ⚠️ Add warnings when a contract exceeds 201 opcodes or 520 bytes.
• 🐛 Fix a bug where an incorrect number of items were dropped from the stack after execution of a branch.

CashScript SDK

• ✨ Improve error handling.
  • Further specified FailedTransactionError into FailedRequireError, FailedSigCheckError, FailedTimeCheckError and a general fallback FailedTransactionError.
  • Add Reason enum with all possible reasons for a Script failure - can be used to catch specific errors.
• 🔍 Add instance.opcount and instance.bytesize fields to all contract instances.
• 🐛 Fix a bug where the size of a preimage was not accounted for in fee calculation for covenants.

---

https://twitter.com/RoscoKalis/status/1217101473743544320

v0.3.0

cashc compiler

• ✨ Covenants abstraction! All individual preimage fields can be accessed without manual decoding, passing, and verification.
  • Available fields: tx.version, tx.hashPrevouts, tx.hashSequence, tx.outpoint, tx.bytecode, tx.value, tx.sequence, tx.hashOutputs, tx.locktime, tx.hashtype.
  • When any of these fields is used inside a function, this function is marked covenant: true, and requires a preimage as parameter (automatically passed by CashScript SDK).
  • The correct fields are efficiently cut out of the preimage and made available.
  • The first occurrance of require(checkSig(sig, pubkey)); is identified, and preimage verification is inserted using the same sig/pubkey. Important: if you have multiple checkSig statements, keep in mind that the first will be used for verification.
  • Automatically cuts off VarInt from scriptCode, so tx.bytecode contains the actual contract bytecode.
• ✨ Output instantiation! Automatically construct output formats for covenant transactions.
  • new OutputP2PKH(bytes8 amount, bytes20 pkh)
  • new OutputP2SH(bytes8 amount, bytes20 scriptHash)
• 🐛 Fix bug with invalid output when the final statement in a contract is an if-statement.

CashScript SDK

• ✨ Add fee option to TransactionOptions. This allows you to specify a hardcoded fee for your transaction.
• ✨ Automatically pass in sighash preimage into covenant functions. Important: uses the hashtype of the first signature in the parameters for generation of this preimage.
• 💫 Better fee estimation for transactions with many inputs.

---

https://twitter.com/RoscoKalis/status/1204765863062188033