forked from w3f/Grant-Milestone-Delivery
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create typechain-polkadot-follow-up-2.md
- Loading branch information
1 parent
bb3431e
commit fd380a9
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,42 @@ | ||
| # Milestone Delivery :mailbox: | ||
|
|
||
| **The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** | ||
|
|
||
| * **Application Document:** https://github.com/w3f/Grants-Program/pull/1432 | ||
| * **Milestone Number:** 1 | ||
|
|
||
| | Number | Deliverable | Link | Notes | | ||
| |--------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | 0a. | License | [LICENSE](https://github.com/727-Ventures/typechain-polkadot/blob/master/LICENSE) | ... | | ||
| | 0b. | Documentation | [entry-point](https://github.com/727-Ventures/typechain-polkadot) & [auto-generated](https://github.com/727-Ventures/typechain-polkadot/tree/master/docs-generated) & [docs-dir](https://github.com/727-Ventures/typechain-polkadot/tree/master/docs) | Documentation was extended with new-added features | | ||
| | 0c. | Testing and Testing Guide | [Tests directory](https://github.com/727-Ventures/typechain-polkadot/tree/master/tests) & [Testing guide](https://github.com/727-Ventures/typechain-polkadot/blob/master/tests/README.md) | New-added features such as events are covered, also updated accordinly typechain-polkadot updates | | ||
| | 0d. | Docker | [Dockerfile](https://github.com/727-Ventures/typechain-polkadot/blob/master/Dockerfile) & [CI/CD](https://github.com/727-Ventures/typechain-polkadot/blob/master/.github/workflows/ci.yml) | CI/CD and Dockerfile to run examples, test typechain itself and run eslint | | ||
| | 0e. | Article | [article](https://medium.com/brushfam/ways-how-to-use-typechain-polkadot-in-your-project-281ef80b8dd8) | "Ways how to use Typechain-Polkadot in your project" | | ||
| | 1. | User-defined plugins | [docs](https://github.com/727-Ventures/typechain-polkadot/tree/master/packages/typechain-polkadot#plugins) & [source code of plugin structure](https://github.com/727-Ventures/typechain-polkadot/blob/master/packages/typechain-polkadot/src/types/interfaces/index.ts) | Typechain now supports plugins that everyone can add, before we had just pre-written code for tx, query methods and so on, but now we have separate plugin for tx, query, mixed-methods etc. | | ||
| | 2. | Subscribing to events | [docs](https://github.com/727-Ventures/typechain-polkadot/blob/master/docs/about.md#events) & [example](https://github.com/727-Ventures/typechain-polkadot/blob/master/tests/events/general.test.ts) | Now users can subscribe to events that contracts emits | | ||
| | 3. | Typechain-compiler | [package](https://github.com/727-Ventures/typechain-polkadot/tree/master/packages/typechain-compiler) & [guide with example project](https://github.com/727-Ventures/typechain-polkadot/blob/master/docs/about.md#typechain-compiler-case) | Typechain-compiler is very handy tool for developers that have big projects and that don't want to waste time by compiling each contract manually and than moving ABIs to other directories and so on. We are using it in OpenBrush to compile it | | ||
| | 4. | Openbrush integration tests | [tests](https://github.com/727-Ventures/openbrush-contracts/tree/main/tests/e2e) | All tests are using typechain-polkadot functionality and typechain-compiler is used for compiling openbrush contracts instead of redspot | | ||
| | 5. | typechain/types package | [package](https://github.com/727-Ventures/typechain-polkadot/tree/master/packages/typechain-types) | Typechain-types is only one package from typechain-polkadot that compiles from ts to js, it is actively used in generated files to avoid a generating just one code a lot of times, also it's provides better updatability for typechain itself by separating static code from dynamic | | ||
|
|
||
| **Additional Information** | ||
|
|
||
| Testing this delivery: | ||
|
|
||
| - Deliverable 0b: | ||
| - We have docs in every package, so you can check them out by going to the package directory and checking README.md, also in the root of the project we have a docs directory with some additional docs, and if you're confused you can check [content](https://github.com/727-Ventures/typechain-polkadot/blob/master/README.md#documentation-) | ||
| - Deliverable 0c: | ||
| - We have a [testing guide](https://github.com/727-Ventures/typechain-polkadot/blob/master/tests/README.md) on how to run tests, and also we have a [CI/CD](https://github.com/727-Ventures/typechain-polkadot/blob/master/.github/workflows/ci.yml) that runs tests on every pull request to the master branch | ||
| - Deliverable 0d: | ||
| - We have a [Dockerfile](https://github.com/727-Ventures/typechain-polkadot/blob/master/Dockerfile) that is used for building docker image, and also we have a [CI/CD](https://github.com/727-Ventures/typechain-polkadot/blob/master/.github/workflows/ci.yml), docker file published on [github packages](https://ghcr.io/727-ventures/typechain-polkadot-ci) | ||
| - Deliverable 0e: | ||
| - Article is published on [medium](https://medium.com/brushfam/ways-how-to-use-typechain-polkadot-in-your-project-281ef80b8dd8), it's about how to use typechain-polkadot in your project, it's a very good article that can help users to start with typechain, also it has an example project that you can use to test typechain-polkadot and typechain-compiler | ||
| - Deliverable 1: | ||
| - We have a [docs](https://github.com/727-Ventures/typechain-polkadot/tree/master/packages/typechain-polkadot#plugins), and also we have an example how typechain itself uses plugins, you can check it out [here](https://github.com/727-Ventures/typechain-polkadot/blob/master/packages/typechain-polkadot/index.ts), so you can test this deliverable by following the steps in documentation | ||
| - Deliverable 2: | ||
| - We have [docs](https://github.com/727-Ventures/typechain-polkadot/blob/master/docs/about.md#events) & [example](https://github.com/727-Ventures/typechain-polkadot/blob/master/tests/events/general.test.ts), if something is unclear, we're encouraging you to check [tests directory](https://github.com/727-Ventures/typechain-polkadot/tree/master/tests/events) | ||
| - Deliverable 3: | ||
| - You can test by following steps in the article [typechain-compiler](https://medium.com/brushfam/ways-how-to-use-typechain-polkadot-in-your-project-281ef80b8dd8), it has a lot of information about how to use typechain-compiler, and also it has an example project that you can use to test typechain-compiler | ||
| - Deliverable 4: | ||
| - You can test by running the openbrush unit tests, which use typechain-polkadot | ||
| - Deliverable 5: | ||
| - You can check our [package](https://github.com/727-Ventures/typechain-polkadot/tree/master/packages/typechain-types), which contains everything that typechain-polkadot uses as a static code for generated code |