Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ci): add extra checks to CI #397

Merged
merged 7 commits into from
Sep 21, 2023
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
16 changes: 10 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,17 @@ jobs:
uses: bufbuild/buf-setup-action@v1
- name: buf lint
uses: bufbuild/buf-lint-action@v1

# - name: buf breaking
# uses: bufbuild/buf-breaking-action@v1
# with:
# # The 'main' branch of the GitHub repository that defines the module.
# against: "https://github.com/${GITHUB_REPOSITORY}.git#branch=main"

spellcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v3
- name: Install codespell
run: sudo pip3 install codespell tomli
- name: Check spelling
run: codespell --toml .github/workflows/codespell.toml *.md docs/*.md

cog_check_job:
runs-on: ubuntu-latest
name: check conventional commit compliance
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/codespell.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[tool.codespell]
skip = '*/node_modules,./target'
count = ''
quiet-level = 3
20 changes: 20 additions & 0 deletions .github/workflows/scheduled_jobs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: 'Scheduled Jobs'
on:
schedule:
- cron: '30 1 * * *'

jobs:
stale:
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v8
with:
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
days-before-stale: 30
days-before-close: 5
todo:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v3"
- name: "TODO to Issue"
uses: "alstr/todo-to-issue-action@v4"
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ cargo test --all

### Run locally:

Running locally requires access to an Ethereum RPC node on the network the Rundler is running on. For testing it is recommended to run a local devlopment node.
Running locally requires access to an Ethereum RPC node on the network the Rundler is running on. For testing it is recommended to run a local development node.

Steps to run `Geth` in dev mode locally:

Expand Down Expand Up @@ -66,7 +66,7 @@ cargo run node
### Goals

- Implement P2P mempool
- Implement persistant mempool
- Implement persistent mempool
- Keep our spec test fork in like with origin
- Deploy public docker image
- Cross platform compilation
Expand Down
10 changes: 5 additions & 5 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ has enough room for it to be included or wait until a new bundle is proposed.

### Bundle Sender

After the bundle proposal runs, the bundle sender logic will handle the process of propagating a transction on chain and checking on the status to see if it is included in a block. This process also handles the gas increases if the transaction
After the bundle proposal runs, the bundle sender logic will handle the process of propagating a transaction on chain and checking on the status to see if it is included in a block. This process also handles the gas increases if the transaction
has any issues being included.

### Sender
Expand All @@ -28,9 +28,9 @@ couple process that track the status of the operations and perform updates to th

### Signer

The signer component is used to sign transactions before they are sent to be propogated on chain. The signing process can either be done by a key that is local to the server instance or an AWS KMS key.
The signer component is used to sign transactions before they are sent to be propagated on chain. The signing process can either be done by a key that is local to the server instance or an AWS KMS key.
When using the KMS option, there also needs to be a configured redis cache to perform locking. The locking is required as if there are multiple instances of the builder modules running, we want to
make sure that none there are two of the services are using the same key with the same nonce. This can lead to an imediate revertion of the bundle if the nonce is not correct when sending the bundle to be
make sure that none there are two of the services are using the same key with the same nonce. This can lead to an immediate revertion of the bundle if the nonce is not correct when sending the bundle to be
processed on chain.

### Server
Expand All @@ -40,8 +40,8 @@ If the server is running in the distributed mode, messaging is done via gRPC whi

## Op Pool

The pool components purpose is to manage the mempool operations. Once a user operation is sent to the RPC server, the pool will add the operation to its mempool to be proposed via the builder and then to be propogated on chain. The Pool should be the
module that lets the bulder know when a new user operation has been added to the mempool so that it can then be proposed to be incuded in a new bundle.
The pool components purpose is to manage the mempool operations. Once a user operation is sent to the RPC server, the pool will add the operation to its mempool to be proposed via the builder and then to be propagated on chain. The Pool should be the
module that lets the bulder know when a new user operation has been added to the mempool so that it can then be proposed to be included in a new bundle.

### Mempool

Expand Down
Loading