Skip to content

Commit

Permalink
chore: Update tangle-substrate-types to v0.5.12 (#758)
Browse files Browse the repository at this point in the history
  • Loading branch information
yurixander authored Sep 7, 2024
1 parent a6dc491 commit 94c3c17
Show file tree
Hide file tree
Showing 12 changed files with 9,775 additions and 1,640 deletions.
13 changes: 11 additions & 2 deletions types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ The package builds the types against the tangle standalone runtime.

### Update Types

In order to update types after making changes to the tangle api do the following:
In order to update types after making changes to the Tangle APIs, do the following:

- Run a local instance of the appropriate runtime. The types in this package correspond to the tangle standalone runtime.

- Change your working directory into the `/types` folder (`cd types`).
- Install dependencies using `yarn`.
- Run the following yarn scripts:
```
yarn update:metadata
Expand All @@ -22,3 +23,11 @@ After updating the types, run a build for the package with
```
yarn build
```

Note that you may run into some errors of missing imports while building. To resolve this, manually add the missing imports on the files with errors. If using VSCode, you can also use its `Add all missing imports` feature to speed up the process.

### Publishing and consuming types package

Once the types have been updated, open a new PR on this repository to submit your changes. Remember to update the types package's version. Once the PR is merged into the `master`, a GitHub Actions workflow will automatically publish them to NPM.

In case that you need to use or prototype the types before they are officially published to NPM, consider installing the package locally and using the local package until its updated version is published to NPM.
5 changes: 3 additions & 2 deletions types/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@webb-tools/tangle-substrate-types",
"version": "0.5.11",
"version": "0.5.12",
"description": "Polkadot.js type definitions required for interacting with Webb's tangle network",
"main": "./build/index.js",
"types": "./build/index.d.ts",
Expand Down Expand Up @@ -69,5 +69,6 @@
"clean": "rm -rf build && rm -rf ts-types",
"publish-types": "node ./scripts/publish-types.js",
"update:metadata": "npx ts-node ./scripts/updateMetadata.ts"
}
},
"packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
}
Loading

0 comments on commit 94c3c17

Please sign in to comment.