@0xsquid/squid-types

Squid Types

Squid types used on the data feed, pathfinder api and sdk.

LINTER & PRETTIER

This project has Prettier and ESLint linter rules installed. With Husky we ensure pre-commit and pre-push validation.

yarn lint

yarn lint:fix

yarn format

VSCODE SETUP

Create a file .vscode/settings.json for auto-saving linter and prettier formatting.

Add the following:

{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "[json]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

RELEASE

NPM package publishing is automated with github actions. Follow these steps:

1. Create a PR to the develop branch

• Update version inside package.json
• Review, approve and merge.

2. Create a PR from develop to main

• Review, approve and merge

As the PR from (2.) is merged, the commit to main will automatically trigger a release to NPM, please make sure you correctly update the version.