Skip to content
This repository has been archived by the owner on Dec 12, 2022. It is now read-only.

Latest commit

 

History

History
59 lines (42 loc) · 2.74 KB

README.md

File metadata and controls

59 lines (42 loc) · 2.74 KB
Raw

district-server-web3

CircleCI

Clojurescript-node.js mount module for a district server, that takes care of setting up and providing web3 instance.

Installation

Add
Clojars Project
into your project.clj.
Include [district.server.web3] in your CLJS file, where you use mount/start.

Warning: district0x modules are still in early stages, therefore API can change in a future.

Usage

You can pass following args to web3 module:

  • :port Port of locally running ganache or real ethereum client
  • :url Full url of the client to connect to.
  • :client-config map of options passed to the websocket client.
  • :reset-connection-poll-interval If websocket disconnects or detects an error module calls on-offline and starts polling with this interval (milliseconds) if the connection can be re-created.
  • :on-online Function to be called when connection to the node comes back online.
  • :on-offline Function to be called when websocket connection disconnects or throws an error.
(ns my-district
  (:require [mount.core :as mount]
            [district.server.web3 :refer [web3]]
            [cljs-web3.eth :as web3-eth]))

(-> (mount/with-args
      {:web3 {:port 8545}})
  (mount/start))

(.then (web3-eth/accounts @web3) prn)
;; => ["0x184c2c67dec231c32856e13134670e44f636acc9"]

Module dependencies

district-server-config

district-server-web3 gets initial args from config provided by district-server-config/config under the key :web3. These args are then merged together with ones passed to mount/with-args.

If you wish to use custom modules instead of dependencies above while still using district-server-web3, you can easily do so by mount's states swapping.

Development (build, test)

Node.js

  1. Build: npx shadow-cljs compile test-node
  2. Tests: node out/node-tests.js

Inspect on headless chrome on another chrome instance

  1. Run headless chrome: chromium-browser --headless --remote-debugging-port=9222 --remote-debugging-address=0.0.0.0 --allowed-origins="*" https://chromium.org
  2. Open chrome://inspect/#devices and configure remote target with IP ADDRESS (hostname doesn't work)

Build & release with deps.edn and tools.build

  1. Build: clj -T:build jar
  2. Release: clj -T:build deploy