rollkit / cosmos-sdk-old

Rollkit-enabled fork of cosmos-sdk.

Rollkit

Rollkit is the first soveriegn rollup framework. For more in-depth information about Rollkit, please visit our website.

Using Rollkit

Rollkit CLI

The easiest way to use rollkit is via the rollkit CLI.

Requires Go version >= 1.22.

A cli tool that allows you to run different kinds of nodes for a rollkit network while also helping you generate the required configuration files

Install

To install rollkit, simply run the following command at the root of the rollkit repo

make install

The latest Rollkit is now installed. You can verify the installation by running:

rollkit version

Quick Start

You can spin up a local rollkit network with the following command:

rollkit start

Explore the CLI documentation here

Building with Rollkit

Rollkit is the first sovereign rollup framework that allows you to launch a sovereign, customizable blockchain as easily as a smart contract.

Check out our tutorials on our website.

Contributing

We welcome your contributions! Everyone is welcome to contribute, whether it's in the form of code, documentation, bug reports, feature requests, or anything else.

If you're looking for issues to work on, try looking at the good first issue list. Issues with this tag are suitable for a new external contributor and is a great way to find something you can help with!

See the contributing guide for more details.

Please join our Community Discord to ask questions, discuss your ideas, and connect with other contributors.

Helpful commands

# Run unit tests
make test

# Generate protobuf files (requires Docker)
make proto-gen

# Run linters (requires golangci-lint, markdownlint, hadolint, and yamllint)
make lint

# Lint protobuf files (requires Docker and buf)
make proto-lint

Tools

1. Install golangci-lint
2. Install markdownlint
3. Install hadolint
4. Install yamllint

Dependency graph

To see our progress and a possible future of Rollkit visit our Dependency Graph.

Audits

Date	Auditor	Version	Report
2024/01/12	Informal Systems	eccdd...bcb9d	informal-systems.pdf
2024/01/10	Binary Builders	eccdd...bcb9d	binary-builders.pdf

cosmos-sdk-old's Issues

Prepare v0.46.x branch with Rollkit

Set rollmint version information using ldflags

Currently there is no rollmint version information embedded in binary. This can be very useful.

1. Version should be logged during app startup.
2. Exact version should be returned from Status method.

Rebase fraud proof prototype to latest cosmos-sdk changes

Depends on #13

Prepare v0.45.x branch with Rollkit

Upgrade default branch to cosmos-sdk version that uses cosmos-db

Add invalid app hash and an existence proof for it in Fraud Proof

Move tracing to IAVL tree substore for Fraud Proof implementation

We'd like to modify the witness data in the FraudProof struct to use witness data generated by the IAVL tree substore in rollkit/iavl#19

This enables us to use the IAVL tree substore entirely for tracing and during verification of fraud proofs, we can load this witness data into a Deep Subtree so that it performs the same underlying tree operations for a fraudulent transaction.

Relevant changes to accommodate this design change should be made in ABCI methods GenerateFraudProof and VerifyFraudProof (and methods used by them).

We should also delete any new tracing related things we added to tracekv and rootmulti store on the cosmos-sdk level since all the tracing happens in the underlying IAVL tree substore now.

Changes needed for Fraud Proof Demo

For an end to end Fraud Proof Demo with a fraudulent cosmos-sdk app on a live network, the following changes are needed:

• Clearing interblock cache when reverting app to previous state
• Resetting deliverState to nil
• Setting AnteHandler to nil to skip checks preventing replay attacks since we need to replay the transaction in this case
• Adding beginBlocker, endBlocker of underlying app to new baseapp setup in VerifyFraudProof
• Write changes written to cache during the beginBlocker in BeginBlock back to the underlying store
• Accommodate non-IAVL stores by setting tracing enabled and extracting witnesses only for IAVL stores.
• Remove GetVersionedWithProof based on rollkit/iavl#25

Fraud Proof Verification using IAVL Deep Subtrees

Covers the third level of Fraud Proof Verification which includes setting up a BaseApp from a Fraud Proof using IAVL Deep Subtrees.

Relevant epic: rollkit/iavl#1

Add more unit and integration tests for State Fraud Proofs

Some suggestions for tests to add to baseapp_test.go in cosmos-sdk-rollmint:

1. Block with bad txs: Txs that exceed gas limits, validateBasic fails, unregistered messages (see TestRunInvalidTransaction)
2. Block with invalid appHash at the end
3. Corrupted Fraud Proof: bad underlying store format, insufficient key-value pairs inside the underlying store
   needed to verify fraud
4. Bad block, fraud proof needed, fraud proof works, chain halts (happy case)

Add expected valid app hash to Fraud Proof

We'd like to add the expected valid app hash in Fraud Proof struct so that during verification, a light client knows what is the valid app hash that it should expect.

Use Node.GetClient to create RPC client

Fraud Proof generation and partial verification using IAVL store

Cover Fraud Proof Generation and the first two levels of verification.

Possibly consolidate code across PRs from celestiaorg#245 while replacing the usage of the SMT store with the IAVL store.

The third level of verification needs the functionality to set up a BaseApp from a Fraud Proof. This requires the ability to create IAVL Deep Subtree. We can add placeholders for these IAVL Deep Subtrees which can be added once rollkit/iavl#1 is wrapped up.

Security patch for v0.46.13 and v0.47.3

https://forum.cosmos.network/t/cosmos-sdk-security-advisory-barberry/10825

https://github.com/cosmos/cosmos-sdk/releases/tag/v0.46.13

https://github.com/cosmos/cosmos-sdk/releases/tag/v0.47.3