Skip to content

Replace Mapping::insert_return_size with Mapping::insert #1463

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.

Sign up for GitHub

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

Merged
HCastano merged 10 commits into from
Nov 8, 2022
Merged

Replace Mapping::insert_return_size with Mapping::insert #1463

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3f592fe
remove insert and replace with insert_size
lean-apple Nov 3, 2022
628e166
Merge branch 'master' into ln-rename-master
lean-apple Nov 3, 2022
9180e79
attempt to fix linting
lean-apple Nov 3, 2022
57451f5
fix fmt for contract tests
lean-apple Nov 3, 2022
f59dddd
rename insert_return_size with shorter name
lean-apple Nov 4, 2022
fc26b92
fix fmt for examples
lean-apple Nov 4, 2022
033320d
update changelog file
lean-apple Nov 7, 2022
ff3d866
update with current changelog
lean-apple Nov 7, 2022
330d942
fix changelog file
lean-apple Nov 7, 2022
d9f4b5e
complete method docs
lean-apple Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
rename insert_return_size with shorter name
  • Loading branch information
@lean-apple
lean-apple committed Nov 4, 2022
commit f59ddddca137dbda6f764e4ea6c6e9b00968ab7c
12 changes: 5 additions & 7 deletions crates/ink/tests/ui/contract/pass/example-erc20-works.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ mod erc20 {
pub fn new(total_supply: Balance) -> Self {
let mut balances = Mapping::default();
let caller = Self::env().caller();
balances.insert_return_size(&caller, &total_supply);
balances.insert(&caller, &total_supply);
Self::env().emit_event(Transfer {
from: None,
to: Some(caller),
Expand Down Expand Up @@ -139,8 +139,7 @@ mod erc20 {
#[ink(message)]
pub fn approve(&mut self, spender: AccountId, value: Balance) -> Result<()> {
let owner = self.env().caller();
self.allowances
.insert_return_size((&owner, &spender), &value);
self.allowances.insert((&owner, &spender), &value);
self.env().emit_event(Approval {
owner,
spender,
Expand Down Expand Up @@ -177,7 +176,7 @@ mod erc20 {
}
self.transfer_from_to(&from, &to, value)?;
self.allowances
.insert_return_size((&from, &caller), &(allowance - value));
.insert((&from, &caller), &(allowance - value));
Ok(())
}

Expand All @@ -200,10 +199,9 @@ mod erc20 {
return Err(Error::InsufficientBalance)
}

self.balances
.insert_return_size(from, &(from_balance - value));
self.balances.insert(from, &(from_balance - value));
let to_balance = self.balance_of_impl(to);
self.balances.insert_return_size(to, &(to_balance + value));
self.balances.insert(to, &(to_balance + value));
self.env().emit_event(Transfer {
from: Some(*from),
to: Some(*to),
Expand Down
13 changes: 6 additions & 7 deletions crates/ink/tests/ui/contract/pass/example-erc721-works.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ mod erc721 {
.get(&caller)
.map(|c| c - 1)
.ok_or(Error::CannotFetchValue)?;
owned_tokens_count.insert_return_size(&caller, &count);
owned_tokens_count.insert(&caller, &count);
token_owner.remove(&id);

self.env().emit_event(Transfer {
Expand Down Expand Up @@ -232,7 +232,7 @@ mod erc721 {
.get(&from)
.map(|c| c - 1)
.ok_or(Error::CannotFetchValue)?;
owned_tokens_count.insert_return_size(&from, &count);
owned_tokens_count.insert(&from, &count);
token_owner.remove(&id);

Ok(())
Expand All @@ -256,8 +256,8 @@ mod erc721 {

let count = owned_tokens_count.get(to).map(|c| c + 1).unwrap_or(1);

owned_tokens_count.insert_return_size(to, &count);
token_owner.insert_return_size(&id, to);
owned_tokens_count.insert(to, &count);
token_owner.insert(&id, to);

Ok(())
}
Expand All @@ -279,8 +279,7 @@ mod erc721 {
});

if approved {
self.operator_approvals
.insert_return_size((&caller, &to), &());
self.operator_approvals.insert((&caller, &to), &());
} else {
self.operator_approvals.remove((&caller, &to));
}
Expand All @@ -305,7 +304,7 @@ mod erc721 {
if self.token_approvals.get(&id).is_some() {
return Err(Error::CannotInsert)
} else {
self.token_approvals.insert_return_size(&id, to);
self.token_approvals.insert(&id, to);
}

self.env().emit_event(Approval {
Expand Down
10 changes: 5 additions & 5 deletions crates/storage/src/lazy/mapping.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ use scale::{
/// let mut instance = Self::default();
/// let caller = Self::env().caller();
/// let value: Balance = Default::default();
/// instance.balances.insert_return_size(&caller, &value);
/// instance.balances.insert(&caller, &value);
/// instance
/// }
///
Expand Down Expand Up @@ -134,7 +134,7 @@ where
///
/// Returns the size of the pre-existing value at the specified key if any.
#[inline]
pub fn insert_return_size<Q, R>(&mut self, key: Q, value: &R) -> Option<u32>
pub fn insert<Q, R>(&mut self, key: Q, value: &R) -> Option<u32>
Copy link
Contributor

@HCastano HCastano Nov 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the docs can you also specify the returned size is in bytes?

where
Q: scale::EncodeLike<K>,
R: Storable + scale::EncodeLike<V>,
Expand Down Expand Up @@ -251,7 +251,7 @@ mod tests {
fn insert_and_get_work() {
ink_env::test::run_test::<ink_env::DefaultEnvironment, _>(|_| {
let mut mapping: Mapping<u8, _> = Mapping::new();
mapping.insert_return_size(&1, &2);
mapping.insert(&1, &2);
assert_eq!(mapping.get(&1), Some(2));

Ok(())
Expand All @@ -263,7 +263,7 @@ mod tests {
fn insert_and_get_work_for_two_mapping_with_same_manual_key() {
ink_env::test::run_test::<ink_env::DefaultEnvironment, _>(|_| {
let mut mapping: Mapping<u8, u8, ManualKey<123>> = Mapping::new();
mapping.insert_return_size(&1, &2);
mapping.insert(&1, &2);

let mapping2: Mapping<u8, u8, ManualKey<123>> = Mapping::new();
assert_eq!(mapping2.get(&1), Some(2));
Expand All @@ -290,7 +290,7 @@ mod tests {
// Given
let mut mapping: Mapping<u8, u8> = Mapping::new();

mapping.insert_return_size(&1, &2);
mapping.insert(&1, &2);
assert_eq!(mapping.get(&1), Some(2));

// When
Expand Down
6 changes: 3 additions & 3 deletions examples/dns/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ mod dns {
return Err(Error::NameAlreadyExists)
}

self.name_to_owner.insert_return_size(&name, &caller);
self.name_to_owner.insert(&name, &caller);
self.env().emit_event(Register { name, from: caller });

Ok(())
Expand All @@ -107,7 +107,7 @@ mod dns {
}

let old_address = self.name_to_address.get(&name);
self.name_to_address.insert_return_size(&name, &new_address);
self.name_to_address.insert(&name, &new_address);

self.env().emit_event(SetAddress {
name,
Expand All @@ -128,7 +128,7 @@ mod dns {
}

let old_owner = self.name_to_owner.get(&name);
self.name_to_owner.insert_return_size(&name, &to);
self.name_to_owner.insert(&name, &to);

self.env().emit_event(Transfer {
name,
Expand Down
16 changes: 8 additions & 8 deletions examples/erc1155/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ mod erc1155 {
// Given that TokenId is a `u128` the likelihood of this overflowing is pretty slim.
self.token_id_nonce += 1;
self.balances
.insert_return_size(&(caller, self.token_id_nonce), &value);
.insert(&(caller, self.token_id_nonce), &value);

// Emit transfer event but with mint semantics
self.env().emit_event(TransferSingle {
Expand Down Expand Up @@ -289,7 +289,7 @@ mod erc1155 {

let caller = self.env().caller();
self.balances
.insert_return_size(&(caller, token_id), &value);
.insert(&(caller, token_id), &value);

// Emit transfer event but with mint semantics
self.env().emit_event(TransferSingle {
Expand Down Expand Up @@ -324,12 +324,12 @@ mod erc1155 {
.expect("Caller should have ensured that `from` holds `token_id`.");
sender_balance -= value;
self.balances
.insert_return_size(&(from, token_id), &sender_balance);
.insert(&(from, token_id), &sender_balance);

let mut recipient_balance = self.balances.get(&(to, token_id)).unwrap_or(0);
recipient_balance += value;
self.balances
.insert_return_size(&(to, token_id), &recipient_balance);
.insert(&(to, token_id), &recipient_balance);

let caller = self.env().caller();
self.env().emit_event(TransferSingle {
Expand Down Expand Up @@ -521,7 +521,7 @@ mod erc1155 {
ensure!(operator != caller, Error::SelfApproval);

if approved {
self.approvals.insert_return_size((&caller, &operator), &());
self.approvals.insert((&caller, &operator), &());
} else {
self.approvals.remove((&caller, &operator));
}
Expand Down Expand Up @@ -611,9 +611,9 @@ mod erc1155 {

fn init_contract() -> Contract {
let mut erc = Contract::new();
erc.balances.insert_return_size((alice(), 1), &10);
erc.balances.insert_return_size((alice(), 2), &20);
erc.balances.insert_return_size((bob(), 1), &10);
erc.balances.insert((alice(), 1), &10);
erc.balances.insert((alice(), 2), &20);
erc.balances.insert((bob(), 1), &10);

erc
}
Expand Down
10 changes: 5 additions & 5 deletions examples/erc20/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ mod erc20 {
pub fn new(total_supply: Balance) -> Self {
let mut balances = Mapping::default();
let caller = Self::env().caller();
balances.insert_return_size(&caller, &total_supply);
balances.insert(&caller, &total_supply);
Self::env().emit_event(Transfer {
from: None,
to: Some(caller),
Expand Down Expand Up @@ -142,7 +142,7 @@ mod erc20 {
pub fn approve(&mut self, spender: AccountId, value: Balance) -> Result<()> {
let owner = self.env().caller();
self.allowances
.insert_return_size((&owner, &spender), &value);
.insert((&owner, &spender), &value);
self.env().emit_event(Approval {
owner,
spender,
Expand Down Expand Up @@ -179,7 +179,7 @@ mod erc20 {
}
self.transfer_from_to(&from, &to, value)?;
self.allowances
.insert_return_size((&from, &caller), &(allowance - value));
.insert((&from, &caller), &(allowance - value));
Ok(())
}

Expand All @@ -203,9 +203,9 @@ mod erc20 {
}

self.balances
.insert_return_size(from, &(from_balance - value));
.insert(from, &(from_balance - value));
let to_balance = self.balance_of_impl(to);
self.balances.insert_return_size(to, &(to_balance + value));
self.balances.insert(to, &(to_balance + value));
self.env().emit_event(Transfer {
from: Some(*from),
to: Some(*to),
Expand Down
12 changes: 6 additions & 6 deletions examples/erc721/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ mod erc721 {
.get(&caller)
.map(|c| c - 1)
.ok_or(Error::CannotFetchValue)?;
owned_tokens_count.insert_return_size(&caller, &count);
owned_tokens_count.insert(&caller, &count);
token_owner.remove(&id);

self.env().emit_event(Transfer {
Expand Down Expand Up @@ -284,7 +284,7 @@ mod erc721 {
.get(&from)
.map(|c| c - 1)
.ok_or(Error::CannotFetchValue)?;
owned_tokens_count.insert_return_size(&from, &count);
owned_tokens_count.insert(&from, &count);
token_owner.remove(&id);

Ok(())
Expand All @@ -308,8 +308,8 @@ mod erc721 {

let count = owned_tokens_count.get(to).map(|c| c + 1).unwrap_or(1);

owned_tokens_count.insert_return_size(to, &count);
token_owner.insert_return_size(&id, to);
owned_tokens_count.insert(to, &count);
token_owner.insert(&id, to);

Ok(())
}
Expand All @@ -332,7 +332,7 @@ mod erc721 {

if approved {
self.operator_approvals
.insert_return_size((&caller, &to), &());
.insert((&caller, &to), &());
} else {
self.operator_approvals.remove((&caller, &to));
}
Expand All @@ -357,7 +357,7 @@ mod erc721 {
if self.token_approvals.contains(&id) {
return Err(Error::CannotInsert)
} else {
self.token_approvals.insert_return_size(&id, to);
self.token_approvals.insert(&id, to);
}

self.env().emit_event(Approval {
Expand Down
16 changes: 8 additions & 8 deletions examples/multisig/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ mod multisig {
ensure_requirement_is_valid(owners.len() as u32, requirement);

for owner in &owners {
contract.is_owner.insert_return_size(owner, &());
contract.is_owner.insert(owner, &());
}

contract.owners = owners;
Expand Down Expand Up @@ -370,7 +370,7 @@ mod multisig {
self.ensure_from_wallet();
self.ensure_no_owner(&new_owner);
ensure_requirement_is_valid(self.owners.len() as u32 + 1, self.requirement);
self.is_owner.insert_return_size(new_owner, &());
self.is_owner.insert(new_owner, &());
self.owners.push(new_owner);
self.env().emit_event(OwnerAddition { owner: new_owner });
}
Expand Down Expand Up @@ -414,7 +414,7 @@ mod multisig {
let owner_index = self.owner_index(&old_owner);
self.owners[owner_index as usize] = new_owner;
self.is_owner.remove(&old_owner);
self.is_owner.insert_return_size(new_owner, &());
self.is_owner.insert(new_owner, &());
self.clean_owner_confirmations(&old_owner);
self.env().emit_event(OwnerRemoval { owner: old_owner });
self.env().emit_event(OwnerAddition { owner: new_owner });
Expand Down Expand Up @@ -447,7 +447,7 @@ mod multisig {
let trans_id = self.transaction_list.next_id;
self.transaction_list.next_id =
trans_id.checked_add(1).expect("Transaction ids exhausted.");
self.transactions.insert_return_size(trans_id, &transaction);
self.transactions.insert(trans_id, &transaction);
self.transaction_list.transactions.push(trans_id);
self.env().emit_event(Submission {
transaction: trans_id,
Expand Down Expand Up @@ -513,7 +513,7 @@ mod multisig {
// Will not underflow as there is at least one confirmation
confirmation_count -= 1;
self.confirmation_count
.insert_return_size(&trans_id, &confirmation_count);
.insert(&trans_id, &confirmation_count);
self.env().emit_event(Revocation {
transaction: trans_id,
from: caller,
Expand Down Expand Up @@ -604,9 +604,9 @@ mod multisig {
let new_confirmation = !self.confirmations.contains(&key);
if new_confirmation {
count += 1;
self.confirmations.insert_return_size(&key, &());
self.confirmations.insert(&key, &());
self.confirmation_count
.insert_return_size(&transaction, &count);
.insert(&transaction, &count);
}
let status = {
if count >= self.requirement {
Expand Down Expand Up @@ -665,7 +665,7 @@ mod multisig {
let mut count = self.confirmation_count.get(&trans_id).unwrap_or(0);
count -= 1;
self.confirmation_count
.insert_return_size(&trans_id, &count);
.insert(&trans_id, &count);
}
}
}
Expand Down
Loading