dash-platform-sdk 1.0.0

package/src/dapi/getDocuments.js

@@ -0,0 +1,33 @@
+import { GetDocumentsRequest } from '../../proto/generated/platform.js'
+import { base58 } from '@scure/base'
+import cbor from 'cbor'
+
+export default async function getDocuments(dataContractId, documentType, where, orderBy, limit = 100, startAt, startAfter, prove = false) {
+  const getDocumentsRequest = new GetDocumentsRequest.fromPartial({
+    v0: {
+      dataContractId: base58.decode(dataContractId),
+      documentType,
+      where: where ? cbor.encode(where) : undefined,
+      orderBy: orderBy ? cbor.encode(orderBy): undefined,
+      limit,
+      startAt : startAt ? startAt : undefined,
+      startAfter : startAfter ? startAfter : undefined,
+      prove
+    }
+  })
+
+  const { v0 } = await this.client.getDocuments(getDocumentsRequest)
+
+  return v0.documents.documents
+}
+
+//*
+//
+//   message GetDocumentsRequestV0 {
+//     // Specifies the starting point for the document retrieval
+//     oneof start {
+//       bytes start_after = 6;  // Start retrieval after this document
+//       bytes start_at = 7;     // Start retrieval at this document
+//     }
+//     bool prove = 8;  // Flag to request a proof as the response
+//   }*/

package/src/dapi/getStatus.js

@@ -0,0 +1,19 @@
+import { GetStatusRequest } from '../../proto/generated/platform.js'
+
+export default async function getStatus() {
+  const getStatusRequest = new GetStatusRequest.fromPartial({v0: {}});
+
+  const response  = await this.client.getStatus(getStatusRequest)
+
+  const {v0} = response
+
+  // map buffers to hex string
+  v0.node.id = v0.node.id.reduce((code, acc) => acc + code.toString(16), "")
+  v0.node.proTxHash = v0.node.proTxHash.reduce((code, acc) => acc + code.toString(16), "")
+  v0.chain.latestBlockHash = v0.chain.latestBlockHash.reduce((code, acc) => acc + code.toString(16), "")
+  v0.chain.latestAppHash = v0.chain.latestAppHash.reduce((code, acc) => acc + code.toString(16), "")
+  v0.chain.earliestAppHash = v0.chain.earliestAppHash.reduce((code, acc) => acc + code.toString(16), "")
+  v0.chain.earliestBlockHash = v0.chain.earliestBlockHash.reduce((code, acc) => acc + code.toString(16), "")
+
+  return v0
+}

package/test/unit/index.spec.js

@@ -0,0 +1,64 @@
+import DashPlatformSDK from '../../index'
+
+let sdk
+
+describe('DashPlatformSDK', () => {
+  beforeAll(() => {
+    sdk = new DashPlatformSDK()
+  })
+
+  test('should be constructable throw `new`', () => {
+    expect(sdk).toEqual(expect.any(DashPlatformSDK))
+  })
+
+  test('should be able to call getStatus', async () => {
+    const status = await sdk.utils.getStatus()
+
+    expect(status.version.software.dapi).toEqual(expect.any(String))
+    expect(status.version.software.drive).toEqual(expect.any(String))
+
+    expect(status.version.software.tenderdash).toEqual(expect.any(String))
+    expect(status.version.protocol.tenderdash.p2p).toEqual(expect.any(Number))
+    expect(status.version.protocol.tenderdash.block).toEqual(expect.any(Number))
+
+    expect(status.version.protocol.drive.latest).toEqual(expect.any(Number))
+    expect(status.version.protocol.drive.current).toEqual(expect.any(Number))
+
+    expect(status.node.id).toEqual(expect.any(String))
+    expect(status.node.proTxHash).toEqual(expect.any(String))
+
+    expect(status.chain.catchingUp).toEqual(expect.any(Boolean))
+    expect(status.chain.latestBlockHash).toEqual(expect.any(String))
+    expect(status.chain.latestAppHash).toEqual(expect.any(String))
+    expect(status.chain.latestBlockHeight).toEqual(expect.any(String))
+    expect(status.chain.earliestBlockHash).toEqual(expect.any(String))
+    expect(status.chain.earliestAppHash).toEqual(expect.any(String))
+    expect(status.chain.earliestBlockHeight).toEqual(expect.any(String))
+    expect(status.chain.maxPeerBlockHeight).toEqual(expect.any(String))
+    expect(status.chain.coreChainLockedHeight).toEqual(expect.any(Number))
+
+    expect(status.network.chainId).toEqual(expect.any(String))
+    expect(status.network.peersCount).toEqual(expect.any(Number))
+    expect(status.network.listening).toEqual(expect.any(Boolean))
+
+    expect(status.stateSync.totalSyncedTime).toEqual(expect.any(String))
+    expect(status.stateSync.remainingTime).toEqual(expect.any(String))
+    expect(status.stateSync.totalSnapshots).toEqual(expect.any(Number))
+    expect(status.stateSync.chunkProcessAvgTime).toEqual(expect.any(String))
+    expect(status.stateSync.snapshotHeight).toEqual(expect.any(String))
+    expect(status.stateSync.snapshotChunksCount).toEqual(expect.any(String))
+    expect(status.stateSync.backfilledBlocks).toEqual(expect.any(String))
+    expect(status.stateSync.backfillBlocksTotal).toEqual(expect.any(String))
+
+    expect(status.time.local).toEqual(expect.any(String))
+    expect(status.time.block).toEqual(expect.any(String))
+    expect(status.time.genesis).toEqual(expect.any(String))
+    expect(status.time.epoch).toEqual(expect.any(Number))
+  })
+
+  test('should be able to call getDocuments()', async () => {
+    const documents = await sdk.documents.get('GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec', 'domain')
+
+    expect(documents.length).toEqual(100)
+  })
+})

package/webpack.config.js

@@ -0,0 +1,18 @@
+const path = require('path');
+
+module.exports = {
+  mode: 'production',
+  entry: './index.js',
+  resolve: {
+    fallback: {
+      "stream":  require.resolve("stream-browserify"),
+      "buffer": require.resolve("buffer/")
+    },
+  },
+  output: {
+    globalObject: 'this',
+    path: path.resolve(__dirname, 'dist'),
+    libraryTarget: 'umd'
+  },
+};
+