Check Connection
Checks if there's an active connection between PlugA on ChainA and PlugB on ChainB, and returns the type of switchboard used.
On-chain
The connection can be verified on-chain by calling the getPlugConfig()
method on Socket. More on this here.
Off-chain
GET
https://prod.dlapi.socket.tech/v1/check-connection
Header: x-api-key : 2Va1n3HzAS5XfXB8ELhX1aATJwzA1A72sNnJE1a0
Query Param | Description |
---|---|
slugA | Chain A slug |
slugB | Chain B slug |
plugA | Address of Plug on Chain A |
plugB | Address of Plug on Chain B |
Example Request
Verifying a connection between Plugs deployed on Goerli and Mumbai testnet
Note : Add the x-api-key header mentioned above in the request for authentication.
Response Parameters
Parameter | Description |
---|---|
arePlugsConnected | Boolean value indicating if there's an active connection between Plugs |
aToBIntegrationType | Returns type of switchboard used for connection from PlugA to PlugB (FAST , SLOW , NATIVE ) |
bToAIntegrationType | Returns type of switchboard used for connection from PlugB to PlugA (FAST , SLOW , NATIVE ) |