-
Notifications
You must be signed in to change notification settings - Fork 1k
[Neo Core Style] define a class for the contractbasemethod #3291
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,122 @@ | ||
| // Copyright (C) 2015-2024 The Neo Project. | ||
| // | ||
| // ContractBasicMethod.cs file belongs to the neo project and is free | ||
| // software distributed under the MIT software license, see the | ||
| // accompanying file LICENSE in the main directory of the | ||
| // repository or http://www.opensource.org/licenses/mit-license.php | ||
| // for more details. | ||
| // | ||
| // Redistribution and use in source and binary forms with or without | ||
| // modifications are permitted. | ||
|
|
||
| namespace Neo.SmartContract | ||
| { | ||
| /// <summary> | ||
| /// This class provides a guideline for basic methods used in the Neo blockchain, offering | ||
| /// a generalized interaction mechanism for smart contract deployment, verification, updates, and destruction. | ||
| /// </summary> | ||
| public record ContractBasicMethod | ||
| { | ||
| /// <summary> | ||
| /// The verification method. This must be called when withdrawing tokens from the contract. | ||
| /// If the contract address is included in the transaction signature, this method verifies the signature. | ||
| /// Example: | ||
| /// <code> | ||
| /// public static bool Verify() => Runtime.CheckWitness(Owner); | ||
| /// </code> | ||
| /// <code> | ||
| /// { | ||
| /// "name": "verify", | ||
| /// "safe": false, | ||
| /// "parameters": [], | ||
| /// "returntype": "bool" | ||
| /// } | ||
| /// </code> | ||
| /// </summary> | ||
| public static string Verify { get; } = "verify"; | ||
|
|
||
| /// <summary> | ||
| /// The initialization method. Compiled into the <see cref="Manifest"/> file if any function uses the initialize statement. | ||
| /// These functions are executed first when loading the contract. | ||
| /// Example: | ||
| /// <code> | ||
| /// private static readonly UInt160 owner = "NdUL5oDPD159KeFpD5A9zw5xNF1xLX6nLT"; | ||
| /// </code> | ||
| /// </summary> | ||
| public static string Initialize { get; } = "_initialize"; | ||
|
|
||
| /// <summary> | ||
| /// The deployment method. Automatically executed by the ContractManagement contract when a contract is first deployed or updated. | ||
| /// <code> | ||
| /// { | ||
| /// "name": "_deploy", | ||
| /// "safe": false, | ||
| /// "parameters": [ | ||
| /// { | ||
| /// "name": "data", | ||
| /// "type": "Any" | ||
| /// }, | ||
| /// { | ||
| /// "name": "update", | ||
| /// "type": "Boolean" | ||
| /// } | ||
| /// ], | ||
| /// "returntype": "Void" | ||
| /// } | ||
| /// </code> | ||
| /// </summary> | ||
| public static string Deploy { get; } = "_deploy"; | ||
|
|
||
| /// <summary> | ||
| /// The update method. Requires <see cref="NefFile"/> or <see cref="Manifest"/>, or both, and is passed to _deploy. | ||
| /// Should verify the signer's address using SYSCALL <code>Neo.Runtime.CheckWitness</code>. | ||
| /// <code> | ||
| /// { | ||
| /// "name": "update", | ||
| /// "safe": false, | ||
| /// "parameters": [ | ||
| /// { | ||
| /// "name": "nefFile", | ||
| /// "type": "ByteArray" | ||
| /// }, | ||
| /// { | ||
| /// "name": "manifest", | ||
| /// "type": "ByteArray" | ||
| /// }, | ||
| /// { | ||
| /// "name": "data", | ||
| /// "type": "Any" | ||
| /// } | ||
| /// ], | ||
| /// "returntype": "Void" | ||
| /// } | ||
| /// </code> | ||
| /// </summary> | ||
| public static string Update { get; } = "update"; | ||
|
|
||
| /// <summary> | ||
| /// The destruction method. Deletes all the storage of the contract. | ||
| /// Should verify the signer's address using SYSCALL <code>Neo.Runtime.CheckWitness</code>. | ||
| /// Any tokens in the contract must be transferred before destruction. | ||
| /// <code> | ||
| /// { | ||
| /// "name": "destroy", | ||
| /// "safe": false, | ||
| /// "parameters": [], | ||
| /// "returntype": "Void" | ||
| /// } | ||
| /// </code> | ||
| /// </summary> | ||
| public static string Destroy { get; } = "destroy"; | ||
|
|
||
| /// <summary> | ||
| /// Parameter counts for the methods. | ||
| /// -1 represents the method can take arbitrary parameters. | ||
| /// </summary> | ||
| public static int VerifyPCount { get; } = -1; | ||
|
shargon marked this conversation as resolved.
|
||
| public static int InitializePCount { get; } = 0; | ||
| public static int DeployPCount { get; } = 2; | ||
| public static int UpdatePCount { get; } = 3; | ||
| public static int DestroyPCount { get; } = 0; | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.