Transactions

Buy Transaction Flow

1. Specify Purchase Amount
   The buyer inputs the desired number of tokens.

2. Calculate Cost
   The platform computes the expected cost in the paired token, accounting for slippage (refer to TokenMaster Pools for cost calculations by pool type).

3. Approval Handling (ERC20)

   • Using PermitC:
     1. Verify user’s token approval for PermitC. If insufficient, prompt an approval transaction.
     2. Generate a signed PermitC transfer order. See PermitTransfer.
   • Using Direct Approvals:
     • Verify user’s token approval for TokenMaster Router. If insufficient, prompt an approval transaction.

4. Cosignature (Optional)
   Obtain cosignature if required by the advanced order. See Cosigning.

5. Transaction Execution

   • Advanced Buy or PermitC Orders:
     • Call buyTokensAdvanced with the required parameters (BuyOrder, SignedOrder, and PermitTransfer).
       • Set signedOrder.hook to address(0) for basic orders.
       • Set permitTransfer.permitProcessor to address(0) for direct approvals.
   • Basic Buy Orders:
     • Call buyTokens with the BuyOrder.
   • Native Token Pairing:
     • Include the native token value as msg.value when invoking the router.

---

Sell Transaction Flow

1. Specify Sale Amount
   The user inputs the desired number of tokens to sell.

2. Calculate Expected Value
   The platform computes the expected value in the paired token, accounting for slippage (refer to TokenMaster Pools for sell value calculations by pool type).

3. Cosignature (Optional)
   Obtain cosignature if the advanced order requires it. See Cosigning.

4. Transaction Execution

   • Advanced Sell Orders:
     • Call sellTokensAdvanced with the SellOrder and SignedOrder.
   • Basic Sell Orders:
     • Call sellTokens with the SellOrder.

---

Spend Transaction Flow

1. Select Spend Order
   The user selects a signed spend order to execute.

2. Specify Multiples
   The user inputs the number of multiples of the spend order to execute.

3. Calculate Maximum Spend
   The platform determines the maximum spend amount based on the signed spend order and the specified multiples, adjusting for value and slippage if an oracle price adjustment is involved.

4. Cosignature (Optional)
   Obtain cosignature if the advanced order requires it. See Cosigning.

5. Transaction Execution

   • Call spendTokens with the SpendOrder and SignedOrder.

---

Example Use Cases

• Game Development
  A game developer could use spends to sell items and lives to players using event indexing to issue the items offchain.

• NFT Minting
  A project could use spends with onchain hooks to mint NFTs using their ecosystem apptoken.

• Retail Payments
  A retail point-of-sale system could generate signed orders for customers to pay onchain using the store's token.