Skip to content

Commit

Permalink
rename to scroll-proving-agent
Browse files Browse the repository at this point in the history
  • Loading branch information
ErdongChen61 committed Oct 31, 2024
1 parent 7331649 commit 76cfb20
Show file tree
Hide file tree
Showing 18 changed files with 75 additions and 75 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ jobs:
context: .
file: docker/Dockerfile
push: true
tags: snarkify/snarkify-scroll-proving-agent:${{ github.ref_name }},snarkify/snarkify-scroll-proving-agent:latest
tags: snarkify/scroll-proving-agent:${{ github.ref_name }},snarkify/scroll-proving-agent:latest
6 changes: 3 additions & 3 deletions .github/workflows/publish-chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:

- name: Helm registry login
run: |
helm registry login ghcr.io/snarkify/snarkify-scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
helm registry login ghcr.io/snarkify/scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
env:
HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"

Expand Down Expand Up @@ -72,7 +72,7 @@ jobs:
- name: Helm registry login
run: |
helm registry login ghcr.io/snarkify/snarkify-scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
helm registry login ghcr.io/snarkify/scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
env:
HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"

Expand All @@ -97,5 +97,5 @@ jobs:
helm dependencies build charts/$chart
helm package charts/$chart
export CHART_VERSION=$(grep 'version:' charts/$chart/Chart.yaml | head -n1 | awk '{ print $2 }')
helm push $chart-${CHART_VERSION}.tgz oci://ghcr.io/snarkify/snarkify-scroll-proving-agent/helm
helm push $chart-${CHART_VERSION}.tgz oci://ghcr.io/snarkify/scroll-proving-agent/helm
done
6 changes: 3 additions & 3 deletions .github/workflows/publish-dev-chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- 'charts/**'

env:
HELM_REGISTRY: ghcr.io/snarkify/snarkify-scroll-proving-agent/helm/dev
HELM_REGISTRY: ghcr.io/snarkify/scroll-proving-agent/helm/dev

jobs:
helm-chart-testing-dev:
Expand Down Expand Up @@ -34,7 +34,7 @@ jobs:

- name: Helm registry login
run: |
helm registry login ghcr.io/snarkify/snarkify-scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
helm registry login ghcr.io/snarkify/scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
env:
HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"

Expand Down Expand Up @@ -74,7 +74,7 @@ jobs:
- name: Helm registry login
run: |
helm registry login ghcr.io/snarkify/snarkify-scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
helm registry login ghcr.io/snarkify/scroll-proving-agent/helm --username ${{ github.actor }} --password ${{ secrets.HELM_GITHUB_PASSWORD }}
env:
HELM_GITHUB_PASSWORD: "${{ secrets.HELM_GITHUB_PASSWORD }}"

Expand Down
76 changes: 38 additions & 38 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "snarkify-scroll-proving-agent"
name = "scroll-proving-agent"
version = "0.0.1"
edition = "2021"

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Snarkify Scroll Proving Agent
# Scroll Proving Agent

## Introduction

The Snarkify Scroll proving agent is a high-performance service client for efficient block proving for layer-2 rollups
The Scroll proving agent is a high-performance service client for efficient block proving for layer-2 rollups
based on the [Scroll SDK](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/). With this integration, Scroll SDK chains
gain access to robust GPU-proving capabilities, allowing for the fast and effective proving of blockspaces.

Expand All @@ -14,7 +14,7 @@ Mainnet proving jobs.

## How It Works

The Snarkify Scroll Proving agent integrates with the [Scroll Proving SDK](https://github.com/scroll-tech/scroll-proving-sdk)
The Scroll Proving agent integrates with the [Scroll Proving SDK](https://github.com/scroll-tech/scroll-proving-sdk)
to handle block proving in three main steps:

1. Task Retrieval: The agent connects to the coordinator endpoint to retrieve proving tasks and to the Geth endpoint
Expand Down Expand Up @@ -83,30 +83,30 @@ env:
- serviceId: Your Scroll Proving service ID in Snarkify platform.
### Deploy Snarkify Scroll Proving Agent
### Deploy Scroll Proving Agent
Deploy the agent using Helm with your configuration files.
```bash
export HELM_EXPERIMENTAL_OCI=1
helm install snarkify-scroll-proving-agent-chunk oci://ghcr.io/snarkify/snarkify-scroll-proving-agent/helm/snarkify-scroll-proving-agent --version 0.0.1 -f chunk-config.yaml
helm install scroll-proving-agent-chunk oci://ghcr.io/snarkify/scroll-proving-agent/helm/scroll-proving-agent --version 0.0.1 -f chunk-config.yaml

helm install snarkify-scroll-proving-agent-batch oci://ghcr.io/snarkify/snarkify-scroll-proving-agent/helm/snarkify-scroll-proving-agent --version 0.0.1 -f batch-config.yaml
helm install scroll-proving-agent-batch oci://ghcr.io/snarkify/scroll-proving-agent/helm/scroll-proving-agent --version 0.0.1 -f batch-config.yaml

helm install snarkify-scroll-proving-agent-bundle oci://ghcr.io/snarkify/snarkify-scroll-proving-agent/helm/snarkify-scroll-proving-agent --version 0.0.1 -f bundle-config.yaml
helm install scroll-proving-agent-bundle oci://ghcr.io/snarkify/scroll-proving-agent/helm/scroll-proving-agent --version 0.0.1 -f bundle-config.yaml
```

### Verify the Deployment
You can verify the deployment by checking the pods and the logs.
```bash
kubectl get pods
kubectl logs -l app.kubernetes.io/name=snarkify-scroll-proving-agent
kubectl logs -l app.kubernetes.io/name=scroll-proving-agent
```

### Uninstall the Helm Chart
```bash
helm uninstall snarkify-scroll-proving-agent-chunk
helm uninstall snarkify-scroll-proving-agent-batch
helm uninstall snarkify-scroll-proving-agent-bundle
helm uninstall scroll-proving-agent-chunk
helm uninstall scroll-proving-agent-batch
helm uninstall scroll-proving-agent-bundle
```

### Community
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
apiVersion: v2
description: A proving agent for Scroll SDK to generate proofs in Snarkify platform.
name: snarkify-scroll-proving-agent
name: scroll-proving-agent
version: 0.0.1
kubeVersion: ">=1.22.0-0"
maintainers:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# snarkify-scroll-proving-agent
# scroll-proving-agent

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

Expand All @@ -24,20 +24,20 @@ Kubernetes: `>=1.22.0-0`
|-----|------|---------|-------------|
| command[0] | string | `"/bin/sh"` | |
| command[1] | string | `"-c"` | |
| command[2] | string | `"exec snarkify-scroll-proving-agent --config /sdk_prover/config.json"` | |
| command[2] | string | `"exec scroll-proving-agent --config /sdk_prover/config.json"` | |
| defaultProbes.custom | bool | `true` | |
| defaultProbes.enabled | bool | `true` | |
| defaultProbes.spec.httpGet.path | string | `"/"` | |
| defaultProbes.spec.httpGet.port | int | `80` | |
| env.serviceId | string | `""` | |
| global.fullnameOverride | string | `"snarkify-scroll-proving-agent"` | |
| global.nameOverride | string | `"snarkify-scroll-proving-agent"` | |
| global.fullnameOverride | string | `"scroll-proving-agent"` | |
| global.nameOverride | string | `"scroll-proving-agent"` | |
| image.pullPolicy | string | `"Always"` | |
| image.repository | string | `"snarkify/snarkify-scroll-proving-agent"` | |
| image.repository | string | `"snarkify/scroll-proving-agent"` | |
| image.tag | string | `"v0.0.1"` | |
| persistence.config.enabled | bool | `true` | |
| persistence.config.mountPath | string | `"/sdk_prover/"` | |
| persistence.config.name | string | `"snarkify-scroll-proving-agent-config"` | |
| persistence.config.name | string | `"scroll-proving-agent-config"` | |
| persistence.config.type | string | `"configMap"` | |
| persistence.keys.accessMode | string | `"ReadWriteOnce"` | |
| persistence.keys.enabled | bool | `true` | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v1
entries:
common:
- apiVersion: v2
created: "2024-10-31T14:15:33.146672-07:00"
created: "2024-10-31T15:13:12.83655-07:00"
description: Function library for Helm charts
digest: 5a3fa66a5d8bcfc12029abed7a432a5275f44db7f0773d3b9f251497ad50d09c
keywords:
Expand All @@ -15,6 +15,6 @@ entries:
name: common
type: library
urls:
- ghcr.io/snarkify/snarkify-scroll-proving-agent/helm/snarkify-scroll-proving-agent/charts/common-1.5.1.tgz
- ghcr.io/snarkify/scroll-proving-agent/helm/scroll-proving-agent/charts/common-1.5.1.tgz
version: 1.5.1
generated: "2024-10-31T14:15:33.144904-07:00"
generated: "2024-10-31T15:13:12.833235-07:00"
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
global:
nameOverride: &app_name snarkify-scroll-proving-agent
nameOverride: &app_name scroll-proving-agent
fullnameOverride: *app_name

image:
repository: snarkify/snarkify-scroll-proving-agent
repository: snarkify/scroll-proving-agent
pullPolicy: Always
tag: v0.0.1

command:
- "/bin/sh"
- "-c"
- "exec snarkify-scroll-proving-agent --config /sdk_prover/config.json"
- "exec scroll-proving-agent --config /sdk_prover/config.json"

resources:
requests:
Expand All @@ -26,7 +26,7 @@ persistence:
enabled: true
type: configMap
mountPath: /sdk_prover/
name: snarkify-scroll-proving-agent-config
name: scroll-proving-agent-config
keys:
enabled: true
type: pvc
Expand Down
4 changes: 2 additions & 2 deletions docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ RUN apt-get update && apt-get install -y libssl-dev ca-certificates && rm -rf /v
RUN update-ca-certificates

# Copy the built binary from the builder stage
COPY --from=builder /usr/src/app/target/release/snarkify-scroll-proving-agent /usr/local/bin/snarkify-scroll-proving-agent
COPY --from=builder /usr/src/app/target/release/scroll-proving-agent /usr/local/bin/scroll-proving-agent

# Set the entrypoint
ENTRYPOINT ["snarkify-scroll-proving-agent"]
ENTRYPOINT ["scroll-proving-agent"]
4 changes: 2 additions & 2 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
use clap::Parser;
use scroll_proving_agent::prover::SnarkifyProver;
use scroll_proving_sdk::{config::Config, prover::ProverBuilder, utils::init_tracing};
use snarkify_scroll_proving_agent::prover::SnarkifyProver;
use std::env;

#[derive(Parser, Debug)]
#[clap(disable_version_flag = true)]
struct Args {
/// Path to the configuration file in JSON format.
/// Regarding the JSON format, please refer to the README.md for the Configuration section in
/// https://github.com/snarkify/snarkify-scroll-proving-agent
/// https://github.com/snarkify/scroll-proving-agent
#[arg(long = "config", default_value = "config.json")]
config_file: String,
}
Expand Down

0 comments on commit 76cfb20

Please sign in to comment.