coosld/tig-monorepo
1
0
Fork 0
mirror of https://github.com/tig-foundation/tig-monorepo.git synced 2026-02-21 10:27:49 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update api endpoints in docs.

Browse Source
This commit is contained in:
FiveMovesAhead 2024-06-08 00:43:25 +10:00
parent 83f519e529
commit fffad88307
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/innovating.md
View File

@ -130,8 +130,8 @@ language governing permissions and limitations under the License.
**IMPORTANT (READ THIS):**
* Not all challenge instances have solutions. Algorithms that can detect such cases and exit early (`return Ok(None)`) will potentially have better performance than algorithms that don't exit early
* You can find the current qualifying difficulties by:
* Query https://api.tig.foundation/play/get-block for <block_id>
* Query https://api.tig.foundation/play/get-challenges?block_id=<block_id> for <qualifier_difficulties>
* Query https://mainnet-api.tig.foundation/get-block for <block_id>
* Query https://mainnet-api.tig.foundation/get-challenges?block_id=<block_id> for <qualifier_difficulties>
* If you are copying and modifying an algorithm that has been submitted to TIG, make sure to use the `innovator_outbound` version
* Do not include tests in your algorithm file. TIG will reject your algorithm submission.
* Only your algorithm's rust code gets submitted. You should not be modifying `Cargo.toml` in `tig-algorithms`. Any extra dependencies you add will not be available when TIG compiles your algorithm

4
swagger.yaml
View File

@ -15,8 +15,8 @@ info:
url: https://github.com/tig-foundation/tig-monorepo/blob/main/docs/agreements/end_user_license_agreement.pdf
version: 1.0.0
servers:
- url: https://api.tig.foundation/play
- url: https://api.tig.foundation/test
- url: https://mainnet-api.tig.foundation
- url: https://testnet-api.tig.foundation
paths:
/get-algorithms:
get:

4
tig-api/README.md
View File

@ -5,8 +5,8 @@ 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
* Mainnet https://mainnet-api.tig.foundation
* Testnet https://testnet-api.tig.foundation
## API Documentation

4
tig-worker/README.md
View File

@ -38,8 +38,8 @@ Performance testing is done in a sandboxed WASM Virtual Machine.
Notes:
* You can query the latest difficulty ranges via TIG's API:
```
query https://api.tig.foundation/play/get-block for <block_id>
query https://api.tig.foundation/play/get-challenges?block_id=<block_id> for qualifier_difficulties
query https://mainnet-api.tig.foundation/get-block for <block_id>
query https://mainnet-api.tig.foundation/get-challenges?block_id=<block_id> for qualifier_difficulties
```
# License