astra-modal-test 1.0.5 → 1.0.7

package/.github/workflows/code-quality.yml

@@ -0,0 +1,43 @@
+name: Code Quality Check
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      actions: read
+      checks: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: github/codeql-action/init@v3
+        with:
+          languages: javascript
+
+      - uses: github/codeql-action/analyze@v3
+
+  eslint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: "npm"
+      - run: yarn install
+      - run: yarn lint

package/.github/workflows/publish.yml

@@ -0,0 +1,64 @@
+name: Build and Publish to NPM
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: prod-deploy
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Build
+        run: npm run build
+
+      - name: Generate build hash
+        id: build-hash
+        run: |
+          BUILD_HASH=$(find dist -type f -exec sha256sum {} \; | sha256sum | cut -d' ' -f1)
+          echo "build_hash=$BUILD_HASH" >> $GITHUB_OUTPUT
+          echo "Build hash: $BUILD_HASH"
+
+
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          BUILD_TIME=$(date -u +%Y-%m-%dT%H:%M:%SZ)
+          echo "{\"version\":\"$PACKAGE_VERSION\",\"buildHash\":\"$BUILD_HASH\",\"buildTime\":\"$BUILD_TIME\"}" > dist/build-info.json
+
+      - name: Check if package should be published
+        id: check-publish
+        run: |
+          PACKAGE_NAME=$(node -p "require('./package.json').name")
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          if npm view $PACKAGE_NAME@$PACKAGE_VERSION version > /dev/null 2>&1; then
+            echo "Version $PACKAGE_VERSION of $PACKAGE_NAME is already published on NPM. Skipping publish."
+            echo "should_publish=false" >> $GITHUB_OUTPUT
+          else
+            echo "Version $PACKAGE_VERSION of $PACKAGE_NAME is new. Proceeding to publish."
+            echo "should_publish=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts-${{ steps.build-hash.outputs.build_hash }}
+          path: |
+            dist/
+            !dist/**/*.map
+
+      - name: Publish new version
+        if: steps.check-publish.outputs.should_publish == 'true'
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,204 @@
+# Astra SDK
+
+Astra SDK is a powerful React library that enables seamless asset bridging between EVM-compatible blockchains and the Bitcoin Lightning Network. Built with modern web technologies, it provides developers with an easy-to-integrate solution for cross-chain liquidity and payments.
+
+## ✨ Features
+
+- **Cross-Chain Bridge**: Bridge assets between EVM chains and Lightning Network
+- **Multi-Chain Support**: Support for Ethereum, Base, BSC, Botanix testnet, and more
+- **Wallet Integration**: Built-in support for WalletConnect and popular Web3 wallets
+- **TypeScript Ready**: Full TypeScript support with type definitions
+- **Responsive Design**: Mobile-first design with responsive UI components
+- **Real-time Updates**: Live transaction status and balance updates
+- **Customizable Theme**: Dark theme with customizable styling
+
+## 🚀 Quick Start
+
+### Installation
+
+```bash
+npm install astra-modal
+# or
+yarn add astra-modal
+```
+
+### Basic Usage
+
+```jsx
+import React from 'react';
+import { AstraProvider, AstraModal, astraSend, astraReceive } from 'astra-modal';
+
+function App() {
+  return (
+    <AstraProvider 
+      projectId="your-project-id" 
+    >
+      <AstraModal />
+      
+      {/* Lightning to EVM */}
+      <button onClick={() => astraSend({
+        assetId: "your-asset-id",
+        amount: 1000
+      })}>
+        Bridge from Lightning
+      </button>
+      
+      {/* EVM to Lightning */}
+      <button onClick={() => astraReceive({
+        assetId: "your-asset-id",
+        invoice: "lnbc..."
+      })}>
+        Bridge to Lightning
+      </button>
+    </AstraProvider>
+  );
+}
+```
+
+## 📖 API Reference
+
+### AstraProvider
+
+The main provider component that wraps your application.
+
+```jsx
+<AstraProvider
+  projectId={string}        // WalletConnect project ID (required)
+>
+  {children}
+</AstraProvider>
+```
+
+### astraSend
+
+Bridge assets from Lightning Network to EVM chains.
+
+```jsx
+astraSend({
+  assetId: string,      // Asset identifier
+  amount: number,       // Amount to bridge (in satoshis)
+  onAstraInvoice?: (invoice, tx, txUrl) => void,  // Callback for invoice
+});
+```
+
+### astraReceive
+
+Bridge assets from EVM chains to Lightning Network.
+
+```jsx
+astraReceive({
+  assetId: string,      // Asset identifier
+  invoice: string       // Lightning invoice
+});
+```
+
+## 🏗️ Development
+
+### Prerequisites
+
+- Node.js 16+ 
+- npm or yarn
+- React 18+
+
+### Local Development
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd astrasdk
+
+# Install dependencies (use npm only)
+npm install
+
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+
+# Run linter
+npm run lint
+```
+
+**Note**: This project uses npm as the package manager. Please avoid using yarn to prevent compatibility issues.
+
+### Environment Configuration
+
+For development, you can use the provided test configuration:
+
+```jsx
+const projectId = "your-test-project-id";
+```
+
+## 🔧 Technical Stack
+
+- **React 18** - UI library
+- **Wagmi** - React hooks for Ethereum
+- **Viem** - TypeScript interface for Ethereum
+- **Reown AppKit** - Wallet connection
+- **Ant Design** - UI components
+- **Styled Components** - CSS-in-JS styling
+- **Zustand** - State management
+- **Axios** - HTTP client
+- **Decimal.js** - Precise decimal arithmetic
+
+## 🌐 Supported Networks
+
+### Production Networks
+- **BSC** - Binance Smart Chain
+- **Base** - Coinbase Layer 2
+
+### Development Networks
+- **Sepolia** - Ethereum testnet
+- **Base Sepolia** - Base testnet
+- **Botanix** - Bitcoin EVM testnet
+
+## 📱 Mobile Support
+
+The SDK is fully responsive and optimized for mobile devices with:
+- Touch-friendly interfaces
+- Responsive modal design
+- Mobile wallet compatibility
+- Optimized font sizes and spacing
+
+## 🔐 Security Features
+
+- Secure wallet connections via WalletConnect
+- Transaction validation and verification
+- Real-time status monitoring
+- Error handling and user feedback
+- Safe contract interactions
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our contributing guidelines:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Submit a pull request
+
+## 📞 Support
+
+For support and questions:
+- Create an issue in the GitHub repository
+- Check the documentation
+- Review example implementations
+
+## 🔄 Changelog
+
+### v1.0.34
+- Initial public release
+- EVM ↔ Lightning bridge functionality
+- Multi-chain support
+- Wallet integration
+- Responsive design
+
+---
+
+Built with ❤️ by the Astra Labs team