trust-mfa-sdk

v2.0.0

Published

2 months ago

TrustJS - Blockchain-powered MFA verification SDK. Trust is the only way.

TrustJS SDK 🔒

Blockchain-powered MFA and fraud detection for secure payments. Trust is the only way.

🚀 Quick Start

Installation

npm install trust-mfa-sdk
# or
yarn add trust-mfa-sdk
# or
pnpm add trust-mfa-sdk

Basic Usage

import TrustJS from 'trust-mfa-sdk'
import 'trust-mfa-sdk/dist/trustjs.css'

const trustjs = new TrustJS({
  publishableKey: 'pk_test_...',
  merchantId: 'your_merchant_id',
  apiUrl: 'https://api.trustjs.com'
})

// Create a payment
const payment = await trustjs.createPayment({
  amount: 599.99,
  orderId: 'order_123'
})

React Components

import { TrustJSProvider, TrustButton } from 'trust-mfa-sdk'
import 'trust-mfa-sdk/dist/trustjs.css'

function App() {
  return (
    <TrustJSProvider
      publishableKey="pk_test_..."
      merchantId="your_merchant_id"
      apiUrl="https://api.trustjs.com"
    >
      <TrustButton
        amount={599.99}
        orderId="order_123"
        onSuccess={(payment) => console.log('Success!', payment)}
        onError={(error) => console.error('Error:', error)}
      >
        Buy Now - $599.99
      </TrustButton>
    </TrustJSProvider>
  )
}

📋 Features

✅ Stripe Integration - Secure payment processing
✅ MFA Protection - Multi-factor authentication for high-value transactions
✅ Fraud Detection - Real-time risk assessment
✅ Blockchain Auditing - Immutable transaction logging on Polygon
✅ React Components - Pre-built UI components
✅ React Hooks - useTrustJS, usePayment, useMfa
✅ TypeScript Support - Full type definitions
✅ Customizable Themes - Dark and light themes
✅ Mobile Friendly - Responsive design

📖 API Reference

Constructor

new TrustJS(config)

Config Options:

| Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | publishableKey | string | ✅ | - | Your Stripe publishable key | | merchantId | string | ✅ | - | Your merchant identifier | | apiUrl | string | ❌ | 'https://api.trustjs.dev' | Backend API URL | | environment | string | ❌ | 'production' | 'development' or 'production' | | theme | string | ❌ | 'dark' | 'dark' or 'light' | | mfaThreshold | number | ❌ | 500 | Amount threshold for MFA | | enableBlockchain | boolean | ❌ | true | Enable blockchain logging | | enableAnalytics | boolean | ❌ | true | Enable analytics tracking |

Methods

`createPayment(options)`

Create a new payment with automatic MFA detection.

const payment = await trustjs.createPayment({
  amount: 599.99,
  orderId: 'order_123',
  currency: 'usd', // optional
  metadata: {} // optional
})

Returns: Promise<PaymentResult>

`verifyMfa(orderId, code)`

Verify MFA code for a payment.

const result = await trustjs.verifyMfa('order_123', '123456')

Returns: Promise<MfaResult>

`confirmPayment(clientSecret, paymentMethodId)`

Confirm a Stripe payment.

const paymentIntent = await trustjs.confirmPayment(
  clientSecret,
  paymentMethodId
)

Returns: Promise<PaymentIntent>

`getAnalytics(options)`

Get merchant analytics data.

const analytics = await trustjs.getAnalytics({
  timeRange: '7d' // '24h', '7d', '30d'
})

Returns: Promise<AnalyticsData>

`getFraudPatterns(options)`

Get detected fraud patterns.

const patterns = await trustjs.getFraudPatterns({
  timeRange: '24h'
})

Returns: Promise<FraudPattern[]>

`verifyBlockchain(transactionHash)`

Verify a blockchain transaction.

const verification = await trustjs.verifyBlockchain('0x...')

Returns: Promise<BlockchainVerification>

⚛️ React Components

TrustJSProvider

Wrap your app with the provider to enable React components and hooks.

import { TrustJSProvider } from 'trust-mfa-sdk'

<TrustJSProvider
  publishableKey="pk_test_..."
  merchantId="your_merchant_id"
  apiUrl="https://api.trustjs.com"
  theme="dark"
  mfaThreshold={500}
>
  {children}
</TrustJSProvider>

TrustButton

Pre-built payment button with MFA handling.

import { TrustButton } from 'trust-mfa-sdk'

<TrustButton
  amount={599.99}
  orderId="order_123"
  onSuccess={(payment) => console.log(payment)}
  onError={(error) => console.error(error)}
  disabled={false}
  className="custom-class"
>
  Buy Now
</TrustButton>

TrustForm

Complete payment form with card input.

import { TrustForm } from 'trust-mfa-sdk'

<TrustForm
  amount={599.99}
  orderId="order_123"
  onSuccess={(payment) => console.log(payment)}
  onError={(error) => console.error(error)}
  showAmount={true}
  showOrderId={true}
/>

TrustModal

Modal for MFA verification.

import { TrustModal } from 'trust-mfa-sdk'

<TrustModal
  isOpen={showModal}
  onClose={() => setShowModal(false)}
  orderId="order_123"
  onVerified={(result) => console.log(result)}
/>

🪝 React Hooks

useTrustJS

Access the TrustJS instance from context.

import { useTrustJS } from 'trust-mfa-sdk'

function MyComponent() {
  const trustjs = useTrustJS()
  
  const handlePayment = async () => {
    const payment = await trustjs.createPayment({
      amount: 599.99,
      orderId: 'order_123'
    })
  }
}

usePayment

Hook for managing payment state.

import { usePayment } from 'trust-mfa-sdk'

function CheckoutForm() {
  const {
    createPayment,
    confirmPayment,
    loading,
    error,
    payment
  } = usePayment()
  
  const handleSubmit = async () => {
    await createPayment({
      amount: 599.99,
      orderId: 'order_123'
    })
  }
}

useMfa

Hook for MFA verification.

import { useMfa } from 'trust-mfa-sdk'

function MfaForm() {
  const {
    verifyCode,
    resendCode,
    loading,
    error,
    verified
  } = useMfa('order_123')
  
  const handleVerify = async (code) => {
    await verifyCode(code)
  }
}

🎨 Theming

Customize the SDK appearance with CSS variables:

:root {
  --trustjs-primary: #6c63ff;
  --trustjs-background: #1a1a2e;
  --trustjs-text: #f8f9ff;
  --trustjs-border: rgba(255, 255, 255, 0.15);
  --trustjs-error: #ef4444;
  --trustjs-success: #10b981;
}

Or use the built-in themes:

const trustjs = new TrustJS({
  theme: 'light' // or 'dark'
})

🔒 Security

Best Practices

Never expose secret keys - Only use publishable keys in client-side code
Verify on backend - Always verify payments on your server
Use HTTPS - All API calls must use HTTPS in production
Store blockchain proofs - Save transaction hashes for audit trails
Implement rate limiting - Prevent abuse of OTP requests

MFA Threshold

Configure when MFA is required:

const trustjs = new TrustJS({
  mfaThreshold: 500 // MFA required for amounts > $500
})

🧪 Testing

Test Mode

Use Stripe test keys for development:

const trustjs = new TrustJS({
  publishableKey: 'pk_test_...',
  environment: 'development'
})

Test Cards

Card: 4242 4242 4242 4242
Expiry: 12/34
CVC: 123
ZIP: 12345

📦 Build from Source

# Clone the repository
git clone https://github.com/Prashant-koi/Trust-is-the-only-way.git
cd Trust-is-the-only-way/sdk

# Install dependencies
npm install

# Build the SDK
npm run build

# Output will be in dist/ directory

🌐 Browser Support

Chrome/Edge (latest 2 versions)
Firefox (latest 2 versions)
Safari (latest 2 versions)
Mobile browsers (iOS Safari, Chrome Mobile)

📄 License

MIT License - see LICENSE file for details.

🤝 Support

Documentation: https://docs.trustjs.com
GitHub Issues: https://github.com/Prashant-koi/Trust-is-the-only-way/issues
Email: [email protected]

🙏 Acknowledgments

Built with Stripe
Powered by Polygon
Bundled with Rollup

TrustJS - Trust is the Only Way

Website • Documentation • GitHub