Maker quickstart

Requirement	Note
Foundry (`forge`, `cast`)
Node 20+	for the streaming client
Base Sepolia RPC URL
Deployer key	a little Base Sepolia ETH
Signing key	signs your ladders; can equal the deployer key while testing

export RPC_URL=<your Base Sepolia RPC>
export EXECUTOR=0x0000006f9bBA066e4efda2e0CAbE4FF8cf9030aC
export VENUE=0x0000009E5F98cDB4dd1E1d2E15B220217c88B3b8
export WETH=0x8b414aD7005EeFd315aF2A16538885Eae229bab7   # MockWETH, 18 decimals, mintable
export USDC=0xAbbdbbbd6d56593A9c5656c06cB30D61E4a544Df   # MockUSDC, 18 decimals, mintable
export SIGNER=<address of your signing key>
export OWNER=<address that will own the provider>

Deploy your provider

The provider is the contract that holds your inventory. Use the reference implementation as is: copy IMMProvider.sol to src/interfaces/IMMProvider.sol and BasicMMProvider.sol to src/periphery/examples/BasicMMProvider.sol in a Foundry project, then:

forge install vectorized/solady
forge create src/periphery/examples/BasicMMProvider.sol:BasicMMProvider \
  --rpc-url $RPC_URL --interactive --broadcast \
  --constructor-args $SIGNER $EXECUTOR $OWNER
export PROVIDER=<the deployed address>

--interactive prompts for the deployer key. A provider must implement IMMProvider, including available(token), which reports how much of token it can pay out now; BasicMMProvider returns its balance. Details and custom contracts: Provider contract.

Fund it

Inventory is the output token of each direction you quote:

cast send $USDC "mint(address,uint256)" $PROVIDER 1000000000000000000000000 --rpc-url $RPC_URL --interactive   # 1,000,000 MockUSDC
cast send $WETH "mint(address,uint256)" $PROVIDER 1000000000000000000000    --rpc-url $RPC_URL --interactive   # 1,000 MockWETH

The executor caps your ladder to what available reports, so the venue quotes only what the provider can pay.

Email support@biconomy.io:

Field	Example
Signer	`$SIGNER`
Provider	`$PROVIDER`
Chain	84532
Directions	WETH to USDC, USDC to WETH

Until registration the stream returns UNREGISTERED_MARKET_MAKER. The stream also needs an API key from Biconomy.

Stream your ladder

Connect to wss://propamm-staging.biconomy.io/v1/ws with your API key in the x-api-key header, subscribe as your signer, and send a signed price-ladder per direction. Both mock tokens have 18 decimals, so 2,000 USDC per WETH is 2000e18 for WETH to USDC and 5e14 for USDC to WETH.

{ "type": "subscribe", "data": { "type": "price-ledger", "mm": "<SIGNER>" } }

{
  "type": "price-ladder",
  "payload": {
    "mm": "<SIGNER>",
    "provider": "<PROVIDER>",
    "tokenIn": "0x8b414aD7005EeFd315aF2A16538885Eae229bab7",
    "tokenOut": "0xAbbdbbbd6d56593A9c5656c06cB30D61E4a544Df",
    "levels": [
      { "size": "1000000000000000000", "price": "1998000000000000000000" },
      { "size": "3000000000000000000", "price": "1995000000000000000000" }
    ],
    "nonce": "<unix milliseconds>",
    "timestampMs": "<unix milliseconds, when you priced it>",
    "expiresAt": "<unix seconds, now + 30>",
    "signature": "<EIP-712 signature>",
    "chainId": 84532
  }
}

Each accepted message returns { "type": "ack" }. Send a new ladder with a higher nonce on every price change. Runnable client: Stream prices.

Read your ladder back

After Biconomy commits it, board() returns your levels with remaining equal to your top size, or less if the provider cannot pay that much:

cast call $VENUE "board(address,address,address)(uint256[],uint256[],uint256,uint256,uint256)" $SIGNER $WETH $USDC --rpc-url $RPC_URL
cast call $VENUE "quote(address,address,uint256)(uint256)" $WETH $USDC 1000000000000000000 --rpc-url $RPC_URL

Empty arrays and remaining == 0: not committed yet, expired, (Reprice) no live anchor for the pair, paused with setPaused, or the provider’s signer() is no longer $SIGNER. remaining == 0 with levels present: the ladder is fully filled, this block’s cap is used, or the provider holds no tokenOut. Check the acks and that expiresAt or the anchor’s ttl leaves time for the commit.

Watch a fill

A fill calls executeSwap on your provider and emits MMFillExecuted on the executor. board() then shows filled up and remaining down.

Stream prices: Rewrite and Reprice, nonces and expiry, a runnable client.
Risk and inventory: the four protections, how much a ladder can fill, how to stop.
Mainnet: change the endpoint to wss://propamm.biconomy.io/v1/ws, the chainId and the token addresses. Contract addresses are the same, see Addresses.

Getting Started

Market Makers

Aggregators

Reference

Next

​Next

Next