Skip to content

Commit 9dcbec6

Browse files
chipshortchipshort
authored
Merge pull request #2384 from CosmWasm/mergify/bp/release/2.2/pr-2337
Deprecate `abort` feature (backport #2337)
2 parents ccd7f0b + 14580c6 commit 9dcbec6

File tree

12 files changed

+44
-43
lines changed

12 files changed

+44
-43
lines changed

‎.circleci/config.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,8 @@ jobs:
10901090
- run:
10911091
name: Clippy linting on std (all feature flags)
10921092
working_directory: ~/project/packages/std
1093-
command: cargo clippy --all-targets --tests --all-features -- -D warnings
1093+
# change to --all-features once `abort` is removed
1094+
command: cargo clippy --all-targets --tests --features staking,stargate,cosmwasm_2_2 -- -D warnings
10941095
- run:
10951096
name: Clippy linting on vm (no feature flags)
10961097
working_directory: ~/project/packages/vm

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ and this project adheres to
88

99
## [Unreleased]
1010

11+
### Changed
12+
13+
- cosmwasm-std: Deprecate `abort` feature. The panic handler is now always
14+
enabled. ([#2384])
15+
16+
[#2384]: https://github.com/CosmWasm/cosmwasm/pull/2384
17+
1118
## [2.2.1] - 2025-02-04
1219

1320
## Added

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,11 @@ extern "C" fn ibc_packet_ack(env_ptr: u32, msg_ptr: u32) -> u32;
190190
extern "C" fn ibc_packet_timeout(env_ptr: u32, msg_ptr: u32) -> u32;
191191
```
192192

193-
`allocate`/`deallocate` allow the host to manage data within the Wasm VM. If
194-
you're using Rust, you can implement them by simply
195-
[re-exporting them from cosmwasm::exports](https://github.com/CosmWasm/cosmwasm/blob/v0.6.3/contracts/hackatom/src/lib.rs#L5).
196-
`instantiate`, `execute` and `query` must be defined by your contract.
193+
`allocate` and `deallocate` allow the host to manage data within the Wasm VM. If
194+
you're using Rust, you get them automatically by using the `cosmwasm-std` crate.
195+
Your contract can define the other entrypoints using the
196+
`cosmwasm_std::entry_point` macro to get strong typing instead of raw memory
197+
offsets.
197198

198199
### Imports
199200

‎contracts/cyberpunk/Cargo.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ overflow-checks = true
2323
[dependencies]
2424
cosmwasm-schema = { path = "../../packages/schema" }
2525
cosmwasm-std = { path = "../../packages/std", default-features = false, features = [
26-
"abort",
2726
"cosmwasm_1_3",
2827
"std",
2928
] }

‎contracts/hackatom/Cargo.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ overflow-checks = true
2525
[dependencies]
2626
cosmwasm-schema = { path = "../../packages/schema" }
2727
cosmwasm-std = { path = "../../packages/std", default-features = false, features = [
28-
"abort",
2928
"cosmwasm_2_2",
3029
"std",
3130
] }

‎devtools/check_workspace.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ cargo fmt
1010
# default, min, all
1111
cargo check
1212
cargo check --no-default-features --features std
13-
cargo check --features std,abort,iterator,staking,stargate,cosmwasm_1_2
13+
cargo check --features std,iterator,staking,stargate,cosmwasm_1_2
1414
cargo wasm-debug
1515
cargo wasm-debug --features std,iterator,staking,stargate
1616
cargo clippy --all-targets --features std,iterator,staking,stargate -- -D warnings

‎docs/USING_COSMWASM_STD.md‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ extern "C" fn deallocate(pointer: u32) { /* ... */ }
1616

1717
// Imports
1818
extern "C" {
19-
#[cfg(feature = "abort")]
2019
fn abort(source_ptr: u32);
2120

2221
fn db_read(key: u32) -> u32;
@@ -34,16 +33,16 @@ in the dependency tree. Otherwise conflicting C exports are created.
3433

3534
The library comes with the following features:
3635

37-
| Feature | Enabled by default | Description |
38-
| ------------ | ------------------ | ------------------------------------------------------------------------- |
39-
| iterator | x | Storage iterators |
40-
| abort | x | A panic handler that aborts the contract execution with a helpful message |
41-
| stargate | | Cosmos SDK 0.40+ features and IBC |
42-
| staking | | Access to the staking module |
43-
| cosmwasm_1_1 | | Features that require CosmWasm 1.1+ on the chain |
44-
| cosmwasm_1_2 | | Features that require CosmWasm 1.2+ on the chain |
45-
| cosmwasm_1_3 | | Features that require CosmWasm 1.3+ on the chain |
46-
| cosmwasm_1_4 | | Features that require CosmWasm 1.4+ on the chain |
36+
| Feature | Enabled by default | Description |
37+
| ------------ | ------------------ | ------------------------------------------------------------------------------------ |
38+
| iterator | x | Storage iterators |
39+
| abort | x | DEPRECATED A panic handler that aborts the contract execution with a helpful message |
40+
| stargate | | Cosmos SDK 0.40+ features and IBC |
41+
| staking | | Access to the staking module |
42+
| cosmwasm_1_1 | | Features that require CosmWasm 1.1+ on the chain |
43+
| cosmwasm_1_2 | | Features that require CosmWasm 1.2+ on the chain |
44+
| cosmwasm_1_3 | | Features that require CosmWasm 1.3+ on the chain |
45+
| cosmwasm_1_4 | | Features that require CosmWasm 1.4+ on the chain |
4746

4847
## The cosmwasm-std dependency for contract developers
4948

@@ -71,9 +70,9 @@ cosmwasm-std = { version = "1.2.0", features = ["stargate", "cosmwasm_1_2"] }
7170
When you are creating a library that uses cosmwasm-std, you should be incredibly
7271
careful with which features you require. The moment you add e.g. `cosmwasm_1_2`
7372
there it becomes impossible to use the contract in chains with lower CosmWasm
74-
versions. If you add `abort`, it becomes impossible for the contract developer
75-
to opt out of the abort feature due to your library. Since this affects the
76-
default features `abort` and `iterator`, you should always disable default
73+
versions. If you add `iterator`, it becomes impossible for the contract
74+
developer to opt out of the iterator feature due to your library. Since this
75+
affects the default feature `iterator`, you should always disable default
7776
features. However, you should make sure to keep the `std` feature enabled, as we
7877
might move certain existing functionality to that feature in the future.
7978

‎packages/std/Cargo.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ readme = "README.md"
1212
features = ["abort", "cosmwasm_2_2", "staking", "stargate"]
1313

1414
[features]
15-
default = ["abort", "iterator", "std"]
15+
default = ["iterator", "std"]
16+
# abort used to enable the panic handler that hands a nice error message back to the host.
17+
# The feature is now deprecated and the panic handler is always enabled.
1618
abort = []
1719
std = []
1820
# iterator allows us to iterate over all DB items in a given range

‎packages/std/src/exports.rs‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ use crate::ibc::{
2222
use crate::ibc::{IbcChannelOpenMsg, IbcChannelOpenResponse};
2323
use crate::imports::{ExternalApi, ExternalQuerier, ExternalStorage};
2424
use crate::memory::{Owned, Region};
25-
#[cfg(feature = "abort")]
2625
use crate::panic::install_panic_handler;
2726
use crate::query::CustomQuery;
2827
use crate::results::{ContractResult, QueryResponse, Reply, Response};
@@ -128,7 +127,6 @@ where
128127
C: CustomMsg,
129128
E: ToString,
130129
{
131-
#[cfg(feature = "abort")]
132130
install_panic_handler();
133131
let res = _do_instantiate(
134132
instantiate_fn,
@@ -158,7 +156,6 @@ where
158156
C: CustomMsg,
159157
E: ToString,
160158
{
161-
#[cfg(feature = "abort")]
162159
install_panic_handler();
163160
let res = _do_execute(
164161
execute_fn,
@@ -187,7 +184,6 @@ where
187184
C: CustomMsg,
188185
E: ToString,
189186
{
190-
#[cfg(feature = "abort")]
191187
install_panic_handler();
192188
let res = _do_migrate(
193189
migrate_fn,
@@ -218,7 +214,6 @@ where
218214
C: CustomMsg,
219215
E: ToString,
220216
{
221-
#[cfg(feature = "abort")]
222217
install_panic_handler();
223218
let res = _do_migrate_with_info(
224219
migrate_with_info_fn,
@@ -247,7 +242,6 @@ where
247242
C: CustomMsg,
248243
E: ToString,
249244
{
250-
#[cfg(feature = "abort")]
251245
install_panic_handler();
252246
let res = _do_sudo(
253247
sudo_fn,
@@ -274,7 +268,6 @@ where
274268
C: CustomMsg,
275269
E: ToString,
276270
{
277-
#[cfg(feature = "abort")]
278271
install_panic_handler();
279272
let res = _do_reply(
280273
reply_fn,
@@ -300,7 +293,6 @@ where
300293
M: DeserializeOwned,
301294
E: ToString,
302295
{
303-
#[cfg(feature = "abort")]
304296
install_panic_handler();
305297
let res = _do_query(
306298
query_fn,
@@ -327,7 +319,6 @@ where
327319
Q: CustomQuery,
328320
E: ToString,
329321
{
330-
#[cfg(feature = "abort")]
331322
install_panic_handler();
332323
let res = _do_ibc_channel_open(
333324
contract_fn,
@@ -356,7 +347,6 @@ where
356347
C: CustomMsg,
357348
E: ToString,
358349
{
359-
#[cfg(feature = "abort")]
360350
install_panic_handler();
361351
let res = _do_ibc_channel_connect(
362352
contract_fn,
@@ -385,7 +375,6 @@ where
385375
C: CustomMsg,
386376
E: ToString,
387377
{
388-
#[cfg(feature = "abort")]
389378
install_panic_handler();
390379
let res = _do_ibc_channel_close(
391380
contract_fn,
@@ -415,7 +404,6 @@ where
415404
C: CustomMsg,
416405
E: ToString,
417406
{
418-
#[cfg(feature = "abort")]
419407
install_panic_handler();
420408
let res = _do_ibc_packet_receive(
421409
contract_fn,
@@ -445,7 +433,6 @@ where
445433
C: CustomMsg,
446434
E: ToString,
447435
{
448-
#[cfg(feature = "abort")]
449436
install_panic_handler();
450437
let res = _do_ibc_packet_ack(
451438
contract_fn,
@@ -476,7 +463,6 @@ where
476463
C: CustomMsg,
477464
E: ToString,
478465
{
479-
#[cfg(feature = "abort")]
480466
install_panic_handler();
481467
let res = _do_ibc_packet_timeout(
482468
contract_fn,
@@ -497,7 +483,6 @@ where
497483
C: CustomMsg,
498484
E: ToString,
499485
{
500-
#[cfg(feature = "abort")]
501486
install_panic_handler();
502487
let res = _do_ibc_source_callback(
503488
contract_fn,
@@ -522,7 +507,6 @@ where
522507
C: CustomMsg,
523508
E: ToString,
524509
{
525-
#[cfg(feature = "abort")]
526510
install_panic_handler();
527511
let res = _do_ibc_destination_callback(
528512
contract_fn,

‎packages/std/src/imports.rs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const HUMAN_ADDRESS_BUFFER_LENGTH: usize = 90;
2727
// A complete documentation those functions is available in the VM that provides them:
2828
// https://github.com/CosmWasm/cosmwasm/blob/v1.0.0-beta/packages/vm/src/instance.rs#L89-L206
2929
extern "C" {
30-
#[cfg(feature = "abort")]
30+
3131
fn abort(source_ptr: u32);
3232

3333
fn db_read(key: u32) -> u32;
@@ -744,7 +744,6 @@ impl Querier for ExternalQuerier {
744744
}
745745
}
746746

747-
#[cfg(feature = "abort")]
748747
pub fn handle_panic(message: &str) {
749748
let region = Region::from_slice(message.as_bytes());
750749
let region_ptr = region.as_ptr() as u32;

0 commit comments

Comments
 (0)