@bsv/sdk 1.0.0 → 1.0.1

package/README.md

@@ -31,8 +31,31 @@ npm install @bsv/sdk
 
 Here's a simple example of using the SDK to create and sign a transaction:
 
-```typescript
-// TODO: Code Example Will Go Here
+```javascript
+import { PrivateKey, P2PKH, Transaction, ARC } from '@bsv/sdk'
+
+const privKey = PrivateKey.fromWif('L5EY1SbTvvPNSdCYQe1EJHfXCBBT4PmnF6CDbzCm9iifZptUvDGB')
+
+const sourceTransaction = Transaction.fromHex('0200000001849c6419aec8b65d747cb72282cc02f3fc26dd018b46962f5de48957fac50528020000006a473044022008a60c611f3b48eaf0d07b5425d75f6ce65c3730bd43e6208560648081f9661b0220278fa51877100054d0d08e38e069b0afdb4f0f9d38844c68ee2233ace8e0de2141210360cd30f72e805be1f00d53f9ccd47dfd249cbb65b0d4aee5cfaf005a5258be37ffffffff03d0070000000000001976a914acc4d7c37bc9d0be0a4987483058a2d842f2265d88ac75330100000000001976a914db5b7964eecb19fcab929bf6bd29297ec005d52988ac809f7c09000000001976a914c0b0a42e92f062bdbc6a881b1777eed1213c19eb88ac00000000')
+
+const version = 1
+const input = {
+  sourceTransaction,
+  sourceOutputIndex: 0,
+  unlockingScriptTemplate: new P2PKH().unlock(privKey),
+}
+const output = {
+  lockingScript: new P2PKH().lock(privKey.toPublicKey().toHash()),
+  change: true
+}
+
+const tx = new Transaction(version, [input], [output])
+await tx.fee()
+await tx.sign()
+
+// get your api key from https://console.taal.com
+const apiKey = 'mainnet_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' // replace
+await tx.broadcast(new ARC('https://api.taal.com/arc', apiKey))
 ```
 
 For a more detailed tutorial and advanced examples, check our [Documentation](#documentation).
@@ -67,7 +90,6 @@ We're always looking for contributors to help us improve the SDK. Whether it's b
 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)!

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "BSV Blockchain Standard Development Kit",
   "main": "dist/cjs/mod.js",
   "module": "dist/esm/mod.js",
   "types": "dist/types/mod.d.ts",
+  "files": [
+    "dist",
+    "docs"
+  ],
   "exports": {
     ".": {
       "types": "./dist/types/mod.d.ts",
@@ -110,7 +114,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bitcoin-sv/sdk.git"
+    "url": "git+https://github.com/bitcoin-sv/ts-sdk.git"
   },
   "keywords": [
     "BSV",
@@ -122,9 +126,9 @@
   "author": "BSV Blockchain Association",
   "license": "SEE LICENSE IN LICENSE.txt",
   "bugs": {
-    "url": "https://github.com/bitcoin-sv/sdk/issues"
+    "url": "https://github.com/bitcoin-sv/ts-sdk/issues"
   },
-  "homepage": "https://github.com/bitcoin-sv/sdk#readme",
+  "homepage": "https://github.com/bitcoin-sv/ts-sdk#readme",
   "devDependencies": {
     "@types/jest": "^29.5.5",
     "jest": "^29.7.0",
@@ -134,4 +138,4 @@
     "tsconfig-to-dual-package": "^1.2.0",
     "typescript": "^5.2.2"
   }
-}
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,40 +0,0 @@
----
-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

@@ -1,24 +0,0 @@
----
-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

@@ -1,23 +0,0 @@
-## 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

@@ -1,72 +0,0 @@
-# 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

@@ -1,85 +0,0 @@
-# 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/ROADMAP.md

@@ -1,3 +0,0 @@
-# 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/docs/getting-started/COMMONJS.md

@@ -1,94 +0,0 @@
-# Getting Started with BSV SDK in Node.js (CommonJS)
-
-Welcome to the quick start guide for the BSV SDK, tailored for Node.js applications using CommonJS syntax. This guide will walk you through the steps to install the SDK, set up your project, and run a simple example that leverages the BSV Blockchain Libraries Project for creating and signing a transaction. Whether you're working on an existing Node.js project or starting a new one, this guide will get you up and running with the BSV SDK in no time.
-
-## Prerequisites
-
-Before you begin, ensure you have the following:
-
-- Node.js installed on your machine. The BSV SDK is compatible with Node.js version 10 or later.
-- An understanding of JavaScript or TypeScript.
-- A basic familiarity with blockchain concepts, particularly those related to Bitcoin SV (BSV).
-
-## Installation
-
-First, you'll need to install the BSV SDK in your Node.js project. If you haven't already created a project, you can do so by running `npm init` in your project directory and following the prompts.
-
-To install the SDK, open your terminal, navigate to your project directory, and run:
-
-```bash
-npm install @bsv/sdk
-```
-
-This command will download and install the BSV SDK and its dependencies into your project.
-
-## Setting Up Your Project
-
-To use the SDK in a Node.js project with CommonJS syntax, you'll need to require the SDK modules in your JavaScript files. Here's how to set up a basic project structure and include the BSV SDK:
-
-1. **Create a New JavaScript File:** In your project directory, create a new file named `index.js` or any other name you prefer for your main application file.
-
-2. **Require the BSV SDK:** At the top of your `index.js` file, require the BSV SDK modules you plan to use. For example, to work with transactions, you might start with:
-
-```javascript
-const { Transaction } = require('@bsv/sdk');
-```
-
-3. **Configure Your Environment:** If your project involves interacting with the BSV blockchain network (e.g., sending transactions, querying blockchain data), ensure you have the necessary network configurations and API keys set up if required by the SDK or any third-party services you're using.
-
-## Example: Creating and Signing a Transaction
-
-Let's walk through a simple example of using the BSV SDK to create and sign a transaction. This example will demonstrate how to construct a transaction, add inputs and outputs, and sign it using a private key.
-
-1. **Prepare Your Script:** In your `index.js`, start by requiring the necessary modules from the SDK. For this example, we'll need `Transaction`, `PrivateKey`, and possibly other modules depending on the complexity of your transaction.
-
-```javascript
-const { Transaction, PrivateKey } = require('@bsv/sdk');
-```
-
-2. **Create a New Transaction:** Initialize a new `Transaction` object.
-
-```javascript
-let tx = new Transaction();
-```
-
-3. **Add Inputs and Outputs:** For this example, we'll add a dummy input and output. In a real-world scenario, you would fetch UTXO (Unspent Transaction Output) data from a blockchain explorer or your wallet.
-
-```javascript
-// Dummy input and output, replace with real data
-tx.from({
-  txId: 'your_utxo_txid',
-  outputIndex: 0,
-  address: 'your_address',
-  satoshis: 1000
-});
-tx.to('recipient_address', 500); // Send 500 satoshis to recipient
-```
-
-4. **Sign the Transaction:** Use a `PrivateKey` instance to sign the transaction. Replace `'your_private_key'` with your actual private key.
-
-```javascript
-const privateKey = new PrivateKey('your_private_key');
-tx.sign(privateKey);
-```
-
-5. **Broadcast the Transaction:** The SDK may provide a method to broadcast the transaction to the BSV network. This step varies depending on the SDK's capabilities and your setup.
-
-```javascript
-// This is a conceptual step; refer to the SDK documentation for actual broadcasting
-tx.broadcast();
-```
-
-## Running Your Project
-
-After setting up your project and writing the example code, you can run your project by executing:
-
-```bash
-node index.js
-```
-
-This command will run your `index.js` file, which includes the BSV SDK transaction creation and signing logic.
-
-## Conclusion
-
-You've now seen how to get started with the BSV SDK in a Node.js (CommonJS) environment, from installation to running a simple transaction example. This guide aimed to provide a straightforward path for integrating the B

package/docs/getting-started/REACT-TS.md

@@ -1,131 +0,0 @@
-# Getting Started with BSV SDK in a React TypeScript Project
-
-Welcome to a quick start guide designed to get you up and running with the BSV SDK in your React TypeScript projects. The BSV SDK offers a comprehensive set of tools for developing applications on the BSV Blockchain, and integrating it into a React application is straightforward. Follow these steps to begin building scalable blockchain applications with ease.
-
-## Prerequisites
-
-Before you start, ensure you have the following installed:
-- Node.js (preferably the latest LTS version)
-- npm (comes with Node.js) or Yarn
-- A code editor of your choice (VSCode is recommended for TypeScript projects)
-
-## Step 1: Setting Up Your React TypeScript Project
-
-If you're starting from scratch, create a new React TypeScript project by running the following command in your terminal:
-
-```bash
-npx create-react-app my-bsv-app --template typescript
-```
-
-This command creates a new React application named `my-bsv-app` with TypeScript setup. If you already have a React TypeScript project, you can skip this step.
-
-## Step 2: Installing the BSV SDK
-
-Navigate to your project directory in the terminal and install the BSV SDK by running:
-
-```bash
-npm install @bsv/sdk
-```
-
-or if you're using Yarn:
-
-```bash
-yarn add @bsv/sdk
-```
-
-This command adds the BSV SDK to your project, allowing you to interact with the BSV Blockchain.
-
-## Step 3: Using the BSV SDK in Your React Application
-
-Now that you've installed the SDK, let's use it to create and sign a transaction. First, create a new component where you'll implement your blockchain logic.
-
-### Create a New Component
-
-In your project's `src` directory, create a new file named `BlockchainExample.tsx`. This component will demonstrate a simple usage of the BSV SDK.
-
-### Implementing the Component
-
-Paste the following code into `BlockchainExample.tsx`:
-
-```typescript
-import React from 'react';
-// Import necessary modules from the SDK
-import { PrivateKey, Transaction } from '@bsv/sdk';
-
-const BlockchainExample: React.FC = () => {
-  // Example function to create and sign a transaction
-  const createTransaction = async () => {
-    try {
-      // Replace with actual private key and addresses
-      const privateKey = new PrivateKey('<your-private-key>');
-      const fromAddress = '<from-address>';
-      const toAddress = '<to-address>';
-      const satoshis = 1000; // Amount to send
-
-      // Create a new transaction
-      let tx = new Transaction();
-      tx.from(fromAddress) // Specify the sender's address
-        .to(toAddress, satoshis) // Specify the recipient and amount
-        .sign(privateKey); // Sign the transaction with the private key
-
-      console.log('Transaction created:', tx.toString());
-      // Add logic to broadcast the transaction
-    } catch (error) {
-      console.error('Error creating transaction:', error);
-    }
-  };
-
-  return (
-    <div>
-      <h2>Blockchain Example</h2>
-      <button onClick={createTransaction}>Create Transaction</button>
-    </div>
-  );
-};
-
-export default BlockchainExample;
-```
-
-**Note:** This is a simplified example for educational purposes. Replace placeholder values with actual private keys and addresses, and implement proper error handling and security measures in your real-world applications.
-
-### Add the Component to Your App
-
-Open `src/App.tsx` and import `BlockchainExample`. Include it in your application's render method:
-
-```typescript
-import React from 'react';
-import './App.css';
-import BlockchainExample from './BlockchainExample';
-
-function App() {
-  return (
-    <div className="App">
-      <header className="App-header">
-        <BlockchainExample />
-      </header>
-    </div>
-  );
-}
-
-export default App;
-```
-
-## Step 4: Running Your Application
-
-Now that everything is set up, start your application by running:
-
-```bash
-npm start
-```
-
-or if you're using Yarn:
-
-```bash
-yarn start
-```
-
-Your application will open in your default web browser. You'll see a button labeled "Create Transaction" that, when clicked, will run the logic to create and sign a transaction using the BSV SDK.
-
-## Next Steps
-
-This guide covered the basics to get you started with the BSV SDK in a React TypeScript project. Explore the SDK's comprehensive documentation to learn more about its capabilities, such as cryptographic primitives, script-level constructs, transaction construction, and much more. Happy coding!

package/docs/getting-started/TS-NODE.md

@@ -1,106 +0,0 @@
-To get started with the BSV SDK in a Node.js TypeScript project, follow these steps to install, configure, and use the library efficiently. This guide will help you set up a basic project structure, install the SDK, and create a simple application that uses BSV SDK functionalities.
-
-### Prerequisites
-
-Before you begin, ensure you have the following installed on your system:
-
-- Node.js (version 12.x or higher)
-- npm (usually comes with Node.js)
-- TypeScript (version 3.8 or higher)
-
-You can check the versions by running `node -v` and `npm -v` in your terminal.
-
-### Step 1: Setting Up Your Project
-
-If you're starting a new project, create a new directory for your project and initialize it with npm:
-
-```bash
-mkdir my-bsv-project
-cd my-bsv-project
-npm init -y
-```
-
-Install TypeScript and ts-node (for executing TypeScript files directly) as dev dependencies:
-
-```bash
-npm install typescript ts-node --save-dev
-```
-
-Create a `tsconfig.json` file to configure TypeScript options:
-
-```json
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "commonjs",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "outDir": "./dist"
-  },
-  "include": ["src/**/*"]
-}
-```
-
-This configuration is a good starting point for Node.js projects. Adjust it as necessary for your project needs.
-
-### Step 2: Installing BSV SDK
-
-Install the BSV SDK using npm:
-
-```bash
-npm install @bsv/sdk
-```
-
-This command installs the SDK and adds it to your project's `package.json` dependencies.
-
-### Step 3: Creating a TypeScript File
-
-In your project directory, create a `src` folder to hold your TypeScript files:
-
-```bash
-mkdir src
-```
-
-Inside the `src` folder, create a file named `index.ts`. This file will contain your code to interact with the BSV blockchain using the SDK.
-
-### Step 4: Using BSV SDK in Your Project
-
-Now, let's use the SDK to create and sign a transaction as an example. Open `src/index.ts` and add the following TypeScript code:
-
-```typescript
-import { PrivateKey, Transaction } from '@bsv/sdk';
-
-async function createAndSignTransaction() {
-  const privateKey = new PrivateKey();
-  const address = privateKey.toAddress();
-  
-  const tx = new Transaction();
-  tx.from(/* UTXO details here */);
-  tx.to(address, 1000); // Send 1000 satoshis to our address
-  tx.change(address); // Return the change to our address
-  await tx.sign(privateKey);
-
-  console.log(`Transaction ID: ${tx.id()}`);
-  console.log(`Raw Transaction: ${tx.serialize()}`);
-}
-
-createAndSignTransaction().catch(console.error);
-```
-
-Note: Replace `/* UTXO details here */` with actual UTXO (Unspent Transaction Output) details. This example assumes you have some UTXOs to spend.
-
-### Step 5: Running Your Code
-
-Finally, run your TypeScript file with `ts-node`:
-
-```bash
-npx ts-node src/index.ts
-```
-
-This command compiles your TypeScript code to JavaScript and executes it, displaying the transaction ID and raw transaction in the console.
-
-### Conclusion
-
-You've now set up a basic Node.js TypeScript project using the BSV SDK. This guide covered project initialization, SDK installation, and a simple application to create and sign transactions. Explore the SDK's extensive documentation to learn more about its features and capabilities for developing on the BSV blockchain.