@bsv/sdk 1.6.9 → 1.6.11

package/docs/guides/http-client-configuration.md

@@ -0,0 +1,414 @@
+# Configuring HTTP Clients
+
+This guide covers how to configure HTTP clients for use with the BSV TypeScript SDK, focusing on Axios and alternatives.
+
+## Using Axios with the SDK
+
+The BSV TypeScript SDK allows you to provide your own HTTP client implementation for network requests. This is particularly useful when you need custom configuration for transaction broadcasting, network queries, or when working in specific environments.
+
+### Basic Axios Setup
+
+```typescript
+import axios from 'axios'
+import { BSV } from '@bsv/sdk'
+
+// Create a configured Axios instance
+const customAxios = axios.create({
+  timeout: 10000, // 10 seconds
+  headers: {
+    'Content-Type': 'application/json',
+    'Accept': 'application/json'
+  }
+})
+
+// Use the custom client when broadcasting transactions
+const broadcastTransaction = async (tx) => {
+  try {
+    // Convert the transaction to hex format
+    const txHex = tx.toHex()
+    
+    // Use your custom axios instance for the request
+    const response = await customAxios.post('https://api.example.com/v1/tx/broadcast', {
+      rawTx: txHex
+    })
+    
+    return response.data
+  } catch (error) {
+    console.error('Error broadcasting transaction:', error)
+    throw error
+  }
+}
+```
+
+### Using Axios with ARC Broadcaster
+
+The ARC (Alternative Revenue Channel) broadcaster can be configured with a custom HTTP client:
+
+```typescript
+import axios from 'axios'
+import { ARC } from '@bsv/sdk'
+
+// Configure Axios
+const customAxios = axios.create({
+  timeout: 15000,
+  headers: {
+    'Authorization': 'Bearer YOUR_API_KEY',
+    'Content-Type': 'application/json'
+  }
+})
+
+// Create an ARC instance with custom HTTP client
+const arc = new ARC({
+  apiUrl: 'https://api.taal.com/arc',
+  httpClient: customAxios
+})
+
+// Use the configured ARC instance to broadcast a transaction
+const broadcastWithARC = async (tx) => {
+  try {
+    // ARC expects hex format
+    const txid = await arc.broadcast(tx.toHex())
+    return txid
+  } catch (error) {
+    console.error('ARC broadcast error:', error)
+    throw error
+  }
+}
+```
+
+## Advanced HTTP Client Configuration
+
+### Handling Timeouts and Retries
+
+```typescript
+import axios from 'axios'
+import axiosRetry from 'axios-retry'
+
+// Create a custom Axios instance
+const client = axios.create({
+  timeout: 30000 // 30 seconds
+})
+
+// Configure automatic retries
+axiosRetry(client, {
+  retries: 3,
+  retryDelay: axiosRetry.exponentialDelay,
+  retryCondition: (error) => {
+    // Retry on network errors or 5xx responses
+    return axiosRetry.isNetworkOrIdempotentRequestError(error) || 
+           (error.response && error.response.status >= 500)
+  }
+})
+
+// Add request interceptor for logging
+client.interceptors.request.use(request => {
+  console.log('Starting request:', request.url)
+  return request
+})
+
+// Add response interceptor for error handling
+client.interceptors.response.use(
+  response => response,
+  error => {
+    if (error.response) {
+      console.error('Server responded with error:', error.response.status, error.response.data)
+    } else if (error.request) {
+      console.error('No response received:', error.request)
+    } else {
+      console.error('Error setting up request:', error.message)
+    }
+    return Promise.reject(error)
+  }
+)
+```
+
+### Environment-specific Configuration
+
+```typescript
+import axios from 'axios'
+
+const getConfiguredClient = (environment = 'production') => {
+  const baseURLs = {
+    production: 'https://api.taal.com',
+    staging: 'https://api-staging.taal.com',
+    development: 'http://localhost:3000'
+  }
+
+  const timeouts = {
+    production: 10000,
+    staging: 15000,
+    development: 30000
+  }
+
+  return axios.create({
+    baseURL: baseURLs[environment],
+    timeout: timeouts[environment],
+    headers: {
+      'Content-Type': 'application/json'
+    }
+  })
+}
+
+const productionClient = getConfiguredClient('production')
+const developmentClient = getConfiguredClient('development')
+```
+
+## SDK Built-in HTTP Clients
+
+The BSV TypeScript SDK comes with built-in HTTP client implementations that you can use directly. The SDK automatically selects the appropriate client based on your environment through the `defaultHttpClient()` function.
+
+### Using NodejsHttpClient
+
+The SDK includes a Node.js-specific HTTP client implementation that uses the Node.js `https` module:
+
+```typescript
+import { NodejsHttpClient } from '@bsv/sdk'
+import https from 'https'
+
+// Create a NodejsHttpClient instance
+const nodeClient = new NodejsHttpClient(https)
+
+// Use with ARC
+const arc = new ARC('https://api.taal.com/arc', {
+  apiKey: 'your-api-key',
+  httpClient: nodeClient
+})
+
+// Example of broadcasting a transaction
+const broadcastTx = async (tx) => {
+  try {
+    const txid = await arc.broadcast(tx)
+    console.log('Transaction broadcast successful. TXID:', txid)
+    return txid
+  } catch (error) {
+    console.error('Error broadcasting transaction:', error)
+    throw error
+  }
+}
+```
+
+### Using Built-in FetchHttpClient
+
+In browser environments, the SDK provides a `FetchHttpClient` implementation that uses the Fetch API:
+
+```typescript
+import { FetchHttpClient, ARC } from '@bsv/sdk'
+
+// Create a FetchHttpClient instance with custom fetch options
+const fetchClient = new FetchHttpClient(window.fetch.bind(window))
+
+// Use with ARC
+const arc = new ARC('https://api.taal.com/arc', {
+  apiKey: 'your-api-key',
+  httpClient: fetchClient
+})
+```
+
+### Using defaultHttpClient
+
+The SDK provides a `defaultHttpClient()` function that automatically selects the appropriate HTTP client based on the environment:
+
+```typescript
+import { defaultHttpClient, ARC } from '@bsv/sdk'
+
+// Get the default HTTP client for the current environment
+const client = defaultHttpClient()
+
+// Use with ARC
+const arc = new ARC('https://api.taal.com/arc', {
+  apiKey: 'your-api-key',
+  httpClient: client
+})
+```
+
+## Alternative HTTP Clients
+
+While the SDK provides built-in HTTP clients and Axios is commonly used, you can implement your own HTTP clients with the BSV TypeScript SDK:
+
+### Using Fetch API
+
+```typescript
+import { ARC } from '@bsv/sdk'
+
+// Create a fetch-based HTTP client
+const fetchClient = {
+  post: async (url, data, options = {}) => {
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        ...options.headers
+      },
+      body: JSON.stringify(data)
+    })
+    
+    if (!response.ok) {
+      const errorText = await response.text()
+      throw new Error(`HTTP error ${response.status}: ${errorText}`)
+    }
+    
+    return await response.json()
+  },
+  
+  get: async (url, options = {}) => {
+    const response = await fetch(url, {
+      method: 'GET',
+      headers: {
+        'Accept': 'application/json',
+        ...options.headers
+      }
+    })
+    
+    if (!response.ok) {
+      const errorText = await response.text()
+      throw new Error(`HTTP error ${response.status}: ${errorText}`)
+    }
+    
+    return await response.json()
+  }
+}
+
+// Use with ARC
+const arc = new ARC({
+  apiUrl: 'https://api.taal.com/arc',
+  httpClient: fetchClient
+})
+```
+
+## Testing and Mocking HTTP Clients
+
+When testing your application, you may want to mock HTTP responses:
+
+```typescript
+import { ARC } from '@bsv/sdk'
+
+// Create a mock HTTP client for testing
+const mockHttpClient = {
+  post: jest.fn().mockResolvedValue({ data: { txid: '1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef' } }),
+  get: jest.fn().mockResolvedValue({ data: { status: 'confirmed' } })
+}
+
+// Create an ARC instance with the mock client
+const arc = new ARC({
+  apiUrl: 'https://api.example.com/arc',
+  httpClient: mockHttpClient
+})
+
+// Test transaction broadcasting
+const testBroadcast = async () => {
+  const mockTxHex = '0100000001...'
+  const result = await arc.broadcast(mockTxHex)
+  
+  // Verify the mock was called correctly
+  expect(mockHttpClient.post).toHaveBeenCalledWith(
+    'https://api.example.com/arc/tx',
+    { rawTx: mockTxHex },
+    expect.any(Object)
+  )
+  
+  return result
+}
+```
+
+## Implementing a Custom HTTP Client
+
+You can create your own HTTP client implementation by implementing the `HttpClient` interface from the SDK. This gives you complete control over how HTTP requests are handled:
+
+```typescript
+import { HttpClient, HttpClientResponse, HttpClientRequestOptions, ARC } from '@bsv/sdk'
+
+// Implement the HttpClient interface
+class CustomHttpClient implements HttpClient {
+  constructor(private readonly options: { timeout?: number } = {}) {}
+  
+  async request<T = any>(
+    url: string,
+    options: HttpClientRequestOptions
+  ): Promise<HttpClientResponse<T>> {
+    console.log(`Making ${options.method} request to ${url}`)
+    
+    try {
+      // Set up timeout
+      const timeout = this.options.timeout || 10000
+      const controller = new AbortController()
+      const timeoutId = setTimeout(() => controller.abort(), timeout)
+      
+      // Prepare fetch options
+      const fetchOptions: RequestInit = {
+        method: options.method || 'GET',
+        headers: options.headers,
+        signal: controller.signal,
+        body: options.data ? JSON.stringify(options.data) : undefined
+      }
+      
+      // Make the request
+      const response = await fetch(url, fetchOptions)
+      clearTimeout(timeoutId)
+      
+      // Parse response
+      let data: any
+      const contentType = response.headers.get('content-type')
+      if (contentType && contentType.includes('application/json')) {
+        data = await response.json()
+      } else {
+        data = await response.text()
+      }
+      
+      // Return formatted response
+      return {
+        status: response.status,
+        statusText: response.statusText,
+        ok: response.ok,
+        data
+      }
+    } catch (error) {
+      console.error('Request failed:', error)
+      return {
+        status: 500,
+        statusText: error.message || 'Request failed',
+        ok: false,
+        data: { error: error.message }
+      }
+    }
+  }
+}
+
+// Use the custom client with ARC
+const customClient = new CustomHttpClient({ timeout: 15000 })
+const arc = new ARC('https://api.taal.com/arc', {
+  apiKey: 'your-api-key',
+  httpClient: customClient
+})
+
+// Example broadcasting a transaction with the custom client
+const broadcastTx = async (tx) => {
+  try {
+    // Make sure to use toHex() for proper serialization
+    const txHex = tx.toHex()
+    const result = await arc.broadcast(tx)
+    
+    // Transaction ID needs specific handling
+    console.log('Transaction broadcast successful. TXID:', result.txid)
+    return result
+  } catch (error) {
+    console.error('Error broadcasting transaction:', error)
+    throw error
+  }
+}
+```
+
+## Best Practices
+
+1. **Always set timeouts** - Network requests can hang indefinitely without proper timeouts
+2. **Implement retries** - Especially for transaction broadcasting, retries can improve reliability
+3. **Add proper error handling** - Parse and handle HTTP errors appropriately
+4. **Configure request logging** - Log requests and responses for debugging purposes
+5. **Use environment variables** - Store API keys and endpoints in environment variables
+6. **Consider rate limiting** - Implement backoff strategies for rate-limited APIs
+7. **Use the built-in clients** - The SDK's `defaultHttpClient()` handles environment detection automatically
+
+## Related Resources
+
+- [Axios Documentation](https://axios-http.com/docs/intro)
+- [ARC API Reference](../reference/arc.md)
+- [Transaction Broadcasting Guide](./transaction-monitoring.md)

package/docs/guides/index.md

@@ -0,0 +1,30 @@
+# How-To Guides
+
+Practical, problem-oriented guides to help you accomplish specific tasks with the BSV TypeScript SDK.
+
+## Transaction Management
+
+### [Transaction Signing Methods](./transaction-signing-methods.md)
+- `WalletClient` approach for secure key management
+- Low-level API approach for direct control
+- Comparison of different signing methods
+- Best practices for transaction signing
+
+### [Creating Transactions with Direct Interfaces](./direct-transaction-creation.md)
+- Lower-level transaction construction using direct SDK interfaces
+- Custom transaction types not supported by `WalletClient`
+- Precise control over UTXO selection
+- Educational examples for understanding transaction structure
+
+## Network Integration
+
+### [Configuring HTTP Clients](./http-client-configuration.md)
+- Axios integration and setup
+- Custom request timeout configuration
+- Error handling and retries
+- Alternative HTTP client options
+- Browser and Node.js environment considerations
+
+---
+
+*More guides are planned for future releases. Check back regularly for updates on transaction batching, security best practices, wallet integration, and more advanced topics.*