feat: v0.25 updates (#21)

* chore: update to 0.25.0-dev.19 version of dependencies

* docs: update minimum version listed in README

* fix: remove deprecated validation check

* docs: update readme with info about identity and contract ID env

* chore: update dependencies

* chore: update to latest 0.25 deps

* refactor: change how name response displayed

* fix: update to return contract

* fix: update doc logic for v0.25

* fix: modify update contract to work with v0.25

* chore: formatting

* fix: modify key add identity for v0.25

* docs: readme update

* docs: update node version

Author: thephez

1-Identities-and-Names/identity-update-add-key.js

@@ -33,15 +33,10 @@ const updateIdentityAddKey = async () => {
 
   const identityPublicKey = identityPrivateKey.toPublicKey().toBuffer();
 
-  const newPublicKey = new IdentityPublicKeyWithWitness({
-    id: newKeyId,
-    type: IdentityPublicKey.TYPES.ECDSA_SECP256K1,
-    data: identityPublicKey,
-    purpose: IdentityPublicKey.PURPOSES.AUTHENTICATION,
-    securityLevel: IdentityPublicKey.SECURITY_LEVELS.HIGH,
-    readOnly: false,
-    signature: Buffer.alloc(0),
-  });
+  const newPublicKey = new IdentityPublicKeyWithWitness(1);
+  newPublicKey.setId(newKeyId);
+  newPublicKey.setSecurityLevel(IdentityPublicKey.SECURITY_LEVELS.HIGH);
+  newPublicKey.setData(identityPublicKey);
 
   const updateAdd = {
     add: [newPublicKey],

1-Identities-and-Names/name-resolve-by-name.js

@@ -11,6 +11,6 @@ const retrieveName = async () => {
 };
 
 retrieveName()
-  .then((d) => console.log('Name retrieved:\n', d.toJSON()))
+  .then((d) => console.log('Name retrieved:\n', d.getData()))
   .catch((e) => console.error('Something went wrong:\n', e))
   .finally(() => client.disconnect());

1-Identities-and-Names/name-resolve-by-record.js

@@ -14,6 +14,6 @@ const retrieveNameByRecord = async () => {
 };
 
 retrieveNameByRecord()
-  .then((d) => console.log('Name retrieved:\n', d[0].toJSON()))
+  .then((d) => console.log('Name retrieved:\n', d[0].getData()))
   .catch((e) => console.error('Something went wrong:\n', e))
   .finally(() => client.disconnect());

1-Identities-and-Names/name-search-by-name.js

@@ -15,7 +15,7 @@ const retrieveNameBySearch = async () => {
 retrieveNameBySearch()
   .then((d) => {
     for (const name of d) {
-      console.log('Name retrieved:\n', name.toJSON());
+      console.log('Name retrieved:\n', name.getData());
     }
   })
   .catch((e) => console.error('Something went wrong:\n', e))

2-Contracts-and-Documents/contract-register-minimal.js

@@ -33,16 +33,9 @@ const registerContract = async () => {
   const contract = await platform.contracts.create(contractDocuments, identity);
   console.dir({ contract: contract.toJSON() });
 
-  // Make sure contract passes validation checks
-  const validationResult = await platform.dpp.dataContract.validate(contract);
-
-  if (validationResult.isValid()) {
-    console.log('Validation passed, broadcasting contract..');
-    // Sign and submit the data contract
-    return platform.contracts.publish(contract, identity);
-  }
-  console.error(validationResult); // An array of detailed validation errors
-  throw validationResult.errors[0];
+  // Sign and submit the data contract
+  await platform.contracts.publish(contract, identity);
+  return contract;
 };
 
 registerContract()

2-Contracts-and-Documents/contract-update-minimal.js

@@ -21,26 +21,17 @@ const updateContract = async () => {
   const existingDataContract = await platform.contracts.get(
     process.env.CONTRACT_ID,
   );
-  const documents = existingDataContract.getDocuments();
+  const documentSchema = existingDataContract.getDocumentSchema('note');
 
-  documents.note.properties.author = {
+  documentSchema.properties.author = {
     type: 'string',
   };
 
-  existingDataContract.setDocuments(documents);
+  existingDataContract.setDocumentSchema('note', documentSchema);
 
-  // Make sure contract passes validation checks
-  const validationResult = await platform.dpp.dataContract.validate(
-    existingDataContract,
-  );
-
-  if (validationResult.isValid()) {
-    console.log('Validation passed, broadcasting contract..');
-    // Sign and submit the data contract
-    return platform.contracts.update(existingDataContract, identity);
-  }
-  console.error(validationResult); // An array of detailed validation errors
-  throw validationResult.errors[0];
+  // Sign and submit the data contract
+  await platform.contracts.update(existingDataContract, identity);
+  return existingDataContract;
 };
 
 updateContract()

2-Contracts-and-Documents/document-delete.js

@@ -31,7 +31,8 @@ const deleteNoteDocument = async () => {
   );
 
   // Sign and submit the document delete transition
-  return platform.documents.broadcast({ delete: [document] }, identity);
+  await platform.documents.broadcast({ delete: [document] }, identity);
+  return document;
 };
 
 deleteNoteDocument()

2-Contracts-and-Documents/document-submit.js

@@ -40,7 +40,8 @@ const submitNoteDocument = async () => {
     delete: [], // Document(s) to delete
   };
   // Sign and submit the document(s)
-  return platform.documents.broadcast(documentBatch, identity);
+  await platform.documents.broadcast(documentBatch, identity);
+  return noteDocument;
 };
 
 submitNoteDocument()

2-Contracts-and-Documents/document-update.js

@@ -34,7 +34,8 @@ const updateNoteDocument = async () => {
   document.set('message', `Updated document @ ${new Date().toUTCString()}`);
 
   // Sign and submit the document replace transition
-  return platform.documents.broadcast({ replace: [document] }, identity);
+  await platform.documents.broadcast({ replace: [document] }, identity);
+  return document;
 };
 
 updateNoteDocument()

README.md

@@ -7,7 +7,7 @@ Code for the tutorials found on the
 
 ## Install
 
-Note: [NodeJS](https://nodejs.org/en/download/) (v12+) must be installed to run
+Note: [NodeJS](https://nodejs.org/en/download/) (v18+) must be installed to run
 the tutorial code.
 
 ### Clone this repository
@@ -41,6 +41,11 @@ Proceed with the tutorials
 align with the tutorials section found on the
 [documentation site](https://dashplatform.readme.io/docs/tutorials-introduction).
 
+After [creating an identity](./1-Identities-and-Names/identity-register.js), set
+the `IDENTITY_ID` value in your `.env` file to your new identity ID. After
+[registering a data contract](./2-Contracts-and-Documents/contract-register-minimal.js),
+set the `CONTRACT_ID` value in your `.env` file to your new contract ID.
+
 ## Contributing
 
 PRs accepted.