Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service Channel
channel.proto:8rpc Open (, )
channel.proto:9rpc Update (, )
channel.proto:10rpc Close (, )
channel.proto:11rpc SubscribeTrades (, stream )
channel.proto:13message
channel.proto:16string channel_id = 1
string last_external_id = 2
service EscrowChannel
escrow.proto:11Escrow Service definition In the protocol, Client is the Initiator, Server is the Follower Initiator start with turnNum = 0 prefunding stage.
rpc Prefund (, )
escrow.proto:12turnNum = 0
rpc Postfund (, )
escrow.proto:13turnNum = 1
rpc Execute (, )
escrow.proto:14turnNum = 2
rpc Finalize (, )
escrow.proto:15isFinal State
service Operator
operator.proto:13protolint:disable MAX_LINE_LENGTH
rpc GetVersion (, )
operator.proto:14message
operator.proto:30(message has no fields)
message
operator.proto:33string version = 1
rpc GetChallenge (, )
operator.proto:15message
operator.proto:37optional address = 1
string name = 2
message
operator.proto:42string challenge = 1
rpc Authenticate (, )
operator.proto:16message
operator.proto:46string signature = 2
optional address = 3
message
operator.proto:51string jwt = 1
rpc OpenChannel (, )
operator.proto:18message
operator.proto:71optional peer = 1
string margin_deposit = 2
message
operator.proto:76string channel_id = 1
rpc GetChannelJwt (, )
operator.proto:19message
operator.proto:80string channel_id = 1
message
operator.proto:84string jwt = 1
rpc GetPositions (, )
operator.proto:20message
operator.proto:210string channel_id = 1
message
operator.proto:214string channel_id = 1
repeated positions = 2
message
operator.proto:219(message has no fields)
message
operator.proto:222repeated clear_streams = 1
rpc RecordTrade (, )
operator.proto:22message
operator.proto:55optional trade = 1
message
operator.proto:59optional trade = 1
rpc RecordTrades (, )
operator.proto:23message
operator.proto:64Maximum number of trades per request is 6765
repeated trades = 1
message
operator.proto:68(message has no fields)
rpc RequestSettlement (, )
operator.proto:24message
operator.proto:200string channel_id = 1
settlement.PaymentMethod payment_method = 2
uint64 chain_id = 3
repeated markets = 4
message
operator.proto:207(message has no fields)
rpc CloseChannel (, )
operator.proto:25message
operator.proto:88string channel_id = 1
message
operator.proto:92(message has no fields)
rpc SubscribeChannelsEvents (, stream )
operator.proto:27message
operator.proto:95(message has no fields)
message
operator.proto:98oneof notification
stream_notification = 1
settlement_notification = 2
position_notification = 3
error_notification = 4
transaction_notification = 5
session_key_transaction_notification = 6
record_trade_notification = 7
service PriceFeed
price_feed.proto:7rpc Subscribe (, stream )
price_feed.proto:8message
price_feed.proto:17optional market = 1
message
price_feed.proto:11optional market = 1
optional price = 2
int64 timestamp = 3
service TradeChannel
trade.proto:11Service definition In the protocol, Client is the Initiator, Server is the Follower Initiator start with turnNum = 0 prefunding stage.
rpc Prefund (, )
trade.proto:12turnNum = 0
rpc Postfund (, )
trade.proto:13turnNum = 1
rpc UpdateMargin (, )
trade.proto:14rpc RequestSettlement (, )
trade.proto:17TODO: Message protocol to be defined Find how to bind with Settlement SVC
rpc Finalize (, )
trade.proto:18isFinal State
message
channel.proto:21Used as request type in: Channel.Close, Channel.Open, Channel.Update
optional state = 1
string state_hash = 2
optional state_sig = 3
Used in:
CLEARING_EVENT_UNSPECIFIED = 0
CLEARING_EVENT_INSTANTIATED = 1
CLEARING_EVENT_ACCEPTED = 2
CLEARING_EVENT_FAILED = 3
CLEARING_EVENT_INITIATOR_FUNDED = 4
CLEARING_EVENT_RESPONDER_FUNDED = 5
CLEARING_EVENT_POSTFUND_PROPOSED = 6
CLEARING_EVENT_AGREED_ON_POSTFUND = 7
CLEARING_EVENT_MOVE_TO_OPERATIONAL = 8
CLEARING_EVENT_PROCESS_MARGIN_CALL = 9
CLEARING_EVENT_STARTED_SETTLEMENT = 10
CLEARING_EVENT_PROCESS_POST_SETTLEMENT_MARGIN = 11
CLEARING_EVENT_FINALIZE_SETTLEMENT = 12
CLEARING_EVENT_FAILED_SETTLEMENT = 13
CLEARING_EVENT_CHALLENGE = 14
CLEARING_EVENT_FINALIZE = 15
CLEARING_EVENT_WITHDRAW = 16
CLEARING_EVENT_CLEAR_CHALLENGE = 17
CLEARING_EVENT_TIMEOUT_CHALLENGE = 18
Used in:
CLEARING_STATE_UNSPECIFIED = 0
CLEARING_STATE_INSTANTIATED = 1
CLEARING_STATE_ACCEPTED = 2
CLEARING_STATE_FAILED = 3
CLEARING_STATE_INITIATOR_FUNDED = 4
CLEARING_STATE_FUNDED = 5
CLEARING_STATE_OPERATIONAL = 6
CLEARING_STATE_ISSUING_MARGIN_CALL = 7
CLEARING_STATE_PROCESSING_MARGIN_CALL = 8
CLEARING_STATE_ACTIVE_SETTLEMENT = 9
CLEARING_STATE_ISSUING_POST_SETTLEMENT_MARGIN = 10
CLEARING_STATE_PROCESSING_POST_SETTLEMENT_MARGIN = 11
CLEARING_STATE_CHALLENGING = 12
CLEARING_STATE_FINALIZING = 13
CLEARING_STATE_WITHDRAWING = 14
CLEARING_STATE_CONCLUDING = 15
CLEARING_STATE_DEFAULT = 16
message
operator.proto:226Used in:
string channel_id = 1
string state = 3
string event = 4
message
operator.proto:182Used in:
string msg = 2
optional metadata = 4
string action = 5
message
escrow.proto:19Message Trading Channel state definition
Used as request type in: EscrowChannel.Execute, EscrowChannel.Finalize, EscrowChannel.Postfund, EscrowChannel.Prefund
Used as response type in: EscrowChannel.Execute, EscrowChannel.Finalize, EscrowChannel.Postfund, EscrowChannel.Prefund
bytes channel_id = 1
optional state = 2
bytes state_hash = 3
repeated state_hash_sigs = 4
uint64 settlement_id = 5
TODO: Find how to correction bind TradeChannel, Settlements and EscrowChannels Keep in mind that and EscrowChannels is a type of settlement options.
message
session_key.proto:7Used in:
optional sender = 1
optional nonce = 2
bytes init_code = 3
bytes call_data = 4
optional call_gas_limit = 5
optional verification_gas_limit = 6
optional pre_verification_gas = 7
optional max_fee_per_gas = 8
optional max_priority_fee_per_gas = 9
bytes paymaster_and_data = 10
bytes signature = 11
Used in:
PARAM_CONDITION_UNSPECIFIED = 0
PARAM_CONDITION_EQUAL = 1
PARAM_CONDITION_GREATER_THAN = 2
PARAM_CONDITION_LESS_THAN = 3
PARAM_CONDITION_GREATER_THAN_OR_EQUAL = 4
PARAM_CONDITION_LESS_THAN_OR_EQUAL = 5
PARAM_CONDITION_NOT_EQUAL = 6
message
session_key.proto:39Used in:
ParamCondition condition = 1
string param = 2
message
operator.proto:173Used in:
optional position = 1
message
operator.proto:195Used in:
optional trade = 1
string revert_reason = 2
message
session_key.proto:21Used in:
optional target = 1
bytes function_abi = 2
optional value_limit = 3
repeated param_rules = 4
message
operator.proto:188Used in:
optional incomplete_userop = 1
uint64 enable_sig_offset = 2
string digest_hash = 3
repeated permissions = 4
message
operator.proto:166Used in:
string channel_id = 1
settlement.SettlementState settlement_state = 2
repeated markets = 3
optional ledger = 4
message
operator.proto:152Used in:
string channel_id = 1
ClearingEvent event = 2
ClearingState state = 3
core.ProtocolIndex my_role = 4
optional peer = 5
core.MarginLimitType margin_limit_type = 6
string margin_deposit = 7
string initiator_margin_balance = 8
margin updates will be reflected here
string follower_margin_balance = 9
margin updates will be reflected here
uint64 turn_num = 10
state_machine.ClearingSMState clearing_sm_state = 11
message
trade.proto:22Message Trading Channel state definition
Used as request type in: TradeChannel.Finalize, TradeChannel.Postfund, TradeChannel.Prefund, TradeChannel.RequestSettlement
Used as response type in: TradeChannel.Finalize, TradeChannel.Postfund, TradeChannel.Prefund, TradeChannel.RequestSettlement
bytes channel_id = 1
optional state = 2
bytes state_hash = 3
repeated state_hash_sigs = 4
optional safety = 5
optional margin_call = 6
message
operator.proto:177Used in:
string to = 1
string data = 2