Merge pull request #96 from beehive-innovation/2021-09-10-npm-package

npm package & remove submodule dependency

Author: marcusnewton

.github/workflows/deploy-docs.yaml

@@ -15,7 +15,6 @@ jobs:
         uses: actions/checkout@v2
         with:
           ref: develop
-          submodules: "recursive"
 
       - name: Install nix
         uses: cachix/install-nix-action@v13

.github/workflows/publish-npm.yaml

@@ -0,0 +1,28 @@
+name: Publish npm package
+
+on:
+  create:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+*"]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.ACCESS_TOKEN }}
+
+      - name: Install nix
+        uses: cachix/install-nix-action@v13
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+      - name: Prepack for npm
+        run: nix-shell --run prepack
+
+      - name: Publish to npm
+        run: nix-shell --run publish

.gitignore

@@ -11,3 +11,5 @@ bin
 !dist/**/artifacts
 docs/api
 bin
+*.tgz
+.npmrc

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "contracts/configurable-rights-pool"]
-	path = contracts/configurable-rights-pool
-	url = git@github.com:balancer-labs/configurable-rights-pool.git

README.md

@@ -2,20 +2,44 @@
 
 Rain Protocol supports fair value capture for intangible or physical assets in a permissionless way in any decentralised environment.
 
-Documentation can be found [here](https://beehive-innovation.github.io/rain-protocol).
+## Installation
+
+```console
+npm install rain-protocol
+```
 
-## Development setup (contributors)
+## Usage
 
-### Git submodules
+### Importing contracts
 
-As we are wrapping balancer contracts, we have git submodules pointing to their repositories.
+```solidity
+pragma solidity ^0.6.12;
+
+import "rain-protocol/contracts/ReadWriteTier.sol";
+
+contract MyContract is ReadWriteTier {
+  ...
+}
+```
 
-When you clone this repository make sure to use `--recurse-submodules`
+### Importing contract [artifact](https://hardhat.org/guides/compile-contracts.html#artifacts) (e.g. abi, bytecode)
 
+```typescript
+const trustJson = require("rain-protocol/artifacts/Trust.json");
 ```
-git clone --recurse-submodules git@github.com:thedavidmeister/tv-balancer.git
+
+### Using with [TypeChain](https://github.com/dethcrypto/TypeChain)
+
+```typescript
+import type { Trust } from "rain-protocol/typechain/Trust";
 ```
 
+## Documentation
+
+Documentation can be found [here](https://beehive-innovation.github.io/rain-protocol).
+
+## Development setup (for contributors)
+
 ### Nix Shell
 
 Install the nix shell if you haven't already.

contracts/RedeemableERC20Pool.sol

@@ -9,23 +9,23 @@ import { Math } from "@openzeppelin/contracts/math/Math.sol";
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
 
-import { IBPool } from "./configurable-rights-pool/contracts/IBFactory.sol";
-import { BPool } from "./configurable-rights-pool/contracts/test/BPool.sol";
+import { IBPool } from "configurable-rights-pool/contracts/IBFactory.sol";
+import { BPool } from "configurable-rights-pool/contracts/test/BPool.sol";
 import {
     RightsManager
-} from "./configurable-rights-pool/libraries/RightsManager.sol";
+} from "configurable-rights-pool/libraries/RightsManager.sol";
 import {
     BalancerConstants
-} from "./configurable-rights-pool/libraries/BalancerConstants.sol";
+} from "configurable-rights-pool/libraries/BalancerConstants.sol";
 import {
     ConfigurableRightsPool
-} from "./configurable-rights-pool/contracts/ConfigurableRightsPool.sol";
+} from "configurable-rights-pool/contracts/ConfigurableRightsPool.sol";
 import {
     CRPFactory
-} from "./configurable-rights-pool/contracts/CRPFactory.sol";
+} from "configurable-rights-pool/contracts/CRPFactory.sol";
 import {
     BFactory
-} from "./configurable-rights-pool/contracts/test/BFactory.sol";
+} from "configurable-rights-pool/contracts/test/BFactory.sol";
 
 import { Phase, Phased } from "./Phased.sol";
 import { RedeemableERC20 } from "./RedeemableERC20.sol";

contracts/RedeemableERC20PoolFactory.sol

@@ -10,10 +10,10 @@ import {
 } from "./RedeemableERC20Pool.sol";
 import {
     CRPFactory
-} from "./configurable-rights-pool/contracts/CRPFactory.sol";
+} from "configurable-rights-pool/contracts/CRPFactory.sol";
 import {
     BFactory
-} from "./configurable-rights-pool/contracts/test/BFactory.sol";
+} from "configurable-rights-pool/contracts/test/BFactory.sol";
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import { RedeemableERC20 } from "./RedeemableERC20.sol";
 

contracts/Trust.sol

@@ -15,10 +15,10 @@ import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
 
 import {
     CRPFactory
-} from "./configurable-rights-pool/contracts/CRPFactory.sol";
+} from "configurable-rights-pool/contracts/CRPFactory.sol";
 import {
     BFactory
-} from "./configurable-rights-pool/contracts/test/BFactory.sol";
+} from "configurable-rights-pool/contracts/test/BFactory.sol";
 
 import { ITier } from "./tier/ITier.sol";