Added AI generated docs as base

Author: phpcoinn

docs/api/api-reference.md

@@ -0,0 +1,292 @@
+# API Reference
+
+The PHPcoin API provides a set of endpoints for interacting with the blockchain. The API is accessible via HTTP and returns data in JSON format.
+
+## Accounts
+
+### getAddress
+
+Converts a public key to a PHPcoin address.
+
+*   **URL:** `/api.php?q=getAddress`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `public_key` (string, required): The public key to convert.
+*   **Example:**
+    ```
+    /api.php?q=getAddress&public_key=...
+    ```
+
+### getBalance
+
+Returns the balance of a specific address.
+
+*   **URL:** `/api.php?q=getBalance`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address to check.
+*   **Example:**
+    ```
+    /api.php?q=getBalance&address=...
+    ```
+
+### getPendingBalance
+
+Returns the pending balance of a specific address, which includes unconfirmed transactions.
+
+*   **URL:** `/api.php?q=getPendingBalance`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address to check.
+*   **Example:**
+    ```
+    /api.php?q=getPendingBalance&address=...
+    ```
+
+### getPublicKey
+
+Returns the public key of a specific address.
+
+*   **URL:** `/api.php?q=getPublicKey`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address to check.
+*   **Example:**
+    ```
+    /api.php?q=getPublicKey&address=...
+    ```
+
+### generateAccount
+
+Generates a new PHPcoin account.
+
+*   **URL:** `/api.php?q=generateAccount`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=generateAccount
+    ```
+
+## Transactions
+
+### getTransactions
+
+Returns the latest transactions for a specific address.
+
+*   **URL:** `/api.php?q=getTransactions`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address to check.
+    *   `limit` (integer, optional): The maximum number of transactions to return.
+    *   `offset` (integer, optional): The offset to start from.
+*   **Example:**
+    ```
+    /api.php?q=getTransactions&address=...&limit=10
+    ```
+
+### getTransaction
+
+Returns a specific transaction by its ID.
+
+*   **URL:** `/api.php?q=getTransaction`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `transaction` (string, required): The ID of the transaction.
+*   **Example:**
+    ```
+    /api.php?q=getTransaction&transaction=...
+    ```
+
+### send
+
+Sends a transaction to the network.
+
+*   **URL:** `/api.php?q=send`
+*   **Method:** `POST`
+*   **Parameters:**
+    *   `val` (float, required): The amount to send.
+    *   `dst` (string, required): The destination address.
+    *   `public_key` (string, required): The sender's public key.
+    *   `signature` (string, required): The transaction signature.
+    *   `date` (integer, required): The transaction date (Unix timestamp).
+    *   `message` (string, optional): A message to include with the transaction.
+*   **Example:**
+    ```json
+    {
+      "val": 10.0,
+      "dst": "...",
+      "public_key": "...",
+      "signature": "...",
+      "date": 1678886400,
+      "message": "Hello, world!"
+    }
+    ```
+
+## Blocks
+
+### currentBlock
+
+Returns the current block.
+
+*   **URL:** `/api.php?q=currentBlock`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=currentBlock
+    ```
+
+### getBlock
+
+Returns a specific block by its height.
+
+*   **URL:** `/api.php?q=getBlock`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `height` (integer, required): The height of the block.
+*   **Example:**
+    ```
+    /api.php?q=getBlock&height=12345
+    ```
+
+### getBlockTransactions
+
+Returns the transactions of a specific block.
+
+*   **URL:** `/api.php?q=getBlockTransactions`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `height` (integer, required): The height of the block.
+*   **Example:**
+    ```
+    /api.php?q=getBlockTransactions&height=12345
+    ```
+
+## Node
+
+### version
+
+Returns the version of the node.
+
+*   **URL:** `/api.php?q=version`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=version
+    ```
+
+### mempoolSize
+
+Returns the number of transactions in the mempool.
+
+*   **URL:** `/api.php?q=mempoolSize`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=mempoolSize
+    ```
+
+### nodeInfo
+
+Returns information about the node.
+
+*   **URL:** `/api.php?q=nodeInfo`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=nodeInfo
+    ```
+
+### getPeers
+
+Returns a list of the node's peers.
+
+*   **URL:** `/api.php?q=getPeers`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=getPeers
+    ```
+
+## Masternodes
+
+### getMasternodes
+
+Returns a list of all masternodes.
+
+*   **URL:** `/api.php?q=getMasternodes`
+*   **Method:** `GET`
+*   **Example:**
+    ```
+    /api.php?q=getMasternodes
+    ```
+
+### getMasternode
+
+Returns a specific masternode by its address.
+
+*   **URL:** `/api.php?q=getMasternode`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address of the masternode.
+*   **Example:**
+    ```
+    /api.php?q=getMasternode&address=...
+    ```
+
+## Smart Contracts
+
+### getSmartContract
+
+Returns a specific smart contract by its address.
+
+*   **URL:** `/api.php?q=getSmartContract`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address of the smart contract.
+*   **Example:**
+    ```
+    /api.php?q=getSmartContract&address=...
+    ```
+
+### getSmartContractProperty
+
+Reads a property of a smart contract.
+
+*   **URL:** `/api.php?q=getSmartContractProperty`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address of the smart contract.
+    *   `property` (string, required): The name of the property to read.
+    *   `key` (string, optional): The key of the property, if it's a map.
+*   **Example:**
+    ```
+    /api.php?q=getSmartContractProperty&address=...&property=myProperty&key=myKey
+    ```
+
+### getSmartContractInterface
+
+Returns the interface of a smart contract.
+
+*   **URL:** `/api.php?q=getSmartContractInterface`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address of the smart contract.
+*   **Example:**
+    ```
+    /api.php?q=getSmartContractInterface&address=...
+    ```
+
+### getSmartContractView
+
+Executes a view method of a smart contract.
+
+*   **URL:** `/api.php?q=getSmartContractView`
+*   **Method:** `GET`
+*   **Parameters:**
+    *   `address` (string, required): The address of the smart contract.
+    *   `method` (string, required): The name of the view method to execute.
+    *   `params` (string, optional): The parameters for the method, as a base64-encoded JSON string.
+*   **Example:**
+    ```
+    /api.php?q=getSmartContractView&address=...&method=myMethod&params=...
+    ```

docs/dapps/developing-dapps.md

@@ -0,0 +1,21 @@
+# Developing Dapps
+
+A Decentralized Application (Dapp) on PHPcoin is a web application that interacts with the PHPcoin blockchain. Dapps can be built using standard web technologies like PHP, HTML, and JavaScript.
+
+## Dapp Structure
+
+A Dapp is typically structured as a web page that is served by a web server. The Dapp's frontend is built with HTML and JavaScript, and it interacts with a PHPcoin node's API to get information from the blockchain and to send transactions.
+
+The backend of a Dapp can be written in any language, but PHP is a natural choice for PHPcoin Dapps. The backend can be used to perform more complex operations, such as interacting with a database or calling external APIs.
+
+## Interacting with the Blockchain
+
+Dapps interact with the PHPcoin blockchain by making calls to a node's API. The API provides a set of endpoints for getting information about the blockchain, sending transactions, and interacting with smart contracts.
+
+You can use any HTTP client to make calls to the API. In PHP, you can use the `file_get_contents()` function or the cURL library. In JavaScript, you can use the `fetch()` API or a library like Axios.
+
+## Example Dapp
+
+The `dapps/demo` directory contains a simple example Dapp that visualizes the PHPcoin network topology. This Dapp is a good starting point for learning how to develop Dapps on PHPcoin.
+
+The Dapp's frontend is built with HTML and JavaScript, and it uses the `vivagraph.js` and `go.js` libraries to visualize the network graph. The Dapp's backend is written in PHP, and it uses the `file_get_contents()` function to call the node's API and get information about the network.

docs/getting-started/installation.md

@@ -0,0 +1,38 @@
+# Installation
+
+This guide will walk you through the process of installing a PHPcoin node on a Debian-based system (e.g., Ubuntu). The easiest way to install PHPcoin is by using the provided installation script, which automates the entire process.
+
+## Prerequisites
+
+Before you begin, you will need:
+
+*   A server running a Debian-based Linux distribution (e.g., Ubuntu 20.04, 22.04).
+*   Root or `sudo` privileges on the server.
+
+## Quick Installation
+
+The following one-liner command will download and execute the installation script, setting up a PHPcoin node for the **mainnet**:
+
+```bash
+curl -s https://phpcoin.net/scripts/install_node.sh | bash
+```
+
+To install a node for the **testnet**, use the following command:
+
+```bash
+curl -s https://phpcoin.net/scripts/install_node.sh | bash -s -- --network testnet
+```
+
+## What the Script Does
+
+The installation script performs the following steps:
+
+1.  **Updates System:** Updates the package manager and installs essential packages, including Nginx, PHP, and MariaDB.
+2.  **Creates Database:** Sets up a new database and user for the PHPcoin node.
+3.  **Downloads Node:** Clones the latest version of the PHPcoin source code from the official Git repository.
+4.  **Configures Web Server:** Configures Nginx to serve the PHPcoin web interface.
+5.  **Initializes Configuration:** Creates the necessary configuration files for the node.
+6.  **Imports Blockchain:** Downloads and imports a recent snapshot of the blockchain to accelerate the initial synchronization process.
+7.  **Starts Services:** Starts the Nginx and MariaDB services.
+
+Once the installation is complete, you can access your PHPcoin node by opening the provided URL in your web browser.

docs/getting-started/running-a-node.md

@@ -0,0 +1,41 @@
+# Running a Node
+
+Once you have installed your PHPcoin node, it will be running as a web application. You can access the web interface by navigating to the URL provided at the end of the installation process.
+
+## Web Interface
+
+The web interface provides a user-friendly way to interact with your node. It includes the following features:
+
+*   **Block Explorer:** Allows you to browse the blockchain, view blocks, and inspect transactions.
+*   **Wallet:** Provides a simple and secure way to manage your PHPcoin wallet, send and receive coins, and view your transaction history.
+*   **Network Information:** Displays information about the current state of the network, including the number of connected peers and the current block height.
+
+## Command-Line Interface (CLI)
+
+In addition to the web interface, PHPcoin provides a command-line interface (CLI) for more advanced users. The CLI scripts are located in the `cli/` directory and can be used to perform various tasks, such as:
+
+*   **Running the P2P Server:** The `server.php` script is used to run the node's peer-to-peer (P2P) server, which is responsible for communicating with other nodes on the network. To run the server, execute the following command from the root of your PHPcoin installation:
+
+    ```bash
+    php cli/server.php
+    ```
+
+*   **Synchronizing the Blockchain:** The `sync.php` script is used to manually trigger the synchronization of the blockchain. This is useful if your node has been offline for a while and needs to catch up with the rest of the network.
+
+    ```bash
+    php cli/sync.php
+    ```
+
+*   **Running Cron Jobs:** The `cron.php` script is designed to be run periodically to perform maintenance tasks, such as cleaning up old data and updating the list of peers.
+
+    ```bash
+    php cli/cron.php
+    ```
+
+*   **Mining:** The `miner.php` script can be used to mine PHPcoin from the command line.
+
+    ```bash
+    php cli/miner.php
+    ```
+
+For most users, the web interface will be sufficient for interacting with the PHPcoin network. However, the CLI provides a powerful set of tools for those who want more control over their node.