Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Commit

Permalink
doc: deprecate
Browse files Browse the repository at this point in the history
  • Loading branch information
tuxcanfly committed Mar 27, 2024
1 parent 65c4668 commit 2d02e09
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# celestia-da

> :warning: **celestia-da is deprecated. See the [migration guide](./migration.md) for details.**
celestia-da is an implementation of the [Generic DA interface](https://github.com/rollkit/go-da)
for modular blockchains. It extends celestia-node and runs a gRPC service,
which can be used by rollup clients to read and write blob data to a specific
Expand Down
26 changes: 26 additions & 0 deletions migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### Migration

celestia-da after v0.13.2 release is deprecated and will no longer be
maintained.

Since go-da v0.5.0 now supports JSONRPC and celestia-node as of v0.13.0
implements the DA interface over JSONRPC, clients should migrate to using the
JSONRPC client instead.

A JSONRPC client requires the dial address and an auth token with a blob write
permission. It can be instantiated as follows:

```go
import (
"github.com/rollkit/go-da/proxy/jsonrpc"
)

// url = "http://localhost:26658"
// auth_token = $(celestia light auth write)

client, err := jsonrpc.NewClient(ctx, url, auth_token)
client.DA.MaxBlobSize()
// returns 1974272
```

See the [go-da releasenotes](https://github.com/rollkit/go-da/releases/tag/v0.5.0) for details.

0 comments on commit 2d02e09

Please sign in to comment.