release: v1.2.0 (getInterchain trace methods)

New transaction.getInterchain and block.getInterchain call the prime-node
/api/v1/{transaction,block}/{id}/interchain endpoints, returning an
InterchainTrace { blockId, validatorBlocks, interchainTransactions }. Adds
VerificationBlock / InterchainTransaction / InterchainTrace interfaces and
method-existence assertions.

.gitea/workflows/publish.yml

@@ -2,7 +2,8 @@ name: Publish to NPM Registry
 
 on:
   release:
-    types: [created]
+    types: [created, published]
+  workflow_dispatch:
 
 jobs:
   publish:
@@ -16,7 +17,6 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: '20.x'
-        registry-url: 'https://git.dragonchain.com/api/packages/dragonchain/npm/'
 
     - name: Install dependencies
       run: npm ci
@@ -28,6 +28,9 @@ jobs:
       run: npm run build
 
     - name: Publish to Gitea NPM registry
-      run: npm publish
+      run: |
+        echo "@dragonchain-inc:registry=https://git.dragonchain.com/api/packages/dragonchain/npm/" > ~/.npmrc
+        echo "//git.dragonchain.com/api/packages/dragonchain/npm/:_authToken=${NODE_AUTH_TOKEN}" >> ~/.npmrc
+        npm publish
       env:
-        NODE_AUTH_TOKEN: ${{ secrets.GITEA_TOKEN }}
+        NODE_AUTH_TOKEN: ${{ secrets.SA_DC_BUILD_API_TOKEN }}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@dragonchain-inc/prime-sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@dragonchain-inc/prime-sdk",
-      "version": "1.1.0",
+      "version": "1.2.0",
       "license": "Apache-2.0",
       "dependencies": {
         "js-yaml": "^4.1.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dragonchain-inc/prime-sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Official Dragonchain Prime SDK for Node.js and TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/block.ts

@@ -3,7 +3,7 @@
  */
 
 import { DragonchainClient } from './client';
-import { Block } from './types';
+import { Block, InterchainTrace } from './types';
 
 export class BlockClient {
   private client: DragonchainClient;
@@ -18,4 +18,12 @@ export class BlockClient {
   async get(blockId: string): Promise<Block> {
     return this.client.get<Block>(`/api/v1/block/${blockId}`);
   }
+
+  /**
+   * Traces a block to the validator (verification) blocks that validated it and
+   * the public-chain interchain anchors those validator blocks were bundled into.
+   */
+  async getInterchain(blockId: string): Promise<InterchainTrace> {
+    return this.client.get<InterchainTrace>(`/api/v1/block/${blockId}/interchain`);
+  }
 }

src/transaction.ts

@@ -11,6 +11,7 @@ import {
   TransactionBulkResponse,
   Transaction,
   ListTransactionsResponse,
+  InterchainTrace,
 } from './types';
 
 export class TransactionClient {
@@ -49,6 +50,16 @@ export class TransactionClient {
     return this.client.get<Transaction>(`/api/v1/transaction/${transactionId}`);
   }
 
+  /**
+   * Traces a transaction to the validator (verification) blocks that validated
+   * its prime block and the public-chain interchain anchors those validator
+   * blocks were bundled into. If the transaction is still pending (not yet in a
+   * block) the trace's arrays are empty.
+   */
+  async getInterchain(transactionId: string): Promise<InterchainTrace> {
+    return this.client.get<InterchainTrace>(`/api/v1/transaction/${transactionId}/interchain`);
+  }
+
   /**
    * Lists all transactions
    */

src/types.ts

@@ -122,21 +122,67 @@ export interface SmartContract {
 
 // Block Types
 export interface BlockProof {
-  scheme: string;
   proof: string;
+  scheme?: string; // absent on trust-scheme chains; present on PoW
   nonce?: number;
 }
 
+export interface BlockHeader {
+  blockId: string;
+  dcId: string;
+  prevId: string;
+  prevProof: string;
+  timestamp: string;
+}
+
 export interface Block {
   version: string;
-  block_id: string;
-  timestamp: string;
-  prev_id: string;
-  prev_proof: string;
+  header: BlockHeader;
   transactions: string[];
   proof: BlockProof;
 }
 
+// Interchain Trace Types
+
+/** A validator's verification of a prime block. */
+export interface VerificationBlock {
+  version: string;
+  primeChainId: string;
+  primeBlockId: string;
+  timestamp: string;
+  verifierPublicKey: string;
+  verifierSignature: string;
+}
+
+/**
+ * An anchor broadcast to a public blockchain (e.g. ETH/BTC) bundling one or more
+ * validator blocks. `validatorBlocks` holds the covered prime block ids;
+ * `coveredPrimeChainIds` the prime chains they belong to.
+ */
+export interface InterchainTransaction {
+  id: number;
+  version: string;
+  timestamp: string;
+  chainId: string;
+  transHash: string;
+  blockId: string;
+  validatorBlocks: string[];
+  validatorBlockhash: string;
+  signature: string;
+  coveredPrimeChainIds: string[];
+}
+
+/**
+ * Links a prime block to the validator (verification) blocks that validated it
+ * and the public-chain interchain anchors those validator blocks were bundled
+ * into. Returned by `transaction.getInterchain` and `block.getInterchain`.
+ */
+export interface InterchainTrace {
+  blockId: string;
+  validatorBlocks: VerificationBlock[];
+  interchainTransactions: InterchainTransaction[];
+}
+
 // System Types
 export interface SystemStatus {
   id: string;

tests/sdk.test.ts

@@ -47,6 +47,7 @@ describe('DragonchainSDK', () => {
       expect(typeof sdk.transaction.create).toBe('function');
       expect(typeof sdk.transaction.createBulk).toBe('function');
       expect(typeof sdk.transaction.get).toBe('function');
+      expect(typeof sdk.transaction.getInterchain).toBe('function');
       expect(typeof sdk.transaction.list).toBe('function');
     });
 
@@ -68,6 +69,7 @@ describe('DragonchainSDK', () => {
 
     it('should have block module with correct methods', () => {
       expect(typeof sdk.block.get).toBe('function');
+      expect(typeof sdk.block.getInterchain).toBe('function');
     });
 
     it('should have system module with correct methods', () => {