Skip to content

Latest commit

 

History

History
42 lines (36 loc) · 10.3 KB

typechain-polkadot-follow-up-2.md

File metadata and controls

42 lines (36 loc) · 10.3 KB
Raw

Milestone Delivery 📫

The invoice form 📝 has been filled out correctly for this milestone and the delivery is according to the official milestone delivery guidelines.

Number Deliverable Link Notes
0a. License LICENSE ...
0b. Documentation entry-point & auto-generated & docs-dir Documentation was extended with new-added features
0c. Testing and Testing Guide Tests directory & Testing guide New-added features such as events are covered, also updated accordinly typechain-polkadot updates
0d. Docker Dockerfile & CI/CD CI/CD and Dockerfile to run examples, test typechain itself and run eslint
0e. Article article "Ways how to use Typechain-Polkadot in your project"
1. User-defined plugins docs & source code of plugin structure 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 & example Now users can subscribe to events that contracts emits
3. Typechain-compiler package & guide with example project 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 All tests are using typechain-polkadot functionality and typechain-compiler is used for compiling openbrush contracts instead of redspot
5. typechain/types package package 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
  • Deliverable 0c:
    • We have a testing guide on how to run tests, and also we have a CI/CD that runs tests on every pull request to the master branch
  • Deliverable 0d:
  • Deliverable 0e:
    • Article is published on medium, 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, and also we have an example how typechain itself uses plugins, you can check it out here, so you can test this deliverable by following the steps in documentation
  • Deliverable 2:
  • Deliverable 3:
    • You can test by following steps in the article typechain-compiler, 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, which contains everything that typechain-polkadot uses as a static code for generated code