Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
label: Version Information
description: Please provide versions of all relevant components
placeholder: |
Rollkit:
ev-node:
Execution Implementation:
validations:
required: true
Expand Down Expand Up @@ -112,7 +112,7 @@ body:
description: |
Please provide relevant logs from different components:
- Node logs
- Rollkit logs
- Ev-node logs
- DA logs
- Sequencer logs
- Execution logs
Expand Down
28 changes: 28 additions & 0 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Build VitePress Site
permissions:
contents: read

on:
push:
branches: [main]
paths:
- "./docs"
pull_request:
paths:
- "./docs"

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn # or pnpm / npm
- name: Install dependencies
run: yarn install # or pnpm install / npm ci
- name: Build with VitePress
run: yarn build # or pnpm build / npm build
51 changes: 51 additions & 0 deletions .github/workflows/deploy_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
# using the `master` branch as the default branch.
push:
branches: [main]
paths:
- "./docs"

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions: write-all

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn # or pnpm / npm
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: yarn install # or pnpm install / npm ci
- name: Build with VitePress
run: yarn build # or pnpm build / npm build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Deploy VitePress site to Pages' step
Uses Step
uses 'peaceiris/actions-gh-pages' with ref 'v4', not a pinned commit hash
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./.vitepress/dist
cname: ev.xyz
45 changes: 45 additions & 0 deletions .github/workflows/preview_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Deploy PR previews

on:
# This workflow requires pull_request and won't work with pull_request_target
# due to github permissions
pull_request:
types:
- opened
- reopened
- synchronize
- closed
paths:
- "./docs"

concurrency: preview-${{ github.ref }}

jobs:
deploy-preview:
if: github.actor != 'dependabot[bot]'
runs-on: ubuntu-latest
permissions: write-all
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: yarn

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Build with Base URL
run: BASE='/docs-preview/pr-${{ github.event.number }}/' yarn build

- name: Deploy preview
uses: rossjrw/pr-preview-action@v1

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Deploy PR previews' step
Uses Step
uses 'rossjrw/pr-preview-action' with ref 'v1', not a pinned commit hash
with:
source-dir: .vitepress/dist
deploy-repository: evstack/docs-preview
token: ${{ secrets.PREVIEW_DEPLOY }}
preview-branch: main
umbrella-dir: .
12 changes: 11 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,14 @@ build
.DS_Store
coverage.out
execution/evm/jwttoken
target
target

docs/.vitepress/dist
node_modules
docs/.vitepress/cache
*.log
*.tgz
.idea
.temp
.vite_opt_cache
.vscode
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Finding an issue

GitHub issues are used to track the work associated with Rollkit. That's where you can find things to work on.
GitHub issues are used to track the work associated with Evolve. That's where you can find things to work on.

Issue labels have been used to help designate the priority, status and beginner-friendliness of various issues. Here are some of the ones that are most relevant to finding a good issue to work on:

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ make proto-lint
| 2024/01/12 | [Informal Systems](https://informal.systems/) | [eccdd...bcb9d](https://github.com/evstack/ev-node/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [informal-systems.pdf](docs/audit/informal-systems.pdf) |
| 2024/01/10 | [Binary Builders](https://binary.builders/) | [eccdd...bcb9d](https://github.com/evstack/ev-node/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [binary-builders.pdf](docs/audit/binary-builders.pdf) |

[docs]: <https://rollkit.dev> <!-- todo rename once we have the domain-->
[docs]: <https://ev.xyz>
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document outlines the release process for all Go packages in the ev-node re

## Package Dependency Graph

```ascii
```txt
┌──────────┐
│ core │ (zero dependencies)
└────┬─────┘
Expand Down
6 changes: 3 additions & 3 deletions apps/evm/based/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rollkit EVM Based Sequencer
# Evolve EVM Based Sequencer

This directory contains the implementation of a based EVM sequencer using Rollkit.
This directory contains the implementation of a based EVM sequencer using Evolve.

## Prerequisites

Expand All @@ -12,7 +12,7 @@ This directory contains the implementation of a based EVM sequencer using Rollki

1. Both EVM and DA layers must be running before starting the aggregator
1. For the EVM layer, Reth can be conveniently run using `docker compose` from the go-execution-evm repository.
2. For the DA layer, local-da can be built and run from the `rollkit/da/cmd/local-da` directory.
2. For the DA layer, local-da can be built and run from the `ev-node/da/cmd/local-da` directory.

2. Build the sequencer:

Expand Down
8 changes: 4 additions & 4 deletions apps/evm/based/cmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import (
rollgenesis "github.com/evstack/ev-node/pkg/genesis"
)

// InitCmd initializes a new rollkit.yaml file in the current directory
// InitCmd initializes a new evolve.yaml file in the current directory
func InitCmd() *cobra.Command {
initCmd := &cobra.Command{
Use: "init",
Short: "Initialize rollkit config",
Short: "Initialize evolve config",
Long: fmt.Sprintf("This command initializes a new %s file in the specified directory (or current directory if not specified).", rollconf.ConfigName),
RunE: func(cmd *cobra.Command, args []string) error {
homePath, err := cmd.Flags().GetString(rollconf.FlagRootDir)
Expand Down Expand Up @@ -47,7 +47,7 @@ func InitCmd() *cobra.Command {
}

if err := cfg.SaveAsYaml(); err != nil {
return fmt.Errorf("error writing rollkit.yaml file: %w", err)
return fmt.Errorf("error writing evolve.yaml file: %w", err)
}

if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
Expand All @@ -57,7 +57,7 @@ func InitCmd() *cobra.Command {
// get chain ID or use default
chainID, _ := cmd.Flags().GetString(rollconf.FlagChainID)
if chainID == "" {
chainID = "rollkit-test"
chainID = "evolve-test"
}

// Initialize genesis without app state
Expand Down
2 changes: 1 addition & 1 deletion apps/evm/based/cmd/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func NewExtendedRunNodeCmd(ctx context.Context) *cobra.Command {

cmd := &cobra.Command{
Use: "start",
Short: "Run the rollkit node in based mode",
Short: "Run the evolve node in based mode",
PreRunE: func(cmd *cobra.Command, args []string) error {
var err error

Expand Down
2 changes: 1 addition & 1 deletion apps/evm/based/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const (

var RootCmd = &cobra.Command{
Use: AppName,
Short: "evm-based is a based evm execution environment for rollkit, out of the box it works with reth",
Short: "evm-based is a based evm execution environment for ev-node, out of the box it works with reth",
}

func main() {
Expand Down
6 changes: 3 additions & 3 deletions apps/evm/single/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rollkit EVM Single Sequencer
# Evolve EVM Single Sequencer

This directory contains the implementation of a single EVM sequencer using Rollkit.
This directory contains the implementation of a single EVM sequencer using Ev-node.

## Prerequisites

Expand All @@ -11,7 +11,7 @@ This directory contains the implementation of a single EVM sequencer using Rollk

1. Both EVM and DA layers must be running before starting the sequencer
1. For the EVM layer, Reth can be conveniently run using `docker compose` from <path_to>/execution/evm/docker.
2. For the DA layer, local-da can be built and run from the `rollkit/da/cmd/local-da` directory.
2. For the DA layer, local-da can be built and run from the `ev-node/da/cmd/local-da` directory.

2. Build the sequencer:

Expand Down
8 changes: 4 additions & 4 deletions apps/evm/single/cmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import (
rollgenesis "github.com/evstack/ev-node/pkg/genesis"
)

// InitCmd initializes a new rollkit.yaml file in the current directory
// InitCmd initializes a new evolve.yaml file in the current directory
func InitCmd() *cobra.Command {
initCmd := &cobra.Command{
Use: "init",
Short: "Initialize rollkit config",
Short: "Initialize evolve config",
Long: fmt.Sprintf("This command initializes a new %s file in the specified directory (or current directory if not specified).", rollconf.ConfigName),
RunE: func(cmd *cobra.Command, args []string) error {
homePath, err := cmd.Flags().GetString(rollconf.FlagRootDir)
Expand Down Expand Up @@ -47,7 +47,7 @@ func InitCmd() *cobra.Command {
}

if err := cfg.SaveAsYaml(); err != nil {
return fmt.Errorf("error writing rollkit.yaml file: %w", err)
return fmt.Errorf("error writing evolve.yaml file: %w", err)
}

if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
Expand All @@ -57,7 +57,7 @@ func InitCmd() *cobra.Command {
// get chain ID or use default
chainID, _ := cmd.Flags().GetString(rollconf.FlagChainID)
if chainID == "" {
chainID = "rollkit-test"
chainID = "evolve-test"
}

// Initialize genesis without app state
Expand Down
2 changes: 1 addition & 1 deletion apps/evm/single/cmd/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
var RunCmd = &cobra.Command{
Use: "start",
Aliases: []string{"node", "run"},
Short: "Run the rollkit node with EVM execution client",
Short: "Run the evolve node with EVM execution client",
RunE: func(cmd *cobra.Command, args []string) error {
executor, err := createExecutionClient(cmd)
if err != nil {
Expand Down
6 changes: 3 additions & 3 deletions apps/evm/single/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"github.com/spf13/cobra"

rollcmd "github.com/evstack/ev-node/pkg/cmd"
rollkitconfig "github.com/evstack/ev-node/pkg/config"
"github.com/evstack/ev-node/pkg/config"

"github.com/evstack/ev-node/apps/evm/single/cmd"
)
Expand All @@ -16,10 +16,10 @@ func main() {
// Initiate the root command
rootCmd := &cobra.Command{
Use: "evm-single",
Short: "Rollkit with EVM; single sequencer",
Short: "Evolve with EVM; single sequencer",
}

rollkitconfig.AddGlobalFlags(rootCmd, "evm-single")
config.AddGlobalFlags(rootCmd, "evm-single")

rootCmd.AddCommand(
cmd.InitCmd(),
Expand Down
18 changes: 9 additions & 9 deletions apps/grpc/single/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ FROM golang:1.24-alpine AS builder
RUN apk add --no-cache git make gcc musl-dev linux-headers

# Set working directory
WORKDIR /rollkit
WORKDIR /ev-node

# Copy go mod files
COPY go.mod go.sum ./
Expand All @@ -22,7 +22,7 @@ RUN go mod download
COPY . .

# Build the application
WORKDIR /rollkit/apps/grpc/single
WORKDIR /ev-node/apps/grpc/single
RUN go build -o grpc-single .

# Runtime stage
Expand All @@ -32,21 +32,21 @@ FROM alpine:3.19
RUN apk add --no-cache ca-certificates

# Create non-root user
RUN addgroup -g 1000 rollkit && \
adduser -u 1000 -G rollkit -s /bin/sh -D rollkit
RUN addgroup -g 1000 ev-node && \
adduser -u 1000 -G ev-node -s /bin/sh -D ev-node

# Set working directory
WORKDIR /home/rollkit
WORKDIR /home/ev-node

# Copy binary from builder
COPY --from=builder /rollkit/apps/grpc/single/grpc-single /usr/local/bin/
COPY --from=builder /ev-node/apps/grpc/single/grpc-single /usr/local/bin/

# Create necessary directories
RUN mkdir -p /home/rollkit/.grpc-single && \
chown -R rollkit:rollkit /home/rollkit
RUN mkdir -p /home/ev-node/.grpc-single && \
chown -R ev-node:ev-node /home/ev-node

# Switch to non-root user
USER rollkit
USER ev-node

# Expose ports
# P2P port
Expand Down
Loading
Loading