opnet 1.0.49 → 1.0.50

package/.babelrc

@@ -1,7 +1,8 @@
-{
-    "sourceType": "module",
-    "presets": [
-        "@babel/preset-react",
-        "@babel/preset-env"
-    ]
-}
+{
+    "sourceType": "module",
+    "presets": [
+        "@babel/preset-react",
+        "@babel/preset-env",
+        "@babel/preset-typescript"
+    ]
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,38 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,20 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI for OP_NET
+
+on:
+    push:
+        tags:
+            - '*'
+
+jobs:
+    build_and_publish:
+        runs-on: ubuntu-latest
+
+        permissions:
+            contents: read
+            id-token: write
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20.x'
+                  registry-url: 'https://registry.npmjs.org'
+
+            - name: Install dependencies
+              run: yarn install
+
+            - name: Build the project
+              run: yarn build
+
+            - name: Build browser assets
+              run: yarn browserBuild
+
+            - name: Publish to npm
+              run: npm publish --provenance --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+            - name: Create GitHub Release
+              uses: actions/create-release@v1
+              with:
+                  tag_name: ${{ github.ref_name }}
+                  release_name: Release ${{ github.ref_name }}
+                  body: |
+                      Automated release for OP_NET.
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.prettierrc.json

@@ -1,12 +1,12 @@
-{
-    "printWidth": 100,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "semi": true,
-    "singleQuote": true,
-    "quoteProps": "as-needed",
-    "bracketSpacing": true,
-    "bracketSameLine": true,
-    "arrowParens": "always",
-    "singleAttributePerLine": true
+{
+    "printWidth": 100,
+    "trailingComma": "all",
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": true,
+    "quoteProps": "as-needed",
+    "bracketSpacing": true,
+    "bracketSameLine": true,
+    "arrowParens": "always",
+    "singleAttributePerLine": true
 }

package/CONTRIBUTING.md

@@ -1,71 +1,71 @@
-# Contributing Guidelines
-
-Thank you for considering contributing to our project! Please take a moment to
-review the following guidelines before submitting your contribution.
-
-## Pull Requests
-
-When submitting a pull request, please make sure to follow these guidelines:
-
-### Before You Begin
-
-1. **Fork the repository**: If you haven't already, fork the repository to your
-   GitHub account.
-
-2. **Create a new branch**: Create a new branch for your feature or bug fix.
-   This helps keep the main branch clean and makes it easier to review your
-   changes.
-
-3. **Ensure your code is up-to-date**: Before starting work, make sure your
-   forked repository is up-to-date with the latest changes from the main
-   repository.
-
-### Making Changes
-
-1. **Follow coding conventions**: Make sure your code follows the existing
-   coding style and conventions used in the project.
-
-2. **Write descriptive commit messages**: Write clear and descriptive commit
-   messages that explain the purpose of your changes.
-
-3. **Test your changes**: Before submitting your pull request, make sure to test
-   your changes thoroughly to ensure they work as expected.
-
-### Submitting the Pull Request
-
-1. **Create a descriptive title**: Use a clear and descriptive title for your
-   pull request that summarizes the purpose of your changes.
-
-2. **Provide a detailed description**: Include a detailed description of the
-   changes you've made and any relevant context that reviewers should know.
-
-3. **Link related issues**: If your pull request addresses a specific issue,
-   make sure to reference it in the description using GitHub's issue linking
-   syntax (`#issue_number`).
-
-4. **Review and address feedback**: Be responsive to any feedback or comments
-   you receive on your pull request and make any necessary changes.
-
-## Issues
-
-When submitting an issue, please provide as much information as possible to help
-us understand and address the problem. Follow these guidelines when creating an
-issue:
-
-1. **Use a descriptive title**: Use a clear and descriptive title that
-   summarizes the issue you're experiencing.
-
-2. **Provide detailed steps to reproduce**: Include detailed steps to reproduce
-   the issue, including any relevant code or configuration.
-
-3. **Include relevant information**: Provide any relevant information such as
-   error messages, screenshots, or logs that can help diagnose the problem.
-
-4. **Specify your environment**: If the issue is related to a specific
-   environment (e.g., operating system, browser), please specify it in your
-   issue description.
-
-5. **Check for existing issues**: Before submitting a new issue, please check if
-   a similar issue has already been reported to avoid duplicates.
-
-Thank you for your contributions!
+# Contributing Guidelines
+
+Thank you for considering contributing to our project! Please take a moment to
+review the following guidelines before submitting your contribution.
+
+## Pull Requests
+
+When submitting a pull request, please make sure to follow these guidelines:
+
+### Before You Begin
+
+1. **Fork the repository**: If you haven't already, fork the repository to your
+   GitHub account.
+
+2. **Create a new branch**: Create a new branch for your feature or bug fix.
+   This helps keep the main branch clean and makes it easier to review your
+   changes.
+
+3. **Ensure your code is up-to-date**: Before starting work, make sure your
+   forked repository is up-to-date with the latest changes from the main
+   repository.
+
+### Making Changes
+
+1. **Follow coding conventions**: Make sure your code follows the existing
+   coding style and conventions used in the project.
+
+2. **Write descriptive commit messages**: Write clear and descriptive commit
+   messages that explain the purpose of your changes.
+
+3. **Test your changes**: Before submitting your pull request, make sure to test
+   your changes thoroughly to ensure they work as expected.
+
+### Submitting the Pull Request
+
+1. **Create a descriptive title**: Use a clear and descriptive title for your
+   pull request that summarizes the purpose of your changes.
+
+2. **Provide a detailed description**: Include a detailed description of the
+   changes you've made and any relevant context that reviewers should know.
+
+3. **Link related issues**: If your pull request addresses a specific issue,
+   make sure to reference it in the description using GitHub's issue linking
+   syntax (`#issue_number`).
+
+4. **Review and address feedback**: Be responsive to any feedback or comments
+   you receive on your pull request and make any necessary changes.
+
+## Issues
+
+When submitting an issue, please provide as much information as possible to help
+us understand and address the problem. Follow these guidelines when creating an
+issue:
+
+1. **Use a descriptive title**: Use a clear and descriptive title that
+   summarizes the issue you're experiencing.
+
+2. **Provide detailed steps to reproduce**: Include detailed steps to reproduce
+   the issue, including any relevant code or configuration.
+
+3. **Include relevant information**: Provide any relevant information such as
+   error messages, screenshots, or logs that can help diagnose the problem.
+
+4. **Specify your environment**: If the issue is related to a specific
+   environment (e.g., operating system, browser), please specify it in your
+   issue description.
+
+5. **Check for existing issues**: Before submitting a new issue, please check if
+   a similar issue has already been reported to avoid duplicates.
+
+Thank you for your contributions!

package/LICENSE.md

@@ -1,16 +1,16 @@
-MIT License
-
-Copyright (c) 2024-2025 to the user BlobMaster41 on GitHub
-
-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-2025 to the user BlobMaster41 on GitHub
+
+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,93 +1,96 @@
-# OP_NET - Smart Contracts on Bitcoin L1
-
-![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&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)
-![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
-![Gulp](https://img.shields.io/badge/GULP-%23CF4647.svg?style=for-the-badge&logo=gulp&logoColor=white)
-![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
-
-[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
-
-## Introduction
-
-A complete, compact and simple library for the Bitcoin ecosystem, written in
-TypeScript. This library is designed to be easy to use and understand, while
-providing a comprehensive set of functions for creating, reading and
-manipulating Bitcoin transactions. This library is designed to be able to
-manipulate anything related to BSI (Bitcoin Smart Inscription), smart contracts,
-and other Bitcoin-related technologies.
-
-## Getting Started
-
-### Prerequisites
-
-- Node.js version 16.x or higher
-- npm (Node Package Manager)
-
-### Installation
-
-```shell
-npm i opnet
-```
-
-### Documentation
-
-Documentation available at [https://dev.opnet.org](https://dev.opnet.org) or in
-the `docs/` directory of the repository.
-
-#### Development
-
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/btc-vision/opnet.git
-   ```
-2. Navigate to the repository directory:
-   ```bash
-   cd opnet
-   ```
-3. Install the required dependencies:
-   ```bash
-   npm i
-   ```
-
-## Example
-
-Calling a contract function from typescript/javascript is as simple as the following code:
-```typescript
-import { getContract, JSONRpcProvider } from 'opnet';
-
-const senderAddress: string = 'tb1p823gdnqvk8a90f8cu30w8ywvk29uh8txtqqnsmk6f5ktd7hlyl0q3cyz4c';
-const provider: JSONRpcProvider = new JSONRpcProvider('https://testnet.opnet.org');
-const contract: IOP_20Contract = getContract<IOP_20Contract>(
-        'tb1q4tyhf8hpu04qjj3qaag20knun0spctultxzakw', // MOTO Contract
-        OP_20_ABI,
-        provider, 
-        sender
-);
-
-const balanceExample = await contract.balanceOf(
-    'tb1p823gdnqvk8a90f8cu30w8ywvk29uh8txtqqnsmk6f5ktd7hlyl0q3cyz4c', // Random address
-);
-
-if ('error' in balanceExample) throw new Error('Error in fetching balance');
-console.log('MOTO Balance:', balanceExample.properties);
-```
-
-You can call any function of the contract by using the `contract` object. This object will encode the correct calldata based of your provided ABI and simulate the call.
-A bunch more documentation will be available soon.
-
-You can get the calldata generated by doing balanceExample.calldata and generate your transaction based on that.
-In scenarios where you are writing data on-chain, you must specify the sender in the getContract function. This is important for the simulation to pass.
-
-## Contribution
-
-Contributions are welcome! Please read through the `CONTRIBUTING.md` file for
-guidelines on how to submit issues, feature requests, and pull requests. We
-appreciate your input and encourage you to help us improve OP_NET.
-
-## License
-
-This project is open source and available under the [MIT License](LICENSE). If
-you have any suggestions or contributions, please feel free to submit a pull
-request.
+# OP_NET - Smart Contracts on Bitcoin L1
+
+![Bitcoin](https://img.shields.io/badge/Bitcoin-000?style=for-the-badge&logo=bitcoin&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)
+![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)
+![Gulp](https://img.shields.io/badge/GULP-%23CF4647.svg?style=for-the-badge&logo=gulp&logoColor=white)
+![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
+
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+## Introduction
+
+A complete, compact and simple library for the Bitcoin ecosystem, written in
+TypeScript. This library is designed to be easy to use and understand, while
+providing a comprehensive set of functions for creating, reading and
+manipulating Bitcoin transactions. This library is designed to be able to
+manipulate anything related to BSI (Bitcoin Smart Inscription), smart contracts,
+and other Bitcoin-related technologies.
+
+## Getting Started
+
+### Prerequisites
+
+-   Node.js version 16.x or higher
+-   npm (Node Package Manager)
+
+### Installation
+
+```shell
+npm i opnet
+```
+
+### Documentation
+
+Documentation available at [https://dev.opnet.org](https://dev.opnet.org) or in
+the `docs/` directory of the repository.
+
+#### Development
+
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/btc-vision/opnet.git
+    ```
+2. Navigate to the repository directory:
+    ```bash
+    cd opnet
+    ```
+3. Install the required dependencies:
+    ```bash
+    npm i
+    ```
+
+## Example
+
+Calling a contract function from typescript/javascript is as simple as the following code:
+
+```typescript
+import { getContract, IOP_20Contract, JSONRpcProvider, OP_20_ABI } from 'opnet';
+
+async function main() {
+    const provider: JSONRpcProvider = new JSONRpcProvider('https://testnet.opnet.org');
+    const contract: IOP_20Contract = getContract<IOP_20Contract>(
+        'tb1q4tyhf8hpu04qjj3qaag20knun0spctultxzakw', // MOTO Contract
+        OP_20_ABI,
+        provider,
+    );
+
+    const balanceExample = await contract.balanceOf(
+        'tb1p823gdnqvk8a90f8cu30w8ywvk29uh8txtqqnsmk6f5ktd7hlyl0q3cyz4c', // Random address
+    );
+
+    if ('error' in balanceExample) throw new Error('Error in fetching balance');
+    console.log('MOTO Balance:', balanceExample.decoded[0]);
+}
+
+main().catch(console.error);
+```
+
+You can call any function of the contract by using the `contract` object. This object will encode the correct calldata based of your provided ABI and simulate the call.
+A bunch more documentation will be available soon.
+
+You can get the calldata generated by doing balanceExample.calldata and generate your transaction based on that.
+In scenarios where you are writing data on-chain, you must specify the sender in the getContract function. This is important for the simulation to pass.
+
+## Contribution
+
+Contributions are welcome! Please read through the `CONTRIBUTING.md` file for
+guidelines on how to submit issues, feature requests, and pull requests. We
+appreciate your input and encourage you to help us improve OP_NET.
+
+## License
+
+This project is open source and available under the [MIT License](LICENSE). If
+you have any suggestions or contributions, please feel free to submit a pull
+request.