From 62cb590dbe42aa600e2d548d0995ecb2ac5b7186 Mon Sep 17 00:00:00 2001 From: Zeljko Date: Mon, 7 Apr 2025 22:28:50 +0200 Subject: [PATCH 1/3] chore: plat-7575 Docs fixes (#153) * chore: adopt docs for netlify deployment * chore: fixes docs sections * chore: revert svg change * chore: improvements --- docs/modules/ROOT/nav.adoc | 1 - docs/modules/ROOT/pages/index.adoc | 16 +++++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 0127d2f02..81e86c1c5 100755 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -2,5 +2,4 @@ * xref:quickstart.adoc[Quickstart] * xref:api_reference.adoc[API Reference] * xref:structure.adoc[Project Structure] -* link:rust_docs/doc/openzeppelin_relayer/index.html[Technical Rust Documentation] * xref:roadmap.adoc[Project Roadmap] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index ae98df43a..a37dfe967 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -3,11 +3,15 @@ = OpenZeppelin Relayer :description: User guide for setting up and configuring OpenZeppelin Relayer. +== Overview + CAUTION: This software is in alpha stage. Use in production environments at your own risk. OpenZeppelin Relayer is a service that provides infrastructure to relay transactions to the EVM & Non-EVM networks. It is designed to be used as a backend for dApps that need to interact with these networks. -**Features** + +== Features + - **Multi-Chain Support**: Interact with multiple blockchain networks, including Solana and EVM-based chains. - **Transaction Relaying**: Submit transactions to supported blockchain networks efficiently. - **Transaction Signing**: Securely sign transactions using configurable key management. @@ -21,7 +25,8 @@ OpenZeppelin Relayer is a service that provides infrastructure to relay transact - **Metrics and Observability**: Monitor application performance using Prometheus and Grafana. - **Docker Support**: Deploy the relayer using Docker for both development and production environments. -**Supported Networks** + +== Supported Networks - Solana - EVM (Basic support for Ethereum and other EVM-compatible chains): @@ -42,6 +47,7 @@ To get started immediately, see xref:quickstart.adoc[Quickstart]. == Technical Overview + [mermaid,width=100%] .... %%{init: { @@ -606,6 +612,7 @@ Available configuration fields ==== 2. Notifications * `notifications` array, which should contain, at least, one valid configuration: + [source,json] ---- "notifications": [ @@ -649,6 +656,7 @@ Available configuration fields ==== 3. Relayers * `relayers` array, containing at least one valid relayer configuration: + [source,json] ---- "relayers": [ @@ -815,7 +823,8 @@ Policies Full `config/config.json` example with evm and solana relayers definitions using keystore signer: -```json +[source,json] +---- { "relayers": [ { @@ -882,6 +891,7 @@ Full `config/config.json` example with evm and solana relayers definitions using ] } ``` +---- === RPC URL Configuration From 9de7133c2ba1768f4d989158f19c27444e522f9e Mon Sep 17 00:00:00 2001 From: Sai Tirumerla <57160285+tirumerla@users.noreply.github.com> Date: Mon, 7 Apr 2025 16:15:26 -0700 Subject: [PATCH 2/3] fix: Missing libssl and workflow (#155) * fix: Missing libssl and workflow * chore: Remove comment * chore: Add libcrypto --- .github/workflows/release-please.yml | 46 ++++++++++++++-------------- Dockerfile.production | 2 ++ docker-compose.yaml | 3 +- 3 files changed, 26 insertions(+), 25 deletions(-) diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 680d337d0..82d902c4c 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -50,27 +50,27 @@ jobs: fetch-depth: 0 token: ${{ steps.gh-app-token.outputs.token }} - - name: Check release branch - id: check_branch - run: | - RELEASE_BRANCH=${{ github.ref_name }} - CURRENT_VERSION=$(echo "$RELEASE_BRANCH" | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -n 1) - echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_OUTPUT - - # Sort release branches - HIGHER_BRANCHES=$(git branch -r | grep release-v | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n +2) - if [[ -n "$HIGHER_BRANCHES" ]]; then - # Extract the highest version - HIGHEST_VERSION=$(echo "$HIGHER_BRANCHES" | tail -n 1) - if [[ "$CURRENT_VERSION" == "$HIGHEST_VERSION" ]]; then - echo "run_release_please=true" >> $GITHUB_OUTPUT - else - echo "run_release_please=false" >> $GITHUB_OUTPUT - echo "Release-please skipped for branch: $RELEASE_BRANCH. Higher versioned release branches exist." - fi - else - echo "run_release_please=true" >> $GITHUB_OUTPUT # if no higher version branch exists run release-please. - fi + # - name: Check release branch + # id: check_branch + # run: | + # RELEASE_BRANCH=${{ github.ref_name }} + # CURRENT_VERSION=$(echo "$RELEASE_BRANCH" | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -n 1) + # echo "CURRENT_VERSION=$CURRENT_VERSION" >> $GITHUB_OUTPUT + + # # Sort release branches + # HIGHER_BRANCHES=$(git branch -r | grep release-v | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n +2) + # if [[ -n "$HIGHER_BRANCHES" ]]; then + # # Extract the highest version + # HIGHEST_VERSION=$(echo "$HIGHER_BRANCHES" | tail -n 1) + # if [[ "$CURRENT_VERSION" == "$HIGHEST_VERSION" ]]; then + # echo "run_release_please=true" >> $GITHUB_OUTPUT + # else + # echo "run_release_please=false" >> $GITHUB_OUTPUT + # echo "Release-please skipped for branch: $RELEASE_BRANCH. Higher versioned release branches exist." + # fi + # else + # echo "run_release_please=true" >> $GITHUB_OUTPUT # if no higher version branch exists run release-please. + # fi - name: Get merged PR number from commit id: get_pr @@ -123,7 +123,6 @@ jobs: - name: Start release please action id: release uses: googleapis/release-please-action@a02a34c4d625f9be7cb89156071d8567266a2445 # v4.2.0 - if: ${{ steps.check_branch.outputs.run_release_please == 'true' }} with: token: ${{ steps.gh-app-token.outputs.token }} target-branch: ${{ github.ref_name }} @@ -131,7 +130,8 @@ jobs: manifest-file: .github/release-please/manifest.json - name: Get release branch name on release please prs - if: ${{ steps.release.outputs.releases_created == 'false' }} + if: ${{ steps.release.outputs.releases_created == 'false' && steps.release.outputs.pr + != '' }} id: get_release_branch run: | echo "release_branch=${{ fromJSON(steps.release.outputs.pr).headBranchName }}" >> $GITHUB_OUTPUT diff --git a/Dockerfile.production b/Dockerfile.production index b4b94d0e9..aaf8e84e1 100644 --- a/Dockerfile.production +++ b/Dockerfile.production @@ -20,6 +20,8 @@ FROM --platform=${BUILDPLATFORM} cgr.dev/chainguard/glibc-dynamic:latest WORKDIR /app COPY --from=base --chown=nonroot:nonroot /usr/app/bin/openzeppelin-relayer /app/openzeppelin-relayer +COPY --from=base /usr/lib/libssl.so.3 /usr/lib/libssl.so.3 +COPY --from=base /usr/lib/libcrypto.so.3 /usr/lib/libcrypto.so.3 ENV APP_PORT=8080 ENV METRICS_PORT=8081 diff --git a/docker-compose.yaml b/docker-compose.yaml index a8840fe22..f8d274fc5 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -3,8 +3,7 @@ services: relayer: - # Needs docker hub registry to be public - image: openzeppelin/openzeppelin-relayer:latest + # image: openzeppelin/openzeppelin-relayer:latest build: context: . dockerfile: ${DOCKERFILE:-Dockerfile.development} From 6ca012fb9b50d5c2159c498679673cb27530fc3c Mon Sep 17 00:00:00 2001 From: Sai Tirumerla <57160285+tirumerla@users.noreply.github.com> Date: Mon, 7 Apr 2025 16:23:25 -0700 Subject: [PATCH 3/3] fix: Docker Compose (#156) --- docker-compose.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yaml b/docker-compose.yaml index f8d274fc5..689eaa662 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -3,7 +3,7 @@ services: relayer: - # image: openzeppelin/openzeppelin-relayer:latest + image: openzeppelin/openzeppelin-relayer:latest build: context: . dockerfile: ${DOCKERFILE:-Dockerfile.development}