v1.4.1

Merge pull request #858 from hirosystems/release/next

Release next

v1.4.0

1.4.0 (2023-01-23)

✨ Features

• Improve LSP completion capability (4cc24ed3, 16db8dd4, 905e5433, 9ffdad0f, d3a27933, cad54358, 439c4933)
• Upgrade clarity vm (fefdd1e0)
• Upgrade stacks-node next image (492804bb)
• Expose stacks-node settings wait_time_for_microblocks, first_attempt_time_ms, subsequent_attempt_time_ms in Devnet config file
• Improve Epoch 2.1 deployments handling
• Improve stacks-devnet-js stability

📚 Documentation

• Updated documentation to set clarity version of contract (b124d96f)

Credits

• @csgui
• @hstove
• @hugocaillard
• @LakshmiLavanyaKasturi
• @lgalabru
• @obycode
• @omahs
• @philipdesmedt
• @whoabuddy

v1.3.1

1.3.0 (2022-12-21)

✨ Features

• Introduce use_docker_gateway_routing setting for CI environments
• Improve signature help in LSP (eee03cff)
• Add support for more keyword help in REPL ([f564d46](f564d46, 0efcc75e)
• Various Docker management optimizations / fixes (b379d29f, 4f4c8806)
• Added chain.switchEpoch() to deno testing library

🐞 Bug fixes

• Fix STX assets title (fdc748e7, ce5d107c)
• Fix define function grammar (d02835ba)
• Fix get_costs panicking (822d8e29, e41ae715)
• Updated pox 2 contract with latest version

Credits

• @csgui
• @hugocaillard
• @lgalabru
• @obycode
• @philipdesmedt
• @whoabuddy

v1.3.0

1.3.0 (2022-12-21)

✨ Features

• Improved Clarity 2 support (#711 #714)
• Ability to configure VSCode extension features (340ba9b8)
• Ability to Go to definition in LSP (#676)
• Press n in clarinet integrate to mine new blocks manually, improve Devnet responsiveness and termination reliability
• Revamped stacks-devnet-js testing framework

🐞 Bug fixes

• Fix deployment plans issue where contracts keep being re-ordered (cf8140e6)
• Fid deno errors not being displayed (3d2db0b7)

Credits

• @gregorycoppola
• @hstove
• @hugocaillard
• @lgalabru
• @obycode
• @whoabuddy

v1.2.0

1.2.0 (2022-12-3)

✨ Features

• Improve Stacks 2.1 support
• Improve stack-devnet-js stability
• Update Clarity VM

🐞 Bug fixes

• clarinet test returns status code 1 when failing
• clarity unit test framework: support contract deploys in unit tests
• clarity unit test framework: add matcher for stx burn events

Credits

• @hstove
• @hugocaillard
• @lgalabru
• @obycode
• @whoabuddy

v1.1.0

1.1.0 (2022-11-17)

✨ Features

• Experimental Support for Stacks 2.1 (790c14bf)
• Display clarity documentation on hover in VSCode (e605acb4)

🐞 Bug fixes

• Better error management in chainhook-node (353ceb61)

🆕 Stacks 2.1 instructions

After updating clarinet open your settings/Devnet.toml file, and update the following settings:

[devnet]
...
enable_next_features = true
disable_stacks_explorer = true
disable_stacks_api = true

Spin up a local Devnet network using the command

$ clarinet integrate

And a new stacks-node will spin up. At Bitcoin block height 107, the chainstate will migrate to epoch 2.05 which was a soft introduced earlier this year, reducing the costs of operations, and at bitcoin block height 114, the chainstate will migrate to epoch 2.1.
If the contracts you're developing are using Clarity 2, you will need to wait for this epoch to be crossed, before deploying your contracts.
This block heights can be customized using the settings:

[devnet]
...
epoch_2_05 = 107
epoch_2_1 = 114

🚨 This new feature is experimental, if you experience bugs or something suspicious, please file an issue.

⚠️ Known limitations

• When running clarinet integrate with Stacks 2.1, contracts can not be automatically deployed in the current release. The default devnet deployment needs to be manually applied, using the command

$ clarinet deployments apply --devnet

• When running clarinet integrate with Stacks 2.1, the stacks-api and the stacks explorer have to be disabled, the compatibility with Stacks 2.1 is still being stabilized.

Credits

• @hugocaillard
• @lgalabru
• @obycode
• @zone117x

v1.0.6

1.0.6 (2022-11-10)

✨ Features

• Ability for chainhook-node to start with custom config (473c86ba)
• Draft bitcoin replay implementation (8580092e)

🐞 Bug fixes

• Filter out boot contracts from requirement dependencies (34fbcf96)
• Deno expect events (8bdcd392)
• Fix issue with check-checker requiring checking on bools (ef738fe3)

🧹 Chores

• Add serverless dependency in cbtc example and upgrade dependencies (f065f2b)
• Get_bitcoin_proof (5a3a8ee9)

Credits

• @aravindgee
• @CharlieC3
• @cylewitruk
• @friedger
• @hugocaillard
• @lgalabru
• @moodmosaic
• @obycode
• @Rapha-btc
• @trichards-hiro

v1.0.5

1.0.5 (2022-11-04)

✨ Features

• Many chainhooks enhancements: event payload augmented, new predicates (segwit, etc) implemented. Documentation coming soon!
• Introducing clarity-jupyter-kernel (1c118513)
• Ability to use low/medium/high cost dynamic presets in deployment plans (86219c4e)
• Ability to send STX in deployment plans (c9e3bac4)

🐞 Bug fixes

• Termination in clarinet integrate --no-dashboard mode fixed (2cdb09a6)
• Check print predicate for contained value (0f5956dc)
• Improved keyword recognition in VSCode grammar file (e690b371, 119dce57)
• Fixed stacks-js-helper generator (11562ae7)

🧹 Chores

• Types improvements clarinet deno library (3bc5c51c)
• Add tests to the clarinet deno library (d5b7555d, 062a7144)

Credits

• @aravindgee
• @aulneau
• @BowTiedDeployer
• @c0d3rk1d
• @hstove
• @hugocaillard
• @lgalabru
• @moodmosaic
• @obycode
• @whoabuddy

v1.0.4

1.0.4 (2022-10-17)

✨ Features

• Devnet chainstates now lives in cache directory specified in Clarinet.toml (a6fb383f)
• Ability to pass wildcards for chainhook testing (08f75a2a)
• Ability to use write-to-file as action (chainhooks) (fb19e392)
• Introduce stacks-network component (ace64116)

🐞 Bug fixes

• Bump ingestion limits to 5 mb (e4d539da)
• Fix invalid bitcoin txid (03783a41)
• Fix coverage tracking (1a4836d1)
• Fix crash occuring on NFTMintEvent (d5dc3fc0)
• Resolve boot contract in LSP (ad34037c)
• Better error (d42f7ed6)
• Performance optimisation with parser v2 (c1712489)

v1.0.3

1.0.3 (2022-12-10)

✨ Features

• Introducing our brand new re-architected VSCode extension (README)
• All of our tools (REPL, LSP, Clarinet) are now directly derived from the canonical Clarity VM (#512, #535, #544)
• Ability to trigger chainhooks from unit tests (#564)
• Deno integration upgraded and revisited (#511)
• Ability to specify Deno import maps (#511)
• Ability to specify TS config files (#555)
• Ability to cache Deno libraries locally (a2c2ded3)
• Bitcoin deployment plans now supports transfers to P2WPKH addresses (c50a4c27)
• Ability to detect outdated deployment plans and display diffs (#365)

🐞 Bug fixes

A myriad of issues were addressed in this new version, the most notable being:

• Cannot make http request from within clarinet test (#566)
• Clarinet CPU usage spiking to 100% when using clarinet integrate (#545)
• Clarinet console crashes when it errors (#541)
• Unhandled Division By Zero exception (#525)
• Handle errors from callReadOnlyFn in tests (#407)
• Arithmetic underflow crashes clarity-repl instead of displaying error (#471)
• Improve debugability of chain.mine_block() (#91)

📚 Documentation

• Added new example - How to use Chainhooks for indexing data (cdeca648)
• Added OpenAPI spec for Chainhooks (01e8979c)

🚨 Backward compatibility

Clarinet v1.0.0 is not backwards-compatible with older versions of the Clarinet deno library. If you are upgrading Clarinet to Clarinet v1.0.2, you will need to enter the following import command in your test files to perform this update.

import { … } from 'https://deno.land/x/[email protected]/index.ts';

Note The v1.0.0 library is not compatible with Clarinet versions <= 0.33.0. Prior versions of the library also will not be compatible with versions >= 1.0.0 of Clarinet because the layer in charge of the communication between Typescript and Rust was upgraded.
If you are using Clarinet in a Github Action, and using the tag latest (now pointing to v1.0.0), the tests will fail if the import upgrade task is not performed. If you do not want to upgrade, this is possible; however, you will need to specify the docker tag v0.33.0, instead of latest.