diff --git a/docs/explanations/tokens.md b/docs/explanations/tokens.md index 451a39f2a..cf3581590 100644 --- a/docs/explanations/tokens.md +++ b/docs/explanations/tokens.md @@ -35,8 +35,11 @@ The initial token implementation includes all actions required to create, use, a | [Burn](#burn) | Burns (destroys) a specified amount of tokens | | [Freeze / Thaw](#freeze-and-thaw) | Freezes/thaws a specific entity's tokens | | [Destroy frozen funds](#destroy-frozen) | Destroys frozen funds for a specified entity | +| [Claim](#claim) | Redeems or withdraws tokens to the authorized identity (e.g., from rewards) | | [Emergency action](#emergency-action) | Performs emergency actions like pausing or resuming the contract | | [Token config update](#configuration-updates) | Updates token configuration settings | +| [Set Purchase Price](#set-purchase-price) | Sets or updates the price for direct token purchases | +| [Purchase](#purchase) | Purchases tokens at the predefined price in exchange for Platform credits | #### Mint @@ -64,6 +67,10 @@ The initial token implementation includes all actions required to create, use, a - Destroy tokens from a frozen identity’s balance (e.g., blacklisting stolen tokens in stablecoin systems). +#### Claim + +- Claim tokens that have been created by a distribution method (e.g., preprogrammed). Tokens created this way are not directly assigned to the authorized identity, but must be claimed to take ownership. + #### Emergency Action - Globally pause or unpause an entire token. While paused, no transfers can occur. @@ -77,6 +84,18 @@ Update token configuration parameters, including: - History retention - Group membership +#### Set Purchase Price + +- Sets or updates the price for direct token purchases. + - Can be a single entry (for a fixed price) or multiple entries for tiered pricing. +- Setting an empty price disables direct token purchases. +- Records changes to the token history if direct pricing history is enabled. + +#### Purchase + +- Purchases tokens at the predefined price in exchange for Platform credits +- Records changes to the token history if direct purchase history is enabled + ### Configuration When creating a token, you define its configuration using the following parameters. Most parameters can be configured to allow modifications after data contract registration; however, the base supply is immutable: diff --git a/docs/protocol-ref/data-contract.md b/docs/protocol-ref/data-contract.md index e3357a3a2..9781ae682 100644 --- a/docs/protocol-ref/data-contract.md +++ b/docs/protocol-ref/data-contract.md @@ -678,6 +678,9 @@ See the [groups implementation in rs-dpp](https://github.com/dashpay/platform/bl ### Data Contract tokens +:::{versionadded} 2.0.0 +::: + - Tokens provide token-related functionality within the contract, such as base supply, maximum supply, and manual minting/burning rules. - Token configurations include change control rules, ensuring proper governance for modifying supply limits and token-related settings. - This enables contracts to define and manage tokens while ensuring compliance with governance rules (e.g., who can mint or burn tokens). diff --git a/docs/protocol-ref/token.md b/docs/protocol-ref/token.md index d915de5be..008ed40f5 100644 --- a/docs/protocol-ref/token.md +++ b/docs/protocol-ref/token.md @@ -39,7 +39,7 @@ pub fn calculate_token_id(contract_id: &[u8; 32], token_pos: TokenContractPositi #### Token Transition Action -The token transition actions [defined in rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_transition_action_type.rs#L7-L17) indicate what operation platform should perform with the provided transition data. +The token transition actions [defined in rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_transition_action_type.rs#L15-L48) indicate what operation platform should perform with the provided transition data. | Action | Name | Description | | :-: | - | - | @@ -52,6 +52,8 @@ The token transition actions [defined in rs-dpp](https://github.com/dashpay/plat | 6 | [Claim](#token-claim-transition) | Retrieve tokens based on a specified distribution method | | 7 | [Emergency Action](#token-emergency-action-transition) | Execute an emergency protocol affecting tokens | | 8 | [Config Update](#token-config-update-transition) | Modify the configuration settings of a token | +| 9 | [Set Purchase Price](#token-set-purchase-price-transition) | Define or update the token’s direct purchase pricing schedule for users (enables or adjusts direct token sales) | +| 10 | [Purchase](#token-purchase-transition) | Purchase tokens directly from the token’s owner or distribution pool at the predefined price (transfers tokens to the buyer in exchange for Platform credits) | ### Token Notes @@ -159,3 +161,34 @@ The token config update transition extends the [base transition](#token-base-tra | publicNote | string | [<= 2048 characters](#token-notes) | Optional public note | Each token configuration update transition must comply with the [token config update transition defined in rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_config_update_transition/v0/mod.rs#L19-L27). + +### Token Set Purchase Price Transition + +The token set purchase price transition enables token purchases by setting the token price using a pricing schedule. This can be a single entry (for a fixed price) or multiple entries for tiered pricing. For example, a token might define a price of 100 credits each for a minimum of 1 token, and 90 credits each for a minimum of 10 tokens – allowing a discount for bulk purchases. + +Only an identity authorized by the token’s *change direct purchase pricing* rules can successfully execute this transition. On execution, platform will update the token’s current direct purchase price schedule. If direct pricing history is enabled, it will also record the change in the token’s history. + +This transition extends the [base transition](#token-base-transition) to include the following additional fields: + +| Field | Type | Size | Description | +| ----- | ---- | ---- | ----------- | +price | [TokenPricingSchedule](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/tokens/token_pricing_schedule.rs#L31-L47) | Variable | Set the fixed price or tiered price. Tiered pricing entries consists of a *minimum token amount* (unsigned 64-bit) and a *price in credits* (unsigned 64-bit) applicable for purchases of that size or greater. The smallest amount tier also defines the *minimum purchasable amount*. If the lowest tier has amount > 1, users cannot buy less than that amount in a single purchase. If multiple tiers are provided, they should be ordered by ascending minimum amount.
**Note:** An empty pricing schedule indicates direct purchases are disabled for the token. | +| publicNote | string | [<= 2048 characters](#token-notes) | Optional public note | + +Each token set purchase price transition must comply with the [token set purchase price transition defined in rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_set_price_for_direct_purchase_transition/v0/mod.rs#L18-L35). + +### Token Purchase Transition + +The token purchase transition transfers a specified number of tokens to the purchasing identity. Platform simultaneously deducts the corresponding purchase cost in credits from the buyer’s balance as part of the state transition. A purchase must be accompanied by a credit transfer to the token seller’s identity in the same batch. If direct purchase history is enabled for the token, platform will create a record of this sale in the token’s history. + +Attempts to purchase tokens when no price is set, when providing insufficient payment, or below the minimum amount will be rejected by platform consensus. + +This transition extends the [base transition](#token-base-transition) to include the following additional fields: + +| Field | Type | Size | Description | +| ----- | ---- | ---- | ----------- | +| amount | unsigned integer | 64 bits | Number of tokens the user is purchasing. The `amount` must be at least the minimum purchase amount defined by the current pricing, and cannot exceed any available supply limits. | +| totalPrice | unsigned integer | 64 bits | Total price (in credits) that the purchaser agrees to pay for this purchase. This should equal the unit price (or tiered price) times the `amount` of tokens, according to the currently set pricing schedule. | +| publicNote | string | [<= 2048 characters](#token-notes) | Optional public note | + +Each token purchase transition must comply with the [token direct purchase transition defined in rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/batched_transition/token_direct_purchase_transition/v0/mod.rs#L20-L31). diff --git a/docs/reference/dapi-endpoints-platform-endpoints.md b/docs/reference/dapi-endpoints-platform-endpoints.md index aec5fcba9..3be405cff 100644 --- a/docs/reference/dapi-endpoints-platform-endpoints.md +++ b/docs/reference/dapi-endpoints-platform-endpoints.md @@ -6,7 +6,14 @@ Please refer to the [gRPC Overview](../reference/dapi-endpoints-grpc-overview.md) for details regarding running the examples shown below. -## Data Proofs and Metadata +## General Behavior + +### Versioning + +All Dash Platform endpoints are versioned so future updates can be done without creating significant +issues for API consumers. + +### Data Proofs and Metadata Platform gRPC endpoints can provide [proofs](https://github.com/dashpay/platform/blob/master/packages/dapi-grpc/protos/platform/v0/platform.proto#L17-L22) so the data returned for a request can be verified as being valid. When requesting proofs, the data requested will be encoded as part of the proof in the response. Full support is not yet available in the JavaScript client, but can be used via the low level [dapi-grpc library](https://github.com/dashpay/platform/tree/master/packages/dapi-grpc). @@ -21,15 +28,11 @@ Some [additional metadata](https://github.com/dashpay/platform/blob/master/packa | `protocolVersion` | Platform protocol version | | `chainId` | Name of the network | -## Versioning - -Dash Platform 0.25.16 included a [breaking change that added versioning](https://github.com/dashpay/platform/pull/1522) to these endpoints so future updates can be done without creating significant issues for API consumers. - ```{eval-rst} .. _mn-identity-id: ``` -## Masternode identity IDs +### Masternode identity IDs [Masternode identities](../explanations/identity.md#masternode-identities) are created automatically by the system based on the [Core masternode registration transaction (protx) @@ -53,41 +56,23 @@ const protx = '8eca4bcbb3a124ab283afd42dad3bdb2077b3809659788a0f1daffce5b9f001f' const base58Protx = bs58.encode(Buffer.from(protx, 'hex')); console.log(`Masternode identity id (base58): ${base58Protx}`); const base64Protx = Buffer.from(protx, 'hex').toString('base64'); -console.log(`Masternode identity id (base58): ${base64Protx}`); +console.log(`Masternode identity id (base64): ${base64Protx}`); // Output: // Masternode identity id (base58): AcPogCxrxeas7jrWYG7TnLHKbsA5KLHGfvg6oYgANZ8J // Masternode identity id (base64): jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8= ::: -## Endpoint Details - -### broadcastStateTransition - -Broadcasts a [state transition](../explanations/platform-protocol-state-transition.md) to the platform via DAPI to make a change to layer 2 data. The `broadcastStateTransition` call returns once the state transition has been accepted into the mempool. - -**Returns**: Nothing or error - -:::{note} -The [`waitForStateTransitionResult` endpoint](#waitforstatetransitionresult) should be used after `broadcastStateTransition` if proof of block confirmation is required. -::: - -**Parameters**: - -| Name | Type | Required | Description | -| ------------------ | -------------- | -------- | -------------------------------------------------------------------- | -| `state_transition` | Bytes (Base64) | Yes | A [state transition](../explanations/platform-protocol-state-transition.md) | +## Contested Resource Endpoints -```{eval-rst} -.. - Commented out info - [block:html] - { - "html": "\n\n\n\n" - } - [/block] -``` +Contested resources are a special class of Dash Platform documents that require deterministic +conflict resolution when multiple identities request the same logical resource (e.g., a DPNS name). +These resources are defined at the data contract level using [contested +indexes](./data-contracts.md#contested-indices). See the [DPNS conflict resolution +section](../explanations/dpns.md#conflict-resolution) for an example of how this works for premium +DPNS names. -**Response**: No response except on error +The endpoints in this section allow clients to check the status of active contests, retrieve +contestants, and obtain the outcome. ### getContestedResources @@ -181,7 +166,7 @@ Retrieves the voting record of a specific identity. grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + "identity_id": "CSgo7cCB07oaVPBDJZuUE2jyxxiIGwap00eIOyG/4xM=" } }' \ seed-1.testnet.networks.dash.org:1443 \ @@ -196,15 +181,83 @@ grpcurl -proto protos/platform/v0/platform.proto \ { "v0": { "votes": { + "contestedResourceIdentityVotes": [ + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "dDBueQ==" + ], + "voteChoice": { + "identityId": "+G9rGhk5ggauDroBJbx8DHj/DCjLaLvlxj3m4oFs9f0=" + } + }, + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "anUxeQ==" + ], + "voteChoice": { + "identityId": "hzKARzLQgCeLgieyXkc22PVsDy9RoyRCSQpVA1sq3Ag=" + } + }, + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "cmVkcGFuZGE=" + ], + "voteChoice": { + "identityId": "Yiub6FbtHuyrGjiOhtFFsNzkFXay15HKapz/5WmIdRc=" + } + }, + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "YTFleGFuZHJh" + ], + "voteChoice": { + "identityId": "FSzaDd9OWziOwkizZf/t6HdDCG3pY6zb4MTriOuiyf0=" + } + }, + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "ZW0xMTFt" + ], + "voteChoice": { + "identityId": "HpGErJllHxDvKnetz9d88452CCfWsbm8s+SLq7hn1v4=" + } + }, + { + "contractId": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "documentTypeName": "domain", + "serializedIndexStorageValues": [ + "ZGFzaA==", + "YXNkdGhyZWVhcHI=" + ], + "voteChoice": { + "identityId": "toqsgrVi2jpH5zyFqx8IkC2cK987anWbUQJknPu+qss=" + } + } + ], "finishedResults": true }, "metadata": { - "height": "7762", - "coreChainLockedHeight": 1099677, - "epoch": 1260, - "timeMs": "1725889742454", - "protocolVersion": 1, - "chainId": "dash-testnet-51" + "height": "164297", + "coreChainLockedHeight": 2256124, + "epoch": 25, + "timeMs": "1744850434997", + "protocolVersion": 8, + "chainId": "evo1" } } } @@ -244,8 +297,8 @@ grpcurl -proto protos/platform/v0/platform.proto \ "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", "document_type_name": "domain", "index_name": "parentNameAndLabel", - "index_values": [], - "contestant_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + "index_values": ["EgRkYXNo", "EgZlbTExMW0="], + "contestant_id": "HpGErJllHxDvKnetz9d88452CCfWsbm8s+SLq7hn1v4=" } }' \ seed-1.testnet.networks.dash.org:1443 \ @@ -260,15 +313,27 @@ grpcurl -proto protos/platform/v0/platform.proto \ { "v0": { "contestedResourceVoters": { + "voters": [ + "9BNnQL24MI/zNJQeg6njKqMFsPfY3r1syRB9zxAlZFQ=", + "7GFTbyVQbbUuol/RD2iNAeKbsL7NXPjfqSjhapTRN3g=", + "vMOhByXvdDR4bNAWsB/gF5WdtF+W4HIEciZgRJZnN4I=", + "rU44/IHactYbFCOO5uW5GRVVTiTXJXGIAGktOoY8kQs=", + "nrjH6/4hLLe9Eh/Y9NPsezMctlDH4+q+4+2AujX68WQ=", + "hLickXbsCtHIUjadrnX4DGaALQ1hBi4HSzAn1iAiI1A=", + "TC4jH+JzJyRlHQ/YxdtqN+L2icRxcM/8Uuq7gxjSJ+8=", + "Nk7hQkGkrfC7lApPG8EyQXOKXoGKsg07MfY1khdQxoM=", + "FE0hYA6383IDzr7zrFxdT6pgY9kXjt90b4OKJED7tCg=", + "CSgo7cCB07oaVPBDJZuUE2jyxxiIGwap00eIOyG/4xM=" + ], "finishedResults": true }, "metadata": { - "height": "7762", - "coreChainLockedHeight": 1099677, - "epoch": 1260, - "timeMs": "1725889742454", - "protocolVersion": 1, - "chainId": "dash-testnet-51" + "height": "164240", + "coreChainLockedHeight": 2256049, + "epoch": 25, + "timeMs": "1744839902217", + "protocolVersion": 8, + "chainId": "evo1" } } } @@ -296,72 +361,6 @@ Retrieves the state of a vote for a specific contested resource. | `count` | Integer | No | Number of results to return | | `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested vote state | -```{eval-rst} -.. - Commented out info - The following example isn't fully functional - - **Example Request and Response** - - ::::{tab-set} - :::{tab-item} gRPCurl - ```shell - grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "document_type_name": "domain", - "index_name": "parentNameAndLabel", - "index_values": ["EgRkYXNo", "value2"], - "result_type": 1 - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getContestedResourceVoteState - ``` - ::: - :::: - -```{eval-rst} -.. - Commented out info - The following example isn't fully functional - - ::::{tab-set} - :::{tab-item} Response (gRPCurl) - ```json - { - "v0": { - "contested_resource_contenders": { - "contenders": [{"identifier": "id1", "vote_count": 10}, {"identifier": "id2", "vote_count": 5}] - }, - "metadata": { - "height": "6852", - "coreChainLockedHeight": 927072, - "epoch": 850, - "timeMs": "1701983652299", - "protocolVersion": 1, - "chainId": "dash-testnet-37" - } - } - } - ``` - ::: - :::: - -### getCurrentQuorumsInfo - -Retrieves current quorum details, including validator sets and metadata for each quorum. - -**Returns**: Information about current quorums, including quorum hashes, validator sets, and -cryptographic proof. - -**Parameters**: - -| Name | Type | Required | Description | -| ------------- | ------ | -------- | ----------- | -| `version` | Object | No | Version object containing request parameters | - **Example Request and Response** ::::{tab-set} @@ -369,52 +368,40 @@ cryptographic proof. ```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": {} + "v0": { + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "document_type_name": "domain", + "index_name": "parentNameAndLabel", + "index_values": ["EgRkYXNo", "EgZlbTExMW0="], + "result_type": 2 + } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getCurrentQuorumsInfo + org.dash.platform.dapi.v0.Platform/getContestedResourceVoteState ``` ::: :::: - ::::{tab-set} :::{tab-item} Response (gRPCurl) ```json { "v0": { - "quorumHashes": [ - "AAABC9mcu+F3eC33hC9wyZAP20QQNHz4kYnfFQPwa5A=" - ], - "currentQuorumHash": "AAABP7yY5DKt8UlLUR/QJlH8BI108xugKSEIOrR6iAA=", - "validatorSets": [ - { - "quorumHash": "AAABC9mcu+F3eC33hC9wyZAP20QQNHz4kYnfFQPwa5A=", - "coreHeight": 1131096, - "members": [ - { - "proTxHash": "BbaHl4NE+iQzsqqZ1B9kPi2FgaeJzcIwhIic7KUkTqg=", - "nodeIp": "52.24.124.162" - }, - { - "proTxHash": "iCUb1LEk7+uHU33qvuxU9sj1dfTfgfEM9ejuoHMJK28=", - "nodeIp": "52.33.28.47" - }, - { - "proTxHash": "FD3Namt2hP3gHoihDl1l3popJExezVhtFKNCZXAl8RM=", - "nodeIp": "35.164.23.245" - } - ], - "thresholdPublicKey": "ixciXjkgFnI/cQNXS51yBi4MYgdPZWjRGxsubEsfzItgvTlABUxow9S1eCE7w9+f" - } - ], - "lastBlockProposer": "iCUb1LEk7+uHU33qvuxU9sj1dfTfgfEM9ejuoHMJK28=", + "contestedResourceContenders": { + "contenders": [ + { + "identifier": "HpGErJllHxDvKnetz9d88452CCfWsbm8s+SLq7hn1v4=", + "voteCount": 34, + "document": "AKcHIgv30Tb3zWNw0bgSF17cJp7HW+A6eiYRVpS3YMKuHpGErJllHxDvKnetz9d88452CCfWsbm8s+SLq7hn1v4BAAcAAAGWGJoweAAAAZYYmjB4AAABlhiaMHgABkVtaWxpTQZlbTExMW0BBGRhc2gEZGFzaAAhAR6RhKyZZR8Q7yp3rc/XfPOOdggn1rG5vLPki6u4Z9b+AQA=" + } + ] + }, "metadata": { - "height": "43865", - "coreChainLockedHeight": 1131112, - "epoch": 2483, - "timeMs": "1730295469308", - "protocolVersion": 4, - "chainId": "dash-testnet-51" + "height": "164296", + "coreChainLockedHeight": 2256122, + "epoch": 25, + "timeMs": "1744850252661", + "protocolVersion": 8, + "chainId": "evo1" } } } @@ -422,19 +409,22 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getEvonodesProposedEpochBlocksByIds +### getVotePollsByEndDate -Retrieves the number of blocks proposed by the specified evonodes in a certain epoch, based on their IDs. +Retrieves vote polls that will end within a specified date range. -**Returns**: A list of evonodes and their proposed block counts or a cryptographic proof. +**Returns**: A list of vote polls or a cryptographic proof. **Parameters**: | Name | Type | Required | Description | | ------------------ | -------- | -------- | ----------- | -| `epoch` | Integer | No | The epoch to query for. If not set, the current epoch will be used | -| `ids` | Array | Yes | An array of evonode IDs for which proposed blocks are retrieved IDs
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data | +| `start_time_info` | Object | No | Start time information for filtering vote polls | +| `end_time_info` | Object | No | End time information for filtering vote polls | +| `limit` | Integer | No | Maximum number of results to return | +| `offset` | Integer | No | Offset for pagination | +| `ascending` | Boolean | No | Sort order for results | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested vote polls | **Example Request and Response** @@ -444,14 +434,13 @@ Retrieves the number of blocks proposed by the specified evonodes in a certain e grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "ids": [ - "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=","dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" - ], - "prove": false + "start_time_info": {"start_time_ms": "1701980000000", "start_time_included": true}, + "end_time_info": {"end_time_ms": "1702000000000", "end_time_included": true}, + "limit": 10 } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getEvonodesProposedEpochBlocksByIds + org.dash.platform.dapi.v0.Platform/getVotePollsByEndDate ``` ::: :::: @@ -461,24 +450,16 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "evonodesProposedBlockCountsInfo": { - "evonodesProposedBlockCounts": [ - { - "proTxHash": "dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" - }, - { - "proTxHash": "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=", - "count": "13" - } - ] + "votePollsByTimestamps": { + "finishedResults": true }, "metadata": { - "height": "13621", - "coreChainLockedHeight": 1105397, - "epoch": 1482, - "timeMs": "1726691577244", - "protocolVersion": 3, - "chainId": "dash-testnet-51" + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", + "protocolVersion": 1, + "chainId": "dash-testnet-50" } } } @@ -486,100 +467,41 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getEvonodesProposedEpochBlocksByRange - -Retrieves the number of blocks proposed by evonodes for a specified epoch. +## Data Contract Endpoints -**Returns**: A list of evonodes and their proposed block counts or a cryptographic proof. +### getDataContract +**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contract **Parameters**: -| Name | Type | Required | Description | -| ------------------ | -------- | -------- | ----------- | -| `epoch` | Integer | No | The epoch to query for. If not set, the current epoch will be used | -| `limit` | Integer | No | Maximum number of evonodes proposed epoch blocks to return | -| `start_after` | Bytes | No | Retrieve results starting after this document | -| `start_at` | Bytes | No | Retrieve results starting at this document | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data | +| Name | Type | Required | Description | +| ------- | ------- | -------- | -------------------------------------------------------------------------- | +| `id` | Bytes | Yes | A data contract `id` | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contract. The data requested will be encoded as part of the proof in the response. | **Example Request and Response** ::::{tab-set} -:::{tab-item} gRPCurl -```shell -grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "epoch": 0, - "limit": 10, - "prove": false - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getEvonodesProposedEpochBlocksByRange -``` -::: -:::: - -::::{tab-set} -:::{tab-item} Response (gRPCurl) -```json -{ - "v0": { - "evonodesProposedBlockCountsInfo": { - "evonodesProposedBlockCounts": [ - { - "proTxHash": "BbaHl4NE+iQzsqqZ1B9kPi2FgaeJzcIwhIic7KUkTqg=", - "count": "1" - } - ] - }, - "metadata": { - "height": "20263", - "coreChainLockedHeight": 1105827, - "epoch": 1499, - "timeMs": "1726752270072", - "protocolVersion": 3, - "chainId": "dash-testnet-51" - } - } -} -``` -::: -:::: - -### getIdentity - -**Returns**: [Identity](../explanations/identity.md) information for the requested identity -**Parameters**: - -| Name | Type | Required | Description | -| ------- | ------- | -------- | --------------------------------------------------------------------- | -| `id` | Bytes | Yes | An identity `id`
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity. The data requested will be encoded as part of the proof in the response.| - -**Example Request and Response** - -::::{tab-set} -:::{tab-item} JavaScript (dapi-client) -:sync: js-dapi-client -```javascript -const DAPIClient = require('@dashevo/dapi-client'); -const { - default: loadDpp, - DashPlatformProtocol, - Identifier, -} = require('@dashevo/wasm-dpp'); - -loadDpp(); -const dpp = new DashPlatformProtocol(); -const client = new DAPIClient({ network: 'testnet' }); - -const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); -client.platform.getIdentity(identityId).then((response) => { - const identity = dpp.identity.createFromBuffer(response.getIdentity()); - console.log(identity.toJSON()); -}); +:::{tab-item} JavaScript (dapi-client) +:sync: js-dapi-client +```javascript +const DAPIClient = require('@dashevo/dapi-client'); +const { + default: loadDpp, + DashPlatformProtocol, + Identifier, +} = require('@dashevo/wasm-dpp'); + +loadDpp(); +const dpp = new DashPlatformProtocol(null); +const client = new DAPIClient({ network: 'testnet' }); + +const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); +client.platform.getDataContract(contractId).then((response) => { + dpp.dataContract.createFromBuffer(response.getDataContract()).then((dataContract) => { + console.dir(dataContract.toJSON(), { depth: 10 }); + }); +}); ``` ::: @@ -587,31 +509,25 @@ client.platform.getIdentity(identityId).then((response) => { :sync: js-dapi-grpc ```javascript const { - v0: { PlatformPromiseClient, GetIdentityRequest }, + v0: { PlatformPromiseClient, GetDataContractRequest }, } = require('@dashevo/dapi-grpc'); -const { - default: loadDpp, - DashPlatformProtocol, - Identifier, -} = require('@dashevo/wasm-dpp'); +const { default: loadDpp, DashPlatformProtocol, Identifier } = require('@dashevo/wasm-dpp'); -loadDpp(); -const dpp = new DashPlatformProtocol(null); const platformPromiseClient = new PlatformPromiseClient( 'https://seed-1.testnet.networks.dash.org:1443', ); -const id = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); -const idBuffer = Buffer.from(id); -const getIdentityRequest = new GetIdentityRequest(); -getIdentityRequest.setId(idBuffer); -getIdentityRequest.setProve(false); +const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); +const contractIdBuffer = Buffer.from(contractId); +const getDataContractRequest = new GetDataContractRequest(); +getDataContractRequest.setId(contractIdBuffer); platformPromiseClient - .getIdentity(getIdentityRequest) + .getDataContract(getDataContractRequest) .then((response) => { - const identity = dpp.identity.createFromBuffer(response.getIdentity()); - console.dir(identity.toJSON()); + dpp.dataContract.createFromBuffer(response.getDataContract()).then((dataContract) => { + console.dir(dataContract.toJSON(), { depth: 10 }); + }); }) .catch((e) => console.error(e)); ``` @@ -624,11 +540,11 @@ platformPromiseClient grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + "id":"5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentity + org.dash.platform.dapi.v0.Platform/getDataContract ``` ::: :::: @@ -638,100 +554,201 @@ grpcurl -proto protos/platform/v0/platform.proto \ :sync: js-dapi-client ```json { - "$version":"0", - "id":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", - "publicKeys":[ - { - "$version":"0", - "id":0, - "purpose":0, - "securityLevel":0, - "contractBounds":null, - "type":0, - "readOnly":false, - "data":"Asi0dHtSjKxf3femzGNwLuBO19EzKQTghRA0PqANzlRq", - "disabledAt":null + "$format_version":"0", + "id":"GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec", + "config":{ + "$format_version":"0", + "canBeDeleted":false, + "readonly":false, + "keepsHistory":false, + "documentsKeepHistoryContractDefault":false, + "documentsMutableContractDefault":true, + "requiresIdentityEncryptionBoundedKey":null, + "requiresIdentityDecryptionBoundedKey":null + }, + "version":1, + "ownerId":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", + "schemaDefs":null, + "documentSchemas":{ + "domain":{ + "type":"object", + "indices":[ + { + "name":"parentNameAndLabel", + "properties":[ + { + "normalizedParentDomainName":"asc" + }, + { + "normalizedLabel":"asc" + } + ], + "unique":true + }, + { + "name":"dashIdentityId", + "properties":[ + { + "records.dashUniqueIdentityId":"asc" + } + ], + "unique":true + }, + { + "name":"dashAlias", + "properties":[ + { + "records.dashAliasIdentityId":"asc" + } + ] + } + ], + "properties":{ + "label":{ + "type":"string", + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$", + "minLength":3, + "maxLength":63, + "position":0, + "description":"Domain label. e.g. 'Bob'." + }, + "normalizedLabel":{ + "type":"string", + "pattern":"^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-]{0,61}[a-hj-km-np-z0-9]$", + "maxLength":63, + "position":1, + "description":"`Domain label converted to lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'b0b'`", + "$comment":"Must be equal to the label in lowercase. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\"." + }, + "parentDomainName":{ + "type":"string", + "pattern":"^$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$", + "minLength":0, + "maxLength":63, + "position":2, + "description":"A full parent domain name. e.g. 'dash'." + }, + "normalizedParentDomainName":{ + "type":"string", + "pattern":"^$|^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-\\.]{0,61}[a-hj-km-np-z0-9]$", + "minLength":0, + "maxLength":63, + "position":3, + "description":"`A parent domain name in lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'dash'`", + "$comment":"Must either be equal to an existing domain or empty to create a top level domain. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\". Only the data contract owner can create top level domains." + }, + "preorderSalt":{ + "type":"array", + "byteArray":true, + "minItems":32, + "maxItems":32, + "position":4, + "description":"Salt used in the preorder document" + }, + "records":{ + "type":"object", + "properties":{ + "dashUniqueIdentityId":{ + "type":"array", + "byteArray":true, + "minItems":32, + "maxItems":32, + "position":0, + "contentMediaType":"application/x.dash.dpp.identifier", + "description":"Identity ID to be used to create the primary name the Identity", + "$comment":"Must be equal to the document owner" + }, + "dashAliasIdentityId":{ + "type":"array", + "byteArray":true, + "minItems":32, + "maxItems":32, + "position":1, + "contentMediaType":"application/x.dash.dpp.identifier", + "description":"Identity ID to be used to create alias names for the Identity", + "$comment":"Must be equal to the document owner" + } + }, + "minProperties":1, + "maxProperties":1, + "position":5, + "additionalProperties":false, + "$comment":"Constraint with max and min properties ensure that only one identity record is used - either a `dashUniqueIdentityId` or a `dashAliasIdentityId`" + }, + "subdomainRules":{ + "type":"object", + "properties":{ + "allowSubdomains":{ + "type":"boolean", + "description":"This option defines who can create subdomains: true - anyone; false - only the domain owner", + "$comment":"Only the domain owner is allowed to create subdomains for non top-level domains", + "position":0 + } + }, + "position":6, + "description":"Subdomain rules allow domain owners to define rules for subdomains", + "additionalProperties":false, + "required":[ + "allowSubdomains" + ] + } + }, + "required":[ + "label", + "normalizedLabel", + "normalizedParentDomainName", + "preorderSalt", + "records", + "subdomainRules" + ], + "additionalProperties":false, + "$comment":"In order to register a domain you need to create a preorder. The preorder step is needed to prevent man-in-the-middle attacks. normalizedLabel + '.' + normalizedParentDomain must not be longer than 253 chars length as defined by RFC 1035. Domain documents are immutable: modification and deletion are restricted" }, - { - "$version":"0", - "id":1, - "purpose":0, - "securityLevel":2, - "contractBounds":null, - "type":0, - "readOnly":false, - "data":"AgHuKPhPVIU5BWfpOcK1hgELY6aeySyrU13JaoxxkTYC", - "disabledAt":null - } - ], - "balance":17912102140, - "revision":0 -} -``` -::: - -:::{tab-item} Response (gRPCurl) -:sync: grpcurl -```json -{ - "v0": { - "identity": "AB8VEmymhcW7r01Ka36+WtMlOruBGrE3Ulr0sTsCo5scBAAAAAAAAAAAIQMSQ7bd3xPfA+9xn2+FLl/AJrQTEhdW/OUafgjhbjs6qwABAAEAAgAAACED8nl3p8oFHACE5DGvv8Y9sBxWEVPLpUDUlSD7yICx0OoAAgACAAEAAAAhA9BQqn5pbKnveG+CTGpr+sheSghjJFEUYpm//gO1HPa1AAMAAwMBAAAAIQK7PbawzDv5oNWL3icaXEeAnv5xigN0gUMXRVzn6VgPQwD8J+gRAgA=", - "metadata": { - "height": "5986", - "coreChainLockedHeight": 1097381, - "epoch": 1170, - "timeMs": "1725566939334", - "protocolVersion": 1, - "chainId": "dash-testnet-51" + "preorder":{ + "type":"object", + "indices":[ + { + "name":"saltedHash", + "properties":[ + { + "saltedDomainHash":"asc" + } + ], + "unique":true + } + ], + "properties":{ + "saltedDomainHash":{ + "type":"array", + "byteArray":true, + "minItems":32, + "maxItems":32, + "position":0, + "description":"Double sha-256 of the concatenation of a 32 byte random salt and a normalized domain name" + } + }, + "required":[ + "saltedDomainHash" + ], + "additionalProperties":false, + "$comment":"Preorder documents are immutable: modification and deletion are restricted" } } -} -``` - -:::: - -### getIdentityBalance - -**Returns**: Credit balance for the requested [Identity](../explanations/identity.md) - -**Parameters**: - -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity - -**Example Request and Response** - -::::{tab-set} -:::{tab-item} gRPCurl -:sync: grpcurl -```shell -# `id` must be represented in base64 -grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityBalance +} ``` ::: -:::: -::::{tab-set} :::{tab-item} Response (gRPCurl) :sync: grpcurl ```json { "v0": { - "balance": "669520130", + "dataContract": "AOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAQAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIGZG9tYWluFgsSEGRvY3VtZW50c011dGFibGUTABIMY2FuQmVEZWxldGVkEwESDHRyYW5zZmVyYWJsZQIBEgl0cmFkZU1vZGUCARIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQIWBBIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwESCWNvbnRlc3RlZBYDEgxmaWVsZE1hdGNoZXMVARYCEgVmaWVsZBIPbm9ybWFsaXplZExhYmVsEgxyZWdleFBhdHRlcm4SE15bYS16QS1aMDEtXXszLDE5fSQSCnJlc29sdXRpb24CABILZGVzY3JpcHRpb24SqklmIHRoZSBub3JtYWxpemVkIGxhYmVsIHBhcnQgb2YgdGhpcyBpbmRleCBpcyBsZXNzIHRoYW4gMjAgY2hhcmFjdGVycyAoYWxsIGFscGhhYmV0IGEteiwgQS1aLCAwLCAxLCBhbmQgLSkgdGhlbiBhIG1hc3Rlcm5vZGUgdm90ZSBjb250ZXN0IHRha2VzIHBsYWNlIHRvIGdpdmUgb3V0IHRoZSBuYW1lFgMSBG5hbWUSCmlkZW50aXR5SWQSDm51bGxTZWFyY2hhYmxlEwASCnByb3BlcnRpZXMVARYBEhByZWNvcmRzLmlkZW50aXR5EgNhc2MSCnByb3BlcnRpZXMWBxIFbGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEipeW2EtekEtWjAtOV1bYS16QS1aMC05LV17MCw2MX1bYS16QS1aMC05XSQSCW1pbkxlbmd0aAIDEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SGURvbWFpbiBsYWJlbC4gZS5nLiAnQm9iJy4SD25vcm1hbGl6ZWRMYWJlbBYGEgR0eXBlEgZzdHJpbmcSB3BhdHRlcm4SPF5bYS1oai1rbS1ucC16MC05XVthLWhqLWttLW5wLXowLTktXXswLDYxfVthLWhqLWttLW5wLXowLTldJBIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgESC2Rlc2NyaXB0aW9uEqNEb21haW4gbGFiZWwgY29udmVydGVkIHRvIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdiMGInEggkY29tbWVudBJcTXVzdCBiZSBlcXVhbCB0byB0aGUgbGFiZWwgaW4gbG93ZXJjYXNlLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4SEHBhcmVudERvbWFpbk5hbWUWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEi1eJHxeW2EtekEtWjAtOV1bYS16QS1aMC05LV17MCw2MX1bYS16QS1aMC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAhILZGVzY3JpcHRpb24SJ0EgZnVsbCBwYXJlbnQgZG9tYWluIG5hbWUuIGUuZy4gJ2Rhc2gnLhIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUWBxIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEkFeJHxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LVwuXXswLDYxfVthLWhqLWttLW5wLXowLTldJBIJbWluTGVuZ3RoAgASCW1heExlbmd0aAI/Eghwb3NpdGlvbgIDEgtkZXNjcmlwdGlvbhKiQSBwYXJlbnQgZG9tYWluIG5hbWUgaW4gbG93ZXJjYXNlIGZvciBjYXNlLWluc2Vuc2l0aXZlIHVuaXF1ZW5lc3MgdmFsaWRhdGlvbi4gIm8iLCAiaSIgYW5kICJsIiByZXBsYWNlZCB3aXRoICIwIiBhbmQgIjEiIHRvIG1pdGlnYXRlIGhvbW9ncmFwaCBhdHRhY2suIGUuZy4gJ2Rhc2gnEggkY29tbWVudBLATXVzdCBlaXRoZXIgYmUgZXF1YWwgdG8gYW4gZXhpc3RpbmcgZG9tYWluIG9yIGVtcHR5IHRvIGNyZWF0ZSBhIHRvcCBsZXZlbCBkb21haW4uICJvIiwgImkiIGFuZCAibCIgbXVzdCBiZSByZXBsYWNlZCB3aXRoICIwIiBhbmQgIjEiLiBPbmx5IHRoZSBkYXRhIGNvbnRyYWN0IG93bmVyIGNhbiBjcmVhdGUgdG9wIGxldmVsIGRvbWFpbnMuEgxwcmVvcmRlclNhbHQWBhIEdHlwZRIFYXJyYXkSCWJ5dGVBcnJheRMBEghtaW5JdGVtcwIgEghtYXhJdGVtcwIgEghwb3NpdGlvbgIEEgtkZXNjcmlwdGlvbhIiU2FsdCB1c2VkIGluIHRoZSBwcmVvcmRlciBkb2N1bWVudBIHcmVjb3JkcxYFEgR0eXBlEgZvYmplY3QSCnByb3BlcnRpZXMWARIIaWRlbnRpdHkWBxIEdHlwZRIFYXJyYXkSCWJ5dGVBcnJheRMBEghtaW5JdGVtcwIgEghtYXhJdGVtcwIgEghwb3NpdGlvbgIBEhBjb250ZW50TWVkaWFUeXBlEiFhcHBsaWNhdGlvbi94LmRhc2guZHBwLmlkZW50aWZpZXISC2Rlc2NyaXB0aW9uEjFJZGVudGlmaWVyIG5hbWUgcmVjb3JkIHRoYXQgcmVmZXJzIHRvIGFuIElkZW50aXR5Eg1taW5Qcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQkSCiRjcmVhdGVkQXQSCiR1cGRhdGVkQXQSDiR0cmFuc2ZlcnJlZEF0EgVsYWJlbBIPbm9ybWFsaXplZExhYmVsEhpub3JtYWxpemVkUGFyZW50RG9tYWluTmFtZRIMcHJlb3JkZXJTYWx0EgdyZWNvcmRzEg5zdWJkb21haW5SdWxlcxIJdHJhbnNpZW50FQESDHByZW9yZGVyU2FsdBIUYWRkaXRpb25hbFByb3BlcnRpZXMTABIIJGNvbW1lbnQS+wE3SW4gb3JkZXIgdG8gcmVnaXN0ZXIgYSBkb21haW4geW91IG5lZWQgdG8gY3JlYXRlIGEgcHJlb3JkZXIuIFRoZSBwcmVvcmRlciBzdGVwIGlzIG5lZWRlZCB0byBwcmV2ZW50IG1hbi1pbi10aGUtbWlkZGxlIGF0dGFja3MuIG5vcm1hbGl6ZWRMYWJlbCArICcuJyArIG5vcm1hbGl6ZWRQYXJlbnREb21haW4gbXVzdCBub3QgYmUgbG9uZ2VyIHRoYW4gMjUzIGNoYXJzIGxlbmd0aCBhcyBkZWZpbmVkIGJ5IFJGQyAxMDM1LiBEb21haW4gZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQIcHJlb3JkZXIWCBIQZG9jdW1lbnRzTXV0YWJsZRMAEgxjYW5CZURlbGV0ZWQTARIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQEWAxIEbmFtZRIKc2FsdGVkSGFzaBIKcHJvcGVydGllcxUBFgESEHNhbHRlZERvbWFpbkhhc2gSA2FzYxIGdW5pcXVlEwESCnByb3BlcnRpZXMWARIQc2FsdGVkRG9tYWluSGFzaBYGEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEllEb3VibGUgc2hhLTI1NiBvZiB0aGUgY29uY2F0ZW5hdGlvbiBvZiBhIDMyIGJ5dGUgcmFuZG9tIHNhbHQgYW5kIGEgbm9ybWFsaXplZCBkb21haW4gbmFtZRIIcmVxdWlyZWQVARIQc2FsdGVkRG9tYWluSGFzaBIUYWRkaXRpb25hbFByb3BlcnRpZXMTABIIJGNvbW1lbnQSSlByZW9yZGVyIGRvY3VtZW50cyBhcmUgaW1tdXRhYmxlOiBtb2RpZmljYXRpb24gYW5kIGRlbGV0aW9uIGFyZSByZXN0cmljdGVk", "metadata": { - "height": "5986", - "coreChainLockedHeight": 1097381, + "height": "5990", + "coreChainLockedHeight": 1097384, "epoch": 1170, - "timeMs": "1725566939334", + "timeMs": "1725567663863", "protocolVersion": 1, "chainId": "dash-testnet-51" } @@ -741,16 +758,16 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getIdentityBalanceAndRevision +### getDataContracts -**Returns**: Credit balance and identity revision for the requested [Identity](../explanations/identity.md) +**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contracts **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity +| Name | Type | Required | Description | +| ------- | ------- | -------- | ----------------------------------------- | +| `ids` | Array | Yes | An array of data contract IDs | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contracts | **Example Request and Response** @@ -762,11 +779,13 @@ grpcurl -proto protos/platform/v0/platform.proto \ grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + "ids": [ + "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + ] } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityBalanceAndRevision + org.dash.platform.dapi.v0.Platform/getDataContracts ``` ::: :::: @@ -777,16 +796,21 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "balanceAndRevision": { - "balance": "669520130" + "dataContracts": { + "dataContractEntries": [ + { + "identifier": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "dataContract": "AOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAAABMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awAAgZkb21haW4WBhIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQMWAxIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwEWAxIEbmFtZRIOZGFzaElkZW50aXR5SWQSCnByb3BlcnRpZXMVARYBEhxyZWNvcmRzLmRhc2hVbmlxdWVJZGVudGl0eUlkEgNhc2MSBnVuaXF1ZRMBFgISBG5hbWUSCWRhc2hBbGlhcxIKcHJvcGVydGllcxUBFgESG3JlY29yZHMuZGFzaEFsaWFzSWRlbnRpdHlJZBIDYXNjEgpwcm9wZXJ0aWVzFgcSBWxhYmVsFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhIqXlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCAxIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEhlEb21haW4gbGFiZWwuIGUuZy4gJ0JvYicuEg9ub3JtYWxpemVkTGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEjxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LV17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1heExlbmd0aAI/Eghwb3NpdGlvbgIBEgtkZXNjcmlwdGlvbhKjRG9tYWluIGxhYmVsIGNvbnZlcnRlZCB0byBsb3dlcmNhc2UgZm9yIGNhc2UtaW5zZW5zaXRpdmUgdW5pcXVlbmVzcyB2YWxpZGF0aW9uLiAibyIsICJpIiBhbmQgImwiIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIgdG8gbWl0aWdhdGUgaG9tb2dyYXBoIGF0dGFjay4gZS5nLiAnYjBiJxIIJGNvbW1lbnQSXE11c3QgYmUgZXF1YWwgdG8gdGhlIGxhYmVsIGluIGxvd2VyY2FzZS4gIm8iLCAiaSIgYW5kICJsIiBtdXN0IGJlIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIuEhBwYXJlbnREb21haW5OYW1lFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhItXiR8XlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCABIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgISC2Rlc2NyaXB0aW9uEidBIGZ1bGwgcGFyZW50IGRvbWFpbiBuYW1lLiBlLmcuICdkYXNoJy4SGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lFgcSBHR5cGUSBnN0cmluZxIHcGF0dGVybhJBXiR8XlthLWhqLWttLW5wLXowLTldW2EtaGota20tbnAtejAtOS1cLl17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAxILZGVzY3JpcHRpb24SokEgcGFyZW50IGRvbWFpbiBuYW1lIGluIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdkYXNoJxIIJGNvbW1lbnQSwE11c3QgZWl0aGVyIGJlIGVxdWFsIHRvIGFuIGV4aXN0aW5nIGRvbWFpbiBvciBlbXB0eSB0byBjcmVhdGUgYSB0b3AgbGV2ZWwgZG9tYWluLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4gT25seSB0aGUgZGF0YSBjb250cmFjdCBvd25lciBjYW4gY3JlYXRlIHRvcCBsZXZlbCBkb21haW5zLhIMcHJlb3JkZXJTYWx0FgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CBBILZGVzY3JpcHRpb24SIlNhbHQgdXNlZCBpbiB0aGUgcHJlb3JkZXIgZG9jdW1lbnQSB3JlY29yZHMWBxIEdHlwZRIGb2JqZWN0Egpwcm9wZXJ0aWVzFgISFGRhc2hVbmlxdWVJZGVudGl0eUlkFggSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABIQY29udGVudE1lZGlhVHlwZRIhYXBwbGljYXRpb24veC5kYXNoLmRwcC5pZGVudGlmaWVyEgtkZXNjcmlwdGlvbhI+SWRlbnRpdHkgSUQgdG8gYmUgdXNlZCB0byBjcmVhdGUgdGhlIHByaW1hcnkgbmFtZSB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchITZGFzaEFsaWFzSWRlbnRpdHlJZBYIEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgESEGNvbnRlbnRNZWRpYVR5cGUSIWFwcGxpY2F0aW9uL3guZGFzaC5kcHAuaWRlbnRpZmllchILZGVzY3JpcHRpb24SPUlkZW50aXR5IElEIHRvIGJlIHVzZWQgdG8gY3JlYXRlIGFsaWFzIG5hbWVzIGZvciB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchINbWluUHJvcGVydGllcwIBEg1tYXhQcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASCCRjb21tZW50EpBDb25zdHJhaW50IHdpdGggbWF4IGFuZCBtaW4gcHJvcGVydGllcyBlbnN1cmUgdGhhdCBvbmx5IG9uZSBpZGVudGl0eSByZWNvcmQgaXMgdXNlZCAtIGVpdGhlciBhIGBkYXNoVW5pcXVlSWRlbnRpdHlJZGAgb3IgYSBgZGFzaEFsaWFzSWRlbnRpdHlJZGASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQYSBWxhYmVsEg9ub3JtYWxpemVkTGFiZWwSGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lEgxwcmVvcmRlclNhbHQSB3JlY29yZHMSDnN1YmRvbWFpblJ1bGVzEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBL7ATdJbiBvcmRlciB0byByZWdpc3RlciBhIGRvbWFpbiB5b3UgbmVlZCB0byBjcmVhdGUgYSBwcmVvcmRlci4gVGhlIHByZW9yZGVyIHN0ZXAgaXMgbmVlZGVkIHRvIHByZXZlbnQgbWFuLWluLXRoZS1taWRkbGUgYXR0YWNrcy4gbm9ybWFsaXplZExhYmVsICsgJy4nICsgbm9ybWFsaXplZFBhcmVudERvbWFpbiBtdXN0IG5vdCBiZSBsb25nZXIgdGhhbiAyNTMgY2hhcnMgbGVuZ3RoIGFzIGRlZmluZWQgYnkgUkZDIDEwMzUuIERvbWFpbiBkb2N1bWVudHMgYXJlIGltbXV0YWJsZTogbW9kaWZpY2F0aW9uIGFuZCBkZWxldGlvbiBhcmUgcmVzdHJpY3RlZAhwcmVvcmRlchYGEgR0eXBlEgZvYmplY3QSB2luZGljZXMVARYDEgRuYW1lEgpzYWx0ZWRIYXNoEgpwcm9wZXJ0aWVzFQEWARIQc2FsdGVkRG9tYWluSGFzaBIDYXNjEgZ1bmlxdWUTARIKcHJvcGVydGllcxYBEhBzYWx0ZWREb21haW5IYXNoFgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SWURvdWJsZSBzaGEtMjU2IG9mIHRoZSBjb25jYXRlbmF0aW9uIG9mIGEgMzIgYnl0ZSByYW5kb20gc2FsdCBhbmQgYSBub3JtYWxpemVkIGRvbWFpbiBuYW1lEghyZXF1aXJlZBUBEhBzYWx0ZWREb21haW5IYXNoEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBJKUHJlb3JkZXIgZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQ=" + } + ] }, "metadata": { - "height": "5986", - "coreChainLockedHeight": 1097381, - "epoch": 1170, - "timeMs": "1725566939334", + "height": "6807", + "coreChainLockedHeight": 927014, + "epoch": 848, + "timeMs": "1701973925674", "protocolVersion": 1, - "chainId": "dash-testnet-51" + "chainId": "dash-testnet-37" } } } @@ -794,25 +818,48 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getIdentityByPublicKeyHash - -**Returns**: An [identity](../explanations/identity.md) associated with the provided public key hash - -:::{note} -This endpoint only works for unique keys. Since masternode keys do not have to be unique (e.g., -voting keys), some masternode identities cannot be retrieved using this endpoint. -::: +### getDataContractHistory +**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contract **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `public_key_hash` | Bytes | Yes | Public key hash (sha256-ripemd160) of identity public key -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity +| Name | Type | Required | Description | +| ------- | -------- | -------- | ---------------------------------------- | +| `id` | Bytes | Yes | A data contract `id` | +| `start_at_ms` | Integer | Yes | Request revisions starting at this timestamp | +| `limit` | Integer | Yes | The maximum number of revisions to return | +| `offset` | Integer | Yes | The offset of the first revision to return | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contract. The data requested will be encoded as part of the proof in the response.| **Example Request and Response** ::::{tab-set} +:::{tab-item} JavaScript (dapi-client) +:sync: js-dapi-client +```javascript +const DAPIClient = require('@dashevo/dapi-client'); +const { + default: loadDpp, + DashPlatformProtocol, + Identifier, +} = require('@dashevo/wasm-dpp'); + +loadDpp(); +const dpp = new DashPlatformProtocol(null); +const client = new DAPIClient({ network: 'testnet' }); + +const contractId = Identifier.from('23iZPjG4ADx8CYGorW4yM8FUo1gihQL2fZszWLTMFyQf'); +client.platform.getDataContractHistory(contractId, 0, 2, 0).then((response) => { + for (const key in response.getDataContractHistory()) { + const revision = response.getDataContractHistory()[key]; + dpp.dataContract.createFromBuffer(revision).then((dataContract) => { + console.dir(dataContract.toJSON(), { depth: 10 }); + }); + } +}); +``` +::: + :::{tab-item} gRPCurl :sync: grpcurl ```shell @@ -820,27 +867,110 @@ voting keys), some masternode identities cannot be retrieved using this endpoint grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "public_key_hash": "uNFZGqdNRA4K+cC+FsVbvBQYR/c=" + "id":"D43WwBJeadt7AR8wRmcagPiCmi/YvDBHYwheFKzMfyw=", + "limit": 2, + "offset": 0, + "start_at_ms": 0, + "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityByPublicKeyHash + org.dash.platform.dapi.v0.Platform/getDataContractHistory ``` ::: :::: ::::{tab-set} +:::{tab-item} Response (JavaScript) +:sync: js-dapi-client +```json +{ + "$format_version":"0", + "id":"2ciAVGRuzogbR2NNtNfbn6YdW7BkLWntC7jrLNRMZN9n", + "config":{ + "$format_version":"0", + "canBeDeleted":false, + "readonly":false, + "keepsHistory":true, + "documentsKeepHistoryContractDefault":false, + "documentsMutableContractDefault":true, + "requiresIdentityEncryptionBoundedKey":null, + "requiresIdentityDecryptionBoundedKey":null + }, + "version":1, + "ownerId":"EB9eBUQxLjA7XGj71x3Msdd1uNmehKYZff3b6idhnTyV", + "schemaDefs":null, + "documentSchemas":{ + "note":{ + "type":"object", + "properties":{ + "message":{ + "type":"string", + "position":0 + } + }, + "additionalProperties":false + } + } +}, +{ + "$format_version":"0", + "id":"2ciAVGRuzogbR2NNtNfbn6YdW7BkLWntC7jrLNRMZN9n", + "config":{ + "$format_version":"0", + "canBeDeleted":false, + "readonly":false, + "keepsHistory":true, + "documentsKeepHistoryContractDefault":false, + "documentsMutableContractDefault":true, + "requiresIdentityEncryptionBoundedKey":null, + "requiresIdentityDecryptionBoundedKey":null + }, + "version":2, + "ownerId":"EB9eBUQxLjA7XGj71x3Msdd1uNmehKYZff3b6idhnTyV", + "schemaDefs":null, + "documentSchemas":{ + "note":{ + "type":"object", + "properties":{ + "message":{ + "type":"string", + "position":0 + }, + "author":{ + "type":"string", + "position":1 + } + }, + "additionalProperties":false + } + } +} +``` +::: + :::{tab-item} Response (gRPCurl) :sync: grpcurl ```json { "v0": { - "identity": "ADASwZuY7AAzrds2zWS39RBnDyo1GkMEtfaZQUQobv2sAgAAAAAAAAAAIQLItHR7UoysX933psxjcC7gTtfRMykE4IUQND6gDc5UagABAAEAAgAAACECAe4o+E9UhTkFZ+k5wrWGAQtjpp7JLKtTXclqjHGRNgIA/QAAAAQ8fEg8AA==", + "dataContractHistory": { + "dataContractEntries": [ + { + "date": "1701271990189", + "value": "ABgBjx2sR2xg0L+ti2CDLmGzmmI6g9+l/6SFwA8U3ybxAAAAAQABAAABw8GCMyj2ynyRr4i36i1KKHFYdYuPDVwKmo1jmEgT4zwAAQRub3RlFgMSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEgdtZXNzYWdlFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24DABIUYWRkaXRpb25hbFByb3BlcnRpZXMTAA==" + }, + { + "date": "1701272469813", + "value": "ABgBjx2sR2xg0L+ti2CDLmGzmmI6g9+l/6SFwA8U3ybxAAAAAQABAAACw8GCMyj2ynyRr4i36i1KKHFYdYuPDVwKmo1jmEgT4zwAAQRub3RlFgMSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYCEgdtZXNzYWdlFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24CABIGYXV0aG9yFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24CARIUYWRkaXRpb25hbFByb3BlcnRpZXMTAA==" + } + ] + }, "metadata": { - "height": "6870", - "coreChainLockedHeight": 927094, - "epoch": 851, - "timeMs": "1701985137472", + "height": "6776", + "coreChainLockedHeight": 926975, + "epoch": 846, + "timeMs": "1701968396855", "protocolVersion": 1, "chainId": "dash-testnet-37" } @@ -848,67 +978,197 @@ grpcurl -proto protos/platform/v0/platform.proto \ } ``` ::: -:::: - -### getIdentityContractNonce - -**Returns**: Current contract nonce for the requested [Identity](../explanations/identity.md) - -**Parameters**: - -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `identity_id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) -| `contract_id` | Bytes | Yes | A contract ID -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity contract nonce +:::: + +## Document Endpoints + +### getDocuments + +**Returns**: [Document](../explanations/platform-protocol-document.md) information for the requested document(s) +**Parameters**: + +:::{note} +The `where`, `order_by`, `limit`, `start_at`, and `start_after` parameters must comply with the limits defined on the [Query Syntax](../reference/query-syntax.md) page. +::: + +| Name | Type | Required | Description | +| ----------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------ | +| `data_contract_id` | Bytes | Yes | A data contract `id` | +| `document_type` | String | Yes | A document type defined by the data contract (e.g. `preorder` or `domain` for the DPNS contract) | +| `where` \* | Bytes | No | Where clause to filter the results | +| `order_by` \* | Bytes | No | Sort records by the field(s) provided | +| `limit` | Integer | No | Maximum number of results to return | +| ---------- | | | | +| _One_ of the following: | | | | +| `start_at` | Integer | No | Return records beginning with the index provided | +| `start_after` | Integer | No | Return records beginning after the index provided | +| ---------- | | | | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested document(s). The data requested will be encoded as part of the proof in the response. | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} JavaScript (dapi-client) +:sync: js-dapi-client +```javascript +const DAPIClient = require('@dashevo/dapi-client'); +const { + default: loadDpp, + DashPlatformProtocol, + Identifier, +} = require('@dashevo/wasm-dpp'); + +loadDpp(); +const dpp = new DashPlatformProtocol(null); +const client = new DAPIClient({ network: 'testnet' }); + +const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); +const type = 'domain'; +const limit = 1; +client.platform.getDataContract(contractId).then((contractResponse) => { + dpp.dataContract + .createFromBuffer(contractResponse.getDataContract()) + .then((contract) => { + // Get document(s) + client.platform + .getDocuments(contractId, type, { + limit, + }) + .then((response) => { + for (const document of response.documents) { + const doc = dpp.document.createExtendedDocumentFromDocumentBuffer( + document, + type, + contract, + ); + console.log(doc.toJSON()); + } + }); + }); +}); +``` +::: -**Example Request and Response** - -::::{tab-set} -:::{tab-item} JavaScript (dapi-client) -:sync: js-dapi-client +:::{tab-item} JavaScript (dapi-grpc) +:sync: js-dapi-grpc ```javascript -const DAPIClient = require('@dashevo/dapi-client'); const { - default: loadDpp, - DashPlatformProtocol, - Identifier, -} = require('@dashevo/wasm-dpp'); + v0: { PlatformPromiseClient, GetDataContractRequest, GetDocumentsRequest }, +} = require('@dashevo/dapi-grpc'); +const { default: loadDpp, DashPlatformProtocol, Identifier } = require('@dashevo/wasm-dpp'); loadDpp(); const dpp = new DashPlatformProtocol(null); -const client = new DAPIClient({ network: 'testnet' }); +const platformPromiseClient = new PlatformPromiseClient( + 'https://seed-1.testnet.networks.dash.org:1443', +); -const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); -client.platform.getIdentityContractNonce(identityId, contractId).then((response) => { - console.log(`Current identity contract nonce: ${response.getIdentityContractNonce()}`); -}); +const contractIdBuffer = Buffer.from(contractId); +const getDataContractRequest = new GetDataContractRequest(); +getDataContractRequest.setId(contractIdBuffer); + +platformPromiseClient + .getDataContract(getDataContractRequest) + .then((contractResponse) => { + dpp.dataContract.createFromBuffer(contractResponse.getDataContract()).then((contract) => { + // Get documents + const getDocumentsRequest = new GetDocumentsRequest(); + const type = 'domain'; + const limit = 10; + + getDocumentsRequest.setDataContractId(contractIdBuffer); + getDocumentsRequest.setDocumentType(type); + // getDocumentsRequest.setWhere(whereSerialized); + // getDocumentsRequest.setOrderBy(orderBySerialized); + getDocumentsRequest.setLimit(limit); + // getDocumentsRequest.setStartAfter(startAfter); + // getDocumentsRequest.setStartAt(startAt); + + platformPromiseClient.getDocuments(getDocumentsRequest).then((response) => { + for (const document of response.getDocuments().getDocumentsList()) { + const documentBuffer = Buffer.from(document); + const doc = dpp.document.createExtendedDocumentFromDocumentBuffer( + documentBuffer, + type, + contract, + ); + console.log(doc.toJSON()); + } + }); + }); + }) + .catch((e) => console.error(e)); ``` ::: -:::{tab-item} gRPCurl +:::{tab-item} Request (gRPCurl) :sync: grpcurl ```shell +# Request documents # `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + "data_contract_id":"5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "document_type":"domain", + "limit":1 } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityContractNonce + org.dash.platform.dapi.v0.Platform/getDocuments ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (dapi-client) +:::{tab-item} Response (JavaScript) :sync: js-dapi-client -```text -Current identity contract nonce: 0 +```json +{ + "$id":"Do3YtBPJG72zG4tCbN5VE8djJ6rLpvx7yvtMWEy89HC", + "$ownerId":"4pk6ZhgDtxn9yN2bbB6kfsYLRmUBH7PKUq275cjyzepT", + "label":"Chronic", + "normalizedLabel":"chr0n1c", + "normalizedParentDomainName":"dash", + "parentDomainName":"dash", + "preorderSalt":"1P9N5qv1Ww2xkv6/XXpsvymyGYychRsLXMhCqvW79Jo=", + "records":{ + "dashUniqueIdentityId":"OM4WaCQNLedQ0rpbl1UMTZhEbnVeMfL4941ZD08iyFw=" + }, + "subdomainRules":{ + "allowSubdomains":false + }, + "$revision":1, + "$createdAt":null, + "$updatedAt":null, + "$dataContract":{ + "$format_version":"0", + "id":"GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec", + "config":{ + "$format_version":"0", + "canBeDeleted":false, + "readonly":false, + "keepsHistory":false, + "documentsKeepHistoryContractDefault":false, + "documentsMutableContractDefault":true, + "requiresIdentityEncryptionBoundedKey":null, + "requiresIdentityDecryptionBoundedKey":null + }, + "version":1, + "ownerId":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", + "schemaDefs":null, + "documentSchemas":{ + "domain":[ + "Object" + ], + "preorder":[ + "Object" + ] + } + }, + "$type":"domain" +} ``` ::: @@ -917,12 +1177,16 @@ Current identity contract nonce: 0 ```json { "v0": { - "identityContractNonce": "3", + "documents": { + "documents": [ + "AAZ1S7dbhY4VJrSCvjs2Z1DIwa9Qt9MAyjbJdh7gPu6oDsGC/h1Ayf+ZzXp2zLWDF4XB2qMLWZ0brsAKo0r/0sYBAAcAAAGRivixugAAAZGK+LG6AAABkYr4sboAF2F1ZzI1LTEyMzQ1Njc4OTAxMjM0NTY3F2F1ZzI1LTEyMzQ1Njc4OTAxMjM0NTY3AQRkYXNoBGRhc2gAIQEOwYL+HUDJ/5nNenbMtYMXhcHaowtZnRuuwAqjSv/SxgEA" + ] + }, "metadata": { - "height": "5986", - "coreChainLockedHeight": 1097381, + "height": "5991", + "coreChainLockedHeight": 1097384, "epoch": 1170, - "timeMs": "1725566939334", + "timeMs": "1725567845055", "protocolVersion": 1, "chainId": "dash-testnet-51" } @@ -932,134 +1196,176 @@ Current identity contract nonce: 0 ::: :::: -### getIdentityKeys +## Identity Endpoints -**Returns**: Keys for an [Identity](../explanations/identity.md). +### getIdentity +**Returns**: [Identity](../explanations/identity.md) information for the requested identity **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `identity_td` | String | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) -| `request_type` | [KeyRequestType](#request-types) | Yes | Request all keys (`all_keys`), specific keys (`specific_keys`), search for keys (`search_key`) -| `limit` | Integer | Yes | The maximum number of revisions to return | -| `offset` | Integer | Yes | The offset of the first revision to return | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity - -#### Request Types - -**All keys** - -To request all keys for an identity, use the `all_keys` request type: - -```json -"all_keys": {} -``` - -**Specific keys** - -To request specific keys for an identity, use the `specific_keys` request type where `key_ids` is an array containing the key IDs to request: +| Name | Type | Required | Description | +| ------- | ------- | -------- | --------------------------------------------------------------------- | +| `id` | Bytes | Yes | An identity `id`
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity. The data requested will be encoded as part of the proof in the response.| -```json -"specific_keys": { - "key_ids": [ - 1 - ] -} -``` +**Example Request and Response** -**Search keys** +::::{tab-set} +:::{tab-item} JavaScript (dapi-client) +:sync: js-dapi-client +```javascript +const DAPIClient = require('@dashevo/dapi-client'); +const { + default: loadDpp, + DashPlatformProtocol, + Identifier, +} = require('@dashevo/wasm-dpp'); -To search for identity keys, use the `search_keys` request type. The options for `security_Level_map` are "CURRENT_KEY_OF_KIND_REQUEST" and "ALL_KEYS_OF_KIND_REQUEST": +loadDpp(); +const dpp = new DashPlatformProtocol(); +const client = new DAPIClient({ network: 'testnet' }); -```json -"search_key": { - "purpose_map": { - "0": { - "security_level_map": { - "0": "CURRENT_KEY_OF_KIND_REQUEST" - } - } - } -} +const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); +client.platform.getIdentity(identityId).then((response) => { + const identity = dpp.identity.createFromBuffer(response.getIdentity()); + console.log(identity.toJSON()); +}); ``` +::: -#### Example Request and Response - -::::{tab-set} -:::{tab-item} gRPCurl (All keys) +:::{tab-item} JavaScript (dapi-grpc) +:sync: js-dapi-grpc +```javascript +const { + v0: { PlatformPromiseClient, GetIdentityRequest }, +} = require('@dashevo/dapi-grpc'); +const { + default: loadDpp, + DashPlatformProtocol, + Identifier, +} = require('@dashevo/wasm-dpp'); -Request all identity keys +loadDpp(); +const dpp = new DashPlatformProtocol(null); +const platformPromiseClient = new PlatformPromiseClient( + 'https://seed-1.testnet.networks.dash.org:1443', +); -Note: `identityId` must be represented in base64 +const id = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); +const idBuffer = Buffer.from(id); +const getIdentityRequest = new GetIdentityRequest(); +getIdentityRequest.setId(idBuffer); +getIdentityRequest.setProve(false); -```shell -grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", - "request_type": { - "allKeys": {} - } - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityKeys +platformPromiseClient + .getIdentity(getIdentityRequest) + .then((response) => { + const identity = dpp.identity.createFromBuffer(response.getIdentity()); + console.dir(identity.toJSON()); + }) + .catch((e) => console.error(e)); ``` ::: -:::{tab-item} gRPCurl (Specific keys) - -Request specific keys - -Note: `identityId` must be represented in base64 +:::{tab-item} gRPCurl +:sync: grpcurl ```shell +# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", - "request_type": { - "specificKeys": { - "keyIds": [ - 1 - ] - } - }, - "limit": 1 + "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityKeys + org.dash.platform.dapi.v0.Platform/getIdentity ``` ::: +:::: -:::{tab-item} gRPCurl (Search keys) +::::{tab-set} +:::{tab-item} Response (JavaScript) +:sync: js-dapi-client +```json +{ + "$version":"0", + "id":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", + "publicKeys":[ + { + "$version":"0", + "id":0, + "purpose":0, + "securityLevel":0, + "contractBounds":null, + "type":0, + "readOnly":false, + "data":"Asi0dHtSjKxf3femzGNwLuBO19EzKQTghRA0PqANzlRq", + "disabledAt":null + }, + { + "$version":"0", + "id":1, + "purpose":0, + "securityLevel":2, + "contractBounds":null, + "type":0, + "readOnly":false, + "data":"AgHuKPhPVIU5BWfpOcK1hgELY6aeySyrU13JaoxxkTYC", + "disabledAt":null + } + ], + "balance":17912102140, + "revision":0 +} +``` +::: -Search keys +:::{tab-item} Response (gRPCurl) +:sync: grpcurl +```json +{ + "v0": { + "identity": "AB8VEmymhcW7r01Ka36+WtMlOruBGrE3Ulr0sTsCo5scBAAAAAAAAAAAIQMSQ7bd3xPfA+9xn2+FLl/AJrQTEhdW/OUafgjhbjs6qwABAAEAAgAAACED8nl3p8oFHACE5DGvv8Y9sBxWEVPLpUDUlSD7yICx0OoAAgACAAEAAAAhA9BQqn5pbKnveG+CTGpr+sheSghjJFEUYpm//gO1HPa1AAMAAwMBAAAAIQK7PbawzDv5oNWL3icaXEeAnv5xigN0gUMXRVzn6VgPQwD8J+gRAgA=", + "metadata": { + "height": "5986", + "coreChainLockedHeight": 1097381, + "epoch": 1170, + "timeMs": "1725566939334", + "protocolVersion": 1, + "chainId": "dash-testnet-51" + } + } +} +``` -Note: `identityId` must be represented in base64 +:::: + +### getIdentityBalance + +**Returns**: Credit balance for the requested [Identity](../explanations/identity.md) + +**Parameters**: + +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl +:sync: grpcurl ```shell +# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", - "request_type": { - "search_key": { - "purpose_map": { - "0": { - "security_level_map": { - "0": "CURRENT_KEY_OF_KIND_REQUEST" - } - } - } - } - }, - "limit": 1 + "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityKeys + org.dash.platform.dapi.v0.Platform/getIdentityBalance ``` ::: :::: @@ -1067,18 +1373,10 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::::{tab-set} :::{tab-item} Response (gRPCurl) :sync: grpcurl -All keys ```json { "v0": { - "keys": { - "keysBytes": [ - "AAAAAAAAACEDEkO23d8T3wPvcZ9vhS5fwCa0ExIXVvzlGn4I4W47OqsA", - "AAEAAgAAACED8nl3p8oFHACE5DGvv8Y9sBxWEVPLpUDUlSD7yICx0OoA", - "AAIAAQAAACED0FCqfmlsqe94b4JMamv6yF5KCGMkURRimb/+A7Uc9rUA", - "AAMDAQAAACECuz22sMw7+aDVi94nGlxHgJ7+cYoDdIFDF0Vc5+lYD0MA" - ] - }, + "balance": "669520130", "metadata": { "height": "5986", "coreChainLockedHeight": 1097381, @@ -1093,41 +1391,20 @@ All keys ::: :::: -### getIdentityNonce +### getIdentityBalanceAndRevision -**Returns**: Current nonce for the requested [Identity](../explanations/identity.md) +**Returns**: Credit balance and identity revision for the requested [Identity](../explanations/identity.md) **Parameters**: | Name | Type | Required | Description | | ------- | ------- | -------- | ------------ | -| `identity_id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity nonce +| `id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity **Example Request and Response** ::::{tab-set} -:::{tab-item} JavaScript (dapi-client) -:sync: js-dapi-client -```javascript -const DAPIClient = require('@dashevo/dapi-client'); -const { - default: loadDpp, - DashPlatformProtocol, - Identifier, -} = require('@dashevo/wasm-dpp'); - -loadDpp(); -const dpp = new DashPlatformProtocol(null); -const client = new DAPIClient({ network: 'testnet' }); - -const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); -client.platform.getIdentityNonce(identityId).then((response) => { - console.log(`Current identity nonce: ${response.getIdentityNonce()}`); -}); -``` -::: - :::{tab-item} gRPCurl :sync: grpcurl ```shell @@ -1135,34 +1412,29 @@ client.platform.getIdentityNonce(identityId).then((response) => { grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentityNonce + org.dash.platform.dapi.v0.Platform/getIdentityBalanceAndRevision ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (dapi-client) -:sync: js-dapi-client -```text -Current identity nonce: 0 -``` -::: - :::{tab-item} Response (gRPCurl) :sync: grpcurl ```json { "v0": { - "identityNonce": "3", + "balanceAndRevision": { + "balance": "669520130" + }, "metadata": { - "height": "5990", - "coreChainLockedHeight": 1097384, + "height": "5986", + "coreChainLockedHeight": 1097381, "epoch": 1170, - "timeMs": "1725567663863", + "timeMs": "1725566939334", "protocolVersion": 1, "chainId": "dash-testnet-51" } @@ -1172,114 +1444,103 @@ Current identity nonce: 0 ::: :::: -### getIdentitiesBalances +### getIdentityByNonUniquePublicKeyHash -Retrieves the balances for a list of identities. +:::{versionadded} 2.0.0 +::: -**Returns**: A list of identities with their corresponding balances or a cryptographic proof. +**Returns**: One or more [identities](../explanations/identity.md) associated with a public key +hash, including non-unique masternode keys. + +:::{note} +Unlike [`getIdentityByPublicKeyHash`](#getidentitybypublickeyhash), this endpoint supports public +key hashes that may be associated with multiple identities, such as masternode voting keys. Use the +`start_after` parameter to paginate through results. +::: **Parameters**: -| Name | Type | Required | Description | -|-----------|---------|----------|----------------------------------------------------------| -| `ids` | Array | No | An array of identity IDs for which balances are requested
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | -| `prove` | Boolean | No | Set to `true` to receive a proof containing the requested balances | +| Name | Type | Required | Description | +| ---------------- | ------ | -------- | ----------- | +| `public_key_hash`| Bytes | Yes | Public key hash (sha256-ripemd160) to search for | +| `start_after` | Bytes | No | Identity ID to start after (for pagination) | +| `prove` | Boolean| No | Set to `true` to receive a proof that contains the requested identity | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl +:sync: grpcurl ```shell +# `public_key_hash` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "ids": [ - "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=","dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" - ], - "prove": false + "public_key_hash": "uNFZGqdNRA4K+cC+FsVbvBQYR/c=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentitiesBalances + org.dash.platform.dapi.v0.Platform/getIdentityByNonUniquePublicKeyHash ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (gRPCurl) +:::{tab-item} Response (identity) ```json { "v0": { - "identitiesBalances": { - "entries": [ - { - "identity_id": "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=", - "balance": 1000000 - }, - { - "identity_id": "dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=", - "balance": 2500000 - } - ] + "identity": { + "identity": "ADASwZuY7AAzrds2zWS39RBnDyo1GkMEtfaZQUQobv2sAgAAAAAAAAAAIQCgUViOvLoIUc3Ibd9YqICX+1+xQz+fdYxRkyZPslTrBzQABAAEAAgAAACECA+Zn..." }, "metadata": { - "height": "13621", - "coreChainLockedHeight": 1105397, - "epoch": 1482, - "timeMs": "1726691577244", - "protocolVersion": 3, - "chainId": "dash-testnet-51" + "height": "7242", + "coreChainLockedHeight": 927815, + "epoch": 855, + "timeMs": "1702012386543", + "protocolVersion": 1, + "chainId": "dash-testnet-37" } } } ``` ::: -:::: - -### getIdentitiesContractKeys -**Returns**: Keys associated to a specific contract for multiple [Identities](../explanations/identity.md). +:::: -**Parameters**: +### getIdentityByPublicKeyHash -| Name | Type | Required | Description | -|----------------------|-------------------------|----------|-------------| -| `identities_ids` | Array | Yes | An array of identity IDs
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | -| `contract_id` | String | Yes | The ID of the contract | -| `document_type_name` | String | No | Name of the document type | -| `purposes` | Array of [KeyPurpose](#key-purposes) | No | Array of purposes for which keys are requested | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity keys | +**Returns**: An [identity](../explanations/identity.md) associated with the provided public key hash -#### Key Purposes +:::{note} +This endpoint only works for unique keys. Since masternode keys do not have to be unique +(e.g., voting keys), some masternode identities cannot be retrieved using this endpoint. See +[`getIdentityByNonUniquePublicKeyHash`](#getidentitybynonuniquepublickeyhash) for masternode +identities. +::: -**Key Purposes** define the intent of usage for each key. Here are the available purposes: +**Parameters**: -- `AUTHENTICATION` - Keys used for authentication purposes. -- `ENCRYPTION` - Keys used for encrypting data. -- `DECRYPTION` - Keys used for decrypting data. -- `TRANSFER` - Keys used for transferring assets. -- `VOTING` - Keys used for voting mechanisms. +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `public_key_hash` | Bytes | Yes | Public key hash (sha256-ripemd160) of identity public key +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity -#### Example Request and Response +**Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl +:sync: grpcurl ```shell -# Request identity keys associated with the specified contract -# `identities_ids` and `contract_id` must be represented in base64 +# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "identities_ids": [ - "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", - "NBgQk65dTNttDYDGLZNLrb1QEAWB91jqkqXtK1KU4Dc=" - ], - "purposes": [], - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + "public_key_hash": "uNFZGqdNRA4K+cC+FsVbvBQYR/c=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getIdentitiesContractKeys + org.dash.platform.dapi.v0.Platform/getIdentityByPublicKeyHash ``` ::: :::: @@ -1290,14 +1551,14 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "identitiesKeys": {}, + "identity": "ADASwZuY7AAzrds2zWS39RBnDyo1GkMEtfaZQUQobv2sAgAAAAAAAAAAIQLItHR7UoysX933psxjcC7gTtfRMykE4IUQND6gDc5UagABAAEAAgAAACECAe4o+E9UhTkFZ+k5wrWGAQtjpp7JLKtTXclqjHGRNgIA/QAAAAQ8fEg8AA==", "metadata": { - "height": "5990", - "coreChainLockedHeight": 1097384, - "epoch": 1170, - "timeMs": "1725567663863", + "height": "6870", + "coreChainLockedHeight": 927094, + "epoch": 851, + "timeMs": "1701985137472", "protocolVersion": 1, - "chainId": "dash-testnet-51" + "chainId": "dash-testnet-37" } } } @@ -1305,15 +1566,17 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getDataContract +### getIdentityContractNonce + +**Returns**: Current contract nonce for the requested [Identity](../explanations/identity.md) -**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contract **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | -------------------------------------------------------------------------- | -| `id` | Bytes | Yes | A data contract `id` | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contract. The data requested will be encoded as part of the proof in the response. | +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `identity_id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) +| `contract_id` | Bytes | Yes | A contract ID +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity contract nonce **Example Request and Response** @@ -1332,43 +1595,14 @@ loadDpp(); const dpp = new DashPlatformProtocol(null); const client = new DAPIClient({ network: 'testnet' }); +const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); -client.platform.getDataContract(contractId).then((response) => { - dpp.dataContract.createFromBuffer(response.getDataContract()).then((dataContract) => { - console.dir(dataContract.toJSON(), { depth: 10 }); - }); +client.platform.getIdentityContractNonce(identityId, contractId).then((response) => { + console.log(`Current identity contract nonce: ${response.getIdentityContractNonce()}`); }); ``` ::: -:::{tab-item} JavaScript (dapi-grpc) -:sync: js-dapi-grpc -```javascript -const { - v0: { PlatformPromiseClient, GetDataContractRequest }, -} = require('@dashevo/dapi-grpc'); -const { default: loadDpp, DashPlatformProtocol, Identifier } = require('@dashevo/wasm-dpp'); - -const platformPromiseClient = new PlatformPromiseClient( - 'https://seed-1.testnet.networks.dash.org:1443', -); - -const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); -const contractIdBuffer = Buffer.from(contractId); -const getDataContractRequest = new GetDataContractRequest(); -getDataContractRequest.setId(contractIdBuffer); - -platformPromiseClient - .getDataContract(getDataContractRequest) - .then((response) => { - dpp.dataContract.createFromBuffer(response.getDataContract()).then((dataContract) => { - console.dir(dataContract.toJSON(), { depth: 10 }); - }); - }) - .catch((e) => console.error(e)); -``` -::: - :::{tab-item} gRPCurl :sync: grpcurl ```shell @@ -1376,201 +1610,21 @@ platformPromiseClient grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "id":"5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" } }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getDataContract -``` -::: -:::: - -::::{tab-set} -:::{tab-item} Response (JavaScript) -:sync: js-dapi-client -```json -{ - "$format_version":"0", - "id":"GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec", - "config":{ - "$format_version":"0", - "canBeDeleted":false, - "readonly":false, - "keepsHistory":false, - "documentsKeepHistoryContractDefault":false, - "documentsMutableContractDefault":true, - "requiresIdentityEncryptionBoundedKey":null, - "requiresIdentityDecryptionBoundedKey":null - }, - "version":1, - "ownerId":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", - "schemaDefs":null, - "documentSchemas":{ - "domain":{ - "type":"object", - "indices":[ - { - "name":"parentNameAndLabel", - "properties":[ - { - "normalizedParentDomainName":"asc" - }, - { - "normalizedLabel":"asc" - } - ], - "unique":true - }, - { - "name":"dashIdentityId", - "properties":[ - { - "records.dashUniqueIdentityId":"asc" - } - ], - "unique":true - }, - { - "name":"dashAlias", - "properties":[ - { - "records.dashAliasIdentityId":"asc" - } - ] - } - ], - "properties":{ - "label":{ - "type":"string", - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$", - "minLength":3, - "maxLength":63, - "position":0, - "description":"Domain label. e.g. 'Bob'." - }, - "normalizedLabel":{ - "type":"string", - "pattern":"^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-]{0,61}[a-hj-km-np-z0-9]$", - "maxLength":63, - "position":1, - "description":"`Domain label converted to lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'b0b'`", - "$comment":"Must be equal to the label in lowercase. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\"." - }, - "parentDomainName":{ - "type":"string", - "pattern":"^$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$", - "minLength":0, - "maxLength":63, - "position":2, - "description":"A full parent domain name. e.g. 'dash'." - }, - "normalizedParentDomainName":{ - "type":"string", - "pattern":"^$|^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-\\.]{0,61}[a-hj-km-np-z0-9]$", - "minLength":0, - "maxLength":63, - "position":3, - "description":"`A parent domain name in lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'dash'`", - "$comment":"Must either be equal to an existing domain or empty to create a top level domain. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\". Only the data contract owner can create top level domains." - }, - "preorderSalt":{ - "type":"array", - "byteArray":true, - "minItems":32, - "maxItems":32, - "position":4, - "description":"Salt used in the preorder document" - }, - "records":{ - "type":"object", - "properties":{ - "dashUniqueIdentityId":{ - "type":"array", - "byteArray":true, - "minItems":32, - "maxItems":32, - "position":0, - "contentMediaType":"application/x.dash.dpp.identifier", - "description":"Identity ID to be used to create the primary name the Identity", - "$comment":"Must be equal to the document owner" - }, - "dashAliasIdentityId":{ - "type":"array", - "byteArray":true, - "minItems":32, - "maxItems":32, - "position":1, - "contentMediaType":"application/x.dash.dpp.identifier", - "description":"Identity ID to be used to create alias names for the Identity", - "$comment":"Must be equal to the document owner" - } - }, - "minProperties":1, - "maxProperties":1, - "position":5, - "additionalProperties":false, - "$comment":"Constraint with max and min properties ensure that only one identity record is used - either a `dashUniqueIdentityId` or a `dashAliasIdentityId`" - }, - "subdomainRules":{ - "type":"object", - "properties":{ - "allowSubdomains":{ - "type":"boolean", - "description":"This option defines who can create subdomains: true - anyone; false - only the domain owner", - "$comment":"Only the domain owner is allowed to create subdomains for non top-level domains", - "position":0 - } - }, - "position":6, - "description":"Subdomain rules allow domain owners to define rules for subdomains", - "additionalProperties":false, - "required":[ - "allowSubdomains" - ] - } - }, - "required":[ - "label", - "normalizedLabel", - "normalizedParentDomainName", - "preorderSalt", - "records", - "subdomainRules" - ], - "additionalProperties":false, - "$comment":"In order to register a domain you need to create a preorder. The preorder step is needed to prevent man-in-the-middle attacks. normalizedLabel + '.' + normalizedParentDomain must not be longer than 253 chars length as defined by RFC 1035. Domain documents are immutable: modification and deletion are restricted" - }, - "preorder":{ - "type":"object", - "indices":[ - { - "name":"saltedHash", - "properties":[ - { - "saltedDomainHash":"asc" - } - ], - "unique":true - } - ], - "properties":{ - "saltedDomainHash":{ - "type":"array", - "byteArray":true, - "minItems":32, - "maxItems":32, - "position":0, - "description":"Double sha-256 of the concatenation of a 32 byte random salt and a normalized domain name" - } - }, - "required":[ - "saltedDomainHash" - ], - "additionalProperties":false, - "$comment":"Preorder documents are immutable: modification and deletion are restricted" - } - } -} + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getIdentityContractNonce +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (dapi-client) +:sync: js-dapi-client +```text +Current identity contract nonce: 0 ``` ::: @@ -1579,12 +1633,12 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "dataContract": "AOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAQAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIGZG9tYWluFgsSEGRvY3VtZW50c011dGFibGUTABIMY2FuQmVEZWxldGVkEwESDHRyYW5zZmVyYWJsZQIBEgl0cmFkZU1vZGUCARIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQIWBBIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwESCWNvbnRlc3RlZBYDEgxmaWVsZE1hdGNoZXMVARYCEgVmaWVsZBIPbm9ybWFsaXplZExhYmVsEgxyZWdleFBhdHRlcm4SE15bYS16QS1aMDEtXXszLDE5fSQSCnJlc29sdXRpb24CABILZGVzY3JpcHRpb24SqklmIHRoZSBub3JtYWxpemVkIGxhYmVsIHBhcnQgb2YgdGhpcyBpbmRleCBpcyBsZXNzIHRoYW4gMjAgY2hhcmFjdGVycyAoYWxsIGFscGhhYmV0IGEteiwgQS1aLCAwLCAxLCBhbmQgLSkgdGhlbiBhIG1hc3Rlcm5vZGUgdm90ZSBjb250ZXN0IHRha2VzIHBsYWNlIHRvIGdpdmUgb3V0IHRoZSBuYW1lFgMSBG5hbWUSCmlkZW50aXR5SWQSDm51bGxTZWFyY2hhYmxlEwASCnByb3BlcnRpZXMVARYBEhByZWNvcmRzLmlkZW50aXR5EgNhc2MSCnByb3BlcnRpZXMWBxIFbGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEipeW2EtekEtWjAtOV1bYS16QS1aMC05LV17MCw2MX1bYS16QS1aMC05XSQSCW1pbkxlbmd0aAIDEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SGURvbWFpbiBsYWJlbC4gZS5nLiAnQm9iJy4SD25vcm1hbGl6ZWRMYWJlbBYGEgR0eXBlEgZzdHJpbmcSB3BhdHRlcm4SPF5bYS1oai1rbS1ucC16MC05XVthLWhqLWttLW5wLXowLTktXXswLDYxfVthLWhqLWttLW5wLXowLTldJBIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgESC2Rlc2NyaXB0aW9uEqNEb21haW4gbGFiZWwgY29udmVydGVkIHRvIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdiMGInEggkY29tbWVudBJcTXVzdCBiZSBlcXVhbCB0byB0aGUgbGFiZWwgaW4gbG93ZXJjYXNlLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4SEHBhcmVudERvbWFpbk5hbWUWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEi1eJHxeW2EtekEtWjAtOV1bYS16QS1aMC05LV17MCw2MX1bYS16QS1aMC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAhILZGVzY3JpcHRpb24SJ0EgZnVsbCBwYXJlbnQgZG9tYWluIG5hbWUuIGUuZy4gJ2Rhc2gnLhIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUWBxIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEkFeJHxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LVwuXXswLDYxfVthLWhqLWttLW5wLXowLTldJBIJbWluTGVuZ3RoAgASCW1heExlbmd0aAI/Eghwb3NpdGlvbgIDEgtkZXNjcmlwdGlvbhKiQSBwYXJlbnQgZG9tYWluIG5hbWUgaW4gbG93ZXJjYXNlIGZvciBjYXNlLWluc2Vuc2l0aXZlIHVuaXF1ZW5lc3MgdmFsaWRhdGlvbi4gIm8iLCAiaSIgYW5kICJsIiByZXBsYWNlZCB3aXRoICIwIiBhbmQgIjEiIHRvIG1pdGlnYXRlIGhvbW9ncmFwaCBhdHRhY2suIGUuZy4gJ2Rhc2gnEggkY29tbWVudBLATXVzdCBlaXRoZXIgYmUgZXF1YWwgdG8gYW4gZXhpc3RpbmcgZG9tYWluIG9yIGVtcHR5IHRvIGNyZWF0ZSBhIHRvcCBsZXZlbCBkb21haW4uICJvIiwgImkiIGFuZCAibCIgbXVzdCBiZSByZXBsYWNlZCB3aXRoICIwIiBhbmQgIjEiLiBPbmx5IHRoZSBkYXRhIGNvbnRyYWN0IG93bmVyIGNhbiBjcmVhdGUgdG9wIGxldmVsIGRvbWFpbnMuEgxwcmVvcmRlclNhbHQWBhIEdHlwZRIFYXJyYXkSCWJ5dGVBcnJheRMBEghtaW5JdGVtcwIgEghtYXhJdGVtcwIgEghwb3NpdGlvbgIEEgtkZXNjcmlwdGlvbhIiU2FsdCB1c2VkIGluIHRoZSBwcmVvcmRlciBkb2N1bWVudBIHcmVjb3JkcxYFEgR0eXBlEgZvYmplY3QSCnByb3BlcnRpZXMWARIIaWRlbnRpdHkWBxIEdHlwZRIFYXJyYXkSCWJ5dGVBcnJheRMBEghtaW5JdGVtcwIgEghtYXhJdGVtcwIgEghwb3NpdGlvbgIBEhBjb250ZW50TWVkaWFUeXBlEiFhcHBsaWNhdGlvbi94LmRhc2guZHBwLmlkZW50aWZpZXISC2Rlc2NyaXB0aW9uEjFJZGVudGlmaWVyIG5hbWUgcmVjb3JkIHRoYXQgcmVmZXJzIHRvIGFuIElkZW50aXR5Eg1taW5Qcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQkSCiRjcmVhdGVkQXQSCiR1cGRhdGVkQXQSDiR0cmFuc2ZlcnJlZEF0EgVsYWJlbBIPbm9ybWFsaXplZExhYmVsEhpub3JtYWxpemVkUGFyZW50RG9tYWluTmFtZRIMcHJlb3JkZXJTYWx0EgdyZWNvcmRzEg5zdWJkb21haW5SdWxlcxIJdHJhbnNpZW50FQESDHByZW9yZGVyU2FsdBIUYWRkaXRpb25hbFByb3BlcnRpZXMTABIIJGNvbW1lbnQS+wE3SW4gb3JkZXIgdG8gcmVnaXN0ZXIgYSBkb21haW4geW91IG5lZWQgdG8gY3JlYXRlIGEgcHJlb3JkZXIuIFRoZSBwcmVvcmRlciBzdGVwIGlzIG5lZWRlZCB0byBwcmV2ZW50IG1hbi1pbi10aGUtbWlkZGxlIGF0dGFja3MuIG5vcm1hbGl6ZWRMYWJlbCArICcuJyArIG5vcm1hbGl6ZWRQYXJlbnREb21haW4gbXVzdCBub3QgYmUgbG9uZ2VyIHRoYW4gMjUzIGNoYXJzIGxlbmd0aCBhcyBkZWZpbmVkIGJ5IFJGQyAxMDM1LiBEb21haW4gZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQIcHJlb3JkZXIWCBIQZG9jdW1lbnRzTXV0YWJsZRMAEgxjYW5CZURlbGV0ZWQTARIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQEWAxIEbmFtZRIKc2FsdGVkSGFzaBIKcHJvcGVydGllcxUBFgESEHNhbHRlZERvbWFpbkhhc2gSA2FzYxIGdW5pcXVlEwESCnByb3BlcnRpZXMWARIQc2FsdGVkRG9tYWluSGFzaBYGEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEllEb3VibGUgc2hhLTI1NiBvZiB0aGUgY29uY2F0ZW5hdGlvbiBvZiBhIDMyIGJ5dGUgcmFuZG9tIHNhbHQgYW5kIGEgbm9ybWFsaXplZCBkb21haW4gbmFtZRIIcmVxdWlyZWQVARIQc2FsdGVkRG9tYWluSGFzaBIUYWRkaXRpb25hbFByb3BlcnRpZXMTABIIJGNvbW1lbnQSSlByZW9yZGVyIGRvY3VtZW50cyBhcmUgaW1tdXRhYmxlOiBtb2RpZmljYXRpb24gYW5kIGRlbGV0aW9uIGFyZSByZXN0cmljdGVk", + "identityContractNonce": "3", "metadata": { - "height": "5990", - "coreChainLockedHeight": 1097384, + "height": "5986", + "coreChainLockedHeight": 1097381, "epoch": 1170, - "timeMs": "1725567663863", + "timeMs": "1725566939334", "protocolVersion": 1, "chainId": "dash-testnet-51" } @@ -1594,34 +1648,134 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getDataContracts +### getIdentityKeys -**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contracts +**Returns**: Keys for an [Identity](../explanations/identity.md). **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ----------------------------------------- | -| `ids` | Array | Yes | An array of data contract IDs | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contracts | +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `identity_td` | String | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) +| `request_type` | [KeyRequestType](#request-types) | Yes | Request all keys (`all_keys`), specific keys (`specific_keys`), search for keys (`search_key`) +| `limit` | Integer | Yes | The maximum number of revisions to return | +| `offset` | Integer | Yes | The offset of the first revision to return | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity -**Example Request and Response** +#### Request Types + +**All keys** + +To request all keys for an identity, use the `all_keys` request type: + +```json +"all_keys": {} +``` + +**Specific keys** + +To request specific keys for an identity, use the `specific_keys` request type where `key_ids` is an array containing the key IDs to request: + +```json +"specific_keys": { + "key_ids": [ + 1 + ] +} +``` + +**Search keys** + +To search for identity keys, use the `search_keys` request type. The options for `security_Level_map` are "CURRENT_KEY_OF_KIND_REQUEST" and "ALL_KEYS_OF_KIND_REQUEST": + +```json +"search_key": { + "purpose_map": { + "0": { + "security_level_map": { + "0": "CURRENT_KEY_OF_KIND_REQUEST" + } + } + } +} +``` + +#### Example Request and Response ::::{tab-set} -:::{tab-item} gRPCurl -:sync: grpcurl +:::{tab-item} gRPCurl (All keys) + +Request all identity keys + +Note: `identityId` must be represented in base64 + ```shell -# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "ids": [ - "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" - ] + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", + "request_type": { + "allKeys": {} + } } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getDataContracts + org.dash.platform.dapi.v0.Platform/getIdentityKeys +``` +::: +:::{tab-item} gRPCurl (Specific keys) + +Request specific keys + +Note: `identityId` must be represented in base64 + +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", + "request_type": { + "specificKeys": { + "keyIds": [ + 1 + ] + } + }, + "limit": 1 + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getIdentityKeys +``` +::: + +:::{tab-item} gRPCurl (Search keys) + +Search keys + +Note: `identityId` must be represented in base64 + +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", + "request_type": { + "search_key": { + "purpose_map": { + "0": { + "security_level_map": { + "0": "CURRENT_KEY_OF_KIND_REQUEST" + } + } + } + } + }, + "limit": 1 + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getIdentityKeys ``` ::: :::: @@ -1629,24 +1783,25 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::::{tab-set} :::{tab-item} Response (gRPCurl) :sync: grpcurl +All keys ```json { "v0": { - "dataContracts": { - "dataContractEntries": [ - { - "identifier": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "dataContract": "AOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAAABMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awAAgZkb21haW4WBhIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQMWAxIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwEWAxIEbmFtZRIOZGFzaElkZW50aXR5SWQSCnByb3BlcnRpZXMVARYBEhxyZWNvcmRzLmRhc2hVbmlxdWVJZGVudGl0eUlkEgNhc2MSBnVuaXF1ZRMBFgISBG5hbWUSCWRhc2hBbGlhcxIKcHJvcGVydGllcxUBFgESG3JlY29yZHMuZGFzaEFsaWFzSWRlbnRpdHlJZBIDYXNjEgpwcm9wZXJ0aWVzFgcSBWxhYmVsFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhIqXlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCAxIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEhlEb21haW4gbGFiZWwuIGUuZy4gJ0JvYicuEg9ub3JtYWxpemVkTGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEjxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LV17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1heExlbmd0aAI/Eghwb3NpdGlvbgIBEgtkZXNjcmlwdGlvbhKjRG9tYWluIGxhYmVsIGNvbnZlcnRlZCB0byBsb3dlcmNhc2UgZm9yIGNhc2UtaW5zZW5zaXRpdmUgdW5pcXVlbmVzcyB2YWxpZGF0aW9uLiAibyIsICJpIiBhbmQgImwiIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIgdG8gbWl0aWdhdGUgaG9tb2dyYXBoIGF0dGFjay4gZS5nLiAnYjBiJxIIJGNvbW1lbnQSXE11c3QgYmUgZXF1YWwgdG8gdGhlIGxhYmVsIGluIGxvd2VyY2FzZS4gIm8iLCAiaSIgYW5kICJsIiBtdXN0IGJlIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIuEhBwYXJlbnREb21haW5OYW1lFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhItXiR8XlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCABIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgISC2Rlc2NyaXB0aW9uEidBIGZ1bGwgcGFyZW50IGRvbWFpbiBuYW1lLiBlLmcuICdkYXNoJy4SGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lFgcSBHR5cGUSBnN0cmluZxIHcGF0dGVybhJBXiR8XlthLWhqLWttLW5wLXowLTldW2EtaGota20tbnAtejAtOS1cLl17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAxILZGVzY3JpcHRpb24SokEgcGFyZW50IGRvbWFpbiBuYW1lIGluIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdkYXNoJxIIJGNvbW1lbnQSwE11c3QgZWl0aGVyIGJlIGVxdWFsIHRvIGFuIGV4aXN0aW5nIGRvbWFpbiBvciBlbXB0eSB0byBjcmVhdGUgYSB0b3AgbGV2ZWwgZG9tYWluLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4gT25seSB0aGUgZGF0YSBjb250cmFjdCBvd25lciBjYW4gY3JlYXRlIHRvcCBsZXZlbCBkb21haW5zLhIMcHJlb3JkZXJTYWx0FgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CBBILZGVzY3JpcHRpb24SIlNhbHQgdXNlZCBpbiB0aGUgcHJlb3JkZXIgZG9jdW1lbnQSB3JlY29yZHMWBxIEdHlwZRIGb2JqZWN0Egpwcm9wZXJ0aWVzFgISFGRhc2hVbmlxdWVJZGVudGl0eUlkFggSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABIQY29udGVudE1lZGlhVHlwZRIhYXBwbGljYXRpb24veC5kYXNoLmRwcC5pZGVudGlmaWVyEgtkZXNjcmlwdGlvbhI+SWRlbnRpdHkgSUQgdG8gYmUgdXNlZCB0byBjcmVhdGUgdGhlIHByaW1hcnkgbmFtZSB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchITZGFzaEFsaWFzSWRlbnRpdHlJZBYIEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgESEGNvbnRlbnRNZWRpYVR5cGUSIWFwcGxpY2F0aW9uL3guZGFzaC5kcHAuaWRlbnRpZmllchILZGVzY3JpcHRpb24SPUlkZW50aXR5IElEIHRvIGJlIHVzZWQgdG8gY3JlYXRlIGFsaWFzIG5hbWVzIGZvciB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchINbWluUHJvcGVydGllcwIBEg1tYXhQcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASCCRjb21tZW50EpBDb25zdHJhaW50IHdpdGggbWF4IGFuZCBtaW4gcHJvcGVydGllcyBlbnN1cmUgdGhhdCBvbmx5IG9uZSBpZGVudGl0eSByZWNvcmQgaXMgdXNlZCAtIGVpdGhlciBhIGBkYXNoVW5pcXVlSWRlbnRpdHlJZGAgb3IgYSBgZGFzaEFsaWFzSWRlbnRpdHlJZGASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQYSBWxhYmVsEg9ub3JtYWxpemVkTGFiZWwSGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lEgxwcmVvcmRlclNhbHQSB3JlY29yZHMSDnN1YmRvbWFpblJ1bGVzEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBL7ATdJbiBvcmRlciB0byByZWdpc3RlciBhIGRvbWFpbiB5b3UgbmVlZCB0byBjcmVhdGUgYSBwcmVvcmRlci4gVGhlIHByZW9yZGVyIHN0ZXAgaXMgbmVlZGVkIHRvIHByZXZlbnQgbWFuLWluLXRoZS1taWRkbGUgYXR0YWNrcy4gbm9ybWFsaXplZExhYmVsICsgJy4nICsgbm9ybWFsaXplZFBhcmVudERvbWFpbiBtdXN0IG5vdCBiZSBsb25nZXIgdGhhbiAyNTMgY2hhcnMgbGVuZ3RoIGFzIGRlZmluZWQgYnkgUkZDIDEwMzUuIERvbWFpbiBkb2N1bWVudHMgYXJlIGltbXV0YWJsZTogbW9kaWZpY2F0aW9uIGFuZCBkZWxldGlvbiBhcmUgcmVzdHJpY3RlZAhwcmVvcmRlchYGEgR0eXBlEgZvYmplY3QSB2luZGljZXMVARYDEgRuYW1lEgpzYWx0ZWRIYXNoEgpwcm9wZXJ0aWVzFQEWARIQc2FsdGVkRG9tYWluSGFzaBIDYXNjEgZ1bmlxdWUTARIKcHJvcGVydGllcxYBEhBzYWx0ZWREb21haW5IYXNoFgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SWURvdWJsZSBzaGEtMjU2IG9mIHRoZSBjb25jYXRlbmF0aW9uIG9mIGEgMzIgYnl0ZSByYW5kb20gc2FsdCBhbmQgYSBub3JtYWxpemVkIGRvbWFpbiBuYW1lEghyZXF1aXJlZBUBEhBzYWx0ZWREb21haW5IYXNoEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBJKUHJlb3JkZXIgZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQ=" - } + "keys": { + "keysBytes": [ + "AAAAAAAAACEDEkO23d8T3wPvcZ9vhS5fwCa0ExIXVvzlGn4I4W47OqsA", + "AAEAAgAAACED8nl3p8oFHACE5DGvv8Y9sBxWEVPLpUDUlSD7yICx0OoA", + "AAIAAQAAACED0FCqfmlsqe94b4JMamv6yF5KCGMkURRimb/+A7Uc9rUA", + "AAMDAQAAACECuz22sMw7+aDVi94nGlxHgJ7+cYoDdIFDF0Vc5+lYD0MA" ] }, "metadata": { - "height": "6807", - "coreChainLockedHeight": 927014, - "epoch": 848, - "timeMs": "1701973925674", + "height": "5986", + "coreChainLockedHeight": 1097381, + "epoch": 1170, + "timeMs": "1725566939334", "protocolVersion": 1, - "chainId": "dash-testnet-37" + "chainId": "dash-testnet-51" } } } @@ -1654,18 +1809,16 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getDataContractHistory +### getIdentityNonce + +**Returns**: Current nonce for the requested [Identity](../explanations/identity.md) -**Returns**: [Data Contract](../explanations/platform-protocol-data-contract.md) information for the requested data contract **Parameters**: -| Name | Type | Required | Description | -| ------- | -------- | -------- | ---------------------------------------- | -| `id` | Bytes | Yes | A data contract `id` | -| `start_at_ms` | Integer | Yes | Request revisions starting at this timestamp | -| `limit` | Integer | Yes | The maximum number of revisions to return | -| `offset` | Integer | Yes | The offset of the first revision to return | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contract. The data requested will be encoded as part of the proof in the response.| +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `identity_id` | Bytes | Yes | An identity ID
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity nonce **Example Request and Response** @@ -1684,14 +1837,9 @@ loadDpp(); const dpp = new DashPlatformProtocol(null); const client = new DAPIClient({ network: 'testnet' }); -const contractId = Identifier.from('23iZPjG4ADx8CYGorW4yM8FUo1gihQL2fZszWLTMFyQf'); -client.platform.getDataContractHistory(contractId, 0, 2, 0).then((response) => { - for (const key in response.getDataContractHistory()) { - const revision = response.getDataContractHistory()[key]; - dpp.dataContract.createFromBuffer(revision).then((dataContract) => { - console.dir(dataContract.toJSON(), { depth: 10 }); - }); - } +const identityId = Identifier.from('36LGwPSXef8q8wpdnx4EdDeVNuqCYNAE9boDu5bxytsm'); +client.platform.getIdentityNonce(identityId).then((response) => { + console.log(`Current identity nonce: ${response.getIdentityNonce()}`); }); ``` ::: @@ -1699,116 +1847,104 @@ client.platform.getDataContractHistory(contractId, 0, 2, 0).then((response) => { :::{tab-item} gRPCurl :sync: grpcurl ```shell -# `id` must be represented in base64 +# `id` must be represented in base64 +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getIdentityNonce +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (dapi-client) +:sync: js-dapi-client +```text +Current identity nonce: 0 +``` +::: + +:::{tab-item} Response (gRPCurl) +:sync: grpcurl +```json +{ + "v0": { + "identityNonce": "3", + "metadata": { + "height": "5990", + "coreChainLockedHeight": 1097384, + "epoch": 1170, + "timeMs": "1725567663863", + "protocolVersion": 1, + "chainId": "dash-testnet-51" + } + } +} +``` +::: +:::: + +### getIdentitiesBalances + +Retrieves the balances for a list of identities. + +**Returns**: A list of identities with their corresponding balances or a cryptographic proof. + +**Parameters**: + +| Name | Type | Required | Description | +|-----------|---------|----------|----------------------------------------------------------| +| `ids` | Array | No | An array of identity IDs for which balances are requested
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | +| `prove` | Boolean | No | Set to `true` to receive a proof containing the requested balances | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl +```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "id":"D43WwBJeadt7AR8wRmcagPiCmi/YvDBHYwheFKzMfyw=", - "limit": 2, - "offset": 0, - "start_at_ms": 0, + "ids": [ + "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=","dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" + ], "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getDataContractHistory + org.dash.platform.dapi.v0.Platform/getIdentitiesBalances ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (JavaScript) -:sync: js-dapi-client -```json -{ - "$format_version":"0", - "id":"2ciAVGRuzogbR2NNtNfbn6YdW7BkLWntC7jrLNRMZN9n", - "config":{ - "$format_version":"0", - "canBeDeleted":false, - "readonly":false, - "keepsHistory":true, - "documentsKeepHistoryContractDefault":false, - "documentsMutableContractDefault":true, - "requiresIdentityEncryptionBoundedKey":null, - "requiresIdentityDecryptionBoundedKey":null - }, - "version":1, - "ownerId":"EB9eBUQxLjA7XGj71x3Msdd1uNmehKYZff3b6idhnTyV", - "schemaDefs":null, - "documentSchemas":{ - "note":{ - "type":"object", - "properties":{ - "message":{ - "type":"string", - "position":0 - } - }, - "additionalProperties":false - } - } -}, -{ - "$format_version":"0", - "id":"2ciAVGRuzogbR2NNtNfbn6YdW7BkLWntC7jrLNRMZN9n", - "config":{ - "$format_version":"0", - "canBeDeleted":false, - "readonly":false, - "keepsHistory":true, - "documentsKeepHistoryContractDefault":false, - "documentsMutableContractDefault":true, - "requiresIdentityEncryptionBoundedKey":null, - "requiresIdentityDecryptionBoundedKey":null - }, - "version":2, - "ownerId":"EB9eBUQxLjA7XGj71x3Msdd1uNmehKYZff3b6idhnTyV", - "schemaDefs":null, - "documentSchemas":{ - "note":{ - "type":"object", - "properties":{ - "message":{ - "type":"string", - "position":0 - }, - "author":{ - "type":"string", - "position":1 - } - }, - "additionalProperties":false - } - } -} -``` -::: - :::{tab-item} Response (gRPCurl) -:sync: grpcurl ```json { "v0": { - "dataContractHistory": { - "dataContractEntries": [ + "identitiesBalances": { + "entries": [ { - "date": "1701271990189", - "value": "ABgBjx2sR2xg0L+ti2CDLmGzmmI6g9+l/6SFwA8U3ybxAAAAAQABAAABw8GCMyj2ynyRr4i36i1KKHFYdYuPDVwKmo1jmEgT4zwAAQRub3RlFgMSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEgdtZXNzYWdlFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24DABIUYWRkaXRpb25hbFByb3BlcnRpZXMTAA==" + "identity_id": "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=", + "balance": 1000000 }, { - "date": "1701272469813", - "value": "ABgBjx2sR2xg0L+ti2CDLmGzmmI6g9+l/6SFwA8U3ybxAAAAAQABAAACw8GCMyj2ynyRr4i36i1KKHFYdYuPDVwKmo1jmEgT4zwAAQRub3RlFgMSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYCEgdtZXNzYWdlFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24CABIGYXV0aG9yFgISBHR5cGUSBnN0cmluZxIIcG9zaXRpb24CARIUYWRkaXRpb25hbFByb3BlcnRpZXMTAA==" + "identity_id": "dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=", + "balance": 2500000 } ] }, "metadata": { - "height": "6776", - "coreChainLockedHeight": 926975, - "epoch": 846, - "timeMs": "1701968396855", - "protocolVersion": 1, - "chainId": "dash-testnet-37" + "height": "13621", + "coreChainLockedHeight": 1105397, + "epoch": 1482, + "timeMs": "1726691577244", + "protocolVersion": 3, + "chainId": "dash-testnet-51" } } } @@ -1816,213 +1952,233 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getDocuments +### getIdentitiesContractKeys + +**Returns**: Keys associated to a specific contract for multiple [Identities](../explanations/identity.md). -**Returns**: [Document](../explanations/platform-protocol-document.md) information for the requested document(s) **Parameters**: -:::{note} -The `where`, `order_by`, `limit`, `start_at`, and `start_after` parameters must comply with the limits defined on the [Query Syntax](../reference/query-syntax.md) page. -::: +| Name | Type | Required | Description | +|----------------------|-------------------------|----------|-------------| +| `identities_ids` | Array | Yes | An array of identity IDs
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | +| `contract_id` | String | Yes | The ID of the contract | +| `document_type_name` | String | No | Name of the document type | +| `purposes` | Array of [KeyPurpose](#key-purposes) | No | Array of purposes for which keys are requested | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity keys | -| Name | Type | Required | Description | -| ----------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------ | -| `data_contract_id` | Bytes | Yes | A data contract `id` | -| `document_type` | String | Yes | A document type defined by the data contract (e.g. `preorder` or `domain` for the DPNS contract) | -| `where` \* | Bytes | No | Where clause to filter the results | -| `order_by` \* | Bytes | No | Sort records by the field(s) provided | -| `limit` | Integer | No | Maximum number of results to return | -| ---------- | | | | -| _One_ of the following: | | | | -| `start_at` | Integer | No | Return records beginning with the index provided | -| `start_after` | Integer | No | Return records beginning after the index provided | -| ---------- | | | | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested document(s). The data requested will be encoded as part of the proof in the response. | +#### Key Purposes -**Example Request and Response** +**Key Purposes** define the intent of usage for each key. Here are the available purposes: -::::{tab-set} -:::{tab-item} JavaScript (dapi-client) -:sync: js-dapi-client -```javascript -const DAPIClient = require('@dashevo/dapi-client'); -const { - default: loadDpp, - DashPlatformProtocol, - Identifier, -} = require('@dashevo/wasm-dpp'); +- `AUTHENTICATION` - Keys used for authentication purposes. +- `ENCRYPTION` - Keys used for encrypting data. +- `DECRYPTION` - Keys used for decrypting data. +- `TRANSFER` - Keys used for transferring assets. +- `VOTING` - Keys used for voting mechanisms. -loadDpp(); -const dpp = new DashPlatformProtocol(null); -const client = new DAPIClient({ network: 'testnet' }); +#### Example Request and Response -const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); -const type = 'domain'; -const limit = 1; -client.platform.getDataContract(contractId).then((contractResponse) => { - dpp.dataContract - .createFromBuffer(contractResponse.getDataContract()) - .then((contract) => { - // Get document(s) - client.platform - .getDocuments(contractId, type, { - limit, - }) - .then((response) => { - for (const document of response.documents) { - const doc = dpp.document.createExtendedDocumentFromDocumentBuffer( - document, - type, - contract, - ); - console.log(doc.toJSON()); - } - }); - }); -}); +::::{tab-set} +:::{tab-item} gRPCurl +```shell +# Request identity keys associated with the specified contract +# `identities_ids` and `contract_id` must be represented in base64 +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "identities_ids": [ + "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=", + "NBgQk65dTNttDYDGLZNLrb1QEAWB91jqkqXtK1KU4Dc=" + ], + "purposes": [], + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getIdentitiesContractKeys ``` ::: +:::: -:::{tab-item} JavaScript (dapi-grpc) -:sync: js-dapi-grpc -```javascript -const { - v0: { PlatformPromiseClient, GetDataContractRequest, GetDocumentsRequest }, -} = require('@dashevo/dapi-grpc'); -const { default: loadDpp, DashPlatformProtocol, Identifier } = require('@dashevo/wasm-dpp'); - -loadDpp(); -const dpp = new DashPlatformProtocol(null); -const platformPromiseClient = new PlatformPromiseClient( - 'https://seed-1.testnet.networks.dash.org:1443', -); - -const contractId = Identifier.from('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec'); -const contractIdBuffer = Buffer.from(contractId); -const getDataContractRequest = new GetDataContractRequest(); -getDataContractRequest.setId(contractIdBuffer); - -platformPromiseClient - .getDataContract(getDataContractRequest) - .then((contractResponse) => { - dpp.dataContract.createFromBuffer(contractResponse.getDataContract()).then((contract) => { - // Get documents - const getDocumentsRequest = new GetDocumentsRequest(); - const type = 'domain'; - const limit = 10; - - getDocumentsRequest.setDataContractId(contractIdBuffer); - getDocumentsRequest.setDocumentType(type); - // getDocumentsRequest.setWhere(whereSerialized); - // getDocumentsRequest.setOrderBy(orderBySerialized); - getDocumentsRequest.setLimit(limit); - // getDocumentsRequest.setStartAfter(startAfter); - // getDocumentsRequest.setStartAt(startAt); - - platformPromiseClient.getDocuments(getDocumentsRequest).then((response) => { - for (const document of response.getDocuments().getDocumentsList()) { - const documentBuffer = Buffer.from(document); - const doc = dpp.document.createExtendedDocumentFromDocumentBuffer( - documentBuffer, - type, - contract, - ); - console.log(doc.toJSON()); - } - }); - }); - }) - .catch((e) => console.error(e)); +::::{tab-set} +:::{tab-item} Response (gRPCurl) +:sync: grpcurl +```json +{ + "v0": { + "identitiesKeys": {}, + "metadata": { + "height": "5990", + "coreChainLockedHeight": 1097384, + "epoch": 1170, + "timeMs": "1725567663863", + "protocolVersion": 1, + "chainId": "dash-testnet-51" + } + } +} ``` ::: +:::: + +## Security Group Endpoints + +:::{versionadded} 2.0.0 +::: -:::{tab-item} Request (gRPCurl) -:sync: grpcurl +Security groups provide a way to distribute token configuration and update authorization across multiple identities. Each group defines a set of member identities, the voting power of each member, and the required power threshold to authorize an action. The endpoints in this section are used to retrieve information about groups and the actions they are performing. + +### getGroupInfo + +Retrieves information about a specific group within a contract, including its members and required power. + +**Returns**: Group information containing member details and required power, or a cryptographic proof. + +**Parameters**: + +| Name | Type | Required | Description | +|--------------------------|---------|----------|-------------| +| `contract_id` | Bytes | Yes | The ID of the contract containing the group | +| `group_contract_position` | UInt32 | Yes | The position of the group within the contract | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group information | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl ```shell -# Request documents -# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "data_contract_id":"5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "document_type":"domain", - "limit":1 + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "group_contract_position": 1, + "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getDocuments + org.dash.platform.dapi.v0.Platform/getGroupInfo ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (JavaScript) -:sync: js-dapi-client +:::{tab-item} Response (gRPCurl) ```json { - "$id":"Do3YtBPJG72zG4tCbN5VE8djJ6rLpvx7yvtMWEy89HC", - "$ownerId":"4pk6ZhgDtxn9yN2bbB6kfsYLRmUBH7PKUq275cjyzepT", - "label":"Chronic", - "normalizedLabel":"chr0n1c", - "normalizedParentDomainName":"dash", - "parentDomainName":"dash", - "preorderSalt":"1P9N5qv1Ww2xkv6/XXpsvymyGYychRsLXMhCqvW79Jo=", - "records":{ - "dashUniqueIdentityId":"OM4WaCQNLedQ0rpbl1UMTZhEbnVeMfL4941ZD08iyFw=" - }, - "subdomainRules":{ - "allowSubdomains":false - }, - "$revision":1, - "$createdAt":null, - "$updatedAt":null, - "$dataContract":{ - "$format_version":"0", - "id":"GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec", - "config":{ - "$format_version":"0", - "canBeDeleted":false, - "readonly":false, - "keepsHistory":false, - "documentsKeepHistoryContractDefault":false, - "documentsMutableContractDefault":true, - "requiresIdentityEncryptionBoundedKey":null, - "requiresIdentityDecryptionBoundedKey":null + "v0": { + "group_info": { + "group_info": { + "members": [ + { + "member_id": "01abcdef", + "power": 5 + }, + { + "member_id": "02abcdef", + "power": 10 + } + ], + "group_required_power": 15 + } }, - "version":1, - "ownerId":"EuzJmuZdBSJs2eTrxHEp6QqJztbp6FKDNGMeb4W2Ds7h", - "schemaDefs":null, - "documentSchemas":{ - "domain":[ - "Object" - ], - "preorder":[ - "Object" - ] + "metadata": { + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", + "protocolVersion": 1, + "chainId": "dash-testnet-50" } - }, - "$type":"domain" + } } ``` ::: +:::: + +### getGroupInfos + +Retrieves information about multiple groups within a contract, including their members and required power. + +**Returns**: A list of group information entries or a cryptographic proof. + +**Parameters**: + +| Name | Type | Required | Description | +|-------------------------------------------|---------|----------|-------------| +| `contract_id` | Bytes | Yes | The ID of the contract containing the groups | +| `start_at_group_contract_position` | Object | No | Filtering options for retrieving groups | +| `start_at_group_contract_position`
`.start_group_contract_position` | UInt32 | No | The position of the first group to retrieve | +| `start_at_group_contract_position`
`.start_group_contract_position_included` | Boolean | No | Whether the start position should be included in the results | +| `count` | UInt32 | No | The maximum number of groups to retrieve | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group information | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "start_at_group_contract_position": { + "start_group_contract_position": 1, + "start_group_contract_position_included": true + }, + "count": 5, + "prove": false + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getGroupInfos +``` +::: +:::: +::::{tab-set} :::{tab-item} Response (gRPCurl) -:sync: grpcurl ```json { "v0": { - "documents": { - "documents": [ - "AAZ1S7dbhY4VJrSCvjs2Z1DIwa9Qt9MAyjbJdh7gPu6oDsGC/h1Ayf+ZzXp2zLWDF4XB2qMLWZ0brsAKo0r/0sYBAAcAAAGRivixugAAAZGK+LG6AAABkYr4sboAF2F1ZzI1LTEyMzQ1Njc4OTAxMjM0NTY3F2F1ZzI1LTEyMzQ1Njc4OTAxMjM0NTY3AQRkYXNoBGRhc2gAIQEOwYL+HUDJ/5nNenbMtYMXhcHaowtZnRuuwAqjSv/SxgEA" + "group_infos": { + "group_infos": [ + { + "group_contract_position": 1, + "members": [ + { + "member_id": "01abcdef", + "power": 5 + }, + { + "member_id": "02abcdef", + "power": 10 + } + ], + "group_required_power": 15 + }, + { + "group_contract_position": 2, + "members": [ + { + "member_id": "03abcdef", + "power": 8 + }, + { + "member_id": "04abcdef", + "power": 12 + } + ], + "group_required_power": 20 + } ] }, "metadata": { - "height": "5991", - "coreChainLockedHeight": 1097384, - "epoch": 1170, - "timeMs": "1725567845055", + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", "protocolVersion": 1, - "chainId": "dash-testnet-51" + "chainId": "dash-testnet-50" } } } @@ -2030,106 +2186,190 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getEpochsInfo +### getGroupActions -**Returns**: Information for the requested epoch(s) +Retrieves a list of actions performed by a specific group within a contract. **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ----------- | -| `start_epoch` | Bytes | No | First epoch being requested -| `count` | Integer | No | Number of records to request -| `ascending` | Boolean | No | Set to `true` to query in ascending order. Results are returned in descending order by default. -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contracts +| Name | Type | Required | Description | +|-----------------------------------|---------|----------|-------------| +| `contract_id` | Bytes | Yes | The ID of the contract containing the group | +| `group_contract_position` | UInt32 | Yes | The position of the group within the contract | +| `status` | Enum | Yes | The status of the actions to retrieve (`ACTIVE = 0`, `CLOSED = 1`) | +| `start_at_action_id` | Object | No | Filtering options for retrieving actions | +| `start_at_action_id.`
`start_action_id` | Bytes | No | The action ID to start retrieving from | +| `start_at_action_id.`
`start_action_id_included` | Boolean | No | Whether the start action should be included in the results | +| `count` | UInt32 | No | The maximum number of actions to retrieve | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group actions | + +**Returns**: A list of group actions or a cryptographic proof. The response message contains details about actions performed by a group, including various event types related to token operations, document updates, contract updates, and emergency actions. The list of possible actions is shown in the table below: + +| Event Type | Subtype | Description | +|-------------------|---------------------------|-------------| +| **TokenEvent** | `mint` | Mints new tokens to a specified recipient. | +| | `burn` | Burns (destroys) a specified amount of tokens. | +| | `freeze` | Freezes a specific entity's tokens. | +| | `unfreeze` | Unfreezes a specific entity's tokens. | +| | `destroy_frozen_funds` | Destroys frozen funds for a specified entity. | +| | `transfer` | Transfers tokens to another recipient. | +| | `emergency_action` | Performs emergency actions like pausing or resuming the contract. | +| | `token_config_update` | Updates token configuration settings. | +| **DocumentEvent** | `create` | Represents the creation of a document. | +| **ContractEvent** | `update` | Represents updates to a contract. | + +**Response Object** + +| Name | Type | Description | +|---------------------|----------|-------------| +| `group_actions` | Object | Contains a list of group actions | +| `group_actions.group_actions` | Array of `GroupActionEntry` | A list of actions performed by the group | +| `group_actions.group_actions[]`
`.action_id` | Bytes | Unique identifier for the action | +| `group_actions.group_actions[]`
`.event` | Object | The event data associated with the action | +| `group_actions.group_actions[]`
`.event.event_type` | Object | The specific type of event | +| `group_actions.group_actions[]`
`.event.event_type.token_event` | Object | Token-related event details (if applicable). See [Token Event details](#token-event-fields) below for complete information. | +| `group_actions.group_actions[]`
`.event.event_type.document_event` | Object | Document-related event details | +| `group_actions.group_actions[]`
`.event.event_type.document_event`
`.create` | Object | Document creation event details | +| `group_actions.group_actions[]`
`.event.event_type.document_event`
`.create.created_document` | Bytes | Created document data | +| `group_actions.group_actions[]`
`.event.event_type.contract_event` | Object | Contract-related event details | +| `group_actions.group_actions[]`
`.event.event_type.contract_event`
`.update` | Object | Contract update event details | +| `group_actions.group_actions[]`
`.event.event_type.contract_event`
`.update.updated_contract` | Bytes | Updated contract data | +| `metadata` | Object | Metadata about the blockchain state. See [metadata details](#data-proofs-and-metadata) for complete information | + +#### Token Event Fields + +| Token Event Type | Field Name | Type | Description | +|-----------------|------------|------|-------------| +| `mint` | `amount` | UInt64 | Amount of tokens to mint. | +| | `recipient_id` | Bytes | Identity ID of the recipient. | +| | `public_note` | String (Optional) | A public note for the mint event. | +| `burn` | `amount` | UInt64 | Amount of tokens to burn. | +| | `public_note` | String (Optional) | A public note for the burn event. | +| `freeze` | `frozen_id` | Bytes | Identifier of the entity being frozen. | +| | `public_note` | String (Optional) | A public note for the freeze event. | +| `unfreeze` | `frozen_id` | Bytes | Identifier of the entity being unfrozen. | +| | `public_note` | String (Optional) | A public note for the unfreeze event. | +| `destroy_frozen_funds` | `frozen_id` | Bytes | Identifier of the frozen entity. | +| | `amount` | UInt64 | Amount of frozen funds to destroy. | +| | `public_note` | String (Optional) | A public note for the destruction event. | +| `transfer` | `recipient_id` | Bytes | Identity ID of the recipient. | +| | `amount` | UInt64 | Amount of tokens transferred. | +| | `public_note` | String (Optional) | A public note for the transfer event. | +| | `shared_encrypted_note` | Object (Optional) | Encrypted note shared by sender and recipient. | +| | `personal_encrypted_note` | Object (Optional) | Personal encrypted note. | +| `emergency_action` | `action_type` | Enum (`PAUSE = 0`, `RESUME = 1`) | Type of emergency action performed. | +| | `public_note` | String (Optional) | A public note for the emergency action. | +| `token_config_update` | `token_config_update_item` | Bytes | Configuration update details. | +| | `public_note` | String (Optional) | A public note for the configuration update. | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl -:sync: grpcurl ```shell -# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "count": 2 + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "group_contract_position": 1, + "status": 0, + "start_at_action_id": { + "start_action_id": "01abcdef", + "start_action_id_included": true + }, + "count": 5, + "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getEpochsInfo + org.dash.platform.dapi.v0.Platform/getGroupActions ``` ::: :::: ::::{tab-set} :::{tab-item} Response (gRPCurl) -:sync: grpcurl ```json { "v0": { - "epochs": { - "epochInfos": [ + "group_actions": { + "group_actions": [ { - "number": 849, - "firstBlockHeight": "6822", - "firstCoreBlockHeight": 927030, - "startTime": "1701976758619", - "feeMultiplier": 2 + "action_id": "01abcdef", + "event": { + "event_type": { + "token_event": { + "mint": { + "amount": "1000", + "recipient_id": "02abcdef", + "public_note": "Minting 1000 tokens" + } + } + } + } }, { - "number": 850, - "firstBlockHeight": "6840", - "firstCoreBlockHeight": 927061, - "startTime": "1701980303210", - "feeMultiplier": 2 + "action_id": "02abcdef", + "event": { + "event_type": { + "token_event": { + "burn": { + "amount": "500", + "public_note": "Burning 500 tokens" + } + } + } + } } ] }, "metadata": { - "height": "6843", - "coreChainLockedHeight": 927065, - "epoch": 850, - "timeMs": "1701980850126", + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", "protocolVersion": 1, - "chainId": "dash-testnet-37" + "chainId": "dash-testnet-50" } } } - ``` ::: :::: -### getPathElements +### getGroupActionSigners -Retrieves elements for a specified path in the platform. +Retrieves the signers for a specified group action within a contract, along with their assigned power. -**Returns**: The elements or a cryptographic proof. +**Returns**: A list of group action signers or a cryptographic proof. -**Parameters**: +**Parameters** -| Name | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `path` | Array | Yes | The path for which elements are being requested | -| `keys` | Array | No | The keys associated with the elements being requested | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested elements | +| Name | Type | Required | Description | +|---------------------------|---------|----------|-------------| +| `contract_id` | Bytes | Yes | The ID of the contract containing the group action. | +| `group_contract_position` | UInt32 | Yes | The position of the group within the contract. | +| `status` | Enum | Yes | The status of the action (`ACTIVE = 0`, `CLOSED = 1`). | +| `action_id` | Bytes | Yes | The unique identifier of the action. | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group action signers. | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl ```shell -# `path` array values be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "path": ["path_element_1", "path_element_2"], - "keys": ["key1", "key2"] + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", + "group_contract_position": 1, + "status": 0, + "action_id": "01abcdef", + "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getPathElements + org.dash.platform.dapi.v0.Platform/getGroupActionSigners ``` ::: :::: @@ -2139,12 +2379,23 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "elements": {}, + "group_action_signers": { + "signers": [ + { + "signer_id": "01abcdef", + "power": 5 + }, + { + "signer_id": "02abcdef", + "power": 10 + } + ] + }, "metadata": { - "height": "3256", - "coreChainLockedHeight": 1087397, - "epoch": 780, - "timeMs": "1724164508171", + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", "protocolVersion": 1, "chainId": "dash-testnet-50" } @@ -2154,200 +2405,237 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getPrefundedSpecializedBalance +## State Transition Endpoints -Retrieves the pre-funded specialized balance for a specific identity. +### broadcastStateTransition -**Returns**: The balance or a cryptographic proof. +Broadcasts a [state transition](../explanations/platform-protocol-state-transition.md) to the platform via DAPI to make a change to layer 2 data. The `broadcastStateTransition` call returns once the state transition has been accepted into the mempool. + +**Returns**: Nothing or error + +:::{note} +The [`waitForStateTransitionResult` endpoint](#waitforstatetransitionresult) should be used after `broadcastStateTransition` if proof of block confirmation is required. +::: **Parameters**: -| Name | Type | Required | Description | -| ------- | -------- | -------- | ----------- | -| `id` | Bytes | Yes | The ID of the identity whose balance is being requested | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested balance | +| Name | Type | Required | Description | +| ------------------ | -------------- | -------- | -------------------------------------------------------------------- | +| `state_transition` | Bytes (Base64) | Yes | A [state transition](../explanations/platform-protocol-state-transition.md) | -**Example Request and Response** +```{eval-rst} +.. + Commented out info + [block:html] + { + "html": "\n\n\n\n" + } + [/block] +``` + +**Response**: No response except on error + +### waitForStateTransitionResult + +**Returns**: The state transition hash and either a proof that the state transition was confirmed in a block or an error. +**Parameters**: + +| Name | Type | Required | Description | +| ----------------------- | ------- | -------- | -------------------------------- | +| `state_transition_hash` | Bytes | Yes | Hash of the state transition | +| `prove` | Boolean | Yes | Set to `true` to request a proof. The data requested will be encoded as part of the proof in the response. | + +**Example Request** + +```{eval-rst} +.. + Commented out info + [block:html] + { + "html": "\n\n\n\n" + } + [/block] +``` ::::{tab-set} -:::{tab-item} gRPCurl +:::{tab-item} JavaScript (dapi-client) +:sync: js-dapi-client +```javascript +const DAPIClient = require('@dashevo/dapi-client'); + +const client = new DAPIClient({ network: 'testnet' }); + +// Replace with your actual hash +const hash = ; +client.platform.waitForStateTransitionResult(hash, { prove: true }) + .then((response) => { + console.log(response); + }); + +``` +::: + +:::{tab-item} Request (gRPCurl) +:sync: grpcurl ```shell -# `id` must be represented in base64 +# Replace `your_state_transition_hash` with your own before running +# `your_state_transition_hash` must be represented in base64 +# Example: wEiwFu9WvAtylrwTph5v0uXQm743N+75C+C9DhmZBkw= grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + "state_transition_hash":your_state_transition_hash, + "prove": "true" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getPrefundedSpecializedBalance + org.dash.platform.dapi.v0.Platform/waitForStateTransitionResult ``` ::: :::: -::::{tab-set} -:::{tab-item} Response (gRPCurl) -```json -{ - "v0": { - "balance": "100000000", - "metadata": { - "height": "6860", - "coreChainLockedHeight": 927080, - "epoch": 852, - "timeMs": "1701983732299", - "protocolVersion": 1, - "chainId": "dash-testnet-37" - } +```{eval-rst} +.. + Commented out info + [block:html] + { + "html": "\n\n" } -} + [/block] ``` -::: -:::: - -### getProofs -:::::{dropdown} ⚠️ For internal use only - - This endpoint is only used for communication between DAPI and Drive. All external requests are rejected. - - **Returns**: Proof information for the requested identities, contracts, and/or document(s) +## System Info Endpoints - **Parameters**: +### getCurrentQuorumsInfo - A combination of one or more of the following are required fields are required: +Retrieves current quorum details, including validator sets and metadata for each quorum. - | Field | Type | Required | Description | - | - | - | - | - | - | `identities` | `IdentityRequest` | No | List of identity requests - | `contracts` | `ContractRequest` | No | List of contract requests - | `documents` | `DocumentRequest` | No | List of document requests +**Returns**: Information about current quorums, including quorum hashes, validator sets, and +cryptographic proof. - **Request type details** +**Parameters**: - | Field | Type | Required | Description | - | - | - | - | - | - | **IdentityRequest** | | | - | `identity_id` | Bytes | Yes | Identity ID - | `request_type` | Type (enum) | Yes | Type of identity proof data to request (options: FULL_IDENTITY, BALANCE, KEYS) - | --------------- | | | - | **ContractRequest** | | | - | `contract_id` | Bytes | Yes | A contract ID - | --------------- | | | - | **DocumentRequest** | | | - | `contract_id` | Bytes | Yes | A contract ID - | `document_type` | String | Yes | Type of contract document - | `document_type_keeps_history` | Boolean | No |Indicates if the document type maintains a history - | `document_id` | Bytes | Yes | Document ID +| Name | Type | Required | Description | +| ------------- | ------ | -------- | ----------- | +| `version` | Object | No | Version object containing request parameters | - **Example Request and Response** +**Example Request and Response** - ::::{tab-set} - :::{tab-item} gRPCurl - :sync: grpcurl - ```shell - # Request proofs for an identity and a data contract - # `identity_id` and `contract_id` must be represented in base64 - grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "identities": [ +::::{tab-set} +:::{tab-item} gRPCurl +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": {} + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getCurrentQuorumsInfo +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (gRPCurl) +```json +{ + "v0": { + "quorumHashes": [ + "AAABC9mcu+F3eC33hC9wyZAP20QQNHz4kYnfFQPwa5A=" + ], + "currentQuorumHash": "AAABP7yY5DKt8UlLUR/QJlH8BI108xugKSEIOrR6iAA=", + "validatorSets": [ + { + "quorumHash": "AAABC9mcu+F3eC33hC9wyZAP20QQNHz4kYnfFQPwa5A=", + "coreHeight": 1131096, + "members": [ { - "request_type": "FULL_IDENTITY", - "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" - } - ], - "contracts": [ + "proTxHash": "BbaHl4NE+iQzsqqZ1B9kPi2FgaeJzcIwhIic7KUkTqg=", + "nodeIp": "52.24.124.162" + }, { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + "proTxHash": "iCUb1LEk7+uHU33qvuxU9sj1dfTfgfEM9ejuoHMJK28=", + "nodeIp": "52.33.28.47" + }, + { + "proTxHash": "FD3Namt2hP3gHoihDl1l3popJExezVhtFKNCZXAl8RM=", + "nodeIp": "35.164.23.245" } ], - "documents": [] - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getProofs - ``` - ::: - :::: - ::::{tab-set} - :::{tab-item} Response (gRPCurl) - :sync: grpcurl - ```json - // GroveDB proof for the requested identity and contract - { - "v0": { - "proof": { - "grovedbProof": "AQYAAQDuAgHx2HzoF4wSud2eE4a+j9LczjcgboCJsEZJK+Bl/97hLAQBIAAkAgEgn2WlCmdZa3aGIz7NDvWCqFa+KfeLcarKW0WH8vLbYZgAAJpItikQWz3TcDudnxxiJSY5h5Ndejq2UOkZPubKDN0QAfhJDycGmgAM67TyQkPU3kuavJLc7wlcbvBD48JEelqeEQQBQAAkAgEgoqG0rG/vIuoqGmjoEjZEs1eHX2tBLBgQkoHBRueycbwA1L5TY2e0nwaAJolrXP7S6qWDVVTGeFpz4cjXIHoOPUoQAY6uNnLUV0nQB1qQqQWBLRyaJZfu/o/kBIBYXq4egeakBAFgAC0EASCfZaUKZ1lrdoYjPs0O9YKoVr4p94txqspbRYfy8tthmP3KiDkEJD0hAACXwGQWS6E+DOmhhxAd6xNjdVGeulgD5i3dNpt5nRiwGxABMwg2kOcA+9xQ3NhoBqze6XaeidN/5COubSCHkp+bZ9wREQEBIN0CAduEoBne86ZfsX2HwXtJ9jM/ghzM4rJqnUNLkRV/wom8As3l9skVhNWf85H1JsVvK8PkRe3fO83N0QjZ9StB5QNQEAFviDbTTGTvt2tyoqGNJydjW32VQs0vs5XVc8d/M5FJpQQgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awACQIBAQIBAwAAAKWXTEBAq5u+FwX5AZapJ7qj7G7SIxP3mYey+otzvhefEAHYJdPBfgqNhf9vXtvya+ip4ZEJR6rubhW79ZMAabO48RERAmKv6d1LDUzhxxrKW1iDGkYD6tZ9TfORRKQKkfWd11g8EAFfm8qRd2+WVybP18udB0457INJ3U11YNIZvdKFY1rQjBECDegFhb6zh0BzQ1pirX6IQGLel/eF8+xv98HZYmkJgBAQAVAO5YGj0RWNmvhmC0NqrtWHwnjSUQNxd6uYRJMjfcPrEQEgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/ax/AwEAAAsACAAAAAAAAAAAAAQBAQAFAgEBAQCqh3fBWf3zs2zg6Wt8+AFC1/58xqnqSxC9exEK7kPRhRACKQ9N/X8hOac8dT4zuZC4upFtihZq9JsYfb5UoiGIDyIQAUYZe6LR2JrmXw44tCBxZtK21SAUzHBMVnCCvx29ZfnfEQIBAWUDAQAALQAqAAAAAAAAACECyLR0e1KMrF/d96bMY3Au4E7X0TMpBOCFEDQ+oA3OVGoAAAMBAQAtACoAAQACAAAAIQIB7ij4T1SFOQVn6TnCtYYBC2Omnsksq1NdyWqMcZE2AgAAEAEBQNkCAaylxbCNFaN71X5p+nfqhe5T3e5JDjX3BTp7s2veVhTOAgHZbe7OzqjzwOzXn6NLbzSt8PItwUVj91x8pf3lguQGEAE2pM5PtpHXYchTiDJh5csJWcrbCMX9R548J6lvLkRY1AKghzeA2y1iYD9QJGMD9IAzws0Sh9r+EI5NYy7xhp72chABtgUnjZcfcBf5QBfldwp2LQHKYDCIWImz4Q/4E46nyQMEIOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAUCAQEBAPLfdXh4PcRzmCXJPABALtDjvEgBgLJwwOYCf0L54idmEAFJybKFoR6l0GDoa2MQGMKbvM0N4w1AhupCbh4b3NiCWhEC0vjwIA7WA1zKJTmJ6cqaWFgqIs59iDoqcRdSLsZEaLkQAXPWZ9eFJe3P3Uf6GA/WznOBSDg+hIny9UF6gSdQJYiIERERAiDmaMZZr2au4ecsGG3ee1t+Ch1xKgnEDVch9iK/U8UxVf8eAwEAD1gA+1MPAOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAAABMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awAAgZkb21haW4WBhIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQMWAxIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwEWAxIEbmFtZRIOZGFzaElkZW50aXR5SWQSCnByb3BlcnRpZXMVARYBEhxyZWNvcmRzLmRhc2hVbmlxdWVJZGVudGl0eUlkEgNhc2MSBnVuaXF1ZRMBFgISBG5hbWUSCWRhc2hBbGlhcxIKcHJvcGVydGllcxUBFgESG3JlY29yZHMuZGFzaEFsaWFzSWRlbnRpdHlJZBIDYXNjEgpwcm9wZXJ0aWVzFgcSBWxhYmVsFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhIqXlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCAxIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEhlEb21haW4gbGFiZWwuIGUuZy4gJ0JvYicuEg9ub3JtYWxpemVkTGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEjxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LV17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1heExlbmd0aAI/Eghwb3NpdGlvbgIBEgtkZXNjcmlwdGlvbhKjRG9tYWluIGxhYmVsIGNvbnZlcnRlZCB0byBsb3dlcmNhc2UgZm9yIGNhc2UtaW5zZW5zaXRpdmUgdW5pcXVlbmVzcyB2YWxpZGF0aW9uLiAibyIsICJpIiBhbmQgImwiIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIgdG8gbWl0aWdhdGUgaG9tb2dyYXBoIGF0dGFjay4gZS5nLiAnYjBiJxIIJGNvbW1lbnQSXE11c3QgYmUgZXF1YWwgdG8gdGhlIGxhYmVsIGluIGxvd2VyY2FzZS4gIm8iLCAiaSIgYW5kICJsIiBtdXN0IGJlIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIuEhBwYXJlbnREb21haW5OYW1lFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhItXiR8XlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCABIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgISC2Rlc2NyaXB0aW9uEidBIGZ1bGwgcGFyZW50IGRvbWFpbiBuYW1lLiBlLmcuICdkYXNoJy4SGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lFgcSBHR5cGUSBnN0cmluZxIHcGF0dGVybhJBXiR8XlthLWhqLWttLW5wLXowLTldW2EtaGota20tbnAtejAtOS1cLl17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAxILZGVzY3JpcHRpb24SokEgcGFyZW50IGRvbWFpbiBuYW1lIGluIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdkYXNoJxIIJGNvbW1lbnQSwE11c3QgZWl0aGVyIGJlIGVxdWFsIHRvIGFuIGV4aXN0aW5nIGRvbWFpbiBvciBlbXB0eSB0byBjcmVhdGUgYSB0b3AgbGV2ZWwgZG9tYWluLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4gT25seSB0aGUgZGF0YSBjb250cmFjdCBvd25lciBjYW4gY3JlYXRlIHRvcCBsZXZlbCBkb21haW5zLhIMcHJlb3JkZXJTYWx0FgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CBBILZGVzY3JpcHRpb24SIlNhbHQgdXNlZCBpbiB0aGUgcHJlb3JkZXIgZG9jdW1lbnQSB3JlY29yZHMWBxIEdHlwZRIGb2JqZWN0Egpwcm9wZXJ0aWVzFgISFGRhc2hVbmlxdWVJZGVudGl0eUlkFggSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABIQY29udGVudE1lZGlhVHlwZRIhYXBwbGljYXRpb24veC5kYXNoLmRwcC5pZGVudGlmaWVyEgtkZXNjcmlwdGlvbhI+SWRlbnRpdHkgSUQgdG8gYmUgdXNlZCB0byBjcmVhdGUgdGhlIHByaW1hcnkgbmFtZSB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchITZGFzaEFsaWFzSWRlbnRpdHlJZBYIEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgESEGNvbnRlbnRNZWRpYVR5cGUSIWFwcGxpY2F0aW9uL3guZGFzaC5kcHAuaWRlbnRpZmllchILZGVzY3JpcHRpb24SPUlkZW50aXR5IElEIHRvIGJlIHVzZWQgdG8gY3JlYXRlIGFsaWFzIG5hbWVzIGZvciB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchINbWluUHJvcGVydGllcwIBEg1tYXhQcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASCCRjb21tZW50EpBDb25zdHJhaW50IHdpdGggbWF4IGFuZCBtaW4gcHJvcGVydGllcyBlbnN1cmUgdGhhdCBvbmx5IG9uZSBpZGVudGl0eSByZWNvcmQgaXMgdXNlZCAtIGVpdGhlciBhIGBkYXNoVW5pcXVlSWRlbnRpdHlJZGAgb3IgYSBgZGFzaEFsaWFzSWRlbnRpdHlJZGASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQYSBWxhYmVsEg9ub3JtYWxpemVkTGFiZWwSGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lEgxwcmVvcmRlclNhbHQSB3JlY29yZHMSDnN1YmRvbWFpblJ1bGVzEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBL7ATdJbiBvcmRlciB0byByZWdpc3RlciBhIGRvbWFpbiB5b3UgbmVlZCB0byBjcmVhdGUgYSBwcmVvcmRlci4gVGhlIHByZW9yZGVyIHN0ZXAgaXMgbmVlZGVkIHRvIHByZXZlbnQgbWFuLWluLXRoZS1taWRkbGUgYXR0YWNrcy4gbm9ybWFsaXplZExhYmVsICsgJy4nICsgbm9ybWFsaXplZFBhcmVudERvbWFpbiBtdXN0IG5vdCBiZSBsb25nZXIgdGhhbiAyNTMgY2hhcnMgbGVuZ3RoIGFzIGRlZmluZWQgYnkgUkZDIDEwMzUuIERvbWFpbiBkb2N1bWVudHMgYXJlIGltbXV0YWJsZTogbW9kaWZpY2F0aW9uIGFuZCBkZWxldGlvbiBhcmUgcmVzdHJpY3RlZAhwcmVvcmRlchYGEgR0eXBlEgZvYmplY3QSB2luZGljZXMVARYDEgRuYW1lEgpzYWx0ZWRIYXNoEgpwcm9wZXJ0aWVzFQEWARIQc2FsdGVkRG9tYWluSGFzaBIDYXNjEgZ1bmlxdWUTARIKcHJvcGVydGllcxYBEhBzYWx0ZWREb21haW5IYXNoFgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SWURvdWJsZSBzaGEtMjU2IG9mIHRoZSBjb25jYXRlbmF0aW9uIG9mIGEgMzIgYnl0ZSByYW5kb20gc2FsdCBhbmQgYSBub3JtYWxpemVkIGRvbWFpbiBuYW1lEghyZXF1aXJlZBUBEhBzYWx0ZWREb21haW5IYXNoEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBJKUHJlb3JkZXIgZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQAAjfsugQjtjFH1tziawxcHm6Itrtfd4HxFXit+EBuIEGCEAIBYN8CAb/jxzcNWFZEpbAUm+m8bHmGDiDoIp0nmnAVzK1RREtVAtYIgZuRPU70BrwnGYqsfr3rqOmCvT+uOZn5JD+z2Fb7EAHRk0v0/UW0amfTj5Q3RgNXsCy34jIVuLie5yXuiKURfQQgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awACwP9eCCC7wkAAAAApQ40uU7eIE6Lc7gSiikQMybwd7ICds9JRkR7mN9dsKsQAS6QXX9hmpIEs9jEW3eAXNz9stWYGeSq/BnIm9Y+L8XMERECiTcgqXvEL2837Y7t1JcjkYGVIFZ7NkS80ZLVeDUZzS0QAfdYjSzg2BIkhpiPAHQ5W4aN0OlpO7pNjwx46JLVtF5HEQLIaUC5PRYEMoQrfMJnG3PgKokrA37sdKCgo7Hxar/TcRABMapwxTKSfBkDooZq35By87R1c8Y4h4LvZXgOwY+CNfQR", - "quorumHash": "AAAAu4I2BiBDnydSZOLs2bV45yWb+vJFEKQi9wTc3hg=", - "signature": "t6IYrtqREmhCMGQva67DMYpqoY+4fIPB0245y/vhrs0L4qqv7+jDYFoppC7TzFCnCpXLxwOL15u8AOmGFsuMn7FA7qtz/rzJT0124Va1EL5ioeD0DwPVVCAEfQcN/7+6", - "round": 1, - "blockIdHash": "R6LgAhbTCMP2bbiktIm1nLnJ4csO0UvaK6vArGJ2ghs=", - "quorumType": 6 - }, - "metadata": { - "height": "9350", - "coreChainLockedHeight": 929436, - "epoch": 943, - "timeMs": "1702317747792", - "protocolVersion": 1, - "chainId": "dash-testnet-37" + "thresholdPublicKey": "ixciXjkgFnI/cQNXS51yBi4MYgdPZWjRGxsubEsfzItgvTlABUxow9S1eCE7w9+f" } + ], + "lastBlockProposer": "iCUb1LEk7+uHU33qvuxU9sj1dfTfgfEM9ejuoHMJK28=", + "metadata": { + "height": "43865", + "coreChainLockedHeight": 1131112, + "epoch": 2483, + "timeMs": "1730295469308", + "protocolVersion": 4, + "chainId": "dash-testnet-51" } } - - ``` - ::: - :::: - ::::: +} +``` +::: +:::: -### getProtocolVersionUpgradeState +### getEvonodesProposedEpochBlocksByIds -**Returns**: The number of votes cast for each protocol version. +Retrieves the number of blocks proposed by the specified evonodes in a certain epoch, based on their IDs. + +**Returns**: A list of evonodes and their proposed block counts or a cryptographic proof. **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity +| Name | Type | Required | Description | +| ------------------ | -------- | -------- | ----------- | +| `epoch` | Integer | No | The epoch to query for. If not set, the current epoch will be used | +| `ids` | Array | Yes | An array of evonode IDs for which proposed blocks are retrieved IDs
Note: masternode IDs are created uniquely as described in the [masternode identity IDs section](#masternode-identity-ids) | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl -:sync: grpcurl ```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": { } + "v0": { + "ids": [ + "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=","dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" + ], + "prove": false + } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getProtocolVersionUpgradeState + org.dash.platform.dapi.v0.Platform/getEvonodesProposedEpochBlocksByIds ``` ::: :::: ::::{tab-set} :::{tab-item} Response (gRPCurl) -:sync: grpcurl ```json { "v0": { - "versions": { - "versions": [ + "evonodesProposedBlockCountsInfo": { + "evonodesProposedBlockCounts": [ { - "versionNumber": 1, - "voteCount": 28 + "proTxHash": "dUuJ2ujbIPxM7l462wexRtfv5Qimb6Co4QlGdbnao14=" + }, + { + "proTxHash": "jspLy7OhJKsoOv1C2tO9sgd7OAlll4ig8dr/zlufAB8=", + "count": "13" } ] }, "metadata": { - "height": "10649", - "coreChainLockedHeight": 930014, - "epoch": 965, - "timeMs": "1702397313265", - "protocolVersion": 1, - "chainId": "dash-testnet-37" + "height": "13621", + "coreChainLockedHeight": 1105397, + "epoch": 1482, + "timeMs": "1726691577244", + "protocolVersion": 3, + "chainId": "dash-testnet-51" } } } @@ -2355,62 +2643,61 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getProtocolVersionUpgradeVoteStatus +### getEvonodesProposedEpochBlocksByRange -**Returns**: Protocol version upgrade status. +Retrieves the number of blocks proposed by evonodes for a specified epoch. + +**Returns**: A list of evonodes and their proposed block counts or a cryptographic proof. **Parameters**: -| Name | Type | Required | Description | -| ------- | ------- | -------- | ------------ | -| `start_pro_tx_hash` | String | No | Protx hash of an evonode -| `count` | Integer | No | Number of records to request -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity +| Name | Type | Required | Description | +| ------------------ | -------- | -------- | ----------- | +| `epoch` | Integer | No | The epoch to query for. If not set, the current epoch will be used | +| `limit` | Integer | No | Maximum number of evonodes proposed epoch blocks to return | +| `start_after` | Bytes | No | Retrieve results starting after this document | +| `start_at` | Bytes | No | Retrieve results starting at this document | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl -:sync: grpcurl ```shell -# `start_pro_tx_hash` must be represented in base64 if present grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "count": 2 + "epoch": 0, + "limit": 10, + "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getProtocolVersionUpgradeVoteStatus + org.dash.platform.dapi.v0.Platform/getEvonodesProposedEpochBlocksByRange ``` ::: :::: ::::{tab-set} :::{tab-item} Response (gRPCurl) -:sync: grpcurl ```json { "v0": { - "versions": { - "versionSignals": [ - { - "proTxHash": "WyRggLpkNQaF/jAtPXkPW7I4y2GZINRiMMhE8HmUSiM=", - "version": 1 - }, + "evonodesProposedBlockCountsInfo": { + "evonodesProposedBlockCounts": [ { - "proTxHash": "XGVCdmYVOHGDcV2VipJVUkcvkzNfoWEogEI+S72u9DY=", - "version": 1 + "proTxHash": "BbaHl4NE+iQzsqqZ1B9kPi2FgaeJzcIwhIic7KUkTqg=", + "count": "1" } ] }, "metadata": { - "height": "10662", - "coreChainLockedHeight": 930024, - "epoch": 966, - "timeMs": "1702398582963", - "protocolVersion": 1, - "chainId": "dash-testnet-37" + "height": "20263", + "coreChainLockedHeight": 1105827, + "epoch": 1499, + "timeMs": "1726752270072", + "protocolVersion": 3, + "chainId": "dash-testnet-51" } } } @@ -2418,108 +2705,106 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getStatus - -Retrieves status information related to Dash Platform. +### getEpochsInfo -**Returns**: Status details including version, node, chain, network, and state sync information, or a cryptographic proof. +**Returns**: Information for the requested epoch(s) **Parameters**: -This endpoint does not require any parameters. +| Name | Type | Required | Description | +| ------- | ------- | -------- | ----------- | +| `start_epoch` | Bytes | No | First epoch being requested +| `count` | Integer | No | Number of records to request +| `ascending` | Boolean | No | Set to `true` to query in ascending order. Results are returned in descending order by default. +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested data contracts **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl +:sync: grpcurl ```shell +# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": {} + "v0": { + "count": 2 + } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getStatus + org.dash.platform.dapi.v0.Platform/getEpochsInfo ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (gRPCurl) -```json -{ - "v0": { - "version": { - "software": { - "dapi": "1.2.0", - "drive": "1.2.0", - "tenderdash": "1.2.1" - }, - "protocol": { - "tenderdash": { - "p2p": 10, - "block": 14 +:::{tab-item} Response (gRPCurl) +:sync: grpcurl +```json +{ + "v0": { + "epochs": { + "epochInfos": [ + { + "number": 849, + "firstBlockHeight": "6822", + "firstCoreBlockHeight": 927030, + "startTime": "1701976758619", + "feeMultiplier": 2 }, - "drive": { - "latest": 1, - "current": 1 + { + "number": 850, + "firstBlockHeight": "6840", + "firstCoreBlockHeight": 927061, + "startTime": "1701980303210", + "feeMultiplier": 2 } - } - }, - "node": { - "id": "H/vx0yVB3Lj1VVMFKVcEqf+a3CQ=", - "proTxHash": "LkhlGi6cDLTy+3q4dAYapK8M0otZaVYx5qNa85UO9vs=" - }, - "chain": { - "latestBlockHash": "XY1U/Ay7DCdZqJJwM4sXSw1OFdBIbnVYFc9sJep1hNw=", - "latestAppHash": "9wq6IzU4AjuL27HybKqvWOOPCbnpBJQjk6q64nsd7i8=", - "latestBlockHeight": "7768", - "earliestBlockHash": "CPoCwn7AOQujAeT8fj1+rbNQyBk+PmKgk2iXBuOiC/o=", - "earliestAppHash": "vwzLnKBxugGubmegwJD5eAPSbVbWddzVExeBy8rI7I8=", - "earliestBlockHeight": "1", - "maxPeerBlockHeight": "7768", - "coreChainLockedHeight": 1099682 - }, - "network": { - "chainId": "dash-testnet-51", - "peersCount": 61, - "listening": true + ] }, - "stateSync": {}, - "time": { - "local": "1725890999274", - "block": "1725890829092", - "genesis": "0", - "epoch": 1260 + "metadata": { + "height": "6843", + "coreChainLockedHeight": 927065, + "epoch": 850, + "timeMs": "1701980850126", + "protocolVersion": 1, + "chainId": "dash-testnet-37" } } } + ``` ::: :::: -### getTotalCreditsInPlatform +### getPathElements -Retrieves the total credits in the platform. +Retrieves elements for a specified path in the platform. -**Returns**: The total amount of credits or a cryptographic proof. +**Returns**: The elements or a cryptographic proof. **Parameters**: | Name | Type | Required | Description | | ------- | -------- | -------- | ----------- | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested credit total | +| `path` | Array | Yes | The path for which elements are being requested | +| `keys` | Array | No | The keys associated with the elements being requested | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested elements | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl ```shell +# `path` array values be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": {} + "v0": { + "path": ["path_element_1", "path_element_2"], + "keys": ["key1", "key2"] + } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getTotalCreditsInPlatform + org.dash.platform.dapi.v0.Platform/getPathElements ``` ::: :::: @@ -2529,12 +2814,12 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "credits": "1594457743625920", + "elements": {}, "metadata": { - "height": "3263", - "coreChainLockedHeight": 1087403, - "epoch": 781, - "timeMs": "1724165757972", + "height": "3256", + "coreChainLockedHeight": 1087397, + "epoch": 780, + "timeMs": "1724164508171", "protocolVersion": 1, "chainId": "dash-testnet-50" } @@ -2544,38 +2829,33 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getVotePollsByEndDate +### getPrefundedSpecializedBalance -Retrieves vote polls that will end within a specified date range. +Retrieves the pre-funded specialized balance for a specific identity. -**Returns**: A list of vote polls or a cryptographic proof. +**Returns**: The balance or a cryptographic proof. **Parameters**: -| Name | Type | Required | Description | -| ------------------ | -------- | -------- | ----------- | -| `start_time_info` | Object | No | Start time information for filtering vote polls | -| `end_time_info` | Object | No | End time information for filtering vote polls | -| `limit` | Integer | No | Maximum number of results to return | -| `offset` | Integer | No | Offset for pagination | -| `ascending` | Boolean | No | Sort order for results | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested vote polls | +| Name | Type | Required | Description | +| ------- | -------- | -------- | ----------- | +| `id` | Bytes | Yes | The ID of the identity whose balance is being requested | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested balance | **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl ```shell +# `id` must be represented in base64 grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "start_time_info": {"start_time_ms": "1701980000000", "start_time_included": true}, - "end_time_info": {"end_time_ms": "1702000000000", "end_time_included": true}, - "limit": 10 + "id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getVotePollsByEndDate + org.dash.platform.dapi.v0.Platform/getPrefundedSpecializedBalance ``` ::: :::: @@ -2585,16 +2865,14 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "votePollsByTimestamps": { - "finishedResults": true - }, + "balance": "100000000", "metadata": { - "height": "2876", - "coreChainLockedHeight": 1086885, - "epoch": 761, - "timeMs": "1724094056585", + "height": "6860", + "coreChainLockedHeight": 927080, + "epoch": 852, + "timeMs": "1701983732299", "protocolVersion": 1, - "chainId": "dash-testnet-50" + "chainId": "dash-testnet-37" } } } @@ -2602,139 +2880,149 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### waitForStateTransitionResult - -**Returns**: The state transition hash and either a proof that the state transition was confirmed in a block or an error. -**Parameters**: +### getProofs -| Name | Type | Required | Description | -| ----------------------- | ------- | -------- | -------------------------------- | -| `state_transition_hash` | Bytes | Yes | Hash of the state transition | -| `prove` | Boolean | Yes | Set to `true` to request a proof. The data requested will be encoded as part of the proof in the response. | +:::::{dropdown} ⚠️ For internal use only + + This endpoint is only used for communication between DAPI and Drive. All external requests are rejected. -**Example Request** + **Returns**: Proof information for the requested identities, contracts, and/or document(s) -```{eval-rst} -.. - Commented out info - [block:html] - { - "html": "\n\n\n\n" - } - [/block] -``` + **Parameters**: -::::{tab-set} -:::{tab-item} JavaScript (dapi-client) -:sync: js-dapi-client -```javascript -const DAPIClient = require('@dashevo/dapi-client'); + A combination of one or more of the following are required fields are required: -const client = new DAPIClient({ network: 'testnet' }); + | Field | Type | Required | Description | + | - | - | - | - | + | `identities` | `IdentityRequest` | No | List of identity requests + | `contracts` | `ContractRequest` | No | List of contract requests + | `documents` | `DocumentRequest` | No | List of document requests -// Replace with your actual hash -const hash = ; -client.platform.waitForStateTransitionResult(hash, { prove: true }) - .then((response) => { - console.log(response); - }); + **Request type details** -``` -::: + | Field | Type | Required | Description | + | - | - | - | - | + | **IdentityRequest** | | | + | `identity_id` | Bytes | Yes | Identity ID + | `request_type` | Type (enum) | Yes | Type of identity proof data to request (options: FULL_IDENTITY, BALANCE, KEYS) + | --------------- | | | + | **ContractRequest** | | | + | `contract_id` | Bytes | Yes | A contract ID + | --------------- | | | + | **DocumentRequest** | | | + | `contract_id` | Bytes | Yes | A contract ID + | `document_type` | String | Yes | Type of contract document + | `document_type_keeps_history` | Boolean | No |Indicates if the document type maintains a history + | `document_id` | Bytes | Yes | Document ID -:::{tab-item} Request (gRPCurl) -:sync: grpcurl -```shell -# Replace `your_state_transition_hash` with your own before running -# `your_state_transition_hash` must be represented in base64 -# Example: wEiwFu9WvAtylrwTph5v0uXQm743N+75C+C9DhmZBkw= -grpcurl -proto protos/platform/v0/platform.proto \ - -d '{ - "v0": { - "state_transition_hash":your_state_transition_hash, - "prove": "true" - } - }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/waitForStateTransitionResult -``` -::: -:::: + **Example Request and Response** -```{eval-rst} -.. - Commented out info - [block:html] + ::::{tab-set} + :::{tab-item} gRPCurl + :sync: grpcurl + ```shell + # Request proofs for an identity and a data contract + # `identity_id` and `contract_id` must be represented in base64 + grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "identities": [ + { + "request_type": "FULL_IDENTITY", + "identity_id": "HxUSbKaFxbuvTUprfr5a0yU6u4EasTdSWvSxOwKjmxw=" + } + ], + "contracts": [ + { + "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=" + } + ], + "documents": [] + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getProofs + ``` + ::: + :::: + ::::{tab-set} + :::{tab-item} Response (gRPCurl) + :sync: grpcurl + ```json + // GroveDB proof for the requested identity and contract { - "html": "\n\n" + "v0": { + "proof": { + "grovedbProof": "AQYAAQDuAgHx2HzoF4wSud2eE4a+j9LczjcgboCJsEZJK+Bl/97hLAQBIAAkAgEgn2WlCmdZa3aGIz7NDvWCqFa+KfeLcarKW0WH8vLbYZgAAJpItikQWz3TcDudnxxiJSY5h5Ndejq2UOkZPubKDN0QAfhJDycGmgAM67TyQkPU3kuavJLc7wlcbvBD48JEelqeEQQBQAAkAgEgoqG0rG/vIuoqGmjoEjZEs1eHX2tBLBgQkoHBRueycbwA1L5TY2e0nwaAJolrXP7S6qWDVVTGeFpz4cjXIHoOPUoQAY6uNnLUV0nQB1qQqQWBLRyaJZfu/o/kBIBYXq4egeakBAFgAC0EASCfZaUKZ1lrdoYjPs0O9YKoVr4p94txqspbRYfy8tthmP3KiDkEJD0hAACXwGQWS6E+DOmhhxAd6xNjdVGeulgD5i3dNpt5nRiwGxABMwg2kOcA+9xQ3NhoBqze6XaeidN/5COubSCHkp+bZ9wREQEBIN0CAduEoBne86ZfsX2HwXtJ9jM/ghzM4rJqnUNLkRV/wom8As3l9skVhNWf85H1JsVvK8PkRe3fO83N0QjZ9StB5QNQEAFviDbTTGTvt2tyoqGNJydjW32VQs0vs5XVc8d/M5FJpQQgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awACQIBAQIBAwAAAKWXTEBAq5u+FwX5AZapJ7qj7G7SIxP3mYey+otzvhefEAHYJdPBfgqNhf9vXtvya+ip4ZEJR6rubhW79ZMAabO48RERAmKv6d1LDUzhxxrKW1iDGkYD6tZ9TfORRKQKkfWd11g8EAFfm8qRd2+WVybP18udB0457INJ3U11YNIZvdKFY1rQjBECDegFhb6zh0BzQ1pirX6IQGLel/eF8+xv98HZYmkJgBAQAVAO5YGj0RWNmvhmC0NqrtWHwnjSUQNxd6uYRJMjfcPrEQEgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/ax/AwEAAAsACAAAAAAAAAAAAAQBAQAFAgEBAQCqh3fBWf3zs2zg6Wt8+AFC1/58xqnqSxC9exEK7kPRhRACKQ9N/X8hOac8dT4zuZC4upFtihZq9JsYfb5UoiGIDyIQAUYZe6LR2JrmXw44tCBxZtK21SAUzHBMVnCCvx29ZfnfEQIBAWUDAQAALQAqAAAAAAAAACECyLR0e1KMrF/d96bMY3Au4E7X0TMpBOCFEDQ+oA3OVGoAAAMBAQAtACoAAQACAAAAIQIB7ij4T1SFOQVn6TnCtYYBC2Omnsksq1NdyWqMcZE2AgAAEAEBQNkCAaylxbCNFaN71X5p+nfqhe5T3e5JDjX3BTp7s2veVhTOAgHZbe7OzqjzwOzXn6NLbzSt8PItwUVj91x8pf3lguQGEAE2pM5PtpHXYchTiDJh5csJWcrbCMX9R548J6lvLkRY1AKghzeA2y1iYD9QJGMD9IAzws0Sh9r+EI5NYy7xhp72chABtgUnjZcfcBf5QBfldwp2LQHKYDCIWImz4Q/4E46nyQMEIOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAUCAQEBAPLfdXh4PcRzmCXJPABALtDjvEgBgLJwwOYCf0L54idmEAFJybKFoR6l0GDoa2MQGMKbvM0N4w1AhupCbh4b3NiCWhEC0vjwIA7WA1zKJTmJ6cqaWFgqIs59iDoqcRdSLsZEaLkQAXPWZ9eFJe3P3Uf6GA/WznOBSDg+hIny9UF6gSdQJYiIERERAiDmaMZZr2au4ecsGG3ee1t+Ch1xKgnEDVch9iK/U8UxVf8eAwEAD1gA+1MPAOZoxlmvZq7h5ywYbd57W34KHXEqCcQNVyH2Ir9TxTFVAAAAAAABAAABMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awAAgZkb21haW4WBhIEdHlwZRIGb2JqZWN0EgdpbmRpY2VzFQMWAxIEbmFtZRIScGFyZW50TmFtZUFuZExhYmVsEgpwcm9wZXJ0aWVzFQIWARIabm9ybWFsaXplZFBhcmVudERvbWFpbk5hbWUSA2FzYxYBEg9ub3JtYWxpemVkTGFiZWwSA2FzYxIGdW5pcXVlEwEWAxIEbmFtZRIOZGFzaElkZW50aXR5SWQSCnByb3BlcnRpZXMVARYBEhxyZWNvcmRzLmRhc2hVbmlxdWVJZGVudGl0eUlkEgNhc2MSBnVuaXF1ZRMBFgISBG5hbWUSCWRhc2hBbGlhcxIKcHJvcGVydGllcxUBFgESG3JlY29yZHMuZGFzaEFsaWFzSWRlbnRpdHlJZBIDYXNjEgpwcm9wZXJ0aWVzFgcSBWxhYmVsFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhIqXlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCAxIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgASC2Rlc2NyaXB0aW9uEhlEb21haW4gbGFiZWwuIGUuZy4gJ0JvYicuEg9ub3JtYWxpemVkTGFiZWwWBhIEdHlwZRIGc3RyaW5nEgdwYXR0ZXJuEjxeW2EtaGota20tbnAtejAtOV1bYS1oai1rbS1ucC16MC05LV17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1heExlbmd0aAI/Eghwb3NpdGlvbgIBEgtkZXNjcmlwdGlvbhKjRG9tYWluIGxhYmVsIGNvbnZlcnRlZCB0byBsb3dlcmNhc2UgZm9yIGNhc2UtaW5zZW5zaXRpdmUgdW5pcXVlbmVzcyB2YWxpZGF0aW9uLiAibyIsICJpIiBhbmQgImwiIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIgdG8gbWl0aWdhdGUgaG9tb2dyYXBoIGF0dGFjay4gZS5nLiAnYjBiJxIIJGNvbW1lbnQSXE11c3QgYmUgZXF1YWwgdG8gdGhlIGxhYmVsIGluIGxvd2VyY2FzZS4gIm8iLCAiaSIgYW5kICJsIiBtdXN0IGJlIHJlcGxhY2VkIHdpdGggIjAiIGFuZCAiMSIuEhBwYXJlbnREb21haW5OYW1lFgYSBHR5cGUSBnN0cmluZxIHcGF0dGVybhItXiR8XlthLXpBLVowLTldW2EtekEtWjAtOS1dezAsNjF9W2EtekEtWjAtOV0kEgltaW5MZW5ndGgCABIJbWF4TGVuZ3RoAj8SCHBvc2l0aW9uAgISC2Rlc2NyaXB0aW9uEidBIGZ1bGwgcGFyZW50IGRvbWFpbiBuYW1lLiBlLmcuICdkYXNoJy4SGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lFgcSBHR5cGUSBnN0cmluZxIHcGF0dGVybhJBXiR8XlthLWhqLWttLW5wLXowLTldW2EtaGota20tbnAtejAtOS1cLl17MCw2MX1bYS1oai1rbS1ucC16MC05XSQSCW1pbkxlbmd0aAIAEgltYXhMZW5ndGgCPxIIcG9zaXRpb24CAxILZGVzY3JpcHRpb24SokEgcGFyZW50IGRvbWFpbiBuYW1lIGluIGxvd2VyY2FzZSBmb3IgY2FzZS1pbnNlbnNpdGl2ZSB1bmlxdWVuZXNzIHZhbGlkYXRpb24uICJvIiwgImkiIGFuZCAibCIgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIiB0byBtaXRpZ2F0ZSBob21vZ3JhcGggYXR0YWNrLiBlLmcuICdkYXNoJxIIJGNvbW1lbnQSwE11c3QgZWl0aGVyIGJlIGVxdWFsIHRvIGFuIGV4aXN0aW5nIGRvbWFpbiBvciBlbXB0eSB0byBjcmVhdGUgYSB0b3AgbGV2ZWwgZG9tYWluLiAibyIsICJpIiBhbmQgImwiIG11c3QgYmUgcmVwbGFjZWQgd2l0aCAiMCIgYW5kICIxIi4gT25seSB0aGUgZGF0YSBjb250cmFjdCBvd25lciBjYW4gY3JlYXRlIHRvcCBsZXZlbCBkb21haW5zLhIMcHJlb3JkZXJTYWx0FgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CBBILZGVzY3JpcHRpb24SIlNhbHQgdXNlZCBpbiB0aGUgcHJlb3JkZXIgZG9jdW1lbnQSB3JlY29yZHMWBxIEdHlwZRIGb2JqZWN0Egpwcm9wZXJ0aWVzFgISFGRhc2hVbmlxdWVJZGVudGl0eUlkFggSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABIQY29udGVudE1lZGlhVHlwZRIhYXBwbGljYXRpb24veC5kYXNoLmRwcC5pZGVudGlmaWVyEgtkZXNjcmlwdGlvbhI+SWRlbnRpdHkgSUQgdG8gYmUgdXNlZCB0byBjcmVhdGUgdGhlIHByaW1hcnkgbmFtZSB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchITZGFzaEFsaWFzSWRlbnRpdHlJZBYIEgR0eXBlEgVhcnJheRIJYnl0ZUFycmF5EwESCG1pbkl0ZW1zAiASCG1heEl0ZW1zAiASCHBvc2l0aW9uAgESEGNvbnRlbnRNZWRpYVR5cGUSIWFwcGxpY2F0aW9uL3guZGFzaC5kcHAuaWRlbnRpZmllchILZGVzY3JpcHRpb24SPUlkZW50aXR5IElEIHRvIGJlIHVzZWQgdG8gY3JlYXRlIGFsaWFzIG5hbWVzIGZvciB0aGUgSWRlbnRpdHkSCCRjb21tZW50EiNNdXN0IGJlIGVxdWFsIHRvIHRoZSBkb2N1bWVudCBvd25lchINbWluUHJvcGVydGllcwIBEg1tYXhQcm9wZXJ0aWVzAgESCHBvc2l0aW9uAgUSFGFkZGl0aW9uYWxQcm9wZXJ0aWVzEwASCCRjb21tZW50EpBDb25zdHJhaW50IHdpdGggbWF4IGFuZCBtaW4gcHJvcGVydGllcyBlbnN1cmUgdGhhdCBvbmx5IG9uZSBpZGVudGl0eSByZWNvcmQgaXMgdXNlZCAtIGVpdGhlciBhIGBkYXNoVW5pcXVlSWRlbnRpdHlJZGAgb3IgYSBgZGFzaEFsaWFzSWRlbnRpdHlJZGASDnN1YmRvbWFpblJ1bGVzFgYSBHR5cGUSBm9iamVjdBIKcHJvcGVydGllcxYBEg9hbGxvd1N1YmRvbWFpbnMWBBIEdHlwZRIHYm9vbGVhbhILZGVzY3JpcHRpb24SW1RoaXMgb3B0aW9uIGRlZmluZXMgd2hvIGNhbiBjcmVhdGUgc3ViZG9tYWluczogdHJ1ZSAtIGFueW9uZTsgZmFsc2UgLSBvbmx5IHRoZSBkb21haW4gb3duZXISCCRjb21tZW50Ek9Pbmx5IHRoZSBkb21haW4gb3duZXIgaXMgYWxsb3dlZCB0byBjcmVhdGUgc3ViZG9tYWlucyBmb3Igbm9uIHRvcC1sZXZlbCBkb21haW5zEghwb3NpdGlvbgIAEghwb3NpdGlvbgIGEgtkZXNjcmlwdGlvbhJCU3ViZG9tYWluIHJ1bGVzIGFsbG93IGRvbWFpbiBvd25lcnMgdG8gZGVmaW5lIHJ1bGVzIGZvciBzdWJkb21haW5zEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEghyZXF1aXJlZBUBEg9hbGxvd1N1YmRvbWFpbnMSCHJlcXVpcmVkFQYSBWxhYmVsEg9ub3JtYWxpemVkTGFiZWwSGm5vcm1hbGl6ZWRQYXJlbnREb21haW5OYW1lEgxwcmVvcmRlclNhbHQSB3JlY29yZHMSDnN1YmRvbWFpblJ1bGVzEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBL7ATdJbiBvcmRlciB0byByZWdpc3RlciBhIGRvbWFpbiB5b3UgbmVlZCB0byBjcmVhdGUgYSBwcmVvcmRlci4gVGhlIHByZW9yZGVyIHN0ZXAgaXMgbmVlZGVkIHRvIHByZXZlbnQgbWFuLWluLXRoZS1taWRkbGUgYXR0YWNrcy4gbm9ybWFsaXplZExhYmVsICsgJy4nICsgbm9ybWFsaXplZFBhcmVudERvbWFpbiBtdXN0IG5vdCBiZSBsb25nZXIgdGhhbiAyNTMgY2hhcnMgbGVuZ3RoIGFzIGRlZmluZWQgYnkgUkZDIDEwMzUuIERvbWFpbiBkb2N1bWVudHMgYXJlIGltbXV0YWJsZTogbW9kaWZpY2F0aW9uIGFuZCBkZWxldGlvbiBhcmUgcmVzdHJpY3RlZAhwcmVvcmRlchYGEgR0eXBlEgZvYmplY3QSB2luZGljZXMVARYDEgRuYW1lEgpzYWx0ZWRIYXNoEgpwcm9wZXJ0aWVzFQEWARIQc2FsdGVkRG9tYWluSGFzaBIDYXNjEgZ1bmlxdWUTARIKcHJvcGVydGllcxYBEhBzYWx0ZWREb21haW5IYXNoFgYSBHR5cGUSBWFycmF5EglieXRlQXJyYXkTARIIbWluSXRlbXMCIBIIbWF4SXRlbXMCIBIIcG9zaXRpb24CABILZGVzY3JpcHRpb24SWURvdWJsZSBzaGEtMjU2IG9mIHRoZSBjb25jYXRlbmF0aW9uIG9mIGEgMzIgYnl0ZSByYW5kb20gc2FsdCBhbmQgYSBub3JtYWxpemVkIGRvbWFpbiBuYW1lEghyZXF1aXJlZBUBEhBzYWx0ZWREb21haW5IYXNoEhRhZGRpdGlvbmFsUHJvcGVydGllcxMAEggkY29tbWVudBJKUHJlb3JkZXIgZG9jdW1lbnRzIGFyZSBpbW11dGFibGU6IG1vZGlmaWNhdGlvbiBhbmQgZGVsZXRpb24gYXJlIHJlc3RyaWN0ZWQAAjfsugQjtjFH1tziawxcHm6Itrtfd4HxFXit+EBuIEGCEAIBYN8CAb/jxzcNWFZEpbAUm+m8bHmGDiDoIp0nmnAVzK1RREtVAtYIgZuRPU70BrwnGYqsfr3rqOmCvT+uOZn5JD+z2Fb7EAHRk0v0/UW0amfTj5Q3RgNXsCy34jIVuLie5yXuiKURfQQgMBLBm5jsADOt2zbNZLf1EGcPKjUaQwS19plBRChu/awACwP9eCCC7wkAAAAApQ40uU7eIE6Lc7gSiikQMybwd7ICds9JRkR7mN9dsKsQAS6QXX9hmpIEs9jEW3eAXNz9stWYGeSq/BnIm9Y+L8XMERECiTcgqXvEL2837Y7t1JcjkYGVIFZ7NkS80ZLVeDUZzS0QAfdYjSzg2BIkhpiPAHQ5W4aN0OlpO7pNjwx46JLVtF5HEQLIaUC5PRYEMoQrfMJnG3PgKokrA37sdKCgo7Hxar/TcRABMapwxTKSfBkDooZq35By87R1c8Y4h4LvZXgOwY+CNfQR", + "quorumHash": "AAAAu4I2BiBDnydSZOLs2bV45yWb+vJFEKQi9wTc3hg=", + "signature": "t6IYrtqREmhCMGQva67DMYpqoY+4fIPB0245y/vhrs0L4qqv7+jDYFoppC7TzFCnCpXLxwOL15u8AOmGFsuMn7FA7qtz/rzJT0124Va1EL5ioeD0DwPVVCAEfQcN/7+6", + "round": 1, + "blockIdHash": "R6LgAhbTCMP2bbiktIm1nLnJ4csO0UvaK6vArGJ2ghs=", + "quorumType": 6 + }, + "metadata": { + "height": "9350", + "coreChainLockedHeight": 929436, + "epoch": 943, + "timeMs": "1702317747792", + "protocolVersion": 1, + "chainId": "dash-testnet-37" + } + } } - [/block] -``` - -## Security Group Endpoints - -Security groups provide a way to distribute token configuration and update authorization across multiple identities. Each group defines a set of member identities, the voting power of each member, and the required power threshold to authorize an action. The endpoints in this section are used to retrieve information about groups and the actions they are performing. - -### getGroupInfo + + ``` + ::: + :::: + ::::: -Retrieves information about a specific group within a contract, including its members and required power. +### getProtocolVersionUpgradeState -**Returns**: Group information containing member details and required power, or a cryptographic proof. +**Returns**: The number of votes cast for each protocol version. **Parameters**: -| Name | Type | Required | Description | -|--------------------------|---------|----------|-------------| -| `contract_id` | Bytes | Yes | The ID of the contract containing the group | -| `group_contract_position` | UInt32 | Yes | The position of the group within the contract | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group information | +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl +:sync: grpcurl ```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "group_contract_position": 1, - "prove": false - } + "v0": { } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getGroupInfo + org.dash.platform.dapi.v0.Platform/getProtocolVersionUpgradeState ``` ::: :::: ::::{tab-set} :::{tab-item} Response (gRPCurl) +:sync: grpcurl ```json { "v0": { - "group_info": { - "group_info": { - "members": [ - { - "member_id": "01abcdef", - "power": 5 - }, - { - "member_id": "02abcdef", - "power": 10 - } - ], - "group_required_power": 15 - } + "versions": { + "versions": [ + { + "versionNumber": 1, + "voteCount": 28 + } + ] }, "metadata": { - "height": "2876", - "coreChainLockedHeight": 1086885, - "epoch": 761, - "timeMs": "1724094056585", + "height": "10649", + "coreChainLockedHeight": 930014, + "epoch": 965, + "timeMs": "1702397313265", "protocolVersion": 1, - "chainId": "dash-testnet-50" + "chainId": "dash-testnet-37" } } } @@ -2742,90 +3030,62 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getGroupInfos - -Retrieves information about multiple groups within a contract, including their members and required power. +### getProtocolVersionUpgradeVoteStatus -**Returns**: A list of group information entries or a cryptographic proof. +**Returns**: Protocol version upgrade status. **Parameters**: -| Name | Type | Required | Description | -|-------------------------------------------|---------|----------|-------------| -| `contract_id` | Bytes | Yes | The ID of the contract containing the groups | -| `start_at_group_contract_position` | Object | No | Filtering options for retrieving groups | -| `start_at_group_contract_position`
`.start_group_contract_position` | UInt32 | No | The position of the first group to retrieve | -| `start_at_group_contract_position`
`.start_group_contract_position_included` | Boolean | No | Whether the start position should be included in the results | -| `count` | UInt32 | No | The maximum number of groups to retrieve | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group information | +| Name | Type | Required | Description | +| ------- | ------- | -------- | ------------ | +| `start_pro_tx_hash` | String | No | Protx hash of an evonode +| `count` | Integer | No | Number of records to request +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity **Example Request and Response** ::::{tab-set} :::{tab-item} gRPCurl +:sync: grpcurl ```shell +# `start_pro_tx_hash` must be represented in base64 if present grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "start_at_group_contract_position": { - "start_group_contract_position": 1, - "start_group_contract_position_included": true - }, - "count": 5, - "prove": false + "count": 2 } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getGroupInfos + org.dash.platform.dapi.v0.Platform/getProtocolVersionUpgradeVoteStatus ``` ::: :::: ::::{tab-set} :::{tab-item} Response (gRPCurl) +:sync: grpcurl ```json { "v0": { - "group_infos": { - "group_infos": [ + "versions": { + "versionSignals": [ { - "group_contract_position": 1, - "members": [ - { - "member_id": "01abcdef", - "power": 5 - }, - { - "member_id": "02abcdef", - "power": 10 - } - ], - "group_required_power": 15 + "proTxHash": "WyRggLpkNQaF/jAtPXkPW7I4y2GZINRiMMhE8HmUSiM=", + "version": 1 }, { - "group_contract_position": 2, - "members": [ - { - "member_id": "03abcdef", - "power": 8 - }, - { - "member_id": "04abcdef", - "power": 12 - } - ], - "group_required_power": 20 + "proTxHash": "XGVCdmYVOHGDcV2VipJVUkcvkzNfoWEogEI+S72u9DY=", + "version": 1 } ] }, "metadata": { - "height": "2876", - "coreChainLockedHeight": 1086885, - "epoch": 761, - "timeMs": "1724094056585", + "height": "10662", + "coreChainLockedHeight": 930024, + "epoch": 966, + "timeMs": "1702398582963", "protocolVersion": 1, - "chainId": "dash-testnet-50" + "chainId": "dash-testnet-37" } } } @@ -2833,81 +3093,15 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getGroupActions - -Retrieves a list of actions performed by a specific group within a contract. - -**Parameters**: - -| Name | Type | Required | Description | -|-----------------------------------|---------|----------|-------------| -| `contract_id` | Bytes | Yes | The ID of the contract containing the group | -| `group_contract_position` | UInt32 | Yes | The position of the group within the contract | -| `status` | Enum | Yes | The status of the actions to retrieve (`ACTIVE = 0`, `CLOSED = 1`) | -| `start_at_action_id` | Object | No | Filtering options for retrieving actions | -| `start_at_action_id.`
`start_action_id` | Bytes | No | The action ID to start retrieving from | -| `start_at_action_id.`
`start_action_id_included` | Boolean | No | Whether the start action should be included in the results | -| `count` | UInt32 | No | The maximum number of actions to retrieve | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group actions | - -**Returns**: A list of group actions or a cryptographic proof. The response message contains details about actions performed by a group, including various event types related to token operations, document updates, contract updates, and emergency actions. The list of possible actions is shown in the table below: - -| Event Type | Subtype | Description | -|-------------------|---------------------------|-------------| -| **TokenEvent** | `mint` | Mints new tokens to a specified recipient. | -| | `burn` | Burns (destroys) a specified amount of tokens. | -| | `freeze` | Freezes a specific entity's tokens. | -| | `unfreeze` | Unfreezes a specific entity's tokens. | -| | `destroy_frozen_funds` | Destroys frozen funds for a specified entity. | -| | `transfer` | Transfers tokens to another recipient. | -| | `emergency_action` | Performs emergency actions like pausing or resuming the contract. | -| | `token_config_update` | Updates token configuration settings. | -| **DocumentEvent** | `create` | Represents the creation of a document. | -| **ContractEvent** | `update` | Represents updates to a contract. | +### getStatus -**Response Object** +Retrieves status information related to Dash Platform. -| Name | Type | Description | -|---------------------|----------|-------------| -| `group_actions` | Object | Contains a list of group actions | -| `group_actions.group_actions` | Array of `GroupActionEntry` | A list of actions performed by the group | -| `group_actions.group_actions[]`
`.action_id` | Bytes | Unique identifier for the action | -| `group_actions.group_actions[]`
`.event` | Object | The event data associated with the action | -| `group_actions.group_actions[]`
`.event.event_type` | Object | The specific type of event | -| `group_actions.group_actions[]`
`.event.event_type.token_event` | Object | Token-related event details (if applicable). See [Token Event details](#token-event-fields) below for complete information. | -| `group_actions.group_actions[]`
`.event.event_type.document_event` | Object | Document-related event details | -| `group_actions.group_actions[]`
`.event.event_type.document_event`
`.create` | Object | Document creation event details | -| `group_actions.group_actions[]`
`.event.event_type.document_event`
`.create.created_document` | Bytes | Created document data | -| `group_actions.group_actions[]`
`.event.event_type.contract_event` | Object | Contract-related event details | -| `group_actions.group_actions[]`
`.event.event_type.contract_event`
`.update` | Object | Contract update event details | -| `group_actions.group_actions[]`
`.event.event_type.contract_event`
`.update.updated_contract` | Bytes | Updated contract data | -| `metadata` | Object | Metadata about the blockchain state. See [metadata details](#data-proofs-and-metadata) for complete information | +**Returns**: Status details including version, node, chain, network, and state sync information, or a cryptographic proof. -#### Token Event Fields +**Parameters**: -| Token Event Type | Field Name | Type | Description | -|-----------------|------------|------|-------------| -| `mint` | `amount` | UInt64 | Amount of tokens to mint. | -| | `recipient_id` | Bytes | Identity ID of the recipient. | -| | `public_note` | String (Optional) | A public note for the mint event. | -| `burn` | `amount` | UInt64 | Amount of tokens to burn. | -| | `public_note` | String (Optional) | A public note for the burn event. | -| `freeze` | `frozen_id` | Bytes | Identifier of the entity being frozen. | -| | `public_note` | String (Optional) | A public note for the freeze event. | -| `unfreeze` | `frozen_id` | Bytes | Identifier of the entity being unfrozen. | -| | `public_note` | String (Optional) | A public note for the unfreeze event. | -| `destroy_frozen_funds` | `frozen_id` | Bytes | Identifier of the frozen entity. | -| | `amount` | UInt64 | Amount of frozen funds to destroy. | -| | `public_note` | String (Optional) | A public note for the destruction event. | -| `transfer` | `recipient_id` | Bytes | Identity ID of the recipient. | -| | `amount` | UInt64 | Amount of tokens transferred. | -| | `public_note` | String (Optional) | A public note for the transfer event. | -| | `shared_encrypted_note` | Object (Optional) | Encrypted note shared by sender and recipient. | -| | `personal_encrypted_note` | Object (Optional) | Personal encrypted note. | -| `emergency_action` | `action_type` | Enum (`PAUSE = 0`, `RESUME = 1`) | Type of emergency action performed. | -| | `public_note` | String (Optional) | A public note for the emergency action. | -| `token_config_update` | `token_config_update_item` | Bytes | Configuration update details. | -| | `public_note` | String (Optional) | A public note for the configuration update. | +This endpoint does not require any parameters. **Example Request and Response** @@ -2916,67 +3110,61 @@ Retrieves a list of actions performed by a specific group within a contract. ```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "group_contract_position": 1, - "status": 0, - "start_at_action_id": { - "start_action_id": "01abcdef", - "start_action_id_included": true - }, - "count": 5, - "prove": false - } + "v0": {} }' \ - seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getGroupActions -``` -::: -:::: - -::::{tab-set} -:::{tab-item} Response (gRPCurl) -```json -{ - "v0": { - "group_actions": { - "group_actions": [ - { - "action_id": "01abcdef", - "event": { - "event_type": { - "token_event": { - "mint": { - "amount": "1000", - "recipient_id": "02abcdef", - "public_note": "Minting 1000 tokens" - } - } - } - } + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getStatus +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (gRPCurl) +```json +{ + "v0": { + "version": { + "software": { + "dapi": "1.2.0", + "drive": "1.2.0", + "tenderdash": "1.2.1" + }, + "protocol": { + "tenderdash": { + "p2p": 10, + "block": 14 }, - { - "action_id": "02abcdef", - "event": { - "event_type": { - "token_event": { - "burn": { - "amount": "500", - "public_note": "Burning 500 tokens" - } - } - } - } + "drive": { + "latest": 1, + "current": 1 } - ] + } }, - "metadata": { - "height": "2876", - "coreChainLockedHeight": 1086885, - "epoch": 761, - "timeMs": "1724094056585", - "protocolVersion": 1, - "chainId": "dash-testnet-50" + "node": { + "id": "H/vx0yVB3Lj1VVMFKVcEqf+a3CQ=", + "proTxHash": "LkhlGi6cDLTy+3q4dAYapK8M0otZaVYx5qNa85UO9vs=" + }, + "chain": { + "latestBlockHash": "XY1U/Ay7DCdZqJJwM4sXSw1OFdBIbnVYFc9sJep1hNw=", + "latestAppHash": "9wq6IzU4AjuL27HybKqvWOOPCbnpBJQjk6q64nsd7i8=", + "latestBlockHeight": "7768", + "earliestBlockHash": "CPoCwn7AOQujAeT8fj1+rbNQyBk+PmKgk2iXBuOiC/o=", + "earliestAppHash": "vwzLnKBxugGubmegwJD5eAPSbVbWddzVExeBy8rI7I8=", + "earliestBlockHeight": "1", + "maxPeerBlockHeight": "7768", + "coreChainLockedHeight": 1099682 + }, + "network": { + "chainId": "dash-testnet-51", + "peersCount": 61, + "listening": true + }, + "stateSync": {}, + "time": { + "local": "1725890999274", + "block": "1725890829092", + "genesis": "0", + "epoch": 1260 } } } @@ -2984,21 +3172,17 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getGroupActionSigners +### getTotalCreditsInPlatform -Retrieves the signers for a specified group action within a contract, along with their assigned power. +Retrieves the total credits in the platform. -**Returns**: A list of group action signers or a cryptographic proof. +**Returns**: The total amount of credits or a cryptographic proof. -**Parameters** +**Parameters**: -| Name | Type | Required | Description | -|---------------------------|---------|----------|-------------| -| `contract_id` | Bytes | Yes | The ID of the contract containing the group action. | -| `group_contract_position` | UInt32 | Yes | The position of the group within the contract. | -| `status` | Enum | Yes | The status of the action (`ACTIVE = 0`, `CLOSED = 1`). | -| `action_id` | Bytes | Yes | The unique identifier of the action. | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested group action signers. | +| Name | Type | Required | Description | +| ------- | -------- | -------- | ----------- | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested credit total | **Example Request and Response** @@ -3007,16 +3191,10 @@ Retrieves the signers for a specified group action within a contract, along with ```shell grpcurl -proto protos/platform/v0/platform.proto \ -d '{ - "v0": { - "contract_id": "5mjGWa9mruHnLBht3ntbfgodcSoJxA1XIfYiv1PFMVU=", - "group_contract_position": 1, - "status": 0, - "action_id": "01abcdef", - "prove": false - } + "v0": {} }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getGroupActionSigners + org.dash.platform.dapi.v0.Platform/getTotalCreditsInPlatform ``` ::: :::: @@ -3026,23 +3204,12 @@ grpcurl -proto protos/platform/v0/platform.proto \ ```json { "v0": { - "group_action_signers": { - "signers": [ - { - "signer_id": "01abcdef", - "power": 5 - }, - { - "signer_id": "02abcdef", - "power": 10 - } - ] - }, + "credits": "1594457743625920", "metadata": { - "height": "2876", - "coreChainLockedHeight": 1086885, - "epoch": 761, - "timeMs": "1724094056585", + "height": "3263", + "coreChainLockedHeight": 1087403, + "epoch": 781, + "timeMs": "1724165757972", "protocolVersion": 1, "chainId": "dash-testnet-50" } @@ -3054,6 +3221,9 @@ grpcurl -proto protos/platform/v0/platform.proto \ ## Token Endpoints +:::{versionadded} 2.0.0 +::: + ### getIdentityTokenBalances Retrieves token balances for a specified identity. @@ -3318,18 +3488,20 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: -### getTokenStatuses +### getTokenDirectPurchasePrices -Retrieves the statuses of specified tokens. +Retrieves direct purchase prices defined for the specified token IDs. -**Returns**: A list of token statuses or a cryptographic proof. +This endpoint provides pricing data for tokens that support direct purchases. Each token may have either a fixed price or a tiered pricing schedule that depends on the quantity being purchased. + +**Returns**: A list of token price entries or a cryptographic proof containing the requested data. **Parameters**: | Name | Type | Required | Description | -|------------|---------|----------|-------------| -| `token_ids` | Array of Bytes | Yes | A list of token IDs to retrieve statuses for | -| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested token statuses | +|-------------|----------|----------|-------------| +| `token_ids` | Array | Yes | List of 32-byte token IDs to retrieve pricing for. Must be unique and non-empty. | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested pricing data | **Example Request and Response** @@ -3339,30 +3511,26 @@ Retrieves the statuses of specified tokens. grpcurl -proto protos/platform/v0/platform.proto \ -d '{ "v0": { - "token_ids": ["01abcdef", "02abcdef"], + "token_ids": ["2f8d91fe65b3b9f1d473ad729f7861e27159be9a93d5748591ecdbbda5e776c0"], "prove": false } }' \ seed-1.testnet.networks.dash.org:1443 \ - org.dash.platform.dapi.v0.Platform/getTokenStatuses + org.dash.platform.dapi.v0.Platform/getTokenDirectPurchasePrices ``` ::: :::: ::::{tab-set} -:::{tab-item} Response (gRPCurl) +:::{tab-item} Response (Fixed Price) ```json { "v0": { - "token_statuses": { - "token_statuses": [ - { - "token_id": "01abcdef", - "paused": false - }, + "tokenDirectPurchasePrices": { + "tokenDirectPurchasePrice": [ { - "token_id": "02abcdef", - "paused": true + "tokenId": "2f8d91fe65b3b9f1d473ad729f7861e27159be9a93d5748591ecdbbda5e776c0", + "fixedPrice": "1000" } ] }, @@ -3378,6 +3546,104 @@ grpcurl -proto protos/platform/v0/platform.proto \ } ``` ::: + +:::{tab-item} Response (Tiered Pricing) +```json +{ + "v0": { + "tokenDirectPurchasePrices": { + "tokenDirectPurchasePrice": [ + { + "tokenId": "ab1c23d4ef567890fedcba9876543210ab1c23d4ef567890fedcba9876543210", + "variablePrice": { + "priceForQuantity": [ + { + "quantity": "1", + "price": "1000" + }, + { + "quantity": "10", + "price": "900" + }, + { + "quantity": "100", + "price": "750" + } + ] + } + } + ] + }, + "metadata": { + "height": "2880", + "coreChainLockedHeight": 1086890, + "epoch": 762, + "timeMs": "1724095000000", + "protocolVersion": 1, + "chainId": "dash-testnet-50" + } + } +} +``` +::: +:::: + +### getTokenPerpetualDistributionLastClaim + +Retrieves the last-claim timestamp for a token’s perpetual distribution for a specific identity. + +**Returns**: A timestamp indicating the last successful claim, or a cryptographic proof. + +**Parameters**: + +| Name | Type | Required | Description | +|---------------------------|---------|----------|-------------| +| `token_id` | Bytes | Yes | The unique 32-byte identifier of the token | +| `contract_info` | Object | No | Token contract info, used to disambiguate tokens with the same ID across contracts | +| `contract_info.`
`contract_id` | Bytes | Yes (if `contract_info` is provided) | ID of the data contract where the token is defined | +| `contract_info.`
`token_contract_position` | Integer | Yes (if `contract_info` is provided) | Token position within the contract | +| `identity_id` | Bytes | Yes | Identity whose last-claim info is being requested | +| `prove` | Boolean | No | Set to `true` to receive a proof containing the requested last-claim data | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "token_id": "2wXv5jz2WxOqZ6RtN4xkGAMeA9ElvZyMvP9pshHylrs=", + "identity_id": "HpGErJllHxDvKnetz9d88452CCfWsbm8s+SLq7hn1v4=", + "prove": false + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getTokenPerpetualDistributionLastClaim +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (gRPCurl) +```json +{ + "v0": { + "lastClaim": { + "timestampMs": "1744857654321" + }, + "metadata": { + "height": "164312", + "coreChainLockedHeight": 2256151, + "epoch": 25, + "timeMs": "1744857654873", + "protocolVersion": 8, + "chainId": "evo1" + } + } +} +``` +::: :::: ### getTokenPreProgrammedDistributions @@ -3458,6 +3724,68 @@ grpcurl -proto protos/platform/v0/platform.proto \ ::: :::: +### getTokenStatuses + +Retrieves the statuses of specified tokens. + +**Returns**: A list of token statuses or a cryptographic proof. + +**Parameters**: + +| Name | Type | Required | Description | +|------------|---------|----------|-------------| +| `token_ids` | Array of Bytes | Yes | A list of token IDs to retrieve statuses for | +| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested token statuses | + +**Example Request and Response** + +::::{tab-set} +:::{tab-item} gRPCurl +```shell +grpcurl -proto protos/platform/v0/platform.proto \ + -d '{ + "v0": { + "token_ids": ["01abcdef", "02abcdef"], + "prove": false + } + }' \ + seed-1.testnet.networks.dash.org:1443 \ + org.dash.platform.dapi.v0.Platform/getTokenStatuses +``` +::: +:::: + +::::{tab-set} +:::{tab-item} Response (gRPCurl) +```json +{ + "v0": { + "token_statuses": { + "token_statuses": [ + { + "token_id": "01abcdef", + "paused": false + }, + { + "token_id": "02abcdef", + "paused": true + } + ] + }, + "metadata": { + "height": "2876", + "coreChainLockedHeight": 1086885, + "epoch": 761, + "timeMs": "1724094056585", + "protocolVersion": 1, + "chainId": "dash-testnet-50" + } + } +} +``` +::: +:::: + ### getTokenTotalSupply Retrieves the total supply of a specified token, including aggregated user accounts and system-held amounts. diff --git a/docs/reference/dapi-endpoints.md b/docs/reference/dapi-endpoints.md index 08942e45d..e74fc6b6e 100644 --- a/docs/reference/dapi-endpoints.md +++ b/docs/reference/dapi-endpoints.md @@ -43,6 +43,7 @@ without introducing issues for endpoint consumers. | [`getIdentity`](../reference/dapi-endpoints-platform-endpoints.md#getidentity) | Returns the requested identity | | [`getIdentityBalance`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybalance) | Returns the requested identity's balance | | [`getIdentityBalanceAndRevision`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybalanceandrevision) | Returns the requested identity's balance and revision | +| [`getIdentityByNonUniquePublicKeyHash`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybynonuniquepublickeyhash) | **Added in Dash Platform v2.0.0**
Returns one or more identities associated with a public key hash, including for non-unique masternode keys. | | [`getIdentityByPublicKeyHash`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybypublickeyhash) | Returns the identity associated with the provided public key hash | | [`getIdentityContractNonce`](../reference/dapi-endpoints-platform-endpoints.md#getidentitycontractnonce) | Returns the identity contract nonce | | [`getIdentityKeys`](../reference/dapi-endpoints-platform-endpoints.md#getidentitykeys) | Returns the requested identity keys @@ -98,8 +99,10 @@ Security groups provide a way to distribute token configuration and update autho | [`getIdentitiesTokenBalances`](../reference/dapi-endpoints-platform-endpoints.md#getidentitiestokenbalances) | Retrieves the token balances for a list of specified identities. | | [`getIdentityTokenInfos`](../reference/dapi-endpoints-platform-endpoints.md#getidentitytokeninfos) | Retrieves information about specified tokens for a given identity. | | [`getIdentitiesTokenInfos`](../reference/dapi-endpoints-platform-endpoints.md#getidentitiestokeninfos) | Retrieves token information for a list of specified identities. | -| [`getTokenStatuses`](../reference/dapi-endpoints-platform-endpoints.md#gettokenstatuses) | Retrieves the statuses of specified tokens. | +| [`getTokenDirectPurchasePrices`](../reference/dapi-endpoints-platform-endpoints.md#gettokendirectpurchaseprices) | Retrieves direct purchase prices defined for the specified token IDs. | +| [`getTokenPerpetualDistributionLastClaim`](../reference/dapi-endpoints-platform-endpoints.md#gettokenperpetualdistributionlastclaim) | Retrieves the last-claim timestamp for a token’s perpetual distribution for a specific identity. | | [`getTokenPreProgrammedDistributions`](../reference/dapi-endpoints-platform-endpoints.md#gettokenpreprogrammeddistributions) | Retrieves pre-programmed distributions of a specified token. | +| [`getTokenStatuses`](../reference/dapi-endpoints-platform-endpoints.md#gettokenstatuses) | Retrieves the statuses of specified tokens. | | [`getTokenTotalSupply`](../reference/dapi-endpoints-platform-endpoints.md#gettokentotalsupply) | Retrieves the total supply of a specified token, including aggregated user accounts and system-held amounts. | ```{eval-rst}