chore(payments): add audit report (#24)

Author: MohammadNassar1

README.md

@@ -1 +1,77 @@
-# starknet-payments
+
+<div align="center">
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="assets/starknet-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="assets/starknet-light.png">
+  <img alt="Your logo" src="assets/starknet-light.png">
+</picture>
+</div>
+
+<div align="center">
+
+[![License: Apache2.0](https://img.shields.io/badge/License-Apache2.0-green.svg)](LICENSE)
+</div>
+
+# Starknet Payments <!-- omit from toc -->
+
+## Table of contents <!-- omit from toc -->
+
+ <!-- omit from toc -->
+- [About](#about)
+- [Disclaimer](#disclaimer)
+- [Dependencies](#dependencies)
+- [Installation](#installation)
+- [Build and Test](#build-and-test)
+- [Implementation specification](#implementation-specification)
+- [Audit](#audit)
+- [Security](#security)
+
+## About
+
+This repo holds the implementation of Staknet Payments contracts.
+
+## Disclaimer
+
+Payments is a work in progress.
+
+## Dependencies
+
+- Cairo dependencies such as [Scarb](https://docs.swmansion.com/scarb/) and [Starknet foundry](https://foundry-rs.github.io/starknet-foundry/index.html) - install using [starkup](https://github.com/software-mansion/starkup).
+
+## Installation
+
+Clone the repo and from within the projects root folder run:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.starkup.dev | sh
+```
+
+## Build and Test
+
+Build the contracts from the repo root:
+
+```bash
+scarb build
+
+```
+
+To run the tests, execute:
+
+```bash
+scarb test
+```
+
+## Implementation specification
+
+Specs document found [here](docs/spec.md)
+
+## Audit
+
+Find the latest audit report in [docs/audit](docs/audit).
+
+## Security
+
+Starknet Payments follows good practices of security, but 100% security cannot be assured. Starknet Payments is provided "as is" without any warranty. Use at your own risk.
+
+For more information and to report security issues, please refer to our [security documentation](https://github.com/starkware-libs/starknet-payments/blob/main/docs/SECURITY.md).

assets/starknet-dark.png

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If there are any vulnerabilities in **Starknet Payments**, don't hesitate to _report them_.
+
+1. Use any of the [private contact addresses](https://github.com/starkware-libs/starknet-payments#getting-help).
+2. Describe the vulnerability.
+
+   If you have a fix, that is most welcome -- please attach or summarize it in your message!
+
+3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
+
+   Please **do not disclose the vulnerability publicly** until a fix is released!
+
+4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.

assets/starknet-light.png

@@ -0,0 +1,7 @@
+# Audits
+
+This folder consists of the audit reports performed on the Starkware Utils library.
+
+| Audit Purpose | Commit | Report | Firm | Date |
+|---------------|--------|--------|------|------|
+| V0 Release    | [23e72ca15a0e06e75313675d1d0f5c7727d3e92f](https://github.com/starkware-libs/starknet-payments/tree/23e72ca15a0e06e75313675d1d0f5c7727d3e92f) |[pdf](https://raw.githubusercontent.com/starkware-libs/starknet-payments/refs/heads/dev/docs/audit/Starknet_Payments_Audit_Report.pdf) | [cairosecurityclan](https://cairosecurityclan.com/) | 30.09.2025 |