feat(example): plumbing, intra-node routing for #308

changelog.config.js

@@ -0,0 +1,92 @@
+module.exports = {
+  disableEmoji: true,
+  list: [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "refactor",
+    "revert",
+    "style",
+    "test",
+  ],
+  maxMessageLength: 64,
+  minMessageLength: 3,
+  maxHeaderWidth: 72,
+  questions: [
+    "type",
+    "scope",
+    "subject",
+    "body",
+    "breaking",
+    "issues",
+    "lerna",
+  ],
+  scopes: [],
+  types: {
+    build: {
+      description:
+        "Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)",
+      emoji: "",
+      value: "build",
+    },
+    chore: {
+      description: "Build process or auxiliary tool changes",
+      emoji: "",
+      value: "chore",
+    },
+    ci: {
+      description: "CI related changes",
+      emoji: "",
+      value: "ci",
+    },
+    docs: {
+      description: "Documentation only changes",
+      emoji: "",
+      value: "docs",
+    },
+    feat: {
+      description: "A new feature",
+      emoji: "",
+      value: "feat",
+    },
+    fix: {
+      description: "A bug fix",
+      emoji: "",
+      value: "fix",
+    },
+    perf: {
+      description: "A code change that improves performance",
+      emoji: "",
+      value: "perf",
+    },
+    refactor: {
+      description: "A code change that neither fixes a bug or adds a feature",
+      emoji: "",
+      value: "refactor",
+    },
+    release: {
+      description: "Create a release commit",
+      emoji: "",
+      value: "release",
+    },
+    revert: {
+      description: "Reverts a previous commit",
+      emoji: "",
+      value: "revert",
+    },
+    style: {
+      description: "Markup, white-space, formatting, missing semi-colons...",
+      emoji: "",
+      value: "style",
+    },
+    test: {
+      description: "Adding missing tests",
+      emoji: "",
+      value: "test",
+    },
+  },
+};

docs/architecture/routing-to-api-servers-deployment-diagram.puml

@@ -0,0 +1,59 @@
+@startuml Routing to Plugin Instances
+
+
+!include <material/common>
+' To import the sprite file you DON'T need to place a prefix!
+!include <material/cellphone>
+!include <material/laptop_chromebook>
+!include <material/database>
+
+title Routing to Plugin Instances\nDeployment Diagram\nHyperledger Cactus
+
+actor "User A" as usera <<human>>
+
+frame "End User Device" as enduserdevice {
+  frame "Business Application" as ba {
+    rectangle "Cactus SDK" as cactussdk {
+      rectangle "API Client" as apiclient {
+      }
+      rectangle "Client Side\nRouter" as clientsiderouter {
+      }
+    }
+  }
+}
+
+cloud "Public Internet" as publicinternet {
+}
+
+frame "Cactus Backend" as cactus {
+    rectangle "API Server A" as apia {
+    rectangle "Connector\nPlugin A" as connectorplugina {
+    }
+  }
+  rectangle "API Server B" as apib {
+    rectangle "Connector\nPlugin B" as connectorpluginb {
+    }
+  }
+}
+
+
+frame "Ledgers" as ledgers {
+  MA_DATABASE(Gray, 1, ledger1, rectangle, "Ledger 1") {
+  }
+  MA_DATABASE(Gray, 1, ledger2, rectangle, "Ledger 2") {
+  }
+}
+
+usera => apiclient: TX: Ledger 1
+apiclient => clientsiderouter: TX: Ledger 1
+clientsiderouter => publicinternet: TX: Ledger 1
+
+publicinternet ==> connectorplugina: TX: Ledger 1
+publicinternet -[#AAAAAA]-> connectorpluginb
+
+connectorplugina ==> ledger1: TX: Ledger 1
+connectorpluginb -[#AAAAAA]-> ledger2
+
+@enduml
+
+

docs/architecture/routing-to-plugin-instances-deployment-diagram.puml

@@ -0,0 +1,55 @@
+@startuml Routing to Plugin Instances
+
+
+!include <material/common>
+' To import the sprite file you DON'T need to place a prefix!
+!include <material/cellphone>
+!include <material/laptop_chromebook>
+!include <material/database>
+
+title Routing to Plugin Instances\nDeployment Diagram\nHyperledger Cactus
+
+actor "User A" as usera <<human>>
+
+frame "End User Device" as enduserdevice {
+  frame "Business Application" as ba {
+    rectangle "Cactus SDK" as cactussdk {
+      rectangle "API Client" as apiclient {
+      }
+      rectangle "Client Side\nRouter" as clientsiderouter {
+      }
+    }
+  }
+}
+
+cloud "Public Internet" as publicinternet {
+}
+
+frame "Cactus Backend" as cactus {
+  rectangle "API Server A" as apia {
+    rectangle "Connector\nPlugin A" as connectorplugina {
+    }
+    rectangle "Connector\nPlugin B" as connectorpluginb {
+    }
+  }
+}
+
+
+frame "Ledgers" as ledgers {
+  MA_DATABASE(Gray, 1, ledger1, rectangle, "Ledger 1") {
+  }
+  MA_DATABASE(Gray, 1, ledger2, rectangle, "Ledger 2") {
+  }
+}
+
+usera => apiclient: TX: Ledger 1
+apiclient => clientsiderouter: TX: Ledger 1
+clientsiderouter => publicinternet: TX: Ledger 1
+
+publicinternet ==> connectorplugina: TX: Ledger 1
+publicinternet -[#AAAAAA]-> connectorpluginb
+
+connectorplugina ==> ledger1: TX: Ledger 1
+connectorpluginb -[#AAAAAA]-> ledger2
+
+@enduml