Authentication
Access Vertex's authenticated streams.
Last updated
Access Vertex's authenticated streams.
Last updated
A single wallet address can be authenticated by up to 5 websocket connections, regardless of the originating IP address. Connections exceeding these limits will be automatically disconnected.
To access streams that require authentication, submit a request with the method
field set to authenticate
.
method
string
Yes
authenticate
id
number
Yes
Can be set to any positive integer. Can be used to identify the websocket request / response.
tx
object
Yes
tx.sender
string
Yes
A hex string representing a bytes32
of a specific subaccount.
tx.expiration
string
Yes
Represents the expiration time in milliseconds since the Unix epoch.
signature
string
Yes
The typed data struct that needs to be signed is:
sender
: A hex string representing a bytes32
of a specific subaccount. The signature must be signed by the wallet address specified by sender.
expiration
: Represents the expiration time in milliseconds since the Unix epoch. Requests will be denied if the expiration is either smaller than the current time or more than 100 seconds ahead of it.
StreamAuthentication
object that needs to be signed. See section for more details.
Hex string representing hash of the signed StreamAuthentication
object.See section for more details.
See more details and examples in our page.