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

Jump to bottom

docs: add Gateway contracts, link to corresponding doc pages #372

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: add Gateway contracts, link to corresponding doc pages #372

wants to merge 3 commits into from

Conversation

derrekcoleman
Copy link
Contributor

@derrekcoleman derrekcoleman commented Oct 4, 2024 •
edited
Loading

  • Add BOB Gateway contracts to Contracts page
  • Hyperlink relay and gateway words to corresponding docs (mainly so people don't think tBTC relay is tBTC token)
  • Rearrange sections to put gateway and relay on top, then BOB, then ethereum (same for testnet section). This makes the diff look crazier than it is
  • Add missing code format `` around address to the only section that didn't have it

Please take a quick peek at the Vercel preview to sanity check links, formatting 🙏

Closes #363

@derrekcoleman derrekcoleman added the documentation Improvements or additions to documentation label Oct 4, 2024
@derrekcoleman derrekcoleman self-assigned this Oct 4, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 4, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 35e817b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Oct 4, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 8, 2024 7:16pm

gregdhill
gregdhill reviewed Oct 8, 2024
View reviewed changes
docs/docs/build/contracts/index.md Outdated Show resolved Hide resolved
docs/docs/build/contracts/index.md
- L1StandardBridge: [0xEEAfA156A5dd3811Ee0D9F91db57A77eA53A8d31](https://etherscan.io/address/0xEEAfA156A5dd3811Ee0D9F91db57A77eA53A8d31)
- L1ERC721Bridge: [0xA67fc05D295d2Be6bC4cBfad4f880c1c58734212](https://etherscan.io/address/0xA67fc05D295d2Be6bC4cBfad4f880c1c58734212)
- [tBTC](/docs/build/bob-sdk/relay) Relay: [`0x9fe7ef727da3d79e0308ff43f31ea1d077ee9f41`](https://explorer.gobob.xyz/address/0x9fe7ef727da3d79e0308ff43f31ea1d077ee9f41)
- [Gateway](/docs/build/bob-sdk/gateway): [`0xcc2c1d45A3ECeEdec364a6B9e537AE97Fa20bEa7`](https://explorer.gobob.xyz/address/0xcc2c1d45A3ECeEdec364a6B9e537AE97Fa20bEa7)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure about linking this, this is only one of many

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great catch, @gregdhill. I should have checked whether it was an LP-specific address.

Which of these contracts, if any, should we add then?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gregdhill gregdhill gregdhill left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@derrekcoleman derrekcoleman

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add relay and gateway addresses to contracts page
2 participants
@derrekcoleman @gregdhill