draft: Final touches (closes #147, #135, #133, #132, #124, #111, #100, #92, #82, #81, #57, #54)

.editorconfig

@@ -0,0 +1,7 @@
+[root]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_size = 4
+indent_style = tab
+trim_trailing_whitespace = true

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+on:
+  push:
+    tags:
+      - "v*.*.*"
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Update changelog
+        id: changelog
+        uses: requarks/changelog-action@v1
+        with:
+          token: ${{ github.token }}
+          tag: ${{ github.ref_name }}
+
+      - name: Create release
+        uses: ncipollo/[email protected]
+        with:
+          allowUpdates: true
+          draft: false
+          makeLatest: true
+          name: ${{ github.ref_name }}
+          body: ${{ steps.changelog.outputs.changes }}
+          token: ${{ github.token }}
+
+      - name: Commit CHANGELOG.md
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          branch: master
+          commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]'
+          file_pattern: CHANGELOG.md

.github/workflows/security.yml

@@ -0,0 +1,34 @@
+name: Security
+
+on:
+  # Run on all pushes and on all pull requests.
+  push:
+  pull_request:
+  # Also run this workflow every Monday at 6:00.
+  schedule:
+    - cron: '0 6 * * 1'
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  security:
+    name: 'Security check'
+    runs-on: ubuntu-latest
+
+    # Don't run the cronjob in this workflow on forks.
+    if: github.event_name != 'schedule' || (github.event_name == 'schedule' && github.repository_owner == 'refactor-ring')
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # This action checks the `composer.lock` file against known security vulnerabilities in the dependencies.
+      # https://github.com/marketplace/actions/the-php-security-checker
+      - name: Run Security Check
+        uses: symfonycorp/security-checker-action@v5

.github/workflows/tests.yml

@@ -0,0 +1,48 @@
+name: "Unit Tests"
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+
+    env:
+      PHP_EXTENSIONS: none, bcmath, ctype, curl, dom, json, gmp, mbstring, opcache, simplexml, sockets, tokenizer, xml, xmlwriter
+      PHP_INI_VALUES: memory_limit=-1, assert.exception=1, zend.assertions=1, error_reporting=-1, log_errors_max_len=0, display_errors=On
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        php: [8.1, 8.2, 8.3]
+        dependency-version: [prefer-lowest, prefer-stable]
+
+    name: Tests PHP${{ matrix.php }} - ${{ matrix.os }} - ${{ matrix.dependency-version }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: ${{ matrix.coverage-driver }}
+          extensions: ${{ env.PHP_EXTENSIONS }}
+          ini-values: ${{ env.PHP_INI_VALUES }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install Composer dependencies
+        run: composer update --${{ matrix.dependency-version }} --no-ansi --no-interaction --no-progress --prefer-dist
+
+      - name: Run unit tests with PHPUnit
+        run: composer run test:unit

.gitignore

@@ -1,2 +1,4 @@
 vendor/
-build
+build
+.phpunit.cache
+tests/_reports

PUBLISHING.md

@@ -0,0 +1,23 @@
+# Publishing a release
+
+This document describes the process of publishing a new version of the package.
+
+1. Update the version in the `composer.json` file.
+2. Commit the changes.
+	-	```bash
+		git commit -m "chore: bump version to <version>"
+		```
+
+		Where `<version>` is the new version number (e.g. `1.2.3`).
+3. Create a new tag.
+	-	```bash
+		git tag v<version>
+		```
+
+		Where `<version>` is the new version number (e.g. `1.2.3`).
+4. Push the changes.
+	-	```bash
+		git push origin master --tags
+		```
+
+A release will automatically be created.

README.md

@@ -1,45 +1,147 @@
 [![PHPCS PSR-12](https://img.shields.io/badge/PHPCS-PSR–12-226146.svg)](https://www.php-fig.org/psr/psr-12/) [![PHPStan ](.github/phpstan.svg)](https://phpstan.org/)
 
-# Monero Library
-A Monero library written in PHP by the [Monero Integrations](https://monerointegrations.com) [team](https://github.com/monero-integrations/monerophp/graphs/contributors).
+# Monero-Crypto
 
-## How It Works
-This library has 3 main parts:
+A Monero cryptography library written in modern PHP 8 by the [Monero Integrations team](https://monerointegrations.com) and [contributors](
+https://github.com/monero-integrations/monerophp/graphs/contributors).
 
-1. A Monero daemon JSON RPC API wrapper, `daemonRPC.php`
-2. A Monero wallet (`monero-wallet-rpc`) JSON RPC API wrapper, `walletRPC.php`
-3. A Monero/Cryptonote toolbox, `cryptonote.php`, with both lower level functions used in Monero related cryptography and higher level methods for things like generating Monero private/public keys.
+## Features
 
-In addition to these features, there are other lower-level libraries included for portability, *eg.* an ed25519 library, a SHA3 library, *etc.*
+This library implements/interfaces various cryptographic functions used in Monero, such as:
+
+- Monero's base58 encoding
+- Monero's mnemonic seeds
+- Keccak hash function
+- Cryptonote functions on the Edwards25519 curve
+- Variably-sized integers (Varint)
+
+Higher-level abstractions are additionally provided for things like generating Monero private/public keys, subaddresses, etc.
 
 ## Preview
 ![Preview](https://user-images.githubusercontent.com/4107993/38056594-b6cd6e14-3291-11e8-96e2-a771b0e9cee3.png)
 
+## Getting Started
+
+The minimum PHP version required is 8.1.0. Please make sure you also have [Composer](https://getcomposer.org/) installed.
+
+You can check your PHP version by running:
+
+```bash
+php -v
+```
+
+### Extensions
+
+The `bcmath` extension is required.
+
+It is **strongly recommended** to use the `gmp` extension for about 100x faster calculations (as opposed to BCMath).
+
+To check what extensions are installed, run:
+
+```bash
+php -m
+```
+
+### Installation
+
+#### From Packagist
+
+```bash
+composer require monero-integrations/monero-crypto
+```
+
+#### From Source
+
+```bash
+git clone https://github.com/monero-integrations/monerophp.git
+cd monerophp
+composer install
+```
+
+### Usage
+
+From here, you can use the library in your PHP project. For example:
+
+```php
+require 'vendor/autoload.php';
+
+// To get a list of available mnemonic wordlists
+use MoneroIntegrations\MoneroCrypto\Mnemonic;
+$wordlists = Mnemonic::getWordsetList();
+
+echo "Available wordlists: " . implode(', ', $wordlists) . PHP_EOL;
+```
+
 ## Documentation
 
-Documentation can be found in the [`/docs`](https://github.com/sneurlax/monerophp/tree/master/docs) folder.
+Documentation is still a work-in-progress, but the library is well-documented with PHPDoc comments.
+
+Current documentation can be found in the [`/docs`](./docs/) folder.
+
+## Development
+
+The project uses several development tools to ensure code quality and consistency:
+
+1. PHP CodeSniffer: Used to check the code style against the PSR-12 standard.
+2. PHPStan: Static analysis tool to find bugs and improve code quality.
+3. PHPUnit: Testing framework for running unit tests.
+4. Laravel Pint: Code style fixer for PSR-12 compliance.
+
+### Running Tests
+
+To ensure everything is working correctly, you can run the tests and code quality checks using Composer scripts:
+
+#### Lint Code
+
+```bash
+composer lint
+```
+
+#### Test Lint
+
+Run linting on your code and test files:
+
+```bash
+composer test:lint
+```
 
-## Configuration
-### Requirements
- - Monero daemon (`monerod`)
- - Webserver with PHP, for example XMPP, Apache, or NGINX
-    - cURL PHP extension for JSON RPC API(s)
-    - GMP PHP extension for about 100x faster calculations (as opposed to BCMath)
+#### Analyze Code with PHPStan
 
-Debian (or Ubuntu) are recommended.
-
-### Getting Started
+```bash
+composer test:phpstan
+```
+
+#### Run Unit Tests
 
-1. Start the Monero daemon (`monerod`) on testnet.
 ```bash
-monerod --testnet --detach
+composer test:unit
 ```
 
-2. Start the Monero wallet RPC interface (`monero-wallet-rpc`) on testnet.
+#### Run All Tests and Checks
+
+This will run linting, PHPStan analysis, and unit tests:
+
 ```bash
-monero-wallet-rpc --testnet --rpc-bind-port 28083 --disable-rpc-login --wallet-dir /path/to/wallet/directory
+composer test
 ```
 
-3. Edit `example.php` with your the IP address of `monerod` and `monero-wallet-rpc` (use `127.0.0.1:28081` and `127.0.0.1:28083`, respectively, for testnet.)
+### Standards
+
+We follow the PSR-12 coding standard. Please make sure your code adheres to these guidelines. You can use Laravel Pint to automatically fix code style issues.
+
+### Contributions
+
+We welcome contributions! If you have an idea or fix, please follow these steps:
+
+1. Fork the repository
+2. Create a branch with your changes
+3. Make your changes
+4. Submit a pull request (PR) with a clear description of the changes
+
+Please ensure your code passes all tests and adheres to our coding standards before submitting a pull request.
+
+For any questions or issues, feel free to reach out to the maintainers or open an issue on GitHub.
+
+## License
 
-4. Serve `example.php` with your webserver (*eg.* XMPP, Apache/Apache2, NGINX, *etc.*) and navigate to it.  If everything has been set up correctly, information from your Monero daemon and wallet will be displayed.
+This library is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more information.