├── .gitignore ├── NOTICE ├── .github ├── dependabot.yml └── workflows │ └── docker-build-publish.yml ├── Dockerfile ├── entrypoint.sh ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | Local Celestia Devnet 2 | Copyright 2023 and onwards Strange Loop Labs AG 3 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | - package-ecosystem: docker 8 | directory: "/" 9 | schedule: 10 | interval: daily 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ghcr.io/celestiaorg/celestia-app:v1.7.0 AS celestia-app 2 | 3 | FROM ghcr.io/celestiaorg/celestia-node:v0.13.1 4 | 5 | USER root 6 | 7 | # hadolint ignore=DL3018 8 | RUN apk --no-cache add \ 9 | curl \ 10 | jq \ 11 | openssl \ 12 | && mkdir /bridge \ 13 | && chown celestia:celestia /bridge 14 | 15 | USER celestia 16 | 17 | COPY --from=celestia-app /bin/celestia-appd /bin/ 18 | 19 | COPY entrypoint.sh /opt/entrypoint.sh 20 | 21 | EXPOSE 26657 26658 26659 9090 22 | 23 | ENTRYPOINT [ "/bin/bash", "/opt/entrypoint.sh" ] 24 | -------------------------------------------------------------------------------- /.github/workflows/docker-build-publish.yml: -------------------------------------------------------------------------------- 1 | name: Docker Build & Publish 2 | 3 | # Trigger on all push events, new semantic version tags, and all PRs 4 | on: 5 | push: 6 | branches: 7 | - "**" 8 | tags: 9 | - "v[0-9]+.[0-9]+.[0-9]+" 10 | - "v[0-9]+.[0-9]+.[0-9]+-alpha.[0-9]+" 11 | - "v[0-9]+.[0-9]+.[0-9]+-beta.[0-9]+" 12 | - "v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+" 13 | pull_request: 14 | 15 | jobs: 16 | docker-security-build: 17 | permissions: 18 | contents: write 19 | packages: write 20 | uses: rollkit/.github/.github/workflows/reusable_dockerfile_pipeline.yml@v0.3.0 # yamllint disable-line rule:line-length 21 | with: 22 | dockerfile: Dockerfile 23 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | CHAINID="test" 4 | 5 | # App & node has a celestia user with home dir /home/celestia 6 | APP_PATH="/home/celestia/.celestia-app" 7 | NODE_PATH="/home/celestia/bridge/" 8 | 9 | # Check if the folder exists 10 | if [ -d "$APP_PATH" ]; then 11 | # If it exists, delete it 12 | echo "The folder $APP_PATH exists. Deleting it..." 13 | rm -rf "$APP_PATH" 14 | echo "Folder deleted." 15 | else 16 | # If it doesn't exist, print a message 17 | echo "The folder $APP_PATH does not exist." 18 | fi 19 | 20 | # Build genesis file incl account for passed address 21 | coins="1000000000000000utia" 22 | celestia-appd init $CHAINID --chain-id $CHAINID 23 | celestia-appd keys add validator --keyring-backend="test" 24 | # this won't work because some proto types are declared twice and the logs output to stdout (dependency hell involving iavl) 25 | celestia-appd add-genesis-account $(celestia-appd keys show validator -a --keyring-backend="test") $coins 26 | celestia-appd gentx validator 5000000000utia \ 27 | --keyring-backend="test" \ 28 | --chain-id $CHAINID 29 | 30 | celestia-appd collect-gentxs 31 | 32 | # Set proper defaults and change ports 33 | # If you encounter: `sed: -I or -i may not be used with stdin` on MacOS you can mitigate by installing gnu-sed 34 | # https://gist.github.com/andre3k1/e3a1a7133fded5de5a9ee99c87c6fa0d?permalink_comment_id=3082272#gistcomment-3082272 35 | sed -i'.bak' 's#"tcp://127.0.0.1:26657"#"tcp://0.0.0.0:26657"#g' ~/.celestia-app/config/config.toml 36 | sed -i'.bak' 's/^timeout_commit\s*=.*/timeout_commit = "2s"/g' ~/.celestia-app/config/config.toml 37 | sed -i'.bak' 's/^timeout_propose\s*=.*/timeout_propose = "2s"/g' ~/.celestia-app/config/config.toml 38 | 39 | mkdir -p $NODE_PATH/keys 40 | cp -r $APP_PATH/keyring-test/ $NODE_PATH/keys/keyring-test/ 41 | 42 | # Start the celestia-app 43 | celestia-appd start --grpc.enable & 44 | 45 | # Try to get the genesis hash. Usually first request returns an empty string (port is not open, curl fails), later attempts 46 | # returns "null" if block was not yet produced. 47 | GENESIS= 48 | CNT=0 49 | MAX=30 50 | while [ "${#GENESIS}" -le 4 -a $CNT -ne $MAX ]; do 51 | GENESIS=$(curl -s http://127.0.0.1:26657/block?height=1 | jq '.result.block_id.hash' | tr -d '"') 52 | ((CNT++)) 53 | sleep 1 54 | done 55 | 56 | export CELESTIA_CUSTOM=test:$GENESIS 57 | echo "$CELESTIA_CUSTOM" 58 | 59 | celestia bridge init --node.store /home/celestia/bridge 60 | celestia bridge start \ 61 | --node.store $NODE_PATH --gateway \ 62 | --core.ip 127.0.0.1 \ 63 | --keyring.accname validator \ 64 | --gateway.addr 0.0.0.0 \ 65 | --rpc.addr 0.0.0.0 \ 66 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Local Celestia Devnet 2 | 3 | This repo provides a Docker image that allows developers to spin up a local 4 | Celestia devnet composed of: 5 | 6 | - 1 x celestia-app validator node 7 | - 1 x celestia-node bridge node 8 | 9 | For information about the different node types, see 10 | [here](https://docs.celestia.org/nodes/overview/). 11 | 12 | ## To run the Docker image from ghcr.io 13 | 14 | ```bash 15 | docker run -t -i \ 16 | -p 26650:26650 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ 17 | ghcr.io/rollkit/local-celestia-devnet:latest 18 | ``` 19 | 20 | ## To build and run the Docker image 21 | 22 | First, clone the repository: 23 | 24 | ```bash 25 | git clone https://github.com/rollkit/local-celestia-devnet.git 26 | ``` 27 | 28 | Change into the directory: 29 | 30 | ```bash 31 | cd local-celestia-devnet/ 32 | ``` 33 | 34 | To build the Docker image: 35 | 36 | ```bash 37 | docker build . -t celestia-local-devnet 38 | ``` 39 | 40 | To run the Docker container: 41 | 42 | ```bash 43 | docker run -t -i \ 44 | -p 26650:26650 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ 45 | celestia-local-devnet 46 | ``` 47 | 48 | Test that the HTTP gateway server is up: 49 | 50 | ```bash 51 | curl -X GET http://127.0.0.1:26659/head 52 | ``` 53 | 54 | ## Running a Detached Container 55 | 56 | If you would like the run the container in the background, you can use the 57 | `-d` flag: 58 | 59 | ```bash 60 | docker run -d -t -i \ 61 | -p 26650:26650 -p 26657:26657 -p 26658:26658 -p 26659:26659 -p 9090:9090 \ 62 | celestia-local-devnet 63 | ``` 64 | 65 | ## Stopping the Container 66 | 67 | To stop the container when you are attached to the container, you can use 68 | `Ctrl+C` to stop the container. 69 | 70 | To stop the container when you are detached from the container, you can use the 71 | `docker ps` command to find the container ID: 72 | 73 | ```bash 74 | docker ps 75 | ``` 76 | 77 | Then, use the `docker stop` command to stop the container: 78 | 79 | ```bash 80 | docker stop 81 | ``` 82 | 83 | To remove the container, use the `docker rm` command to remove the container: 84 | 85 | ```bash 86 | docker rm 87 | ``` 88 | 89 | ## Exposed Ports 90 | 91 | | Port | Protocol | Address | Description | Node Type | 92 | |-------|----------|-----------|-------------|-----------------------------------------| 93 | | 26650 | gRPC | 127.0.0.1 | gRPC | Data Availability Service | 94 | | 26657 | HTTP | 127.0.0.1 | RPC | Consensus (e.g `celestia-app`) | 95 | | 26658 | HTTP | 127.0.0.1 | RPC | Data Availability (e.g `celestia-node`) | 96 | | 26659 | HTTP | 127.0.0.1 | REST | Data Availability (e.g `celestia-node`) | 97 | | 9090 | HTTP | 0.0.0.0 | gRPC | Consensus (e.g `celestia-app`) | 98 | 99 | ## Environment Variables 100 | 101 | | Variable | Description | Default | 102 | |------------------------|---------------------------------|--------------------| 103 | | CELESTIA_NAMESPACE | Namespace to use for DA Service | Randomly generated | 104 | 105 | You may also find these docs helpful: 106 | 107 | - [celestia-app ports](https://docs.celestia.org/nodes/celestia-app/#ports) 108 | - [celestia-node ports](https://docs.celestia.org/nodes/celestia-node-troubleshooting/#ports) 109 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------