Skip to content

Comments

maint(ct): clean up L2StdTokenFac tests#2492

Merged
mergify[bot] merged 2 commits intodevelopfrom
sc/ct-test-cleanup-12
Apr 24, 2022
Merged

maint(ct): clean up L2StdTokenFac tests#2492
mergify[bot] merged 2 commits intodevelopfrom
sc/ct-test-cleanup-12

Conversation

@smartcontracts
Copy link
Contributor

Description
Cleans up the L2StandardTokenFactory tests using the same technique as
previous cleanup PRs.

Cleans up the L2StandardTokenFactory tests using the same technique as
previous cleanup PRs.
@changeset-bot
Copy link

changeset-bot bot commented Apr 22, 2022

⚠️ No Changeset found

Latest commit: 170aa1f

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@mergify
Copy link
Contributor

mergify bot commented Apr 24, 2022

This PR has been added to the merge queue, and will be merged soon.

@mergify
Copy link
Contributor

mergify bot commented Apr 24, 2022

This PR is next in line to be merged, and will be merged as soon as checks pass.

@mergify mergify bot merged commit b4dcfdf into develop Apr 24, 2022
@mergify mergify bot deleted the sc/ct-test-cleanup-12 branch April 24, 2022 12:38
nebojsa94 pushed a commit to Tenderly/optimism that referenced this pull request Apr 26, 2022
Cleans up the L2StandardTokenFactory tests using the same technique as
previous cleanup PRs.

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
@mslipper mslipper mentioned this pull request Apr 28, 2022
theochap pushed a commit that referenced this pull request Dec 10, 2025
…instructions (#2492)

## Summary

Completely rewrote the `bin/node/README.md` to provide comprehensive
documentation for the `kona-node` binary, addressing the need for clear
installation and usage instructions.

## Changes

### Before
The README was minimal (8 lines) with only a basic description:
```markdown
# `kona-node`

A binary that runs OP Stack consensus.

Subcommands include:
- gossip using [`kona-p2p`](https://crates.io/crates/kona-p2p)
- discovery using [`kona-p2p`](https://crates.io/crates/kona-p2p)
```

### After
Expanded to 149 lines of comprehensive documentation including:

- **Installation instructions** using `cargo install kona-node`
- **Complete usage examples** derived from the docker recipe
configuration
- **All available subcommands** with aliases (node, net, registry,
bootstore, info)
- **Working OP Sepolia configuration example**
- **Environment variable configuration** options
- **Help menu references** for all commands
- **Requirements section** listing prerequisites
- **Advanced configuration** reference

## Key Features Added

### 🛠️ Installation
```bash
cargo install kona-node
```

### 📖 Usage Examples
Complete command structure with real-world OP Sepolia example:
```bash
kona-node \
  --l2-chain-id 11155420 \
  --metrics.enabled \
  node \
  --l1 $L1_PROVIDER_RPC \
  --l1-beacon $L1_BEACON_API \
  --l2 http://localhost:8551 \
  --rpc.port 5060
```

### 🔧 Environment Variables
Documented all major configuration options:
- `KONA_NODE_L1_ETH_RPC`
- `KONA_NODE_L1_BEACON` 
- `KONA_NODE_L2_ENGINE_RPC`
- `RUST_LOG`

### 📚 Help References
Clear instructions to access help menus:
```bash
kona-node --help
kona-node node --help
```

## Implementation Notes

The documentation was created by analyzing:
- Docker recipe configuration in
`docker/recipes/kona-node/docker-compose.yaml`
- CLI source code in `bin/node/src/cli.rs` and command definitions
- Flag structures in `bin/node/src/flags/` for accurate parameter
documentation

This addresses the original request to "provide usage instructions by
installing the `kona-node` with `cargo install`" and uses "the docker
recipe for the `kona-node` to see how to run the `kona-node` binary with
the specified arguments" while mentioning "you can use the help menu."

<!-- START COPILOT CODING AGENT TIPS -->
---

💬 Share your feedback on Copilot coding agent for the chance to win a
$200 gift card! Click
[here](https://survey.alchemer.com/s3/8343779/Copilot-Coding-agent) to
start the survey.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: refcell <21288394+refcell@users.noreply.github.com>
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.

3 participants