Mint AMM Liquidity

Adds liquidity to a pool.

Usage

import { client } from './viem.config'
 
const { receipt, ...event } = await client.amm.mintSync({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000002',
  validatorTokenAmount: 1000000n,
})
 
console.log('Mint:', event)
Mint: {
  sender: '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userToken: '0x20c0000000000000000000000000000000000001',
  validatorToken: '0x20c0000000000000000000000000000000000002',
  amountValidatorToken: 1000000n,
  liquidity: 1000000n,
}

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Asynchronous Usage

The examples above use a *Sync variant of the action, that will wait for the transaction to be included before returning.

If you are optimizing for performance, you should use the non-sync amm.mint action and wait for inclusion manually:

import { Actions } from 'viem/tempo'
import { client } from './viem.config'
 
const hash = await client.amm.mint({
  to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEbb',
  userTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000002',
  validatorTokenAmount: 1000000n,
})
const receipt = await client.transaction.waitForReceipt({ hash }).receipt
 
const { args } = Actions.amm.mint.extractEvent(receipt.logs)

Recipes

Seed a Pool for a New Fee Token

Combine amm.getPool with mintSync to confirm a pool is empty before seeding it, so fees paid in a newly issued stablecoin can settle.

import { client } from './viem.config'
 
const alphaUsd = '0x20c0000000000000000000000000000000000001'
const validatorToken = '0x20c0000000000000000000000000000000000002'
 
const pool = await client.amm.getPool({
  userToken: alphaUsd,
  validatorToken,
})
 
if (pool.totalSupply === 0n) {
  await client.amm.mintSync({
    to: client.account.address,
    userTokenAddress: alphaUsd,
    validatorTokenAddress: validatorToken,
    validatorTokenAmount: 10_000_000000n,
  })
}

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Custody LP Shares in a Treasury Account

Pass a treasury address as to when an operator wallet funds the pool: LP shares belong to to, and only that address can burn them.

import { client } from './viem.config'
 
const treasury = '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
 
const { liquidity } = await client.amm.mintSync({
  to: treasury,
  userTokenAddress: '0x20c0000000000000000000000000000000000001',
  validatorTokenAddress: '0x20c0000000000000000000000000000000000002',
  validatorTokenAmount: 1_000_000000n,
})
 
console.log('LP shares minted to treasury:', liquidity)
LP shares minted to treasury: 1000000000n

import { Account, Client } from 'viem/tempo'
 
export const client = Client.create({
  account: Account.fromSecp256k1('0x...'),
})

Return Value

type ReturnType = {
  /** Address that added liquidity. */
  sender: Address
  /** Address that received LP tokens. */
  to: Address
  /** User token address. */
  userToken: Address
  /** Validator token address. */
  validatorToken: Address
  /** Amount of validator token added. */
  amountValidatorToken: bigint
  /** Amount of LP tokens minted. */
  liquidity: bigint
  /** Transaction receipt. */
  receipt: TransactionReceipt
}

The transaction receipt and decoded Mint event data.

Parameters

to

• Type: Address

Address to mint LP tokens to.

userTokenAddress

• Type: Address | bigint

User token address.

validatorTokenAddress

• Type: Address | bigint

Validator token address.

validatorTokenAmount

• Type: bigint

Amount of validator token to add.

account (optional)

• Type: Account | Address

Account that will be used to send the transaction.

feePayer (optional)

• Type: Account | boolean

Fee payer for the transaction (TIP-1 gas sponsorship).

Pass true to defer the fee token to an external fee payer (e.g. a relay), or a local Account to co-sign the transaction as the fee payer.

feeToken (optional)

• Type: Address | bigint

Fee token for the transaction.

Can be an unpaused USD-denominated TIP-20 token address or ID.

gas (optional)

• Type: bigint

Gas limit for the transaction.

keyAuthorization (optional)

• Type: KeyAuthorization

Signed key authorization to include with the transaction, authorizing an access key to act for the sending account.

maxFeePerGas (optional)

• Type: bigint

Max fee per gas for the transaction.

maxPriorityFeePerGas (optional)

• Type: bigint

Max priority fee per gas for the transaction.

nonce (optional)

• Type: number

Nonce for the transaction.

nonceKey (optional)

• Type: 'expiring' | 'random' | bigint

Nonce key for the transaction (TIP-1009 2D nonces).

Use 'expiring' to select an expiring nonce, which enables concurrent transaction submission without nonce ordering. Use 'random' to select a random key.

throwOnReceiptRevert (optional)

• Type: boolean
• Default: true

Whether a Sync action throws when the receipt reports a revert.

validAfter (optional)

• Type: number

Unix timestamp after which the transaction can be included.

validBefore (optional)

• Type: number

Unix timestamp before which the transaction must be included.