-
Notifications
You must be signed in to change notification settings - Fork 168
Rewards Eligibility Oracle testing #1289
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.
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
Draft
RembrandtK
wants to merge
15
commits into
main
Choose a base branch
from
reo-testing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 10 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
20229de
feat(deployment): REO tasks, localNetwork support, and tooling improv…
RembrandtK 92d44da
docs: REO testing plans, guides, and rewards documentation
RembrandtK b5083bd
feat(issuance): add MockRewardsEligibilityOracle for testnet
RembrandtK c820c81
fix(rewards): reorder subtraction in _updateSubgraphRewards to avoid …
RembrandtK e0dc1de
chore: update arbitrumSepolia addresses after deployment
RembrandtK 69f291e
docs(deployment): add deployment tagging workflow to setup guide
RembrandtK c3d6f95
feat(deployment): add GRT token tasks (status, balance, transfer, mint)
RembrandtK 9f0b5f3
docs(testing): add network subgraph endpoint and allocation lifetime …
RembrandtK d4fcc55
docs(testing): use standard network subgraph for Arbitrum Sepolia
RembrandtK b9bdfbe
chore: release @graphprotocol/address-book v1.2.0
RembrandtK c5fdd54
fix: address PR review feedback
RembrandtK 110a487
fix(address-book): add missing issuance addresses symlink
RembrandtK 81616e3
fixup! fix(address-book): add missing issuance addresses symlink
RembrandtK ba3b3e3
docs(reo): extract network details to shared reference files
RembrandtK 29c6d3b
feat(reo): add indexer-status.sh script for network subgraph queries
RembrandtK File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or 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
This file contains hidden or 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,108 @@ | ||
| # Publishing @graphprotocol/address-book | ||
|
|
||
| Step-by-step guide for releasing a new version of the address-book package and deploying it to the network monitor. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - npm publish access for the `@graphprotocol` scope | ||
| - Write access to the [network-monitor](https://github.com/edgeandnode/network-monitor) repo | ||
| - Ability to trigger GitHub Actions workflows in both repos | ||
|
|
||
| ## Step 1: Update Address Files | ||
|
|
||
| Update the source address files in the contracts monorepo. These live in: | ||
|
|
||
| - `packages/horizon/addresses.json` | ||
| - `packages/subgraph-service/addresses.json` | ||
| - `packages/issuance/addresses.json` | ||
|
|
||
| The address-book package symlinks to these files during development, so changes here are automatically reflected locally. | ||
|
|
||
| ## Step 2: Create a Changeset | ||
|
|
||
| From the monorepo root: | ||
|
|
||
| ```bash | ||
| pnpm changeset | ||
| ``` | ||
|
|
||
| - Select `@graphprotocol/address-book` | ||
| - Choose the bump type (patch/minor/major) | ||
| - Describe what changed (e.g., "update arbitrumSepolia addresses after deployment") | ||
|
|
||
| ## Step 3: Version the Package | ||
|
|
||
| ```bash | ||
| pnpm changeset version | ||
| ``` | ||
|
|
||
| This consumes the changeset, bumps the version in `packages/address-book/package.json`, and updates `CHANGELOG.md`. | ||
|
|
||
| ## Step 4: Commit and Push | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -m "chore: release @graphprotocol/address-book vX.Y.Z" | ||
| git push | ||
| ``` | ||
|
|
||
| ## Step 5: Publish to npm | ||
|
|
||
| 1. Go to the contracts monorepo → Actions → "Publish package to NPM" | ||
| 2. Select `address-book` as the package | ||
| 3. Set tag to `latest` (or a pre-release tag) | ||
| 4. Run workflow | ||
|
|
||
| The workflow automatically: | ||
|
|
||
| - Publishes to npm (symlinks are converted to real files via `prepublishOnly`) | ||
| - Creates and pushes a git tag (`@graphprotocol/address-book@X.Y.Z`) | ||
|
|
||
| ## Step 6: Verify on npm | ||
|
|
||
| ```bash | ||
| npm view @graphprotocol/address-book version | ||
| ``` | ||
|
|
||
| Confirm the new version is live. | ||
|
|
||
| ## Step 7: Update the Network Monitor | ||
|
|
||
| In the [network-monitor](https://github.com/edgeandnode/network-monitor) repo: | ||
|
|
||
| 1. Update `package.json` to reference the new version: | ||
|
|
||
| ```json | ||
| "@graphprotocol/address-book": "X.Y.Z", | ||
| ``` | ||
|
|
||
| 2. Run `yarn` to update the lockfile | ||
| 3. Commit and push | ||
|
|
||
| The network monitor imports addresses from: | ||
|
|
||
| - `@graphprotocol/address-book/horizon/addresses.json` (in `src/env.ts`) | ||
| - `@graphprotocol/address-book/subgraph-service/addresses.json` (in `src/env.ts`, `src/tests/contracts.ts`) | ||
|
|
||
| ## Step 8: Deploy the Network Monitor | ||
|
|
||
| 1. Go to the network-monitor repo → Actions → "Deployment" | ||
| 2. Choose the target cluster: | ||
| - **`network`** → production (mainnet) | ||
| - **`testnet`** → testnet | ||
| 3. Run workflow | ||
|
|
||
| This builds a Docker image, pushes it to `ghcr.io/edgeandnode/network-monitor`, and restarts the StatefulSet on GKE. | ||
|
|
||
| ## Quick Reference | ||
|
|
||
| | Step | Action | Where | | ||
| | ---- | ------------------------------- | ----------------------------- | | ||
| | 1 | Update address files | contracts monorepo | | ||
| | 2 | `pnpm changeset` | contracts monorepo | | ||
| | 3 | `pnpm changeset version` | contracts monorepo | | ||
| | 4 | Commit + push | contracts monorepo | | ||
| | 5 | Publish to npm (auto-tags) | contracts monorepo GH Actions | | ||
| | 6 | Verify on npm | npmjs.com | | ||
| | 7 | Bump version in network-monitor | network-monitor repo | | ||
| | 8 | Deploy network monitor | network-monitor GH Actions | |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.