Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable a subset of eipw lints (closes #117) #158

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+389 −111
Open

Enable a subset of eipw lints (closes #117) #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .eipw.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
[[modifiers]]
kind = "set-default-annotation"
name = "status"
value = "Stagnant"
annotation_type = "warning"

[[modifiers]]
kind = "set-default-annotation"
name = "status"
value = "Withdrawn"
annotation_type = "warning"

[lints.preamble-author]
kind = "preamble-author"
name = "author"

[lints.preamble-order]
kind = "preamble-order"
names = [
"pip",
"title",
"description",
"author",
"discussion",
"status",
"type",
"date",
]

[lints.preamble-req]
kind = "preamble-required"
names = [
"pip",
"title",
"description",
"author",
"discussion",
"status",
"type",
"date",
]

[lints.preamble-date-created]
kind = "preamble-date"
name = "date"

[lints.preamble-trim]
kind = "preamble-trim"

[lints.preamble-pip]
kind = "preamble-uint"
name = "pip"

[lints.preamble-no-dup]
kind = "preamble-no-duplicates"

[lints.preamble-re-description-pip-dash]
kind = "preamble-regex"
name = "description"
mode = "excludes"
pattern = '(?i)pip[\s]*[0-9]+'
message = "proposals must be referenced with the form `PIP-N` (not `PIPN` or `PIP N`)"

[lints.preamble-re-title-pip-dash]
kind = "preamble-regex"
name = "title"
mode = "excludes"
pattern = '(?i)pip[\s]*[0-9]+'
message = "proposals must be referenced with the form `PIP-N` (not `PIPN` or `PIP N`)"

[lints.preamble-discussion]
kind = "preamble-url"
name = "discussion"

[lints.preamble-list-author]
kind = "preamble-list"
name = "author"

[lints.markdown-re-pip-dash]
kind = "markdown-regex"
mode = "excludes"
pattern = '(?i)pip[\s]*[0-9]+'
message = "proposals must be referenced with the form `PIP-N` (not `PIPN` or `PIP N`)"
27 changes: 27 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Continuous Integration

on:
pull_request:
types:
- opened
- reopened
- synchronize
- ready_for_review
- edited

jobs:
eipw-validator:
name: PIP Validator
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@47fbe2df0ad0e27efb67a70beac3555f192b062f

- uses: ethereum/eipw-action@88d2e579767028a48f712cd9e8d25639347dc236
id: eipw
with:
token: ${{ secrets.GITHUB_TOKEN }}
unchecked: 1
path: PIPs/
options-file: .eipw.toml
14 changes: 10 additions & 4 deletions PIPs/PIP-01.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 1 | PIP Purpose and Guidelines | Describes community standards for the Polygon ecosystem, including core protocol specifications | Harry Rook, Mateusz Rzeszowski | [Forum](https://forum.polygon.technology/t/pip-1-pip-purpose-and-guidelines/11356) | Continuous | Informational | 2023-22-02
---
pip: 1
title: PIP Purpose and Guidelines
description: Describes community standards for the Polygon ecosystem, including core protocol specifications
author: Harry Rook (@hrook1), Mateusz Rzeszowski
discussion: https://forum.polygon.technology/t/pip-1-pip-purpose-and-guidelines/11356
status: Continuous
type: Informational
date: 2023-02-22
---

### Abstract
### Abstract

Polygon Improvement Proposals (PIPs) describe community standards for the Polygon ecosystem, including core protocol specifications such as Heimdall and Bor, client APIs, and contract standards, etc.

Expand Down
12 changes: 9 additions & 3 deletions PIPs/PIP-02.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 2 | Proposal to distribute and decentralize staking power across the Polygon chain | Proposal to increase the minimun commission. | Delroy Bosco | [Forum](https://forum.polygon.technology/t/pip-2-proposal-to-distribute-and-decentralize-staking-power-across-the-polygon-chain/219/11) | Stagnant | Contracts | 2021-11-01
---
pip: 2
title: Proposal to distribute and decentralize staking power across the Polygon chain
description: Proposal to increase the minimun commission.
author: Delroy Bosco
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't find a GitHub username for Delroy, so any future changes to this file will report an error on this line. Mostly just an annoyance.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing it out, I can find the username if needs be.

discussion: https://forum.polygon.technology/t/pip-2-proposal-to-distribute-and-decentralize-staking-power-across-the-polygon-chain/219/11
status: Stagnant
type: Contracts
date: 2021-11-01
---

### Abstract:
Expand Down
14 changes: 10 additions & 4 deletions PIPs/PIP-03.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|---------------------------------------|
| 3 | Auction Mechansim - A Mechanism to replace bad and under-performing validators| Proposes a mechanism to replace under-performing validators |Delroy Bosco | [Forum](https://forum.polygon.technology/t/pip-3-auction-mechansim-a-mechanism-to-replace-bad-and-under-performing-validators/8270/6)|Stagnant | Contracts | 2021-06-01 |

---
pip: 3
title: Auction Mechansim - A Mechanism to replace bad and under-performing validator
description: Proposes a mechanism to replace under-performing validators
author: Delroy Bosco
discussion: https://forum.polygon.technology/t/pip-3-auction-mechansim-a-mechanism-to-replace-bad-and-under-performing-validators/8270/6
status: Stagnant
type: Contracts
date: 2021-06-01
---

### Abstract:

Expand Down
14 changes: 10 additions & 4 deletions PIPs/PIP-04.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 4 | Validator Performance Management Proposal | Proposes a framework that will allow further decentralization of the network by means of validator self-regulation. | Eric Hill, Harry Rook, Mateusz Rzesowski | [Forum](https://forum.polygon.technology/t/pip-4-validator-performance-management/9956) | Final | Contracts | 2022-08-22|

---
pip: 4
title: Validator Performance Management Proposal
description: Proposes a framework that will allow further decentralization of the network by means of validator self-regulation.
author: Eric Hill, Harry Rook (@hrook1), Mateusz Rzesowski
discussion: https://forum.polygon.technology/t/pip-4-validator-performance-management/9956
status: Final
type: Contracts
date: 2022-08-22
---


### Abstract
Expand Down
15 changes: 10 additions & 5 deletions PIPs/PIP-05.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 5 | Change in SprintLength | Proposes a change in the SprintLenght | Sandeep Sreenath, Paul O’Leary, Arpit Temani | [Forum](https://forum.polygon.technology/t/pip-5-change-in-sprintlength/10874/4) | Final | Core | 2023-01-10 |


---
pip: 5
title: Change in SprintLength
description: Proposes a change in the SprintLenght
author: Sandeep Sreenath (@ssandeep), Paul O’Leary, Arpit Temani
discussion: https://forum.polygon.technology/t/pip-5-change-in-sprintlength/10874/4
status: Final
type: Core
date: 2023-01-10
---

### Motivation

Expand Down
16 changes: 10 additions & 6 deletions PIPs/PIP-06.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 6 | Change in BaseFeeChangeDenominator | Proposes a change in the BaseFeeChangeDenominator | Shivam Sharma, Sandeep Sreenath, Paul O’Leary | [Forum](https://forum.polygon.technology/t/pip-6-change-in-basefeechangedenominator/10875/4) | Final | Core | 2023-01-10 |



---
pip: 6
title: Change in BaseFeeChangeDenominator
description: Proposes a change in the BaseFeeChangeDenominator
author: Shivam Sharma, Sandeep Sreenath (@ssandeep), Paul O’Leary
discussion: https://forum.polygon.technology/t/pip-6-change-in-basefeechangedenominator/10875/4
status: Final
type: Core
date: 2023-01-10
---

### Motivation

Expand Down
15 changes: 10 additions & 5 deletions PIPs/PIP-07.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 7 | Delhi Hardfork | Proposes the Delhi Hardfork | Harry Rook | [Forum](https://forum.polygon.technology/t/pip-7-delhi-hardfork/10904/2) | Final | Core | 2023-01-12 |


---
pip: 7
title: Delhi Hardfork
description: Proposes the Delhi Hardfork
author: Harry Rook (@hrook1)
discussion: https://forum.polygon.technology/t/pip-7-delhi-hardfork/10904/2
status: Final
type: Core
date: 2023-01-12
---

### Abstract

Expand Down
14 changes: 10 additions & 4 deletions PIPs/PIP-08.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 8 | PIP Classification, Workflow and Implementation | Describes a proposed classification scheme for PIPs and their respective work flows. | Harry Rook , Mateusz Rzeszowski | [Forum](https://forum.polygon.technology/t/pip-8-pip-classification-workflow-and-implementation/11365/1) | Continuous | Informational | 2023-02-21 |

---
pip: 8
title: PIP Classification, Workflow and Implementation
description: Describes a proposed classification scheme for PIPs and their respective work flows.
author: Harry Rook (@hrook1), Mateusz Rzeszowski
discussion: https://forum.polygon.technology/t/pip-8-pip-classification-workflow-and-implementation/11365/1
status: Continuous
type: Informational
date: 2023-02-21
---

## Abstract

Expand Down
13 changes: 10 additions & 3 deletions PIPs/PIP-09.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 9 | Performance Benchmark Adjustment | Maintaining the current level of Performance Benchmark at 95% | Delroy Bosco, Jackson Lewis, Harry Rook, Mateusz Rzeszowski| [Forum](https://forum.polygon.technology/t/pip-9-performance-benchmark-adjustment/11387) | Final | Contracts | 2023-02-23 |
---
pip: 9
title: Performance Benchmark Adjustment
description: Maintaining the current level of Performance Benchmark at 95%
author: Delroy Bosco, Jackson Lewis, Harry Rook (@hrook1), Mateusz Rzeszowsk
discussion: https://forum.polygon.technology/t/pip-9-performance-benchmark-adjustment/11387
status: Final
type: Contracts
date: 2023-02-23
---

### Abstract

Expand Down
12 changes: 9 additions & 3 deletions PIPs/PIP-10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 10 | Increase StateSync Confirmations | Proposal to increase the statesync confirmations in bor | [Krishna Upadhyaya](https://github.com/0xKrishna), [Manav Darji](https://github.com/manav2401), [Pratik Patil](https://github.com/pratikspatil024) | [Forum](https://forum.polygon.technology/t/proposal-increase-statesync-confirmations/11779) | Draft | Core | 2023-18-04
---
pip: 10
title: Increase StateSync Confirmations
description: Proposal to increase the statesync confirmations in bor
author: Krishna Upadhyaya (@0xKrishna), Manav Darji (@manav2401), Pratik Patil (@pratikspatil024)
discussion: https://forum.polygon.technology/t/proposal-increase-statesync-confirmations/11779
status: Draft
type: Core
date: 2023-04-18
---

### Abstract
Expand Down
12 changes: 9 additions & 3 deletions PIPs/PIP-11.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 11 | Deterministic finality via Milestones | Proposal to introduce Milestones in Polygon PoS to have deterministic finality | [Vaibhav Jindal](https://github.com/VAIBHAVJINDAL3012), [Arpit Temani](https://github.com/temaniarpit27), [Evgeniy Danilenko](https://github.com/JekaMas/), [Manav Darji](https://github.com/manav2401), [Sandeep Sreenath](https://github.com/ssandeep) | [Forum Post](https://forum.polygon.technology/t/pip-11-deterministic-finality-via-milestones/11918/) | Last Call | Core | 2023-09-25 |
---
pip: 11
title: Deterministic finality via Milestones
description: Proposal to introduce Milestones in Polygon PoS to have deterministic finality
author: Vaibhav Jindal (@VAIBHAVJINDAL3012), Arpit Temani (@temaniarpit27), Evgeniy Danilenko (@JekaMas), Manav Darji (@manav2401), Sandeep Sreenath (@ssandeep)
discussion: https://forum.polygon.technology/t/pip-11-deterministic-finality-via-milestones/11918/
status: Last Call
type: Core
date: 2023-09-25
---

## Table of contents
Expand Down
14 changes: 10 additions & 4 deletions PIPs/PIP-12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 12 | Time Based StateSync Confirmations Delay | Fix to the statesync confirmations issue in bor | [Jerry Chen](https://github.com/cffls), [Pratik Patil](https://github.com/pratikspatil024), [Manav Darji](https://github.com/manav2401) | [Forum](https://forum.polygon.technology/t/pip-12-time-based-statesync-confirmations-delay/11950) | Final | Core | 2023-05-11
---
pip: 12
title: Time Based StateSync Confirmations Delay
description: Fix to the statesync confirmations issue in bor
author: Jerry Chen (@cffls), Pratik Patil (@pratikspatil024), Manav Darji (@manav2401)
discussion: https://forum.polygon.technology/t/pip-12-time-based-statesync-confirmations-delay/11950
status: Final
type: Core
date: 2023-05-11
---

### Abstract
### Abstract

[PIP-10](https://github.com/maticnetwork/Polygon-Improvement-Proposals/blob/main/PIPs/PIP-10.md) outlined a state sync bug that can arise when network partitions (reorg) have lengths > `sprintLength` (16 blocks). In summary, the issue occurs when the two chains eventually merge, as the current value of `to` (which is used to fetch the state sync events) is based on `sprintLength`. Block production will occur at different times on each fork, meaning nodes on the incoming chain may have a different number of state sync transactions.

Expand Down
12 changes: 9 additions & 3 deletions PIPs/PIP-13.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 13 | Indore Hard Fork | Proposes the Indore Hardfork | [Pratik Patil](https://github.com/pratikspatil024), [Sandeep Sreenath](https://github.com/ssandeep) | [Forum](https://forum.polygon.technology/t/indore-hard-fork/12272) | Final | Core | 2023-06-27
---
pip: 13
title: Indore Hard Fork
description: Proposes the Indore Hardfork
author: Pratik Patil (@pratikspatil024), Sandeep Sreenath (@ssandeep)
discussion: https://forum.polygon.technology/t/indore-hard-fork/12272
status: Final
type: Core
date: 2023-06-27
---

### Abstract
Expand Down
13 changes: 10 additions & 3 deletions PIPs/PIP-14.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 14 | Checkpoint Buffer Time | Increase in Checkpoint Buffer Time | [Vaibhav Jindal](https://github.com/VAIBHAVJINDAL3012), [Sandeep Sreenath](https://github.com/ssandeep) | [Forum](https://forum.polygon.technology/t/pip-14-increase-checkpoint-buffer-time/12369) | Final | Core | 2023-07-13
---
pip: 14
title: Checkpoint Buffer Time
description: Increase in Checkpoint Buffer Time
author: Vaibhav Jindal (@VAIBHAVJINDAL3012), Sandeep Sreenath (@ssandeep)
discussion: https://forum.polygon.technology/t/pip-14-increase-checkpoint-buffer-time/12369
status: Final
type: Core
date: 2023-07-13
---

### Abstract
This proposal describes a change to the value of the ‘Checkpoint Buffer Time’ in Heimdall, from 1000 seconds to 1500 seconds.
Expand Down
14 changes: 10 additions & 4 deletions PIPs/PIP-15.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
| PIP | Title | Description | Author | Discussion | Status | Type | Date |
|-------------------|---------------------------------|----------------------|-------------------------------|------------|--------|------------------------------------------|-----------------------|
| 15 | Adding support for EIP-4337 Bundled Transactions | Proposes and Implements an additional API to support Bundled Transactions | [Pratik Patil](https://github.com/pratikspatil024) | [Forum](https://forum.polygon.technology/t/pip-adding-support-for-eip-4337-bundled-transactions/12679) | Final | Interface | 2023-08-2
---
pip: 15
title: Adding support for EIP-4337 Bundled Transactions
description: Proposes and Implements an additional API to support Bundled Transactions
author: Pratik Patil (@pratikspatil024)
discussion: https://forum.polygon.technology/t/pip-adding-support-for-eip-4337-bundled-transactions/12679
status: Final
type: Interface
date: 2023-08-02
---

### Abstract
Expand Down Expand Up @@ -98,4 +104,4 @@ This PIP has no effect on the consensus rules of the network and aims to add one

### Copyright

All copyrights and related rights in this work are waived under [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
All copyrights and related rights in this work are waived under [CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
Loading