Connection Management

[s0b0lev]

Query details of all joined token networks

Documentation Link

GET /api/(version)/connections

Example request

$ curl -i http://localhost:5001/api/v1/connections

Example Response

{
    "0x2a65Aca4D5fC5B5C859090a6c34d164135398226": {
        "funds": 100,
        "sum_deposits": 67,
        "channels": 3
    },
    "0x0f114A1E9Db192502E7856309cc899952b3db1ED": {
        "funds": 49,
        "sum_deposits": 31,
        "channels": 1
    }
}

Response JSON Array of Objects:

• funds (int) – Funds from last connect request
• sum_deposits (int) – Sum of deposits of all currently open channels
• channels (int) – Number of channels currently open for that token

Status Codes

• 200 OK – For a successful query
• 500 Internal Server Error – Internal Raiden node error

---

Automatically join a token network

Documentation Link

PUT /api/(version)/connections/(token_address)

Example Request

$ curl -i -X PUT http://localhost:5001/api/v1/connections/0x2a65Aca4D5fC5B5C859090a6c34d164135398226 -H 'Content-Type: application/json' --data-raw '{"funds": 1337}'

Payload

• funds (int) – Amount of funding you want to put into the network.
• initial_channel_target (int) – Number of channels to open proactively.
• joinable_funds_target (float) – Fraction of funds that will be used to join channels opened by other participants.

Status Codes

• 204 No Content – For a successful connection creation.
• 402 Payment Required – If any of the channel deposits fail due to insufficient ETH balance to pay for the gas of the on-chain transactions.
• 404 Not Found – The given token address is not a valid eip55-encoded Ethereum address
• 408 Request Timeout – If a timeout happened during any of the transactions.
• 409 Conflict – If any of the provided input to the call is invalid.
• 500 Internal Server Error – Internal Raiden node error.

---

Leave a token network

Documentation Link

DELETE /api/(version)/connections/(token_address)

Example Request

$ curl -i -X DELETE http://localhost:5001/api/v1/connections/0x2a65Aca4D5fC5B5C859090a6c34d164135398226 -H 'Content-Type: application/json'

Example Response

[
    "0x41BCBC2fD72a731bcc136Cf6F7442e9C19e9f313",
    "0x5A5f458F6c1a034930E45dC9a64B99d7def06D7E",
    "0x8942c06FaA74cEBFf7d55B79F9989AdfC85C6b85"
]

Status codes

• 200 OK – For successfully leaving a token network
• 404 Not Found – The given token address is not a valid eip55-encoded Ethereum address
• 500 Internal Server Error – Internal Raiden node error

[s0b0lev]

Connection management interfaces were implemented.