Skip to content

Add Symbiotic Templates documentation#137

Open
dylankilkenny wants to merge 2 commits into
mainfrom
docs/add-symbiotic-templates
Open

Add Symbiotic Templates documentation#137
dylankilkenny wants to merge 2 commits into
mainfrom
docs/add-symbiotic-templates

Conversation

@dylankilkenny
Copy link
Copy Markdown
Member

@dylankilkenny dylankilkenny commented Mar 31, 2026

Summary

  • Add documentation for the Symbiotic templates
  • Per-provider pages: LayerZero DVN (layerzero.mdx) and Chainlink CCV (chainlink-ccv.mdx)
  • Shared docs: architecture, setup, CLI/API reference, deployment, security, troubleshooting
  • Navigation entry added under "Open Source Tools" in ethereum-evm sidebar

All pages live at /symbiotic/*

Source repo PR: OpenZeppelin/openzeppelin-symbiotic-templates#75

Add per-provider docs (LayerZero DVN, Chainlink CCV) and shared docs
(architecture, setup, CLI, deployment, security, troubleshooting) for
the Symbiotic cross-chain verification templates. Includes navigation
entry under Open Source Tools in ethereum-evm sidebar.

Signed-off-by: Dylan Kilkenny <dylankilkenny95@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 31, 2026

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 9ce7036
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/69cbf212f04be90008d0d321
😎 Deploy Preview https://deploy-preview-137--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread content/symbiotic/layerzero.mdx Outdated
- `contracts/src/symbiotic/KeyRegistry.sol` -- Operator BLS public key registry
- `contracts/src/symbiotic/VotingPowers.sol` -- Operator voting power tracking
- `contracts/src/symbiotic/Driver.sol` -- Epoch and genesis management
- `contracts/src/examples/TestOApp.sol` -- Test application for sending/receiving messages
Copy link
Copy Markdown
Collaborator

@tirumerla tirumerla May 15, 2026

Choose a reason for hiding this comment

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

ExampleOApp.sol? not seeing TestOApp.sol

Copy link
Copy Markdown
Collaborator

@tirumerla tirumerla left a comment

Choose a reason for hiding this comment

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

few suggestions, otherwise lgtm. This needs a dummy commit to trigger the deployment again

Comment thread content/symbiotic/layerzero.mdx Outdated
make e2e
```

`make send` sends through `TestOApp.send(...)` which calls `SendUln302`, triggering `DVN.assignJob()`.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Same here, ExampleOApp.send(...)

Comment thread content/symbiotic/deployment.mdx Outdated
-------------------- -------------------
LZ V2 Endpoint (pre-deployed) LZ V2 Endpoint (pre-deployed)
DVN.assignJob() DVN.submitProof() -> Settlement
TestOApp.send() TestOApp.lzReceive()
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
TestOApp.send() TestOApp.lzReceive()
ExampleOApp.send() ExampleOApp.lzReceive()

Comment thread content/symbiotic/setup.mdx Outdated
```bash
make shell
# Then use jq to extract addresses:
jq '.source.layerzero.dvn' $DEPLOYMENTS_FILE
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
jq '.source.layerzero.dvn' $DEPLOYMENTS_FILE
jq '.source.dvn' $DEPLOYMENTS_FILE

Sync content/symbiotic/* with the source template repo's audited docs
(openzeppelin-symbiotic-templates#132): chainlink_ccv testnet is now
Supported, testnet keystore commands use --env, corrected keystore paths
and CCIP selector config, JobAssigned emitter, and the Provider trait
snippet. Adds the Acceptance Hooks page plus its sidebar nav entry.

Signed-off-by: Dylan Kilkenny <dylankilkenny95@gmail.com>
@dylankilkenny dylankilkenny requested review from a team and stevep0z as code owners June 2, 2026 13:40
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 2, 2026

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 95fdab3
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6a1edd5270733c000811c288
😎 Deploy Preview https://deploy-preview-137--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants