Skip to content

Commit

Permalink
Milestone 3 main functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
varex83 committed Feb 1, 2023
1 parent c1a26d6 commit 6ebf49e
Show file tree
Hide file tree
Showing 321 changed files with 25,618 additions and 12,620 deletions.
5 changes: 3 additions & 2 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ module.exports = {
"import/no-cycle": "error",
"import/no-self-import": "error",
"@typescript-eslint/consistent-type-assertions": [
"off",
"warn",
{ assertionStyle: "never" }
],
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/no-non-null-assertion": "warn",
},
};
40 changes: 40 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: CI/CD

on:
pull_request:
branches: [ master ]

jobs:
# examples-builds:
# eslint:
# eslint-on-output:
integration-tests:
concurrency:
group: integration-tests-${{ github.ref }}
cancel-in-progress: true
runs-on: ubuntu-latest
needs: examples-builds
container:
image: ghcr.io/supercolony-net/openbrush-contracts-ci
options: --user root
env:
CARGO_TARGET_DIR: /usr/local/cache/target
steps:
- uses: actions/setup-node@v1
with:
node-version: '16.x'
- uses: actions/checkout@v3
- name: Yarn install dependencies
run: |
npm install
- name: Cache contract artifacts
id: cache-contract-artifacts
uses: actions/cache@v3
with:
path: artifacts
key: cache-contract-artifacts-${{ github.sha }}

- name: Run Test Mocha
run: |
npm run test
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
![Typechain](https://user-images.githubusercontent.com/43150707/215465145-ef41167c-ef40-4f3c-8fd8-ca56a2480810.png)

If you have any questions regarding Typechain-Polkadot, you can join the [Brushfam Element channel](https://matrix.to/#/!utTuYglskDvqRRMQta:matrix.org?via=matrix.org&via=t2bot.io&via=web3.foundation) to find your answers and meet other ink! smart contracts developers.

## Overview :page_facing_up:

Typechain is maintained by [Brushfam](https://www.brushfam.io/) team to improve developers’ experience working with ink! smart contracts.
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.

Expand All @@ -19,16 +16,16 @@ Interaction with blockchain is done with polkadot.js library, which only has abs
Install the package as dependency:

```bash
npm i @727-ventures/typechain-polkadot
yarn add @727-ventures/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 @727-ventures/typechain-polkadot --in artifacts --out typed_contracts
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/727-Ventures/openbrush-contracts/tree/main/examples/psp22)):
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"
```
Expand Down Expand Up @@ -75,12 +72,13 @@ Given, that a front-end developer needs to do this with every contracts update,

When contracts descriptions come both with ABI and source code (`*.contract` files), our tool will provide means for deployment as well.

Also, Typechain-Polkadot uses awesome tool Handlebars for generating code from templates. It is a very flexible and powerful tool, which allows to generate code from templates with a lot of different logic.
For example, you can generate code for different contracts with different logic, or you can generate code for different methods with different logic.

## 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-follow-up.md)
- [Delivery milestone 1](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/deliveries/typechain-polkadot-milestone-1.md#milestone-delivery-mailbox)
- [Delivery milestone 2](https://github.com/w3f/Grant-Milestone-Delivery/blob/master/deliveries/typechain-polkadot-milestone-2.md)
- [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)
2 changes: 1 addition & 1 deletion docs-generated/assets/search.js

Large diffs are not rendered by default.

Loading

0 comments on commit 6ebf49e

Please sign in to comment.