Deposit Methods

Deposit methods of Azoth SDK for depositing tokens into the system.

deposit()

Deposits tokens into AzothPay.

async deposit(amount: bigint | number, isPermit2: boolean = false): Promise<ethers.TransactionResponse>

Parameters:

• amount: The amount of tokens to deposit, should be formatted using formatInput()

• isPermit2 (optional): Whether to use Permit2 for the deposit (default: false)

Returns:

• An ethers.js TransactionResponse object

Example:

// Format the amount correctly (10 USDT with 6 decimals)
const amount = formatInput('10', 6);

// Deposit
const tx = await azoth.deposit(amount);
await tx.wait();
console.log('Deposit successful');

depositBySig()

Creates a deposit transaction that can be signed off-chain and executed by anyone.

async depositBySig(amount: bigint | number, deadline: number): Promise<ethers.TransactionResponse>

Parameters:

• amount: The amount of tokens to deposit, should be formatted using formatInput()

• deadline: Timestamp after which the transaction cannot be executed

Returns:

• An ethers.js TransactionResponse object

Example:

// Format the amount correctly (10 USDT with 6 decimals)
const amount = formatInput('10', 6);

// Set deadline to 1 hour from now
const deadline = Math.floor(Date.now() / 1000) + 3600;

// Create the depositBySig transaction
const tx = await azoth.depositBySig(amount, deadline);
await tx.wait();

depositFor()

Deposits tokens into another account.

async depositFor(amount: bigint | number, to: string, isPermit2: boolean = false): Promise<ethers.TransactionResponse>

Parameters:

• amount: The amount of tokens to deposit, should be formatted using formatInput()

• to: The recipient address

• isPermit2 (optional): Whether to use Permit2 for the deposit (default: false)

Returns:

• An ethers.js TransactionResponse object

Example:

// Format the amount correctly (50 USDT with 6 decimals)
const amount = formatInput('50', 6);
const recipientAddress = '0x...';

// Deposit to the recipient
const tx = await azoth.depositFor(amount, recipientAddress);
await tx.wait();

depositAndSubscribe()

Deposits tokens and creates a subscription in a single transaction using multicall. This method combines deposit() and subscribe() operations atomically, saving gas and improving user experience.

async depositAndSubscribe(
  author: string,
  amount: string | number | bigint,
  rate: string | number | bigint,
  period: RatePeriod = RatePeriod.MONTH,
  projectId: number,
  isPermit2: boolean = false,
  decimals: number = 6
): Promise<ethers.TransactionResponse>

Parameters:

• author: The address of the creator to subscribe to

• amount: The amount of tokens to deposit (in token units, e.g., "100" for $100)

• rate: The subscription rate per period (in token units, e.g., "100" for $100/month)

• period: (Optional) The subscription period (default: RatePeriod.MONTH)

• projectId: The project ID associated with the subscription

• isPermit2: (Optional) Whether to use Permit2 for deposit (default: false)

• decimals: (Optional) Token decimals (default: 6 for USDT/USDC)

Returns: An ethers.js TransactionResponse object.

Benefits:

• ✅ Saves gas by combining two operations into one transaction

• ✅ Atomic execution: both operations succeed or both fail

• ✅ Better UX: only one transaction confirmation needed

Example:

const creatorAddress = '0x...';

// Deposit $100 and subscribe to $100/month in a single transaction
const tx = await papaya.depositAndSubscribe(
  creatorAddress,  // author
  '100',           // deposit amount ($100)
  '100',           // subscription rate ($100/month)
  RatePeriod.MONTH,
  0,               // projectId
  false,           // isPermit2
  6                // decimals (USDT/USDC)
);

await tx.wait();
console.log('Deposit and subscription completed in one transaction!');

Note: The order of operations is important - deposit is executed first, then subscribe. This ensures the account has sufficient balance before creating the subscription.