From 2e159f95d120532d712cddf45ce5835af0101272 Mon Sep 17 00:00:00 2001 From: Lachlan Glen <54282009+lachlanglen@users.noreply.github.com> Date: Tue, 4 Jun 2024 10:47:38 -0400 Subject: [PATCH] Testnet (#28) * add deploy-testnet.yml * add testnet deployment workflow & appspec * testnet workflow debugging * upload appspec as artifact * upload zipped codebase to s3 in workflow * continue working on after_install_testnet * separate watchtower log groups by django env * add testnet potlock TLA to indexer handler * add POTLOCK_TLA to settings * add dev.potlock.io and test-dev.potlock.io to allowed hosts * remove admin dashboard edit access * remove admin edit permission for all models * add timestamp to deployment zip filename * add env vars to deploy-testnet * add after_install_dev script * add after_install debug logs * handle testnet potfactory & pot contract patterns * test throttle rate * update throttling to 100/minute * update readme with API urls --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e04c4f7..fc89206 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ - [Steps to run:](#steps-to-run) - [Env vars example](#env-vars-example) - [API Basics](#api-basics) - - [Base URL](#base-url) - - [Authorization](#authorization) - - [Error Responses](#error-responses) - - [Pagination](#pagination) + - [Base URL](#base-url) + - [Authorization](#authorization) + - [Error Responses](#error-responses) + - [Pagination](#pagination) - [API Endpoints](#api-endpoints) - [`Account` endpoints](#account-endpoints) - [✅ Get all accounts: `GET /accounts` (paginated)](#-get-all-accounts-get-accounts-paginated) @@ -52,6 +52,7 @@ - If for some reason this doesn't kill any active celery tasks, run `ps auxww | grep 'celery' | grep -v grep` and kill resulting PIDs Extra commands that might come in useful: + - Purge celery queue (`celery -A base purge`) ### Env vars example @@ -77,13 +78,14 @@ export PL_SENTRY_DSN= #### Base URL -`/api/v1/` +**dev (mainnet):** `https://dev.potlock.io/api/v1/` +**testnet:** `https://test-dev.potlock.io/api/v1/` #### Authorization This is a public, read-only API and as such does not currently implement authentication or authorization. -Rate limits of (FILL THIS IN) are enforced to ensure service for all users. +Rate limits of 100 requests/min are enforced to ensure service for all users. #### Error Responses