Skip to content

Module dev_relay.erl

This module implements the relay device, which is responsible for relaying messages between nodes and other HTTP(S) endpoints.

Description

It can be called in either call or cast mode. In call mode, it returns a {ok, Result} tuple, where Result is the response from the remote peer to the message sent. In cast mode, the invocation returns immediately, and the message is relayed asynchronously. No response is given and the device returns {ok, <<"OK">>}.

Example usage:

       curl /~relay@.1.0/call?method=GET?0.path=https://www.arweave.net/

Function Index

call/3Execute a call request using a node's routes.
call_get_test/0*
cast/3Execute a request in the same way as call/3, but asynchronously.
commit_request_test/0*Test that a relay@1.0/call correctly commits requests as specified.
relay_nearest_test/0*
request/3Preprocess a request to check if it should be relayed to a different node.

Function Details

call/3

call(M1, RawM2, Opts) -> any()

Execute a call request using a node's routes.

Supports the following options: - target: The target message to relay. Defaults to the original message. - relay-path: The path to relay the message to. Defaults to the original path. - method: The method to use for the request. Defaults to the original method. - commit-request: Whether the request should be committed before dispatching. Defaults to false.

call_get_test/0 *

call_get_test() -> any()

cast/3

cast(M1, M2, Opts) -> any()

Execute a request in the same way as call/3, but asynchronously. Always returns <<"OK">>.

commit_request_test/0 *

commit_request_test() -> any()

Test that a relay@1.0/call correctly commits requests as specified. We validate this by configuring two nodes: One that will execute a given request from a user, but only if the request is committed. The other node re-routes all requests to the first node, using call's commit-request key to sign the request during proxying. The initial request is not signed, such that the first node would otherwise reject the request outright.

relay_nearest_test/0 *

relay_nearest_test() -> any()

request/3

request(Msg1, Msg2, Opts) -> any()

Preprocess a request to check if it should be relayed to a different node.