{"id":19630979,"url":"https://github.com/catalogfi/merry","last_synced_at":"2025-04-28T06:32:35.509Z","repository":{"id":245153433,"uuid":"817295381","full_name":"catalogfi/merry","owner":"catalogfi","description":"Swiftly launch your own Multichain environment for testing, executing commands, and monitoring state while maintaining control over chain operations.","archived":false,"fork":false,"pushed_at":"2025-04-23T07:18:31.000Z","size":31802,"stargazers_count":11,"open_issues_count":1,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-23T08:25:15.952Z","etag":null,"topics":["anvil","bitcoin","catalog","ethereum","foundry"],"latest_commit_sha":null,"homepage":"https://merry.dev","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/catalogfi.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,"zenodo":null}},"created_at":"2024-06-19T12:12:48.000Z","updated_at":"2025-04-21T05:24:28.000Z","dependencies_parsed_at":"2024-06-20T05:37:23.736Z","dependency_job_id":"b5bd2ebd-8f60-48fa-b364-fed689eab2f1","html_url":"https://github.com/catalogfi/merry","commit_stats":null,"previous_names":["catalogfi/merry"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalogfi%2Fmerry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalogfi%2Fmerry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalogfi%2Fmerry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalogfi%2Fmerry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catalogfi","download_url":"https://codeload.github.com/catalogfi/merry/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251265411,"owners_count":21561675,"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":["anvil","bitcoin","catalog","ethereum","foundry"],"created_at":"2024-11-11T12:07:18.099Z","updated_at":"2025-04-28T06:32:35.213Z","avatar_url":"https://github.com/catalogfi.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub Release](https://img.shields.io/github/v/release/catalogfi/merry)\n\n\u003ch1\u003e \u003cimg height=\"36px\" src=\"./logo.png\"\u003e  \u003cspan\u003eMerry\u003c/span\u003e \u003c/h1\u003e\n\nStreamline your multi-chain testing with `Merry`!\n\nThis CLI tool leverages Docker to effortlessly set up a multi-chain testing environment in a single command. Merry includes Bitcoin regtest node, Ethereum localnet node, and essential [Catalog.fi](https://www.catalog.fi/) services, providing a self-contained space to test your applications independently of external services.\n\nIt supports various features, including a faucet, electrum services, and an orderbook with COBI.\n\n## Prerequisites\n\nBefore using Merry, please ensure you have Docker installed and running on your system. If not, download and install Docker from the official [website](https://www.docker.com).\n\n## Installation\n\nYou can install Merry using the following command.\n\n```bash\ncurl https://get.merry.dev | bash\n```\n\nMerry stores its configuration files and other data in a directory on your system, typically named `~/.merry/`.\n\nSee the [Install from scratch](#install-from-scratch) section to install Merry from scratch.\n\n## Commands\n\nMerry provides a variety of commands to manage your testing environment:\n\n### Starting Merry\n\n```bash\nmerry go\n```\n\nThis starts all services, including the Bitcoin regtest node, Ethereum localnet node, explorers for the nodes, and the Catalog services.\n\n- `--bare` flag: Starts only the multi-chain services (Bitcoin and Ethereum nodes with explorers) and excludes Catalog services. This option is helpful if you don't need the additional functionalities like COBI and Orderbook provided by Catalog.\n\n- `--headless` flag: Starts all services except for frontend interfaces. This can help run Merry in headless environments (e.g., servers) where a graphical user interface is not required.\n\n### Stopping Merry\n\n```bash\nmerry stop\n\n# Reset data\nmerry stop -d\n```\n\nStops all running services. Use `--delete` or `-d` to remove data.\n\n### Getting logs\n\n```bash\nmerry logs -s \u003cservice\u003e\n\n# Getting logs of EVM service\nmerry logs -s evm\n```\n\nReplace \u003cservice\u003e with the specific service (e.g., cobi, orderbook, evm) to view its logs.\n\n### Replacing a service with a local one\n\n```bash\nmerry replace \u003cservice\u003e\n```\n\nThis command allows you to replace a service with your local development version. Make sure you're in the directory containing the local service's Dockerfile. Supported services include COBI, Orderbook, and EVM.\n\n### Calling Bitcoin RPC methods\n\n```bash\nmerry rpc \u003cmethod\u003e \u003cparams\u003e\n\n# example: get blockchain info\nmerry rpc getblockchaininfo\n```\n\nInteract with the Bitcoin regtest node directly using RPC methods.\n\n### Updating Docker images\n\n```bash\nmerry update\n```\n\nKeep your testing environment up-to-date by updating all Docker images.\n\n### Fund accounts\n\n```bash\nmerry faucet \u003caddress\u003e\n```\n\nFund any EVM or Bitcoin address for testing purposes. Replace \u003caddress\u003e with the address you want to fund. It could be a Bitcoin or Ethereum address.\n\n### List all commands\n\n```bash\nmerry --help\n```\n\n## Testing with Merry\n\nOnce your environment is set up:\n\n- Connect to the Orderbook using its provided URL within your client application.\n- Leverage the built-in Bitcoin regtest and Ethereum testnet nodes to test your multi-chain functionalities.\n\nContributing\n\nWe welcome contributions to Merry! There are no special requirements needed. Fork the repository, make your changes, and submit a pull request.\n\nLet Merry simplify your multi-chain testing journey!\n\n## Install from scratch\n\n- Clone the repository\n\n```bash\ngit clone https://github.com/catalogfi/merry.git\n```\n\n- Building and installing\n\n```bash\ncd cmd/merry\n# build and install the binary\ngo install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalogfi%2Fmerry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatalogfi%2Fmerry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalogfi%2Fmerry/lists"}