Files
ritmex-bot/docs/grvt/schemas/ws_withdrawal_feed_data_v1.md
T

2.4 KiB

!!! info "WSWithdrawalFeedDataV1" Subscribes to a feed of withdrawal updates.

|Name<br>`Lite`|Type|Required<br>`Default`| Description |
|-|-|-|-|
|stream<br>`s` |string|True|The websocket channel to which the response is sent|
|selector<br>`s1` |string|True|Primary selector|
|sequence_number<br>`sn` |string|True|A sequence number used to determine message order within a stream.<br>- If `useGlobalSequenceNumber` is **false**, this returns the gateway sequence number, which increments by one locally within each stream and resets on gateway restarts.<br>- If `useGlobalSequenceNumber` is **true**, this returns the global sequence number, which uniquely identifies messages across the cluster.<br>  - A single cluster payload can be multiplexed into multiple stream payloads.<br>  - To distinguish each stream payload, a `dedupCounter` is included.<br>  - The returned sequence number is computed as: `cluster_sequence_number * 10^5 + dedupCounter`.|
|feed<br>`f` |Withdrawal|True|The Withdrawal object|
??? info "[Withdrawal](/../../schemas/withdrawal)"
    |Name<br>`Lite`|Type|Required<br>`Default`| Description |
    |-|-|-|-|
    |from_account_id<br>`fa` |string|True|The subaccount to withdraw from|
    |to_eth_address<br>`te` |string|True|The ethereum address to withdraw to|
    |currency<br>`c` |string|True|The token currency to withdraw|
    |num_tokens<br>`nt` |string|True|The number of tokens to withdraw|
    |signature<br>`s` |Signature|True|The signature of the withdrawal|
    ??? info "[Signature](/../../schemas/signature)"
        |Name<br>`Lite`|Type|Required<br>`Default`| Description |
        |-|-|-|-|
        |signer<br>`s` |string|True|The address (public key) of the wallet signing the payload|
        |r<br>`r` |string|True|Signature R|
        |s<br>`s1` |string|True|Signature S|
        |v<br>`v` |integer|True|Signature V|
        |expiration<br>`e` |string|True|Timestamp after which this signature expires, expressed in unix nanoseconds. Must be capped at 30 days|
        |nonce<br>`n` |integer|True|Users can randomly generate this value, used as a signature deconflicting key.<br>ie. You can send the same exact instruction twice with different nonces.<br>When the same nonce is used, the same payload will generate the same signature.<br>Our system will consider the payload a duplicate, and ignore it.|