Prepare for v1.5.0 Release (#1009)

Just some housekeeping for the release:
- Fix the badges
- Bump package version
- Some small README formatting changes

Author: nlordell

README.md

@@ -1,14 +1,14 @@
-Safe Smart Account
-==============
+# Safe Smart Account
 
 [![npm version](https://badge.fury.io/js/%40safe-global%2Fsafe-smart-account.svg)](https://badge.fury.io/js/%40safe-global%2Fsafe-smart-account)
-[![Build Status](https://github.com/safe-global/safe-smart-account/workflows/safe-smart-account/badge.svg?branch=main)](https://github.com/safe-global/safe-smart-account/actions)
+[![Build Status](https://github.com/safe-global/safe-smart-account/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/safe-global/safe-smart-account/actions)
 [![Coverage Status](https://coveralls.io/repos/github/safe-global/safe-smart-account/badge.svg?branch=main)](https://coveralls.io/github/safe-global/safe-smart-account)
 
-> :warning: **This branch contains changes that are under development** To use the latest audited version make sure to use the correct commit. The tagged versions that are used by the Safe team can be found in the [releases](https://github.com/safe-global/safe-smart-account/releases).
+> [!WARNING]
+> **This branch contains changes that are under development** To use the latest audited version make sure to use the correct commit. The tagged versions that are used by the Safe team can be found in the [releases](https://github.com/safe-global/safe-smart-account/releases).
+
+## Usage
 
-Usage
------
 ### Install requirements with npm:
 
 ```bash
@@ -36,23 +36,25 @@ ERC4337_TEST_SAFE_FACTORY_ADDRESS=
 MNEMONIC=
 ```
 
-2. Pre-fund the executor account derived from the mnemonic with some Native Token to cover the deployment of an ERC4337 module and the pre-fund of the Safe for the test operation.
+2. Pre-fund the executor account derived from the mnemonic with some Native Token to cover the deployment of an ERC-4337 module and the pre-fund of the Safe for the test operation.
 
 ### Deployments
 
 A collection of the different Safe contract deployments and their addresses can be found in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
 
-To add support for a new network follow the steps of the ``Deploy`` section and create a PR in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
+To add support for a new network follow the steps of the `Deploy` section and create a PR in the [Safe deployments](https://github.com/safe-global/safe-deployments) repository.
 
 ### Deploy
 
-> :warning: **Make sure to use the correct commit when deploying the contracts.** Any change (even comments) within the contract files will result in different addresses. The tagged versions that are used by the Safe team can be found in the [releases](https://github.com/safe-global/safe-smart-account/releases).
+> [!WARNING]
+> **Make sure to use the correct commit when deploying the contracts.** Any change (even comments) within the contract files will result in different addresses. The tagged versions that are used by the Safe team can be found in the [releases](https://github.com/safe-global/safe-smart-account/releases).
 
 > **Current version:** The latest release is [v1.4.1-3](https://github.com/safe-global/safe-smart-account/tree/v1.4.1-3) on the commit [21dc824](https://github.com/safe-global/safe-smart-account/commit/21dc82410445637820f600c7399a804ad55841d5)
 
 This will deploy the contracts deterministically and verify the contracts on etherscan using [Solidity 0.7.6](https://github.com/ethereum/solidity/releases/tag/v0.7.6) by default.
 
 Preparation:
+
 - Set `MNEMONIC` in `.env`
 - Set `INFURA_KEY` in `.env`
 
@@ -82,32 +84,34 @@ Note: Address will vary if contract code is changed or a different Solidity vers
 
 #### Replay protection ([EIP-155](https://eips.ethereum.org/EIPS/eip-155))
 
-Some networks require replay protection, making it incompatible with the default deployment process as it relies on a presigned transaction without replay protection (see https://github.com/Arachnid/deterministic-deployment-proxy).
+Some networks require replay protection, making it incompatible with the default deployment process as it relies on a presigned transaction without replay protection (see <https://github.com/Arachnid/deterministic-deployment-proxy>).
 
-Safe Smart Account contracts use a different deterministic deployment proxy (https://github.com/safe-global/safe-singleton-factory). To make sure that the latest version of this package is installed, run `npm i --save-dev @safe-global/safe-singleton-factory` before deployment. For more information, including deploying the factory to a new network, please refer to the factory repo.
+Safe Smart Account contracts use a different deterministic deployment proxy (<https://github.com/safe-global/safe-singleton-factory>). To make sure that the latest version of this package is installed, run `npm i --save-dev @safe-global/safe-singleton-factory` before deployment. For more information, including deploying the factory to a new network, please refer to the factory repository.
 
 Note: This will result in different addresses compared to hardhat's default deterministic deployment process.
 
 ### Verify contract
 
 This command will use the deployment artifacts to compile the contracts and compare them to the onchain code
+
 ```bash
 npx hardhat --network <network> local-verify
 ```
 
 This command will upload the contract source to Etherscan
+
 ```bash
 npx hardhat --network <network> etherscan-verify
 ```
 
-Documentation
--------------
+## Documentation
+
 - [Safe developer portal](http://docs.safe.global)
 - [Error codes](docs/error_codes.md)
 - [Coding guidelines](docs/guidelines.md)
 
-Audits/ Formal Verification
----------
+## Audits and Formal Verification
+
 - [for Version 1.5.0 by Certora & Ackee](docs/audit_1_5_0.md)
 - [for Version 1.4.0/1.4.1 by Ackee Blockchain](docs/audit_1_4_0.md)
 - [for Version 1.3.0 by G0 Group](docs/audit_1_3_0.md)
@@ -116,10 +120,10 @@ Audits/ Formal Verification
 - [for Version 1.0.0 by Runtime Verification](docs/rv_1_0_0.md)
 - [for Version 0.0.1 by Alexey Akhunov](docs/alexey_audit.md)
 
-Security and Liability
-----------------------
+## Security and Liability
+
 All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-License
--------
+## License
+
 All smart contracts are released under LGPL-3.0

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@safe-global/safe-smart-account",
-    "version": "1.4.1-build.0",
+    "version": "1.5.0",
     "description": "Ethereum multisig contract",
     "homepage": "https://github.com/safe-global/safe-smart-account/",
     "license": "LGPL-3.0",