Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(axelar-std-derive): add contractstorage attribute macro #216

Merged
merged 33 commits into from
Jan 30, 2025

Conversation

nbayindirli
Copy link
Contributor

@nbayindirli nbayindirli commented Jan 27, 2025

AXE-7205

Example generation:

#[contracttype]
enum DataKey {
Counter,
Message(Address),
LastCaller(u64),
Flag(String, Address),
OptionalMessage(u32),
}
impl DataKey {
pub fn counter(env: &soroban_sdk::Env) -> Option<u32> {
let key = DataKey::Counter;
let value = env.storage().instance().get::<_, u32>(&key);
if value.is_some() {
stellar_axelar_std::ttl::extend_instance_ttl(env);
}
value
}
pub fn set_counter(env: &soroban_sdk::Env, value: &u32) {
let key = DataKey::Counter;
env.storage().instance().set(&key, value);
stellar_axelar_std::ttl::extend_instance_ttl(env);
}
pub fn delete_counter(env: &soroban_sdk::Env) {
let key = DataKey::Counter;
env.storage().instance().remove(&key);
}
pub fn message(env: &soroban_sdk::Env, sender: Address) -> Option<String> {
let key = DataKey::Message(sender);
let value = env.storage().persistent().get::<_, String>(&key);
if value.is_some() {
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
value
}
pub fn set_message(env: &soroban_sdk::Env, sender: Address, value: &String) {
let key = DataKey::Message(sender);
env.storage().persistent().set(&key, value);
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
pub fn delete_message(env: &soroban_sdk::Env, sender: Address) {
let key = DataKey::Message(sender);
env.storage().persistent().remove(&key);
}
pub fn last_caller(env: &soroban_sdk::Env, timestamp: u64) -> Option<Address> {
let key = DataKey::LastCaller(timestamp);
let value = env.storage().temporary().get::<_, Address>(&key);
if value.is_some() {}
value
}
pub fn set_last_caller(env: &soroban_sdk::Env, timestamp: u64, value: &Address) {
let key = DataKey::LastCaller(timestamp);
env.storage().temporary().set(&key, value);
}
pub fn delete_last_caller(env: &soroban_sdk::Env, timestamp: u64) {
let key = DataKey::LastCaller(timestamp);
env.storage().temporary().remove(&key);
}
pub fn flag(env: &soroban_sdk::Env, key: String, owner: Address) -> Option<bool> {
let key = DataKey::Flag(key, owner);
let value = env.storage().persistent().get::<_, bool>(&key);
if value.is_some() {
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
value
}
pub fn set_flag(env: &soroban_sdk::Env, key: String, owner: Address, value: &bool) {
let key = DataKey::Flag(key, owner);
env.storage().persistent().set(&key, value);
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
pub fn delete_flag(env: &soroban_sdk::Env, key: String, owner: Address) {
let key = DataKey::Flag(key, owner);
env.storage().persistent().remove(&key);
}
pub fn optional_message(env: &soroban_sdk::Env, id: u32) -> Option<Option<String>> {
let key = DataKey::OptionalMessage(id);
let value = env.storage().persistent().get::<_, Option<String>>(&key);
if value.is_some() {
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
value
}
pub fn set_optional_message(
env: &soroban_sdk::Env,
id: u32,
value: &Option<String>,
) {
let key = DataKey::OptionalMessage(id);
env.storage().persistent().set(&key, value);
stellar_axelar_std::ttl::extend_persistent_ttl(env, &key);
}
pub fn delete_optional_message(env: &soroban_sdk::Env, id: u32) {
let key = DataKey::OptionalMessage(id);
env.storage().persistent().remove(&key);
}
}
pub fn counter(env: &soroban_sdk::Env) -> Option<u32> {
DataKey::counter(env)
}
pub fn set_counter(env: &soroban_sdk::Env, value: &u32) {
DataKey::set_counter(env, value)
}
pub fn delete_counter(env: &soroban_sdk::Env) {
DataKey::delete_counter(env)
}
pub fn message(env: &soroban_sdk::Env, sender: Address) -> Option<String> {
DataKey::message(env, sender)
}
pub fn set_message(env: &soroban_sdk::Env, sender: Address, value: &String) {
DataKey::set_message(env, sender, value)
}
pub fn delete_message(env: &soroban_sdk::Env, sender: Address) {
DataKey::delete_message(env, sender)
}
pub fn last_caller(env: &soroban_sdk::Env, timestamp: u64) -> Option<Address> {
DataKey::last_caller(env, timestamp)
}
pub fn set_last_caller(env: &soroban_sdk::Env, timestamp: u64, value: &Address) {
DataKey::set_last_caller(env, timestamp, value)
}
pub fn delete_last_caller(env: &soroban_sdk::Env, timestamp: u64) {
DataKey::delete_last_caller(env, timestamp)
}
pub fn flag(env: &soroban_sdk::Env, key: String, owner: Address) -> Option<bool> {
DataKey::flag(env, key, owner)
}
pub fn set_flag(env: &soroban_sdk::Env, key: String, owner: Address, value: &bool) {
DataKey::set_flag(env, key, owner, value)
}
pub fn delete_flag(env: &soroban_sdk::Env, key: String, owner: Address) {
DataKey::delete_flag(env, key, owner)
}
pub fn optional_message(env: &soroban_sdk::Env, id: u32) -> Option<Option<String>> {
DataKey::optional_message(env, id)
}
pub fn set_optional_message(env: &soroban_sdk::Env, id: u32, value: &Option<String>) {
DataKey::set_optional_message(env, id, value)
}
pub fn delete_optional_message(env: &soroban_sdk::Env, id: u32) {
DataKey::delete_optional_message(env, id)
}

@nbayindirli nbayindirli force-pushed the feature/storage-macro branch from df0fb2c to c41e64d Compare January 27, 2025 16:04
@codecov-commenter
Copy link

codecov-commenter commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.09%. Comparing base (d371b1e) to head (c7576ac).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #216      +/-   ##
==========================================
+ Coverage   96.87%   97.09%   +0.21%     
==========================================
  Files          68       69       +1     
  Lines        3653     3923     +270     
==========================================
+ Hits         3539     3809     +270     
  Misses        114      114              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nbayindirli nbayindirli force-pushed the feature/storage-macro branch 4 times, most recently from 326f7ea to f5f0811 Compare January 27, 2025 17:51
@nbayindirli nbayindirli changed the title feat(axelar-std-derive): add IntoStorage derive macro feat(axelar-std-derive): add contractstorage proc macro Jan 27, 2025
@nbayindirli nbayindirli changed the title feat(axelar-std-derive): add contractstorage proc macro feat(axelar-std-derive): add contractstorage attribute macro Jan 27, 2025
@nbayindirli nbayindirli force-pushed the feature/storage-macro branch 2 times, most recently from d011f36 to 3012f10 Compare January 27, 2025 23:40
@nbayindirli nbayindirli force-pushed the feature/storage-macro branch from 3012f10 to 836c8da Compare January 27, 2025 23:41
@nbayindirli nbayindirli marked this pull request as ready for review January 27, 2025 23:42
@nbayindirli nbayindirli requested a review from a team as a code owner January 27, 2025 23:42
@nbayindirli nbayindirli force-pushed the feature/storage-macro branch from 4fb89dc to 873bfae Compare January 27, 2025 23:44
@nbayindirli nbayindirli force-pushed the feature/storage-macro branch from 873bfae to c6de88f Compare January 27, 2025 23:48
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std/src/tests/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
@ahramy
Copy link
Contributor

ahramy commented Jan 29, 2025

Since we’ve decided to merge this PR, we need to ensure the PR title is appropriate. Using feat will bump up the minor version to 0.x.0 of the package. Do we want to do that?

packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
contracts/stellar-example/src/storage_types.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
packages/stellar-axelar-std-derive/src/storage.rs Outdated Show resolved Hide resolved
@nbayindirli nbayindirli requested a review from cgorenflo January 30, 2025 18:05
@nbayindirli nbayindirli merged commit 94632d8 into main Jan 30, 2025
7 checks passed
@nbayindirli nbayindirli deleted the feature/storage-macro branch January 30, 2025 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants