mm-fok-sample-integration

[sarveshotex]

Pull Request Template: GlueX Liquidity Module Integration

Protocol Information

• **Protocol Name: Sample Market maker
• Protocol Website: [Link to website or documentation]
• Indexing Smart Contract Addresses (e.g. factories):
  • [Chain 1]:
    • [Contract Addresses, Contract Type]
  • [Chain 2]: [Contract Addresses]
    • [Contract Addresses, Contract Type]
  • ...

---

Summary of Integration

Provide a brief overview of your integration:

• What does your protocol do?
  A sample protocol for Market maker integration
• What type of liquidity does it provide (DEX, lending, yield farming, etc.)?
  Market maker private liquidity
• Any unique features that GlueX should consider?
  It supports 1inch/cowswap/0x RFQ

---

Implementation Details

Execution Functions Required

List all execution functions that GlueX needs to interact with your protocol, including:

• Function names and descriptions
  RFQ function name on contract eg: settle/swap
• Input and output parameters
  RFQ input params like sell_token, buy_token etc
• Relevant smart contract references
  RFQ settlement/router contract address

Functions Implemented

• get_sell_quote():
  Fetch quote from makert maker SellQuote API with inputs as input token, output token, input_amount, and user address.
• get_buy_quote():
  Fetch quote from makert maker BuyQuote API with inputs as input token, output token, output_amount, and user address.

Dynamic States Required for AMM Calculations

N/A

Static States Required for AMM Calculations

Specify any on-chain values that remain constant such as:

• Market maker Quoter contract Address
• Market maker Router Contract Address

Dependencies

List any external dependencies (APIs, data sources, libraries). If none, state N/A.

• Market maker API: https://sample-maker.market.xyz

Other Requirements

• API Keys:

  • Market maker API key(s): sample-api-key

• Special Access Requirements: Any required permissions, whitelisting, or approvals.

---

Test Results

Provide details of tests performed, including:

• Test logs (paste relevant results)
• Edge cases considered
• Pass/fail outcomes