@bsv/sdk 1.0.0 → 1.0.1

package/docs/getting-started/VUE.md

@@ -1,103 +0,0 @@
-# Getting Started with BSV SDK in a Vue TypeScript Project
-
-Welcome to the quick start guide for integrating the BSV SDK into your Vue TypeScript project. This guide will walk you through the setup and basic usage of the BSV SDK, enabling you to build scalable applications on the BSV Blockchain. Let’s dive into how you can add blockchain capabilities to your Vue application.
-
-## Prerequisites
-
-Before starting, ensure you have the following installed:
-- Node.js (12.x or later)
-- npm (6.x or later)
-- Vue CLI (3.x or later)
-
-If you're new to Vue or TypeScript, it might be helpful to familiarize yourself with the basics of creating a Vue project with TypeScript support.
-
-## Step 1: Create Your Vue Project
-
-If you haven't already, start by creating a new Vue project. Open your terminal and run:
-
-```bash
-vue create my-bsv-app
-```
-
-During the setup, choose "Manually select features" to select TypeScript. Follow the prompts to set up TypeScript with Vue.
-
-## Step 2: Install the BSV SDK
-
-Navigate to your project directory in the terminal and install the BSV SDK by running:
-
-```bash
-npm install @bsv/sdk
-```
-
-This command will add the BSV SDK as a dependency to your project, making its functionality available for use in your Vue components.
-
-## Step 3: Initialize the SDK in Your Vue Application
-
-Create a new file `bsvPlugin.ts` in your project's `src` directory. This file will set up the BSV SDK so that it can be easily used throughout your application.
-
-```typescript
-// src/bsvPlugin.ts
-
-import { createApp } from 'vue';
-import App from './App.vue';
-
-// Import the SDK
-import * as BSV from '@bsv/sdk';
-
-const app = createApp(App);
-
-// Here you can add BSV SDK to Vue's global properties for easy access in components
-app.config.globalProperties.$bsv = BSV;
-
-app.mount('#app');
-```
-
-Update your `main.ts` to use this new setup:
-
-```typescript
-// src/main.ts
-
-import './bsvPlugin';
-```
-
-## Step 4: Using the BSV SDK in Your Components
-
-Now that you have the BSV SDK integrated into your Vue application, you can start using it in your components. Here's an example of how to create and sign a transaction within a Vue component:
-
-1. **Create a new Vue component** `TransactionComponent.vue` in your `src/components` directory.
-2. **Implement the BSV SDK logic** within your component:
-
-```vue
-<template>
-  <div>
-    <h1>Create and Sign a Transaction</h1>
-    <!-- Transaction form and submission button will go here -->
-  </div>
-</template>
-
-<script lang="ts">
-import { defineComponent } from 'vue';
-
-export default defineComponent({
-  name: 'TransactionComponent',
-  methods: {
-    async createAndSignTransaction() {
-      // Access the BSV SDK from the global properties
-      const BSV = this.$bsv;
-
-      // Example: Creating a new PublicKey
-      const privateKey = BSV.PrivateKey.fromRandom();
-      const publicKey = privateKey.toPublicKey();
-
-      console.log('PublicKey:', publicKey.toString());
-
-      // Add your transaction logic here
-    }
-  }
-});
-</script>
-```
-
-## Step 5: Interacting with the Blockchain
-
-With the BSV SDK now part of your Vue application, you can extend the functionality as needed to interact with the BSV Blockchain. Use the SDK's comprehensive API to create transactions, manage keys, verify signatures, and much more.

package/jest.config.js

@@ -1,6 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-export default {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  testPathIgnorePatterns: ['dist/']
-}

package/mod.ts

@@ -1,8 +0,0 @@
-export * from "./src/primitives/index.js"
-export * from "./src/script/index.js"
-export * from "./src/script/templates/index.js"
-export * from "./src/transaction/index.js"
-export * from "./src/transaction/fee-models/index.js"
-export * from "./src/transaction/broadcasters/index.js"
-export * from "./src/messages/index.js"
-export * from "./src/compat/index.js"

package/src/compat/BSM.ts

@@ -1,51 +0,0 @@
-import BigNumber from '../primitives/BigNumber.js'
-import { Writer, toArray } from '../primitives/utils.js'
-import * as ECDSA from '../primitives/ECDSA.js'
-import * as Hash from '../primitives/Hash.js'
-import PrivateKey from '../primitives/PrivateKey.js'
-import PublicKey from '../primitives/PublicKey.js'
-import Signature from '../primitives/Signature.js'
-
-const prefix = 'Bitcoin Signed Message:\n'
-
-/**
- * Generates a SHA256 double-hash of the prefixed message.
- * @deprecated Replaced by BRC-77 which uses a more secure and private method for message signing.
- * @param messageBuf The message buffer to be hashed.
- * @returns The double-hash of the prefixed message as a number array.
- */
-export const magicHash = (messageBuf: number[]): number[] => {
-    const bw = new Writer()
-    bw.writeVarIntNum(prefix.length)
-    bw.write(toArray(prefix, 'utf8'))
-    bw.writeVarIntNum(messageBuf.length)
-    bw.write(messageBuf)
-    const buf = bw.toArray()
-    const hashBuf = Hash.hash256(buf) as number[]
-    return hashBuf
-}
-
-/**
- * Signs a BSM message using the given private key.
- * @deprecated Replaced by BRC-77 which employs BRC-42 key derivation and BRC-43 invoice numbers for enhanced security and privacy.
- * @param message The message to be signed as a number array.
- * @param privateKey The private key used for signing the message.
- * @returns The signature object.
- */
-export const sign = (message: number[], privateKey: PrivateKey): Signature => {
-    const hashBuf = magicHash(message)
-    return ECDSA.sign(new BigNumber(hashBuf), privateKey, true)
-}
-
-/**
- * Verifies a BSM signed message using the given public key.
- * @deprecated Replaced by BRC-77 which provides privately-verifiable signatures and avoids key reuse.
- * @param message The message to be verified as a number array.
- * @param sig The signature object.
- * @param pubKey The public key for verification.
- * @returns True if the signature is valid, false otherwise.
- */
-export const verify = (message: number[], sig: Signature, pubKey: PublicKey): boolean => {
-    const hashBuf = magicHash(message)
-    return ECDSA.verify(new BigNumber(hashBuf), sig, pubKey)
-}