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(dan): template macro handles component state #4380

Merged
merged 12 commits into from
Aug 3, 2022

Conversation

mrnaveira
Copy link
Contributor

@mrnaveira mrnaveira commented Aug 3, 2022

Description

  • Function parameters are correctly encoded and passed to the user function
  • Component parameters (i.e. self) are transparently handled to the user code:
    1. The ABI specifies a u32 type component id
    2. The state is retrieved from the engine with that component id (not the real call yet, as it's not implemented in the engine)
    3. The state is decoded and passed to the function on the self parameter
    4. If the attribute is mutable (&mut self) then we call the engine to update the component state
  • Unit return types (()) are now supported in functions (see the State.set function as an example)
  • Expanded the ast.rs module with convenient functions to detect self and constructor functions

Motivation and Context

Following the previous work on the template macro (#4358, #4361), this PR aims to solve some of the previous limitations:

  • The function arguments must be processed and encoded
  • Struct fields and self must be handled
  • Calls to the tari engine import should be done instead of mocked

With those implemented, the state test example is now written as:

use tari_template_macros::template;

#[template]
mod state_template {
    pub struct State {
        pub value: u32,
    }

    impl State {
        pub fn new() -> Self {
            Self { value: 0 }
        }

        pub fn set(&mut self, value: u32) {
            self.value = value;
        }

        pub fn get(&self) -> u32 {
            self.value
        }
    }
}

Please keep in mind that this is the simplest example that manages the contract state, but it currently supports function logic as complex as the user wants, as long as it is valid Rust code.

Also, for now I didn't find necessary to mark constructor functions in any special way. Right now, a function is automatically considered a constructor (and the component instantiated) if it returns Self.

Lastly, as the state managing itself is not yet implemented on the engine, state is not conserved between calls. But this PR encapsulates component related logic in a single module (component.rs) so it should be relatively simple to implement in the future.

How Has This Been Tested?

The unit test for the state example, now rewritten using the template macro, pass

Copy link
Collaborator

@stringhandler stringhandler left a comment

Choose a reason for hiding this comment

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

Nice

@stringhandler stringhandler merged commit 696d909 into tari-project:development Aug 3, 2022
sdbondi added a commit to sdbondi/tari that referenced this pull request Aug 4, 2022
* development:
  fix: wallet database encryption does not bind to field keys tari-project#4137 (tari-project#4340)
  fix: use SafePassword struct instead of String for passwords (tari-project#4320)
  feat(dan): template macro handles component state (tari-project#4380)
  fix(dht)!: add message padding for message decryption, to reduce message length leaks (fixes tari-project#4140) (tari-project#4362)
  fix(wallet): update seed words for output manager tests (tari-project#4379)
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.

2 participants