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: Add PrimaryKey implementation example for custom types #93

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bullet-tooth
Copy link

Why?

Sometimes, it's useful to store a custom type as a key in a Map storage structure. To do this, users need to implement proper serialization for such types.

So I found it useful to add such an example with a reference implementation for a widely used Denom enum that represents either a native token or a cw20 token.

Scope:

  • Made some util functions as the public that can be helpful in custom types implementations
  • Added example test with primary key implementation for `Denom
  • Added a readme reference for that example

Denom::Native(name) => (NATIVE_PREFIX, name.as_bytes()),
Denom::Cw20(addr) => (CW20_PREFIX, addr.as_bytes()),
};
vec![Key::Val8([prefix]), Key::Ref(value)]
Copy link
Author

Choose a reason for hiding this comment

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

Question for maintainers: From the selectivity perspective, mb, is it better to write the value first as a prefix and after its type (which is either 1 or 2 in our case)?

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.

1 participant