diff --git a/docs/explanations/dashpay.md b/docs/explanations/dashpay.md index 6e1082561..b6a29f6e0 100644 --- a/docs/explanations/dashpay.md +++ b/docs/explanations/dashpay.md @@ -81,7 +81,7 @@ used to store private information about other Dash identities. ### Implementation DashPay has many constraints as defined in the [DashPay data -contract](https://github.com/dashevo/platform/blob/master/packages/dashpay-contract/schema/dashpay.schema.json). +contract](https://github.com/dashpay/platform/blob/master/packages/dashpay-contract/schema/dashpay.schema.json). Additionally, the DashPay data triggers defined in [rs-drive-abci](https://github.com/dashpay/platform/tree/master/packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/documents_batch/data_triggers/triggers/dashpay) enforce additional validation rules related to the `contactRequest` document. diff --git a/docs/explanations/dpns.md b/docs/explanations/dpns.md index 136417391..34988589f 100644 --- a/docs/explanations/dpns.md +++ b/docs/explanations/dpns.md @@ -56,7 +56,7 @@ DPNS names have several constraints as defined in the [DPNS data contract](https * Maximum length - 63 characters * Character set - `0-9`, `-` (hyphen), and `A-Z` (case insensitive) - * Note: Use of `-` as a prefix/suffix to a name is _not_ allowed (e.g. `-name` or `name-`). This constraint is defined by this JSON-Schema [pattern](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L38) in the DPNS data contract: `^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$` + * Note: Use of `-` as a prefix/suffix to a name is _not_ allowed (e.g. `-name` or `name-`). This constraint is defined by this JSON-Schema [pattern](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L38) in the DPNS data contract: `^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$` * Domain labels are converted to lowercase for case-insensitive uniqueness validation. Then, "o", "i" and "l" replaced with "0" and "1" to mitigate [homograph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack). For example, "Alice" is normalized "a11ce". Additional validation rules related to the `domain` document are enforced by the DPNS [data triggers](../explanations/platform-protocol-data-trigger.md) defined in [rs-drive-abci](https://github.com/dashpay/platform/tree/master/packages/rs-drive-abci/src/execution/validation/state_transition/state_transitions/documents_batch/data_triggers/triggers). diff --git a/docs/explanations/platform-protocol-data-contract.md b/docs/explanations/platform-protocol-data-contract.md index 6e23a7967..ecf595e46 100644 --- a/docs/explanations/platform-protocol-data-contract.md +++ b/docs/explanations/platform-protocol-data-contract.md @@ -18,7 +18,7 @@ Data contracts are owned by the [identity](../explanations/identity.md) that reg ### Structure -Each data contract must define several fields. When using the [reference implementation](https://github.com/dashevo/platform/tree/master/packages/rs-dpp) of the Dash Platform Protocol, some of these fields are automatically set to a default value and do not have to be explicitly provided. These include: +Each data contract must define several fields. When using the [reference implementation](https://github.com/dashpay/platform/tree/master/packages/rs-dpp) of the Dash Platform Protocol, some of these fields are automatically set to a default value and do not have to be explicitly provided. These include: * The platform protocol schema it uses * A contract ID (generated from a hash of the data contract's owner identity plus some entropy) @@ -62,7 +62,7 @@ Dash Platform v0.22 added the ability to update existing data contracts in certa ## Example Contract -The [DashPay contract](https://github.com/dashevo/platform/blob/master/packages/dashpay-contract/schema/dashpay.schema.json) is included below for reference. It defines a `contact` document and a `profile` document. Each of these documents then defines the properties and indices they require: +The [DashPay contract](https://github.com/dashpay/platform/blob/master/packages/dashpay-contract/schema/dashpay.schema.json) is included below for reference. It defines a `contact` document and a `profile` document. Each of these documents then defines the properties and indices they require: ```json { diff --git a/docs/explanations/platform-protocol-document.md b/docs/explanations/platform-protocol-document.md index 52ad5b395..4ef649e3b 100644 --- a/docs/explanations/platform-protocol-document.md +++ b/docs/explanations/platform-protocol-document.md @@ -14,7 +14,7 @@ Documents are defined in an application's [Data Contract](../explanations/platfo ### Base Fields -Dash Platform Protocol (DPP) defines a set of base fields that must be present in all documents. For the [reference implementation](https://github.com/dashevo/platform/tree/master/packages/rs-dpp), the base fields shown below are defined in the [document base schema](https://github.com/dashevo/platform/blob/master/packages/rs-dpp/src/schema/document/v0/documentBase.json). +Dash Platform Protocol (DPP) defines a set of base fields that must be present in all documents. For the [reference implementation](https://github.com/dashpay/platform/tree/master/packages/rs-dpp), the base fields shown below are defined in the [document base schema](https://github.com/dashpay/platform/blob/master/packages/rs-dpp/src/schema/document/v0/documentBase.json). | Field Name | Description | | - | - | @@ -32,7 +32,7 @@ Dash Platform Protocol (DPP) defines a set of base fields that must be present i ### Data Contract Fields -Each application defines its own fields via document definitions in its data contract. Details of the [DPNS data contract documents](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) are described below as an example. This contract defines two document types (`preorder` and `domain`) and provides the functionality described in the [Name Service explanation](../explanations/dpns.md). +Each application defines its own fields via document definitions in its data contract. Details of the [DPNS data contract documents](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) are described below as an example. This contract defines two document types (`preorder` and `domain`) and provides the functionality described in the [Name Service explanation](../explanations/dpns.md). | Document Type | Field Name | Data Type | | - | - | - | diff --git a/docs/explanations/platform-protocol.md b/docs/explanations/platform-protocol.md index 3366dc0cc..0616d60fa 100644 --- a/docs/explanations/platform-protocol.md +++ b/docs/explanations/platform-protocol.md @@ -46,8 +46,8 @@ For additional detail, see the [State Transition](../explanations/platform-proto | :------ | :---------- | | 0.25 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.25.0). | | 0.24 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.24.0). | -| 0.23 | See details in the [GitHub release](https://github.com/dashevo/platform/releases/tag/v0.23.0). | -| 0.22 | See details in the [GitHub release](https://github.com/dashevo/platform/releases/tag/v0.22.0). | +| 0.23 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.23.0). | +| 0.22 | See details in the [GitHub release](https://github.com/dashpay/platform/releases/tag/v0.22.0). | | 0.21 | See details in the [GitHub release](https://github.com/dashevo/js-dpp/releases/tag/v0.21.0). | | 0.20 | This release updated to a newer version of JSON Schema (2020-12 spec) and also switched to a new regex module ([Re2](https://github.com/google/re2)) for improved security. See more details in the [GitHub release](https://github.com/dashevo/js-dpp/releases/tag/v0.20.0). | diff --git a/docs/index.md b/docs/index.md index cb970c563..e2bb5586c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -172,11 +172,11 @@ protocol-ref/errors :hidden: resources/repository-overview -Testnet Block Explorer +Testnet Block Explorer Testnet Faucet -JavaScript SDK +JavaScript SDK resources/source-code -Previous Version of Docs +Previous Version of Docs ``` ```{toctree} diff --git a/docs/intro/testnet.md b/docs/intro/testnet.md index 075173bc5..1b1cf993a 100644 --- a/docs/intro/testnet.md +++ b/docs/intro/testnet.md @@ -12,7 +12,7 @@ Testnet is the Dash testing network used for experimentation and evaluation of D Dash Core Group provides the core Testnet infrastructure consisting of 150 masternodes running Dash Core along with the platform services that provide the [decentralized API (DAPI)](../explanations/dapi.md) and [storage (Drive)](../explanations/drive.md) functionality. -Testnet also includes a [block explorer](https://testnet-insight.dashevo.org/insight/) for the core blockchain and a [test Dash faucet](https://testnet-faucet.dash.org/) that dispenses funds to users/developers experimenting on the network. +Testnet also includes a [block explorer](https://insight.testnet.networks.dash.org:3002/insight/) for the core blockchain and a [test Dash faucet](http://faucet.testnet.networks.dash.org/) that dispenses funds to users/developers experimenting on the network. ### Features diff --git a/docs/intro/what-is-dash-platform.md b/docs/intro/what-is-dash-platform.md index 75d8ce5e5..98516c171 100644 --- a/docs/intro/what-is-dash-platform.md +++ b/docs/intro/what-is-dash-platform.md @@ -51,8 +51,8 @@ The source for both DAPI and dapi-client are available on GitHub: Drive is Dash Platform's storage component, allowing for consensus-based verification and validation of user-created data. In order for this to occur, developers create a [data contract](../explanations/platform-protocol-data-contract.md). This data contract describes the data structures that comprise an application, similar to creating a schema for a document-oriented database like MongoDB. -Data created by users of the application is validated and verified against this contract. Upon successful validation/verification, application data is submitted to Drive (via DAPI), where it is stored on the masternode network. Drive uses Dash's purpose-built database, [GroveDB](https://github.com/dashevo/grovedb/), to provide efficient proofs with query responses, so you don't have to trust the API provider to be certain your data is authentic. +Data created by users of the application is validated and verified against this contract. Upon successful validation/verification, application data is submitted to Drive (via DAPI), where it is stored on the masternode network. Drive uses Dash's purpose-built database, [GroveDB](https://github.com/dashpay/grovedb/), to provide efficient proofs with query responses, so you don't have to trust the API provider to be certain your data is authentic. The source is available on GitHub: -- Drive: +- Drive: diff --git a/docs/other/key-concepts.md b/docs/other/key-concepts.md index 2645ec89f..85550e209 100644 --- a/docs/other/key-concepts.md +++ b/docs/other/key-concepts.md @@ -8,7 +8,7 @@ In order to pay for these various operations, Dash must be spent by either the a # Data Contracts -A data contract is an agreement between your application and the Dash network as to how your data should be stored and validated by the Dash network. The concept is analogous to creating a schema for a document-oriented database. Data contracts are JSON objects, and an example contract for the [Dash Platform Naming Service (DPNS)](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) is included below: +A data contract is an agreement between your application and the Dash network as to how your data should be stored and validated by the Dash network. The concept is analogous to creating a schema for a document-oriented database. Data contracts are JSON objects, and an example contract for the [Dash Platform Naming Service (DPNS)](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) is included below: ```json { diff --git a/docs/protocol-ref/data-contract.md b/docs/protocol-ref/data-contract.md index 3769bb1ee..59eacf901 100644 --- a/docs/protocol-ref/data-contract.md +++ b/docs/protocol-ref/data-contract.md @@ -18,7 +18,7 @@ There are a variety of constraints currently defined for performance and securit > 🚧 > -> The `$ref` keyword has been [disabled](https://github.com/dashevo/platform/pull/300) since Platform v0.22. +> The `$ref` keyword has been [disabled](https://github.com/dashpay/platform/pull/300) since Platform v0.22. | Keyword | Constraint | | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | @@ -346,7 +346,7 @@ The `indices` array consists of: **Note:** - The `indices` object should be excluded for documents that do not require indices. -- When defining an index with multiple properties (i.e a compound index), the order in which the properties are listed is important. Refer to the [mongoDB documentation](https://docs.mongodb.com/manual/core/index-compound/#prefixes) for details regarding the significance of the order as it relates to querying capabilities. Dash uses [GroveDB](https://github.com/dashevo/grovedb) which works similarly but does requiring listing _all_ the index's fields in query order by statements. +- When defining an index with multiple properties (i.e a compound index), the order in which the properties are listed is important. Refer to the [mongoDB documentation](https://docs.mongodb.com/manual/core/index-compound/#prefixes) for details regarding the significance of the order as it relates to querying capabilities. Dash uses [GroveDB](https://github.com/dashpay/grovedb) which works similarly but does requiring listing _all_ the index's fields in query order by statements. ```json "indices": [ diff --git a/docs/protocol-ref/identity.md b/docs/protocol-ref/identity.md index 108e9a45e..fce1cfa01 100644 --- a/docs/protocol-ref/identity.md +++ b/docs/protocol-ref/identity.md @@ -714,14 +714,14 @@ fn sign_by_private_key( match key_type { KeyType::BLS12_381 => self.set_signature(bls.sign(&data, private_key)?.into()), - // https://github.com/dashevo/platform/blob/9c8e6a3b6afbc330a6ab551a689de8ccd63f9120/packages/js-dpp/lib/stateTransition/AbstractStateTransition.js#L169 + // https://github.com/dashpay/platform/blob/9c8e6a3b6afbc330a6ab551a689de8ccd63f9120/packages/js-dpp/lib/stateTransition/AbstractStateTransition.js#L169 KeyType::ECDSA_SECP256K1 | KeyType::ECDSA_HASH160 => { let signature = signer::sign(&data, private_key)?; self.set_signature(signature.to_vec().into()); } // the default behavior from - // https://github.com/dashevo/platform/blob/6b02b26e5cd3a7c877c5fdfe40c4a4385a8dda15/packages/js-dpp/lib/stateTransition/AbstractStateTransition.js#L187 + // https://github.com/dashpay/platform/blob/6b02b26e5cd3a7c877c5fdfe40c4a4385a8dda15/packages/js-dpp/lib/stateTransition/AbstractStateTransition.js#L187 // is to return the error for the BIP13_SCRIPT_HASH KeyType::BIP13_SCRIPT_HASH => { return Err(ProtocolError::InvalidIdentityPublicKeyTypeError( diff --git a/docs/protocol-ref/overview.md b/docs/protocol-ref/overview.md index f4ed6fafd..34663a0ed 100644 --- a/docs/protocol-ref/overview.md +++ b/docs/protocol-ref/overview.md @@ -14,7 +14,7 @@ In addition to ensuring data complies with predefined JSON Schemas, DPP also def ## Reference Implementation -The current reference implementation is the (Rust) [rs-dpp](https://github.com/dashevo/platform/tree/master/packages/rs-dpp) library. The schemas and meta-schemas referred to in this specification can be found here in the reference implementation: . +The current reference implementation is the (Rust) [rs-dpp](https://github.com/dashpay/platform/tree/master/packages/rs-dpp) library. The schemas and meta-schemas referred to in this specification can be found here in the reference implementation: . ## Release Notes diff --git a/docs/reference/dapi-endpoints-core-grpc-endpoints.md b/docs/reference/dapi-endpoints-core-grpc-endpoints.md index 803edcb41..2e27a2ac3 100644 --- a/docs/reference/dapi-endpoints-core-grpc-endpoints.md +++ b/docs/reference/dapi-endpoints-core-grpc-endpoints.md @@ -784,5 +784,5 @@ grpcurl -proto protos/core/v0/core.proto \ Implementation details related to the information on this page can be found in: -- The [Platform repository](https://github.com/dashevo/platform/tree/master/packages/dapi) `packages/dapi/lib/grpcServer/handlers/core` folder -- The [Platform repository](https://github.com/dashevo/platform/tree/master/packages/dapi-grpc) `packages/dapi-grpc/protos/core` folder +- The [Platform repository](https://github.com/dashpay/platform/tree/master/packages/dapi) `packages/dapi/lib/grpcServer/handlers/core` folder +- The [Platform repository](https://github.com/dashpay/platform/tree/master/packages/dapi-grpc) `packages/dapi-grpc/protos/core` folder diff --git a/docs/reference/dapi-endpoints-grpc-overview.md b/docs/reference/dapi-endpoints-grpc-overview.md index 81c07a0c9..7cf2bde4f 100644 --- a/docs/reference/dapi-endpoints-grpc-overview.md +++ b/docs/reference/dapi-endpoints-grpc-overview.md @@ -16,7 +16,7 @@ Clients for a number of languages are built automatically from the protocol defi Some examples shown in the endpoint details pages use a command-line tool named [gRPCurl](https://github.com/fullstorydev/grpcurl) that allows interacting with gRPC servers in a similar way as `curl` does for the [JSON-RPCs](../reference/dapi-endpoints-json-rpc-endpoints.md). Additional information may be found in the [gRPC documentation](https://grpc.io/docs/guides/). -To use gRPCurl as shown in the detailed examples, clone the [platform](https://github.com/dashevo/platform/) repository and execute the example requests from the `packages/dapi-grpc` directory of that repository as shown in this example: +To use gRPCurl as shown in the detailed examples, clone the [platform](https://github.com/dashpay/platform/) repository and execute the example requests from the `packages/dapi-grpc` directory of that repository as shown in this example: ```shell ## Clone the dapi-grpc repository diff --git a/docs/reference/dapi-endpoints-json-rpc-endpoints.md b/docs/reference/dapi-endpoints-json-rpc-endpoints.md index 811dc467f..ffd7de5dd 100644 --- a/docs/reference/dapi-endpoints-json-rpc-endpoints.md +++ b/docs/reference/dapi-endpoints-json-rpc-endpoints.md @@ -363,4 +363,4 @@ There are no recently deprecated endpoint, but the previous version of documenta Implementation details related to the information on this page can be found in: -- The [DAPI repository](https://github.com/dashevo/platform/tree/master/packages/dapi) `lib/rpcServer/commands` folder \ No newline at end of file +- The [DAPI repository](https://github.com/dashpay/platform/tree/master/packages/dapi) `lib/rpcServer/commands` folder \ No newline at end of file diff --git a/docs/reference/dapi-endpoints-platform-endpoints.md b/docs/reference/dapi-endpoints-platform-endpoints.md index 80c874938..ad5de0319 100644 --- a/docs/reference/dapi-endpoints-platform-endpoints.md +++ b/docs/reference/dapi-endpoints-platform-endpoints.md @@ -8,9 +8,9 @@ Please refer to the [gRPC Overview](../reference/dapi-endpoints-grpc-overview.md ## 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/dashevo/platform/tree/master/packages/dapi-grpc). +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). -Some [additional metadata](https://github.com/dashevo/platform/blob/master/packages/dapi-grpc/protos/platform/v0/platform.proto#L48-L55) is also provided with responses: +Some [additional metadata](https://github.com/dashpay/platform/blob/master/packages/dapi-grpc/protos/platform/v0/platform.proto#L48-L55) is also provided with responses: | Metadata field | Description | | :---------------------- | :---------------------------------------------------- | @@ -1872,5 +1872,5 @@ The following endpoints were recently deprecated. See the [previous version of d Implementation details related to the information on this page can be found in: -* The [Platform repository](https://github.com/dashevo/platform/tree/master/packages/dapi) `packages/dapi/lib/grpcServer/handlers/core` folder -* The [Platform repository](https://github.com/dashevo/platform/tree/master/packages/dapi-grpc) `packages/dapi-grpc/protos` folder +* The [Platform repository](https://github.com/dashpay/platform/tree/master/packages/dapi) `packages/dapi/lib/grpcServer/handlers/core` folder +* The [Platform repository](https://github.com/dashpay/platform/tree/master/packages/dapi-grpc) `packages/dapi-grpc/protos` folder diff --git a/docs/reference/data-contracts.md b/docs/reference/data-contracts.md index 7dcdfb879..a6d3ae5c4 100644 --- a/docs/reference/data-contracts.md +++ b/docs/reference/data-contracts.md @@ -117,12 +117,12 @@ The `indices` array consists of: * One or more objects that each contain: * A unique `name` for the index - * A `properties` array composed of a `` object for each document field that is part of the index (sort order: [`asc` only](https://github.com/dashevo/platform/pull/435) for Dash Platform v0.23) + * A `properties` array composed of a `` object for each document field that is part of the index (sort order: [`asc` only](https://github.com/dashpay/platform/pull/435) for Dash Platform v0.23) * An (optional) `unique` element that determines if duplicate values are allowed for the document > 🚧 Compound Indices > -> When defining an index with multiple properties (i.e a compound index), the order in which the properties are listed is important. Refer to the [mongoDB documentation](https://docs.mongodb.com/manual/core/index-compound/#prefixes) for details regarding the significance of the order as it relates to querying capabilities. Dash uses [GroveDB](https://github.com/dashevo/grovedb), which works similarly but does require listing all the index's fields in query order by statements. +> When defining an index with multiple properties (i.e a compound index), the order in which the properties are listed is important. Refer to the [mongoDB documentation](https://docs.mongodb.com/manual/core/index-compound/#prefixes) for details regarding the significance of the order as it relates to querying capabilities. Dash uses [GroveDB](https://github.com/dashpay/grovedb), which works similarly but does require listing all the index's fields in query order by statements. ```json "indices": [ @@ -229,7 +229,7 @@ There are a variety of constraints currently defined for performance and securit > 🚧 > -> The `$ref` keyword has been [disabled](https://github.com/dashevo/platform/pull/300) since Platform v0.22. +> The `$ref` keyword has been [disabled](https://github.com/dashpay/platform/pull/300) since Platform v0.22. | Keyword | Constraint | | ------- | ---------- | diff --git a/docs/reference/platform-proofs.md b/docs/reference/platform-proofs.md index d251600e6..083fb625c 100644 --- a/docs/reference/platform-proofs.md +++ b/docs/reference/platform-proofs.md @@ -6,7 +6,7 @@ >❗️ Platform v0.22.0 > -> Note: As part of the transition from MongoDB to Dash's [GroveDB](https://github.com/dashevo/grovedb), proofs will be not be available for at least the initial version of Platform v0.22. +> Note: As part of the transition from MongoDB to Dash's [GroveDB](https://github.com/dashpay/grovedb), proofs will be not be available for at least the initial version of Platform v0.22. Since data verification is a critical aspect of Dash Platform, all [Platform endpoints](../reference/dapi-endpoints-platform-endpoints.md) can provide an optional proof that the response is correct. Set the optional `prove` parameter (`"prove": true`) in the request to receive a proof that contains the requested data. diff --git a/docs/reference/query-syntax.md b/docs/reference/query-syntax.md index 5e865f844..c6957cae0 100644 --- a/docs/reference/query-syntax.md +++ b/docs/reference/query-syntax.md @@ -10,9 +10,9 @@ Generally queries will consist of a `where` clause plus optional [modifiers](#qu > 🚧 Query limitations > -> Dash Platform v0.22 introduced a number of limitations due to the switch to using [GroveDB](https://github.com/dashevo/grovedb). See details in pull requests [77](https://github.com/dashevo/platform/pull/77) and [230](https://github.com/dashevo/platform/pull/230) that implemented these changes. +> Dash Platform v0.22 introduced a number of limitations due to the switch to using [GroveDB](https://github.com/dashpay/grovedb). See details in pull requests [77](https://github.com/dashpay/platform/pull/77) and [230](https://github.com/dashpay/platform/pull/230) that implemented these changes. > -> Query validation details may be found [here](https://github.com/dashevo/platform/blob/master/packages/js-drive/lib/document/query/validateQueryFactory.js) along with the associated validation [tests](https://github.com/dashevo/platform/blob/master/packages/js-drive/test/unit/document/query/validateQueryFactory.spec.js). +> Query validation details may be found [here](https://github.com/dashpay/platform/blob/master/packages/js-drive/lib/document/query/validateQueryFactory.js) along with the associated validation [tests](https://github.com/dashpay/platform/blob/master/packages/js-drive/test/unit/document/query/validateQueryFactory.spec.js). ## Where Clause @@ -33,13 +33,13 @@ The Where clause must be a non-empty array containing not more than 10 condition ### Fields -Valid fields consist of the indices defined for the document being queried. For example, the [DPNS data contract](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) defines three indices: +Valid fields consist of the indices defined for the document being queried. For example, the [DPNS data contract](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json) defines three indices: | Index Field(s) | Index Type | Unique | | - | - | :-: | -| [normalizedParentDomainName, normalizedLabel](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L5-L16) | Compound | Yes | -| [records.dashUniqueIdentityId](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L17-L25) | Single Field | Yes | -| [records.dashAliasIdentityId](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L26-L33) | Single Field | No | +| [normalizedParentDomainName, normalizedLabel](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L5-L16) | Compound | Yes | +| [records.dashUniqueIdentityId](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L17-L25) | Single Field | Yes | +| [records.dashAliasIdentityId](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json#L26-L33) | Single Field | No | ```{eval-rst} .. @@ -123,7 +123,7 @@ Valid fields consist of the indices defined for the document being queried. For ```json length // Not available in Dash Platform v0.22 -// See https://github.com/dashevo/platform/pull/77 +// See https://github.com/dashpay/platform/pull/77 { where: [ // Return documents that have 5 values in their `items` array @@ -134,7 +134,7 @@ Valid fields consist of the indices defined for the document being queried. For ```json contains // Not available in Dash Platform v0.22 -// See https://github.com/dashevo/platform/pull/77 +// See https://github.com/dashpay/platform/pull/77 { where: [ // Return documents that have both "red" and "blue" @@ -146,7 +146,7 @@ Valid fields consist of the indices defined for the document being queried. For ```json elementMatch // Not available in Dash Platform v0.22 -// See https://github.com/dashevo/platform/pull/77 +// See https://github.com/dashpay/platform/pull/77 { where: [ // Return `scores` documents where the results contain @@ -178,9 +178,9 @@ The query modifiers described here determine how query results will be sorted an > 🚧 Compound Index Constraints > -> For indices composed of multiple fields ([example from the DPNS data contract](https://github.com/dashevo/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json)), the sort order in an `orderBy` must either match the order defined in the data contract OR be the inverse order. +> For indices composed of multiple fields ([example from the DPNS data contract](https://github.com/dashpay/platform/blob/master/packages/dpns-contract/schema/dpns-contract-documents.json)), the sort order in an `orderBy` must either match the order defined in the data contract OR be the inverse order. > -> Please refer to [pull request 230](https://github.com/dashevo/platform/pull/230) for additional information related to compound index constraints in Platform v0.22. +> Please refer to [pull request 230](https://github.com/dashpay/platform/pull/230) for additional information related to compound index constraints in Platform v0.22. ## Example query diff --git a/docs/resources/repository-overview.md b/docs/resources/repository-overview.md index 17a156c22..39d53fa32 100644 --- a/docs/resources/repository-overview.md +++ b/docs/resources/repository-overview.md @@ -6,34 +6,34 @@ > 📘 Change to monorepo > -> Dash Platform v0.21 migrated to a [monorepo](https://en.wikipedia.org/wiki/Monorepo) structure to streamline continuous integration builds and testing. A number of the libraries below were previously independent repositories but now are aggregated into the [`packages` directory](https://github.com/dashevo/platform/tree/master/packages) of the monorepo (). +> Dash Platform v0.21 migrated to a [monorepo](https://en.wikipedia.org/wiki/Monorepo) structure to streamline continuous integration builds and testing. A number of the libraries below were previously independent repositories but now are aggregated into the [`packages` directory](https://github.com/dashpay/platform/tree/master/packages) of the monorepo (). ## js-dash-sdk Dash client-side JavaScript library for application development and wallet payment/signing. Uses wallet-lib, dapi-client, and dashcore-lib to expose layer-1 and layer-2 functionality. Main user is app developers. npm: `dash` -[Repository](https://github.com/dashevo/platform/tree/master/packages/js-dash-sdk) +[Repository](https://github.com/dashpay/platform/tree/master/packages/js-dash-sdk) ## js-dapi-client Client library for accessing [DAPI Endpoints](../reference/dapi-endpoints.md) . Enables interaction with Dash platform through the [DAPI](../explanations/dapi.md) hosted on masternodes. Provides automatic masternode discovery starting from any initial masternode. npm: `@dashevo/dapi-client` -[Repository](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client) +[Repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client) ## dapi A decentralized API for the Dash network. Exposes endpoints for interacting with the layer 1 blockchain and layer 2 platform services. -[Repository](https://github.com/dashevo/platform/tree/master/packages/dapi) +[Repository](https://github.com/dashpay/platform/tree/master/packages/dapi) ## js-dpp JavaScript implementation of [Dash Platform Protocol](../explanations/platform-protocol.md). Performs validation of all data submitted to the platform. npm: `@dashevo/dpp` -[Repository](https://github.com/dashevo/platform/tree/master/packages/js-dpp) +[Repository](https://github.com/dashpay/platform/tree/master/packages/js-dpp) ## Supporting Repositories @@ -41,7 +41,7 @@ npm: `@dashevo/dpp` Manages the platform state and provides decentralized application storage on the Dash network. -[Repository](https://github.com/dashevo/platform/tree/master/packages/js-drive) +[Repository](https://github.com/dashpay/platform/tree/master/packages/js-drive) ### dashcore-lib @@ -54,21 +54,21 @@ Repository: A hierarchical authenticated data structure. The construction is based on [Database Outsourcing with Hierarchical Authenticated Data Structures](https://eprint.iacr.org/2015/351.pdf). -[Repository](https://github.com/dashevo/grovedb) +[Repository](https://github.com/dashpay/grovedb) ### wallet-lib An extensible JavaScript Wallet Library for Dash. Provides layer 1 SPV wallet functionality. npm: `@dashevo/wallet-lib` -[Repository](https://github.com/dashevo/platform/tree/master/packages/wallet-lib) +[Repository](https://github.com/dashpay/platform/tree/master/packages/wallet-lib) ### dapi-grpc Decentralized API gRPC definition files and generated clients. Used by clients (e.g. dapi-client) to interact with DAPI endpoints. npm: `@dashevo/dapi-grpc` -[Repository](https://github.com/dashevo/platform/tree/master/packages/dapi-grpc) +[Repository](https://github.com/dashpay/platform/tree/master/packages/dapi-grpc) ### dash-network-deploy @@ -80,19 +80,19 @@ Tool for assisting Dash devnet network deployment and testing. Test suite for end-to-end testing of Dash Platform by running some real-life scenarios against a Dash Network. -[Repository](https://github.com/dashevo/platform/tree/master/packages/platform-test-suite) +[Repository](https://github.com/dashpay/platform/tree/master/packages/platform-test-suite) ### rs-drive Implements secondary indices for Platform in conjunction with GroveDB. -[Repository](https://github.com/dashevo/rs-drive) +[Repository](https://github.com/dashpay/platform/tree/master/packages/rs-drive) ### dashmate A distribution package for Dash masternode installation. -[Repository](https://github.com/dashevo/platform/tree/master/packages/dashmate) +[Repository](https://github.com/dashpay/platform/tree/master/packages/dashmate) ## Contract Repositories @@ -100,10 +100,10 @@ A distribution package for Dash masternode installation. DashPay contract documents JSON Schema -[Repository](https://github.com/dashevo/platform/tree/master/packages/dashpay-contract) +[Repository](https://github.com/dashpay/platform/tree/master/packages/dashpay-contract) ### dpns-contract DPNS contract documents JSON Schema -[Repository](https://github.com/dashevo/platform/tree/master/packages/dpns-contract) +[Repository](https://github.com/dashpay/platform/tree/master/packages/dpns-contract) diff --git a/docs/resources/source-code.md b/docs/resources/source-code.md index ef59ad7a1..96160d25d 100644 --- a/docs/resources/source-code.md +++ b/docs/resources/source-code.md @@ -1,5 +1,6 @@ # Source Code Source code produced by Dash Core Group is located in two GitHub organizations: -- [Dashpay](https://github.com/dashpay) - Dash Core Blockchain software and documention -- [Dashevo](https://github.com/dashevo) - Dash Platform software \ No newline at end of file + +- [Dashpay](https://github.com/dashpay) - Dash Core and Platform software and documentation +- [Dashevo](https://github.com/dashevo) - Original source of Dash Platform development. Archived for historical reference diff --git a/docs/tutorials/connecting-to-testnet.md b/docs/tutorials/connecting-to-testnet.md index 426649008..a48c0814e 100644 --- a/docs/tutorials/connecting-to-testnet.md +++ b/docs/tutorials/connecting-to-testnet.md @@ -8,7 +8,7 @@ The purpose of this tutorial is to walk through the steps necessary to access th ## Overview -Platform services are provided via a combination of HTTP and gRPC connections to DAPI, and some connections to an Insight API. Although one could interact with DAPI by connecting to these directly, or by using [DAPI-client](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client), the easiest approach is to use the [JavaScript Dash SDK](https://github.com/dashevo/platform/tree/master/packages/js-dash-sdk). The Dash SDK connects to the testnet by default. +Platform services are provided via a combination of HTTP and gRPC connections to DAPI, and some connections to an Insight API. Although one could interact with DAPI by connecting to these directly, or by using [DAPI-client](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client), the easiest approach is to use the [JavaScript Dash SDK](https://github.com/dashpay/platform/tree/master/packages/js-dash-sdk). The Dash SDK connects to the testnet by default. ## Prerequisites @@ -21,7 +21,7 @@ Platform services are provided via a combination of HTTP and gRPC connections to The JavaScript SDK package is available from npmjs.com and can be installed by running `npm install dash` from the command line: ```shell -npm install dash@4.0.0-rc +npm install dash@~4.0.0 ``` ### 2. Connect to Dash Platform @@ -98,9 +98,9 @@ connect() ## Connect Directly to DAPI (Optional) -> 🚧 Advanced Topic -> -> Normally, the Dash SDK, dapi-client, or another library should be used to interact with DAPI. This may be helpful for debugging in some cases, but generally is not required. +:::{attention} +Normally, the Dash SDK, dapi-client, or another library should be used to interact with DAPI. Connecting directly may be helpful for debugging in some cases, but generally is not required. +::: The example below demonstrates retrieving the hash of the best block hash directly from a DAPI node via command line and several languages: diff --git a/docs/tutorials/contracts-and-documents.md b/docs/tutorials/contracts-and-documents.md index 1dd8d7269..600229c8e 100644 --- a/docs/tutorials/contracts-and-documents.md +++ b/docs/tutorials/contracts-and-documents.md @@ -20,6 +20,6 @@ contracts-and-documents/update-documents contracts-and-documents/delete-documents ``` -> 📘 Tutorial code -> -> You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashevo/platform-readme-tutorials/archive/refs/heads/main.zip). +:::{tip} +You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip). +::: diff --git a/docs/tutorials/contracts-and-documents/delete-documents.md b/docs/tutorials/contracts-and-documents/delete-documents.md index c9e066394..0e9b7e6f5 100644 --- a/docs/tutorials/contracts-and-documents/delete-documents.md +++ b/docs/tutorials/contracts-and-documents/delete-documents.md @@ -42,9 +42,9 @@ deleteNoteDocument() .finally(() => client.disconnect()); ``` -> 👍 Initializing the Client with a contract identity -> -> The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashevo/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +:::{tip} +The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +::: ## What's happening @@ -54,6 +54,7 @@ Once the document has been retrieved, we must submit it to [DAPI](../../explanat The `platform.documents.broadcast` method takes the document batch (e.g. `{delete: [documents[0]]}`) and an identity parameter. Internally, it creates a [State Transition](../../explanations/platform-protocol-state-transition.md) containing the previously created document, signs the state transition, and submits the signed state transition to DAPI. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/contracts-and-documents/register-a-data-contract.md b/docs/tutorials/contracts-and-documents/register-a-data-contract.md index 30026e63c..1eb09a10d 100644 --- a/docs/tutorials/contracts-and-documents/register-a-data-contract.md +++ b/docs/tutorials/contracts-and-documents/register-a-data-contract.md @@ -35,11 +35,11 @@ revisions to be retrieved in the future as needed. The sixth tab shows a data contract configured for creating NFTs. It allows documents to be deleted, transferred, or traded. It also limits document creation to the contract owner. See the [NFT explanation section](../../explanations/nft.md) for more details about NFTs on Dash Platform. **_Note: the JavaScript SDK supports NFT contract registration, but does not currently support trades or transfers._** -> 🚧 -> -> Since Platform v0.25.16, each document property must assign `position` value to support [backwards compatibility](https://github.com/dashpay/platform/pull/1594) for contract updates. -> -> Since Platform v0.23, an index can [only use the ascending order](https://github.com/dashevo/platform/pull/435) (`asc`). Future updates will remove this restriction. +:::{attention} +Since Platform v0.25.16, each document property must assign `position` value to support [backwards compatibility](https://github.com/dashpay/platform/pull/1594) for contract updates. + +Since Platform v0.23, an index can [only use the ascending order](https://github.com/dashpay/platform/pull/435) (`asc`). Future updates will remove this restriction. +::: ::::{tab-set} :::{tab-item} 1. Minimal contract @@ -241,9 +241,9 @@ array of bytes (e.g. a NodeJS Buffer). ::: :::: -> 📘 -> -> Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +:::{note +Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +::: ### Registering the data contract @@ -554,9 +554,9 @@ registerContract() ::: :::: -> 👍 -> -> **Make a note of the returned data contract `id` as it will be used used in subsequent tutorials throughout the documentation.** +:::{attention} +Make a note of the returned data contract `id` as it will be used used in subsequent tutorials throughout the documentation. +::: ## What's Happening @@ -564,6 +564,7 @@ After we initialize the Client, we create an object defining the documents this Once the data contract has been created, we still need to submit it to DAPI. The `platform.contracts.publish` method takes a data contract and an identity parameter. Internally, it creates a State Transition containing the previously created contract, signs the state transition, and submits the signed state transition to DAPI. A response will only be returned if an error is encountered. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/contracts-and-documents/retrieve-a-data-contract.md b/docs/tutorials/contracts-and-documents/retrieve-a-data-contract.md index af8a3e516..2cbbbb8d3 100644 --- a/docs/tutorials/contracts-and-documents/retrieve-a-data-contract.md +++ b/docs/tutorials/contracts-and-documents/retrieve-a-data-contract.md @@ -34,9 +34,9 @@ retrieveContract() ### Updating the client app list -> 📘 -> -> In many cases it may be desirable to work with a newly retrieved data contract using the `.` syntax (e.g. `dpns.domain`). Data contracts that were created after the client was initialized or not included in the initial client options can be added via `client.getApps().set(...)`. +:::{note} +In many cases it may be desirable to work with a newly retrieved data contract using the `.` syntax (e.g. `dpns.domain`). Data contracts that were created after the client was initialized or not included in the initial client options can be added via `client.getApps().set(...)`. +::: ```javascript const Dash = require('dash'); @@ -85,9 +85,9 @@ The following example response shows a retrieved contract: } ``` -> 📘 -> -> Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +:::{note} +Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +::: ## What's Happening diff --git a/docs/tutorials/contracts-and-documents/retrieve-data-contract-history.md b/docs/tutorials/contracts-and-documents/retrieve-data-contract-history.md index f721d6074..466f0ebdb 100644 --- a/docs/tutorials/contracts-and-documents/retrieve-data-contract-history.md +++ b/docs/tutorials/contracts-and-documents/retrieve-data-contract-history.md @@ -109,10 +109,9 @@ The following example response shows a retrieved contract history: ] ``` -> 📘 -> -> Please refer to the [data contract reference page](../../reference/data-contracts.md) for more -> comprehensive details related to contracts and documents. +:::{note} +Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +::: ## What's Happening diff --git a/docs/tutorials/contracts-and-documents/retrieve-documents.md b/docs/tutorials/contracts-and-documents/retrieve-documents.md index 82574d7a1..d766ba000 100644 --- a/docs/tutorials/contracts-and-documents/retrieve-documents.md +++ b/docs/tutorials/contracts-and-documents/retrieve-documents.md @@ -34,9 +34,9 @@ getDocuments() .finally(() => client.disconnect()); ``` -> 👍 Initializing the Client with a contract identity -> -> The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashevo/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +:::{tip} +The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +::: ### Queries @@ -48,9 +48,9 @@ The following examples show the structure of a `note` document (from the data co The values returned by `.toJSON()` include the base document properties (prefixed with `$`) present in all documents along with the data contract defined properties. -> 📘 -> -> Note: When using `.toJSON()`, binary data is displayed as a base64 string (since JSON is a text-based format). +:::{note} +Note: When using `.toJSON()`, binary data is displayed as a base64 string (since JSON is a text-based format). +::: The values returned by `.getData()` (and also shown in the console.dir() `data` property) represent _only_ the properties defined in the `note` document described by the [tutorial data contract](../../tutorials/contracts-and-documents/register-a-data-contract.md#code). @@ -139,8 +139,8 @@ Document { After we initialize the Client, we request some documents. The `client.platform.documents.get` method takes two arguments: a record locator and a query object. The records locator consists of an app name (e.g. `tutorialContract`) and the top-level document type requested, (e.g. `note`). -> 📘 DPNS Contract -> -> Note: Access to the DPNS contract is built into the Dash SDK. DPNS documents may be accessed via the `dpns` app name (e.g. `dpns.domain`). +:::{note} +Access to the DPNS contract is built into the Dash SDK. DPNS documents may be accessed via the `dpns` app name (e.g. `dpns.domain`). +::: If you need more than the first 100 documents, you'll have to make additional requests with `startAt` incremented by 100 each time. In the future, the Dash SDK may return documents with paging information to make this easier and reveal how many documents are returned in total. diff --git a/docs/tutorials/contracts-and-documents/submit-documents.md b/docs/tutorials/contracts-and-documents/submit-documents.md index 5e913ed7f..ed8da51e5 100644 --- a/docs/tutorials/contracts-and-documents/submit-documents.md +++ b/docs/tutorials/contracts-and-documents/submit-documents.md @@ -52,9 +52,9 @@ submitNoteDocument() .finally(() => client.disconnect()); ``` -> 👍 Initializing the Client with a contract identity -> -> The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashevo/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +:::{tip} +The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +::: ## What's happening @@ -64,6 +64,7 @@ Once the document has been created, we still need to submit it to [DAPI](../../e The `platform.documents.broadcast` method then takes the document batch and an identity parameter. Internally, it creates a [State Transition](../../explanations/platform-protocol-state-transition.md) containing the previously created document, signs the state transition, and submits the signed state transition to DAPI. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/contracts-and-documents/update-a-data-contract.md b/docs/tutorials/contracts-and-documents/update-a-data-contract.md index 26b4de949..b3ba8fb1a 100644 --- a/docs/tutorials/contracts-and-documents/update-a-data-contract.md +++ b/docs/tutorials/contracts-and-documents/update-a-data-contract.md @@ -93,9 +93,9 @@ updateContract() ::: :::: -> 📘 -> -> Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +:::{note} +Please refer to the [data contract reference page](../../reference/data-contracts.md) for more comprehensive details related to contracts and documents. +::: ## What's Happening @@ -103,6 +103,7 @@ After we initialize the Client, we retrieve an existing contract owned by our id Once the data contract has been updated, we still need to submit it to DAPI. The `platform.contracts.update` method takes a data contract and an identity parameter. Internally, it creates a State Transition containing the updated contract, signs the state transition, and submits the signed state transition to DAPI. A response will only be returned if an error is encountered. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/contracts-and-documents/update-documents.md b/docs/tutorials/contracts-and-documents/update-documents.md index 77fce8920..80faa3bbb 100644 --- a/docs/tutorials/contracts-and-documents/update-documents.md +++ b/docs/tutorials/contracts-and-documents/update-documents.md @@ -45,9 +45,9 @@ updateNoteDocument() .finally(() => client.disconnect()); ``` -> 👍 Initializing the Client with a contract identity -> -> The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashevo/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +:::{tip} +The example above shows how access to contract documents via `.` syntax (e.g. `tutorialContract.note`) can be enabled by passing a contract identity to the constructor. Please refer to the [Dash SDK documentation](https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/docs/getting-started/multiple-apps.md) for details. +::: ## What's happening @@ -55,6 +55,7 @@ After we initialize the Client, we retrieve the document to be updated via `plat The `platform.documents.broadcast` method then takes the document batch (e.g. `{replace: [noteDocument]}`) and an identity parameter. Internally, it creates a [State Transition](../../explanations/platform-protocol-state-transition.md) containing the previously created document, signs the state transition, and submits the signed state transition to DAPI. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/create-and-fund-a-wallet.md b/docs/tutorials/create-and-fund-a-wallet.md index 379465f80..3c1670843 100644 --- a/docs/tutorials/create-and-fund-a-wallet.md +++ b/docs/tutorials/create-and-fund-a-wallet.md @@ -54,9 +54,9 @@ Mnemonic: thrive wolf habit timber birth service crystal patient tiny depart tow Unused address: yXF7LsyajRvJGX96vPHBmo9Dwy9zEvzkbh ``` -> 🚧 -> -> **Please save your mnemonic for the next step and for re-use in subsequent tutorials throughout the documentation.** +:::{attention} +Please save your mnemonic for the next step and for re-use in subsequent tutorials throughout the documentation. +::: # What's Happening @@ -64,4 +64,4 @@ Once we connect, we output the newly generated mnemonic from `client.wallet.expo # Next Step -Using the faucet at https://testnet-faucet.dash.org/, send test funds to the "unused address" from the console output. You will need to wait until the funds are confirmed to use them. There is a block explorer running at https://testnet-insight.dashevo.org/insight/ which can be used to check confirmations. +Using the [faucet](https://testnet-faucet.dash.org/), send test funds to the "unused address" from the console output. You will need to wait until the funds are confirmed to use them. The [block explorer](https://insight.testnet.networks.dash.org:3002/insight/) can be used to check confirmations. diff --git a/docs/tutorials/identities-and-names.md b/docs/tutorials/identities-and-names.md index 3cc31945e..5c63252cd 100644 --- a/docs/tutorials/identities-and-names.md +++ b/docs/tutorials/identities-and-names.md @@ -20,6 +20,6 @@ identities-and-names/register-a-name-for-an-identity identities-and-names/retrieve-a-name ``` -> 📘 Tutorial code -> -> You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashevo/platform-readme-tutorials/archive/refs/heads/main.zip). +:::{tip} +You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip). +::: diff --git a/docs/tutorials/identities-and-names/register-a-name-for-an-identity.md b/docs/tutorials/identities-and-names/register-a-name-for-an-identity.md index e90c85a00..00493cd9e 100644 --- a/docs/tutorials/identities-and-names/register-a-name-for-an-identity.md +++ b/docs/tutorials/identities-and-names/register-a-name-for-an-identity.md @@ -83,6 +83,7 @@ registerAlias() After initializing the Client, we fetch the Identity we'll be associating with a name. This is an asynchronous method so we use _await_ to pause until the request is complete. Next, we call `platform.names.register` and pass in the name we want to register, the type of identity record to create, and the identity we just fetched. We wait for the result, and output it to the console. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/identities-and-names/register-an-identity.md b/docs/tutorials/identities-and-names/register-an-identity.md index 59dadab94..5214e4029 100644 --- a/docs/tutorials/identities-and-names/register-an-identity.md +++ b/docs/tutorials/identities-and-names/register-an-identity.md @@ -18,9 +18,10 @@ Identities serve as the basis for interactions with Dash Platform. They consist ## Code -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: ```javascript const setupDashClient = require('../setupDashClient'); @@ -39,9 +40,9 @@ createIdentity() The Identity will be output to the console. The Identity will need to have one confirmation before it is accessible via `client.platform.identity.get`. -> 👍 -> -> **Make a note of the returned identity `id` as it will be used used in subsequent tutorials throughout the documentation.** +:::{attention} +Make a note of the returned identity `id` as it will be used used in subsequent tutorials throughout the documentation. +::: ## What's Happening diff --git a/docs/tutorials/identities-and-names/retrieve-an-accounts-identities.md b/docs/tutorials/identities-and-names/retrieve-an-accounts-identities.md index 5686457b1..4ebe8f128 100644 --- a/docs/tutorials/identities-and-names/retrieve-an-accounts-identities.md +++ b/docs/tutorials/identities-and-names/retrieve-an-accounts-identities.md @@ -46,6 +46,6 @@ Example Response After we initialize the Client and getting the account, we call `account.identities.getIdentityIds()` to retrieve a list of all identities created with the wallet mnemonic. The list of identities is output to the console. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/identities-and-names/topup-an-identity-balance.md b/docs/tutorials/identities-and-names/topup-an-identity-balance.md index c867dd3f9..039dce6a2 100644 --- a/docs/tutorials/identities-and-names/topup-an-identity-balance.md +++ b/docs/tutorials/identities-and-names/topup-an-identity-balance.md @@ -42,6 +42,7 @@ topupIdentity() After connecting to the Client, we call `platform.identities.topUp` with an identity ID and a topup amount in duffs (1 duff = 1000 credits). This creates a lock transaction and increases the identity's credit balance by the relevant amount (minus fee). The updated balance is output to the console. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/identities-and-names/transfer-credits-to-an-identity.md b/docs/tutorials/identities-and-names/transfer-credits-to-an-identity.md index 4a0294f6f..49784b35b 100644 --- a/docs/tutorials/identities-and-names/transfer-credits-to-an-identity.md +++ b/docs/tutorials/identities-and-names/transfer-credits-to-an-identity.md @@ -50,6 +50,7 @@ transferCreditsToIdentity() After connecting to the Client, we call `platform.identities.creditTransfer` with our identity, the recipient's identity ID, and the amount to transfer. After the credits are transferred to the recipient, we retrieve the recipient's identity and output their updated balance to the console. -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](../setup-sdk-client.md#wallet-operations) for options. +::: diff --git a/docs/tutorials/identities-and-names/update-an-identity.md b/docs/tutorials/identities-and-names/update-an-identity.md index 62b4d4ba5..22437915e 100644 --- a/docs/tutorials/identities-and-names/update-an-identity.md +++ b/docs/tutorials/identities-and-names/update-an-identity.md @@ -17,9 +17,9 @@ Since Dash Platform v0.23, it is possible to update identities to add new keys o The two examples below demonstrate updating an existing identity to add a new key and disabling an existing key: -> 🚧 -> -> The current SDK version signs all state transitions with public key id `1`. If it is disabled, the SDK will be unable to use the identity. Future SDK versions will provide a way to also sign using keys added in an identity update. +:::{attention} +The current SDK version signs all state transitions with public key id `1`. If it is disabled, the SDK will be unable to use the identity. Future SDK versions will provide a way to also sign using keys added in an identity update. +::: ::::{tab-set} :::{tab-item} Disable identity key @@ -116,8 +116,8 @@ After we initialize the Client, we retrieve our existing identity and set an `id 2. An object containing the key(s) to be added 3. An object containing the id and private key for each public key being added -> 📘 -> -> When adding new public keys, they must be signed using the associated private key to prove ownership of the keys. +:::{note} +When adding new public keys, they must be signed using the associated private key to prove ownership of the keys. +::: Internally, the method creates a State Transition containing the updated identity, signs the state transition, and submits the signed state transition to DAPI. After the identity is updated, we output it to the console. diff --git a/docs/tutorials/introduction.md b/docs/tutorials/introduction.md index 55d4adb4b..6fe1d7103 100644 --- a/docs/tutorials/introduction.md +++ b/docs/tutorials/introduction.md @@ -8,9 +8,9 @@ The tutorials in this section walk through the steps necessary to begin building Building on Dash Platform requires first registering an Identity and then registering a Data Contract describing the schema of data to be stored. Once that is done, data can be stored and updated by submitting Documents that comply with the Data Contract. -> 📘 Tutorial code -> -> You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashevo/platform-readme-tutorials/archive/refs/heads/main.zip). +:::{tip} +You can clone a repository containing the code for all tutorials from GitHub or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip). +::: ## Prerequisites diff --git a/docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md b/docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md index 82314ce04..dc2eb194d 100644 --- a/docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md +++ b/docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md @@ -14,9 +14,9 @@ Please follow the steps in [the installation section](https://docs.dash.org/en/s Dashmate can be used to create a local network on a single computer. This network contains multiple nodes to mimic conditions and features found in testnet/mainnet settings. -> 📘 -> -> Dashmate local networks use the [regtest network type](../../reference/glossary.md#regtest) so layer 1 blocks can be easily mined as needed. +:::{note} +Dashmate local networks use the [regtest network type](../../reference/glossary.md#regtest) so layer 1 blocks can be easily mined as needed. +::: ### Setup @@ -53,9 +53,9 @@ Example (partial) output of the setup wizard showing important information: ``` -> 📘 -> -> Make a note of the key and identity information displayed during setup as they may be required in the future. +:::{note} +Make a note of the key and identity information displayed during setup as they may be required in the future. +::: ### Operation @@ -135,9 +135,9 @@ const client = new Dash.Client(clientOpts); ## Testnet Masternode Setup -> ❗️ Advanced Topic -> -> Running a masternode requires familiarity with Dash Platform services. Improper configuration may impact testing so please exercise caution if running a masternode. +:::{important} +Running a masternode requires familiarity with Dash Platform services. Improper configuration may impact testing so please exercise caution if running a masternode. +::: To setup a testnet masternode, please refer to the comprehensive documentation of the process as described [here](https://docs.dash.org/en/stable/masternodes/setup-testnet.html#dashmate-installation). The following video also details how to complete the process. @@ -149,19 +149,17 @@ To setup a testnet masternode, please refer to the comprehensive documentation o ``` -> 📘 Full Platform Node -> -> A full node that with all Platform services can be started by simply running the setup command with the [node type setup parameter](https://github.com/dashevo/platform/tree/master/packages/dashmate#setup-node) set to `fullnode` and then starting the node. -> -> ``` text -> dashmate setup testnet fullnode -> dashmate start -> ``` +A full node that with all Platform services can be started by simply running the setup command with the [node type setup parameter](https://github.com/dashpay/platform/tree/master/packages/dashmate#node-setup) set to `fullnode` and then starting the node. + +``` text +dashmate setup testnet fullnode +dashmate start +``` ## Remote Development Network -> 📘 Connecting to a remote development network -> -> In order to connect to a remote [devnet](../../reference/glossary.md#devnet) (e.g. one run by Dash Core Group), please use one of the methods described in the [Connect to a Devnet](../../tutorials/connecting-to-testnet.md#connect-to-a-devnet) section. +:::{note} +In order to connect to a remote [devnet](../../reference/glossary.md#devnet) (e.g. one run by Dash Core Group), please use one of the methods described in the [Connect to a Devnet](../../tutorials/connecting-to-testnet.md#connect-to-a-devnet) section. +::: -For development we recommend using either a local network created via dashmate as [described above](#local-network) or using Testnet. While configuring a remote development network is possible using the Dash network deployment tool, it is beyond the scope of this documentation. For details regarding this tool, please refer to the [GitHub repository](https://github.com/dashevo/dash-network-deploy). +For development we recommend using either a local network created via dashmate as [described above](#local-network) or using Testnet. While configuring a remote development network is possible using the Dash network deployment tool, it is beyond the scope of this documentation. For details regarding this tool, please refer to the [GitHub repository](https://github.com/dashpay/dash-network-deploy). diff --git a/docs/tutorials/send-funds.md b/docs/tutorials/send-funds.md index 377708670..04d8f80ea 100644 --- a/docs/tutorials/send-funds.md +++ b/docs/tutorials/send-funds.md @@ -8,9 +8,10 @@ Once you have a wallet and some funds ([tutorial](../tutorials/create-and-fund-a # Code -> 📘 Wallet Sync -> -> Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](./setup-sdk-client.md#wallet-operations) for options. +:::{note} +:class: note +Since the SDK does not cache wallet information, lengthy re-syncs (5+ minutes) may be required for some Core chain wallet operations. See [Wallet Operations](./setup-sdk-client.md#wallet-operations) for options. +::: ```javascript const setupDashClient = require('../setupDashClient'); diff --git a/docs/tutorials/use-dapi-client-methods.md b/docs/tutorials/use-dapi-client-methods.md index a704f7fac..784747c0f 100644 --- a/docs/tutorials/use-dapi-client-methods.md +++ b/docs/tutorials/use-dapi-client-methods.md @@ -12,7 +12,7 @@ In addition to the SDK methods for interacting with identities, names, contracts # Code -The following example demonstrates several of the Core DAPI client methods. DAPI client also has several Platform methods accessible via `getDAPIClient().platform.*`. The methods can be found here in the [js-dapi-client repository](https://github.com/dashevo/platform/tree/master/packages/js-dapi-client/lib/methods). +The following example demonstrates several of the Core DAPI client methods. DAPI client also has several Platform methods accessible via `getDAPIClient().platform.*`. The methods can be found here in the [js-dapi-client repository](https://github.com/dashpay/platform/tree/master/packages/js-dapi-client/lib/methods). ```javascript const Dash = require('dash'); @@ -34,6 +34,6 @@ dapiClientMethods() .finally(() => client.disconnect()); ``` -> 📘 -> -> Examples using DAPI client to access many of the DAPI endpoints can be found in the [DAPI Endpoint Reference section](../reference/dapi-endpoints.md). +:::{note} +Examples using DAPI client to access many of the DAPI endpoints can be found in the [DAPI Endpoint Reference section](../reference/dapi-endpoints.md). +:::