Skip to content

Commit

Permalink
Merge pull request #160 from OffchainLabs/rel-0.6.0
Browse files Browse the repository at this point in the history
Add changelog and bump version numbers
  • Loading branch information
rauljordan authored Aug 31, 2024
2 parents bd4bd9c + 446eeef commit 29dc097
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 5 deletions.
51 changes: 51 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Changelog

These crates follow [semver](https://semver.org).

## [0.6.0](https://github.com/OffchainLabs/stylus-sdk-rs/releases/tag/v0.6.0) - 2024-08-30

### Breaking Changes

- `#[selector(id = ...)]` syntax has been removed to avoid misleading contracts
from being implemented.
- Several methods in `RawDeploy` which were not fully implemented yet
- `#[pure]`, `#[view]` and `#[write]` attributes have been removed in favor of
using arguments to infer state mutability.
- `stylus-sdk` now ships with `mini-alloc` enabled by default. This means that
a `#[global_allocator]` should not be declared in most cases. If a custom
allocator is still needed the `mini-alloc` should be disabled (enabled by
default).
- `StorageU1` and `StorageI1` types have been removed.

### Deprecated

- The `#[external]` macro is now deprecated in favor of `#[public]` which
provides the same funcitonality.
- The `#[solidity_storage]` macro is now deprecated in favor of `#[storage]`
which provides the same functionality.

### Changed

- Ensure consistency between proc macros when parsing attributes.
- Update `sol_interface!` macro to report errors when using Solidity features
which have not yet been implemented.

### Fixed

- Properly encode bytes when calling external contracts.
- Properly encode BYtes and strings in return types.
- Bytes type now works properly in `export-abi`.
- `export-abi` now works for contracts with no functions with returned values.
- Off-by-one error when storing strings with length 32.
- Interfaces in `sol_interface!` no longer incorrectly inherit functions from
previous definitions.

### Documentation

- Various documentation updates for clarity.
- Cleaned up typos and moved TODOs to the github issue tracker.

### Security

- Function signatures which generate the same selector values will now fail
at compile-time to avoid misleading contract calls.
6 changes: 3 additions & 3 deletions Cargo.lock

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

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ members = ["stylus-sdk", "stylus-proc", "mini-alloc"]
resolver = "2"

[workspace.package]
version = "0.5.2"
version = "0.6.0"
edition = "2021"
authors = ["Offchain Labs"]
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -33,4 +33,4 @@ convert_case = "0.6.0"
# members
mini-alloc = { path = "mini-alloc" }
stylus-sdk = { path = "stylus-sdk" }
stylus-proc = { path = "stylus-proc", version = "0.5.2" }
stylus-proc = { path = "stylus-proc", version = "0.6.0" }

0 comments on commit 29dc097

Please sign in to comment.