This document describes how the Polymath architecture is at this point in time (September 2018)

State of the codebase

Starting on September 2018, we began migrating to a monorepo structure using Yarn Workspaces and Lerna

Apps and Packages

Index:

• @polymathnetwork/issuer (Webapp): App for creating, configuring and issuing Security Tokens.
• @polymathnetwork/investor (Webapp): Template project for issuers to host their own page to offer their STO. Right now it is expected that the user clones the repository and sets it up.
• @polymathnetwork/offchain (Service): Deals with processes done outside the blockchain. Right now, mailing mostly.
• @polymathnetwork/js (NPM package): Utility package that attempts to simplify interaction with the Smart Contracts. It is right now working as a web3.js wrapper.
• @polymathnetwork/ui (Package): It seems to have been originally intended to store shared React Components, current state though is tightly coupled with issuer.
• @polymathnetwork/auth (Package): Package managing the state of the connection to the network. This has been merged with ui
• @polymathnetwork/shared (Private package): Package new to the monorepo, this was added to provide a place for shared code across packages. It is also providing a fixed state of the contracts' artifacts and the local blockchain to avoid environment inconsistencies. These must be re-generated if the dependency to polymath-core is changed.