+ poa_agent v0.1.0 + POAAgent + + + + View Source + + +
+ + +POAAgent
+
+
+ + Documentation +
+ +-
+
- Initial Architecture + +
- You can find the online documentation here + +
- Getting Started + +
Or you can build the documenation locally running
+mix deps.get
+mix docsThat command will create a doc/ folder with the actual Documentation.
+ + Run +
+ +POAAgent is an Elixir application, in order to run it first we need to fetch the dependencies and compile it.
+mix deps.get
+mix deps.compile
+mix compileTo run the Elixir application while under development it may be convenient to use:
+env MIX_ENV=dev mix run --no-halt with an appropiate configuration in /config/dev.exs.
+ + Run Tests +
+ +In order to run the tests we have to run the command
+mix testPOAAgent comes also with a code analysis tool Credo and a types checker tool Dialyxir. In order to run them we have to run
mix credo
+mix dialyzer+ + Building & Deploying an Executable +
+ +To build an executable you’ll need Elixir 1.6 (and Erlang/OTP 20).
+-
+
- Once you have a copy of this repository configure the agent for production in the file
config/prod.exs. +
+ - An real configuration example can be found in the default
config/prod.exs. +
+ - Do a
mix deps.getto fetch, among other dependencies, the tooling for building server executables. +
+ - A
env MIX_ENV=prod mix release --name=poa_agent --env=prodwill assemble an executable. +
+
A resulting artifact resides at _build/prod/rel/poa_agent/releases/0.1.0/poa_agent.tar.gz which you can move to a remote host.
+Use tar xfz then bin/poa_agent start (bin/poa_agent stop will stop the server cleanly).
If you want to run it on the local host then the procedure is as simple as: _build/prod/rel/poa_agent/bin/poa_agent.
Note: executables must be built on the platform (OS and architecture) they are destined for under the project’s current configuration.
+Other options are possible (see https://hexdocs.pm/distillery/getting-started.html).
+ + Configuration +
+ +Executables are built with a configuration as described above.
+However the transfers and collectors are configurable at run-time through a JSON configuration.
+To configure this supply a path to a JSON file with the config_overlay key/value.
+The following is an extract from config/test.exs:
config :poa_agent,
+ config_overlay: "config/config_overlay.json"A corresponding example is provided in config/config_overlay.json:
{
+ "POAAgent":{
+ "collectors":[
+ {
+ "id": "eth_information",
+ "url": "http://localhost:8546",
+ "name": "NewNodeName",
+ "contact": "mynewemail@gmail.com"
+ }
+ ],
+ "transfers":[
+ {
+ "id": "rest_transfer",
+ "address": "http://localhost:4003",
+ "identifier": "NewIdentifier",
+ "secret": "newsecret"
+ }
+ ]
+ }
+}
+The file can reside anywhere on the machine that the Elixir executable has access to.
+The key/value pairs in the JSON configuration will replace the defaults specified in the Elixir configuration (i.e. config/{dev,test,prod}.exs).
+ + Coverage +
+ +To get an HTML coverage report on your own machine try env MIX_ENV=test mix coveralls.html then open cover/excoveralls.html.
+You can get a simple print-out with env MIX_ENV=test mix coveralls.