NEP 22: Contract Update Standard #154

superboyiii · 2022-08-31T10:10:10Z

Close: #135

nep-xx.mediawiki

Co-authored-by: Erik van den Brink <[email protected]>

ixje

LGTM

roman-khimov

It'd be nice to have this, I'd change our examples to use this standard interface.

nep-xx.mediawiki

erikzhang · 2022-09-20T02:26:24Z

Add _initialize?

roman-khimov · 2022-09-20T04:22:51Z

_initialize is something different to me, not directly related to deploy/update. Maybe it's in some other document (but I wasn't able to find it on https://docs.neo.org/) or other NEP.

superboyiii · 2022-09-20T10:11:52Z

@roman-khimov @erikzhang Added. Please review again.

roman-khimov · 2022-09-20T16:57:44Z

NEP-22:

provide systems with a generalized interaction mechanism for smart contract initial deploy, update and destroy.

I don't see _initialize being a part of this NEP.

erikzhang · 2022-09-21T01:13:03Z

I don't see _initialize being a part of this NEP.

I'm not sure if it should be part of this PR, but obviously it should be included in a document.

Also, don't forget the verify method.

superboyiii · 2022-09-21T11:12:47Z

I don't see _initialize being a part of this NEP.

I'm not sure if it should be part of this PR, but obviously it should be included in a document.

Also, don't forget the verify method.

Added.

superboyiii · 2022-09-26T06:22:44Z

@erikzhang @roman-khimov Is it OK?

roman-khimov · 2022-11-23T07:46:37Z

It's a method soup now to me. I'd rather have separate NEPs for _initialize, _deploy and verify (three NEPs, seems to be perfectly fine to me, they are different unrelated things) and one for update/destroy. I want to be able to specify "NEP-XYZ" in SupportedStandards and expect all the tooling around to understand that this contract has standardized update/destroy method pair that can be interacted with. "NEP-22" doesn't give this meaning right now.

ixje · 2023-05-08T14:50:34Z

_initialize is something different to me, not directly related to deploy/update. Maybe it's in some other document (but I wasn't able to find it on https://docs.neo.org/) or other NEP.

I can kind of see the relationship. update can call _deploy which in turn can call _initialize again. Ideally there would be a flow diagram included to make it clear. verify on the other hand seems totally unrelated and worthy of a separate document if we're splitting anyway

roman-khimov · 2023-05-08T15:09:19Z

I can kind of see the relationship

Is it related? Probably so. Can be it be used without all the other things? Sure it is. Can all the other things in this proposal be used without _initialize? Sure they are. We can have as many standards as we need and they can be related, but different standards for different things. NEP-XYZ in SupportedStandards should have some specific meaning. And SupportedStandards can have as many NEP-X, NEP-Y, NEP-Z as needed.

EdgeDLT · 2023-05-08T15:48:47Z

And SupportedStandards can have as many NEP-X, NEP-Y, NEP-Z as needed.

I agree in principle with the idea of having independent standards. But I suspect there are many others like myself who also have a mental block at the future thought of these long lists of numbers with no meaning. Maybe we could package them together under a standard group, but at that point, is it that much different from what we have now?

Jim8y · 2024-06-06T08:44:44Z

#154 (comment)

I can't imagine how to use this NEP in its current form. It needs a split.

@roman-khimov this one can be the most general description of base methods, as for specific method that should have a seperate NEP, we can create another NEPs for them, like Verify, no need to complete them in one NEP.

superboyiii · 2024-06-06T08:48:11Z

#154 (comment)

I can't imagine how to use this NEP in its current form. It needs a split.

It's a guideline proposal for someone doesn't know where to start. It doesn't mean that you must implement all of these. In fact, you can even don't apply any of these, but it can remind these people some important points when starting to write neo smart contract.

roman-khimov · 2024-06-06T09:10:33Z

Let's get back to #135 that started all of this for a moment. What people really wanted there is a convention for methods that contract authors can use to have some common way to update/destroy contracts. In this sense it's somewhat similar to NEP-11/17/24. And this is only about two methods: update and destroy, so that I wouldn't want to do

func obnovlyashka(data Array)

to update my contract (because 3rd-party tools couldn't easily create an update transaction for me in this case, unlike when they deal with a compliant update).

But what we also have here now are:

verify, which has nothing to do with update/destroy, it's just a different mechanism
_deploy, which is related to update, but is still somewhat different in that it can be omitted completely, it can be implemented in a contract that doesn't have update and, most importantly, it's not something you can call externally yourself, it's a native contract mechanism

At least we need to move verify out. It'd be perfect to have a NEP for it, but it's a separate matter. I would also move _deploy out since it has a broader definition (not just updates, but deployments as well, works irrespective of how your exposed-from-contract update methods are called), then this NEP could just refer to it.

igormcoelho · 2024-07-18T13:20:00Z

According to recent discussions, I agree that update and destroy are the most important here to be standardized.

AnnaShaleva · 2024-07-18T14:13:40Z

Totally agree with Roman, we should adjust this NEP to standardize a single update method. The rest of methods standards should be moved to a separate granular NEPs.

cschuchardt88 · 2024-07-18T14:58:05Z

Should update method have a data parameter? Same for destroy. This has been requested from others in the pass to have one added to neo-cli, including neo-express.

superboyiii · 2024-09-11T06:20:01Z

@roman-khimov @shargon @cschuchardt88 @Jim8y Now I changed it to Contract Update Standard. I will submit destroy standard as well.

nep-22.mediawiki

superboyiii · 2024-09-12T03:49:40Z

@shargon @roman-khimov Done.

vncoelho · 2024-09-30T13:56:31Z

nep-22.mediawiki

+}
+</pre>
+
+This method will will callback <code>Update</code> method in native <code>ContractManagement</code> contract. It will update contract state if it's exectued successfully.


Probably just MUST call

vncoelho · 2024-09-30T13:58:22Z

nep-22.mediawiki

+
+Updating a smart contract MUST have <code>nefFile</code> or <code>manifest.json</code>. If just update one of them at a time is OK, another SHOULD be set as null. It will be passed to <code>_deploy</code>.
+
+The parameter <code>data</code> can be any type of supported parameters for contract-specific purpose. For example some kinds of json parameters can be put into data for specific check.


"For example some kinds of json parameters can be put into data for specific check."
Some examples here?

vncoelho · 2024-09-30T13:58:59Z

nep-22.mediawiki

+
+The parameter <code>data</code> can be any type of supported parameters for contract-specific purpose. For example some kinds of json parameters can be put into data for specific check.
+
+This function SHOULD check whether the <code>signer</code> address equals the <code>owner</code> hash of contract. This function SHOULD use the SYSCALL <code>Neo.Runtime.CheckWitness</code> to verify the <code>signer</code>. Details has been explained in [NEP-30](https://github.com/superboyiii/proposals/blob/upgrade-standard/nep-30.mediawiki).


This function? Which function?

Maybe better as this method, since we're talking about update method here. Also, I don't understand what is to check whether the <code>signer</code> address equals the <code>owner</code> hash of contract. Transaction can have a lot of signers. We should care more about owner allowing this action (CheckWitness). And NEP-30 is a different thing in general, most of contracts will not have contract-based owners, they're usually just multisig.

roman-khimov · 2024-10-17T19:26:12Z

nep-22.mediawiki

+
+==Motivation==
+
+As the NEO blockchain scales, Smart Contract Update will become increasingly important. We need standize <code>update</code> method in contract to callback native <code>ContractManagement</code> correctly.


s/NEO/Neo. s/standize/a standard/? I'm also not sure we need to say anything about callbacks. It's about standard API to update contracts, what it does internally is not motivation probably.

roman-khimov · 2024-10-17T19:28:07Z

nep-22.mediawiki

+
+==Specification==
+
+Neo N3 has a native <code>ContractManagement</code> contract that is used for contract deployment and update via <code>deploy</code> and <code>update</code> methods of it. After settling with the new NEF and manifest both of them will invoke a special <code>_deploy</code> method if it's implemented by the contract. More details in [NEP-29](https://github.com/neo-project/proposals/blob/master/nep-29.mediawiki)


I don't think it's a part of specification. We're specifying something different here.

roman-khimov · 2024-10-17T19:29:40Z

nep-22.mediawiki

+}
+</pre>
+
+This method will will callback <code>Update</code> method in native <code>ContractManagement</code> contract. It will update contract state if it's exectued successfully.


Probably just MUST call

roman-khimov · 2024-10-17T19:32:17Z

nep-22.mediawiki

+
+This method will will callback <code>Update</code> method in native <code>ContractManagement</code> contract. It will update contract state if it's exectued successfully.
+
+Updating a smart contract MUST have <code>nefFile</code> or <code>manifest.json</code>. If just update one of them at a time is OK, another SHOULD be set as null. It will be passed to <code>_deploy</code>.


Maybe refer to NEP-16 and NEP-15 here. I also don't understand

It will be passed to _deploy.

here. Only data is going to be passed and that's exactly where a reference to NEP-29 is needed.

roman-khimov · 2024-10-17T19:35:31Z

nep-22.mediawiki

+
+The parameter <code>data</code> can be any type of supported parameters for contract-specific purpose. For example some kinds of json parameters can be put into data for specific check.
+
+This function SHOULD check whether the <code>signer</code> address equals the <code>owner</code> hash of contract. This function SHOULD use the SYSCALL <code>Neo.Runtime.CheckWitness</code> to verify the <code>signer</code>. Details has been explained in [NEP-30](https://github.com/superboyiii/proposals/blob/upgrade-standard/nep-30.mediawiki).


Maybe better as this method, since we're talking about update method here. Also, I don't understand what is to check whether the <code>signer</code> address equals the <code>owner</code> hash of contract. Transaction can have a lot of signers. We should care more about owner allowing this action (CheckWitness). And NEP-30 is a different thing in general, most of contracts will not have contract-based owners, they're usually just multisig.

NEP: Contract Basic Method Guideline

01d147a

superboyiii mentioned this pull request Aug 31, 2022

NEP: Contract Basic Method Guideline #136

Closed

ixje reviewed Aug 31, 2022

View reviewed changes

nep-xx.mediawiki Outdated Show resolved Hide resolved

nep-xx.mediawiki Outdated Show resolved Hide resolved

nep-xx.mediawiki Outdated Show resolved Hide resolved

superboyiii and others added 4 commits August 31, 2022 22:45

Update nep-xx.mediawiki

55ff8e0

Co-authored-by: Erik van den Brink <[email protected]>

Update nep-xx.mediawiki

97d541e

Update nep-xx.mediawiki

45a0042

fix update

2deb55a

ixje previously approved these changes Aug 31, 2022

View reviewed changes

fix format

cec6fe1

superboyiii dismissed ixje’s stale review via cec6fe1 September 1, 2022 02:23

roman-khimov reviewed Sep 9, 2022

View reviewed changes

advice from Roman

12ae313

roman-khimov previously approved these changes Sep 14, 2022

View reviewed changes

shargon reviewed Sep 16, 2022

View reviewed changes

nep-xx.mediawiki Outdated Show resolved Hide resolved

fix format

7900ded

superboyiii dismissed roman-khimov’s stale review via 7900ded September 19, 2022 03:23

accept

758be48

add _initialize

dbce0a1

add verify()

b08c9bd

roman-khimov mentioned this pull request Jul 24, 2024

nep-Y: add _deploy NEP #179

Merged

Merge branch 'neo-project:master' into upgrade-standard

9394d4d

superboyiii changed the title ~~Draft NEP 22: Contract Basic Method Guideline~~ NEP 22: Contract Update Standard Sep 11, 2024

contract update method

c8583e9

superboyiii added 3 commits September 11, 2024 14:28

add references

b8978f2

fix

35cea0b

fix

43fde57

shargon reviewed Sep 11, 2024

View reviewed changes

nep-22.mediawiki Outdated Show resolved Hide resolved

shargon added 2 commits September 11, 2024 00:08

Update nep-22.mediawiki

385000b

Update nep-22.mediawiki

dfa5288

shargon reviewed Sep 11, 2024

View reviewed changes

nep-22.mediawiki Outdated Show resolved Hide resolved

roman-khimov reviewed Sep 11, 2024

View reviewed changes

nep-22.mediawiki Outdated Show resolved Hide resolved

nep-22.mediawiki Outdated Show resolved Hide resolved

nep-22.mediawiki Outdated Show resolved Hide resolved

nep-22.mediawiki Outdated Show resolved Hide resolved

improvement

d38495c

Jim8y requested review from shargon, vncoelho, cschuchardt88, roman-khimov and AnnaShaleva September 30, 2024 12:56

vncoelho reviewed Sep 30, 2024

View reviewed changes

roman-khimov reviewed Oct 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NEP 22: Contract Update Standard #154

NEP 22: Contract Update Standard #154

superboyiii commented Aug 31, 2022

ixje left a comment

roman-khimov left a comment

erikzhang commented Sep 20, 2022

roman-khimov commented Sep 20, 2022

superboyiii commented Sep 20, 2022

roman-khimov commented Sep 20, 2022

erikzhang commented Sep 21, 2022

superboyiii commented Sep 21, 2022

superboyiii commented Sep 26, 2022

roman-khimov commented Nov 23, 2022

ixje commented May 8, 2023

roman-khimov commented May 8, 2023

EdgeDLT commented May 8, 2023

Jim8y commented Jun 6, 2024 •

edited

Loading

superboyiii commented Jun 6, 2024

roman-khimov commented Jun 6, 2024

igormcoelho commented Jul 18, 2024

AnnaShaleva commented Jul 18, 2024 •

edited

Loading

cschuchardt88 commented Jul 18, 2024 •

edited

Loading

superboyiii commented Sep 11, 2024

superboyiii commented Sep 12, 2024

vncoelho Sep 30, 2024

roman-khimov Oct 17, 2024

vncoelho Sep 30, 2024

vncoelho Sep 30, 2024

roman-khimov Oct 17, 2024

roman-khimov Oct 17, 2024

roman-khimov Oct 17, 2024

roman-khimov Oct 17, 2024

roman-khimov Oct 17, 2024

roman-khimov Oct 17, 2024


		Updating a smart contract MUST have <code>nefFile</code> or <code>manifest.json</code>. If just update one of them at a time is OK, another SHOULD be set as null. It will be passed to <code>_deploy</code>.

		The parameter <code>data</code> can be any type of supported parameters for contract-specific purpose. For example some kinds of json parameters can be put into data for specific check.


		The parameter <code>data</code> can be any type of supported parameters for contract-specific purpose. For example some kinds of json parameters can be put into data for specific check.

		This function SHOULD check whether the <code>signer</code> address equals the <code>owner</code> hash of contract. This function SHOULD use the SYSCALL <code>Neo.Runtime.CheckWitness</code> to verify the <code>signer</code>. Details has been explained in [NEP-30](https://github.com/superboyiii/proposals/blob/upgrade-standard/nep-30.mediawiki).


		==Motivation==

		As the NEO blockchain scales, Smart Contract Update will become increasingly important. We need standize <code>update</code> method in contract to callback native <code>ContractManagement</code> correctly.


		==Specification==

		Neo N3 has a native <code>ContractManagement</code> contract that is used for contract deployment and update via <code>deploy</code> and <code>update</code> methods of it. After settling with the new NEF and manifest both of them will invoke a special <code>_deploy</code> method if it's implemented by the contract. More details in [NEP-29](https://github.com/neo-project/proposals/blob/master/nep-29.mediawiki)


		This method will will callback <code>Update</code> method in native <code>ContractManagement</code> contract. It will update contract state if it's exectued successfully.

		Updating a smart contract MUST have <code>nefFile</code> or <code>manifest.json</code>. If just update one of them at a time is OK, another SHOULD be set as null. It will be passed to <code>_deploy</code>.

NEP 22: Contract Update Standard #154

Are you sure you want to change the base?

NEP 22: Contract Update Standard #154

Conversation

superboyiii commented Aug 31, 2022

ixje left a comment

Choose a reason for hiding this comment

roman-khimov left a comment

Choose a reason for hiding this comment

erikzhang commented Sep 20, 2022

roman-khimov commented Sep 20, 2022

superboyiii commented Sep 20, 2022

roman-khimov commented Sep 20, 2022

erikzhang commented Sep 21, 2022

superboyiii commented Sep 21, 2022

superboyiii commented Sep 26, 2022

roman-khimov commented Nov 23, 2022

ixje commented May 8, 2023

roman-khimov commented May 8, 2023

EdgeDLT commented May 8, 2023

Jim8y commented Jun 6, 2024 • edited Loading

superboyiii commented Jun 6, 2024

roman-khimov commented Jun 6, 2024

igormcoelho commented Jul 18, 2024

AnnaShaleva commented Jul 18, 2024 • edited Loading

cschuchardt88 commented Jul 18, 2024 • edited Loading

superboyiii commented Sep 11, 2024

superboyiii commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jim8y commented Jun 6, 2024 •

edited

Loading

AnnaShaleva commented Jul 18, 2024 •

edited

Loading

cschuchardt88 commented Jul 18, 2024 •

edited

Loading