docs: README audit table

[rootulp]

Closes #250

[coderabbitai]

Walkthrough

The recent update introduces a dedicated section for audits in the README.md, enhancing transparency and trust with a table listing audit details like dates, auditors, versions, and links to reports.

Changes

File(s)	Change Summary
README.md	Added a section for audits in the README.md file, including a table with audit details such as dates, auditors, versions, and reports.

Assessment against linked issues

Objective	Addressed	Explanation
README: add links to audits (#250)	✅

🐰
In the realm of code, under the moon's soft glow,
A rabbit hopped in, with updates in tow.
With a flick and a hop, and a soft little thud,
It laid down the links, with nary a dud.
"Audit reports here!" it cheerfully said,
For trust and for clarity, we've thoroughly tread.
🌟📚🐾

---

Recent Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8167cd1 and 3809168.

Files selected for processing (1)

• README.md (1 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[rach-id]

Thanks for helping with this,

[rootulp]

@rach-id thoughts on merging this as is? We haven't received a response from Binary Builders.

[rach-id]

It was this: https://github.com/celestiaorg/blobstream-contracts/releases/tag/v2.1.2

[coderabbitai]

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 2db843d and 8167cd1.

Files selected for processing (1)

• README.md (1 hunks)

Additional comments not posted (2)

README.md (2)

97-103: Ensure the audit report links are accessible and correct.

Verification successful

---

The audit report links provided in the README.md file are accessible and correct, as confirmed by the HTTP status code 200 for each link after following redirections.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the accessibility of the provided PDF links in the audit section.
curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/13961809/2023-10-17_Celestia_Audit_Report_Binary_Builders.pdf
curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf
curl -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/14383577/celestia_blobstream_audit_final.pdf

Length of output: 541

---

---

Script:

#!/bin/bash
# Follow the redirections and verify the final HTTP status codes of the provided PDF links in the audit section.
curl -L -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/13961809/2023-10-17_Celestia_Audit_Report_Binary_Builders.pdf
curl -L -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf
curl -L -o /dev/null --silent --head --write-out '%{http_code}\n' https://github.com/celestiaorg/blobstream-contracts/files/14383577/celestia_blobstream_audit_final.pdf

Length of output: 550

---

93-103: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-103]

Review and correct any typographical errors in the document.

While the static analysis hints at possible spelling mistakes, these are likely false positives due to technical terms. However, it's good practice to manually review the document for any real typographical errors that might affect readability.

[rootulp]

The commit hash for blobstream-contracts wasn't included in the Binary Builders PDF but Frojdi from Binary Builders shared this one.

[rootulp]

Ready for review @rach-id @adlerjohn

[coderabbitai]

Actionable comments posted: 2

[coderabbitai]

Consider adding a brief introduction to the Audits section.

A short introductory sentence before the table could provide context and emphasize the importance of audits for the project's security and reliability. For example:

## Audits

We prioritize the security of our contracts and regularly undergo audits by reputable firms. Below is a summary of our audit history:

[coderabbitai]

Correct repeated whitespaces and ensure proper spacing between sentences.

In the audit table, there are instances of repeated whitespaces and missing spaces between sentences. Correcting these will improve the readability of the table. For example:

- | 2023/10/26 | [Informal Systems](https://informal.systems/) | [v1.0.0](https://github.com/celestiaorg/celestia-app/tree/v1.0.0)                   | [cf301adf](https://github.com/celestiaorg/blobstream-contracts/blob/cf301adfbfdae138526199fab805822400dcfd5d)  | [informal-systems.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf)        |
+ | 2023/10/26 | [Informal Systems](https://informal.systems/) | [v1.0.0](https://github.com/celestiaorg/celestia-app/tree/v1.0.0) | [cf301adf](https://github.com/celestiaorg/blobstream-contracts/blob/cf301adfbfdae138526199fab805822400dcfd5d) | [informal-systems.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf) |

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	| Date | Auditor | celestia-app | blobstream-contracts | Report |
	|------------|-----------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
	| 2023/10/17 | [Binary Builders](https://binary.builders/) | [v1.0.0-rc10](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc10) | [eb7a4e7](https://github.com/celestiaorg/blobstream-contracts/commit/eb7a4e74718b80277ad9dde116ead67383f5fe15) | [binary-builders.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961809/2023-10-17_Celestia_Audit_Report_Binary_Builders.pdf) |
	| 2023/10/26 | [Informal Systems](https://informal.systems/) | [v1.0.0](https://github.com/celestiaorg/celestia-app/tree/v1.0.0) | [cf301adf](https://github.com/celestiaorg/blobstream-contracts/blob/cf301adfbfdae138526199fab805822400dcfd5d) | [informal-systems.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf) |
	| 2023/11/16 | [Ottersec](https://osec.io/) | [v1.3.0](https://github.com/celestiaorg/celestia-app/releases/tag/v1.3.0) | [v3.1.0](https://github.com/celestiaorg/blobstream-contracts/releases/tag/v3.1.0) | [ottersec.pdf](https://github.com/celestiaorg/blobstream-contracts/files/14383577/celestia_blobstream_audit_final.pdf) |
	| Date | Auditor | celestia-app | blobstream-contracts | Report |
	|------------|-----------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
	| 2023/10/17 | [Binary Builders](https://binary.builders/) | [v1.0.0-rc10](https://github.com/celestiaorg/celestia-app/releases/tag/v1.0.0-rc10) | [eb7a4e7](https://github.com/celestiaorg/blobstream-contracts/commit/eb7a4e74718b80277ad9dde116ead67383f5fe15) | [binary-builders.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961809/2023-10-17_Celestia_Audit_Report_Binary_Builders.pdf) |
	| 2023/10/26 | [Informal Systems](https://informal.systems/) | [v1.0.0](https://github.com/celestiaorg/celestia-app/tree/v1.0.0) | [cf301adf](https://github.com/celestiaorg/blobstream-contracts/blob/cf301adfbfdae138526199fab805822400dcfd5d) | [informal-systems.pdf](https://github.com/celestiaorg/blobstream-contracts/files/13961767/Celestia_.Q4.2023.QGB-v2-20231026_182304.pdf) |
	| 2023/11/16 | [Ottersec](https://osec.io/) | [v1.3.0](https://github.com/celestiaorg/celestia-app/releases/tag/v1.3.0) | [v3.1.0](https://github.com/celestiaorg/blobstream-contracts/releases/tag/v3.1.0) | [ottersec.pdf](https://github.com/celestiaorg/blobstream-contracts/files/14383577/celestia_blobstream_audit_final.pdf) |

[rach-id]

@rootulp not blocking but might be nice to commit this

[coderabbitai]

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!