You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update README.md
* Update README.md
* Update README.md
* add docker examples
* add "daprovider" name to rpc server
* Add methods and response types for daclient api
* add fallback to das with daprovider
* update deps and fix fallback preimages
---------
Co-authored-by: Diego <31937514+Ferret-san@users.noreply.github.com>
Co-authored-by: Diego <diego@celestia.org>
Co-authored-by: chendechen <dechen.chen@debank.com>
@@ -23,6 +23,21 @@ A data availability server for the Arbitrum Nitro stack, leveraging Celestia DA
23
23
--celestia.rpc $CELESTIA_NODE_ENDPOINT
24
24
```
25
25
26
+
## Running Docker Image
27
+
28
+
```
29
+
docker run --name celestia-server \
30
+
-p 26657:26657 \
31
+
-e AUTH_TOKEN=your_token \
32
+
-e NAMESPACEID=your_namespace \
33
+
-e CELESTIA_NODE_ENDPOINT=your_node_endpoint \
34
+
ghcr.io/celestiaorg/nitro-das-celestia:v0.4.3
35
+
```
36
+
37
+
## Example Docker Compose
38
+
39
+
For an example on how to use the images in conjunction with other containers, check the [docker-compose.yaml](https://github.com/celestiaorg/nitro-das-celestia/blob/main/docker-compose.yaml) in this repository for an example
40
+
26
41
## Flags
27
42
28
43
```
@@ -61,6 +76,31 @@ Usage of daserver:
61
76
--rpc-server-timeouts.write-timeout duration the maximum duration before timing out writes of the response (http.Server.WriteTimeout) (default 30s)
62
77
```
63
78
79
+
## Running a da server for an Orbit x Celestia chain
80
+
81
+
Before proceeding, it is highly encouraged to familiarize yourself with [Celestia](https://docs.celestia.org/) and more specifically with [DA Nodes](https://docs.celestia.org/how-to-guides/light-node) (light, full, bridge)
82
+
83
+
## Running a Batch Poster
84
+
85
+
If you are running a celestia-sever for a batch poster node, you need to take the following into account:
86
+
87
+
- if you don't provide a `gas-price` and a `gas-multipler`, you will be automatically opting for gas estimation from your celestia-node
88
+
- you should run this on the same machine as your nitro batch poster node
89
+
- you WILL NOT be able to use a hosted provider for your celestia-node endpoint. You will have to run your own celestia-node in order to post data to Celestia
90
+
- you can get the `auth token` for your node like [this](https://docs.celestia.org/how-to-guides/quick-start#get-your-auth-token)
91
+
- you will need to pick a [namespace](https://docs.celestia.org/tutorials/node-tutorial#namespaces) were to write data to and make sure to use this in other nodes and share with node runners.
92
+
93
+
## Running a Full Node
94
+
95
+
If you are running a celestia-server as part of a full node setup for an orbit x celestia da chain, note the folloing:
96
+
97
+
- you don't need to provide a `gas-price` or a `gas-multiplier`, since the node won't be submitting data to celestia
98
+
- you should run this on the same machine as your nitro full node or block the `store` endpoint if you are not running a batch poster
99
+
- you only need a namespace to use when fetching data from Celestia (the rollup should make this clear and accesible to you), and a celestia-node endpoint (core / consensus endpoints won't work!). If you do not wish to run your own celestia light node, or da bridge node, you can get a hosted endpoint from providers like:
> The celestia server binary won't throw an error if you forget to set the validator config, if you are running validators for your chain, please read carefully
0 commit comments