Open a trove

POST /v1/actions/river/open

Open a trove on a River market: deposit collateral, mint satUSD.

River (rebranded Satoshi Protocol) is a Prisma-lineage pooled CDP minting satUSD behind one SatoshiXApp diamond per chain (BNB, Base, Hemi). One TroveManager per collateral = one RIVER_<chainId>_<TM_INDEX> market; troves are keyed by OWNER ADDRESS — at most one per user per market, no ids. Interest is protocol-set (currently 0%); the only borrowing cost is a one-off decaying-baseRate mint fee (0.5%–5%) on open/borrow-more, guarded by maxFeePercentage (quoted automatically).

Standard lending actions cover the day-to-day ops:

satUSD deposit/withdraw → the single per-chain Stability Pool (attached to market index 0; zero approvals)
collateral deposit/withdraw → addColl/withdrawColl (no troveId — address-keyed)
borrow → withdrawDebt (mint fee applies)
repay → repayDebt clamped to entireDebt − gasComp − minNetDebt; isAll=true routes to closeTrove (burns entireDebt − gasComp from the wallet, returns all collateral; blocked in Recovery Mode)

The 2-satUSD debt-side gas compensation is minted on open and burned from the GasPool on close — it never touches the wallet.

Validates the diamond-level minNetDebt and rejects paused/sunsetting markets; quotes the mint-fee guard live. Returns the transaction plus the collateral approval (to the diamond).

Plain-text reference — POST /v1/actions/river/open

Request body

Field	Type	Required	Description
`chainId`	string	yes	EVM chain id, as a decimal string. See the `ChainId` schema.
`lender`	string	yes	Per-market key, e.g. RIVER_8453_0
`account`	string	yes	Trove owner (tx sender)
`collAmount`	string	yes	Collateral amount, raw units
`amount`	string	yes	satUSD debt to mint, raw units (net ≥ minNetDebt)
`maxFeePercentage`	string	no	Optional mint-fee guard override, WAD percentage

Response 200

Field	Type	Description
`success`	`True`
`data`	object	Informational data (quotes, simulation results, etc.)
`actions`	object	Transaction calldata and approvals. Null for quote-only responses (no account provided).
`actions.transactions`	object[]	Pre-trade setup transactions (e.g. e-mode switch, collateral enable). Execute these before the main swap. Empty when no setup is needed.
`actions.transactions[].to`	string	Target contract address
`actions.transactions[].data`	string	Encoded calldata
`actions.transactions[].value`	string	ETH value to send with the transaction
`actions.transactions[].description`	string	Human-readable label. For `alternatives`, this is the aggregator name (e.g. "Paraswap"). For `transactions`, describes the setup action (e.g. "Switch e-mode to 1").
`actions.alternatives`	object[]	DEX aggregator swap transactions sorted by best output (descending). Each entry's `description` is the aggregator name. The client should pick one to execute. Present on loop action endpoints.
`actions.alternatives[].to`	string	Target contract address
`actions.alternatives[].data`	string	Encoded calldata
`actions.alternatives[].value`	string	ETH value to send with the transaction
`actions.alternatives[].description`	string	Human-readable label. For `alternatives`, this is the aggregator name (e.g. "Paraswap"). For `transactions`, describes the setup action (e.g. "Switch e-mode to 1").
`actions.permissions`	object[]	Approval/delegation transactions that must execute before both `transactions` and `alternatives`. Includes ERC20 allowances (targeting the composer contract) and lender borrow/withdrawal delegations (targeting the lending protocol contract directly). Filtered against on-chain state so only missing approvals are returned. Null when no approvals are needed.
`actions.permissions[].to`	string	Target contract address
`actions.permissions[].data`	string	Encoded calldata
`actions.permissions[].value`	string	ETH value
`actions.permissions[].description`	string	Human-readable description of the approval (e.g. "Approve borrow for AAVE_V3", "Approve ERC20")
`actions.permissions[].spender`	string	ERC-20 approve spender (x-chain permissions). Match it against the selected quote's `approvalTarget` — several bridges can share one spender, so do not match by description.

Example response

{
  "success": true,
  "data": {},
  "actions": {
    "transactions": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "alternatives": [
      {
        "to": "0x87870Bca3F3fD6335C3F4ce8392D69350B4fA4E2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string"
      }
    ],
    "permissions": [
      {
        "to": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
        "data": "0x617ba037000000000000000000000000c02aaa39b2",
        "value": "0",
        "description": "string",
        "spender": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
      }
    ]
  }
}

Request

Responses

Open-trove transaction + approval

Rate limited. Unauthenticated callers share a per-IP budget; send an x-api-key header to lift it. Retry with exponential backoff.

An upstream data source or protocol origin failed (error.code is ORIGIN_FAILED). error.details carries the per-origin status. This is also what a missing or malformed required parameter currently returns, rather than a 400.

Open a trove

/v1/actions/river/open

Request​

Responses​

Request

Responses