https://github.com/pooltogether/contract-list-schema

A package for maintaining protocol deployments & ABIs
https://github.com/pooltogether/contract-list-schema

Last synced: about 2 months ago
JSON representation

A package for maintaining protocol deployments & ABIs

• Host: GitHub
• URL: https://github.com/pooltogether/contract-list-schema
• Owner: pooltogether
• License: mit
• Created: 2021-09-02T18:43:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-16T15:00:51.000Z (over 2 years ago)
• Last Synced: 2024-04-23T21:42:34.692Z (9 months ago)
• Language: TypeScript
• Size: 156 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `contract-list-schema`

[![npm](https://img.shields.io/npm/v/@pooltogether/contract-list-schema)](https://unpkg.com/@pooltogether/contract-list-schema@latest/)

A package for maintaining contract deployments & ABIs.

## Notes

With hardcoded addresses in a schema, when swapping out a contract address there will be a period of time when this package doesn't match live chain data.

## Maintaining

### **When swapping or removing a contract**

- Bump package **MAJOR** version

- Add contract ABIs (if necessary)

- Update relevant contracts in `contracts`

### **When deploying a new contract**

- Bump package **MINOR** version

- Add contract ABIs (if necessary)

- Add contracts to `contracts` (where necessary)

### **When adding a new tag**

- Bump package **MINOR** version

- Add tag to `tags`

- Add tag to relevant Contracts in `contracts`

#### Local use

In `contract-list-schema`

`yalc publish --push`

In the repo you want to use `contract-list-schema`

`yalc add contract-list-schema`