@dashevo/dapi-grpc 3.0.1 → 3.1.0-dev.3

package/CHANGELOG.md

@@ -167,5 +167,3 @@
 * add more methods to Core service ([41f3ad0](https://github.com/dashevo/dapi-grpc/commit/41f3ad0ad6aee3acf4b1760949cde36d8df7d6f2))
 * fetchIdentity endpoint ([75d32d8](https://github.com/dashevo/dapi-grpc/commit/75d32d883be4d7a113fe34f1d008e1d9bcc3c7e1))
 * introduce Platform service ([c88b891](https://github.com/dashevo/dapi-grpc/commit/c88b891ecfac8987cd76c773b2f783ad7a155540))
-
-

package/Cargo.toml

@@ -39,7 +39,7 @@ serde = ["dep:serde", "dep:serde_bytes", "tenderdash-proto/serde"]
 mocks = ["serde", "dep:serde_json"]
 
 [dependencies]
-tenderdash-proto = { git = "https://github.com/dashpay/rs-tenderdash-abci", tag = "v1.5.0-dev.2", default-features = false }
+tenderdash-proto = { git = "https://github.com/dashpay/rs-tenderdash-abci", tag = "v1.5.1", default-features = false }
 
 prost = { version = "0.14" }
 futures-core = "0.3.30"
@@ -83,6 +83,6 @@ ignored = [
   "platform-version",
   "futures-core",
   "tonic-prost-build",
-  "getrandom", # Ignore getrandom as we need it to enable `js` feature
+  "getrandom",            # Ignore getrandom as we need it to enable `js` feature
   "dash-platform-macros", # used in build.rs
 ]

package/README.md

@@ -140,4 +140,3 @@ Feel free to dive in! [Open an issue](https://github.com/dashpay/platform/issues
 ## License
 
 [MIT](LICENSE) © Dash Core Group, Inc.
-

package/build.rs

@@ -1,7 +1,8 @@
 use std::{
     collections::HashSet,
+    env,
     fs::{create_dir_all, remove_dir_all},
-    path::PathBuf,
+    path::{Path, PathBuf},
 };
 
 use tonic_prost_build::Builder;
@@ -13,23 +14,32 @@ const SERDE_WITH_STRING: &str =
     r#"#[cfg_attr(feature = "serde", serde(with = "crate::deserialization::from_to_string"))]"#;
 
 fn main() {
+    let output_base = resolve_output_base().unwrap_or_else(|e| {
+        eprintln!("[error] => resolve output base failed: {e}");
+        std::process::exit(1);
+    });
+    println!(
+        "cargo:rustc-env=DAPI_GRPC_OUT_DIR={}",
+        output_base.display()
+    );
+
     #[cfg(feature = "server")]
-    generate_code(ImplType::Server);
+    generate_code(ImplType::Server, &output_base);
     #[cfg(feature = "client")]
-    generate_code(ImplType::Client);
+    generate_code(ImplType::Client, &output_base);
 
     if std::env::var("CARGO_CFG_TARGET_ARCH")
         .unwrap_or_default()
         .eq("wasm32")
     {
-        generate_code(ImplType::Wasm);
+        generate_code(ImplType::Wasm, &output_base);
     }
 }
 
-fn generate_code(typ: ImplType) {
+fn generate_code(typ: ImplType, output_base: &Path) {
     let core = MappingConfig::new(
         PathBuf::from("protos/core/v0/core.proto"),
-        PathBuf::from("src/core"),
+        output_base.join("core"),
         &typ,
     );
 
@@ -39,7 +49,7 @@ fn generate_code(typ: ImplType) {
 
     let platform = MappingConfig::new(
         PathBuf::from("protos/platform/v0/platform.proto"),
-        PathBuf::from("src/platform"),
+        output_base.join("platform"),
         &typ,
     );
 
@@ -49,7 +59,7 @@ fn generate_code(typ: ImplType) {
 
     let drive = MappingConfig::new(
         PathBuf::from("protos/drive/v0/drive.proto"),
-        PathBuf::from("src/drive"),
+        output_base.join("drive"),
         &typ,
     );
 
@@ -60,6 +70,7 @@ fn generate_code(typ: ImplType) {
     println!("cargo:rerun-if-changed=./protos");
     println!("cargo:rerun-if-env-changed=CARGO_FEATURE_SERDE");
     println!("cargo:rerun-if-env-changed=CARGO_CFG_TARGET_ARCH");
+    println!("cargo:rerun-if-env-changed=DAPI_GRPC_OUT_DIR");
 }
 
 struct MappingConfig {
@@ -73,7 +84,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     // Derive features for versioned messages
     //
     // "GetConsensusParamsRequest" is excluded as this message does not support proofs
-    const VERSIONED_REQUESTS: [&str; 48] = [
+    const VERSIONED_REQUESTS: [&str; 56] = [
         "GetDataContractHistoryRequest",
         "GetDataContractRequest",
         "GetDataContractsRequest",
@@ -112,6 +123,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetTokenDirectPurchasePricesRequest",
         "GetTokenContractInfoRequest",
         "GetTokenStatusesRequest",
+        "GetTokenPreProgrammedDistributionsRequest",
         "GetTokenTotalSupplyRequest",
         "GetGroupInfoRequest",
         "GetGroupInfosRequest",
@@ -122,11 +134,24 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetAddressesInfosRequest",
         "GetRecentAddressBalanceChangesRequest",
         "GetRecentCompactedAddressBalanceChangesRequest",
+        "GetShieldedEncryptedNotesRequest",
+        "GetShieldedAnchorsRequest",
+        "GetMostRecentShieldedAnchorRequest",
+        "GetShieldedPoolStateRequest",
+        "GetShieldedNullifiersRequest",
+        "GetRecentNullifierChangesRequest",
+        "GetRecentCompactedNullifierChangesRequest",
     ];
 
-    const PROOF_ONLY_VERSIONED_REQUESTS: [&str; 1] = ["GetAddressesTrunkStateRequest"];
+    const PROOF_ONLY_VERSIONED_REQUESTS: [&str; 2] = [
+        "GetAddressesTrunkStateRequest",
+        "GetNullifiersTrunkStateRequest",
+    ];
 
-    const MERK_PROOF_VERSIONED_REQUESTS: [&str; 1] = ["GetAddressesBranchStateRequest"];
+    const MERK_PROOF_VERSIONED_REQUESTS: [&str; 2] = [
+        "GetAddressesBranchStateRequest",
+        "GetNullifiersBranchStateRequest",
+    ];
 
     // The following responses are excluded as they don't support proofs:
     // - "GetConsensusParamsResponse"
@@ -136,7 +161,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     // - "GetIdentityByNonUniquePublicKeyHashResponse"
     //
     //  "GetEvonodesProposedEpochBlocksResponse" is used for 2 Requests
-    const VERSIONED_RESPONSES: [&str; 46] = [
+    const VERSIONED_RESPONSES: [&str; 54] = [
         "GetDataContractHistoryResponse",
         "GetDataContractResponse",
         "GetDataContractsResponse",
@@ -173,6 +198,7 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetTokenDirectPurchasePricesResponse",
         "GetTokenContractInfoResponse",
         "GetTokenStatusesResponse",
+        "GetTokenPreProgrammedDistributionsResponse",
         "GetTokenTotalSupplyResponse",
         "GetGroupInfoResponse",
         "GetGroupInfosResponse",
@@ -183,11 +209,24 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         "GetAddressesInfosResponse",
         "GetRecentAddressBalanceChangesResponse",
         "GetRecentCompactedAddressBalanceChangesResponse",
+        "GetShieldedEncryptedNotesResponse",
+        "GetShieldedAnchorsResponse",
+        "GetMostRecentShieldedAnchorResponse",
+        "GetShieldedPoolStateResponse",
+        "GetShieldedNullifiersResponse",
+        "GetRecentNullifierChangesResponse",
+        "GetRecentCompactedNullifierChangesResponse",
     ];
 
-    const PROOF_ONLY_VERSIONED_RESPONSES: [&str; 1] = ["GetAddressesTrunkStateResponse"];
+    const PROOF_ONLY_VERSIONED_RESPONSES: [&str; 2] = [
+        "GetAddressesTrunkStateResponse",
+        "GetNullifiersTrunkStateResponse",
+    ];
 
-    const MERK_PROOF_VERSIONED_RESPONSES: [&str; 1] = ["GetAddressesBranchStateResponse"];
+    const MERK_PROOF_VERSIONED_RESPONSES: [&str; 2] = [
+        "GetAddressesBranchStateResponse",
+        "GetNullifiersBranchStateResponse",
+    ];
 
     check_unique(&VERSIONED_REQUESTS).expect("VERSIONED_REQUESTS");
     check_unique(&VERSIONED_RESPONSES).expect("VERSIONED_RESPONSES");
@@ -196,8 +235,24 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
     check_unique(&MERK_PROOF_VERSIONED_REQUESTS).expect("MERK_PROOF_VERSIONED_REQUESTS");
     check_unique(&MERK_PROOF_VERSIONED_RESPONSES).expect("MERK_PROOF_VERSIONED_RESPONSES");
 
+    // Messages whose latest version is v1 — the macro needs to know
+    // to generate match arms for both V0 and V1. Listed separately
+    // so the default `grpc_versions(0)` loop below skips them.
+    //
+    // Adding a message here is the proto-side companion of:
+    //   - Adding a `GetXxxRequestV1` / `GetXxxResponseV1` to the
+    //     oneof in `platform.proto`.
+    //   - Bumping the matching `FeatureVersionBounds.max_version`
+    //     to 1 in `rs-platform-version`.
+    //   - Implementing the v1 dispatch arm in `drive-abci`.
+    const VERSIONED_AT_V1_REQUESTS: [&str; 1] = ["GetDocumentsRequest"];
+    const VERSIONED_AT_V1_RESPONSES: [&str; 1] = ["GetDocumentsResponse"];
+
     // Derive VersionedGrpcMessage on requests
     for msg in VERSIONED_REQUESTS {
+        if VERSIONED_AT_V1_REQUESTS.contains(&msg) {
+            continue;
+        }
         platform = platform
             .message_attribute(
                 msg,
@@ -205,6 +260,14 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
             )
             .message_attribute(msg, r#"#[grpc_versions(0)]"#);
     }
+    for msg in VERSIONED_AT_V1_REQUESTS {
+        platform = platform
+            .message_attribute(
+                msg,
+                r#"#[derive(::dash_platform_macros::VersionedGrpcMessage)]"#,
+            )
+            .message_attribute(msg, r#"#[grpc_versions(1)]"#);
+    }
 
     // Derive ProofOnlyVersionedGrpcMessage on requests
     for msg in PROOF_ONLY_VERSIONED_REQUESTS {
@@ -218,6 +281,9 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
 
     // Derive VersionedGrpcMessage and VersionedGrpcResponse on responses
     for msg in VERSIONED_RESPONSES {
+        if VERSIONED_AT_V1_RESPONSES.contains(&msg) {
+            continue;
+        }
         platform = platform
             .message_attribute(
                 msg,
@@ -225,6 +291,14 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
             )
             .message_attribute(msg, r#"#[grpc_versions(0)]"#);
     }
+    for msg in VERSIONED_AT_V1_RESPONSES {
+        platform = platform
+            .message_attribute(
+                msg,
+                r#"#[derive(::dash_platform_macros::VersionedGrpcMessage,::dash_platform_macros::VersionedGrpcResponse)]"#,
+            )
+            .message_attribute(msg, r#"#[grpc_versions(1)]"#);
+    }
 
     // Derive VersionedGrpcMessage and ProofOnlyVersionedGrpcResponse on responses
     for msg in PROOF_ONLY_VERSIONED_RESPONSES {
@@ -277,10 +351,14 @@ fn configure_platform(mut platform: MappingConfig) -> MappingConfig {
         .field_attribute("start_at_ms", SERDE_WITH_STRING)
         .field_attribute("public_key_hash", SERDE_WITH_BYTES)
         .field_attribute("public_key_hashes", SERDE_WITH_BASE64)
+        .field_attribute("nullifiers", SERDE_WITH_BASE64)
         // Get documents fields
         .field_attribute("data_contract_id", SERDE_WITH_BYTES)
-        .field_attribute("where", SERDE_WITH_BYTES)
-        .field_attribute("order_by", SERDE_WITH_BYTES)
+        // V0 still ships CBOR for `where` / `order_by`; V1 ships
+        // typed `repeated WhereClause` / `repeated OrderClause`
+        // and doesn't need the `bytes`-shaped serde shim.
+        .field_attribute("GetDocumentsRequestV0.where", SERDE_WITH_BYTES)
+        .field_attribute("GetDocumentsRequestV0.order_by", SERDE_WITH_BYTES)
         // Proof fields
         .field_attribute("Proof.grovedb_proof", SERDE_WITH_BYTES)
         .field_attribute("Proof.quorum_hash", SERDE_WITH_BYTES)
@@ -462,3 +540,13 @@ fn abs_path(path: &PathBuf) -> PathBuf {
 
     PathBuf::from(env!("CARGO_MANIFEST_DIR")).join(path)
 }
+
+/// Resolve output base directory for generated files.
+fn resolve_output_base() -> Result<PathBuf, String> {
+    env::var("DAPI_GRPC_OUT_DIR")
+        .map(PathBuf::from)
+        .or_else(|_| env::var("OUT_DIR").map(|out_dir| PathBuf::from(out_dir).join("dapi_grpc")))
+        .map_err(|_| {
+            "OUT_DIR should be provided by Cargo; set DAPI_GRPC_OUT_DIR to override it".to_string()
+        })
+}