Merge branch 'master' of https://github.com/atpar/ap-monorepo

atpar · Dec 18, 2019 · 23a1579 · 23a1579
2 parents 7ff85a6 + 6fce7ac
commit 23a1579
Show file tree

Hide file tree

Showing 58 changed files with 18,353 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,7 +4,6 @@ artifacts/
 Database.json
 Orderbook-Database.json
 Channel-Database.json
-packages/ap.js/docs
 
 mnemonic.js
 

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ Monorepo containing all packages related to the ACTUS Protocol.
 
 ## Packages
 
-| Package                                                                                 | Version                                                                                                                                           | Description                                                                |
-|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
-|[`ap-contracts`](https://github.com/atpar/ap-monorepo/tree/master/packages/ap-contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@atpar/ap-contracts)](https://www.npmjs.com/package/@atpar/ap-contracts "View this project on npm") | Contains the ACTUS Protocol smart contracts                                |
-|[`ap.js`](https://github.com/atpar/ap-monorepo/tree/master/packages/ap.js)               | [![npm (scoped)](https://img.shields.io/npm/v/@atpar/ap.js)](https://www.npmjs.com/package/@atpar/ap.js "View this project on npm")               | Typescript library for interacting with the ACTUS Protocol smart contracts |
+| Package                                                                                 | Version                                                                                                                                           | Coverage                                                                                                                                                 | Description                                                                |
+|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|
+|[`ap-contracts`](https://github.com/atpar/ap-monorepo/tree/master/packages/ap-contracts) | [![npm (scoped)](https://img.shields.io/npm/v/@atpar/ap-contracts)](https://www.npmjs.com/package/@atpar/ap-contracts "View this project on npm") | [![Coverage Status](https://coveralls.io/repos/github/atpar/ap-monorepo/badge.svg?branch=MS1)](https://coveralls.io/github/atpar/ap-monorepo?branch=MS1) | Contains the ACTUS Protocol smart contracts                                |
+|[`ap.js`](https://github.com/atpar/ap-monorepo/tree/master/packages/ap.js)               | [![npm (scoped)](https://img.shields.io/npm/v/@atpar/ap.js)](https://www.npmjs.com/package/@atpar/ap.js "View this project on npm")               |                                                                                                                                                          | Typescript library for interacting with the ACTUS Protocol smart contracts |
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetActor.md b/packages/ap-contracts/docs/contracts/Core/AssetActor.md
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetRegistry/AssetRegistry.md b/packages/ap-contracts/docs/contracts/Core/AssetRegistry/AssetRegistry.md
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetRegistry/AssetRegistryStorage.md b/packages/ap-contracts/docs/contracts/Core/AssetRegistry/AssetRegistryStorage.md
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetRegistry/Economics.md b/packages/ap-contracts/docs/contracts/Core/AssetRegistry/Economics.md
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetRegistry/IAssetRegistry.md b/packages/ap-contracts/docs/contracts/Core/AssetRegistry/IAssetRegistry.md
diff --git a/packages/ap-contracts/docs/contracts/Core/AssetRegistry/Ownership.md b/packages/ap-contracts/docs/contracts/Core/AssetRegistry/Ownership.md
diff --git a/packages/ap-contracts/docs/contracts/Core/IAssetActor.md b/packages/ap-contracts/docs/contracts/Core/IAssetActor.md
diff --git a/.../ap-contracts/docs/contracts/Core/MarketObjectRegistry/IMarketObjectRegistry.md b/.../ap-contracts/docs/contracts/Core/MarketObjectRegistry/IMarketObjectRegistry.md
diff --git a/...s/ap-contracts/docs/contracts/Core/MarketObjectRegistry/MarketObjectRegistry.md b/...s/ap-contracts/docs/contracts/Core/MarketObjectRegistry/MarketObjectRegistry.md
diff --git a/...ntracts/docs/contracts/Core/MarketObjectRegistry/MarketObjectRegistryStorage.md b/...ntracts/docs/contracts/Core/MarketObjectRegistry/MarketObjectRegistryStorage.md
diff --git a/packages/ap-contracts/docs/contracts/Core/ProductRegistry/IProductRegistry.md b/packages/ap-contracts/docs/contracts/Core/ProductRegistry/IProductRegistry.md
diff --git a/packages/ap-contracts/docs/contracts/Core/ProductRegistry/ProductRegistry.md b/packages/ap-contracts/docs/contracts/Core/ProductRegistry/ProductRegistry.md
diff --git a/...ages/ap-contracts/docs/contracts/Core/ProductRegistry/ProductRegistryStorage.md b/...ages/ap-contracts/docs/contracts/Core/ProductRegistry/ProductRegistryStorage.md
diff --git a/packages/ap-contracts/docs/contracts/Core/SharedTypes.md b/packages/ap-contracts/docs/contracts/Core/SharedTypes.md
diff --git a/packages/ap-contracts/docs/contracts/Issuance/AssetIssuer.md b/packages/ap-contracts/docs/contracts/Issuance/AssetIssuer.md
diff --git a/packages/ap-contracts/docs/contracts/Issuance/Custodian.md b/packages/ap-contracts/docs/contracts/Issuance/Custodian.md
diff --git a/packages/ap-contracts/docs/contracts/Issuance/IAssetIssuer.md b/packages/ap-contracts/docs/contracts/Issuance/IAssetIssuer.md
diff --git a/packages/ap-contracts/docs/contracts/Issuance/ICustodian.md b/packages/ap-contracts/docs/contracts/Issuance/ICustodian.md
diff --git a/packages/ap-contracts/docs/contracts/Issuance/VerifyOrder.md b/packages/ap-contracts/docs/contracts/Issuance/VerifyOrder.md
diff --git a/packages/ap-contracts/docs/contracts/Migrations.md b/packages/ap-contracts/docs/contracts/Migrations.md
diff --git a/packages/ap-contracts/docs/contracts/Tokenization/TokenizationFactory.md b/packages/ap-contracts/docs/contracts/Tokenization/TokenizationFactory.md
diff --git a/packages/ap-contracts/docs/contracts/external/Dependencies.md b/packages/ap-contracts/docs/contracts/external/Dependencies.md
diff --git a/packages/ap-contracts/package.json b/packages/ap-contracts/package.json
@@ -31,6 +31,7 @@
     "compile": "truffle compile",
     "coverage": "truffle run coverage",
     "generate-artifacts": "rm -rf ./artifacts && ./scripts/truffle-minimize.sh ./build/contracts ./artifacts",
+    "generate-docs": "./scripts/generate-docs.sh",
     "generate-ts-bindings": "typechain --target web3-v1 --outDir ./ts-bindings './build/contracts/*.json'",
     "lint": "solium -d contracts/",
     "lint:fix": "solium -d contracts/ --fix",

diff --git a/packages/ap-contracts/scripts/generate-docs.sh b/packages/ap-contracts/scripts/generate-docs.sh
@@ -0,0 +1 @@
+solidity-docgen -i ./ -o docs --contract-pages --exclude="test,node_modules,migrations,docs,scripts,ts-bindings,build,artifacts" --solc-settings "{remappings: ['openzeppelin-solidity/=node_modules/openzeppelin-solidity/','actus-solidity/=node_modules/actus-solidity/','funds-distribution-token/=node_modules/funds-distribution-token/','truffle/=node_modules/truffle/build/']}"