document new stats param.

sava-software · Oct 7, 2024 · 35df62c · 35df62c
1 parent bc8d21a
commit 35df62c
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 16 deletions.
diff --git a/solana/README.md b/solana/README.md
@@ -6,6 +6,17 @@
 
 Attempts to find one or more tables to help minimize the size of a transaction.
 
+#### `/v0/alt/discover/*`
+
+* **query**:
+    * **accountsOnly**:
+        * `true`: An array of base58 encoded lookup table public keys will be returned.
+        * `false`: (default) An array of objects including both the table public key and the base64 encoded program
+          account will be returned.
+    * **stats**:
+        * `true`: Include stats comparing the input tx and the resulting versioned tx, as well as stats per table used.
+        * `false`: (default)
+
 #### POST `/v0/alt/discover/tx/raw`
 
 Post a serialized and encoded, legacy or v0, transaction.
@@ -19,11 +30,6 @@ curl -H "X-BYTE-ENCODING: base64" -d 'AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
     * **X-BYTE-ENCODING**: Encoding of the posted transaction.
         * `hex`
         * `base64`: default
-* **query**:
-    * **accountsOnly**:
-        * `true`: An array of base58 encoded lookup table public keys will be returned.
-        * `false`: (default) An array of objects including both the table public key and the base64 encoded program
-          account will be returned.
 * **body**: serialized and encoded transaction.
 
 #### POST `/v0/alt/discover/accounts`
@@ -38,11 +44,6 @@ curl -d '["8UJgxaiQx5nTrdDgph5FiahMmzduuLTLf5WmsPegYA6W","2UZMvVTBQR9yWxrEdzEQzX
   'http://localhost:4242/v0/alt/discover/accounts?accountsOnly=true';
 ```
 
-* **query**:
-    * **accountsOnly**:
-        * `true`: An array of base58 encoded lookup table public keys will be returned.
-        * `false`: (default) An array of objects including both the table public key and the base64 encoded program
-          account will be returned.
 * **body**: JSON array of base58 encoded accounts.
 
 ## Service Configuration

diff --git a/...nts/lookup/http/OptimalTablesHandler.java → ...ts/lookup/http/DiscoverTablesHandler.java b/...nts/lookup/http/OptimalTablesHandler.java → ...ts/lookup/http/DiscoverTablesHandler.java
@@ -6,13 +6,13 @@
 import software.sava.services.solana.accounts.lookup.LookupTableDiscoveryService;
 
 import static java.lang.System.Logger.Level.INFO;
-import static software.sava.services.solana.accounts.lookup.http.OptimalTablesHandler.QueryParams.NONE;
+import static software.sava.services.solana.accounts.lookup.http.DiscoverTablesHandler.QueryParams.NONE;
 
-abstract class OptimalTablesHandler extends LookupTableDiscoveryServiceHandler {
+abstract class DiscoverTablesHandler extends LookupTableDiscoveryServiceHandler {
 
-  private static final System.Logger logger = System.getLogger(OptimalTablesHandler.class.getName());
+  private static final System.Logger logger = System.getLogger(DiscoverTablesHandler.class.getName());
 
-  OptimalTablesHandler(final LookupTableDiscoveryService tableService, final LookupTableCache tableCache) {
+  DiscoverTablesHandler(final LookupTableDiscoveryService tableService, final LookupTableCache tableCache) {
     super(tableService, tableCache);
   }
 

diff --git a/...src/main/java/software/sava/services/solana/accounts/lookup/http/FromAccountsHandler.java b/...src/main/java/software/sava/services/solana/accounts/lookup/http/FromAccountsHandler.java
@@ -10,7 +10,7 @@
 
 import java.util.HashSet;
 
-final class FromAccountsHandler extends OptimalTablesHandler {
+final class FromAccountsHandler extends DiscoverTablesHandler {
 
   FromAccountsHandler(final LookupTableDiscoveryService tableService,
                       final LookupTableCache tableCache) {

diff --git a/...na/src/main/java/software/sava/services/solana/accounts/lookup/http/FromRawTxHandler.java b/...na/src/main/java/software/sava/services/solana/accounts/lookup/http/FromRawTxHandler.java
@@ -14,7 +14,7 @@
 import java.util.*;
 import java.util.stream.Collectors;
 
-class FromRawTxHandler extends OptimalTablesHandler {
+class FromRawTxHandler extends DiscoverTablesHandler {
 
   private static final System.Logger logger = System.getLogger(FromRawTxHandler.class.getName());