API exposure - RESTful API and socket.io-based push Events #280
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Should we merge this PR or wait for the changes as defined in #10 ? |
|
let's wait for the changes in #10 , I will push to this PR directly and rename it accordingly |
This is the server for the API exposure. All methods marked by the @expose decorator will be available via http-requests at the given REST endpoint, once the Dispatcher is initialized and the server is running. Synchronous methods will return their return-value immediately in the request's respond message. Asynchronous methods will not return their return value, but rather a unique callback-id, that will later be used in a 'rpc_response' Event via socket.io for evaluation. The response is structured like this: { callback_id: value or None if Synchronous method= str (the methods name) result= value or None if Asynchronous } Clients should also connect to the websocket that is used for push-Notifications ('Events') via the socket.io protocol. Without the connection to the socket, asynchronous calls over http-requests will be initiated, but the client has no knowledge about the success of the call. Also externally initiated state-changes such as channel-opening or incoming transfers will not be observed by the client, if he doesn't want to pull this information constantly. Events are structured like this: Event: 'rpc_response' namespace: '/' data: { callback_id: <int>, procedure: <str>, status: <bool> } closes #10 related issue: #207
…Exception classes
…_event methods, add basic Event Queue
ezdac
commented
Jan 24, 2017
| from ethereum.transactions import Transaction | ||
| from ethereum.utils import denoms, int_to_big_endian, encode_hex, normalize_address | ||
| <<<<<<< 4c31f51f14f0b23ec72f06c4605e9944fbe60a20 |
There was a problem hiding this comment.
note to self: don't get distracted while rebasing
ezdac
commented
Jan 24, 2017
|
|
||
| log = slogging.get_logger(__name__) # pylint: disable=invalid-name | ||
|
|
||
| DEFAULT_REVEAL_TIMEOUT = 30 | ||
| DEFAULT_SETTLE_TIMEOUT = DEFAULT_REVEAL_TIMEOUT * 20 | ||
|
|
||
| EventListener = namedtuple('EventListener', ('event_name', 'filter_', 'translator')) |
There was a problem hiding this comment.
Careful: this and every related peace of code didn't make it in my pull-rebase from origin/master (somehow).
If I cannot rewind this easily, it has to be cherrypicked and reimplemented again!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this provides the initial ideas of the API-exposure.
what this PR implements:
@exposedecorated methods can be called via http-requests (REST-style URLs)"result": data"result": nullDispatcher-classsocket.ioprotocol)what is still TO DO:
closes #10
related #207