@azothpay/api

Browser-compatible JavaScript client library for AzothPay API - a streaming payments and subscriptions protocol on Ethereum blockchain.

Installation

npm install @azothpay/api

Peer Dependencies

This package requires ethers to be installed:

npm install ethers

Usage

Basic Setup

import { AzothPayApiClient } from '@azothpay/api';

const client = new AzothPayApiClient(
  'https://azothpay.com',
  'usdt', // contract type
  'your-api-key'
);

Creating a Subscription

import { ethers } from 'ethers';

// Connect to Ethereum provider
const provider = new ethers.providers.Web3Provider(window.ethereum);
const signer = provider.getSigner();

// Create subscription
const params = {
  author: '0x...', // Content creator address
  subscriptionRate: '1000000000000000', // Rate in wei
  projectId: 1
};

// Option 1: Get transaction and sign manually
const transaction = await client.createSubscription(params);
const receipt = await client.signAndSendTransactionAndWait(transaction, signer);

// Option 2: Create and send in one call
const receipt = await client.createSubscriptionAndSend(params, signer);

Meta Transactions (Gasless)

import { AzothPayMetaApiClient } from '@azothpay/api/meta';

const metaClient = new AzothPayMetaApiClient(
  'https://api.azothpay.example.com',
  'usdt',
  'your-api-key'
);

// Create subscription via meta transaction
const params = {
  from: '0x...', // User address
  author: '0x...', // Content creator address
  subscriptionRate: '1000000000000000',
  projectId: 1
};

const result = await metaClient.createSubscriptionViaMetaTransaction(
  params,
  signer,
  contractAddress,
  chainId,
  relayerAddress
);

API Methods

AzothPayApiClient

• getApiInfo() - Get API information and status
• getAvailableContracts() - Get list of available contracts
• createSubscription(params) - Create a new subscription
• cancelSubscription(author, params) - Cancel a subscription
• listSubscriptions(address) - List user's active subscriptions
• makePayment(params) - Make a one-time payment
• depositFunds(params) - Deposit funds to user account
• withdrawFunds(params) - Withdraw funds from user account
• getBalance(address) - Check user balance and streaming rates
• claimProject(params) - Claim project ID for fee settings
• configureFees(projectId, params) - Configure protocol fees
• getProjectInfo(projectId) - Get project information
• createBatchSubscriptions(params) - Create multiple subscriptions
• processBatchPayments(params) - Batch payments to multiple recipients
• liquidateAccount(params) - Liquidate underfunded accounts
• getAnalytics(params) - Get streaming payment analytics
• registerWebhook(params) - Register a webhook endpoint
• listWebhooks() - List registered webhooks

AzothPayMetaApiClient

• getNonce(address) - Get nonce for meta transactions
• prepareSubscriptionMetaTransaction(params) - Prepare subscription meta transaction
• prepareCancelSubscriptionMetaTransaction(author, params) - Prepare cancel subscription meta transaction
• preparePaymentMetaTransaction(params) - Prepare payment meta transaction
• prepareDepositMetaTransaction(params) - Prepare deposit meta transaction
• prepareWithdrawMetaTransaction(params) - Prepare withdraw meta transaction
• signMetaTransaction(transactionData, signer, contractAddress, chainId, relayerAddress) - Sign a meta transaction
• executeMetaTransaction(signedTransaction) - Execute a signed meta transaction

License

MIT