Skip to content

Commit

Permalink
Merge branch 'develop' into update-cli-commands
Browse files Browse the repository at this point in the history
  • Loading branch information
LakshmiLavanyaKasturi authored Jul 19, 2023
2 parents 504dcb6 + dcc0b92 commit 174636a
Show file tree
Hide file tree
Showing 35 changed files with 840 additions and 447 deletions.
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributing

Thank you for considering contributing to this product! We welcome any contributions, whether it's bug fixes, new features, or improvements to the existing codebase.

### Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:

[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

To help you get familiar with our contribution process, we have a list of [good first issues](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) that contain enhancements or bugs that have a relatively limited scope. This is a great place to get started.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.

If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment. **Issues won't be assigned to anyone outside the core team**.

### Contribution Prerequisites

... 🚧 Work in progress 🚧 ...
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'Bug'

---

**Describe the bug**
A clear and concise description of what the bug is.


**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots or consol.log to help explain your problem.

**Environment (please complete the following information):**
- OS (version): [e.g. macOS (13.4.1)]
- Docker version [e.g. 24.0.4]
- Clarinet version [e.g. 1.7.0] - Please use the latest version


**Additional context**
Add any other context about the problem here:
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Ask the community
url: https://discord.gg/KrqnVg8D
about: Ask and discuss questions with other Stacks community developers.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'enhancement'

---

**Please review the existing enhancement issues at the link below before creating a new one to ensure you do not create a duplicate request.**
If you see an [existing enhancement issues](https://github.com/blockstack/explorer/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) please comment on the issue or upvote the issue with a :thumbsup:


**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Description

<!-- Describe the bug this PR fixes or the feature it adds. Link to any related issues and PRs -->

#### Breaking change?

<!-- If applicable, list the APIs/functionality which this PR breaks -->

### Example

<!-- If applicable, add an example on how this improves the application -->

---

### Checklist

- [ ] Tests added in this PR (if applicable)

34 changes: 25 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
#### [1.7.1](https://github.com/hirosystems/clarinet/compare/v1.7.0...v1.7.1) (2023-07-19)

##### Chores

* Update default epoch to 2.4 (#1082) (fcabffac)
* Update subnet node to 0.8.1 (#1081) (db547ce8)
* Update subnet image and contract version (4dd02518)

##### Bug Fixes

* Fix clarity version of nested requirements (#1080) (ced0faab)
* Safety check on invalid line number in coverage (#1085) (29eb81b9)
* Add FAUCET_PRIVATE_KEY to stacks-blockchain-api env (#1071) (ab121210)
* Add `--allow-read` flag to allow filesystem read access in `clarinet test` (#1060) (4de49fde)
* Fix Panic at get_current_block_height for unexisting block (#1061) (edb77595)

# [1.7.0](https://github.com/hirosystems/clarinet/compare/v1.6.1...v1.7.0) (2023-06-14)
##### New Features

Expand All @@ -6,26 +22,26 @@

##### Chores

* update chainhook-sdk (5eed0bf6)
* update chainhook-types (57a7957d)
* handle clarity-vm 2.1 (#1037) (7fe94b80)
* bump clarity repl to 1.6.4 (#1036) (3bad4177)
* remove unused deps (#1032) (c30af614)
* Update chainhook-sdk (5eed0bf6)
* Update chainhook-types (57a7957d)
* Handle clarity-vm 2.1 (#1037) (7fe94b80)
* Bump clarity repl to 1.6.4 (#1036) (3bad4177)
* Remove unused deps (#1032) (c30af614)

# [1.6.1](https://github.com/hirosystems/clarinet/compare/v1.6.0...v1.6.1) (2023-05-16)

*Note* This release fixes the build of v1.6.0

##### Chores

* upgrade uuid crate (5b9b4015)
* upgrade lsp dependencies (be8d2ceb)
* Upgrade uuid crate (5b9b4015)
* Upgrade lsp dependencies (be8d2ceb)

##### Bug Fixes

* **lsp:**
* functions first parameter highlighting (9a28a9a1)
* clarity keywords syntax highlighting (724379dc)
* Functions first parameter highlighting (9a28a9a1)
* Clarity keywords syntax highlighting (724379dc)

# [1.6.0](https://github.com/hirosystems/clarinet/compare/v1.5.3...v1.6.0) (2023-05-09)

Expand Down
24 changes: 12 additions & 12 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ You must first [Install Rust](https://www.rust-lang.org/tools/install) to use th
If you are using Debian and Ubuntu-based distributions, make sure to run the following command to install required packages before building Clarinet.

```bash
sudo apt install build-essential pkg-config libssl-dev
sudo apt install build-essential pkg-config libssl-dev curl
```

#### Build Clarinet
Expand Down Expand Up @@ -745,6 +745,16 @@ clarinet integrate

Clarinet will spin-up a subnet node. More documentation on how to use and interact with this incoming L2 can be found on the [Hyperchain repository](https://github.com/hirosystems/stacks-subnets).

## Bugs and feature requests

If you encounter a bug or have a feature request, we encourage you to follow the steps below:

1. **Search for existing issues:** Before submitting a new issue, please search [existing and closed issues](../../issues) to check if a similar problem or feature request has already been reported.
1. **Open a new issue:** If it hasn't been addressed, please [open a new issue](../../issues/new/choose). Choose the appropriate issue template and provide as much detail as possible, including steps to reproduce the bug or a clear description of the requested feature.
1. **Evaluation SLA:** Our team reads and evaluates all the issues and pull requests. We are avaliable Monday to Friday and we make a best effort to respond within 7 business days.

Please **do not** use the issue tracker for personal support requests or to ask for the status of a transaction. You'll find help at the [#support Discord channel](https://discord.gg/SK3DxdsP).

## Contributing to Clarinet

Contributions are welcome and appreciated. The following sections provide information on how you can contribute to Clarinet.
Expand Down Expand Up @@ -814,3 +824,16 @@ To start contributing:
done
```
6. Submit a pull request against the `develop` branch for review.

### Code of Conduct
Please read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it.

## Community

Join our community and stay connected with the latest updates and discussions:

- [Join our Discord community chat](https://discord.gg/ZQR6cyZC) to engage with other users, ask questions, and participate in discussions.

- [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the mailing list.

- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)
2 changes: 1 addition & 1 deletion components/clarinet-cli/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "clarinet-cli"
version = "1.7.0"
version = "1.7.1"
authors = ["Ludo Galabru <[email protected]>", "Brice Dobry <[email protected]>"]
edition = "2021"
description = "Clarinet is a simple, modern and opinionated runtime for testing, integrating and deploying Clarity smart contracts."
Expand Down
6 changes: 3 additions & 3 deletions components/clarinet-cli/examples/cbtc/serverless/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3110,9 +3110,9 @@ seek-bzip@^1.0.5:
commander "^2.8.1"

semver@^6.0.0:
version "6.3.0"
resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
version "6.3.1"
resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4"
integrity sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==

[email protected]:
version "11.3.0"
Expand Down
4 changes: 4 additions & 0 deletions components/clarinet-cli/examples/swappool/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
**/settings/Mainnet.toml
**/settings/Testnet.toml
.cache/**
history.txt
23 changes: 23 additions & 0 deletions components/clarinet-cli/examples/swappool/Clarinet.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[project]
name = 'swappool'
description = ''
authors = []
telemetry = false
cache_dir = './.cache'

[[project.requirements]]
contract_id = 'SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1'

[contracts.empty]
path = 'contracts/empty.clar'
clarity_version = 2
epoch = 2.4

[repl.analysis]
passes = ['check_checker']

[repl.analysis.check_checker]
strict = false
trusted_sender = false
trusted_caller = false
callee_filter = false
10 changes: 10 additions & 0 deletions components/clarinet-cli/examples/swappool/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Description

The purpose of this example is too make sure that clarinet properly handles the clarity versions of contracts dependencies.

This project only has a requirements:
`SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.amm-swap-pool-v1-1`, which relies on `SP3K8...KBR9.alex-vault-v1-1` which itself relies on the [semi-fongible trait contract](https://explorer.hiro.so/txid/0x74db763fbaa66da3368e642ddac48dc5ac81f3c6e5a9b1aaf358c5745608fdde).

The semi-fongible contract caused issues in the past because it's valid with Clarity 1 contract but **invalid** with Clarity 2. (The function `get-total-supply-fixed` is declared twice, which is now illegal). So when loaded with the wrong clarity version, this dependency would lead to issue.

Reference issues: #997, #1079.
Loading

0 comments on commit 174636a

Please sign in to comment.