icon-project / documentation Goto Github PK

cbc2be0#comments

Lifecycle of SCORE

b0ebc7a#comments

• Need to separate Audit checklist from this documents, since Audit lists are frequently able to be changed.
• Need to explain overall process and structure of Contract (-> This can be covered by 'SCORE overview'.). I think this document is main guide to write SCORE, so almost things should be in this documents, even it may be duplicated. This document should cover from creating projects with tbears, to deplying contract to main-net.
• How to check eventlog recorded.
• Example of event handling using both revert() and IconServiceBaseException. It would be better if we explain why we recommend to use revert() rather than IconServiceBaseException.
• In InterfaceScore, we need to show the example of other callee Contract's codes.

19e2a1f#comments

3375c2f#comments

I went through the process of reading this documentation and pushing a multisig wallet SCORE on the mainnet yesterday, so I'll share my feedback here :

In the "How to use" section, the field _walletOwners and _required are introduced as parameters needed for deploying the multisig SCORE, however it is really unclear how to set these parameters before reading the end of the documentation, as it provides complete examples of this SCORE API calls.

I experienced issues with deploying this SCORE using my version of t-bears on the mainnet. I'm using the latest version of tbears publicly released (tbears v1.1.0.1), I had errors such as "JSON verification failed, invalid params values". I had to use a SDK in order to send the deploy transaction.

I agree with @jeegun that overall, the purpose of the methods of this multisig wallet is not clearly defined. The whole process of using this multisig wallet is not explained. What is the process you recommand for using this wallet ? What methods should walletOwners call, when, and why, in order to use this wallet correctly ?

4b85e5e#comments

3375c2f#commitcomment-32694854

For icon-json-rpc-v3.md: Overall, the documents needs to be more descriptive. The document as a whole and each section needs communicate its purpose better. For example, in the 'methods' section, it would be helpful to present a high level overview of the methods before listing the methods.