feat(rebrand): rebrand zkbas to zkbnb

.github/workflows/deploy-on-qa1.yml

@@ -1,4 +1,4 @@
-name: Deploy zkbas on qa1
+name: Deploy zkbnb on qa1
 
 on:
   push:
@@ -12,15 +12,15 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - name: Deploy new zkbas on qa1
+      - name: Deploy new zkbnb on qa1
         run: |
-          echo 'fetch zkbas repo'
+          echo 'fetch zkbnb repo'
           export BRANCH=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
 
           cd ~
-          rm -rf ./zkbas
-          git clone --branch qa1 https://github.com/bnb-chain/zkbas.git
-          cd ./zkbas
+          rm -rf ./zkbnb
+          git clone --branch qa1 https://github.com/bnb-chain/zkbnb.git
+          cd ./zkbnb
 
           sudo scp -r ./deploy-qa.sh "qa1:/tmp/"
           sudo ssh qa1 "sudo bash -x /tmp/deploy-qa.sh qa1;exit"
@@ -30,9 +30,9 @@ jobs:
         run: |
           export SLACK_WEBHOOK_URL=`sudo cat /home/ec2-user/actions-runner/slack-config.json | jq -r '.slack'`
           export JOB_STATUS=${{ job.status }}
-          sudo scp -r qa1:/root/zkbas-deploy/zkbas-contract/info/addresses.json ~/addresses.json
-          export ZkBas=`sudo cat ~/addresses.json  | jq -r '.zkbasProxy'`
+          sudo scp -r qa1:/root/zkbnb-deploy/zkbnb-contract/info/addresses.json ~/addresses.json
+          export ZkBNB=`sudo cat ~/addresses.json  | jq -r '.zkbnbProxy'`
           export AssetGov=`sudo cat ~/addresses.json  | jq -r '.assetGovernance'`
           curl -X POST $SLACK_WEBHOOK_URL --header 'Content-Type: application/json' \
-          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkbasContract": "'$ZkBas'", "AssetGovContract": "'$AssetGov'" }'
+          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkBNBContract": "'$ZkBNB'", "AssetGovContract": "'$AssetGov'" }'
 

.github/workflows/deploy-on-qa2.yml

@@ -1,4 +1,4 @@
-name: Deploy zkbas on qa2
+name: Deploy zkbnb on qa2
 
 on:
   push:
@@ -12,15 +12,15 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - name: Deploy new zkbas on qa2
+      - name: Deploy new zkbnb on qa2
         run: |
-          echo 'fetch zkbas repo'
+          echo 'fetch zkbnb repo'
           export BRANCH=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
 
           cd ~
-          rm -rf ./zkbas
-          git clone --branch qa2 https://github.com/bnb-chain/zkbas.git
-          cd ./zkbas
+          rm -rf ./zkbnb
+          git clone --branch qa2 https://github.com/bnb-chain/zkbnb.git
+          cd ./zkbnb
 
           sudo scp -r ./deploy-qa.sh "qa2:/tmp/"
           sudo ssh qa2 "sudo bash -x /tmp/deploy-qa.sh qa2;exit"
@@ -30,9 +30,9 @@ jobs:
         run: |
           export SLACK_WEBHOOK_URL=`sudo cat /home/ec2-user/actions-runner/slack-config.json | jq -r '.slack'`
           export JOB_STATUS=${{ job.status }}
-          sudo scp -r qa2:/root/zkbas-deploy/zkbas-contract/info/addresses.json ~/addresses.json
-          export ZkBas=`sudo cat ~/addresses.json  | jq -r '.zkbasProxy'`
+          sudo scp -r qa2:/root/zkbnb-deploy/zkbnb-contract/info/addresses.json ~/addresses.json
+          export ZkBNB=`sudo cat ~/addresses.json  | jq -r '.zkbnbProxy'`
           export AssetGov=`sudo cat ~/addresses.json  | jq -r '.assetGovernance'`
           curl -X POST $SLACK_WEBHOOK_URL --header 'Content-Type: application/json' \
-          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkbasContract": "'$ZkBas'", "AssetGovContract": "'$AssetGov'" }'
+          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkBNBContract": "'$ZkBNB'", "AssetGovContract": "'$AssetGov'" }'
 

.github/workflows/deploy-on-qa3.yml

@@ -1,4 +1,4 @@
-name: Deploy zkbas on qa3
+name: Deploy zkbnb on qa3
 
 on:
   push:
@@ -12,15 +12,15 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - name: Deploy new zkbas on qa3
+      - name: Deploy new zkbnb on qa3
         run: |
-          echo 'fetch zkbas repo'
+          echo 'fetch zkbnb repo'
           export BRANCH=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
 
           cd ~
-          rm -rf ./zkbas
-          git clone --branch qa3 https://github.com/bnb-chain/zkbas.git
-          cd ./zkbas
+          rm -rf ./zkbnb
+          git clone --branch qa3 https://github.com/bnb-chain/zkbnb.git
+          cd ./zkbnb
 
           sudo scp -r ./deploy-qa.sh "qa3:/tmp/"
           sudo ssh qa3 "sudo bash -x /tmp/deploy-qa.sh qa3;exit"
@@ -30,9 +30,9 @@ jobs:
         run: |
           export SLACK_WEBHOOK_URL=`sudo cat /home/ec2-user/actions-runner/slack-config.json | jq -r '.slack'`
           export JOB_STATUS=${{ job.status }}
-          sudo scp -r qa3:/root/zkbas-deploy/zkbas-contract/info/addresses.json ~/addresses.json
-          export ZkBas=`sudo cat ~/addresses.json  | jq -r '.zkbasProxy'`
+          sudo scp -r qa3:/root/zkbnb-deploy/zkbnb-contract/info/addresses.json ~/addresses.json
+          export ZkBNB=`sudo cat ~/addresses.json  | jq -r '.zkbnbProxy'`
           export AssetGov=`sudo cat ~/addresses.json  | jq -r '.assetGovernance'`
           curl -X POST $SLACK_WEBHOOK_URL --header 'Content-Type: application/json' \
-          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkbasContract": "'$ZkBas'", "AssetGovContract": "'$AssetGov'" }'
+          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkBNBContract": "'$ZkBNB'", "AssetGovContract": "'$AssetGov'" }'
 

.github/workflows/integration-test.yml

@@ -16,49 +16,49 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - name: deploy new zkbas on runner
+      - name: deploy new zkbnb on runner
         run: |
-          echo 'fetch zkbas repo'
+          echo 'fetch zkbnb repo'
           export PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
           echo Pull requests $PR_NUMBER
 
           cd ~
-          sudo rm -rf ./zkbas
-          git clone https://github.com/bnb-chain/zkbas.git
+          sudo rm -rf ./zkbnb
+          git clone https://github.com/bnb-chain/zkbnb.git
           echo "Integration tests run on commit id: $GITHUB_SHA"
-          cd ./zkbas
+          cd ./zkbnb
           git fetch origin pull/$PR_NUMBER/head:$GITHUB_SHA
           git checkout $GITHUB_SHA
 
-          echo "start deploy new zkbas"
+          echo "start deploy new zkbnb"
           sudo bash ./deployment/tool/generate_api.sh
           go mod tidy
           docker image prune -f
           make docker-image
-          sudo mkdir -p ./deployment/.zkbas
-          sudo cp /server/test.keyfile/* ./deployment/.zkbas
+          sudo mkdir -p ./deployment/.zkbnb
+          sudo cp /server/test.keyfile/* ./deployment/.zkbnb
           blockNr=$(sudo bash ./deployment/tool/tool.sh blockHeight)
           sudo bash ./deployment/tool/tool.sh all
           sudo bash ./deployment/docker-compose/docker-compose.sh down
           sudo bash ./deployment/docker-compose/docker-compose.sh up $blockNr
           echo "Contract addresses"
-          cat ~/zkbas/deployment/dependency/zkbas-contract/info/addresses.json
+          cat ~/zkbnb/deployment/dependency/zkbnb-contract/info/addresses.json
           echo "Waiting 3m for the initialization tx to be verified"
           sleep 3m # Waiting for the initialization tx to be verified
           echo "end deploy"
 
       - name: run integration test
         run: |
           export PATH=$PATH:/usr/local/go/bin:/usr/local/go/bin:/root/go/bin
-          export ZkBas=$(sudo cat ~/zkbas/deployment/dependency/zkbas-contract/info/addresses.json  | jq -r '.zkbasProxy')
-          export AssetGov=$(sudo cat ~/zkbas/deployment/dependency/zkbas-contract/info/addresses.json  | jq -r '.assetGovernance')
+          export ZkBNB=$(sudo cat ~/zkbnb/deployment/dependency/zkbnb-contract/info/addresses.json  | jq -r '.zkbnbProxy')
+          export AssetGov=$(sudo cat ~/zkbnb/deployment/dependency/zkbnb-contract/info/addresses.json  | jq -r '.assetGovernance')
           export TestLogLevel=2
           export L1EndPoint=$L1_ENDPOINT
           export L2EndPoint=$L2_ENDPOINT
 
-          cd /tmp && sudo rm -rf ./zkbas-integration-test
-          git clone --branch main https://github.com/bnb-chain/zkbas-integration-test.git
-          cd ./zkbas-integration-test/tests
+          cd /tmp && sudo rm -rf ./zkbnb-integration-test
+          git clone --branch main https://github.com/bnb-chain/zkbnb-integration-test.git
+          cd ./zkbnb-integration-test/tests
 
           echo '1. start TestSetupSuite'
           go test -v -failfast  -run TestSetupSuite -timeout 30m
@@ -71,7 +71,7 @@ jobs:
         run: |
           export SLACK_WEBHOOK_URL=`sudo cat /home/ec2-user/actions-runner/slack-config.json | jq -r '.slack'`
           export JOB_STATUS=${{ job.status }}
-          export ZkBas=`sudo cat /home/ec2-user/zkbas/deployment/dependency/zkbas-contract/info/addresses.json | jq -r '.zkbasProxy'`
-          export AssetGov=`sudo cat /home/ec2-user/zkbas/deployment/dependency/zkbas-contract/info/addresses.json | jq -r '.assetGovernance'`
+          export ZkBNB=`sudo cat /home/ec2-user/zkbnb/deployment/dependency/zkbnb-contract/info/addresses.json | jq -r '.zkbnbProxy'`
+          export AssetGov=`sudo cat /home/ec2-user/zkbnb/deployment/dependency/zkbnb-contract/info/addresses.json | jq -r '.assetGovernance'`
           curl -X POST $SLACK_WEBHOOK_URL --header 'Content-Type: application/json' \
-          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkbasContract": "'$ZkBas'", "AssetGovContract": "'$AssetGov'" }'
+          --data-raw '{ "author": "@'$GITHUB_ACTOR'", "status": "'$JOB_STATUS'", "ref": "'$GITHUB_REF'", "event": "'$GITHUB_EVENT_NAME'", "url": "'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'/commit/'$GITHUB_SHA'/checks", "ZkBNBContract": "'$ZkBNB'", "AssetGovContract": "'$AssetGov'" }'

.github/workflows/issue-trigger.yml

@@ -15,17 +15,17 @@ jobs:
         if: contains(github.event.pull_request.body, '/update-integration-keyfile') || contains(github.event.comment.body, '/update-integration-keyfile')   # check the comment if it contains the keywords
         run: |
           cd /server
-          sudo rm -rf ./zkbas
-          
-          echo 'fetch zkbas repo'
+          sudo rm -rf ./zkbnb
+
+          echo 'fetch zkbnb repo'
           export PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
           echo Pull requests $PR_NUMBER
-          
-          sudo git clone https://github.com/bnb-chain/zkbas.git
-          cd ./zkbas
+
+          sudo git clone https://github.com/bnb-chain/zkbnb.git
+          cd ./zkbnb
           sudo git fetch origin pull/$PR_NUMBER/head:$GITHUB_SHA 2>/dev/null
           sudo git checkout $GITHUB_SHA
 
           sudo bash ./deployment/tool/tool.sh prepare new
           sudo rm -rf /server/test.keyfile
-          sudo cp -r ./deployment/.zkbas /server/test.keyfile
+          sudo cp -r ./deployment/.zkbnb /server/test.keyfile

.gitignore

@@ -33,5 +33,5 @@ build
 vendor
 deployment/dependency
 deployment/configs
-deployment/.zkbas
+deployment/.zkbnb
 run_*.sh

Dockerfile

@@ -2,14 +2,14 @@ FROM golang:1.17-alpine as builder
 
 RUN apk add --no-cache make git bash
 
-ADD . /zkbas
+ADD . /zkbnb
 
 ENV CGO_ENABLED=0
 ENV GO111MODULE=on
 
-RUN cd /zkbas && make build-only
+RUN cd /zkbnb && make build-only
 
-# Pull zkBAS into a second stage deploy alpine container
+# Pull ZkBNB into a second stage deploy alpine container
 FROM alpine:3.16.0
 
 ARG USER=bsc
@@ -30,8 +30,8 @@ RUN echo "[ ! -z \"\$TERM\" -a -r /etc/motd ] && cat /etc/motd" >> /etc/bash/bas
 
 WORKDIR ${WORKDIR}
 
-COPY --from=builder /zkbas/build/bin/zkbas ${WORKDIR}/
+COPY --from=builder /zkbnb/build/bin/zkbnb ${WORKDIR}/
 RUN chown -R ${USER_UID}:${USER_GID} ${WORKDIR}
 USER ${USER_UID}:${USER_GID}
 
-ENTRYPOINT ["/server/zkbas"]
+ENTRYPOINT ["/server/zkbnb"]

Makefile

@@ -2,18 +2,18 @@
 # with Go source code. If you know what GOPATH is then you probably
 # don't need to bother with make.
 
-.PHONY: zkbas android ios zkbas-cross evm all test clean
-.PHONY: zkbas-linux zkbas-linux-386 zkbas-linux-amd64 zkbas-linux-mips64 zkbas-linux-mips64le
-.PHONY: zkbas-linux-arm zkbas-linux-arm-5 zkbas-linux-arm-6 zkbas-linux-arm-7 zkbas-linux-arm64
-.PHONY: zkbas-darwin zkbas-darwin-386 zkbas-darwin-amd64
-.PHONY: zkbas-windows zkbas-windows-386 zkbas-windows-amd64
+.PHONY: zkbnb android ios zkbnb-cross evm all test clean
+.PHONY: zkbnb-linux zkbnb-linux-386 zkbnb-linux-amd64 zkbnb-linux-mips64 zkbnb-linux-mips64le
+.PHONY: zkbnb-linux-arm zkbnb-linux-arm-5 zkbnb-linux-arm-6 zkbnb-linux-arm-7 zkbnb-linux-arm64
+.PHONY: zkbnb-darwin zkbnb-darwin-386 zkbnb-darwin-amd64
+.PHONY: zkbnb-windows zkbnb-windows-386 zkbnb-windows-amd64
 GOBIN?=${GOPATH}/bin
 
 VERSION=$(shell git describe --tags)
 GIT_COMMIT=$(shell git rev-parse HEAD)
 GIT_COMMIT_DATE=$(shell git log -n1 --pretty='format:%cd' --date=format:'%Y%m%d')
-REPO=github.com/bnb-chain/zkbas
-IMAGE_NAME=ghcr.io/bnb-chain/zkbas
+REPO=github.com/bnb-chain/zkbnb
+IMAGE_NAME=ghcr.io/bnb-chain/zkbnb
 API_SERVER = ./service/apiserver
 
 api-server:
@@ -39,7 +39,7 @@ lint:
 	golangci-lint run ./...
 
 build-only:
-	go build -o build/bin/zkbas -ldflags="-X main.version=${VERSION} -X main.gitCommit=${GIT_COMMIT} -X main.gitDate=${GIT_COMMIT_DATE}" ./cmd/zkbas
+	go build -o build/bin/zkbnb -ldflags="-X main.version=${VERSION} -X main.gitCommit=${GIT_COMMIT} -X main.gitDate=${GIT_COMMIT_DATE}" ./cmd/zkbnb
 
 docker-image:
 	go mod vendor # temporary, should be removed after open source