Merge branch 'helius-labs:main' into triton

rpcpool · Jan 3, 2025 · bd0fd33 · bd0fd33
2 parents 0a536c7 + df690fd
commit bd0fd33
Show file tree

Hide file tree

Showing 28 changed files with 42 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Photon: the Indexer for ZK Compression on Solana
 
-Photon is the core indexer for [ZK Compression](zkcompression.com) on the Solana blockchain. It offers rapid indexing capabilities, snapshot support, and flexible database options to cater to local and production deployments.
+Photon is the core indexer for [ZK Compression](https://www.zkcompression.com) on the Solana blockchain. It offers rapid indexing capabilities, snapshot support, and flexible database options to cater to local and production deployments.
 
 ## 🚀 Quick Start
 

diff --git a/src/api/api.rs b/src/api/api.rs
@@ -5,6 +5,7 @@ use solana_client::nonblocking::rpc_client::RpcClient;
 use utoipa::openapi::{ObjectBuilder, RefOr, Schema, SchemaType};
 use utoipa::ToSchema;
 
+use crate::api::method::get_validity_proof::GetValidityProofRequestDocumentation;
 use crate::api::method::utils::GetNonPaginatedSignaturesResponse;
 use crate::common::typedefs::unsigned_integer::UnsignedInteger;
 
@@ -382,7 +383,7 @@ impl PhotonApi {
             },
             OpenApiSpec {
                 name: "getValidityProof".to_string(),
-                request: Some(GetValidityProofRequest::schema().1),
+                request: Some(GetValidityProofRequestDocumentation::schema().1),
                 response: GetValidityProofResponse::schema().1,
             },
             OpenApiSpec {

diff --git a/src/api/method/get_validity_proof.rs b/src/api/method/get_validity_proof.rs
@@ -252,11 +252,23 @@ pub struct GetValidityProofRequest {
     #[serde(default)]
     pub hashes: Vec<Hash>,
     #[serde(default)]
+    #[schema(deprecated = true)]
     pub newAddresses: Vec<SerializablePubkey>,
     #[serde(default)]
     pub newAddressesWithTrees: Vec<AddressWithTree>,
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, ToSchema)]
+#[serde(deny_unknown_fields, rename_all = "camelCase")]
+#[allow(non_snake_case)]
+// Create to hide the deprecated newAddresses field from the documentation
+pub struct GetValidityProofRequestDocumentation {
+    #[serde(default)]
+    pub hashes: Vec<Hash>,
+    #[serde(default)]
+    pub newAddressesWithTrees: Vec<AddressWithTree>,
+}
+
 #[derive(Serialize, Deserialize, ToSchema)]
 #[serde(deny_unknown_fields, rename_all = "camelCase")]
 pub struct GetValidityProofResponse {
@@ -273,12 +285,12 @@ pub async fn get_validity_proof(
         && request.newAddresses.is_empty()
         && request.newAddressesWithTrees.is_empty()
     {
-        return Err(PhotonApiError::UnexpectedError(
+        return Err(PhotonApiError::ValidationError(
             "No hashes or new addresses provided for proof generation".to_string(),
         ));
     }
     if !request.newAddressesWithTrees.is_empty() && !request.newAddresses.is_empty() {
-        return Err(PhotonApiError::UnexpectedError(
+        return Err(PhotonApiError::ValidationError(
             "Cannot provide both newAddresses and newAddressesWithTree".to_string(),
         ));
     }

diff --git a/src/openapi/specs/getCompressedAccount.yaml b/src/openapi/specs/getCompressedAccount.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedAccountBalance.yaml b/src/openapi/specs/getCompressedAccountBalance.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedAccountProof.yaml b/src/openapi/specs/getCompressedAccountProof.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedAccountsByOwner.yaml b/src/openapi/specs/getCompressedAccountsByOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedBalanceByOwner.yaml b/src/openapi/specs/getCompressedBalanceByOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedMintTokenHolders.yaml b/src/openapi/specs/getCompressedMintTokenHolders.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedTokenAccountBalance.yaml b/src/openapi/specs/getCompressedTokenAccountBalance.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedTokenAccountsByDelegate.yaml b/src/openapi/specs/getCompressedTokenAccountsByDelegate.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedTokenAccountsByOwner.yaml b/src/openapi/specs/getCompressedTokenAccountsByOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedTokenBalancesByOwner.yaml b/src/openapi/specs/getCompressedTokenBalancesByOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressedTokenBalancesByOwnerV2.yaml b/src/openapi/specs/getCompressedTokenBalancesByOwnerV2.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressionSignaturesForAccount.yaml b/src/openapi/specs/getCompressionSignaturesForAccount.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressionSignaturesForAddress.yaml b/src/openapi/specs/getCompressionSignaturesForAddress.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressionSignaturesForOwner.yaml b/src/openapi/specs/getCompressionSignaturesForOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getCompressionSignaturesForTokenOwner.yaml b/src/openapi/specs/getCompressionSignaturesForTokenOwner.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getIndexerHealth.yaml b/src/openapi/specs/getIndexerHealth.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getIndexerSlot.yaml b/src/openapi/specs/getIndexerSlot.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getLatestCompressionSignatures.yaml b/src/openapi/specs/getLatestCompressionSignatures.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getLatestNonVotingSignatures.yaml b/src/openapi/specs/getLatestNonVotingSignatures.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getMultipleCompressedAccountProofs.yaml b/src/openapi/specs/getMultipleCompressedAccountProofs.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getMultipleCompressedAccounts.yaml b/src/openapi/specs/getMultipleCompressedAccounts.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getMultipleNewAddressProofs.yaml b/src/openapi/specs/getMultipleNewAddressProofs.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getMultipleNewAddressProofsV2.yaml b/src/openapi/specs/getMultipleNewAddressProofsV2.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getTransactionWithCompressionInfo.yaml b/src/openapi/specs/getTransactionWithCompressionInfo.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:

diff --git a/src/openapi/specs/getValidityProof.yaml b/src/openapi/specs/getValidityProof.yaml
@@ -4,7 +4,7 @@ info:
   description: Solana indexer for general compression
   license:
     name: Apache-2.0
-  version: 0.49.0
+  version: 0.50.0
 servers:
 - url: https://mainnet.helius-rpc.com?api-key=<api_key>
 paths:
@@ -44,10 +44,6 @@ paths:
                       type: array
                       items:
                         $ref: '#/components/schemas/Hash'
-                    newAddresses:
-                      type: array
-                      items:
-                        $ref: '#/components/schemas/SerializablePubkey'
                     newAddressesWithTrees:
                       type: array
                       items: