DON'T MERGE - What it takes to integrate your internal KYC and settlement systems with Polymesh.

README.md

@@ -0,0 +1,63 @@
+There are 2 subfolders. Each is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). They are built in a similar way.
+
+* [kyc_provider](./kyc_provider) provides a basic example of a KYC provider system.
+* [settlement_provider](./settlement_provider) provides a basic example of an exchange settlement system integrated with custodians.
+
+There are 2 important branches:
+
+* `pre-polymesh`, that imagines a simplified existing setup for a KYC or settlement provider.
+* `post-polymesh`, that provides an example of integration of the existing operations with Polymesh.
+
+There is a pull request, which should not be merged, that makes explicit the changes that went into `post-polymesh`. This can serve as the starting point for reflection.
+
+A general note. There is no login for the `pre-polymesh` parts, so anyone can impersonate someone else. Obviously, this is a design decision meant to avoid overburdening the learner. In the `post-polymesh` parts, there is still no login, but the public / private keys default system prevents spoofing anyway.
+
+## Getting Started
+
+In each sub-folder:
+
+1. Install:
+    ```bash
+    npm install
+    ```
+2. Enter your `keys.json` following the model found in `keys.json.sample`.
+3. See the specifics in each folder's `README.md`.
+4. Run the development server:
+    ```bash
+    npm run dev
+    # or
+    yarn dev
+    ```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+## Modify it
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+
+## Further creation steps
+
+```bash
+npm install --save-dev typescript @types/react @types/node
+touch tsconfig.json
+npm run dev
+```

kyc_provider/README.md

@@ -1,51 +1,44 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Basic example of a KYC provider system
 
-It provides a basic example of a KYC provider system.
+The KYC provider is known as ExKyc.
 
-## Getting Started
+There are 2 pages:
 
-First, install:
+* `/` for the KYC customer to enter their parameters.
+* `/manager` for the KYC internal system to handle requests.
 
-```bash
-npm install
-```
-Second, run the development server:
+For the avoidance of doubt, this is meant as an example of KYC, and not CDD for Polymesh.
 
-```bash
-npm run dev
-# or
-yarn dev
-```
+You need some setup before using it.
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+1. Enter your `keys.json` following the model found in `keys.json.sample`.
 
-## Modify it
+## `/`
 
-You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+In this simplified version, a customer is known by its id. You can use any id, even one from someone else. This security loophole is left open to simplify the system.
 
-[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+The customer information is split into 2 parts:
 
-The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+* The basic self-explanatory information: name, jurisdiction...
+* The Polymesh identification, only in `post-polymesh`
 
-## Learn More
+These 2 parts can be updated separately.
 
-To learn more about Next.js, take a look at the following resources:
+On this page, the customer can only see, not update, "EzKyc's decision" with regards to being "verified".
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+The server will automatically publish a claim if:
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+1. the customer is already verified by EzKyc.
+2. the customer submits a new or updated Polymesh did.
 
-## Deploy on Vercel
+## `/manager`
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+On this page, an EzKyc employee can:
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+* See, not modify, a customer's information
+* Accept or reject the information provided.
 
-## Further creation steps
+The server will automatically publish a claim if:
 
-```bash
-npm install --save-dev typescript @types/react @types/node
-touch tsconfig.json
-npm run dev
-```
+1. the customer has provided a Polymesh did.
+1. the EzKyc employee accepts the documents.

kyc_provider/keys.json.sample

@@ -0,0 +1,6 @@
+{
+    "accountMnemonic": "lock basic ...",
+    "rpcNetwork": "wss://testnet-rpc.polymesh.live",
+    "middlewareLink": "https://testnet-middleware.polymesh.live/testnet/graphql",
+    "middlewareKey": "0123456789abcdefghijklmnopqrstuvwxyzABCD"
+}

kyc_provider/next.config.js

@@ -1,9 +1,39 @@
+const keys = JSON.parse(require("fs").readFileSync("./keys.json").toString())
+
 module.exports = {
     serverRuntimeConfig: {
         // Will only be available on the server side
         kycDbPath: process.env.KYC_DB_PATH || "./dbStore/kycCustomers.db",
+        polymesh: {
+            accountMnemonic: process.env.POLY_ACCOUNT_MNEMONIC || keys["accountMnemonic"],
+            middlewareLink: process.env.MIDDLEWARE_LINK || keys["middlewareLink"],
+            middlewareKey: process.env.MIDDLEWARE_KEY || keys["middlewareKey"]
+        }
     },
     publicRuntimeConfig: {
         // Will be available on both server and client
+        appName: "ezKyc",
+        polymesh: {
+            nodeUrl: process.env.POLY_NODE_URL
+                || keys["rpcNetwork"]
+                || "wss://testnet-rpc.polymesh.live",
+            // TODO choose where the middleware info goes. Server only or public (i.e. shared)?
+            middlewareLink: process.env.MIDDLEWARE_LINK || keys["middlewareLink"],
+            middlewareKey: process.env.MIDDLEWARE_KEY || keys["middlewareKey"],
+        }
     },
-}
+    webpack: (config, { buildId, dev, isServer, defaultLoaders, webpack }) => {
+        // Note: we provide webpack above so you should not `require` it
+        // Perform customizations to webpack config
+        // config.plugins.push(new webpack.IgnorePlugin(/\/__tests__\//))
+
+        config.module.rules.push({
+            test: /\.mjs$/,
+            include: /node_modules/,
+            type: 'javascript/auto',
+        })
+
+        // Important: return the modified config
+        return config
+    },
+}