@btc-vision/btc-runtime 1.1.7 → 1.1.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 btc-vision
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 [ORANGE PILLS INC, 2140 S DUPONT HWY CAMDEN, DE 19934]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,186 +1,186 @@
-# OPNet 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)
-![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
-![NodeJS](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
-![WebAssembly](https://img.shields.io/badge/WebAssembly-654FF0?style=for-the-badge&logo=webassembly&logoColor=white)
-![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
-
-[![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.
-
-## 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.
-
-## Usage Examples
-
-### Creating a Basic Token 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.
-
-```typescript
-import { u128, u256 } from 'as-bignum/assembly';
-import {
-    Address, Blockchain,
-    BytesWriter,
-    Calldata,
-    encodeSelector,
-    Map,
-    OP20InitParameters,
-    Selector,
-} from '@btc-vision/btc-runtime/runtime';
-import { DeployableOP_20 } from '@btc-vision/btc-runtime/runtime/contracts/DeployableOP_20';
-
-@final
-export class MyToken extends DeployableOP_20 {
-    constructor() {
-        super();
-
-        // DO NOT USE TO DEFINE VARIABLE THAT ARE NOT CONSTANT. SEE "solidityLikeConstructor" BELOW.
-    }
-
-    // "solidityLikeConstructor" This is a solidity-like constructor. This method will only run once.
-    public onInstantiated(): void {
-        if (!this.isInstantiated) {
-            super.onInstantiated(); // IMPORTANT.
-
-            const maxSupply: u256 = u128.fromString('100000000000000000000000000').toU256(); // Your max supply.
-            const decimals: u8 = 18; // Your decimals.
-            const name: string = 'MyToken'; // Your token name.
-            const symbol: string = 'TOKEN'; // Your token symbol.
-
-            this.instantiate(new OP20InitParameters(maxSupply, decimals, name, symbol));
-
-            // Add your logic here. Eg, minting the initial supply:
-            // this._mint(Blockchain.origin, maxSupply);
-        }
-    }
-
-    public override callMethod(method: Selector, calldata: Calldata): BytesWriter {
-        switch (method) {
-            default:
-                return super.callMethod(method, calldata);
-        }
-    }
-}
-```
-
-### Emitting Events
-
-```typescript
-class MyContract extends OP_NET {
-    public someAction(): void {
-        const event = new CustomEvent(Blockchain.sender, u256.fromU32(100));
-        this.emitEvent(event);
-    }
-}
-```
-
-## Advanced Topics
-
-### Storage Management with Cryptographic Proofs
-
-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.
-
-### Using Serializable Data Structures
-
-For complex data types, the `Serializable` class allows you to manage and persist data structures across multiple
-storage slots.
-
-```typescript
-class ComplexData extends Serializable {
-    // Implementation
-}
-```
-
-## Additional Documentation
-
-For more detailed explanations on specific topics, refer to the individual documentation files:
-
-- [Blockchain.md](docs/Blockchain.md)
-- [Contract.md](docs/Contract.md)
-- [Events.md](docs/Events.md)
-- [Pointers.md](docs/Pointers.md)
-- [Storage.md](docs/Storage.md)
-
-## License
-
-This project is licensed under the MIT License. View the full license [here](LICENSE.md).
+# OPNet 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)
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![NodeJS](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)
+![WebAssembly](https://img.shields.io/badge/WebAssembly-654FF0?style=for-the-badge&logo=webassembly&logoColor=white)
+![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
+
+[![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.
+
+## 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.
+
+## Usage Examples
+
+### Creating a Basic Token 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.
+
+```typescript
+import { u128, u256 } from 'as-bignum/assembly';
+import {
+    Address, Blockchain,
+    BytesWriter,
+    Calldata,
+    encodeSelector,
+    Map,
+    OP20InitParameters,
+    Selector,
+} from '@btc-vision/btc-runtime/runtime';
+import { DeployableOP_20 } from '@btc-vision/btc-runtime/runtime/contracts/DeployableOP_20';
+
+@final
+export class MyToken extends DeployableOP_20 {
+    constructor() {
+        super();
+
+        // DO NOT USE TO DEFINE VARIABLE THAT ARE NOT CONSTANT. SEE "solidityLikeConstructor" BELOW.
+    }
+
+    // "solidityLikeConstructor" This is a solidity-like constructor. This method will only run once.
+    public onInstantiated(): void {
+        if (!this.isInstantiated) {
+            super.onInstantiated(); // IMPORTANT.
+
+            const maxSupply: u256 = u128.fromString('100000000000000000000000000').toU256(); // Your max supply.
+            const decimals: u8 = 18; // Your decimals.
+            const name: string = 'MyToken'; // Your token name.
+            const symbol: string = 'TOKEN'; // Your token symbol.
+
+            this.instantiate(new OP20InitParameters(maxSupply, decimals, name, symbol));
+
+            // Add your logic here. Eg, minting the initial supply:
+            // this._mint(Blockchain.origin, maxSupply);
+        }
+    }
+
+    public override callMethod(method: Selector, calldata: Calldata): BytesWriter {
+        switch (method) {
+            default:
+                return super.callMethod(method, calldata);
+        }
+    }
+}
+```
+
+### Emitting Events
+
+```typescript
+class MyContract extends OP_NET {
+    public someAction(): void {
+        const event = new CustomEvent(Blockchain.sender, u256.fromU32(100));
+        this.emitEvent(event);
+    }
+}
+```
+
+## Advanced Topics
+
+### Storage Management with Cryptographic Proofs
+
+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.
+
+### Using Serializable Data Structures
+
+For complex data types, the `Serializable` class allows you to manage and persist data structures across multiple
+storage slots.
+
+```typescript
+class ComplexData extends Serializable {
+    // Implementation
+}
+```
+
+## Additional Documentation
+
+For more detailed explanations on specific topics, refer to the individual documentation files:
+
+- [Blockchain.md](docs/Blockchain.md)
+- [Contract.md](docs/Contract.md)
+- [Events.md](docs/Events.md)
+- [Pointers.md](docs/Pointers.md)
+- [Storage.md](docs/Storage.md)
+
+## License
+
+This project is licensed under the MIT License. View the full license [here](LICENSE.md).

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@btc-vision/btc-runtime",
-    "version": "1.1.7",
+    "version": "1.1.8",
     "description": "Bitcoin Smart Contract Runtime",
     "main": "btc/index.ts",
     "types": "btc/index.ts",
@@ -23,7 +23,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/BlobMaster41/btc-runtime.git"
+        "url": "https://github.com/btc-vision/btc-runtime"
     },
     "type": "module",
     "files": [