{"id":19460109,"url":"https://github.com/offchainlabs/nitro-testnode","last_synced_at":"2025-04-06T22:11:00.752Z","repository":{"id":173181269,"uuid":"650348181","full_name":"OffchainLabs/nitro-testnode","owner":"OffchainLabs","description":"A complete environment for nitro-based service including sequencer, batch-poster, validator, and a coordinator.","archived":false,"fork":false,"pushed_at":"2024-10-29T09:30:05.000Z","size":564,"stargazers_count":23,"open_issues_count":11,"forks_count":56,"subscribers_count":23,"default_branch":"release","last_synced_at":"2024-10-29T10:57:19.727Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OffchainLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-06T22:05:37.000Z","updated_at":"2024-10-28T16:26:37.000Z","dependencies_parsed_at":"2023-11-20T17:29:45.845Z","dependency_job_id":"d0669a16-2bf6-4072-ae12-67975b73b1db","html_url":"https://github.com/OffchainLabs/nitro-testnode","commit_stats":null,"previous_names":["offchainlabs/nitro-testnode"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Fnitro-testnode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Fnitro-testnode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Fnitro-testnode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OffchainLabs%2Fnitro-testnode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OffchainLabs","download_url":"https://codeload.github.com/OffchainLabs/nitro-testnode/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247557767,"owners_count":20958047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T17:35:37.993Z","updated_at":"2025-04-06T22:11:00.734Z","avatar_url":"https://github.com/OffchainLabs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nitro Testnode\n\nNitro-testnode brings up a full environment for local nitro testing (with Stylus support) including a dev-mode geth L1, and multiple instances with different roles.\n\n### Requirements\n\n* bash shell\n* docker and docker-compose\n\nAll must be installed in PATH.\n\n## Using latest nitro release (recommended)\n\nCheck out the release branch of the repository.\n\n\u003e Notice: release branch may be force-pushed at any time.\n\n```bash\ngit clone -b release --recurse-submodules https://github.com/OffchainLabs/nitro-testnode.git\ncd nitro-testnode\n```\n\nInitialize the node\n\n```bash\n./test-node.bash --init\n```\nTo see more options, use `--help`.\n\n## Using current nitro code (local compilation)\n\nCheck out the nitro repository. Use the test-node submodule of nitro repository.\n\n\u003e Notice: testnode may not always be up-to-date with config options of current nitro node, and is not considered stable when operated in that way.\n\n```bash\ngit clone --recurse-submodules https://github.com/OffchainLabs/nitro.git\ncd nitro/nitro-testnode\n```\n\nInitialize the node in dev-mode (this will build the docker images from source)\n```bash\n./test-node.bash --init --dev\n```\nTo see more options, use `--help`.\n\n## Further information\n\n### Branch Selection Guide (for devs working *on* nitro-testnode)\n\nThis repository maintains two main branches with distinct purposes.\n\n#### `release` branch\n\nTarget branch for changes that should be immediately available to external users.\n\n**Examples of changes for `release`:**\n* Bug fixes for existing functionality\n* Documentation improvements\n* Updates to support newly released Nitro features\n* Configuration updates for published Nitro releases\n\n\u003e 💡 Changes here will later be merged into `master`\n\n#### `master` branch\n\nTarget branch for changes supporting unreleased Nitro features.\n\n**Examples of changes for `master`:**\n* Support for new configuration options being developed in Nitro\n* Integration tests for upcoming Nitro features\n* Breaking changes that depend on unreleased Nitro versions\n\n\u003e 💡 Changes here will be merged into `release` when the corresponding Nitro features are released\n\n#### Branch Flow\n\n##### For immediate public consumption\n1. Push to `release`\n2. Later merge into `master`\n\n##### For unreleased Nitro features\n1. Push to `master`\n2. Merge into `release` when the feature is released\n\n\n### Working with docker containers\n\n**sequencer** is the main docker to be used to access the nitro testchain. It's http and websocket interfaces are exposed at localhost ports 8547 and 8548 ports, respectively.\n\nStopping, restarting nodes can be done with docker-compose.\n\n### Helper scripts\n\nSome helper scripts are provided for simple testing of basic actions.\n\nTo fund the address 0x1111222233334444555566667777888899990000 on l2, use:\n\n```bash\n./test-node.bash script send-l2 --to address_0x1111222233334444555566667777888899990000\n```\n\nFor help and further scripts, see:\n\n```bash\n./test-node.bash script --help\n```\n\n## Named accounts\n\n```bash\n./test-node.bash script print-address --account sequencer\n```\n```\nsequencer:                  0xe2148eE53c0755215Df69b2616E552154EdC584f\nvalidator:                  0x6A568afe0f82d34759347bb36F14A6bB171d2CBe\nl2owner:                    0x5E1497dD1f08C87b2d8FE23e9AAB6c1De833D927\nl3owner:                    0x863c904166E801527125D8672442D736194A3362\nl3sequencer:                0x3E6134aAD4C4d422FF2A4391Dc315c4DDf98D1a5\nuser_l1user:                0x058E6C774025ade66153C65672219191c72c7095\nuser_token_bridge_deployer: 0x3EaCb30f025630857aDffac9B2366F953eFE4F98\nuser_fee_token_deployer:    0x2AC5278D230f88B481bBE4A94751d7188ef48Ca2\n```\n\nWhile not a named account, 0x3f1eae7d46d88f08fc2f8ed27fcb2ab183eb2d0e is funded on all test chains.\n\n## Contact\n\nDiscord - [Arbitrum](https://discord.com/invite/5KE54JwyTs)\n\nTwitter: [Arbitrum](https://twitter.com/arbitrum)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffchainlabs%2Fnitro-testnode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffchainlabs%2Fnitro-testnode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffchainlabs%2Fnitro-testnode/lists"}