feat(platform)!: token marketplace escrow trees and token market contract (PV15)

.codecov.yml

@@ -56,6 +56,7 @@ ignore:
   - "packages/app-connect-contract/src/**"
   - "packages/moderation-charters-contract/src/**"
   - "packages/decision-proposals-contract/src/**"
+  - "packages/token-market-contract/src/**"
   - "packages/masternode-reward-shares-contract/src/**"
   - "packages/token-history-contract/src/**"
   - "packages/wallet-utils-contract/src/**"

.github/package-filters/js-packages-direct.yml

@@ -19,6 +19,9 @@
 '@dashevo/decision-proposals-contract':
   - packages/decision-proposals-contract/**
 
+'@dashevo/token-market-contract':
+  - packages/token-market-contract/**
+
 '@dashevo/dashpay-contract':
   - packages/dashpay-contract/**
 

.github/package-filters/js-packages-no-workflows.yml

@@ -19,6 +19,9 @@
 '@dashevo/decision-proposals-contract': &decision-proposals-contract
   - packages/decision-proposals-contract/**
 
+'@dashevo/token-market-contract': &token-market-contract
+  - packages/token-market-contract/**
+
 '@dashevo/dashpay-contract': &dashpay-contract
   - packages/dashpay-contract/**
 
@@ -47,6 +50,7 @@
   - *app-connect-contract
   - *moderation-charters-contract
   - *decision-proposals-contract
+  - *token-market-contract
   - packages/rs-platform-serialization/**
   - packages/rs-platform-serialization-derive/**
   - packages/rs-platform-value/**

.github/package-filters/js-packages.yml

@@ -26,6 +26,10 @@
   - .github/workflows/tests*
   - packages/decision-proposals-contract/**
 
+'@dashevo/token-market-contract': &token-market-contract
+  - .github/workflows/tests*
+  - packages/token-market-contract/**
+
 '@dashevo/dashpay-contract': &dashpay-contract
   - .github/workflows/tests*
   - packages/dashpay-contract/**
@@ -60,6 +64,7 @@
   - *app-connect-contract
   - *moderation-charters-contract
   - *decision-proposals-contract
+  - *token-market-contract
   - packages/rs-platform-serialization/**
   - packages/rs-platform-serialization-derive/**
   - packages/rs-platform-value/**

.github/package-filters/rs-packages-direct.yml

@@ -33,6 +33,11 @@ decision-proposals-contract:
   - packages/decision-proposals-contract/schema/**
   - packages/decision-proposals-contract/Cargo.toml
 
+token-market-contract:
+  - packages/token-market-contract/src/**
+  - packages/token-market-contract/schema/**
+  - packages/token-market-contract/Cargo.toml
+
 dashpay-contract:
   - packages/dashpay-contract/src/**
   - packages/dashpay-contract/schema/**

.github/package-filters/rs-packages-no-workflows.yml

@@ -33,6 +33,11 @@ decision-proposals-contract: &decision-proposals-contract
   - packages/decision-proposals-contract/schema/**
   - packages/decision-proposals-contract/Cargo.toml
 
+token-market-contract: &token-market-contract
+  - packages/token-market-contract/src/**
+  - packages/token-market-contract/schema/**
+  - packages/token-market-contract/Cargo.toml
+
 dashpay-contract: &dashpay-contract
   - packages/dashpay-contract/src/**
   - packages/dashpay-contract/schema/**
@@ -69,6 +74,7 @@ data-contracts: &data-contracts
   - *app-connect-contract
   - *moderation-charters-contract
   - *decision-proposals-contract
+  - *token-market-contract
 
 dpp: &dpp
   - packages/rs-dpp/**

.github/package-filters/rs-packages.yml

@@ -40,6 +40,12 @@ decision-proposals-contract: &decision-proposals-contract
   - packages/decision-proposals-contract/schema/**
   - packages/decision-proposals-contract/Cargo.toml
 
+token-market-contract: &token-market-contract
+  - .github/workflows/tests*
+  - packages/token-market-contract/src/**
+  - packages/token-market-contract/schema/**
+  - packages/token-market-contract/Cargo.toml
+
 dashpay-contract: &dashpay-contract
   - .github/workflows/tests*
   - packages/dashpay-contract/src/**
@@ -82,6 +88,7 @@ data-contracts: &data-contracts
   - *app-connect-contract
   - *moderation-charters-contract
   - *decision-proposals-contract
+  - *token-market-contract
 
 dpp: &dpp
   - .github/workflows/tests*

.github/package-filters/test-suite-triggers.yml

@@ -33,6 +33,7 @@ run:
   - packages/app-connect-contract/**
   - packages/moderation-charters-contract/**
   - packages/decision-proposals-contract/**
+  - packages/token-market-contract/**
   - packages/wallet-utils-contract/**
   # Local network scripts and action
   - .github/actions/local-network/**

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

@@ -507,6 +507,7 @@ jobs:
             --package app-connect-contract \
             --package moderation-charters-contract \
             --package decision-proposals-contract \
+            --package token-market-contract \
             --all-features \
             --locked \
             -E '(not test(~shield) or (package(=platform-wallet-storage) and not test(~wallet::shielded::))) and (not binary_id(=drive-abci::strategy_tests) or test(~comprehensive_mixed_operations) or test(~process_proposal_collision))'

.github/workflows/tests.yml

@@ -353,6 +353,7 @@ jobs:
               - packages/app-connect-contract/**
               - packages/moderation-charters-contract/**
               - packages/decision-proposals-contract/**
+              - packages/token-market-contract/**
               - packages/dapi-grpc/**
               - packages/dashpay-contract/**
               - packages/data-contracts/**

Cargo.toml

@@ -41,6 +41,7 @@ members = [
     "packages/app-connect-contract",
     "packages/moderation-charters-contract",
     "packages/decision-proposals-contract",
+    "packages/token-market-contract",
     "packages/rs-sdk-ffi",
     "packages/rs-sdk-cxx",
     "packages/wasm-drive-verify",

Dockerfile

@@ -216,7 +216,7 @@
 ARG SCCACHE_BUCKET
 ARG AWS_PROFILE
 ARG SCCACHE_REGION
 ARG SCCACHE_S3_KEY_PREFIX
 ARG SCCACHE_ENDPOINT
 
 # Generate sccache configuration variables and save them to /root/env
@@ -409,6 +409,7 @@
     packages/app-connect-contract \
     packages/moderation-charters-contract \
     packages/decision-proposals-contract \
+    packages/token-market-contract \
     packages/data-contracts \
     packages/strategy-tests \
     packages/simple-signer \
@@ -536,6 +537,7 @@
     packages/app-connect-contract \
     packages/moderation-charters-contract \
     packages/decision-proposals-contract \
+    packages/token-market-contract \
     packages/withdrawals-contract \
     packages/masternode-reward-shares-contract \
     packages/dpns-contract \
@@ -724,6 +726,7 @@
     packages/app-connect-contract \
     packages/moderation-charters-contract \
     packages/decision-proposals-contract \
+    packages/token-market-contract \
     packages/masternode-reward-shares-contract \
     packages/dpns-contract \
     packages/data-contracts \
@@ -872,6 +875,7 @@
 COPY --from=build-dashmate-helper /platform/packages/app-connect-contract packages/app-connect-contract
 COPY --from=build-dashmate-helper /platform/packages/moderation-charters-contract packages/moderation-charters-contract
 COPY --from=build-dashmate-helper /platform/packages/decision-proposals-contract packages/decision-proposals-contract
+COPY --from=build-dashmate-helper /platform/packages/token-market-contract packages/token-market-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/dpns-contract packages/dpns-contract
@@ -978,6 +982,7 @@
     packages/app-connect-contract \
     packages/moderation-charters-contract \
     packages/decision-proposals-contract \
+    packages/token-market-contract \
     packages/withdrawals-contract \
     packages/masternode-reward-shares-contract \
     packages/dpns-contract \

book/src/architecture/overview.md

@@ -199,12 +199,12 @@ Several smaller crates provide cross-cutting infrastructure:
 
 The versioning backbone. Defines `PlatformVersion`, `ProtocolVersion`, and the
 version tables for every consensus-critical method across DPP, Drive, and
-Drive-ABCI. Currently tracks 14 protocol versions (v1 through v14).
+Drive-ABCI. Currently tracks 15 protocol versions (v1 through v15).
 
 ```rust
 // From packages/rs-platform-version/src/version/mod.rs
 pub type ProtocolVersion = u32;
-pub const LATEST_VERSION: ProtocolVersion = PROTOCOL_VERSION_14;
+pub const LATEST_VERSION: ProtocolVersion = PROTOCOL_VERSION_15;
 pub const INITIAL_PROTOCOL_VERSION: ProtocolVersion = 1;
 ```
 
@@ -281,7 +281,7 @@ Here is a simplified view of every Rust workspace member, grouped by role:
 | **gRPC definitions** | `dapi-grpc` |
 | **WASM bindings** | `wasm-dpp`, `wasm-dpp2`, `wasm-sdk`, `wasm-drive-verify` |
 | **iOS/FFI** | `rs-sdk-ffi` |
-| **System contracts** | `dpns-contract`, `dashpay-contract`, `withdrawals-contract`, `masternode-reward-shares-contract`, `wallet-utils-contract`, `token-history-contract`, `keyword-search-contract`, `document-history-contract`, `app-connect-contract`, `moderation-charters-contract`, `decision-proposals-contract`, `data-contracts` |
+| **System contracts** | `dpns-contract`, `dashpay-contract`, `withdrawals-contract`, `masternode-reward-shares-contract`, `wallet-utils-contract`, `token-history-contract`, `keyword-search-contract`, `document-history-contract`, `app-connect-contract`, `moderation-charters-contract`, `decision-proposals-contract`, `token-market-contract`, `data-contracts` |
 | **Tooling** | `dashmate` (JS), `strategy-tests`, `simple-signer`, `check-features`, `json-schema-compatibility-validator` |
 | **Other** | `dash-platform-macros`, `rs-dash-event-bus`, `rs-platform-wallet`, `dash-platform-balance-checker`, `rs-dapi` |
 

book/src/data-model/token-marketplace.md

@@ -49,3 +49,44 @@ created tradeable becomes tradeable only if its issuer kept the right to change
 A non-transferable token cannot be tradeable because filling a listing or an offer moves the token
 from the seller to the buyer, which is the transfer the token refuses. `transferable` is fixed
 when the token is created, so the trade mode is the only half of the rule an update can change.
+
+## Where orders and escrow live
+
+Open orders are documents of the token market system contract
+(`AE6yYq65VdfGCg2MSyV9vV7cWGiFWjbwBuy7THesDh4e`), registered at genesis from protocol version 15
+and inserted by the upgrade to 15. It has two document types, `ask` (a listing) and `bid` (an
+offer), each with three indexes:
+
+| Index | Properties | Serves |
+|---|---|---|
+| `book` | `tokenId`, `decimals`, `price`, `$createdAt` | A token's order book, by price and then by age |
+| `depth` | `tokenId`, `decimals`, `price`, summed | The total open at each price, or over a price range, in one proven sum query: the base units of the asks (`remaining`) and the credits of the bids (`escrow`) |
+| `byOwner` | `$ownerId`, `tokenId`, `$createdAt` | An identity's open orders |
+
+Each side sums what it holds in escrow, so the sums cannot overflow: the tokens listed never exceed
+the token's supply, and the credits offered never exceed the credits on Platform. Every integer of
+an order is a signed 8-byte value, so a partial fill rewrites an order without changing its stored
+size.
+
+An order's price is in credits per whole token, and each order records the token's decimals when
+it was placed (`decimals`). Every fill prices the order at that scale, so a later change to the
+token's decimals (a `Conventions` update) changes neither what an open listing costs nor what an
+open offer pays. The `book` and `depth` indexes keep each scale apart (`tokenId`, then `decimals`,
+then `price`), so a book query and a depth sum name the token's decimals and never mix prices of
+different scales. After a token changes its decimals, the orders placed before the change stay
+under the old decimals until they close; a client showing them alongside the new ones queries both
+and scales each by its `decimals`.
+
+Only the marketplace transitions write orders. A document transition cannot create one
+(`creationRestrictionMode` 2), and a replace or a delete of one is refused by a data trigger. The
+types stay mutable and deletable so the documents carry a revision and storage flags: the order's
+owner pays its storage and gets it back when the order closes.
+
+What an order holds is kept outside the contract:
+
+- The tokens of a listing sit in `[Tokens, TOKEN_ORDER_ESCROW_KEY]`, a BigSumTree with one SumTree
+  per token, keyed by order id. The token conservation check counts it beside the identity
+  balances and the shielded pools.
+- The credits of an offer sit in `[PreFundedSpecializedBalances, PREFUNDED_BALANCES_FOR_TOKEN_ORDERS]`,
+  a SumTree keyed by order id, which the credit conservation check already counts.
+

package.json

@@ -18,6 +18,7 @@
     "test:app-connect-contract": "ultra -r --filter \"packages/@(app-connect-contract|js-dash-sdk|js-drive|js-dapi-client|wasm-dpp|wallet-lib|dapi|platform-test-suite)\" test",
     "test:moderation-charters-contract": "ultra -r --filter \"packages/@(moderation-charters-contract|js-dash-sdk|js-drive|js-dapi-client|wasm-dpp|wallet-lib|dapi|platform-test-suite)\" test",
     "test:decision-proposals-contract": "ultra -r --filter \"packages/@(decision-proposals-contract|js-dash-sdk|js-drive|js-dapi-client|wasm-dpp|wallet-lib|dapi|platform-test-suite)\" test",
+    "test:token-market-contract": "ultra -r --filter \"packages/@(token-market-contract|js-dash-sdk|js-drive|js-dapi-client|wasm-dpp|wallet-lib|dapi|platform-test-suite)\" test",
     "test:dapi-client": "ultra -r --filter \"packages/@(js-dapi-client|wallet-lib|js-dash-sdk|platform-test-suite)\" test",
     "test:sdk": "ultra -r --filter \"packages/@(js-dash-sdk|platform-test-suite)\" test",
     "test:spv": "ultra -r --filter \"packages/@(dash-spv|js-dapi-client)\" test",
@@ -83,6 +84,7 @@
     "packages/app-connect-contract",
     "packages/moderation-charters-contract",
     "packages/decision-proposals-contract",
+    "packages/token-market-contract",
     "packages/wasm-drive-verify",
     "packages/wasm-sdk",
     "packages/js-evo-sdk"

packages/data-contracts/Cargo.toml

@@ -21,6 +21,7 @@ all-contracts = [
     "app-connect",
     "moderation-charters",
     "decision-proposals",
+    "token-market",
 ]
 
 # Individual contract features
@@ -35,6 +36,7 @@ document-history = ["dep:document-history-contract"]
 app-connect = ["dep:app-connect-contract"]
 moderation-charters = ["dep:moderation-charters-contract"]
 decision-proposals = ["dep:decision-proposals-contract"]
+token-market = ["dep:token-market-contract"]
 
 [dependencies]
 thiserror = "2.0.12"
@@ -52,6 +54,7 @@ document-history-contract = { path = "../document-history-contract", optional =
 app-connect-contract = { path = "../app-connect-contract", optional = true }
 moderation-charters-contract = { path = "../moderation-charters-contract", optional = true }
 decision-proposals-contract = { path = "../decision-proposals-contract", optional = true }
+token-market-contract = { path = "../token-market-contract", optional = true }
 
 [dev-dependencies]
 base58 = "0.2.0"

packages/data-contracts/src/error.rs

@@ -221,3 +221,21 @@ impl From<decision_proposals_contract::Error> for Error {
         }
     }
 }
+
+#[cfg(feature = "token-market")]
+impl From<token_market_contract::Error> for Error {
+    fn from(e: token_market_contract::Error) -> Self {
+        match e {
+            token_market_contract::Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            } => Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            },
+            token_market_contract::Error::InvalidSchemaJson(e) => Error::InvalidSchemaJson(e),
+        }
+    }
+}