feat(platform): keyword search system contract (#2523)

Co-authored-by: Quantum Explorer <[email protected]>

Author: pauldelucia

.github/workflows/tests-rs-package.yml

@@ -195,7 +195,7 @@ jobs:
         uses: ./.github/actions/librocksdb
 
       - name: Run tests
-        run: cargo test --package=${{ inputs.package }} --all-features --locked
+        run: RUST_MIN_STACK=16777216 cargo test --package=${{ inputs.package }} --all-features --locked
         env:
           SCCACHE_S3_KEY_PREFIX: ${{ runner.os }}/sccache/${{ runner.arch }}/linux-gnu
           ROCKSDB_STATIC: "/opt/rocksdb/usr/local/lib/librocksdb.a"

Cargo.lock

@@ -29,7 +29,8 @@ members = [
     "packages/rs-json-schema-compatibility-validator",
     "packages/check-features",
     "packages/wallet-utils-contract",
-    "packages/token-history-contract"
+    "packages/token-history-contract",
+    "packages/keyword-search-contract"
 ]
 
 exclude = ["packages/wasm-sdk"] # This one is experimental and not ready for use

Cargo.toml

@@ -68,25 +68,25 @@ FROM node:20-alpine${ALPINE_VERSION} AS deps-base
 # Install some dependencies
 #
 RUN apk add --no-cache \
-        alpine-sdk \
-        bash \
-        binutils \
-        ca-certificates \
-        clang-static clang-dev \
-        cmake \
-        curl \
-        git \
-        libc-dev \
-        linux-headers \
-        llvm-static llvm-dev  \
-        openssl-dev \
-        snappy-static snappy-dev \
-        perl \
-        python3 \
-        unzip \
-        wget \
-        xz \
-        zeromq-dev
+    alpine-sdk \
+    bash \
+    binutils \
+    ca-certificates \
+    clang-static clang-dev \
+    cmake \
+    curl \
+    git \
+    libc-dev \
+    linux-headers \
+    llvm-static llvm-dev  \
+    openssl-dev \
+    snappy-static snappy-dev \
+    perl \
+    python3 \
+    unzip \
+    wget \
+    xz \
+    zeromq-dev
 
 # Configure snappy, dependency of librocksdb-sys
 RUN <<EOS
@@ -109,10 +109,10 @@ WORKDIR /platform
 COPY rust-toolchain.toml .
 RUN TOOLCHAIN_VERSION="$(grep channel rust-toolchain.toml | awk '{print $3}' | tr -d '"')" && \
     curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- \
-        --profile minimal \
-        -y \
-        --default-toolchain "${TOOLCHAIN_VERSION}" \
-        --target wasm32-unknown-unknown
+    --profile minimal \
+    -y \
+    --default-toolchain "${TOOLCHAIN_VERSION}" \
+    --target wasm32-unknown-unknown
 
 ONBUILD ENV HOME=/root
 ONBUILD ENV CARGO_HOME=$HOME/.cargo
@@ -145,7 +145,7 @@ EOS
 ARG PROTOC_VERSION=27.3
 RUN if [[ "$TARGETARCH" == "arm64" ]] ; then export PROTOC_ARCH=aarch_64; else export PROTOC_ARCH=x86_64; fi; \
     curl -Ls https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-linux-${PROTOC_ARCH}.zip \
-        -o /tmp/protoc.zip && \
+    -o /tmp/protoc.zip && \
     unzip -qd /opt/protoc /tmp/protoc.zip && \
     rm /tmp/protoc.zip && \
     ln -s /opt/protoc/bin/protoc /usr/bin/
@@ -180,9 +180,9 @@ ARG SCCHACHE_VERSION=0.8.2
 # Install sccache for caching
 RUN if [[ "$TARGETARCH" == "arm64" ]] ; then export SCC_ARCH=aarch64; else export SCC_ARCH=x86_64; fi; \
     curl -Ls \
-        https://github.com/mozilla/sccache/releases/download/v$SCCHACHE_VERSION/sccache-v$SCCHACHE_VERSION-${SCC_ARCH}-unknown-linux-musl.tar.gz | \
-        tar -C /tmp -xz && \
-        mv /tmp/sccache-*/sccache /usr/bin/
+    https://github.com/mozilla/sccache/releases/download/v$SCCHACHE_VERSION/sccache-v$SCCHACHE_VERSION-${SCC_ARCH}-unknown-linux-musl.tar.gz | \
+    tar -C /tmp -xz && \
+    mv /tmp/sccache-*/sccache /usr/bin/
 
 #
 # Configure sccache
@@ -327,11 +327,11 @@ RUN --mount=type=secret,id=AWS \
     set -ex; \
     source /root/env; \
     if [ "$TARGETARCH" = "amd64" ]; then \
-        CARGO_BINSTALL_ARCH="x86_64-unknown-linux-musl"; \
+    CARGO_BINSTALL_ARCH="x86_64-unknown-linux-musl"; \
     elif [ "$TARGETARCH" = "arm64" ]; then \
-        CARGO_BINSTALL_ARCH="aarch64-unknown-linux-musl"; \
+    CARGO_BINSTALL_ARCH="aarch64-unknown-linux-musl"; \
     else \
-        echo "Unsupported architecture: $TARGETARCH"; exit 1; \
+    echo "Unsupported architecture: $TARGETARCH"; exit 1; \
     fi; \
     # Construct download URL
     DOWNLOAD_URL="https://github.com/cargo-bins/cargo-binstall/releases/download/v${BINSTALL_VERSION}/cargo-binstall-${CARGO_BINSTALL_ARCH}.tgz"; \
@@ -380,6 +380,7 @@ COPY --parents \
     packages/dpns-contract \
     packages/wallet-utils-contract \
     packages/token-history-contract \
+    packages/keyword-search-contract \
     packages/data-contracts \
     packages/strategy-tests \
     packages/simple-signer \
@@ -421,19 +422,19 @@ RUN --mount=type=cache,sharing=shared,id=cargo_registry_index,target=${CARGO_HOM
     set -ex; \
     source /root/env && \
     if  [[ "${CARGO_BUILD_PROFILE}" == "release" ]] ; then \
-        mv .cargo/config-release.toml .cargo/config.toml; \
+    mv .cargo/config-release.toml .cargo/config.toml; \
     else \
-        export FEATURES_FLAG="--features=console,grovedbg"; \
+    export FEATURES_FLAG="--features=console,grovedbg"; \
     fi && \
     if [ "${SDK_TEST_DATA}" == "true" ]; then \
-        mv .cargo/config-test-sdk-data.toml .cargo/config.toml; \
+    mv .cargo/config-test-sdk-data.toml .cargo/config.toml; \
     fi && \
     cargo chef cook \
-        --recipe-path recipe.json \
-        --profile "$CARGO_BUILD_PROFILE" \
-        --package drive-abci \
-        ${FEATURES_FLAG} \
-        --locked && \
+    --recipe-path recipe.json \
+    --profile "$CARGO_BUILD_PROFILE" \
+    --package drive-abci \
+    ${FEATURES_FLAG} \
+    --locked && \
     if [[ -x /usr/bin/sccache ]]; then sccache --show-stats; fi
 
 COPY --parents \
@@ -455,6 +456,7 @@ COPY --parents \
     packages/dashpay-contract \
     packages/wallet-utils-contract \
     packages/token-history-contract \
+    packages/keyword-search-contract \
     packages/withdrawals-contract \
     packages/masternode-reward-shares-contract \
     packages/feature-flags-contract \
@@ -483,22 +485,22 @@ RUN --mount=type=cache,sharing=shared,id=cargo_registry_index,target=${CARGO_HOM
     set -ex; \
     source /root/env && \
     if  [[ "${CARGO_BUILD_PROFILE}" == "release" ]] ; then \
-        mv .cargo/config-release.toml .cargo/config.toml; \
-        export OUT_DIRECTORY=release; \
+    mv .cargo/config-release.toml .cargo/config.toml; \
+    export OUT_DIRECTORY=release; \
     else \
-        export FEATURES_FLAG="--features=console,grovedbg"; \
-        export OUT_DIRECTORY=debug; \
+    export FEATURES_FLAG="--features=console,grovedbg"; \
+    export OUT_DIRECTORY=debug; \
     fi && \
     if [ "${SDK_TEST_DATA}" == "true" ]; then \
-        mv .cargo/config-test-sdk-data.toml .cargo/config.toml; \
+    mv .cargo/config-test-sdk-data.toml .cargo/config.toml; \
     fi && \
     # Workaround: as we cache dapi-grpc, its build.rs is not rerun, so we need to touch it
     echo "// $(date) " >> /platform/packages/dapi-grpc/build.rs && \
     cargo build \
-        --profile "${CARGO_BUILD_PROFILE}" \
-        --package drive-abci \
-        ${FEATURES_FLAG} \
-        --locked && \
+    --profile "${CARGO_BUILD_PROFILE}" \
+    --package drive-abci \
+    ${FEATURES_FLAG} \
+    --locked && \
     cp target/${OUT_DIRECTORY}/drive-abci /artifacts/ && \
     if [[ -x /usr/bin/sccache ]]; then sccache --show-stats; fi && \
     # Remove /platform to reduce layer size
@@ -523,11 +525,11 @@ RUN --mount=type=cache,sharing=shared,id=cargo_registry_index,target=${CARGO_HOM
     source /root/env && \
     unset CFLAGS CXXFLAGS && \
     cargo chef cook \
-        --recipe-path recipe.json \
-        --profile "$CARGO_BUILD_PROFILE" \
-        --package wasm-dpp \
-        --target wasm32-unknown-unknown \
-        --locked && \
+    --recipe-path recipe.json \
+    --profile "$CARGO_BUILD_PROFILE" \
+    --package wasm-dpp \
+    --target wasm32-unknown-unknown \
+    --locked && \
     if [[ -x /usr/bin/sccache ]]; then sccache --show-stats; fi
 
 
@@ -551,6 +553,7 @@ COPY --parents \
     packages/withdrawals-contract \
     packages/wallet-utils-contract \
     packages/token-history-contract \
+    packages/keyword-search-contract \
     packages/masternode-reward-shares-contract \
     packages/feature-flags-contract \
     packages/dpns-contract \
@@ -674,6 +677,7 @@ COPY --from=build-dashmate-helper /platform/packages/dapi-grpc packages/dapi-grp
 COPY --from=build-dashmate-helper /platform/packages/dash-spv packages/dash-spv
 COPY --from=build-dashmate-helper /platform/packages/wallet-utils-contract packages/wallet-utils-contract
 COPY --from=build-dashmate-helper /platform/packages/token-history-contract packages/token-history-contract
+COPY --from=build-dashmate-helper /platform/packages/keyword-search-contract packages/keyword-search-contract
 COPY --from=build-dashmate-helper /platform/packages/withdrawals-contract packages/withdrawals-contract
 COPY --from=build-dashmate-helper /platform/packages/masternode-reward-shares-contract packages/masternode-reward-shares-contract
 COPY --from=build-dashmate-helper /platform/packages/feature-flags-contract packages/feature-flags-contract
@@ -750,6 +754,7 @@ COPY --from=build-dapi /platform/packages/dapi-grpc /platform/packages/dapi-grpc
 COPY --from=build-dapi /platform/packages/js-grpc-common /platform/packages/js-grpc-common
 COPY --from=build-dapi /platform/packages/wasm-dpp /platform/packages/wasm-dpp
 COPY --from=build-dapi /platform/packages/token-history-contract /platform/packages/token-history-contract
+COPY --from=build-dapi /platform/packages/keyword-search-contract /platform/packages/keyword-search-contract
 
 RUN cp /platform/packages/dapi/.env.example /platform/packages/dapi/.env
 

Dockerfile

@@ -67,7 +67,8 @@
     "packages/dash-spv",
     "packages/wasm-dpp",
     "packages/withdrawals-contract",
-    "packages/token-history-contract"
+    "packages/token-history-contract",
+    "packages/search-contract"
   ],
   "resolutions": {
     "elliptic": "6.5.7",

package.json

@@ -18,3 +18,4 @@ feature-flags-contract = { path = "../feature-flags-contract" }
 platform-value = { path = "../rs-platform-value" }
 wallet-utils-contract = { path = "../wallet-utils-contract" }
 token-history-contract = { path = "../token-history-contract" }
+keyword-search-contract = { path = "../keyword-search-contract" }

packages/data-contracts/Cargo.toml

@@ -136,3 +136,20 @@ impl From<token_history_contract::Error> for Error {
         }
     }
 }
+
+impl From<keyword_search_contract::Error> for Error {
+    fn from(e: keyword_search_contract::Error) -> Self {
+        match e {
+            keyword_search_contract::Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            } => Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            },
+            keyword_search_contract::Error::InvalidSchemaJson(e) => Error::InvalidSchemaJson(e),
+        }
+    }
+}

packages/data-contracts/src/error.rs

@@ -6,6 +6,7 @@ use crate::error::Error;
 pub use dashpay_contract;
 pub use dpns_contract;
 pub use feature_flags_contract;
+pub use keyword_search_contract;
 pub use masternode_reward_shares_contract;
 use platform_value::Identifier;
 use platform_version::version::PlatformVersion;
@@ -23,6 +24,7 @@ pub enum SystemDataContract {
     Dashpay = 4,
     WalletUtils = 5,
     TokenHistory = 6,
+    KeywordSearch = 7,
 }
 
 pub struct DataContractSource {
@@ -43,6 +45,7 @@ impl SystemDataContract {
             SystemDataContract::Dashpay => dashpay_contract::ID_BYTES,
             SystemDataContract::WalletUtils => wallet_utils_contract::ID_BYTES,
             SystemDataContract::TokenHistory => token_history_contract::ID_BYTES,
+            SystemDataContract::KeywordSearch => keyword_search_contract::ID_BYTES,
         };
         Identifier::new(bytes)
     }
@@ -98,10 +101,19 @@ impl SystemDataContract {
             SystemDataContract::TokenHistory => DataContractSource {
                 id_bytes: token_history_contract::ID_BYTES,
                 owner_id_bytes: token_history_contract::OWNER_ID_BYTES,
-                version: platform_version.system_data_contracts.wallet as u32,
+                version: platform_version.system_data_contracts.token_history as u32,
                 definitions: token_history_contract::load_definitions(platform_version)?,
                 document_schemas: token_history_contract::load_documents_schemas(platform_version)?,
             },
+            SystemDataContract::KeywordSearch => DataContractSource {
+                id_bytes: keyword_search_contract::ID_BYTES,
+                owner_id_bytes: keyword_search_contract::OWNER_ID_BYTES,
+                version: platform_version.system_data_contracts.keyword_search as u32,
+                definitions: keyword_search_contract::load_definitions(platform_version)?,
+                document_schemas: keyword_search_contract::load_documents_schemas(
+                    platform_version,
+                )?,
+            },
         };
 
         Ok(data)