Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Alex Seleznov <[email protected]>
  • Loading branch information
xgreenx and alex-tsx authored Jun 16, 2022
1 parent b966138 commit 6f051ac
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions applications/typechain-polkadot.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ Technical specifications can be found [here](https://github.com/Supercolony-net/

| Number | Deliverable | Specification |
| ------ | ----------- | ------------- |
| 0 | License | MIT |
| 1 | TS types | We will research & match types from ABI to TypeScript, compatible with [polkadot{.js} v8](https://polkadot.js.org) library. Separately, for methods' arguments and return values. Files with types definition will be generated. |
| 2 | Runtime code | Prepare output(its draft can be seen in [technical specification](https://github.com/Supercolony-net/typechain-polkadot/blob/master/docs/tech-specs.md#generated-code-draft)) of runtime code with contracts' methods implementation. At this point we have minimal viable coverage of the ABI types, original methods' names, and general types for methods' options, without specifics for contract's [namespaces](https://github.com/Supercolony-net/typechain-polkadot/blob/master/docs/tech-specs.md#namespaces). |
| 3 | Testing | Minimal coverage of PSP22 contract with integration tests. We will be testing correctness of the derived types of the arguments and return values. |
Expand All @@ -160,6 +161,7 @@ Technical specifications can be found [here](https://github.com/Supercolony-net/

| Number | Deliverable | Specification |
| ------ | ----------- | ------------- |
| 0 | License | MIT |
| 1 | Investigation | Broaden types definitions for methods arguments and return values (to full coverage). |
| 2 | Parser & generators modules | Design and implement a new parser module for ABI JSON to work with different versions of the ABI. Parser's output structure serves as an input for generators. Refactor, replace inlne generation with parser to generator flow. |
| 3 | Contract deployment | Support of parsing `*.contract` files. Provide means for contract deployment. |
Expand All @@ -175,6 +177,7 @@ Technical specifications can be found [here](https://github.com/Supercolony-net/

| Number | Deliverable | Specification |
| ------ | ----------- | ------------- |
| 0 | License | MIT |
| 1 | Precise methods definitions | Refine definitions and bahavior of contracts methods (i.e. methods' arguments and returns), depending on namespace, call options and properties of the method, like `payable` & `mutable`. E.g. preamptive querying for transaction calls, controlled by a call options flag. |
| 2 | Methods' names | Format methods' names in the output from original `MethodTrait::method_name` to more user-friendly `methodName` naming scheme, while resolving overlap in formatted names. |
| 3 | Contract classes extension | Extend generated contract classes with useful properties, normally available on the contract (e.g. address, name, signer, etc.). Rely on usage experience in doing so. |
Expand Down

0 comments on commit 6f051ac

Please sign in to comment.