This repository has been archived by the owner on Aug 14, 2023. It is now read-only.
ABI Encoding #159
Merged
ABI Encoding #159
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* allocating a static Buffer on the heap * adding documentation
Adding `Commit` method to `svm_kv::traits::KVStore` is required in order to proceed.
* native rust (a.k.a `Builder`) * json * wasm
moshababo
reviewed
Jul 16, 2020
| }}; | ||
| } | ||
|
|
||
| /// Decodes a encoded function buffer back into a `sdk_values::Value` |
| let mut values = Vec::new(); | ||
|
|
||
| while next_byte != marker::ARRAY_END { | ||
| let v = self.decode_value(cursor)?; |
There was a problem hiding this comment.
Looks like this supports infinite nesting of arrays. Is this intentional?
There was a problem hiding this comment.
I've added a marker-trait to prohibit encoding of nested arrays
crates/svm-abi/encoder/src/lib.rs
Outdated
| @@ -0,0 +1,96 @@ | |||
| #![no_std] | |||
|
|
|||
| //! This crate is responsible of encoding SVM types (its actuall type and their values to be precise), | |||
crates/svm-abi/encoder/src/lib.rs
Outdated
| value::{Address, AddressOwned, PubKey256, PubKey256Owned}, | ||
| }; | ||
|
|
||
| /// A traits to be implemented by of types. |
There was a problem hiding this comment.
Something is wrong with this sentence.
moshababo
approved these changes
Jul 19, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The purpose of this PR is to implement a well-defined ABI encoding & decoding specification for the blob data passed to the
func_buffer. (calledctor_bufin the context ofspawn app- but it's the same mechanism).Since WASM MVP comes out-of-the-box only 2 types relevant for us (SVM don't work for
floatsfor determinism concerns).We need to come up with an encoding method so that we can feed a function with composite data such as:
TupleAddressPublicKeyThis
svm-codecshould extend its exposed WASM API and it'll do so by importing this crate.So when
smapp(or any other future Wallet client) will want to dispatch a new SVM transaction ofspawn-app(orexec-app) to the network, it will do so in two steps:func_bufandfunc_args- using thesvm-abicrate (implemented in this PR).func_bufandfunc_argswith the results of step 1.In the future, we may add new ABI encoding schemes. But hopefully, we can get away with this one.
Also, this ABI encoding scheme should be leveraged by the future so-called SMESH language.
Important:
There will be high-level API exposed as JSON for each App. This data will contain variables names and types for each function. That's how
smapp(or similar) will know that a function input expects in a high-level without caring about the low-level implementation details.Also, this data will be off-chain. This functionality is out of scope for this PR.