Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Supercolony-net/typechain-polkadot
https://github.com/Supercolony-net/typechain-polkadot
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/Supercolony-net/typechain-polkadot
- Owner: Supercolony-net
- License: mit
- Created: 2022-06-16T06:59:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-06T18:47:37.000Z (over 1 year ago)
- Last Synced: 2024-11-07T18:12:49.242Z (about 1 month ago)
- Language: TypeScript
- Size: 310 KB
- Stars: 13
- Watchers: 4
- Forks: 28
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-substrate - Typechain-Polkadot - Hepls users to generate typescript types from contract ABIs (ink!) and generate runtime code to interact with contracts and deploy them. (Tools)
- awesome-substrate - Typechain-Polkadot - Hepls users to generate typescript types from contract ABIs (ink!) and generate runtime code to interact with contracts and deploy them. (Tools)
README
## Overview :page_facing_up:
Typechain was created by [Supercolony](supercolony.net) to to improve developers’ experience working with ink! smartcontracts.
Nowadays, when technologies are growing faster and faster, we should think about optimizations of different routine processes and making older stuff better. One of these optimizations is to make code typesafe that will be flexible in different situations.
When a smart contract is being written, front-end developer receives file representation of it in the format called Application Binary Interface (ABI). One ABI per each contract, new ABI for every update of a contract.
Information about how to interact with a contract (methods names, arguments & returns types etc.) is included in this ABI file. It is not quite human-readable, so extraction of that information becomes a challenge. We need to have correct type definitions for each contract in TypeScript.
Interaction with blockchain is done with polkadot.js library, which only has abstract definitions for the contract in use, thus users' code cannot be typesafe. And Typechain-Polkadot can change it.
### Installation & import
Install the package as dependency:
```bash
yarn add @supercolony/typechain-polkadot
```
Pass the folder with artifacts(in the example it is `artifacts`) as input argument
and the output folder(in the example it is `typed_contracts`):
```bash
npx typechain-polkadot --in artifacts --out typed_contracts
```
Import the contract what you want to use(in the example it is [`my_psp22`](https://github.com/Supercolony-net/openbrush-contracts/tree/main/examples/psp22)):
```typescript
import MyPSP22 from "../typed_contracts/contracts/my_psp22"
```
In the code you can find all available methods and constructors.
Right now, you can't instantiate the contract via typechain(coming soon),
but you can wrap any already deployed contract. If in the code you already
have instantiated `contract` then you can easily wrap it:
```typescript
const typed_contract = new MyPSP22(
contract.address.toString(),
signer /* who will sign transactions*/,
contract.api
);
```
More information you can find in [docs](docs/about.md).
### Usage of Typechain-compiler
```bash
npx typechain-compiler --config config.json
```
Also you can set some additional arguments like `--noCompile`, `--noTypechain`, `--release`
Config interface will be something like this:
```typescript
export interface Config {
projectFiles: string[]; // Path to all project files, everystring in glob format
skipLinting : boolean; // Skip linting of project files
artifactsPath : string; // Path to artifacts folder, where artifacts will be stored it will save both .contract and .json (contract ABI)
typechainGeneratedPath : string; // Path to typechain generated folder
}
```
### Project Details
Typesafe contracts' descriptions can be generated automatically by a script, taking a list of ABIs as an input, giving usable TS type definitions and even runtime code as its output.
Given, that a front-end developer needs to do this with every contracts update, such tool would save a lot of time and prevent mistakes of misusing smart contracts. It is installed as a package with built-in CLI.
When contracts descriptions come both with ABI and source code (`*.contract` files), our tool will provide means for deployment as well.
## Roadmap 🚗
Typechain participates in the Web3 Grants, you can find the roadmap there:
- [Grant I](https://github.com/w3f/Grants-Program/blob/master/applications/typechain-polkadot.md)
- [Delivery milestone 1](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/deliveries/typechain-polkadot-milestone-1.md#milestone-delivery-mailbox)
- Grant II - Comming soon....
-----------
#### Made with ❤️ by [Supercolony](https://supercolony.net)