@btc-vision/btc-runtime 1.10.8 → 1.10.11

package/LICENSE

@@ -0,0 +1,190 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Orange Pill Labs Holding Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -9,192 +9,313 @@
 
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
-## Table of Contents
-
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Core Concepts](#core-concepts)
-    - [Blockchain Environment](#blockchain-environment)
-    - [Contracts](#contracts)
-    - [Events](#events)
-    - [Pointers and Storage Management](#pointers-and-storage-management)
-4. [Usage Examples](#usage-examples)
-5. [Advanced Topics](#advanced-topics)
-6. [Additional Documentation](#additional-documentation)
-7. [License](#license)
-
-## Introduction
-
-The OPNet Smart Contract Runtime provides the foundational components required for creating smart contracts on Bitcoin
-Layer 1 (L1). Written in AssemblyScript, this runtime allows developers to leverage WebAssembly for efficient contract
-execution while integrating deeply with Bitcoin's decentralized architecture.
-
-### Features
-
-- **AssemblyScript and WebAssembly:** Efficient and high-performance contract execution using WebAssembly.
-- **Bitcoin Integration:** Direct interaction with Bitcoin L1, enabling the creation of decentralized applications that
-  operate on the Bitcoin network.
-- **Comprehensive Storage Management:** Flexible and secure storage management using primary pointers and sub-pointers,
-  ensuring data integrity through cryptographic proofs.
-- **Event Handling:** Sophisticated event system for contract state changes, allowing easy tracking and logging of
-  contract activities.
+## Overview
+
+The **OPNet Smart Contract Runtime** is the foundational framework for building decentralized applications directly on
+Bitcoin Layer 1 (L1). Written in AssemblyScript and compiled to WebAssembly, btc-runtime enables developers to create,
+deploy, and execute smart contracts on the Bitcoin network with the same expressiveness as Ethereum's Solidity.
+
+Unlike Bitcoin Layer 2 solutions, OPNet operates directly on Bitcoin's base layer, inheriting Bitcoin's security
+guarantees and decentralization properties while adding programmable smart contract capabilities.
+
+> **What is OPNet?**
+>
+> OPNet (Open Protocol Network) is a consensus-layer built on Bitcoin L1. It allows developers to write smart
+> contracts in AssemblyScript or similar that compile to WebAssembly (WASM) and execute deterministically across all
+> network nodes. Think of it as "Solidity for Bitcoin" - you get the programmability of Ethereum with the security of
+> Bitcoin.
+
+> **Why AssemblyScript?**
+>
+> AssemblyScript compiles to WebAssembly, which provides:
+> - **Deterministic execution** across all platforms and nodes
+> - **Near-native performance** for compute-intensive operations
+> - **Memory safety** through WASM's sandboxed environment
+> - **Familiar syntax** for TypeScript/JavaScript developers
+
+> **IMPORTANT: Floating-Point Arithmetic is Prohibited**
+>
+> Floating-point arithmetic (`f32`, `f64`) is **strictly prohibited** in blockchain and smart contract environments.
+> Floating-point operations are **non-deterministic** across different CPU architectures, compilers, and platforms due
+> to differences in rounding, precision, and IEEE 754 implementation details.
+>
+> **Always use integer arithmetic** (`u128`, `u256`) for all blockchain computations. For decimal values, use
+> fixed-point representation (e.g., store currency as smallest units like satoshis). This library provides full support
+> for 128-bit and 256-bit integer operations through [@btc-vision/as-bignum](https://github.com/btc-vision/as-bignum).
+
+## Security Audit
+
+<p align="center">
+  <a href="https://verichains.io">
+    <img src="https://raw.githubusercontent.com/btc-vision/contract-logo/refs/heads/main/public-assets/verichains.png" alt="Verichains" width="300"/>
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://verichains.io">
+    <img src="https://img.shields.io/badge/Security%20Audit-Verichains-4C35E0?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNMTIgMkw0IDV2Ni41YzAgNS4yNSAzLjQgMTAuMiA4IDExLjUgNC42LTEuMyA4LTYuMjUgOC0xMS41VjVsLTgtM3ptMCAxMC45OVYxOS41Yy0zLjQ1LTEuMTctNS45My00LjgtNi02LjVWNi4zTDEyIDRsMCA4Ljk5eiIgZmlsbD0id2hpdGUiLz48L3N2Zz4=" alt="Audited by Verichains"/>
+  </a>
+  <a href="./SECURITY.md">
+    <img src="https://img.shields.io/badge/Security-Report-22C55E?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNOSAxNi4xN0w0LjgzIDEybC0xLjQyIDEuNDFMOSAxOSAyMSA3bC0xLjQxLTEuNDFMOSAxNi4xN3oiIGZpbGw9IndoaXRlIi8+PC9zdmc+" alt="Security Report"/>
+  </a>
+</p>
+
+This runtime has been professionally audited by [**Verichains**](https://verichains.io), a leading blockchain security
+firm. The audit covered all core components including contract standards (OP20, OP721), storage systems, cryptographic
+operations, and security mechanisms.
+
+For full details, see [SECURITY.md](./SECURITY.md).
+
+## Features
+
+| Feature                      | Description                                                      |
+|------------------------------|------------------------------------------------------------------|
+| **Contract Standards**       | OP20 (fungible tokens), OP721 (NFTs), OP20S (gasless signatures) |
+| **Storage System**           | Pointer-based persistent storage with SHA256 key hashing         |
+| **SafeMath**                 | Overflow/underflow protection for all arithmetic operations      |
+| **Reentrancy Protection**    | Built-in guards with STANDARD and CALLBACK modes                 |
+| **Cryptographic Operations** | Schnorr signatures, ML-DSA (quantum-resistant), SHA256           |
+| **Bitcoin Integration**      | Transaction parsing, address validation, script building         |
+| **Event System**             | 352-byte events for state change notifications                   |
+| **Cross-Contract Calls**     | Inter-contract communication with configurable failure handling  |
 
 ## Installation
 
-1. Clone the repository:
-    ```bash
-    git clone https://github.com/btc-vision/btc-runtime.git
-    ```
-2. Navigate to the repository directory:
-    ```bash
-    cd btc-runtime
-    ```
-3. Install the necessary dependencies:
-    ```bash
-    npm install
-    ```
-
-## Core Concepts
-
-### Blockchain Environment
-
-The `Blockchain` object environment is the backbone of the OPNet runtime, providing essential functionality for
-interacting with the blockchain, such as managing contract states, handling transactions, and emitting events.
-
-For more detailed information, see the [Blockchain.md](docs/Blockchain.md) documentation.
-
-### Contracts
-
-Contracts in OPNet are AssemblyScript classes that extend the `OP_NET` base class. The constructor pattern differs from
-Solidity's, as it runs every time a contract is instantiated, so developers should not use the constructor for
-persistent initialization.
-
-For a detailed guide on how to structure contracts, refer to the [Contract.md](docs/Contract.md) documentation.
-
-### Events
-
-Events in OPNet allow contracts to emit signals that external observers can listen to. They are crucial for tracking
-state changes and interactions within the contract.
-
-For a comprehensive explanation on how to define and use events, refer to the [Events.md](docs/Events.md) documentation.
-
-### Pointers and Storage Management
-
-Storage in OPNet is managed using a combination of pointers (`u16`) and sub-pointers (`u256`). These are encoded and
-hashed to generate unique storage locations that are secure and verifiable. This approach ensures that the data stored
-is tamper-proof and can be efficiently accessed.
-
-For more details on pointers and storage management, see the [Pointers.md](docs/Pointers.md)
-and [Storage.md](docs/Storage.md) documentation.
+```bash
+npm install @btc-vision/btc-runtime
+```
 
-## Usage Examples
+## Quick Start
 
-### Creating a Basic Token Contract
+### Your First Contract
 
-Here is a real-world example of how to create a basic token contract using the OPNet Smart Contract Runtime. This
-contract follows the OP20 standard.
+Here's a minimal OP20 token contract to get you started:
 
 ```typescript
 import { u256 } from '@btc-vision/as-bignum/assembly';
 import {
-    Address,
-    AddressMap,
     Blockchain,
     BytesWriter,
     Calldata,
     OP20,
     OP20InitParameters,
-    SafeMath,
 } from '@btc-vision/btc-runtime/runtime';
 
 @final
 export class MyToken extends OP20 {
     public constructor() {
         super();
-
-        // IMPORTANT. THIS WILL RUN EVERYTIME THE CONTRACT IS INTERACTED WITH. FOR SPECIFIC INITIALIZATION, USE "onDeployment" METHOD.
+        // NOTE: Constructor runs on EVERY interaction, not just deployment!
     }
 
-    // "solidityLikeConstructor" This is a solidity-like constructor. This method will only run once when the contract is deployed.
+    // This runs ONCE when the contract is deployed (like Solidity's constructor)
     public override onDeployment(_calldata: Calldata): void {
-        const maxSupply: u256 = u256.fromString('1000000000000000000000000000'); // Your max supply. (Here, 1 billion tokens)
-        const decimals: u8 = 18; // Your decimals.
-        const name: string = 'Test'; // Your token name.
-        const symbol: string = 'TEST'; // Your token symbol.
+        const maxSupply: u256 = u256.fromString('1000000000000000000000000'); // 1 million tokens
+        const decimals: u8 = 18;
+        const name: string = 'MyToken';
+        const symbol: string = 'MTK';
 
         this.instantiate(new OP20InitParameters(maxSupply, decimals, name, symbol));
 
-        // Add your logic here. Eg, minting the initial supply:
-        // this._mint(Blockchain.tx.origin, maxSupply);
+        // Mint initial supply to deployer
+        this._mint(Blockchain.tx.origin, maxSupply);
     }
 
-    @method(
-        {
-            name: 'address',
-            type: ABIDataTypes.ADDRESS,
-        },
-        {
-            name: 'amount',
-            type: ABIDataTypes.UINT256,
-        },
-    )
-    @emit('Minted')
+    // Custom mint function (deployer only)
     public mint(calldata: Calldata): BytesWriter {
         this.onlyDeployer(Blockchain.tx.sender);
-        this._mint(calldata.readAddress(), calldata.readU256());
+
+        const to = calldata.readAddress();
+        const amount = calldata.readU256();
+        this._mint(to, amount);
+
         return new BytesWriter(0);
     }
+}
+```
 
-    /**
-     * Mints tokens to the specified addresses.
-     *
-     * @param calldata Calldata containing an `AddressMap<Address, u256>` to mint to.
-     */
-    @method({
-        name: 'addressAndAmount',
-        type: ABIDataTypes.ADDRESS_UINT256_TUPLE,
-    })
-    @emit('Minted')
-    public airdrop(calldata: Calldata): BytesWriter {
-        this.onlyDeployer(Blockchain.tx.sender);
+### Solidity Comparison
 
-        const addressAndAmount: AddressMap<u256> = calldata.readAddressMapU256();
-        const addresses: Address[] = addressAndAmount.keys();
+If you're coming from Solidity/EVM development, here's how OPNet concepts map:
 
-        let totalAirdropped: u256 = u256.Zero;
+| Solidity/EVM                | OPNet/btc-runtime                         | Notes                       |
+|-----------------------------|-------------------------------------------|-----------------------------|
+| `contract MyContract`       | `class MyContract extends OP_NET`         | Base class inheritance      |
+| `constructor()`             | `onDeployment(calldata)`                  | Runs once at deployment     |
+| `msg.sender`                | `Blockchain.tx.sender`                    | Immediate caller            |
+| `tx.origin`                 | `Blockchain.tx.origin`                    | Original transaction signer |
+| `block.number`              | `Blockchain.block.number`                 | Current block height        |
+| `mapping(address => uint)`  | `AddressMemoryMap` + `StoredU256`         | Pointer-based storage       |
+| `emit Transfer(...)`        | `this.emitEvent(new TransferEvent(...))`  | Event emission              |
+| `ERC20`                     | `OP20`                                    | Fungible token standard     |
+| `ERC721`                    | `OP721`                                   | Non-fungible token standard |
+| `uint256`                   | `u256`                                    | 256-bit unsigned integer    |
+| `require(condition, "msg")` | `if (!condition) throw new Revert("msg")` | Error handling              |
+| `modifier onlyOwner`        | `this.onlyDeployer(sender)`               | Access control              |
 
-        for (let i: i32 = 0; i < addresses.length; i++) {
-            const address = addresses[i];
-            const amount = addressAndAmount.get(address);
+## Documentation
 
-            const currentBalance: u256 = this.balanceOfMap.get(address);
+Comprehensive documentation is available in the [docs/](./docs/) directory:
 
-            if (currentBalance) {
-                this.balanceOfMap.set(address, SafeMath.add(currentBalance, amount));
-            } else {
-                this.balanceOfMap.set(address, amount);
-            }
+### Getting Started
 
-            totalAirdropped = SafeMath.add(totalAirdropped, amount);
+- [Installation](./docs/getting-started/installation.md) - Setup and configuration
+- [First Contract](./docs/getting-started/first-contract.md) - Step-by-step tutorial
+- [Project Structure](./docs/getting-started/project-structure.md) - Directory layout
 
-            this.createMintedEvent(address, amount);
-        }
+### Core Concepts
 
-        this._totalSupply.set(SafeMath.add(this._totalSupply.value, totalAirdropped));
+- [Blockchain Environment](./docs/core-concepts/blockchain-environment.md) - Runtime context
+- [Storage System](./docs/core-concepts/storage-system.md) - How data persistence works
+- [Pointers](./docs/core-concepts/pointers.md) - Storage key management
+- [Events](./docs/core-concepts/events.md) - State change notifications
+- [Security](./docs/core-concepts/security.md) - Protection mechanisms
 
-        return new BytesWriter(0);
+### Contract Standards
+
+- [OP_NET Base](./docs/contracts/op-net-base.md) - Abstract contract class
+- [OP20 Token](./docs/contracts/op20-token.md) - Fungible token standard
+- [OP20S Signatures](./docs/contracts/op20s-signatures.md) - Gasless approvals
+- [OP721 NFT](./docs/contracts/op721-nft.md) - Non-fungible tokens
+- [ReentrancyGuard](./docs/contracts/reentrancy-guard.md) - Reentrancy protection
+
+### Types & Utilities
+
+- [Address](./docs/types/address.md) - 32-byte address handling
+- [SafeMath](./docs/types/safe-math.md) - Overflow-safe arithmetic
+- [Calldata](./docs/types/calldata.md) - Input parsing
+- [BytesWriter/Reader](./docs/types/bytes-writer-reader.md) - Serialization
+
+### Storage Types
+
+- [Stored Primitives](./docs/storage/stored-primitives.md) - Basic value storage
+- [Stored Arrays](./docs/storage/stored-arrays.md) - Array storage
+- [Stored Maps](./docs/storage/stored-maps.md) - Key-value storage
+- [Memory Maps](./docs/storage/memory-maps.md) - In-memory mappings
+
+### Advanced Topics
+
+- [Cross-Contract Calls](./docs/advanced/cross-contract-calls.md) - Inter-contract communication
+- [Signature Verification](./docs/advanced/signature-verification.md) - Cryptographic operations
+- [Quantum Resistance](./docs/advanced/quantum-resistance.md) - ML-DSA support
+- [Bitcoin Scripts](./docs/advanced/bitcoin-scripts.md) - Script building
+- [Plugins](./docs/advanced/plugins.md) - Extending functionality
+
+### Examples
+
+- [Basic Token](./docs/examples/basic-token.md) - Simple OP20 implementation
+- [NFT with Reservations](./docs/examples/nft-with-reservations.md) - Advanced NFT
+- [Stablecoin](./docs/examples/stablecoin.md) - Role-based token
+- [Oracle Integration](./docs/examples/oracle-integration.md) - Price feeds
+
+### API Reference
+
+- [Blockchain](./docs/api-reference/blockchain.md) - Environment methods
+- [OP20](./docs/api-reference/op20.md) - Token standard API
+- [OP721](./docs/api-reference/op721.md) - NFT standard API
+- [SafeMath](./docs/api-reference/safe-math.md) - Math operations
+- [Storage](./docs/api-reference/storage.md) - Storage classes
+- [Events](./docs/api-reference/events.md) - Event classes
+
+## Running Tests
+
+```bash
+# Run all tests with verbose output
+npm test
+
+# Run tests with summary only
+npm run test:ci
+```
+
+## Project Structure
+
+```
+btc-runtime/
+├── runtime/                    # Core runtime library
+│   ├── contracts/              # Contract base classes (OP_NET, OP20, OP721)
+│   ├── storage/                # Storage types (Stored*, Maps)
+│   ├── math/                   # SafeMath operations
+│   ├── types/                  # Core types (Address, Calldata)
+│   ├── events/                 # Event system
+│   └── env/                    # Blockchain environment
+├── docs/                       # Documentation
+└── tests/                      # Test suite
+```
+
+## Key Differences from Solidity
+
+### 1. Constructor Behavior
+
+```typescript
+// OPNet: Constructor runs EVERY time
+export class MyContract extends OP_NET {
+    constructor() {
+        super();
+        // DON'T put initialization here - it runs on every call!
+    }
+
+    // Use this for one-time initialization (like Solidity constructor)
+    public override onDeployment(calldata: Calldata): void {
+        // Initialize storage here
     }
 }
 ```
 
-## Advanced Topics
+### 2. Storage is Explicit
 
-### Storage Management with Cryptographic Proofs
+```typescript
+// Solidity: Implicit storage
+// mapping(address => uint256) balances;
+
+// OPNet: Explicit pointer allocation
+class Test {
+    private balancePointer: u16 = Blockchain.nextPointer;
+    private balances: AddressMemoryMap<Address, StoredU256> = new AddressMemoryMap(
+        this.balancePointer,
+        u256.Zero
+    );
+}
+```
 
-Storage pointers and sub-pointers are encoded and hashed to create unique and secure storage locations. These storage
-locations are managed using the `Blockchain` class's `setStorageAt` and `getStorageAt` methods, ensuring data integrity
-and preventing tampering.
+### 3. Integer Types
+
+```typescript
+// OPNet uses u256 from as-bignum (NOT native BigInt)
+import { u256 } from '@btc-vision/as-bignum/assembly';
+
+const a = u256.from(100);
+const b = u256.from(50);
+const sum = SafeMath.add(a, b);  // Always use SafeMath!
+```
+
+### 4. No Floating Point
+
+```typescript
+// WRONG - Non-deterministic!
+// const price: f64 = 1.5;
+
+// CORRECT - Fixed-point with integers
+const PRECISION: u256 = u256.fromU64(1_000_000); // 6 decimals
+const price: u256 = SafeMath.mul(amount, PRECISION);
+```
+
+## Contributing
+
+Contributions are welcome! Please ensure all tests pass before submitting a pull request.
+
+```bash
+npm test
+```
 
 ## License
 
-This project is licensed under the MIT License. View the full license [here](LICENSE.md).
+This project is licensed under the Apache-2.0 License. See [LICENSE](./LICENSE) for details.
+
+## Links
+
+- **Website**: [OPNet](https://opnet.org)
+- **Documentation**: [docs/](./docs/)
+- **Security**: [SECURITY.md](./SECURITY.md)
+- **GitHub**: [btc-vision/btc-runtime](https://github.com/btc-vision/btc-runtime)
+- **Issues**: [GitHub Issues](https://github.com/btc-vision/btc-runtime/issues)
+- **Auditor**: [Verichains](https://verichains.io)