-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding op-pip-1 and op-pip-2 and file reorg (#397)
* adding op-pip-1 and op-pip-2 and file reorg * improve compliance with the format guidelines * Improve compliance with format guidelines * minor updates * fix: format the docs --------- Co-authored-by: Ali Behjati <[email protected]>
- Loading branch information
1 parent
c9306f4
commit 4dd7b3f
Showing
19 changed files
with
96 additions
and
7 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# PIP-1 : Adoption of the Pyth DAO Constitution | ||
|
||
- Abstract: | ||
- This document ("PIP-1”) proposes the adoption of a decision framework for the Pyth DAO and the governing framework for the holders of $PYTH, the “Pyth DAO Constitution”, as formulated here: https://github.com/pyth-network/governance/blob/309c716599617971c6abb18f2097412d977b954f/docs/constitution/pyth-dao-constitution.md | ||
- Once the Pyth DAO Constitution adopted, the Pyth DAO will operate as outlined in the constitution. | ||
|
||
- Rationale: | ||
- The Pyth DAO should adopt a clear framework regarding its governance, operations, and processes. The framework should fully inform its members of how the DAO functions and how $PYTH token holders relate to the DAO. | ||
- Through PIP-1, the Pyth DAO will have the ability to submit subsequent Pyth Improvement Proposals (“**PIPs**”), collectively decide on them and implement them, and delegate certain responsibilities to elected councils. | ||
|
||
- Key Terms: | ||
|
||
PIP-1 proposes to adopt the Pyth DAO Constitution, a framework that: | ||
|
||
- sets rules and procedures on the submission and voting on PIPs | ||
- suggests the formation of two councils: the Pythian Council and the Price Feed Council which are respectively responsible for the voting and implementation of certain Operational PIPs as defined in the proposed constitution | ||
- lists a set of values and principles for the Pyth DAO community centered around ownership, governance, and inclusivity for the long-term benefit of the Pyth DAO | ||
|
||
- Implementation Plan: | ||
- Approval of PIP-1 | ||
|
||
- Timeline: | ||
- PIP-1 is subject to a 7-day on-chain voting period from the time of posting in the Pyth Forum |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Operational PIP: Upgrade Blast Contract (Pythian Council) | ||
|
||
## Abstract | ||
|
||
Upgrade the current Pyth oracle contract on Blast to be able to collect a share of the gas fees spent when updating a price on-chain. | ||
|
||
## Rationale | ||
|
||
Collect the revenue generated from usage of the oracle by downstream applications at no extra cost to users (paid out from the centralized sequencer revenue). | ||
|
||
## Description | ||
|
||
This proposal is to update the Pyth contract on Blast to enable gas fee claims (as part of sequencer revenue sharing). After we upgrade the contract to this version, we call the new added function which enables the gas fee claims (to the contract itself) and later we can add functionality to claim them. | ||
|
||
## Implementation Plan | ||
|
||
* Discuss [Proposal](http://xc-admin.xyz.pyth.network/?tab=proposals&proposal=9JFcL29kfJATziNqFSWgpPuTw82n3ZwiqM4DniFEs1su): `9JFcL29kfJATziNqFSWgpPuTw82n3ZwiqM4DniFEs1su` among the Pyth community | ||
|
||
* Implement the proposed [Code change](https://github.com/pyth-network/pyth-crosschain/compare/chore/evm/blast-claim-gas) in accordance with the Blast [docs](https://docs.blast.io/building/guides/gas-fees | ||
|
||
[Branch](https://github.com/pyth-network/pyth-crosschain/tree/chore/evm/blast-claim-gas): `chore/evm/blast-claim-gas` | ||
|
||
* Verify the implementation following the guide below: | ||
|
||
1. Make sure you node-js and forge installed. | ||
2. node-js: install `nvm` from [here](https://github.com/nvm-sh/nvm) | ||
3. forge: install it from [here](https://getfoundry.sh/) | ||
4. Clone pyth-crosschain repo and run the following command: `npm ci && npx lerna run build` | ||
5. Go to the proposal code branch | ||
6. Get the on-chain implementation code digest by going to the `contract_manager` directory and running this command: `npx ts-node scripts/check_proposal.ts --cluster mainnet-beta --proposal <proposal id>` | ||
7. Get the source code digest by going to the `target_chains/ethereum/contracts` and running `npx truffle compile --all && cat build/contracts/PythUpgradable.json | jq -r .deployedBytecode | tr -d '\n' | cast keccak` | ||
8. Match the of the on-chain digest with the source code digest. | ||
|
||
p.s: the codes above are not merged in our contract because these are one-off and cannot be in our generic smart-contract. We will store the diff in the repo like [this](https://github.com/pyth-network/pyth-crosschain/blob/main/target_chains/ethereum/contracts/canto-deployment-patch.diff) one. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Operational PIP: Upgrade Mode Contract (Pythian Council) | ||
|
||
## Abstract | ||
|
||
Upgrade the current Pyth oracle contract on Mode to be able to collect a share of the gas fees spent when updating a price on-chain. | ||
|
||
## Rationale | ||
|
||
Collect the revenue generated from usage of the oracle by downstream applications at no extra cost to users (paid out from the centralized sequencer revenue). | ||
|
||
## Description | ||
|
||
This proposal is to update the Pyth contract on Mode to enable gas fee claims (as part of sequencer revenue sharing of these protocols). After we upgrade the contract to this version, we call the new added function which enables the gas fee claims (to the contract itself) and later we can add functionality to claim them. | ||
|
||
## Implementation Plan | ||
|
||
* Discuss [Proposal](https://xc-admin.xyz.pyth.network/?tab=proposals&proposal=3GPW7Xed6N8Tfix21VqmywHJg5JDeK3nMJMD1gwmQvth : `3GPW7Xed6N8Tfix21VqmywHJg5JDeK3nMJMD1gwmQvth` among the Pyth community | ||
|
||
* Implement the proposed [Code change](https://github.com/pyth-network/pyth-crosschain/compare/chore/evm/mode-claim-gas) ([docs](https://docs.mode.network/build-on-mode/sfs-sequencer-fee-sharing/register-a-smart-contract/sfs-registering-a-contract-with-remix) for this change and gas sharing contract address) | ||
|
||
[branch](https://github.com/pyth-network/pyth-crosschain/tree/chore/evm/mode-claim-gas): `chore/evm/mode-claim-gas` | ||
|
||
* Verify the implementation following the guide below: | ||
|
||
1. Make sure you node-js and forge installed. | ||
2. node-js: install `nvm` from [here](https://github.com/nvm-sh/nvm) | ||
3. forge: install it from [here](https://getfoundry.sh/) | ||
4. Clone pyth-crosschain repo and run the following command: `npm ci && npx lerna run build` | ||
5. Go to the proposal code branch | ||
6. Get the on-chain implementation code digest by going to the `contract_manager` directory and running this command: `npx ts-node scripts/check_proposal.ts --cluster mainnet-beta --proposal <proposal id>` | ||
7. Get the source code digest by going to the `target_chains/ethereum/contracts` and running `npx truffle compile --all && cat build/contracts/PythUpgradable.json | jq -r .deployedBytecode | tr -d '\n' | cast keccak` | ||
8. Match the of the on-chain digest with the source code digest. | ||
|
||
p.s: the codes above are not merged in our contract because these are one-off and cannot be in our generic smart-contract. We will store the diff in the repo like [this](https://github.com/pyth-network/pyth-crosschain/blob/main/target_chains/ethereum/contracts/canto-deployment-patch.diff) one. |