diff --git a/bip-0040.mediawiki b/bip-0040.mediawiki index 5a06bb64..2179d836 100644 --- a/bip-0040.mediawiki +++ b/bip-0040.mediawiki @@ -203,6 +203,113 @@ Send the version of the client to the server. This command doesn't expect a resp | The client version. |} +===Service: Example=== + +This service is an example service. It doesn't have any other purpose than testing. + +* Service name: example +* Service vendor: Stratum + +====Method: Hello World==== + +Ask the server to send a "Hello world!" back. + +* Method name: hello_world + +{| +! [Request] +! Type +! Example +! Description +|- +! Method +| colspan="3" | example.hello_world +|- +! [Response] +! Type +! Example +! Description +|- +! Result +| string +| Hello world! +| The "Hello world" text. +|} + +====Method: Ping==== + +Ping the server and get a pong back with the same text. + +* Method name: ping + +{| +! [Request] +! Type +! Example +! Description +|- +! Method +| colspan="3" | example.ping +|- +! Params [0] (payload) +| mixed +| 12345678 +| The ping text. +|- +! [Response] +! Type +! Example +! Description +|- +! Result +| string +| Hello world! +| The "Hello world" text. +|} + +====Method: Synchronous==== + +Ask the server to run a synchronous command for a specific amount of seconds. + +* Method name: synchronous + +====Method: Throw Exception==== + +Ask the server throw exception. + +* Method name: throw_exception + +====Method: Throw Signed Exception==== + +Ask the server throw signed exception. + +* Method name: throw_signed_exception + +===Service: Example Publish-Subscribe=== + +This service is an example service. It doesn't have any other purpose than testing. + +* Service name: example.pubsub +* Service vendor: Stratum + +====Method: Subscribe==== + +Subscribe on an event. + +* Method name: subscribe + +====Method: Time Event==== + +The time event that gets emitted. + +* Method name: time_event + +====Method: Unsubscribe==== + +Unsubscribe from an event. + +* Method name: unsubscribe + ===Service: Server=== * Service name: server @@ -251,7 +358,7 @@ This document serves as the specification for the media type "application/stratu IANA maintains the registry of WebSocket Subprotocol Names at https://www.iana.org/assignments/websocket. -This document serves as the specification for the subprotocol name "stratum". It has been registered with IANA. +This document serves as the specification for the WebSocket subprotocol name "stratum". It has been registered with IANA. ==References== \ No newline at end of file