CHANGELOG.md

Changelog

[unreleased]

• Introduce #[callback_result] annotation, which acts like #[callback] except that it returns Result<T, PromiseError> to allow error handling. PR 554
  • Adds #[callback_unwrap] to replace callback
• mock: Update method_names field of AddKeyWithFunctionCall to a Vec<String> from Vec<Vec<u8>>. PR 555
  • Method names were changed to be strings in 4.0.0-pre.2 but this one was missed
• env: Update the register used for temporary env methods to u64::MAX - 2 from 0. PR 557.
  • When mixing using sys and env, reduces chance of collision for using 0

4.0.0-pre.2 [08-19-2021]

• Update panic and panic_utf8 syscall signatures to indicate they do not return. PR 489
• Deprecate env::panic in favor of env::panic_str. PR 492
  • This method now takes a &str as the bytes are enforced to be utf8 in the runtime.
  • Change is symmetric to env::log_str change in 4.0.0-pre.1
• Removes PublicKey generic on env promise batch calls. Functions now just take a reference to the PublicKey. PR 495
• fix: Public keys can no longer be borsh deserialized from invalid bytes. PR 502
  • Adds Hash derive to PublicKey
• Changes method name parameters from bytes (Vec<u8> and &[u8]) to string equivalents for batch function call promises PR 515
  • promise_batch_action_function_call, Promise::function_call, promise_batch_action_add_key_with_function_call, Promise::add_access_key, and Promise::add_access_key_with_nonce are afffected.
  • Updates promise_then, promise_create, and Receipt::FunctionCall's method name to string equivalents from bytes PR 521.
  • Instead of b"method_name" just use "method_name", the bytes are enforced to be utf8 in the runtime.
• Fixes #[ext_contract] codegen function signatures to take an AccountId instead of a generic ToString and converting unchecked to AccountId. PR 518
• Fixes NFT contract standard mint function to not be in the NonFungibleTokenCore trait. PR 525
  • If using the mint function from the code generated function on the contract, switch to call it on the NonFungibleToken field of the contract (self.mint(..) => self.token.mint(..))
• Fixes nft_is_approved method on contract standard to take &self instead of moving self.
• Fixes receiver_id in mock::Receipt to AccountId from string. This is a change to the type added in 4.0.0-pre.1. PR 529
• Moves runtime syscalls to near-sys crate and includes new functions available PR 507

4.0.0-pre.1 [07-23-2021]

• Implements new LazyOption type under unstable feature. Similar to Lazy but is optional to set a value. PR 444.
• Move type aliases and core types to near-sdk to avoid coupling. PR 415.
• Implements new Lazy type under the new unstable feature which is a lazily loaded storage value. PR 409.
• fix(promise): PromiseOrValue now correctly sets should_return flag correctly on serialization. PR 407.
• fix(tree_map): Correctly panic when range indices are exluded and start > end. PR 392.
• Implement FromStr for json types to allow calling .parse() to convert them.
  • ValidAccountId PR 391.
  • Base58CryptoHash PR 398.
  • Base58PublicKey PR 400.
• expose cur_block and genesis_config from RuntimeStandalone to configure simulation tests. PR 390.
• fix(simulator): failing with long chains. PR 385.
• Make block time configurable to sim contract tests. PR 378.
• Deprecate env::log in favour of env::log_str. The logs assume that the bytes are utf8, so this will be a cleaner interface to use. PR 366.
• Update syscall interface to no longer go through BLOCKCHAIN_INTERFACE. Instead uses near_sdk::sys which is under the unstable feature flag if needed. PR 417.
• Set up global allocator by default for WASM architectures. PR 429.
  • This removes the re-export of wee_alloc because if this feature is enabled, the allocator will already be set.
  • Deprecates setup_alloc! macro as this will be setup by default, as long as the wee_alloc feature is not specifically disabled. In this case, the allocator can be overriden to a custom one or set manually if intended.
• Update TreeMap iterator implementation to avoid unnecessary storage reads. PR 428.
• Update AccountId to be a newtype with merged functionality from ValidAccountId. PR 448
  • Removes ValidAccountId to avoid having multiple types for account IDs.
  • This type will have ValidAccountId's JSON (de)serialization and the borsh serialization will be equivalent to what it was previously
• Initializes default for BLOCKCHAIN_INTERFACE to avoid requiring to initialize testing environment for tests that don't require custom blockchain interface configuration. PR 450
  • This default only affects outside of wasm32 environments and is optional/backwards compatible
• Deprecates env::block_index and replaces it with env::block_height for more consistent naming. PR 474
• Updates internal NFT traits to not move the underlying type for methods. PR 475
  • This should not be a breaking change if using the impl macros, only if implementing manually
• Makes BLOCKCHAIN_INTERFACE a concrete type and no longer exports it. PR 451
  • If for testing you need this mocked blockchain, near_sdk::mock::with_mocked_blockchain can be used
  • near_sdk::env::take_blockchain_interface is removed, as this interface is no longer optional
  • removes BlockchainInterface trait, as this interface is only used in mocked contexts now
• Updates Gas type to be a newtype, which makes the API harder to misuse. PR 471
  • This also changes the JSON serialization of this type to a string, to avoid precision loss when deserializing in JavaScript
• PublicKey now utilizes Base58PublicKey instead of Vec<u8> directly PR 453. Usage of Base58PublicKey is deprecated
• Expose Receipt and respective VmActions in mocked contexts through replacing with a local interface and types. PR 479

3.1.0 [04-06-2021]

• Updated dependencies for near-sdk
• Introduce trait IntoStorageKey and updating all persistent collections to take it instead of Vec<u8>. It's a non-breaking change.
• Introduce a macro derive BorshStorageKey that implements IntoStorageKey using borsh serialization. Example:

use near_sdk::BorshStorageKey;

#[derive(BorshSerialize, BorshStorageKey)]
enum StorageKey {
    Records,
    UniqueValues,
}

#[near_bindgen]
#[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)]
pub struct StatusMessage {
    pub records: LookupMap<String, String>,
    pub unique_values: LookupSet<String>,
}

#[near_bindgen]
impl StatusMessage {
    #[init]
    pub fn new() -> Self {
        Self {
            records: LookupMap::new(StorageKey::Records),
            unique_values: LookupSet::new(StorageKey::UniqueValues),
        }
    }
}

3.0.1 [03-25-2021]

• Introduced #[private] method decorator, that verifies predecessor_account_id() == current_account_id(). NOTE: Usually, when a contract has to have a callback for a remote cross-contract call, this callback method should only be called by the contract itself. It's to avoid someone else calling it and messing the state. Pretty common pattern is to have an assert that validates that the direct caller (predecessor account ID) matches to the contract's account (current account ID).
• Added how to build contracts with reproducible builds.
• Added log! macro to log a string from a contract similar to println! macro.
• Added test_utils mod from near_sdk that contains a bunch of helper methods and structures, e.g.
  • test_env - simple test environment mod used internally.
  • Expanded testing_env to be able to pass promise results
  • Added VMContextBuilder to help construct a VMContext for tests
  • Added get_logs method that returns current logs from the contract execution.
  • TEST_BREAKING env::created_receipts moved to test_utils::get_created_receipts. env shouldn't contain testing methods.
  • Updated a few examples to use log! macro
• Added #[derive(PanicOnDefault)] that automatically implements Default trait that panics when called. This is helpful to prevent contracts from being initialized using Default by removing boilerplate code.
• Introduce setup_alloc macro that generates the same boilerplate as before, but also adds a #[cfg(target_arch = "wasm32")], which prevents the allocator from being used when the contract's main file is used in simulation testing.
• Introduce Base58CryptoHash and CryptoHash to represent 32 bytes slice of u8.
• Introduce LazyOption to keep a single large value with lazy deserialization.
• BREAKING #[init] now checks that the state is not initialized. This is expected behavior. To ignore state check you can call #[init(ignore_state)]
• NOTE: 3.0.0 is not published, due to tag conflicts on the near-sdk-rs repo.

2.0.1 [01-13-2021]

• Pinned version of syn crate to =1.0.57, since 1.0.58 introduced a breaking API change.

2.0.0 [08-25-2020]

Contract changes

• Updated status-message-collections to use LookupMap
• BREAKING Updated fungible-token implementation to use LookupMap. It changes storage layout.

API changes

• Introduce LookupMap and LookupSet that are faster implementations of UnorderedMap and UnorderedSet, but without support for iterators. Most read/lookup/write are done in 1 storage access instead of 2 or 3 for Unordered* implementations.
• BREAKING Default is removed from near_sdk::collections to avoid implicit state conflicts. Collections should be initialized by explicitly specifying prefix using new method.
• BREAKING TreeMap implementation was updated to use LookupMap. Previous TreeMap implementation was renamed to LegacyTreeMap and was deprecated. It should only be used if the contract was already deployed and state has to be compatible with the previous implementation.

1.0.1 [08-22-2020]

Other changes

• Remove requirements for input args types to implement serde::Serialize and for return types to implement serde::Deserialize.

Fix

• Bumped dependency version of near-vm-logic and near-runtime-fees to 2.0.0 that changed VMLogic interface.

1.0.0 [07-13-2020]

Other changes

• Re-export common crates to be reused directly from near_sdk.
• Added ValidAccountId to json_types which validates the input string during deserialization to be a valid account ID.
• Added Debug to Base58PublicKey.
• Bumped dependency version of borsh to 0.7.0.
• Bumped dependency version of near-vm-logic and near-runtime-fees to 1.0.0.
• Implemented Debug trait for Vector collection that can be enabled with expensive-debug feature.

Contract changes

• Use re-exported crate dependencies through near_sdk crate.

0.11.0 [06-08-2020]

API breaking changes

• Renamed Map to UnorderedMap and Set to UnorderedSet to reflect that one cannot rely on the order of the elements in them. In this PR and in near#154

Other changes

• Added ordered tree implementation based on AVL, see TreeMap. near#154

• Made module generated by ext_contract macro public, providing more flexibility for the usage: near#150

Contract changes

• Fungible token now requires from the users to transfer NEAR tokens to pay for the storage increase to prevent the contract from locking the users from operating on it. near#173
• Renaming method of fungible token set_allowance => inc_allowance. Added dec_allowance method. near#174
• Remove possibility to do self-transfer in fungible token. near#176
• Improving fungible token comments near#177
• Add account check to get_balance in fungible token near#175
• In fungible token remove account from storage if its balance is 0 near#179