Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

vaultUpdates

Streams one user's vault activity over the node /ws connection: deposits and withdrawals made with vaultTransfer, vault creation, and leader commission payouts. Subscribe with type vaultUpdates; pushes arrive on channel vault as flat frames with no data wrapper. Read current vault equity with uservaultequities.

Channelvaultserver → client · type vaultUpdates

Confirm vault deposits and withdrawals as they land, and refresh vault equity.

Subscribe
{
  "method": "subscribe",
  "type": "vaultUpdates",
  "subscription": {
    "type": "vaultUpdates",
    "user": "0xabc123abc123abc123abc123abc123abc123abc1"
  }
}
Try it
WS wss://rpc.txflow-testnet.xyz/ws
Subscription parameters
typestringrequired
"vaultUpdates"
userstring · addressrequired

Account address (the owner, not an agent).

Server message
actionstring

`create` when the vault is created, `transfer` for a deposit or withdrawal, `leaderCommission` for a leader commission payout.

"create""transfer""leaderCommission"
amountstring

Amount moved, in token units.

channelstring
"vault"
isDepositboolean

`true` for a deposit, `false` for a withdrawal.

leaderstring · address

Vault leader address.

statusstring
"success""failed"
tokenstring
txHashstring
userstring · address
vaultAddressstring · address
commissionstring

Leader commission amount.

errorstring

Reason, present when `status` is `failed`.

requestedUsdstring

Requested USD amount.

Message example
{
  "channel": "vault",
  "user": "0xabc123abc123abc123abc123abc123abc123abc1",
  "vaultAddress": "0x664989a76069c2b153720745bc1c3c8eeee504c1",
  "leader": "0x0000000000000000000000000000000000000000",
  "action": "transfer",
  "isDeposit": true,
  "amount": "10.000000",
  "token": "USDC:0xd04f0d19E8FbA49cfA541E272F9C60a2ad720464",
  "txHash": "0x6a661ee8ee3056b1cb301338754fb6e24a89cb1fb8aac4775c1d24c1c24797b4",
  "status": "success"
}