@btc-vision/btc-runtime 1.11.0-rc.9 → 1.11.0

package/docs/examples/stablecoin.md

@@ -85,7 +85,7 @@ modifier onlyRole(bytes32 role) {
     _;
 }
 
-// OPNet - Bit flags for efficiency
+// OP_NET - Bit flags for efficiency
 enum Role { ADMIN = 1, MINTER = 2, PAUSER = 4, BLACKLISTER = 8 }
 
 public hasRole(account: Address, role: u256): bool {
@@ -208,7 +208,7 @@ function pause() external onlyRole(PAUSER_ROLE) {
     _pause();
 }
 
-// OPNet
+// OP_NET
 private whenNotPaused(): void {
     if (this._paused.value) {
         throw new Revert('Pausable: paused');
@@ -979,11 +979,11 @@ contract Stablecoin is ERC20, ERC20Pausable, AccessControl {
 }
 ```
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Key Differences Table
 
-| Aspect | Solidity (OpenZeppelin) | OPNet |
+| Aspect | Solidity (OpenZeppelin) | OP_NET |
 |--------|------------------------|-------|
 | **Access Control** | `AccessControl` with `bytes32` role hashes | Bit flags in `u256` with enum |
 | **Role Definition** | `keccak256("MINTER_ROLE")` | `enum Role { MINTER = 2 }` (powers of 2) |
@@ -1017,7 +1017,7 @@ function grantRole(bytes32 role, address account) public onlyRole(getRoleAdmin(r
 }
 ```
 
-**OPNet (Bit Flag System):**
+**OP_NET (Bit Flag System):**
 ```typescript
 // Roles as bit flags (powers of 2)
 enum Role {
@@ -1063,7 +1063,7 @@ contract MyToken is ERC20Pausable {
 }
 ```
 
-**OPNet (Manual Implementation):**
+**OP_NET (Manual Implementation):**
 ```typescript
 private _paused: StoredBoolean;
 
@@ -1106,7 +1106,7 @@ function blacklist(address account) external onlyRole(BLACKLISTER_ROLE) {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 private _blacklist: AddressMemoryMap;
 
@@ -1129,7 +1129,7 @@ public blacklist(calldata: Calldata): BytesWriter {
 }
 ```
 
-### Advantages of OPNet Approach
+### Advantages of OP_NET Approach
 
 | Feature | Benefit |
 |---------|---------|
@@ -1142,7 +1142,7 @@ public blacklist(calldata: Calldata): BytesWriter {
 
 ### Minter Allowance Pattern (USDC-style)
 
-Both implementations support minter allowances, but OPNet makes this a first-class feature:
+Both implementations support minter allowances, but OP_NET makes this a first-class feature:
 
 **Solidity:**
 ```solidity
@@ -1155,7 +1155,7 @@ function mint(address to, uint256 amount) external onlyRole(MINTER_ROLE) {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 private _minterAllowance: AddressMemoryMap;
 

package/docs/getting-started/first-contract.md

@@ -1,6 +1,6 @@
 # Your First Contract
 
-This tutorial guides you through creating a complete OP20 token contract from scratch. By the end, you'll understand the core concepts of OPNet smart contract development.
+This tutorial guides you through creating a complete OP20 token contract from scratch. By the end, you'll understand the core concepts of OP_NET smart contract development.
 
 ## What We're Building
 
@@ -59,7 +59,7 @@ Let's break this down piece by piece.
 
 ## Contract Lifecycle Overview
 
-This diagram illustrates the complete lifecycle of an OPNet smart contract from deployment to execution:
+This diagram illustrates the complete lifecycle of an OP_NET smart contract from deployment to execution:
 
 ```mermaid
 ---
@@ -163,10 +163,10 @@ public constructor() {
 }
 ```
 
-**IMPORTANT:** In OPNet, the constructor runs on **every** contract interaction, not just deployment. This is different from Solidity!
+**IMPORTANT:** In OP_NET, the constructor runs on **every** contract interaction, not just deployment. This is different from Solidity!
 
 ```typescript
-// OPNet                           // Solidity
+// OP_NET                           // Solidity
 public constructor() {             // constructor() {
     super();                       //     // Runs ONCE at deployment
     // Runs EVERY time!            // }
@@ -302,7 +302,7 @@ function mint(address to, uint256 amount) external onlyOwner {
 
 ### u256 - Big Numbers
 
-OPNet uses `u256` for large numbers (like balances):
+OP_NET uses `u256` for large numbers (like balances):
 
 ```typescript
 import { u256 } from '@btc-vision/as-bignum/assembly';
@@ -318,7 +318,7 @@ const c = u256.fromString('99999999999999'); // From string (large numbers)
 
 **Why not native numbers?**
 
-| JavaScript/TypeScript | AssemblyScript/OPNet |
+| JavaScript/TypeScript | AssemblyScript/OP_NET |
 |----------------------|----------------------|
 | `number` (64-bit float) | Non-deterministic! |
 | `BigInt` | Not supported in WASM |
@@ -326,7 +326,7 @@ const c = u256.fromString('99999999999999'); // From string (large numbers)
 
 ### Address
 
-Addresses are 32 bytes in OPNet:
+Addresses are 32 bytes in OP_NET:
 
 ```typescript
 import { Address, Blockchain } from '@btc-vision/btc-runtime/runtime';
@@ -423,7 +423,7 @@ Here's a side-by-side comparison of the complete contract:
 
 <table>
 <tr>
-<th>OPNet (AssemblyScript)</th>
+<th>OP_NET (AssemblyScript)</th>
 <th>Solidity</th>
 </tr>
 <tr>

package/docs/getting-started/installation.md

@@ -1,6 +1,6 @@
 # Installation
 
-This guide walks you through setting up your development environment for building OPNet smart contracts.
+This guide walks you through setting up your development environment for building OP_NET smart contracts.
 
 ## Quick Start - Clone Example Project
 
@@ -331,7 +331,7 @@ And add a build script to `package.json`:
 |---------|---------|---------|
 | `@btc-vision/btc-runtime` | ^1.10.8 | Core runtime - contracts, storage, events |
 | `@btc-vision/as-bignum` | ^0.0.6 | 128-bit and 256-bit integer types |
-| `@btc-vision/opnet-transform` | ^0.1.12 | AssemblyScript transform for OPNet |
+| `@btc-vision/opnet-transform` | ^0.1.12 | AssemblyScript transform for OP_NET |
 | `assemblyscript` | ^0.28.9 | AssemblyScript compiler |
 
 ## Troubleshooting

package/docs/getting-started/project-structure.md

@@ -1,6 +1,6 @@
 # Project Structure
 
-This guide explains the standard project structure for OPNet smart contract development and how the btc-runtime library is organized.
+This guide explains the standard project structure for OP_NET smart contract development and how the btc-runtime library is organized.
 
 ## Your Project Structure
 
@@ -72,7 +72,7 @@ graph LR
     TOKEN -.->|"tested by"| SPEC
 ```
 
-A typical OPNet contract project looks like this:
+A typical OP_NET contract project looks like this:
 
 ```
 my-opnet-project/
@@ -168,8 +168,8 @@ AssemblyScript compiler configuration with per-contract targets:
 | `use` | Links custom abort function for error handling |
 | `optimizeLevel` | Optimization level (0-3), higher = faster but larger |
 | `shrinkLevel` | Code size reduction (0-2) |
-| `transform` | OPNet transform for decorator processing |
-| `runtime: "stub"` | Minimal runtime (OPNet provides its own) |
+| `transform` | OP_NET transform for decorator processing |
+| `runtime: "stub"` | Minimal runtime (OP_NET provides its own) |
 
 ### package.json Scripts
 
@@ -384,7 +384,7 @@ import {
 
 ### Storage Pointer System
 
-This diagram illustrates how OPNet manages persistent storage using pointers:
+This diagram illustrates how OP_NET manages persistent storage using pointers:
 
 ```mermaid
 ---
@@ -529,7 +529,7 @@ export class MyToken extends Pausable {
 
 ## Comparison with Solidity Projects
 
-| Solidity | OPNet | Notes |
+| Solidity | OP_NET | Notes |
 |----------|-------|-------|
 | `contracts/` | `src/token/`, `src/nft/` | Contract source files (one folder per contract) |
 | `interfaces/` | `src/shared/` | Type definitions and shared logic |

package/docs/storage/memory-maps.md

@@ -145,11 +145,11 @@ flowchart LR
     H --> I
 ```
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Quick Reference Table
 
-| Solidity | OPNet AddressMemoryMap |
+| Solidity | OP_NET AddressMemoryMap |
 |----------|------------------------|
 | `mapping(address => uint256)` | `AddressMemoryMap` |
 | `balances[addr]` | `balances.get(addr)` |
@@ -161,7 +161,7 @@ flowchart LR
 
 ### Operations Comparison
 
-| Operation | Solidity | OPNet |
+| Operation | Solidity | OP_NET |
 |-----------|----------|-------|
 | Declare | `mapping(address => uint256) public balances;` | `private balances: AddressMemoryMap;` |
 | Initialize | Automatic | `this.balances = new AddressMemoryMap(this.balancesPointer);` |
@@ -175,7 +175,7 @@ flowchart LR
 
 ### Common Patterns
 
-| Pattern | Solidity | OPNet |
+| Pattern | Solidity | OP_NET |
 |---------|----------|-------|
 | Transfer balance | `balances[from] -= amt; balances[to] += amt;` | `balances.set(from, SafeMath.sub(balances.get(from), amt)); balances.set(to, SafeMath.add(balances.get(to), amt));` |
 | Check sufficient | `require(balances[addr] >= amount);` | `if (balances.get(addr) < amount) throw new Revert("Insufficient");` |
@@ -186,7 +186,7 @@ flowchart LR
 
 ### Key Differences from Solidity
 
-| Aspect | Solidity | OPNet |
+| Aspect | Solidity | OP_NET |
 |--------|----------|-------|
 | Key type | `address` (20 bytes) | `Address` (32 bytes) |
 | Value type | Any | `u256` only |
@@ -196,7 +196,7 @@ flowchart LR
 
 ### ERC-20 Style Comparison
 
-| ERC-20 Function | Solidity | OPNet |
+| ERC-20 Function | Solidity | OP_NET |
 |-----------------|----------|-------|
 | `balanceOf(address)` | `return balances[owner];` | `return this.balances.get(owner);` |
 | `transfer(to, amount)` | `balances[msg.sender] -= amount; balances[to] += amount;` | `this.balances.set(sender, SafeMath.sub(...)); this.balances.set(to, SafeMath.add(...));` |
@@ -237,7 +237,7 @@ contract TokenBalances {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class TokenBalances extends OP_NET {
@@ -344,7 +344,7 @@ contract Staking {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class Staking extends OP_NET {

package/docs/storage/stored-arrays.md

@@ -196,11 +196,11 @@ if (this.holders.getLength() === 0) {
 }
 ```
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Quick Reference Table
 
-| Solidity Array Type | OPNet Equivalent | Elements per Slot | Default Max |
+| Solidity Array Type | OP_NET Equivalent | Elements per Slot | Default Max |
 |---------------------|------------------|-------------------|-------------|
 | `uint256[]` | `StoredU256Array` | 1 | u32.MAX_VALUE - 1 |
 | `uint128[]` | `StoredU128Array` | 2 | u32.MAX_VALUE - 1 |
@@ -213,7 +213,7 @@ if (this.holders.getLength() === 0) {
 
 ### Operations Comparison
 
-| Operation | Solidity | OPNet |
+| Operation | Solidity | OP_NET |
 |-----------|----------|-------|
 | Declare array | `address[] public holders;` | `private holders: StoredAddressArray;` |
 | Initialize | Automatic | `this.holders = new StoredAddressArray(this.holdersPointer, EMPTY_POINTER);` |
@@ -230,7 +230,7 @@ if (this.holders.getLength() === 0) {
 
 ### Common Patterns
 
-| Pattern | Solidity | OPNet |
+| Pattern | Solidity | OP_NET |
 |---------|----------|-------|
 | Loop through array | `for (uint i = 0; i < arr.length; i++)` | `for (let i: u32 = 0; i < arr.getLength(); i++)` |
 | Remove at index (swap) | `arr[i] = arr[arr.length-1]; arr.pop();` | `arr.set(i, arr.get(arr.getLength()-1)); arr.deleteLast(); arr.save();` |
@@ -276,7 +276,7 @@ contract AddressList {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class AddressList extends OP_NET {
@@ -372,7 +372,7 @@ contract ValueQueue {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class ValueQueue extends OP_NET {

package/docs/storage/stored-maps.md

@@ -260,11 +260,11 @@ flowchart LR
     G --> H["Commit to storage"]
 ```
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Quick Reference Table
 
-| Solidity Mapping Type | OPNet Equivalent | Notes |
+| Solidity Mapping Type | OP_NET Equivalent | Notes |
 |-----------------------|------------------|-------|
 | `mapping(uint256 => uint256)` | `StoredMapU256` | u256 keys and values |
 | `mapping(address => uint256)` | `AddressMemoryMap` | Recommended for address keys |
@@ -274,7 +274,7 @@ flowchart LR
 
 ### Operations Comparison
 
-| Operation | Solidity | OPNet (StoredMapU256) |
+| Operation | Solidity | OP_NET (StoredMapU256) |
 |-----------|----------|----------------------|
 | Declare | `mapping(uint256 => uint256) data;` | `private data: StoredMapU256;` |
 | Initialize | Automatic | `this.data = new StoredMapU256(this.dataPointer);` |
@@ -286,7 +286,7 @@ flowchart LR
 
 ### Nested Mapping Comparison
 
-| Operation | Solidity | OPNet (MapOfMap) |
+| Operation | Solidity | OP_NET (MapOfMap) |
 |-----------|----------|------------------|
 | Declare | `mapping(address => mapping(address => uint256)) allowances;` | `private allowances: MapOfMap<u256>;` |
 | Read nested | `allowances[owner][spender]` | `allowances.get(owner).get(spender)` |
@@ -294,7 +294,7 @@ flowchart LR
 
 ### Address Key Patterns
 
-| Solidity Pattern | OPNet Equivalent |
+| Solidity Pattern | OP_NET Equivalent |
 |------------------|------------------|
 | `mapping(address => uint256) balances;` | `private balances: AddressMemoryMap;` (preferred) |
 | `balances[msg.sender]` | `balances.get(Blockchain.tx.sender)` |
@@ -303,7 +303,7 @@ flowchart LR
 
 ### Common Use Cases
 
-| Use Case | Solidity | OPNet |
+| Use Case | Solidity | OP_NET |
 |----------|----------|-------|
 | Token balances | `mapping(address => uint256) balances;` | `AddressMemoryMap` |
 | Approvals | `mapping(address => mapping(address => uint256))` | `MapOfMap<u256>` |
@@ -341,7 +341,7 @@ contract KeyValueStore {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class KeyValueStore extends OP_NET {
@@ -414,7 +414,7 @@ contract ApprovalSystem {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class ApprovalSystem extends OP_NET {

package/docs/storage/stored-primitives.md

@@ -277,11 +277,11 @@ public override onDeployment(calldata: Calldata): void {
 }
 ```
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Quick Reference Table
 
-| Solidity | OPNet | Default Value |
+| Solidity | OP_NET | Default Value |
 |----------|-------|---------------|
 | `uint256 public value;` | `StoredU256` | `u256.Zero` |
 | `uint64[4] packed;` | `StoredU64` | `[0, 0, 0, 0]` |
@@ -294,7 +294,7 @@ public override onDeployment(calldata: Calldata): void {
 
 ### Operations Comparison
 
-| Operation | Solidity | OPNet |
+| Operation | Solidity | OP_NET |
 |-----------|----------|-------|
 | Declare state variable | `uint256 public value;` | `private _value: StoredU256 = new StoredU256(ptr, EMPTY_POINTER);` |
 | Read value | `value` or `this.value` | `this._value.value` |
@@ -309,7 +309,7 @@ public override onDeployment(calldata: Calldata): void {
 
 ### Declaration Patterns
 
-| Solidity Pattern | OPNet Equivalent |
+| Solidity Pattern | OP_NET Equivalent |
 |------------------|------------------|
 | `uint256 public totalSupply;` | `private totalSupplyPtr: u16 = Blockchain.nextPointer;`<br>`private _totalSupply: StoredU256 = new StoredU256(this.totalSupplyPtr, EMPTY_POINTER);` |
 | `string public name = "Token";` | `private namePtr: u16 = Blockchain.nextPointer;`<br>`private _name: StoredString = new StoredString(this.namePtr, 0);`<br>Then in `onDeployment`: `this._name.value = "Token";` |
@@ -346,7 +346,7 @@ contract Counter {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class Counter extends OP_NET {
@@ -417,7 +417,7 @@ contract Ownable {
 }
 ```
 
-**OPNet:**
+**OP_NET:**
 ```typescript
 @final
 export class Ownable extends OP_NET {

package/docs/types/address.md

@@ -1,6 +1,6 @@
 # Address Type
 
-The `Address` type represents a 32-byte Bitcoin/OPNet address. It provides methods for creating, comparing, and serializing addresses.
+The `Address` type represents a 32-byte Bitcoin/OP_NET address. It provides methods for creating, comparing, and serializing addresses.
 
 ## Overview
 
@@ -248,12 +248,12 @@ const sender: Address = reader.readAddress();
 
 ## Address Size
 
-OPNet addresses are **32 bytes**, compared to Ethereum's 20 bytes:
+OP_NET addresses are **32 bytes**, compared to Ethereum's 20 bytes:
 
 | Platform | Address Size | Format |
 |----------|-------------|--------|
 | Ethereum | 20 bytes | 0x + 40 hex chars |
-| OPNet | 32 bytes | 64 hex chars |
+| OP_NET | 32 bytes | 64 hex chars |
 
 ```typescript
 // Full 32-byte address (Address extends Uint8Array)
@@ -303,7 +303,7 @@ this.balances.set(userAddress, newBalance);
 
 ## ML-DSA Public Key Access
 
-Every `Address` in OPNet can access its ML-DSA (quantum-resistant) public key directly:
+Every `Address` in OP_NET can access its ML-DSA (quantum-resistant) public key directly:
 
 ```typescript
 const sender: Address = Blockchain.tx.sender;
@@ -429,11 +429,11 @@ const deadAddr: ExtendedAddress = Blockchain.DEAD_ADDRESS;
 
 See [Quantum Resistance](../advanced/quantum-resistance.md) for details.
 
-## Solidity vs OPNet Comparison
+## Solidity vs OP_NET Comparison
 
 ### Address Type Comparison Table
 
-| Feature | Solidity | OPNet |
+| Feature | Solidity | OP_NET |
 |---------|----------|-------|
 | **Type name** | `address` | `Address` |
 | **Size** | 20 bytes (160 bits) | 32 bytes (256 bits) |
@@ -464,7 +464,7 @@ address self = address(this);
 ```
 
 ```typescript
-// OPNet
+// OP_NET
 const sender: Address = Blockchain.tx.sender;
 const origin: Address = Blockchain.tx.origin;
 const self: Address = Blockchain.contract.address;
@@ -478,7 +478,7 @@ require(to != address(0), "Cannot send to zero address");
 ```
 
 ```typescript
-// OPNet
+// OP_NET
 if (to.equals(Address.zero())) {
     throw new Revert('Cannot send to zero address');
 }
@@ -497,7 +497,7 @@ require(from != to, "Cannot transfer to self");
 ```
 
 ```typescript
-// OPNet
+// OP_NET
 if (!Blockchain.tx.sender.equals(owner)) {
     throw new Revert('Not owner');
 }
@@ -528,7 +528,7 @@ function transferOwnership(address newOwner) public onlyOwner {
 ```
 
 ```typescript
-// OPNet
+// OP_NET
 private ownerPointer: u16 = Blockchain.nextPointer;
 private _owner: StoredAddress;
 
@@ -570,7 +570,7 @@ function balanceOf(address account) public view returns (uint256) {
 ```
 
 ```typescript
-// OPNet
+// OP_NET
 private balancesPointer: u16 = Blockchain.nextPointer;
 private balances: AddressMemoryMap;
 
@@ -600,7 +600,7 @@ bool success = recipient.send(amount); // Returns false on failure
 ```
 
 ```typescript
-// OPNet - No native value transfers on addresses
+// OP_NET - No native value transfers on addresses
 // Bitcoin UTXO model is fundamentally different
 // Token transfers are done via contract calls instead:
 this._transfer(from, to, amount);  // Internal token transfer logic
@@ -608,7 +608,7 @@ this._transfer(from, to, amount);  // Internal token transfer logic
 
 ### Key Differences Explained
 
-| Aspect | Solidity/Ethereum | OPNet/Bitcoin |
+| Aspect | Solidity/Ethereum | OP_NET/Bitcoin |
 |--------|-------------------|---------------|
 | **Address derivation** | Keccak256 hash of public key (last 20 bytes) | SHA256 of ML-DSA public key (32 bytes) |
 | **Native currency** | ETH handled via `payable` | Bitcoin UTXOs handled separately |