Merge pull request #30 from peaqnetwork/fix/1208238364944982_generate…

…-did-hash-offline

Fix/1208238364944982 Generate Did Hash Offline

package.json

@@ -1,6 +1,6 @@
 {
   "name": "peaq-network",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "license": "MIT",
   "scripts": {
     "prepare": "ts-patch install -s"

packages/sdk/package.json

@@ -1,7 +1,7 @@
 {
   "author": "peaq network <[email protected]>",
   "name": "@peaq-network/sdk",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "peaq network sdk",
   "license": "Apache-2.0",
   "repository": {

packages/sdk/src/modules/did/index.ts

@@ -48,7 +48,7 @@ type Service = {
   data?: string;
 }
 
-interface GenerateDidOptions {
+export interface GenerateDidOptions {
   address: Address;
   customDocumentFields?: CustomDocumentFields;
 }
@@ -85,7 +85,7 @@ interface RemoveDidOptions {
   seed?: string;
 }
 
-interface GenerateDidResult {
+export interface GenerateDidResult {
   value: string;
 }
 
@@ -155,7 +155,7 @@ export class Did extends Base {
    * Creates a new DID by adding a new attribute to the PEAQ DID registry.
    * 
    * @param options - The options for creating the DID.
-   * @returns block_hash - Hash that is searchable on a block explorer to see transaction.
+   * @returns CreateDidResult - Contains the block_hash of the executed transaction and unsubscribe() to terminate event listening.
    */
   public async create(
     options: CreateDidOptions,
@@ -245,6 +245,12 @@ export class Did extends Base {
     }
   }
 
+  /**
+   * Updates a previously created DID Document and overwrites the previously set data.
+   * 
+   * @param options: UpdateDidOptions = {address: Address, customDocumentFields?: CustomDocumentFields}
+   * @returns UpdateDidResult - Contains log information, block_hash of the executed transaction and unsubscribe() to terminate event listening.
+   */
   public async update(options: UpdateDidOptions,
     statusCallback?: (result: ISubmittableResult) => void | Promise<void>
   ): Promise<UpdateDidResult | null> {
@@ -298,7 +304,13 @@ export class Did extends Base {
     }
   }
 
-  // TODO add custom errors
+
+  /**
+   * Removes a previously created DID Document.
+   * 
+   * @param options: UpdateDidOptions = {address: Address, customDocumentFields?: CustomDocumentFields}
+   * @returns RemoveDidResult - Contains log information, block_hash of the executed transaction and unsubscribe() to terminate event listening.
+   */
   public async remove(options: RemoveDidOptions,
     statusCallback?: (result: ISubmittableResult) => void | Promise<void>
   ): Promise<RemoveDidResult | null> {

packages/sdk/src/modules/main/index.ts

@@ -6,16 +6,18 @@ import { unsubscribeRuntimeVersion } from '../../utils';
 import type { Options, SDKMetadata } from '../../types';
 
 import { Base } from '../base';
-import { Did } from '../did';
+import { GenerateDidOptions, GenerateDidResult, Did } from '../did';
 import { RBAC } from "../rbac";
 
+
 /**
  * Main class for interacting with the SDK.
  */
 export class Main extends Base {
   private readonly _options: Options;
   protected override _api: ApiPromise;
   private _metadata: SDKMetadata;
+
   public did: Did;
   public rbac: RBAC;
 
@@ -43,15 +45,15 @@ export class Main extends Base {
   }
 
   /**
-   * Creates a new offline instance of the SDK to use the generate function.
+   * Generates a hash of the DID Document without connecting to the chain.
    *
-   * @param None
-   * @returns The created offline instance of the SDK.
+   * @param GenerateDidOptions - The options for generating a DID.
+   * @returns The hash value of the generated DID document
    */
-    public static async createOfflineInstance(): Promise<Main> {
-      const sdk = new Main({});
-      return sdk;
-    }
+  public static async generateDidDocument(options: GenerateDidOptions): Promise<GenerateDidResult> {
+    const did = new Did();
+    return did.generate(options);
+  }
 
   /**
    * Connects the SDK to the network.

packages/types/package.json

@@ -1,7 +1,7 @@
 {
   "author": "peaq network <[email protected]>",
   "name": "@peaq-network/types",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "license": "Apache-2.0",
   "description": "Typescript definitions for the peaq network",
   "repository": {