@dashevo/dpns-contract 0.3.0-dev.5 → 0.21.4

package/README.md

@@ -1,9 +1,9 @@
 # DPNS Contract
 
-[![Build Status](https://img.shields.io/travis/com/dashevo/dpns-contract.svg?branch=master&style=flat-square)](https://travis-ci.com/dashevo/dpns-contract)
+[![Build Status](https://github.com/dashevo/dpns-contract/actions/workflows/test_and_release.yml/badge.svg)](https://github.com/dashevo/dpns-contract/actions/workflows/test_and_release.yml)
 [![NPM version](https://img.shields.io/npm/v/@dashevo/dpns-contract.svg?style=flat-square)](https://npmjs.org/package/@dashevo/dpns-contract)
 
-> JSON Contracts for Dash Platform Name Service
+JSON Contracts for Dash Platform Name Service
 
 ## Table of Contents
 

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@dashevo/dpns-contract",
-  "version": "0.3.0-dev.5",
+  "version": "0.21.4",
   "description": "A contract and helper scripts for DPNS DApp",
   "scripts": {
-    "check-package": "npm run check-package:name && npm run check-package:version",
-    "check-package:name": "test $(jq -r .name package.json) = $(jq -r .name package-lock.json)",
-    "check-package:version": "test $(jq -r .version package.json) = $(jq -r .version package-lock.json)",
     "lint": "eslint .",
     "test": "npm run test:unit",
     "test:unit": "mocha 'test/unit/**/*.spec.js'"
@@ -34,18 +31,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@dashevo/dapi-client": "~0.16.0-dev.1",
-    "@dashevo/dashcore-lib": "~0.18.12",
-    "@dashevo/dpp": "~0.16.0-dev.4",
-    "chai": "^4.2.0",
+    "@dashevo/dpp": "~0.21.4",
+    "chai": "^4.3.4",
     "dirty-chai": "^2.0.1",
-    "eslint": "^6.7.2",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-plugin-import": "^2.19.1",
-    "mocha": "^8.1.1",
-    "multihashes": "^0.4.15",
-    "sinon": "^8.0.1",
-    "sinon-chai": "^3.4.0",
-    "yargs": "^15.3.1"
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.24.2",
+    "mocha": "^9.1.2",
+    "sinon": "^11.1.2",
+    "sinon-chai": "^3.7.0"
   }
 }

package/schema/dpns-contract-documents.json

@@ -1,5 +1,6 @@
 {
   "domain": {
+    "type": "object",
     "indices": [
       {
         "properties": [
@@ -19,55 +20,62 @@
           }
         ],
         "unique": true
+      },
+      {
+        "properties": [
+          {
+            "records.dashAliasIdentityId": "asc"
+          }
+        ]
       }
     ],
     "properties": {
       "label": {
         "type": "string",
-        "pattern": "^((?!-)[a-zA-Z0-9-]{0,62}[a-zA-Z0-9])$",
+        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$",
         "minLength": 3,
         "maxLength": 63,
         "description": "Domain label. e.g. 'Bob'."
       },
       "normalizedLabel": {
         "type": "string",
-        "pattern": "^((?!-)[a-z0-9-]{0,62}[a-z0-9])$",
+        "pattern": "^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$",
         "maxLength": 63,
         "description": "Domain label in lowercase for case-insensitive uniqueness validation. e.g. 'bob'",
         "$comment": "Must be equal to the label in lowercase. This property will be deprecated due to case insensitive indices"
       },
       "normalizedParentDomainName": {
         "type": "string",
-        "pattern": "^$|^((?!-)[a-z0-9-\\.]{0,189}[a-z0-9])$",
+        "pattern": "^$|^[[a-z0-9][a-z0-9-\\.]{0,188}[a-z0-9]$",
         "minLength": 0,
         "maxLength": 190,
         "description": "A full parent domain name in lowercase for case-insensitive uniqueness validation. e.g. 'dash'",
         "$comment": "Must either be equal to an existing domain or empty to create a top level domain. Only the data contract owner can create top level domains."
       },
       "preorderSalt": {
-        "type": "object",
+        "type": "array",
         "byteArray": true,
-        "minBytesLength": 32,
-        "maxBytesLength": 32,
+        "minItems": 32,
+        "maxItems": 32,
         "description": "Salt used in the preorder document"
       },
       "records": {
         "type": "object",
         "properties": {
           "dashUniqueIdentityId": {
-            "type": "object",
+            "type": "array",
             "byteArray": true,
-            "minBytesLength": 32,
-            "maxBytesLength": 32,
+            "minItems": 32,
+            "maxItems": 32,
             "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": "object",
+            "type": "array",
             "byteArray": true,
-            "minBytesLength": 32,
-            "maxBytesLength": 32,
+            "minItems": 32,
+            "maxItems": 32,
             "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"
@@ -104,6 +112,7 @@
     "$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": [
       {
         "properties": [
@@ -116,10 +125,10 @@
     ],
     "properties": {
       "saltedDomainHash": {
-        "type": "object",
+        "type": "array",
         "byteArray": true,
-        "minBytesLength": 32,
-        "maxBytesLength": 32,
+        "minItems": 32,
+        "maxItems": 32,
         "description": "Double sha-256 of the concatenation of a 32 byte random salt and a normalized domain name"
       }
     },

package/test/unit/dpnsContract.spec.js

@@ -11,7 +11,7 @@ describe('DPNS Contract', () => {
   let dataContract;
   let identityId;
 
-  beforeEach(function beforeEach() {
+  beforeEach(async function beforeEach() {
     const fetchContractStub = this.sinon.stub();
 
     dpp = new DashPlatformProtocol({
@@ -20,6 +20,8 @@ describe('DPNS Contract', () => {
       },
     });
 
+    await dpp.initialize();
+
     identityId = generateRandomIdentifier();
 
     dataContract = dpp.dataContract.create(identityId, dpnsContractDocumentsSchema);
@@ -27,7 +29,9 @@ describe('DPNS Contract', () => {
     fetchContractStub.resolves(dataContract);
   });
 
-  it('should have a valid contract definition', async () => {
+  it('should have a valid contract definition', async function shouldHaveValidContract() {
+    this.timeout(5000);
+
     const validationResult = await dpp.dataContract.validate(dataContract);
 
     expect(validationResult.isValid()).to.be.true();
@@ -77,8 +81,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('minBytesLength');
-            expect(error.dataPath).to.equal('.saltedDomainHash');
+            expect(error.keyword).to.equal('minItems');
+            expect(error.instancePath).to.equal('/saltedDomainHash');
           }
         });
 
@@ -96,8 +100,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('minBytesLength');
-            expect(error.dataPath).to.equal('.saltedDomainHash');
+            expect(error.keyword).to.equal('minItems');
+            expect(error.instancePath).to.equal('/saltedDomainHash');
           }
         });
 
@@ -115,8 +119,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('maxBytesLength');
-            expect(error.dataPath).to.equal('.saltedDomainHash');
+            expect(error.keyword).to.equal('maxItems');
+            expect(error.instancePath).to.equal('/saltedDomainHash');
           }
         });
       });
@@ -202,7 +206,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('pattern');
-            expect(error.dataPath).to.equal('.label');
+            expect(error.instancePath).to.equal('/label');
           }
         });
 
@@ -221,7 +225,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('minLength');
-            expect(error.dataPath).to.equal('.label');
+            expect(error.instancePath).to.equal('/label');
           }
         });
 
@@ -240,7 +244,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('maxLength');
-            expect(error.dataPath).to.equal('.label');
+            expect(error.instancePath).to.equal('/label');
           }
         });
       });
@@ -280,7 +284,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('pattern');
-            expect(error.dataPath).to.equal('.normalizedLabel');
+            expect(error.instancePath).to.equal('/normalizedLabel');
           }
         });
 
@@ -299,7 +303,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('maxLength');
-            expect(error.dataPath).to.equal('.normalizedLabel');
+            expect(error.instancePath).to.equal('/normalizedLabel');
           }
         });
       });
@@ -339,7 +343,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('maxLength');
-            expect(error.dataPath).to.equal('.normalizedParentDomainName');
+            expect(error.instancePath).to.equal('/normalizedParentDomainName');
           }
         });
 
@@ -358,7 +362,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('pattern');
-            expect(error.dataPath).to.equal('.normalizedParentDomainName');
+            expect(error.instancePath).to.equal('/normalizedParentDomainName');
           }
         });
       });
@@ -397,8 +401,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('minBytesLength');
-            expect(error.dataPath).to.equal('.preorderSalt');
+            expect(error.keyword).to.equal('minItems');
+            expect(error.instancePath).to.equal('/preorderSalt');
           }
         });
 
@@ -416,8 +420,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('minBytesLength');
-            expect(error.dataPath).to.equal('.preorderSalt');
+            expect(error.keyword).to.equal('minItems');
+            expect(error.instancePath).to.equal('/preorderSalt');
           }
         });
 
@@ -435,8 +439,8 @@ describe('DPNS Contract', () => {
             const [error] = e.getErrors();
 
             expect(error.name).to.equal('JsonSchemaError');
-            expect(error.keyword).to.equal('maxBytesLength');
-            expect(error.dataPath).to.equal('.preorderSalt');
+            expect(error.keyword).to.equal('maxItems');
+            expect(error.instancePath).to.equal('/preorderSalt');
           }
         });
       });
@@ -503,7 +507,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('minProperties');
-            expect(error.dataPath).to.equal('.records');
+            expect(error.instancePath).to.equal('/records');
           }
         });
 
@@ -524,7 +528,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('additionalProperties');
-            expect(error.dataPath).to.equal('.records');
+            expect(error.instancePath).to.equal('/records');
             expect(error.params.additionalProperty).to.equal('someOtherProperty');
           }
         });
@@ -548,7 +552,7 @@ describe('DPNS Contract', () => {
 
               expect(error.name).to.equal('JsonSchemaError');
               expect(error.keyword).to.equal('maxProperties');
-              expect(error.dataPath).to.equal('.records');
+              expect(error.instancePath).to.equal('/records');
             }
           });
 
@@ -569,8 +573,8 @@ describe('DPNS Contract', () => {
                 const [error] = e.getErrors();
 
                 expect(error.name).to.equal('JsonSchemaError');
-                expect(error.keyword).to.equal('minBytesLength');
-                expect(error.dataPath).to.equal('.records.dashUniqueIdentityId');
+                expect(error.keyword).to.equal('minItems');
+                expect(error.instancePath).to.equal('/records/dashUniqueIdentityId');
               }
             });
 
@@ -590,8 +594,8 @@ describe('DPNS Contract', () => {
                 const [error] = e.getErrors();
 
                 expect(error.name).to.equal('JsonSchemaError');
-                expect(error.keyword).to.equal('maxBytesLength');
-                expect(error.dataPath).to.equal('.records.dashUniqueIdentityId');
+                expect(error.keyword).to.equal('maxItems');
+                expect(error.instancePath).to.equal('/records/dashUniqueIdentityId');
               }
             });
           });
@@ -613,8 +617,8 @@ describe('DPNS Contract', () => {
                 const [error] = e.getErrors();
 
                 expect(error.name).to.equal('JsonSchemaError');
-                expect(error.keyword).to.equal('minBytesLength');
-                expect(error.dataPath).to.equal('.records.dashAliasIdentityId');
+                expect(error.keyword).to.equal('minItems');
+                expect(error.instancePath).to.equal('/records/dashAliasIdentityId');
               }
             });
 
@@ -634,8 +638,8 @@ describe('DPNS Contract', () => {
                 const [error] = e.getErrors();
 
                 expect(error.name).to.equal('JsonSchemaError');
-                expect(error.keyword).to.equal('maxBytesLength');
-                expect(error.dataPath).to.equal('.records.dashAliasIdentityId');
+                expect(error.keyword).to.equal('maxItems');
+                expect(error.instancePath).to.equal('/records/dashAliasIdentityId');
               }
             });
           });
@@ -677,7 +681,7 @@ describe('DPNS Contract', () => {
 
             expect(error.name).to.equal('JsonSchemaError');
             expect(error.keyword).to.equal('additionalProperties');
-            expect(error.dataPath).to.equal('.subdomainRules');
+            expect(error.instancePath).to.equal('/subdomainRules');
           }
         });
 
@@ -697,7 +701,7 @@ describe('DPNS Contract', () => {
 
               expect(error.name).to.equal('JsonSchemaError');
               expect(error.keyword).to.equal('type');
-              expect(error.dataPath).to.equal('.subdomainRules.allowSubdomains');
+              expect(error.instancePath).to.equal('/subdomainRules/allowSubdomains');
             }
           });
         });

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: 'bug'
-assignees: ''
-
----
-
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Expected Behavior
-<!--- Tell us what should happen -->
-
-## Current Behavior
-<!--- Tell us what happens instead of the expected behavior -->
-
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug -->
-
-## Steps to Reproduce (for bugs)
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Environment name and version (e.g. Chrome 39, node.js 5.4):
-* Operating System and version (desktop, server, or mobile):
-* Link to your project:

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: 'enhancement'
-assignees: ''
-
----
-
-<!--- Provide a general summary of the feature request in the Title above -->
-
-## Expected Behavior
-<!--- A clear and concise description of what you want to happen -->
-
-## Current Behavior
-<!--- Explain the difference from current behavior -->
-
-## Possible Solution
-<!--- Suggest ideas of how to implement the addition or change -->
-
-## Alternatives Considered
-<!--- A clear and concise description of any alternative solutions or features you've considered -->
-
-## Additional Context
-<!--- Add any other context or screenshots about the feature request here. -->
-

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +0,0 @@
-<!--- Provide a general summary of your changes in the Title above -->
-<!--- Pull request titles must use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format -->
-
-## Issue being fixed or feature implemented
-<!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
-
-
-## What was done?
-<!--- Describe your changes in detail -->
-
-
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
-
-
-## Breaking Changes
-<!--- Please describe any breaking changes your code introduces and verify that -->
-<!--- the title includes "!" following the conventional commit type (e.g. "feat!: ..."-->
-
-
-## Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have added or updated relevant unit/integration/functional/e2e tests
-- [ ] I have made corresponding changes to the documentation
-
-**For repository code-owners and collaborators only**
-- [ ] I have assigned this pull request to a milestone

package/.travis.yml

@@ -1,42 +0,0 @@
-sudo: false
-dist: trusty
-language: node_js
-
-node_js:
- - '12'
- - '14'
-
-branches:
-  only:
-    - master
-    - /^v(0|[1-9]\d*)\.(0|[1-9]\d*)$/
-    - /^v(0|[1-9]\d*)\.(0|[1-9]\d*)-dev$/
-    - /^v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/
-
-services:
-  - docker
-
-addons:
-  apt:
-    packages:
-      - docker-ce
-
-before_install:
-  # Login to NPM registry
-  - echo "//registry.npmjs.org/:_authToken=\${NPM_TOKEN}" > .npmrc
-
-install:
-  - npm ci
-
-script:
-  - npm run check-package
-  - npm run lint
-  - npm run test
-
-deploy:
-  provider: script
-  skip_cleanup: true
-  script: bash bin/travis-deploy.sh
-  on:
-    tags: true
-    repo: dashevo/dpns-contract

package/bin/travis-deploy.sh

@@ -1,31 +0,0 @@
-#! /bin/sh
-
-set -xe
-
-# Update this whenever the latest Node.js LTS version changes (~ every year).
-# Do not forget to add this version to .travis.yml config also.
-LATEST_LTS_VERSION="14"
-
-# We want this command to succeed whether or not the Node.js version is the
-# latest (so that the build does not show as failed), but _only_ the latest
-# should be used to publish the module.
-if [ "$TRAVIS_NODE_VERSION" != "$LATEST_LTS_VERSION" ]; then
-  echo "Node.js v$TRAVIS_NODE_VERSION is not latest LTS version -- will not deploy with this version."
-  exit 0
-fi
-
-# Ensure the tag matches the one in package.json, otherwise abort.
-PACKAGE_TAG=v"$(jq -r .version package.json)"
-if [ "$PACKAGE_TAG" != "$TRAVIS_TAG" ]; then
-  echo "Travis tag (\"$TRAVIS_TAG\") is not equal to package.json tag (\"$PACKAGE_TAG\"). Please push a correct tag and try again."
-  exit 1
-fi
-
-# Use regex pattern matching to check if "dev" exists in tag
-NPM_TAG="latest"
-if [[ $PACKAGE_TAG =~ dev ]]; then
-  NPM_TAG="dev"
-fi
-
-# Now that checks have been passed, publish the module
-npm publish --tag $NPM_TAG