feat: add example retrieving contract history (#22)

* feat: add example retrieving contract history

Also includes register/update for a contract with history

* refactor: remove contract config options that can't be modified

* refactor: rename contract history

* chore: add comment

* refactor: rename function

* refactor: remove wasm-dpp

DPP is included in SDK so wasm-dpp isn't required

* style: minor updates

* chore: remove url

Author: thephez

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

@@ -0,0 +1,50 @@
+const Dash = require('dash');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const clientOpts = {
+  network: process.env.NETWORK,
+  wallet: {
+    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
+    unsafeOptions: {
+      skipSynchronizationBeforeHeight: 675000, // only sync from early-2022
+    },
+  },
+};
+const client = new Dash.Client(clientOpts);
+
+const registerContract = async () => {
+  const { platform } = client;
+  const identity = await platform.identities.get(process.env.IDENTITY_ID); // Your identity ID
+
+  const contractDocuments = {
+    note: {
+      type: 'object',
+      properties: {
+        message: {
+          type: 'string',
+        },
+      },
+      additionalProperties: false,
+    },
+  };
+
+  const contract = await platform.contracts.create(contractDocuments, identity);
+  contract.setConfig({
+    canBeDeleted: false,
+    readonly: false, // Make contract read-only
+    keepsHistory: true, // Enable storing of contract history
+    documentsKeepHistoryContractDefault: false,
+    documentsMutableContractDefault: true,
+  });
+  console.dir({ contract: contract.toJSON() });
+
+  // Sign and submit the data contract
+  await platform.contracts.publish(contract, identity);
+  return contract;
+};
+
+registerContract()
+  .then((d) => console.log('Contract registered:\n', d.toJSON()))
+  .catch((e) => console.error('Something went wrong:\n', e))
+  .finally(() => client.disconnect());

2-Contracts-and-Documents/contract-retrieve-history.js

@@ -0,0 +1,21 @@
+const Dash = require('dash');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const client = new Dash.Client({ network: process.env.NETWORK });
+
+const retrieveContractHistory = async () => {
+  const contractId = process.env.CONTRACT_ID; // Your contract ID
+  return await client.platform.contracts.history(contractId, 0, 10, 0);
+};
+
+retrieveContractHistory()
+  .then((d) => {
+    Object.entries(d).forEach(([key, value]) => {
+      client.platform.dpp.dataContract
+        .createFromObject(value)
+        .then((contract) => console.dir(contract.toJSON(), { depth: 5 }));
+    });
+  })
+  .catch((e) => console.error('Something went wrong:\n', e))
+  .finally(() => client.disconnect());

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

@@ -0,0 +1,46 @@
+const Dash = require('dash');
+const dotenv = require('dotenv');
+dotenv.config();
+
+const clientOpts = {
+  network: process.env.NETWORK,
+  wallet: {
+    mnemonic: process.env.MNEMONIC, // A Dash wallet mnemonic with testnet funds
+    unsafeOptions: {
+      skipSynchronizationBeforeHeight: 675000, // only sync from early-2022
+    },
+  },
+};
+const client = new Dash.Client(clientOpts);
+
+const updateContract = async () => {
+  const { platform } = client;
+  const identity = await platform.identities.get(process.env.IDENTITY_ID); // Your identity ID
+
+  const existingDataContract = await platform.contracts.get(
+    process.env.CONTRACT_ID,
+  );
+  const documentSchema = existingDataContract.getDocumentSchema('note');
+  console.log(documentSchema);
+
+  documentSchema.properties.author = {
+    type: 'string',
+  };
+
+  existingDataContract.setDocumentSchema('note', documentSchema);
+  existingDataContract.setConfig({
+    keepsHistory: true, // Enable storing of contract history
+  });
+
+  console.log(existingDataContract.getDocumentSchema('note'));
+  console.dir(existingDataContract.toJSON());
+  // Sign and submit the data contract
+  await platform.contracts.update(existingDataContract, identity);
+  return existingDataContract;
+};
+
+updateContract()
+  .then((d) => console.log('Contract updated:\n', d.toJSON()))
+  .catch((e) => console.error('Something went wrong:\n', e))
+  .finally(() => client.disconnect());
+