Skip to content

Naming reference

Fragments

Fragment Imports Source
virtufin.core virtufin.core.yaml
virtufin.worlds virtufin.domain.devkit--virtufin.worlds.yaml
virtufin.execution virtufin.worlds virtufin.execution.devkit--virtufin.execution.yaml
virtufin.indicator virtufin.worlds virtufin.indicator.devkit--virtufin.indicator.yaml
virtufin.market virtufin.worlds virtufin.marketdata.devkit--virtufin.market.yaml
virtufin.pages virtufin.domain.devkit--virtufin.pages.yaml
virtufin.portfolio virtufin.worlds virtufin.portfolio.devkit--virtufin.portfolio.yaml
virtufin.positions virtufin.worlds virtufin.portfolio.devkit--virtufin.positions.yaml
virtufin.trading virtufin.worlds virtufin.trading.contracts--virtufin.trading.yaml
virtufin.venue.alpaca virtufin.market virtufin.marketdata.devkit--virtufin.venue.alpaca.yaml
virtufin.venue.binance virtufin.market virtufin.marketdata.devkit--virtufin.venue.binance.yaml
virtufin.worker.websocketfeed virtufin.websocket.devkit--virtufin.worker.websocketfeed.yaml

Segment classes

Class Alphabet Used for Valid Invalid
vocab [a-z][a-z0-9-]* domain, entity, event, venue, service, worker type, indicator instance orderbook, load-failed, sma-20 OrderBook, load_failed, 20sma
identifier [A-Z0-9_]{1,32}, at least one letter scenario, world, universe, strategy name LIVE, CRASH_2020 live, 123
pair BASE_QUOTE, uppercase currency pair BTC_USDT, 1INCH_USD BTCUSDT, btc_usdt, BTC/USDT
guid lowercase canonical GUID worker, order, connection id 3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b uppercase or braced GUIDs
interval 1s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1mo candle interval 1m, 1mo 1M, 60s
token [a-z0-9][a-z0-9-]* opaque id, e.g. a run id 9f8e7d6c Run_1
any [A-Za-z0-9_-]+ experimental (x.) names only demo a.b

Derivation rules

Name Rule Example (Binance order book, BTC_USDT)
topic scope.path.event[.identity] (identity only if the event is partitioned) act.exchange.binance.orderbook.changed.BTC_USDT
state key scope.path.identity act.exchange.binance.orderbook.BTC_USDT
index key scope.path.index cfg.scenario.index
ce-subject entity_type/identity currency_pair/BTC_USDT
ce-type com.virtufin.path.event com.virtufin.exchange.binance.orderbook.changed
ce-source urn:com.virtufin:<service>[:<instance>], workers urn:com.virtufin:worker:<type>[:<id>] urn:com.virtufin:worker:binanceorderbook
dead letter dlq.<topic>; the pubsub component's own is dlq.pubsub dlq.sc.LIVE.trading.order.submitted
experimental x.<segments>, outside the contract x.demo.events

Topics

Entity Event Topic template Example topic ce-type ce-subject Status
virtufin.core/worker command wrk.<worker_type>.command.<worker_id> wrk.httpget.command.3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b com.virtufin.httpget.command worker/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.core/worker error (unpartitioned) wrk.<worker_type>.error wrk.httpget.error com.virtufin.httpget.error worker/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.core/worker metrics (unpartitioned) wrk.<worker_type>.metrics wrk.httpget.metrics com.virtufin.httpget.metrics worker/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.core/worker response (unpartitioned) wrk.<worker_type>.response wrk.httpget.response com.virtufin.httpget.response worker/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.core/reply reply rpc.<caller>.reply.<run_id> rpc.notebook.reply.9f8e7d6c com.virtufin.notebook.reply run/9f8e7d6c live
virtufin.execution/order update (unpartitioned) (act\|hyp.<world>).exchange.<venue>.order.update act.exchange.binance.order.update com.virtufin.exchange.binance.order.update order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.indicator/indicator changed sc.<scenario>.indicator.<indicator>.changed.<pair> sc.LIVE.indicator.sma-20.changed.BTC_USDT com.virtufin.indicator.sma-20.changed currency_pair/BTC_USDT live
virtufin.market/orderbook changed (act\|hyp.<world>).exchange.<venue>.orderbook.changed.<pair> act.exchange.binance.orderbook.changed.BTC_USDT com.virtufin.exchange.binance.orderbook.changed currency_pair/BTC_USDT live
virtufin.market/orderbook gap (act\|hyp.<world>).exchange.<venue>.orderbook.gap.<pair> act.exchange.binance.orderbook.gap.BTC_USDT com.virtufin.exchange.binance.orderbook.gap currency_pair/BTC_USDT live
virtufin.market/orderbook snapshot (act\|hyp.<world>).exchange.<venue>.orderbook.snapshot.<pair> act.exchange.binance.orderbook.snapshot.BTC_USDT com.virtufin.exchange.binance.orderbook.snapshot currency_pair/BTC_USDT live
virtufin.market/orderbook update (act\|hyp.<world>).exchange.<venue>.orderbook.update.<pair> act.exchange.binance.orderbook.update.BTC_USDT com.virtufin.exchange.binance.orderbook.update currency_pair/BTC_USDT live
virtufin.market/candle closed (act\|hyp.<world>).exchange.<venue>.candle.closed.<pair>.<interval> act.exchange.binance.candle.closed.BTC_USDT.1m com.virtufin.exchange.binance.candle.closed currency_pair/BTC_USDT live
virtufin.market/candle update (act\|hyp.<world>).exchange.<venue>.candle.update.<pair>.<interval> act.exchange.binance.candle.update.BTC_USDT.1m com.virtufin.exchange.binance.candle.update currency_pair/BTC_USDT live
virtufin.market/trade executed (act\|hyp.<world>).exchange.<venue>.trade.executed.<pair> act.exchange.binance.trade.executed.BTC_USDT com.virtufin.exchange.binance.trade.executed currency_pair/BTC_USDT live
virtufin.market/trade update (act\|hyp.<world>).exchange.<venue>.trade.update.<pair> act.exchange.binance.trade.update.BTC_USDT com.virtufin.exchange.binance.trade.update currency_pair/BTC_USDT live
virtufin.market/ticker update (act\|hyp.<world>).exchange.<venue>.ticker.update.<pair> act.exchange.binance.ticker.update.BTC_USDT com.virtufin.exchange.binance.ticker.update currency_pair/BTC_USDT reserved
virtufin.market/funding rate (act\|hyp.<world>).exchange.<venue>.funding.rate.<pair> act.exchange.binance.funding.rate.BTC_USDT com.virtufin.exchange.binance.funding.rate currency_pair/BTC_USDT reserved
virtufin.market/mark price (act\|hyp.<world>).exchange.<venue>.mark.price.<pair> act.exchange.binance.mark.price.BTC_USDT com.virtufin.exchange.binance.mark.price currency_pair/BTC_USDT reserved
virtufin.market/instrument snapshot (act\|hyp.<world>).exchange.<venue>.instrument.snapshot.<pair> act.exchange.binance.instrument.snapshot.BTC_USDT com.virtufin.exchange.binance.instrument.snapshot currency_pair/BTC_USDT live
virtufin.portfolio/account snapshot (act\|hyp.<world>).portfolio.<venue>.account.snapshot.<account> act.portfolio.binance.account.snapshot.name com.virtufin.portfolio.binance.account.snapshot account/name live
virtufin.portfolio/account update (act\|hyp.<world>).portfolio.<venue>.account.update.<account> act.portfolio.binance.account.update.name com.virtufin.portfolio.binance.account.update account/name live
virtufin.portfolio/balance changed (act\|hyp.<world>).portfolio.<venue>.balance.changed.<account> act.portfolio.binance.balance.changed.name com.virtufin.portfolio.binance.balance.changed account/name live
virtufin.portfolio/holding changed (act\|hyp.<world>).portfolio.<venue>.holding.changed.<account> act.portfolio.binance.holding.changed.name com.virtufin.portfolio.binance.holding.changed account/name live
virtufin.portfolio/ledger posted (act\|hyp.<world>).portfolio.<venue>.ledger.posted.<account> act.portfolio.binance.ledger.posted.name com.virtufin.portfolio.binance.ledger.posted account/name live
virtufin.portfolio/openorder changed (act\|hyp.<world>).portfolio.<venue>.openorder.changed.<account> act.portfolio.binance.openorder.changed.name com.virtufin.portfolio.binance.openorder.changed account/name live
virtufin.positions/position adjustment (unpartitioned) sc.<scenario>.position.adjustment sc.LIVE.position.adjustment com.virtufin.position.adjustment position/BTC_USDT reserved
virtufin.positions/position closed (unpartitioned) sc.<scenario>.position.closed sc.LIVE.position.closed com.virtufin.position.closed position/BTC_USDT reserved
virtufin.positions/position decreased (unpartitioned) sc.<scenario>.position.decreased sc.LIVE.position.decreased com.virtufin.position.decreased position/BTC_USDT reserved
virtufin.positions/position flipped (unpartitioned) sc.<scenario>.position.flipped sc.LIVE.position.flipped com.virtufin.position.flipped position/BTC_USDT reserved
virtufin.positions/position increased (unpartitioned) sc.<scenario>.position.increased sc.LIVE.position.increased com.virtufin.position.increased position/BTC_USDT reserved
virtufin.positions/position liquidated (unpartitioned) sc.<scenario>.position.liquidated sc.LIVE.position.liquidated com.virtufin.position.liquidated position/BTC_USDT reserved
virtufin.positions/position liquidation-warning (unpartitioned) sc.<scenario>.position.liquidation-warning sc.LIVE.position.liquidation-warning com.virtufin.position.liquidation-warning position/BTC_USDT reserved
virtufin.positions/position opened (unpartitioned) sc.<scenario>.position.opened sc.LIVE.position.opened com.virtufin.position.opened position/BTC_USDT reserved
virtufin.positions/position snapshot (unpartitioned) sc.<scenario>.position.snapshot sc.LIVE.position.snapshot com.virtufin.position.snapshot position/BTC_USDT reserved
virtufin.positions/position updated (unpartitioned) sc.<scenario>.position.updated sc.LIVE.position.updated com.virtufin.position.updated position/BTC_USDT reserved
virtufin.positions/position updated-attributed (unpartitioned) sc.<scenario>.position.updated-attributed sc.LIVE.position.updated-attributed com.virtufin.position.updated-attributed position/BTC_USDT reserved
virtufin.positions/risk alert (unpartitioned) sc.<scenario>.risk.<metric>.alert sc.LIVE.risk.name.alert com.virtufin.risk.name.alert currency_pair/BTC_USDT live
virtufin.positions/risk breach (unpartitioned) sc.<scenario>.risk.<metric>.breach sc.LIVE.risk.name.breach com.virtufin.risk.name.breach currency_pair/BTC_USDT live
virtufin.positions/risk pnl (unpartitioned) sc.<scenario>.risk.<metric>.pnl sc.LIVE.risk.name.pnl com.virtufin.risk.name.pnl currency_pair/BTC_USDT live
virtufin.positions/risk update (unpartitioned) sc.<scenario>.risk.<metric>.update sc.LIVE.risk.name.update com.virtufin.risk.name.update currency_pair/BTC_USDT live
virtufin.positions/pnl update (unpartitioned) sc.<scenario>.pnl.<metric>.update sc.LIVE.pnl.name.update com.virtufin.pnl.name.update currency_pair/BTC_USDT live
virtufin.trading/order accepted (unpartitioned) sc.<scenario>.trading.order.accepted sc.LIVE.trading.order.accepted com.virtufin.trading.order.accepted order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order amended (unpartitioned) sc.<scenario>.trading.order.amended sc.LIVE.trading.order.amended com.virtufin.trading.order.amended order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order canceled (unpartitioned) sc.<scenario>.trading.order.canceled sc.LIVE.trading.order.canceled com.virtufin.trading.order.canceled order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order expired (unpartitioned) sc.<scenario>.trading.order.expired sc.LIVE.trading.order.expired com.virtufin.trading.order.expired order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order filled (unpartitioned) sc.<scenario>.trading.order.filled sc.LIVE.trading.order.filled com.virtufin.trading.order.filled order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order rejected (unpartitioned) sc.<scenario>.trading.order.rejected sc.LIVE.trading.order.rejected com.virtufin.trading.order.rejected order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/order submitted (unpartitioned) sc.<scenario>.trading.order.submitted sc.LIVE.trading.order.submitted com.virtufin.trading.order.submitted order/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live
virtufin.trading/trade cleared (unpartitioned) sc.<scenario>.trading.trade.cleared sc.LIVE.trading.trade.cleared com.virtufin.trading.trade.cleared trade/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b reserved
virtufin.trading/trade settled (unpartitioned) sc.<scenario>.trading.trade.settled sc.LIVE.trading.trade.settled com.virtufin.trading.trade.settled trade/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b reserved
virtufin.venue.alpaca/orderbook changed (act\|hyp.<world>).exchange.alpaca.orderbook.changed.<pair> act.exchange.alpaca.orderbook.changed.BTC_USDT com.virtufin.exchange.alpaca.orderbook.changed currency_pair/BTC_USDT live
virtufin.venue.alpaca/orderbook gap (act\|hyp.<world>).exchange.alpaca.orderbook.gap.<pair> act.exchange.alpaca.orderbook.gap.BTC_USDT com.virtufin.exchange.alpaca.orderbook.gap currency_pair/BTC_USDT live
virtufin.venue.alpaca/orderbook snapshot (act\|hyp.<world>).exchange.alpaca.orderbook.snapshot.<pair> act.exchange.alpaca.orderbook.snapshot.BTC_USDT com.virtufin.exchange.alpaca.orderbook.snapshot currency_pair/BTC_USDT live
virtufin.venue.alpaca/orderbook update (act\|hyp.<world>).exchange.alpaca.orderbook.update.<pair> act.exchange.alpaca.orderbook.update.BTC_USDT com.virtufin.exchange.alpaca.orderbook.update currency_pair/BTC_USDT live
virtufin.venue.alpaca/trade executed (act\|hyp.<world>).exchange.alpaca.trade.executed.<pair> act.exchange.alpaca.trade.executed.BTC_USDT com.virtufin.exchange.alpaca.trade.executed currency_pair/BTC_USDT live
virtufin.venue.alpaca/trade update (act\|hyp.<world>).exchange.alpaca.trade.update.<pair> act.exchange.alpaca.trade.update.BTC_USDT com.virtufin.exchange.alpaca.trade.update currency_pair/BTC_USDT live
virtufin.venue.binance/orderbook changed (act\|hyp.<world>).exchange.binance.orderbook.changed.<pair> act.exchange.binance.orderbook.changed.BTC_USDT com.virtufin.exchange.binance.orderbook.changed currency_pair/BTC_USDT live
virtufin.venue.binance/orderbook gap (act\|hyp.<world>).exchange.binance.orderbook.gap.<pair> act.exchange.binance.orderbook.gap.BTC_USDT com.virtufin.exchange.binance.orderbook.gap currency_pair/BTC_USDT live
virtufin.venue.binance/orderbook snapshot (act\|hyp.<world>).exchange.binance.orderbook.snapshot.<pair> act.exchange.binance.orderbook.snapshot.BTC_USDT com.virtufin.exchange.binance.orderbook.snapshot currency_pair/BTC_USDT live
virtufin.venue.binance/orderbook update (act\|hyp.<world>).exchange.binance.orderbook.update.<pair> act.exchange.binance.orderbook.update.BTC_USDT com.virtufin.exchange.binance.orderbook.update currency_pair/BTC_USDT live
virtufin.venue.binance/candle closed (act\|hyp.<world>).exchange.binance.candle.closed.<pair>.<interval> act.exchange.binance.candle.closed.BTC_USDT.1m com.virtufin.exchange.binance.candle.closed currency_pair/BTC_USDT live
virtufin.venue.binance/candle update (act\|hyp.<world>).exchange.binance.candle.update.<pair>.<interval> act.exchange.binance.candle.update.BTC_USDT.1m com.virtufin.exchange.binance.candle.update currency_pair/BTC_USDT live
virtufin.venue.binance/trade executed (act\|hyp.<world>).exchange.binance.trade.executed.<pair> act.exchange.binance.trade.executed.BTC_USDT com.virtufin.exchange.binance.trade.executed currency_pair/BTC_USDT live
virtufin.venue.binance/trade update (act\|hyp.<world>).exchange.binance.trade.update.<pair> act.exchange.binance.trade.update.BTC_USDT com.virtufin.exchange.binance.trade.update currency_pair/BTC_USDT live
virtufin.venue.binance/instrument snapshot (act\|hyp.<world>).exchange.binance.instrument.snapshot.<pair> act.exchange.binance.instrument.snapshot.BTC_USDT com.virtufin.exchange.binance.instrument.snapshot currency_pair/BTC_USDT live
virtufin.worker.websocketfeed/feed message (unpartitioned) wrk.websocketfeed.message wrk.websocketfeed.message com.virtufin.websocketfeed.message worker/3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b live

State keys

Entity Key template Example key Index key
virtufin.worlds/scenario_registry cfg.scenario.<scenario> cfg.scenario.LIVE cfg.scenario.index
virtufin.worlds/strategy_registry cfg.strategy.<strategy> cfg.strategy.MA_CROSS cfg.strategy.index
virtufin.execution/order (act\|hyp.<world>).exchange.<venue>.order.<order_id> act.exchange.binance.order.3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b
virtufin.indicator/indicator sc.<scenario>.indicator.<indicator>.<pair> sc.LIVE.indicator.sma-20.BTC_USDT
virtufin.market/orderbook (act\|hyp.<world>).exchange.<venue>.orderbook.<pair> act.exchange.binance.orderbook.BTC_USDT
virtufin.market/candle (act\|hyp.<world>).exchange.<venue>.candle.<pair>.<interval> act.exchange.binance.candle.BTC_USDT.1m
virtufin.market/trade (act\|hyp.<world>).exchange.<venue>.trade.<pair> act.exchange.binance.trade.BTC_USDT
virtufin.market/instrument (act\|hyp.<world>).exchange.<venue>.instrument.<pair> act.exchange.binance.instrument.BTC_USDT
virtufin.market/feed_registry cfg.feed.<feed> cfg.feed.NAME cfg.feed.index
virtufin.pages/page_registry cfg.page.<page> cfg.page.NAME cfg.page.index
virtufin.pages/navigation cfg.navigation cfg.navigation
virtufin.pages/ai_provider cfg.ai.provider.<user> cfg.ai.provider.3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b
virtufin.portfolio/account (act\|hyp.<world>).portfolio.<venue>.account.<account> act.portfolio.binance.account.name
virtufin.portfolio/balance (act\|hyp.<world>).portfolio.<venue>.balance.<account> act.portfolio.binance.balance.name
virtufin.portfolio/holding (act\|hyp.<world>).portfolio.<venue>.holding.<account> act.portfolio.binance.holding.name
virtufin.portfolio/openorder (act\|hyp.<world>).portfolio.<venue>.openorder.<account> act.portfolio.binance.openorder.name
virtufin.positions/position sc.<scenario>.position.<pair> sc.LIVE.position.BTC_USDT
virtufin.positions/portfolio sc.<scenario>.position.portfolio sc.LIVE.position.portfolio
virtufin.positions/pnl_book sc.<scenario>.pnl.book sc.LIVE.pnl.book
virtufin.trading/order sc.<scenario>.trading.order.<order_id> sc.LIVE.trading.order.3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b
virtufin.trading/trade sc.<scenario>.trading.trade.<trade_id> sc.LIVE.trading.trade.3f2a8c1e-0b4d-4e6f-9a7b-1c2d3e4f5a6b
virtufin.trading/halt sc.<scenario>.trading.halt sc.LIVE.trading.halt
virtufin.venue.alpaca/orderbook (act\|hyp.<world>).exchange.alpaca.orderbook.<pair> act.exchange.alpaca.orderbook.BTC_USDT
virtufin.venue.alpaca/trade (act\|hyp.<world>).exchange.alpaca.trade.<pair> act.exchange.alpaca.trade.BTC_USDT
virtufin.venue.binance/orderbook (act\|hyp.<world>).exchange.binance.orderbook.<pair> act.exchange.binance.orderbook.BTC_USDT
virtufin.venue.binance/candle (act\|hyp.<world>).exchange.binance.candle.<pair>.<interval> act.exchange.binance.candle.BTC_USDT.1m
virtufin.venue.binance/trade (act\|hyp.<world>).exchange.binance.trade.<pair> act.exchange.binance.trade.BTC_USDT
virtufin.venue.binance/instrument (act\|hyp.<world>).exchange.binance.instrument.<pair> act.exchange.binance.instrument.BTC_USDT

Worker types

Worker type Consumes Produces Command Response Error
alpacaorderbook virtufin.venue.alpaca/orderbook.update virtufin.venue.alpaca/orderbook.changed wrk.alpacaorderbook.command.{worker_id} wrk.alpacaorderbook.response wrk.alpacaorderbook.error
alpacatrades virtufin.venue.alpaca/trade.update virtufin.venue.alpaca/trade.executed wrk.alpacatrades.command.{worker_id} wrk.alpacatrades.response wrk.alpacatrades.error
binanceorderbook virtufin.venue.binance/orderbook.update
virtufin.venue.binance/orderbook.snapshot
virtufin.venue.binance/instrument.snapshot
virtufin.venue.binance/orderbook.changed
virtufin.venue.binance/orderbook.gap
wrk.binanceorderbook.command.{worker_id} wrk.binanceorderbook.response wrk.binanceorderbook.error
binancecandles virtufin.venue.binance/candle.update virtufin.venue.binance/candle.closed wrk.binancecandles.command.{worker_id} wrk.binancecandles.response wrk.binancecandles.error
binancetrades virtufin.venue.binance/trade.update virtufin.venue.binance/trade.executed wrk.binancetrades.command.{worker_id} wrk.binancetrades.response wrk.binancetrades.error
binanceportfolio wrk.binanceportfolio.command.{worker_id} wrk.binanceportfolio.response wrk.binanceportfolio.error
binancepositionreconciler wrk.binancepositionreconciler.command.{worker_id} wrk.binancepositionreconciler.response wrk.binancepositionreconciler.error
websocketfeed wrk.websocketfeed.command.{worker_id} wrk.websocketfeed.response wrk.websocketfeed.error

Venues

Venue Symbol format BTC_USDT on the venue Interval names Fragment
alpaca {BASE}/{QUOTE} BTC/USDT virtufin.venue.alpaca
binance {BASE}{QUOTE} BTCUSDT 1M → 1mo virtufin.venue.binance