Merge pull request #67 from application-research/docker-cont

feat: added car generation cli and car docs

Author: Alvin Reyes

CONTRIBUTING.md

@@ -1,127 +1,26 @@
 # Δ Delta
-Filecoin Storage Deal Making Service
-
-*Delta is in active development and is not ready for production use.*
-
-![image](https://user-images.githubusercontent.com/4479171/226853191-e19e8fa4-abc1-4652-970f-d3d6cea0df13.png)
-
-
-For more information, check out the [docs](docs)
-
-# Build and Run Delta
-
-## Prepare to `build`
-Copy the `.env.example` file to `.env` and update the values as needed.
-
-```
-# Node info
-NODE_NAME=stg-deal-maker
-NODE_DESCRIPTION=Experimental Deal Maker
-NODE_TYPE=delta-main
-
-# Database configuration
-MODE=standalone
-DB_DSN=delta.db
-#REPO=/mnt/.whypfs # shared mounted repo
-
-# Frequencies
-MAX_CLEANUP_WORKERS=1500
-```
-
-Running this the first time will generate a wallet. Make sure to get FIL/DataCap from the [faucet](https://verify.glif.io/) and fund the wallet
-
-## Install and run `Delta` using `docker`
-Make sure you have docker installed on your machine.
-
-### Run the current delta clone using docker-compose
-If you already have a wallet with datacap, you can pass it to the command below. This copies over the wallet directory to the containerized app and sets it as the default wallet.
-```
-make docker-compose-run WALLET_DIR=<walletdir>
-```
-
-**Check localhost**
-
-You can check the localhost to see if the delta app is running
-```
-curl --location --request GET 'http://localhost:1414/open/node/info'
-```
-
-**Next**
-
-Now that you can access a live Delta node, you are now ready to make a deal. You can now go to the following guides:
-
-- [Make an e2e deal](docs/make-e2e-deal.md)
-- [Make an import deal](docs/make-import-deal.md)
-
-
-### Run a specific docker image tag from the docker hub artifactory
-We have a few pre-built images on the docker hub artifactory. You can run the following command to run a specific image tag 
-```
-cd docker
-./run.sh <TAG> 
-```
-Note: no tag means it'll just get the latest image.
-
-## Install, build from source and run `Delta`
-### Install the following pre-req
-- go 1.18
-- [jq](https://stedolan.github.io/jq/)
-- [hwloc](https://www.open-mpi.org/projects/hwloc/)
-- opencl
-- [rustup](https://rustup.rs/)
-- postgresql
-
-Alternatively, if using Ubuntu, you can run the following commands to install the pre-reqs
-```
-apt-get update && \
-apt-get install -y wget jq hwloc ocl-icd-opencl-dev git libhwloc-dev pkg-config make && \
-apt-get install -y cargo
-```
-
-### Using `make` 
-```
-make all
-./delta daemon --repo=.whypfs --wallet-dir=<walletdir>
-```
-
-### Using `go build`
-```
-go build -tags netgo -ldflags '-s -w' -o delta
-./delta daemon --repo=.whypfs --wallet-dir=<walletdir>
-```
-
-## Run `Delta`
-```
-./delta daemon --mode=standalone
-```
-
-## Test the API server
-Try the following endpoints to test the API server
-```
-curl --location --request GET 'http://localhost:1414/open/node/info'
-curl --location --request GET 'http://localhost:1414/open/node/peers'
-curl --location --request GET 'http://localhost:1414/open/node/host'
-```
-
-If it return the following, then the API server is working
-```
-{"name":"stg-deal-maker","description":"Experimental Deal Maker","type":"delta-main"}
-```
-
-
-# Getting Started with `Delta`
-- To get started on running delta, go to the [getting started to run delta](docs/getting-started-run-delta.md)
-- To get started on using a live delta instance, go to the [getting started to use delta](docs/getting-started-use-delta.md)
-- To learn more about running delta using docker, go to the [run delta using docker](docs/running-delta-docker.md)
-- To learn more about deployment modes, go to the [deployment modes](docs/deployment-modes.md)
-- To get estuary api key, go to the [estuary api keys](docs/getting-estuary-api-key.md)
-- To manage wallets, go to the [managing wallets](docs/manage-wallets.md)
-- To make an end-to-end deal, go to the [make e2e deals](docs/make-e2e-deal.md)
-- To make an import deal, go to the [make import deals](docs/make-import-deal.md)
-- To learn how to repair a deal, go to the [repairing and retrying deals](docs/repair.md)
-- To learn how to access the open statistics and information, go to the [open statistics and information](docs/open-stats-info.md)
-- To learn about the content lifecycle and check status of the deals, go to the [content lifecycle and deal status](docs/content-deal-status.md)
-- To use Delta cli to manage deals, go to the [delta cli](docs/cli.md)
-
-## Author
-Protocol Labs Outercore Engineering.
+Generic DealMaking MicroService using whypfs + filclient + estuary_auth
+
+![image](https://user-images.githubusercontent.com/4479171/218267752-9a7af133-4e36-4f4c-95da-16b3c7bd73ae.png)
+
+## Features
+- Make e2e / online and import / offline storage deals.
+- Compute piece_commitments using variety of methods
+  - boost piece commitment computation
+  - parallel piece commitment computation
+  - filclient piece commitment computation
+- Assign deals to specific miners
+- Assign deals to specific wallets
+- Shows all the deals made for specific user
+- Extensive status information about the deals made
+- Support for multiple wallets
+- Lightweight. Uses a light ipfs node `whypfs-core` to stage the files.
+- Cleans up itself after a deal is made.
+- Monitors deal progress
+- Monitors transfer progress
+- Containerized deployment
+
+## Getting Started
+To get started, go to our docs [here](docs).
+# Author
+Protocol Labs Outercore Engineering.