nep-Y: add _deploy NEP #179
Conversation
NEP-22 can reference it. This mostly follows the implementation, there is nothing really new here. Signed-off-by: Roman Khimov <[email protected]>
|
Refs. #154. |
|
See, man, here is the problem, you dont have an NEP number,,,,, and we have to approve it without the number,,, then when its acctepted, you will need to update it with a number,,,, then all of us have to reapprove it again...... you know how hard it is to collect review and approves. |
Signed-off-by: Roman Khimov <[email protected]>
| <pre> | ||
| { | ||
| "name": "_deploy", | ||
| "safe": false, | ||
| "parameters": [ | ||
| { | ||
| "name": "data", | ||
| "type": "Any" | ||
| }, | ||
| { | ||
| "name": "update", | ||
| "type": "Boolean" | ||
| } | ||
| ], | ||
| "returntype": "Void" | ||
| } | ||
| </pre> |
There was a problem hiding this comment.
{
"name": "_deploy",
"safe": false,
"parameters": [
{
"name": "data",
"type": "Any"
},
{
"name": "update",
"type": "Boolean"
}
],
"returntype": "Void"
}There was a problem hiding this comment.
syntax highlighting would be nice.
There was a problem hiding this comment.
See #180 (comment)
nep-29.mediawiki
Outdated
|
|
||
| ==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 can invoke a special <code>_deploy</code> method if it's implemented by the contract. |
There was a problem hiding this comment.
Neo N3 has a native ContractManagement contract that is used for contract deployment (deploy) and update (update) methods. After settling with the new NEF and Manifest, both of them can invoke a special _deploy method (if it's implemented by the contract).
There was a problem hiding this comment.
@roman-khimov, consider this new sentence.
One question.
"both of them can invoke a special¨, you mean, if the developer implements the _deploy method, it is still optional to call it from Deploy/Update,right?
It is not automatically and compulsory, correct?
There was a problem hiding this comment.
consider this new sentence.
It was phrased like that in one of the earlier drafts, but I wanted to avoid "deployment (deploy)/update (update)". Pure stylistic, I like the way it's in the PR, but I can change it as well if there is a wider agreement that your version is better.
if the developer implements the _deploy method
Then it will always be called. Maybe s/can/will/ makes sense here, a bit stronger causality (if implemented -> will invoke).
There was a problem hiding this comment.
Fixed. Now we need more approvals.
Use more strict wording to clarify how it works. Signed-off-by: Roman Khimov <[email protected]>
roman-khimov
dismissed stale reviews from AnnaShaleva, shargon, and Jim8y
via
b857b61
|
My only recommendation here is to include an example of of the |
Signed-off-by: Roman Khimov <[email protected]>
roman-khimov
dismissed stale reviews from shargon, Jim8y, and AnnaShaleva
via
f318350
This better be in implementations, some of them do use it.
Added! It's not used often, so it takes some time to find any implementation. |
nep-29.mediawiki
Outdated
| } | ||
| </pre> | ||
|
|
||
| This method will be automatically executed by ContractManagement contract when a contract is first deployed or updated. At this point new contract state is already saved (and it can be called from other code), but <code>Deploy</code> or <code>Update</code> notification is not yet emitted by ContractManagement contract. |
There was a problem hiding this comment.
| This method will be automatically executed by ContractManagement contract when a contract is first deployed or updated. At this point new contract state is already saved (and it can be called from other code), but <code>Deploy</code> or <code>Update</code> notification is not yet emitted by ContractManagement contract. | |
| This method will be automatically executed by <code>ContractManagement</code> contract when a contract is first deployed or updated. At this point new contract state is already saved (and it can be called from other code), but <code>Deploy</code> or <code>Update</code> notification is not yet emitted by <code>ContractManagement</code> contract. |
wrap ContractManagement
nep-29.mediawiki
Outdated
|
|
||
| <code>_deploy</code> parameters are made to be generic enough to cover all contract state management cases, it is possible to get additional per-network or per-instance contract data for initialization and updates can be easily differentiated from deployments via <code>update</code> parameter. | ||
|
|
||
| Notice that if there are any notifications emitted during <code>_deploy</code> execution they will precede <code>Deploy</code> or <code>Update</code> notifications from ContractManagement. This behavior is historic, it mostly means that we're considering contract to be completely ready after succesful <code>_deploy</code> invocation (it can throw an exception or abort execution as well). |
There was a problem hiding this comment.
| Notice that if there are any notifications emitted during <code>_deploy</code> execution they will precede <code>Deploy</code> or <code>Update</code> notifications from ContractManagement. This behavior is historic, it mostly means that we're considering contract to be completely ready after succesful <code>_deploy</code> invocation (it can throw an exception or abort execution as well). | |
| Notice that if there are any notifications emitted during <code>_deploy</code> execution they will precede <code>Deploy</code> or <code>Update</code> notifications from <code>ContractManagement</code>. This behavior is historic, it mostly means that we're considering contract to be completely ready after succesful <code>_deploy</code> invocation (it can throw an exception or abort execution as well). |
wrap ContractManagement
nep-29.mediawiki
Outdated
| ==Implementation== | ||
|
|
||
| * https:/nspcc-dev/neofs-contract/blob/99fb86c35a48ed12017423aa4fee13f7d07fa4c0/contracts/netmap/contract.go#L79 | ||
| * https:/neo-project/non-native-contracts/blob/8d72b92e5e5705d763232bcc24784ced0fb8fc87/src/NameService/NameService.cs#L439 |
There was a problem hiding this comment.
| * https:/neo-project/non-native-contracts/blob/8d72b92e5e5705d763232bcc24784ced0fb8fc87/src/NameService/NameService.cs#L439 | |
| * C# .NET - https:/neo-project/non-native-contracts/blob/8d72b92e5e5705d763232bcc24784ced0fb8fc87/src/NameService/NameService.cs#L439 |
And reoder them alphabetically. Signed-off-by: Roman Khimov <[email protected]>
Sometimes it's <code></code>, sometimes it's not, make it uniform. Signed-off-by: Roman Khimov <[email protected]>
roman-khimov
requested review from
cschuchardt88,
Jim8y,
AnnaShaleva and
shargon
|
Seems good to merge. |
NEP-22 can reference it. This mostly follows the implementation, there is nothing really new here.