Merge branch 'blank_slate'

tig-foundation · May 21, 2024 · 55a6a41 · 55a6a41
2 parents c70db37 + b6c0524
commit 55a6a41
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git a/docs/guides/innovating.md b/docs/guides/innovating.md
@@ -1,5 +1,17 @@
 # Getting Started with Innovating
 
+## Developer Environment
+
+TIG compiles all algorithms into WASM for sandboxing and for verifiable execution.
+
+TIG currently requires all algorithms to be written in [Rust](https://www.rust-lang.org/tools/install).
+
+We recommend developing using [Visual Studio Code](https://code.visualstudio.com/) with Rust plugins:
+* rust-analyzer
+* Even Better TOML
+* crates
+* CodeLLDB
+
 ## Setting up Private Fork
 
 Innovators will want to create a private fork so that they can test that their algorithm can be successfully compiled into WASM by the CI.
@@ -131,4 +143,6 @@ git push origin <challenge_name>/<algorithm_name>
 
 ## Making Your Submission
 
+**IMPORTANT:** Submissions are final and cannot be modified after they are made. Please make a private fork of this repo and ensure the CI can compile your algorithm.
+
 You will need to burn 0.001 ETH to make a submission. Visit https://play.tig.foundation/innovator and follow the instructions.
diff --git a/tig-api/README.md b/tig-api/README.md
@@ -4,6 +4,10 @@ A Rust crate for making requests to TIG's API.
 
 Developers must either enable feature `request` (uses `reqwest`) or `request-js` (uses `web-sys`) 
 
+## API Url
+* Mainnet https://api.tig.foundation/play
+* Testnet https://api.tig.foundation/test
+
 ## GET Endpoints
 
 * `get-algorithms`

diff --git a/tig-benchmarker/README.md b/tig-benchmarker/README.md
@@ -14,6 +14,26 @@ wasm-pack build --release --target web
 python3 -m http.server 80
 ```
 
+See `tig-api` [README](../tig-api/README.md) for API Urls.
+
+# Finding your API Key
+
+## Mainnet
+
+1. Navigate to https://play.tig.foundation/
+2. Connect your wallet
+3. Run the following command in the console: `JSON.parse(Cookies.get("account"))`
+    * `address` is your Mainnet `player_id`
+    * `api_key` is your Mainnet API key
+
+## Testnet
+
+1. Navigate to https://test.tig.foundation/
+2. Connect your wallet
+3. Run the following command in the console: `JSON.parse(Cookies.get("account"))`
+    * `address` is your Testnet `player_id`
+    * `api_key` is your Testnet API key
+
 # License
 
 [End User License Agreement](../docs/agreements/end_user_license_agreement.pdf)
diff --git a/tig-worker/README.md b/tig-worker/README.md
@@ -17,13 +17,17 @@ Performance testing is done in a sandboxed WASM Virtual Machine.
     export ALGORITHM=<algorithm_name>
     ```
 3. Pick a difficulty & create `settings.json`:
+    * [Difficulty for Satisfiability](../tig-challenges/src/satisfiability.rs#L12). Recommend `[50, 300]` for initial tests
+    * [Difficulty for Vehicle Routing](../tig-challenges/src/vehicle_routing.rs#L7). Recommend `[40, 250]` for initial tests
+    * [Difficulty for Knapsack](../tig-challenges/src/knapsack.rs#L8). Recommend `[50, 10]` for initial tests
+
     ```
     {
         "block_id": "",
         "algorithm_id": "",
         "challenge_id": "",
         "player_id": "",
-        "difficulty": [50, 300]
+        "difficulty": <your difficulty>
     }
     ```
 4. Test the algorithm: