-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### What Allow the first param of contract functions to be &Env or Env, instead of requiring that if present it is Env. ### Why To reduce repetitive clones in contract functions. Requiring as input to functions an owned copy of Env is unnecessary, and it has a run on affect that if someone wants to use a contract function also as an internal function called by their code they need to clone the Env each time it is called. This has zero performance implications because the Env is, or should be, erased from most places at build time, but it adds noise to the application. Looking back we should have made the Env a ref everywhere, probably, but in lieu of doing that which would be a breaking change we can make it allowed so both are allowed. This will also remove a compile fail case for devs. Before if they used an &Env they would see an error. Now they won't. This change is not a breaking change.
- Loading branch information
1 parent
eb9f7e2
commit bb38320
Showing
6 changed files
with
211 additions
and
10 deletions.
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| use crate as soroban_sdk; | ||
| use soroban_sdk::{contract, contractimpl, Env}; | ||
| use stellar_xdr::curr as stellar_xdr; | ||
| use stellar_xdr::{ | ||
| Limits, ReadXdr, ScSpecEntry, ScSpecFunctionInputV0, ScSpecFunctionV0, ScSpecTypeDef, | ||
| }; | ||
|
|
||
| #[contract] | ||
| pub struct Contract; | ||
|
|
||
| #[contractimpl] | ||
| impl Contract { | ||
| pub fn add(_e: &Env, a: i32, b: i32) -> i32 { | ||
| a + b | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_functional() { | ||
| let e = Env::default(); | ||
| let contract_id = e.register_contract(None, Contract); | ||
|
|
||
| let a = 10i32; | ||
| let b = 12i32; | ||
| let c = ContractClient::new(&e, &contract_id).add(&a, &b); | ||
| assert_eq!(c, 22); | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_spec() { | ||
| let entries = ScSpecEntry::from_xdr(__SPEC_XDR_FN_ADD, Limits::none()).unwrap(); | ||
| let expect = ScSpecEntry::FunctionV0(ScSpecFunctionV0 { | ||
| doc: "".try_into().unwrap(), | ||
| name: "add".try_into().unwrap(), | ||
| inputs: vec![ | ||
| ScSpecFunctionInputV0 { | ||
| doc: "".try_into().unwrap(), | ||
| name: "a".try_into().unwrap(), | ||
| type_: ScSpecTypeDef::I32, | ||
| }, | ||
| ScSpecFunctionInputV0 { | ||
| doc: "".try_into().unwrap(), | ||
| name: "b".try_into().unwrap(), | ||
| type_: ScSpecTypeDef::I32, | ||
| }, | ||
| ] | ||
| .try_into() | ||
| .unwrap(), | ||
| outputs: vec![ScSpecTypeDef::I32].try_into().unwrap(), | ||
| }); | ||
| assert_eq!(entries, expect); | ||
| } |
132 changes: 132 additions & 0 deletions
132
soroban-sdk/test_snapshots/tests/contract_fn/test_functional.1.json
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| { | ||
| "generators": { | ||
| "address": 1, | ||
| "nonce": 0 | ||
| }, | ||
| "auth": [ | ||
| [] | ||
| ], | ||
| "ledger": { | ||
| "protocol_version": 20, | ||
| "sequence_number": 0, | ||
| "timestamp": 0, | ||
| "network_id": "0000000000000000000000000000000000000000000000000000000000000000", | ||
| "base_reserve": 0, | ||
| "min_persistent_entry_ttl": 4096, | ||
| "min_temp_entry_ttl": 16, | ||
| "max_entry_ttl": 6312000, | ||
| "ledger_entries": [ | ||
| [ | ||
| { | ||
| "contract_data": { | ||
| "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM", | ||
| "key": "ledger_key_contract_instance", | ||
| "durability": "persistent" | ||
| } | ||
| }, | ||
| [ | ||
| { | ||
| "last_modified_ledger_seq": 0, | ||
| "data": { | ||
| "contract_data": { | ||
| "ext": "v0", | ||
| "contract": "CAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD2KM", | ||
| "key": "ledger_key_contract_instance", | ||
| "durability": "persistent", | ||
| "val": { | ||
| "contract_instance": { | ||
| "executable": { | ||
| "wasm": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" | ||
| }, | ||
| "storage": null | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "ext": "v0" | ||
| }, | ||
| 4095 | ||
| ] | ||
| ], | ||
| [ | ||
| { | ||
| "contract_code": { | ||
| "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" | ||
| } | ||
| }, | ||
| [ | ||
| { | ||
| "last_modified_ledger_seq": 0, | ||
| "data": { | ||
| "contract_code": { | ||
| "ext": "v0", | ||
| "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855", | ||
| "code": "" | ||
| } | ||
| }, | ||
| "ext": "v0" | ||
| }, | ||
| 4095 | ||
| ] | ||
| ] | ||
| ] | ||
| }, | ||
| "events": [ | ||
| { | ||
| "event": { | ||
| "ext": "v0", | ||
| "contract_id": null, | ||
| "type_": "diagnostic", | ||
| "body": { | ||
| "v0": { | ||
| "topics": [ | ||
| { | ||
| "symbol": "fn_call" | ||
| }, | ||
| { | ||
| "bytes": "0000000000000000000000000000000000000000000000000000000000000001" | ||
| }, | ||
| { | ||
| "symbol": "add" | ||
| } | ||
| ], | ||
| "data": { | ||
| "vec": [ | ||
| { | ||
| "i32": 10 | ||
| }, | ||
| { | ||
| "i32": 12 | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "failed_call": false | ||
| }, | ||
| { | ||
| "event": { | ||
| "ext": "v0", | ||
| "contract_id": "0000000000000000000000000000000000000000000000000000000000000001", | ||
| "type_": "diagnostic", | ||
| "body": { | ||
| "v0": { | ||
| "topics": [ | ||
| { | ||
| "symbol": "fn_return" | ||
| }, | ||
| { | ||
| "symbol": "add" | ||
| } | ||
| ], | ||
| "data": { | ||
| "i32": 22 | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "failed_call": false | ||
| } | ||
| ] | ||
| } |