feat: make Jupiter API configurable via ENV vars (#1283)

Co-authored-by: Auston Bunsen <[email protected]> Co-authored-by: Auston Bunsen <[email protected]> Co-authored-by: Kirill Bubochkin <[email protected]>
espresso-cash · Mar 1, 2024 · 10cacfc · 10cacfc
1 parent 9500baa
commit 10cacfc
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/packages/jupiter_aggregator/README.md b/packages/jupiter_aggregator/README.md
@@ -25,13 +25,14 @@ start using the package.
 
 ## Usage
 
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder. 
+Define environmental variables when launching the app with flags on the command line. For example:
 
-```dart
-const like = 'sample';
+```bash
+flutter run lib/main.dart --dart-define=QUOTE_API_BASE=https://public.jupiterapi.com
 ```
 
+You can get Swap API urls from [Jupiter Station](https://station.jup.ag/docs/apis/swap-api), [QuickNode](https://marketplace.quicknode.com/add-on/metis-jupiter-v6-swap-api) or [JupiterAPI.com](https://www.jupiterapi.com/).
+
 ## Additional information
 
 TODO: Tell users more about the package: where to find more information, how to 

diff --git a/packages/jupiter_aggregator/lib/src/client.dart b/packages/jupiter_aggregator/lib/src/client.dart
@@ -7,7 +7,12 @@ import 'package:retrofit/retrofit.dart';
 part 'client.g.dart';
 
 /// For docs head to https://station.jup.ag/api-v6
-@RestApi(baseUrl: 'https://quote-api.jup.ag/v6')
+@RestApi(
+  baseUrl: String.fromEnvironment(
+    'QUOTE_API_BASE',
+    defaultValue: 'https://quote-api.jup.ag/v6',
+  ),
+)
 abstract class JupiterAggregatorClient {
   factory JupiterAggregatorClient() => _JupiterAggregatorClient(Dio());
 

diff --git a/packages/jupiter_aggregator/lib/src/client.g.dart b/packages/jupiter_aggregator/lib/src/client.g.dart