Initial Commit

docs/api/redis-channels.md

@@ -0,0 +1,38 @@
+# Redis channels
+
+This document describes the redis channels used by thalos to deliver messages.
+
+## Namespace
+
+First. all channels have a namespace attached to them. this is done to prevent other application to clash with the keys.
+
+The namespace have the following format: `<prefix>::<chain_id>`
+
+* `prefix` is per default `ship` but can be configured to be something else.
+* `chain_id` is the chain's id and is used to separate transactions if multiple chains are setup in the same redis database.
+
+## Transactions
+
+All transactions are posted to the following channel:
+
+`<namespace>::transactions`
+
+## Actions
+
+there is 4 types of channels for actions.
+
+The channel where all actions are posted is:
+
+`<namespace>::actions`
+
+Channel where only specific actions are posted:
+
+`<namespace>::actions/name/<action>`
+
+Channel where only actions on a specific `<contract>` is posted:
+
+`<namespace>::actions/contract/<contract>`
+
+Channel where only `<action>` on a specific `<contract>` is posted:
+
+`<namespace>::actions/contract/<contract>/name/<action>`