@bsv/sdk 1.0.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Report a bug or an issue you've found with `@bsv/sdk`.
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+## Bug Description
+
+Briefly describe the bug/issue you've encountered.
+
+## Steps to Reproduce
+
+1. Step 1
+2. Step 2
+3. ...
+
+## Expected Behavior
+
+What should have happened if the bug hadn't occurred?
+
+## Actual Behavior
+
+What actually happened?
+
+## Stack Traces or Screenshots
+
+If applicable, add screenshots or stack traces to help explain the issue.
+
+## Environment
+
+- OS: [e.g. MacOS, Windows]
+- Node version: [e.g. 12.20]
+- `@bsv/sdk` version: [e.g. 1.2.3]
+
+## Additional Information
+
+Provide any additional context or information about the bug.

package/.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,24 @@
+---
+name: Discussion
+about: Propose a discussion or seek clarification about a feature or topic.
+title: "[DISCUSSION]"
+labels: discussion
+assignees: ''
+
+---
+
+## Summary
+
+Briefly describe the topic you'd like to discuss.
+
+## Motivation
+
+Why do you believe this to be important?
+
+## Description
+
+Provide a detailed description or elaborate on your topic.
+
+## Additional References
+
+Provide any additional articles, links, or context that would help facilitate the discussion.

package/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,23 @@
+## Description of Changes
+
+Provide a brief description of the changes you've made.
+
+## Linked Issues / Tickets
+
+Reference any related issues or tickets, e.g. "Closes #123".
+
+## Testing Procedure
+
+Describe the tests you've added or any testing steps you've taken.
+
+- [ ] I have added new unit tests
+- [ ] All tests pass locally
+- [ ] I have tested manually in my local environment
+
+## Checklist:
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have updated `CHANGELOG.md` with my changes
+- [ ] I have run `npm run doc` and `npm run lint` one final time before requesting a review

package/CHANGELOG.md

@@ -0,0 +1,72 @@
+# CHANGELOG for `@bsv/sdk`
+
+All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Table of Contents
+
+- [Unreleased](#unreleased)
+- [1.0.0 - YYYY-MM-DD](#100---yyyy-mm-dd)
+
+## [Unreleased]
+
+### Added
+- (Include new features or significant user-visible enhancements here.)
+
+### Changed
+- (Detail modifications that are non-breaking but relevant to the end-users.)
+
+### Deprecated
+- (List features that are in the process of being phased out or replaced.)
+
+### Removed
+- (Indicate features or capabilities that were taken out of the project.)
+
+### Fixed
+- (Document bugs that were fixed since the last release.)
+
+### Security
+- (Notify of any improvements related to security vulnerabilities or potential risks.)
+
+---
+
+## [1.0.0] - YYYY-MM-DD
+
+### Added
+- Initial release of the BSV Blockchain Libraries Project SDK.
+- Sound Cryptographic Primitives for key management, signature computations, and encryption protocols.
+- Script Level Constructs with network-compliant script interpreter.
+- Comprehensive Transaction Construction and Signing API.
+- Mechanisms for Transaction Broadcast Management.
+- Tools for Merkle Proof Verification and representation.
+- Structures and interfaces for full Serializable SPV Structures.
+- Enhanced mechanisms for Secure Encryption and Signed Messages.
+
+---
+
+### Template for New Releases:
+
+Replace `X.X.X` with the new version number and `YYYY-MM-DD` with the release date:
+
+```
+## [X.X.X] - YYYY-MM-DD
+
+### Added
+- 
+
+### Changed
+- 
+
+### Deprecated
+- 
+
+### Removed
+- 
+
+### Fixed
+- 
+
+### Security
+- 
+```
+
+Use this template as the starting point for each new version. Always update the "Unreleased" section with changes as they're implemented, and then move them under the new version header when that version is released.

package/CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# CONTRIBUTING to `@bsv/sdk`
+
+Thank you for considering contributing to the BSV Blockchain Libraries Project! This document outlines the processes and practices we expect contributors to adhere to.
+
+## Table of Contents
+
+1. [General Guidelines](#general-guidelines)
+2. [Code of Conduct](#code-of-conduct)
+3. [Getting Started](#getting-started)
+4. [Pull Request Process](#pull-request-process)
+5. [Coding Conventions](#coding-conventions)
+6. [Documentation and Testing](#documentation-and-testing)
+7. [Contact & Support](#contact--support)
+
+## General Guidelines
+
+- **Issues First**: If you're planning to add a new feature or change existing behavior, please open an issue first. This allows us to avoid multiple people working on similar features and provides a place for discussion.
+  
+- **Stay Updated**: Always pull the latest changes from the main branch before creating a new branch or starting on new code.
+  
+- **Simplicity Over Complexity**: Your solution should be as simple as possible, given the requirements.
+
+## Code of Conduct
+
+### Posting Issues and Comments
+
+- **Be Respectful**: Everyone is here to help and grow. Avoid any language that might be considered rude or offensive.
+  
+- **Be Clear and Concise**: Always be clear about what you're suggesting or reporting. If an issue is related to a particular piece of code or a specific error message, include that in your comment.
+  
+- **Stay On Topic**: Keep the conversation relevant to the issue at hand. If you have a new idea or unrelated question, please open a new issue.
+
+### Coding and PRs
+
+- **Stay Professional**: Avoid including "fun" code, comments, or irrelevant file changes in your commits and pull requests.
+
+## Getting Started
+
+1. **Fork the Repository**: Click on the "Fork" button at the top-right corner of this repository.
+  
+2. **Clone the Forked Repository**: `git clone https://github.com/YOUR_USERNAME/ts-sdk.git`
+
+3. **Navigate to the Directory**: `cd bsv-sdk`
+
+4. **Install Dependencies**: Since we maintain all code within this library, there shouldn't be any runtime dependencies. Nevertheless, always run `npm install` after pulling to ensure tooling is up to date.
+
+## Pull Request Process
+
+1. **Create a Branch**: For every new feature or bugfix, create a new branch.
+  
+2. **Commit Your Changes**: Make your changes and commit them. Commit messages should be clear and concise to explain what was done.
+  
+3. **Run Tests**: Ensure all tests pass using Jest: `npm test`.
+  
+4. **Documentation**: All code must be fully annotated with comments. Update the documentation by running `npm run doc` before creating a pull request.
+  
+5. **Push to Your Fork**: `git push origin your-new-branch`.
+  
+6. **Open a Pull Request**: Go to your fork on GitHub and click "New Pull Request". Fill out the PR template, explaining your changes.
+  
+7. **Code Review**: At least two maintainers must review and approve the PR before it's merged. Address any feedback or changes requested.
+  
+8. **Merge**: Once approved, the PR will be merged into the main branch.
+
+## Coding Conventions
+
+- **Code Style**: We use `ts-standard` for our TypeScript coding style. Run `npm run lint` to ensure your code adheres to this style.
+  
+- **No Runtime Dependencies**: All code should be maintained within this library. Do not introduce external dependencies.
+  
+- **Testing**: Always include tests for new code or changes. We aim for industry-standard levels of test coverage.
+  
+- **Documentation**: All functions, classes, and modules should be documented. Use annotation comments to describe the purpose, parameters, and return values.
+
+## Documentation and Testing
+
+- **Documentation**: Update the documentation whenever you add or modify the code. Run `npm run doc` to generate the latest docs.
+  
+- **Testing**: We use Jest for all tests. Write comprehensive tests, ensuring edge cases are covered. All PRs should maintain or improve the current test coverage.
+
+## Contact & Support
+
+If you have any questions or need assistance with your contributions, feel free to reach out. Remember, we're here to help each other grow and improve the `@bsv/sdk`.
+
+Thank you for being a part of this journey. Your contributions help shape the future of the BSV Blockchain Libraries Project!

package/LICENSE.txt

@@ -0,0 +1,28 @@
+Open BSV License version 4
+
+Copyright (c) 2023 BSV Blockchain Association ("Bitcoin Association")
+ 
+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:
+ 
+1 - The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+2 - The Software, and any software that is derived from the Software or parts thereof,
+can only be used on the Bitcoin SV blockchains. The Bitcoin SV blockchains are defined,
+for purposes of this license, as the Bitcoin blockchain containing block height #556767
+with the hash "000000000000000001d956714215d96ffc00e0afda4cd0a96c96f8d802b1662b" and
+that contains the longest persistent chain of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin white paper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository or another repository designated by Bitcoin Association,
+as well as the test blockchains that contain the longest persistent chains of blocks accepted by this Software and which are valid under the rules set forth in the Bitcoin whitepaper (S. Nakamoto, Bitcoin: A Peer-to-Peer Electronic Cash System, posted online October 2008) and the latest version of this Software available in this repository, or another repository designated by Bitcoin Association
+ 
+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

@@ -0,0 +1,87 @@
+# BSV SDK
+
+BSV BLOCKCHAIN | Standard Development Kit for JavaScript and TypeScript
+
+Welcome to the BSV Blockchain Libraries Project, the comprehensive TypeScript SDK designed to provide an updated and unified layer for developing scalable applications on the BSV Blockchain. This SDK addresses the limitations of previous tools by offering a fresh, peer-to-peer approach, adhering to SPV, and ensuring privacy and scalability.
+
+## Table of Contents
+
+1. [Objective](#objective)
+2. [Getting Started](#getting-started)
+3. [Features & Deliverables](#features--deliverables)
+4. [Documentation](#documentation)
+5. [Contribution Guidelines](#contribution-guidelines)
+6. [Support & Contacts](#support--contacts)
+
+## Objective
+
+The BSV Blockchain Libraries Project aims to structure and maintain a middleware layer of the BSV Blockchain technology stack. By facilitating the development and maintenance of core libraries, it serves as an essential toolkit for developers looking to build on the BSV Blockchain.
+
+## Getting Started
+
+### Installation
+
+To install the SDK, run:
+
+```bash
+npm install @bsv/sdk
+```
+
+### Basic Usage
+
+Here's a simple example of using the SDK to create and sign a transaction:
+
+```typescript
+// TODO: Code Example Will Go Here
+```
+
+For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).
+
+## Features & Deliverables
+
+- **Sound Cryptographic Primitives**: Secure key management, signature computations, and encryption protocols.
+  
+- **Script Level Constructs**: Network-compliant script interpreter with support for custom scripts and serialization formats.
+  
+- **Transaction Construction and Signing**: Comprehensive transaction builder API, ensuring versatile and secure transaction creation.
+  
+- **Transaction Broadcast Management**: Mechanisms to send transactions to both miners and overlays, ensuring extensibility and future-proofing.
+  
+- **Merkle Proof Verification**: Tools for representing and verifying merkle proofs, adhering to various serialization standards.
+  
+- **Serializable SPV Structures**: Structures and interfaces for full SPV verification.
+  
+- **Secure Encryption and Signed Messages**: Enhanced mechanisms for encryption and digital signatures, replacing outdated methods.
+
+## Documentation
+
+The SDK is richly documented with code-level annotations. This should show up well within editors like VSCode. For complete API docs, check out [the docs folder](./docs). Please refer to the [Libraries Wiki](#) (link to be provided) for a deep dive into each feature, tutorials, and usage examples.
+
+## Contribution Guidelines
+
+We're always looking for contributors to help us improve the SDK. Whether it's bug reports, feature requests, or pull requests - all contributions are welcome.
+
+1. **Fork & Clone**: Fork this repository and clone it to your local machine.
+2. **Set Up**: Run `npm install` to install all dependencies.
+3. **Make Changes**: Create a new branch and make your changes.
+4. **Test**: Ensure all tests pass by running `npm test`.
+5. **Commit**: Commit your changes and push to your fork.
+6. **Pull Request**: Open a pull request from your fork to this repository.
+
+For more details, check the [contribution guidelines](./CONTRIBUTING.md).
+
+For information on past releases, check out the [changelog](./CHANGELOG.md). For future plans, check the [roadmap](./ROADMAP.md)!
+
+## Support & Contacts
+
+Project Owners: Thomas Giacomo and Darren Kellenschwiler
+
+Development Team Lead: Ty Everett
+
+For questions, bug reports, or feature requests, please open an issue on GitHub or contact us directly.
+
+## License
+
+The license for the code in this repository is the Open BSV License. Refer to [LICENSE.txt](./LICENSE.txt) for the license text.
+
+Thank you for being a part of the BSV Blockchain Libraries Project. Let's build the future of BSV Blockchain together!

package/ROADMAP.md

@@ -0,0 +1,3 @@
+# ROADMAP
+
+Until version 1.0 of this library is released, the roadmap is being managed internally by the development team. Please reach out if you have any questions.

package/dist/cjs/mod.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/primitives/index.js"), exports);
+__exportStar(require("./src/script/index.js"), exports);
+__exportStar(require("./src/script/templates/index.js"), exports);
+__exportStar(require("./src/transaction/index.js"), exports);
+__exportStar(require("./src/transaction/fee-models/index.js"), exports);
+__exportStar(require("./src/transaction/broadcasters/index.js"), exports);
+__exportStar(require("./src/messages/index.js"), exports);
+__exportStar(require("./src/compat/index.js"), exports);
+//# sourceMappingURL=mod.js.map

package/dist/cjs/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","sourceRoot":"","sources":["../../mod.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAAyC;AACzC,wDAAqC;AACrC,kEAA+C;AAC/C,6DAA0C;AAC1C,wEAAqD;AACrD,0EAAuD;AACvD,0DAAuC;AACvC,wDAAqC"}

package/dist/cjs/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@bsv/sdk",
+  "version": "1.0.0",
+  "type": "commonjs",
+  "description": "BSV Blockchain Standard Development Kit",
+  "scripts": {
+    "test": "npm run build && jest",
+    "test:watch": "npm run build && jest --watch",
+    "test:coverage": "npm run build && jest --coverage",
+    "lint": "ts-standard --fix src/**/*.ts",
+    "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
+    "dev": "tsc -b -w",
+    "prepublish": "npm run build",
+    "doc": "ts2md --inputFilename=src/script/index.ts --outputFilename=docs/script.md --filenameSubString=script --firstHeadingLevel=1 && ts2md --inputFilename=src/primitives/index.ts --outputFilename=docs/primitives.md --filenameSubString=primitives --firstHeadingLevel=1 && ts2md --inputFilename=src/transaction/index.ts --outputFilename=docs/transaction.md --filenameSubString=transaction --firstHeadingLevel=1 && ts2md --inputFilename=src/messages/index.ts --outputFilename=docs/messages.md --filenameSubString=messages --firstHeadingLevel=1 && ts2md --inputFilename=src/compat/index.ts --outputFilename=docs/compat.md --filenameSubString=compat --firstHeadingLevel=1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bitcoin-sv/sdk.git"
+  },
+  "keywords": [
+    "BSV",
+    "Blockchain",
+    "SDK",
+    "Bitcoin",
+    "SV"
+  ],
+  "author": "BSV Blockchain Association",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "bugs": {
+    "url": "https://github.com/bitcoin-sv/sdk/issues"
+  },
+  "homepage": "https://github.com/bitcoin-sv/sdk#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.5",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1",
+    "ts-standard": "^12.0.2",
+    "ts2md": "^0.2.0",
+    "tsconfig-to-dual-package": "^1.2.0",
+    "typescript": "^5.2.2"
+  }
+}