💿 Storage: Pin / Unpin object

[bdeneux]

📝 Description

Implement the PinObject and UnpinObject execute message.

❓ Question

What do we do if when we execute PinObject on object that has been already pinned ? The same question for UnpinObject message ?

Now, if we try to pin an already pinned object, the contract return successful response simulating that the object has just been pinned. Otherwise if we try to unpin an object that is already not pinned to the sender, the contract return also a successful response, by doing this on the unpin object and to limit access to the state, there is no verification on the objects state to check if object exist when trying to unpin object. So if we try to unpin object that does not exist, the contract return successfully because the (ObjectId, senderAddr) tuple doesn't exist in the pins state.

🔗 Link

Wait #123 before merge

[bot-anik]

size-limit report 📦

Path	Size
target/wasm32-unknown-unknown/release/cw_template.wasm	178.1 KB (0%)
target/wasm32-unknown-unknown/release/cw_logic_sample.wasm	203.87 KB (0%)
target/wasm32-unknown-unknown/release/cw_storage.wasm	261.73 KB (-0.3% 🔽)

[amimart]

@bdeneux Regarding the behavior when pinning already pinned object and unpinning not yet pinned object I agree with you, as it changes nothing in the state, to consider those messages successful, making them as no-op.

@ccamel Your opinion about that? We'll need to update the specifications accordingly.

[bdeneux]

@bdeneux Regarding the behavior when pinning already pinned object and unpinning not yet pinned object I agree with you, as it changes nothing in the state, to consider those messages successful, making them as no-op.

@ccamel Your opinion about that? We'll need to update the specifications accordingly.

@amimart @ccamel Sorry, my bad, after checking, the specification already indicate this behavior :

/// # PinObject
    /// PinObject pins the object in the bucket for the considered sender. If the object is already pinned
    /// for the sender, this is a no-op.
    /// While an object is pinned, it cannot be removed from the storage.

/// # UnpinObject
    /// UnpinObject unpins the object in the bucket for the considered sender. If the object is not pinned
    /// for the sender, this is a no-op.
    /// The object can be removed from the storage if it is not pinned anymore.

So it's ok for the PinObject. My question now is about the UnpinObject, what do you think if we try to unpin a not found object id, since the pin is not found on the Pins state, this will be also a no-op, do we need instead to return that the object is not found (keeping in mind that this need to ask the state twice instead of once if the object exist) ?

[amimart]

@bdeneux In the case we try to unpin a non existing object, I would tend to make it an error case, even if it has a little more cost than considering it a no-op. Because a successful unpin of an object could suggest the existence of it.

[codecov-commenter]

Codecov Report

Merging #126 (57327db) into main (55b02d7) will increase coverage by 1.30%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #126      +/-   ##
==========================================
+ Coverage   91.45%   92.76%   +1.30%     
==========================================
  Files          11       11              
  Lines         199      235      +36     
==========================================
+ Hits          182      218      +36     
  Misses         17       17              

Impacted Files	Coverage Δ
contracts/cw-storage/src/state.rs	100.00% <ø> (ø)
contracts/cw-storage/src/contract.rs	96.19% <100.00%> (+1.98%)	⬆️
contracts/cw-storage/src/msg.rs	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[amimart]

Nice piece! 💪

I just noted small enhancement ways :)

[amimart]

Sounds pretty great! 🚀

[ccamel]

LGTM! 👍

[bot-anik]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[bot-anik]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀