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

package/README.md

@@ -1,4 +1,4 @@
-# OPNet Smart Contract Runtime
+# OP_NET Smart Contract Runtime
 
 ![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&logoColor=white)
 ![AssemblyScript](https://img.shields.io/badge/assembly%20script-%23000000.svg?style=for-the-badge&logo=assemblyscript&logoColor=white)
@@ -11,13 +11,13 @@
 
 ## Overview
 
-The OPNet Smart Contract Runtime is the framework for building decentralized applications on Bitcoin L1. Written in AssemblyScript and compiled to WebAssembly, it enables smart contract development on Bitcoin with similar expressiveness to Solidity.
+The OP_NET Smart Contract Runtime is the framework for building decentralized applications on Bitcoin L1. Written in AssemblyScript and compiled to WebAssembly, it enables smart contract development on Bitcoin with similar expressiveness to 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.
+Unlike Bitcoin Layer 2 solutions, OP_NET operates directly on Bitcoin's base layer, inheriting Bitcoin's security guarantees and decentralization properties while adding programmable smart contract capabilities.
 
-> **What is OPNet?**
+> **What is OP_NET?**
 >
-> 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.
+> OP_NET (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?**
 >
@@ -88,7 +88,7 @@ export class MyToken extends OP20 {
 
 ## Solidity Comparison
 
-| Solidity/EVM                | OPNet/btc-runtime                         |
+| Solidity/EVM                | OP_NET/btc-runtime                         |
 |-----------------------------|-------------------------------------------|
 | `contract MyContract`       | `class MyContract extends OP_NET`         |
 | `constructor()`             | `onDeployment(calldata)`                  |
@@ -138,7 +138,7 @@ See the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) for requirem
 
 ## Links
 
-- [OPNet](https://opnet.org)
+- [OP_NET](https://opnet.org)
 - [Documentation](./docs/)
 - [GitHub](https://github.com/btc-vision/btc-runtime)
 - [npm](https://www.npmjs.com/package/@btc-vision/btc-runtime)

package/docs/README.md

@@ -1,6 +1,6 @@
 # Documentation
 
-Welcome to the comprehensive documentation for **@btc-vision/btc-runtime**, the OPNet Smart Contract Runtime for Bitcoin L1.
+Welcome to the comprehensive documentation for **@btc-vision/btc-runtime**, the OP_NET Smart Contract Runtime for Bitcoin L1.
 
 ## Quick Start
 
@@ -98,7 +98,7 @@ npm run build:token
 - [Pointer System](./core-concepts/storage-system.md#pointer-system)
 - [Storage Types](./core-concepts/storage-system.md#storage-types)
 - [Reading and Writing](./core-concepts/storage-system.md#reading-and-writing)
-- [Solidity vs OPNet Comparison](./core-concepts/storage-system.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./core-concepts/storage-system.md#solidity-vs-opnet-comparison)
 - [Best Practices](./core-concepts/storage-system.md#best-practices)
 
 #### [Pointers](./core-concepts/pointers.md)
@@ -261,7 +261,7 @@ npm run build:token
 
 #### [ReentrancyGuard](./contracts/reentrancy-guard.md)
 - [Overview](./contracts/reentrancy-guard.md#overview)
-- [OpenZeppelin vs OPNet ReentrancyGuard](./contracts/reentrancy-guard.md#openzeppelin-vs-opnet-reentrancyguard)
+- [OpenZeppelin vs OP_NET ReentrancyGuard](./contracts/reentrancy-guard.md#openzeppelin-vs-opnet-reentrancyguard)
 - [What is Reentrancy?](./contracts/reentrancy-guard.md#what-is-reentrancy)
   - [The Attack](./contracts/reentrancy-guard.md#the-attack)
   - [The Defense](./contracts/reentrancy-guard.md#the-defense)
@@ -285,17 +285,17 @@ npm run build:token
 - [Common Mistakes](./contracts/reentrancy-guard.md#common-mistakes)
 - [Testing Reentrancy](./contracts/reentrancy-guard.md#testing-reentrancy)
 
-#### [Upgradeable](./contracts/upgradeable.md)
-- [Overview](./contracts/upgradeable.md#overview)
-- [Class Reference](./contracts/upgradeable.md#class-reference)
-  - [Properties](./contracts/upgradeable.md#properties)
-  - [Methods](./contracts/upgradeable.md#methods)
-- [Events](./contracts/upgradeable.md#events)
-- [Usage Patterns](./contracts/upgradeable.md#usage-patterns)
-- [Security Considerations](./contracts/upgradeable.md#security-considerations)
-- [Upgrade Workflow](./contracts/upgradeable.md#upgrade-workflow)
-- [Combining with Other Base Classes](./contracts/upgradeable.md#combining-with-other-base-classes)
-- [Solidity Comparison](./contracts/upgradeable.md#solidity-comparison)
+#### [Updatable](./contracts/updatable.md)
+- [Overview](./contracts/updatable.md#overview)
+- [Class Reference](./contracts/updatable.md#class-reference)
+  - [Properties](./contracts/updatable.md#properties)
+  - [Methods](./contracts/updatable.md#methods)
+- [Events](./contracts/updatable.md#events)
+- [Usage Patterns](./contracts/updatable.md#usage-patterns)
+- [Security Considerations](./contracts/updatable.md#security-considerations)
+- [Update Workflow](./contracts/updatable.md#update-workflow)
+- [Combining with Other Base Classes](./contracts/updatable.md#combining-with-other-base-classes)
+- [Solidity Comparison](./contracts/updatable.md#solidity-comparison)
 
 ---
 
@@ -307,7 +307,7 @@ npm run build:token
 - [Address Comparison](./types/address.md#address-comparison)
 - [Special Addresses](./types/address.md#special-addresses)
 - [Address Methods](./types/address.md#address-methods)
-- [Solidity vs OPNet Comparison](./types/address.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./types/address.md#solidity-vs-opnet-comparison)
 - [Best Practices](./types/address.md#best-practices)
 
 #### [SafeMath](./types/safe-math.md)
@@ -322,14 +322,14 @@ npm run build:token
 - [Reading Values](./types/calldata.md#reading-values)
 - [Reading Arrays](./types/calldata.md#reading-arrays)
 - [Reading Complex Types](./types/calldata.md#reading-complex-types)
-- [Solidity vs OPNet Comparison](./types/calldata.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./types/calldata.md#solidity-vs-opnet-comparison)
 - [Best Practices](./types/calldata.md#best-practices)
 
 #### [BytesWriter/Reader](./types/bytes-writer-reader.md)
 - [Overview](./types/bytes-writer-reader.md#overview)
 - [BytesWriter](./types/bytes-writer-reader.md#byteswriter)
 - [BytesReader](./types/bytes-writer-reader.md#bytesreader)
-- [Solidity vs OPNet Comparison](./types/bytes-writer-reader.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./types/bytes-writer-reader.md#solidity-vs-opnet-comparison)
 - [Migration Patterns](./types/bytes-writer-reader.md#migration-patterns)
 - [Best Practices](./types/bytes-writer-reader.md#best-practices)
 
@@ -354,7 +354,7 @@ npm run build:token
 - [Initialization](./storage/stored-primitives.md#initialization)
   - [Default Values](./storage/stored-primitives.md#default-values)
   - [Setting Initial Values](./storage/stored-primitives.md#setting-initial-values)
-- [Solidity vs OPNet Comparison](./storage/stored-primitives.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./storage/stored-primitives.md#solidity-vs-opnet-comparison)
 - [Side-by-Side Code Examples](./storage/stored-primitives.md#side-by-side-code-examples)
   - [Counter Contract](./storage/stored-primitives.md#counter-contract)
   - [Ownable Contract](./storage/stored-primitives.md#ownable-contract)
@@ -375,7 +375,7 @@ npm run build:token
   - [Get](./storage/stored-arrays.md#get)
   - [Set](./storage/stored-arrays.md#set)
   - [Length](./storage/stored-arrays.md#length)
-- [Solidity vs OPNet Comparison](./storage/stored-arrays.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./storage/stored-arrays.md#solidity-vs-opnet-comparison)
 - [Side-by-Side Code Examples](./storage/stored-arrays.md#side-by-side-code-examples)
   - [Simple Address List](./storage/stored-arrays.md#simple-address-list)
   - [Value Queue (FIFO-like with array)](./storage/stored-arrays.md#value-queue-fifo-like-with-array)
@@ -399,7 +399,7 @@ npm run build:token
 - [Nested Maps](./storage/stored-maps.md#nested-maps)
 - [MapOfMap](./storage/stored-maps.md#mapofmap)
   - [MapOfMap Get/Set Pattern](./storage/stored-maps.md#mapofmap-getset-pattern)
-- [Solidity vs OPNet Comparison](./storage/stored-maps.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./storage/stored-maps.md#solidity-vs-opnet-comparison)
 - [Side-by-Side Code Examples](./storage/stored-maps.md#side-by-side-code-examples)
   - [Simple Key-Value Store](./storage/stored-maps.md#simple-key-value-store)
   - [Approval System with Nested Mapping](./storage/stored-maps.md#approval-system-with-nested-mapping)
@@ -417,7 +417,7 @@ npm run build:token
   - [Methods](./storage/memory-maps.md#methods)
 - [Storage Flow](./storage/memory-maps.md#storage-flow)
   - [Address to Storage Key](./storage/memory-maps.md#address-to-storage-key)
-- [Solidity vs OPNet Comparison](./storage/memory-maps.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./storage/memory-maps.md#solidity-vs-opnet-comparison)
 - [Side-by-Side Code Examples](./storage/memory-maps.md#side-by-side-code-examples)
   - [Basic Token Balance Tracking](./storage/memory-maps.md#basic-token-balance-tracking)
   - [Staking Contract](./storage/memory-maps.md#staking-contract)
@@ -470,7 +470,7 @@ npm run build:token
 - [Schnorr Signatures](./advanced/signature-verification.md#schnorr-signatures)
 - [ML-DSA Signatures](./advanced/signature-verification.md#ml-dsa-signatures)
 - [Verification API](./advanced/signature-verification.md#verification-api)
-- [Solidity vs OPNet Comparison](./advanced/signature-verification.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./advanced/signature-verification.md#solidity-vs-opnet-comparison)
 - [Best Practices](./advanced/signature-verification.md#best-practices)
 
 #### [Quantum Resistance](./advanced/quantum-resistance.md)
@@ -479,7 +479,7 @@ npm run build:token
 - [Security Levels](./advanced/quantum-resistance.md#security-levels)
 - [The Address Class](./advanced/quantum-resistance.md#the-address-class)
 - [Migration Path](./advanced/quantum-resistance.md#migration-path)
-- [Solidity vs OPNet Comparison](./advanced/quantum-resistance.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./advanced/quantum-resistance.md#solidity-vs-opnet-comparison)
 - [Best Practices](./advanced/quantum-resistance.md#best-practices)
 
 #### [Bitcoin Scripts](./advanced/bitcoin-scripts.md)
@@ -496,22 +496,22 @@ npm run build:token
   - [CSV (CheckSequenceVerify)](./advanced/bitcoin-scripts.md#csv-checksequenceverify)
   - [CLTV (CheckLockTimeVerify)](./advanced/bitcoin-scripts.md#cltv-checklockimeverify)
 - [Script Analysis](./advanced/bitcoin-scripts.md#script-analysis)
-- [Solidity vs OPNet Comparison](./advanced/bitcoin-scripts.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./advanced/bitcoin-scripts.md#solidity-vs-opnet-comparison)
 - [Best Practices](./advanced/bitcoin-scripts.md#best-practices)
 
-#### [Contract Upgrades](./advanced/contract-upgrades.md)
-- [Overview](./advanced/contract-upgrades.md#overview)
-- [How It Works](./advanced/contract-upgrades.md#how-it-works)
-- [Basic Usage](./advanced/contract-upgrades.md#basic-usage)
-- [The Timelock Pattern](./advanced/contract-upgrades.md#the-timelock-pattern)
-  - [Why Use a Timelock?](./advanced/contract-upgrades.md#why-use-a-timelock)
-  - [Using the Upgradeable Base Class](./advanced/contract-upgrades.md#using-the-upgradeable-base-class)
-  - [Using the UpgradeablePlugin](./advanced/contract-upgrades.md#using-the-upgradeableplugin)
-- [Storage Compatibility](./advanced/contract-upgrades.md#storage-compatibility)
-- [Security Considerations](./advanced/contract-upgrades.md#security-considerations)
-- [Comparison with Other Platforms](./advanced/contract-upgrades.md#comparison-with-other-platforms)
-- [Complete Example](./advanced/contract-upgrades.md#complete-example)
-- [Upgrade Workflow](./advanced/contract-upgrades.md#upgrade-workflow)
+#### [Contract Updates](./advanced/updatable)
+- [Overview](./advanced/updatable#overview)
+- [How It Works](./advanced/updatable#how-it-works)
+- [Basic Usage](./advanced/updatable#basic-usage)
+- [The Timelock Pattern](./advanced/updatable#the-timelock-pattern)
+  - [Why Use a Timelock?](./advanced/updatable#why-use-a-timelock)
+  - [Using the Updatable Base Class](./advanced/updatable#using-the-updatable-base-class)
+  - [Using the UpdatablePlugin](./advanced/updatable#using-the-updatableplugin)
+- [Storage Compatibility](./advanced/updatable#storage-compatibility)
+- [Security Considerations](./advanced/updatable#security-considerations)
+- [Comparison with Other Platforms](./advanced/updatable#comparison-with-other-platforms)
+- [Complete Example](./advanced/updatable#complete-example)
+- [Update Workflow](./advanced/updatable#update-workflow)
 
 #### [Plugins](./advanced/plugins.md)
 - [Overview](./advanced/plugins.md#overview)
@@ -524,7 +524,7 @@ npm run build:token
   - [onExecutionCompleted](./advanced/plugins.md#onexecutioncompleted)
   - [execute](./advanced/plugins.md#execute)
 - [Built-in Plugins](./advanced/plugins.md#built-in-plugins)
-- [Solidity vs OPNet Comparison](./advanced/plugins.md#solidity-vs-opnet-comparison)
+- [Solidity vs OP_NET Comparison](./advanced/plugins.md#solidity-vs-opnet-comparison)
 - [Best Practices](./advanced/plugins.md#best-practices)
 
 ---
@@ -632,7 +632,7 @@ npm run build:token
 
 - [Example Tokens Repository](https://github.com/btc-vision/example-tokens)
 - [btc-runtime Repository](https://github.com/btc-vision/btc-runtime)
-- [OPNet Website](https://opnet.org)
+- [OP_NET Website](https://opnet.org)
 
 ## Solidity Developer?
 

package/docs/advanced/bitcoin-scripts.md

@@ -1,6 +1,6 @@
 # Bitcoin Scripts
 
-OPNet provides utilities for working with Bitcoin scripts, addresses, and timelocks. This enables contracts to interact with Bitcoin's native scripting capabilities.
+OP_NET provides utilities for working with Bitcoin scripts, addresses, and timelocks. This enables contracts to interact with Bitcoin's native scripting capabilities.
 
 ## Overview
 
@@ -20,7 +20,7 @@ import {
 
 ## Networks
 
-OPNet supports three Bitcoin networks:
+OP_NET supports three Bitcoin networks:
 
 ```typescript
 import { Networks, Network } from '@btc-vision/btc-runtime/runtime';
@@ -291,7 +291,7 @@ flowchart LR
     CSV6 -->|"No"| CSV8["Transaction invalid"]
 ```
 
-OPNet provides a built-in method for CSV scripts:
+OP_NET provides a built-in method for CSV scripts:
 
 ```typescript
 import { BitcoinScript, BitcoinAddresses, Network, Networks } from '@btc-vision/btc-runtime/runtime';
@@ -425,7 +425,7 @@ if (result.success) {
 
 ## Script Recognition
 
-OPNet can parse and recognize common script patterns:
+OP_NET can parse and recognize common script patterns:
 
 ### Recognize CSV Timelock
 
@@ -636,13 +636,13 @@ public buildOpReturnScript(data: Uint8Array): Uint8Array {
 }
 ```
 
-## Solidity vs OPNet: Bitcoin Scripts Comparison
+## Solidity vs OP_NET: Bitcoin Scripts Comparison
 
-Bitcoin scripting is fundamentally different from Solidity, as it operates on UTXOs rather than account balances. OPNet uniquely bridges smart contract functionality with native Bitcoin scripting capabilities.
+Bitcoin scripting is fundamentally different from Solidity, as it operates on UTXOs rather than account balances. OP_NET uniquely bridges smart contract functionality with native Bitcoin scripting capabilities.
 
 ### Feature Comparison Table
 
-| Feature | Solidity/EVM | OPNet | OPNet Advantage |
+| Feature | Solidity/EVM | OP_NET | OP_NET Advantage |
 |---------|--------------|-------|-----------------|
 | **Bitcoin Script Support** | Not supported | Full support via `BitcoinOpcodes` | Native Bitcoin integration |
 | **Address Types** | Single type (20 bytes) | P2PKH, P2SH, P2WPKH, P2WSH, P2TR | Full Bitcoin address compatibility |
@@ -657,7 +657,7 @@ Bitcoin scripting is fundamentally different from Solidity, as it operates on UT
 
 ### Capability Matrix
 
-| Capability | Solidity | OPNet |
+| Capability | Solidity | OP_NET |
 |------------|:--------:|:-----:|
 | Create P2PKH addresses | No | Yes |
 | Create P2SH addresses | No | Yes |
@@ -706,10 +706,10 @@ contract TimeLock {
 }
 ```
 
-#### OPNet Approach (Consensus-Enforced)
+#### OP_NET Approach (Consensus-Enforced)
 
 ```typescript
-// OPNet - CSV relative timelock (consensus-enforced)
+// OP_NET - CSV relative timelock (consensus-enforced)
 import { BitcoinScript, BitcoinAddresses, Network, Networks } from '@btc-vision/btc-runtime/runtime';
 
 // Create a timelock script - 144 blocks = ~1 day
@@ -774,10 +774,10 @@ contract MultiSig {
 }
 ```
 
-#### OPNet Approach (Native Bitcoin Multisig)
+#### OP_NET Approach (Native Bitcoin Multisig)
 
 ```typescript
-// OPNet - native Bitcoin multisig (simple, consensus-enforced)
+// OP_NET - native Bitcoin multisig (simple, consensus-enforced)
 import { BitcoinScript, BitcoinAddresses, Network, Networks } from '@btc-vision/btc-runtime/runtime';
 
 // Build a 2-of-3 multisig script - one line of code!
@@ -805,7 +805,7 @@ if (recognized.ok) {
 
 ### Script Building Comparison
 
-| Task | Solidity | OPNet |
+| Task | Solidity | OP_NET |
 |------|----------|-------|
 | Build P2PKH script | Not possible | `buildP2PKHScript(pubkeyHash)` |
 | Build multisig script | Custom contract | `BitcoinScript.multisig(m, pubkeys)` |
@@ -817,7 +817,7 @@ if (recognized.ok) {
 
 ### Transaction Introspection
 
-| Feature | Solidity | OPNet |
+| Feature | Solidity | OP_NET |
 |---------|----------|-------|
 | Access tx outputs | `msg.value` only | `Blockchain.tx.outputs` (full array) |
 | Access tx inputs | Not possible | `Blockchain.tx.inputs` (full array) |
@@ -846,7 +846,7 @@ contract DataEmbed {
 ```
 
 ```typescript
-// OPNet - OP_RETURN (native Bitcoin, permanent)
+// OP_NET - OP_RETURN (native Bitcoin, permanent)
 import { BytesWriter, BitcoinOpcodes } from '@btc-vision/btc-runtime/runtime';
 
 function buildOpReturnScript(data: Uint8Array): Uint8Array {
@@ -869,9 +869,9 @@ function buildOpReturnScript(data: Uint8Array): Uint8Array {
 // - No complex event parsing needed
 ```
 
-### Why OPNet for Bitcoin Integration?
+### Why OP_NET for Bitcoin Integration?
 
-| Solidity Limitation | OPNet Solution |
+| Solidity Limitation | OP_NET Solution |
 |---------------------|----------------|
 | Cannot interact with Bitcoin | Full Bitcoin script support |
 | No UTXO awareness | Complete transaction introspection |