mirror of
https://github.com/logos-messaging/go-zerokit-rln.git
synced 2026-01-02 05:03:10 +00:00
chore: update README.md with instructions on how to update zerokit
This commit is contained in:
parent
d284a3d8f2
commit
4b71a4fcf1
58
README.md
58
README.md
@ -1,3 +1,61 @@
|
||||
# go-zerokit-rln
|
||||
|
||||
Go wrappers for [zerokit's RLN](https://github.com/vacp2p/zerokit)
|
||||
|
||||
|
||||
|
||||
### Updating vacp2p/zerokit
|
||||
|
||||
To overcome the limit of 500mb github has for repositories, go-zerokit-rln depends on 3 projects:
|
||||
- https://github.com/waku-org/go-zerokit-rln-apple
|
||||
- https://github.com/waku-org/go-zerokit-rln-arm
|
||||
- https://github.com/waku-org/go-zerokit-rln-x86_64
|
||||
|
||||
Zerokit must be updated in these 3 repositories. The instructions are the same for each of the architectures,
|
||||
except for `-apple` which require macos to be executed. You need to have docker and rust installed.
|
||||
|
||||
```bash
|
||||
export GO_RLN_ARCH=x86_64 # Replace this for x86_64, arm or apple
|
||||
export ZEROKIT_COMMIT=master # Use a commit, branch or tag
|
||||
|
||||
git clone https://github.com/waku-org/go-zerokit-rln_${GO_RLN_ARCH}
|
||||
cd go-zerokit-rln-${GO_RLN_ARCH}
|
||||
git submodule init
|
||||
git submodule update --recursive
|
||||
cd zerokit
|
||||
git pull
|
||||
git checkout ${ZEROKIT_COMMIT}
|
||||
cd ..
|
||||
make
|
||||
git add zerokit
|
||||
git add libs/*/librln.a
|
||||
git commit -m "chore: bump zerokit"
|
||||
git push
|
||||
```
|
||||
|
||||
Once you execute the previous commands for each one of the architectures, update go.mod:
|
||||
```bash
|
||||
cd /path/to/go-zerokit-rln
|
||||
go get github.com/waku-org/go-zerokit-rln-apple@latest
|
||||
go get github.com/waku-org/go-zerokit-rln-arm@latest
|
||||
go get github.com/waku-org/go-zerokit-rln-x86_64@latest
|
||||
git checkout master
|
||||
git add go.mod
|
||||
git add go.sum
|
||||
git commit -m "chore: bump zerokit"
|
||||
git push
|
||||
```
|
||||
|
||||
And later in go-waku, update the go-zerokit-rln dependency with
|
||||
```
|
||||
cd /path/to/go-waku
|
||||
git fetch
|
||||
git checkout -b `date +"%Y%m%d%H%M%S"-bump-zerokit` origin/master
|
||||
go get github.com/waku-org/go-zerokit-rln@latest
|
||||
git add go.mod
|
||||
git add go.sum
|
||||
git commit -m "chore: bump go-zerokit-rln"
|
||||
git push
|
||||
````
|
||||
And create a PR
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user