carrotsmuggler / c4-table

A utility to extract the issue links for a particular contest submitted by a particular user. Generates a markdown table with the issue links.

c4-table

A utility to extract the issue links for a particular contest submitted by a particular user. Generates a markdown table with the issue links.

This tool can be used to make a table of your own submitted findings once the backstage access of the contest has opened and you have access to the issue links to prepare for PJQA. This can also be used to extract submissions from top auditors and read them while waiting for PJQA. This is very useful, since for contests with a large number of submissions, the github UI does not show the entire list, and one needs to search manually and note down the issue numbers.

This script uses gh (github cli tool) to access the backstage. Make sure you have gh installed and logged in.

Installation

The tool accesses the code4rena backstage with the github cli. You need to have gh installed, and logged in with an account which has backstage access.

gh installation

For Debian,

sudo apt-get install gh

For other platforms, check installation instructions here.

gh login

Must login to a github account which has backstage access with gh.

gh auth login

Follow instructions to login. For more help, check the official documentation.

Usage

Run with -h for help. Program needs 2 arguments: a contest link and a username (optional for some cases).

Contest link can be:

1. http link of the contest findings repo: https://github.com/code-423n4/2023-10-zksync-findings
2. Name of the contest repo: 2023-10-zksync
3. Name of the contest findings repo: 2023-10-zksync-findings

Example usage

c4-table 2023-08-chainlink carrotsmuggler

Output

c4-table 2024-03-ondo-finance-findings carrotsmuggler

Num	URL	Acceptance	Occurrence	Title	Comments
141	code-423n4/2024-03-ondo-finance-findings#141	X	1	BUIDL tokens in the manager contract can be force converted into USDC DOSing operations at a small fee
142	code-423n4/2024-03-ondo-finance-findings#142	P	4	Users can lose access to funds due to minimum withdrawal limits.
143	code-423n4/2024-03-ondo-finance-findings#143	QA	1	Close hardcoded MINIMUM_OUSG_PRICE in ousgInstantManager contract can lead to DOS

Found 3 issues from carrotsmuggler in 2024-03-ondo-finance-findings repo

Columns have been named name as per my convenience. You can edit the code to change the column names/number.

Extra features

Quick links ( -l | --links-only)

Fetches only the issue urls, and not the issue titles. Very fast since all issues dont need to be fetched.

Stat dump (-u | --user-stats)

Passing username is optional here. This dumps out the submissions per user of the contest.

-> c4-table 2024-02-hydradx -u
Username             | Number of issues
-------------------- | ---------------
QiuhaoLi             | 11
castle_chain         | 12
oakcobalt            | 15
carrotsmuggler       | 20
J4X                  | 28
Total 206 issues submitted by 49 users

Support

If you like this tool please let me know here by giving me a reaction 👍 👎 ❤️ 👀

This work was inspired from c4-stats by @one-hundred-proof. Check it out here

c4-table's Issues

Feedback for c4-table

If you like c4-table please feel free to add whatever GitHub reaction you want below, or add a comment.

If you'd like a new feature please submit it as a new issue.