Cleanup Borsh Serializers

near / nearcore

Reference client for NEAR Protocol

https://near.org

GNU General Public License v3.0

2.34k stars 631 forks source link

Cleanup Borsh Serializers #2167

Closed MaksymZavershynskyi closed 3 years ago

MaksymZavershynskyi commented 4 years ago

[x] Allow deriving Borsh schema using #[derive(BorshSchema)]. https://github.com/nearprotocol/borsh/pull/56
[x] Implement Rust contract metadata and use Borsh schema for types;
[ ] Reconcile and update Borsh for TS/JS (Applayer workspace): https://github.com/nearprotocol/nearlib/issues/252
[ ] Upgrade rpctypegen to new Borsh Schema format (blocked by the above issue).

ghost commented 4 years ago

Never liked cabbage, until I ate borsh.

Question is if this naming-indirection makes sense. I mean, reading technical docs and getting hungry, and guessing what this library does?

Possibly you should consider giving "borsh" a more expressive name, something that implies what this library does.

near-stream?

MaksymZavershynskyi commented 4 years ago

Never liked cabbage, until I ate borsh.

Question is if this naming-indirection makes sense. I mean, reading technical docs and getting hungry, and guessing what this library does?

Possibly you should consider giving "borsh" a more expressive name, something that implies what this library does.

near-stream?

Borsh name is too much ingrained into our codebase to be easily switched. Also, similar to CBOR, BORSH is a meaningful abbreviation see http://borsh.io/

MaksymZavershynskyi commented 4 years ago

Assigning to @kcole16 since the rest of the work is mostly on the Applayer side.

ilblackdragon commented 4 years ago

@nearmax I'm a bit lost given some work was already done - Are the steps left to finish this Epic required for MainNet or not?

MaksymZavershynskyi commented 4 years ago

This is not a Mainnet blocker. Since the remaining steps will not change the node API, we will be able to update via nearlib. Moving to the IceBox and removing from the Mainnet release.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity in the last 2 months. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

bowenwang1996 commented 3 years ago

I believe the majority of the work is done. The rest is tracked in #2242