svm icon indicating copy to clipboard operation
svm copied to clipboard

Implement host function: `svm_tx_amount`

Open YaronWittenstein opened this issue 3 years ago • 0 comments

Depends on #487

We need to ask the Host for the amount value supplied in the Transaction.

One classic usage is tracking how much money the current executing Account has been funded. So each time an Account gets funding, it will execute some piece of code (see SVM SDK fundable hooks feature - similar to the payable of Solidity)

That code will ask the Host for the current transaction value to update some Storage variable of itself.

Implementation Proposal

The host function signature should look probably like this:

fn tx_amount(env: &FuncEnv) -> u64 {
  // ...
}

The amount will be taken from the Envelope.

Fundable Hooks

Fundable hooks are SVM SDK mechanisms to share common pieces of code between different #[endpoint]. When an endpoint wants to use an existing fundable hook, it should add this annotation: #[fundable(FUNDABLE_HOOK_NAME)]

Links:

  • https://github.com/spacemeshos/svm/blob/master/crates/sdk-macros/src/function/fundable.rs
  • https://github.com/spacemeshos/svm/blob/master/crates/sdk-macros/src/function/fundable_hook.rs
  • https://github.com/spacemeshos/svm/blob/master/tests/sdk/tests/funding/funding.rs

Open Question

  • @avive @lrettig - do we let an Account ask for its current balance? (in a running Contract code).
  • Is the svm_tx_amount can be called from within verify? (I don't see any problem with that since it's part of the Transaction)

YaronWittenstein avatar Dec 26 '21 20:12 YaronWittenstein