Skip to content

Conversation

@St0rmBr3w
Copy link
Contributor

  • WORKFLOW.md: Add note clarifying lz:oft:send is a custom task defined in examples/oft/tasks/, not a core SDK task
  • native-oft-adapter README: Replace confusing mint instructions with accurate note about native token usage (no minting required)

- WORKFLOW.md: Add note clarifying lz:oft:send is a custom task defined
  in examples/oft/tasks/, not a core SDK task
- native-oft-adapter README: Replace confusing mint instructions with
  accurate note about native token usage (no minting required)
@cursor
Copy link

cursor bot commented Jan 20, 2026

PR Summary

Introduces clear deployment guidance and fixes confusing example docs.

  • Add WORKFLOW.md outlining transaction model, pathway wiring (~8 tx/path), Hardhat task orchestration, layerzero.config.ts structure, lifecycle states, and common workflows (fresh deploy, adding a chain, updating config)
  • Clarify example tasks: note that lz:oft:send is an example-specific custom task, not part of the core SDK
  • Update examples/native-oft-adapter/README.md: replace minting guidance with a note that the adapter uses native tokens on the source chain—no initial mint required

Written by Cursor Bugbot for commit 1870046. Configure here.

…xamples

- Add root-level CLAUDE.md, DEBUGGING.md, CHEATSHEET.md guides
- Add CLAUDE.md files for all examples explaining their purpose and usage
- Add AGENTS.md files for key packages with CI/automation guidance
- Update AGENTS.md, README.md with improved documentation
- Add changesets for version tracking
@github-actions
Copy link
Contributor

github-actions bot commented Jan 20, 2026

🧪 E2E Test Status

E2E tests are non-blocking and validate real blockchain interactions. Failures may occur due to network issues, RPC rate limits, or external service downtime.

Test Runs (Newest First):

  • Run #6579 - Passed - 2026-01-20 00:25 (UTC)
  • Run #6578 - Passed - 2026-01-20 00:14 (UTC)

@St0rmBr3w
Copy link
Contributor Author

Code review

Found 5 issues:

  1. examples/oft-composer-library/CLAUDE.md references non-existent files - The Quick Start section instructs users to run commands like cp .env.example .env, pnpm compile, and npx hardhat lz:deploy, but the directory only contains CLAUDE.md, README.md, and node_modules. No contracts/, layerzero.config.ts, hardhat.config.ts, or .env.example exist. Users following this documentation will encounter immediate failures.

| `layerzero.config.ts` | Pathway configuration |
| `hardhat.config.ts` | Network definitions |
## Quick Start
```bash
cp .env.example .env
pnpm install && pnpm compile
npx hardhat lz:deploy
npx hardhat lz:oapp:wire --oapp-config layerzero.config.ts
```
## What Makes This Example Different
- **Compose pattern**: Execute additional logic after OFT transfer
- Chain actions together (transfer → swap → stake)

  1. examples/oft-evm-solana-move/CLAUDE.md describes non-existent multi-VM structure - The CLAUDE.md claims contracts/ (EVM), programs/ (Solana), and sources/ (Move) directories exist, but the directory only contains artifacts/, node_modules, and documentation files. Commands like pnpm compile, anchor build, and aptos move compile will all fail.

| `programs/` | Solana programs (Rust/Anchor) |
| `sources/` | Move modules |
| `layerzero.config.ts` | Multi-VM pathway configuration |
## Prerequisites
- Node.js + pnpm (EVM)
- Rust + Anchor (Solana)
- Aptos CLI (Move)
## Quick Start
```bash
cp .env.example .env
# Build all platforms
pnpm compile # EVM
anchor build # Solana
aptos move compile # Move
```

  1. examples/oft-solana-composer-library/CLAUDE.md references non-existent Solana programs - The documentation describes programs/, Anchor.toml, and layerzero.config.ts that do not exist. The directory only contains build artifacts and node_modules. The anchor build command in Quick Start will fail.

| `Anchor.toml` | Anchor configuration |
| `layerzero.config.ts` | Pathway configuration |
## Prerequisites
- Rust toolchain
- Anchor CLI
- Solana CLI
## Quick Start
```bash
cp .env.example .env
anchor build
```

  1. examples/oft-tron/CLAUDE.md describes non-existent Tron implementation - The CLAUDE.md references contracts/ and layerzero.config.ts that do not exist. Unlike similar chain-specific examples (oft-initia, oft-hyperliquid) which have complete implementations, oft-tron is a placeholder without actual contracts.

| `layerzero.config.ts` | Pathway configuration |
| Configuration files | Tron-specific setup |
## Prerequisites
- TronBox or compatible tooling
- Tron wallet setup
## Quick Start
```bash
cp .env.example .env
pnpm install
# See README for Tron-specific deployment
```

  1. README.md removes beta warning without explanation - The previous README contained a warning that the repository is in beta state with potential backwards-incompatible changes. This warning was removed without any indication that the repository has graduated from beta or any replacement stability statement.

devtools/README.md

Lines 1 to 20 in d74d228

<p align="center">
<a href="https://layerzero.network#gh-dark-mode-only">
<img alt="LayerZero" style="width: 50%" src="assets/logo-dark.svg#gh-dark-mode-only"/>
</a>
<a href="https://layerzero.network#gh-light-mode-only">
<img alt="LayerZero" style="width: 50%" src="assets/logo-light.svg#gh-light-mode-only"/>
</a>
</p>
<p align="center">
<a href="https://layerzero.network" style="color: #a77dff">Homepage</a> | <a href="https://docs.layerzero.network/" style="color: #a77dff">Docs</a> | <a href="https://layerzero.network/developers" style="color: #a77dff">Developers</a>
</p>
<h1 align="center">LayerZero Developer Utilities</h1>
<p align="center">
<a href="/WORKFLOW.md" style="color: #a77dff">Workflow Guide</a> | <a href="/DEBUGGING.md" style="color: #a77dff">Debugging</a> | <a href="/CHEATSHEET.md" style="color: #a77dff">Cheatsheet</a> | <a href="/examples" style="color: #a77dff">Examples</a>
</p>
---


Recommendation: For issues 1-4, either add a clear notice that these are placeholder/scaffold examples (not runnable implementations), or remove the CLAUDE.md files until the examples are implemented. For issue 5, consider restoring the beta warning or adding a clear statement about the repository's stability status.

Generated with Claude Code

- If this code review was useful, please react with 👍. Otherwise, react with 👎.

…warning

- Remove CLAUDE.md files for examples that only exist locally:
  - examples/frontend/
  - examples/oft-composer-library/
  - examples/oft-evm-solana-move/
  - examples/oft-solana-composer-library/
  - examples/oft-tron/
- Restore beta warning in README.md
- Restore original navigation links (DEVELOPMENT.md)
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.

1 participant