fix(exp): document expirationTimestamp (#631)

* fix(infura): replace config with ipfs daemon for initUser methods

* fix(exp): document expirationTimestamp

* fix(exp): remove change to role credential validation

* fix: build errors

docs/api/interfaces/modules_claims.IssueClaimOptions.md

@@ -40,7 +40,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid (milliseconds)
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

docs/api/interfaces/modules_claims.IssueClaimRequestOptions.md

@@ -28,7 +28,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

docs/api/interfaces/modules_claims.IssueVerifiablePresentationOptions.md

@@ -25,7 +25,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

docs/api/interfaces/modules_claims.RegisterOnchainOptions.md

@@ -45,7 +45,7 @@ ___
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid (seconds).
+A Unix timestamp expressed in seconds of when the claim expires.
 
 ___
 

docs/api/interfaces/modules_did_registry.IssuePublicClaimOptions.md

@@ -16,7 +16,7 @@
 
 • `Optional` **expirationTimestamp**: `number`
 
-Defines how long the claim is valid.
+A Unix timestamp expressed in milliseconds of when the claim expires.
 
 ___
 

e2e/claims.service.e2e.ts

@@ -838,7 +838,7 @@ describe('Сlaim tests', () => {
         const waitForRegister = new Promise((resolve) =>
           claimManager.once(
             'RoleRegistered',
-            (subject, role, version, expiry: BigNumber, issuer) =>
+            (subject, role, version, expiry: BigNumber) =>
               resolve(expiry.toNumber())
           )
         );

src/modules/claims/claims.types.ts

@@ -30,6 +30,7 @@ export interface IClaimIssuance extends IMessage {
   claimTypeVersion?: string;
   acceptedBy: string;
   vp?: string;
+  // a Unix timestamp expressed in milliseconds of when the claim expires
   expirationTimestamp?: number;
 }
 
@@ -198,7 +199,7 @@ export interface IssueClaimRequestOptions {
    */
   credentialStatusOverride?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -224,7 +225,7 @@ export interface RegisterOnchainOptions {
   /** DID of the claim subject */
   subject?: string;
 
-  /** Defines how long the claim is valid (seconds). */
+  /** A Unix timestamp expressed in seconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -269,7 +270,7 @@ export interface IssueClaimOptions {
    */
   credentialStatusOverride?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid (milliseconds) */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 
@@ -337,7 +338,7 @@ export interface IssueVerifiablePresentationOptions {
    */
   credentialStatus?: StatusList2021Entry;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }
 

src/modules/did-registry/did.types.ts

@@ -16,6 +16,7 @@ export interface IpfsConfig {
   host: string;
   port?: number;
   protocol?: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   headers?: Record<string, any>;
 }
 
@@ -75,7 +76,7 @@ export interface IssuePublicClaimOptions {
   /* Public claim data object */
   publicClaim?: IPublicClaim;
 
-  /** Defines how long the claim is valid. */
+  /** A Unix timestamp expressed in milliseconds of when the claim expires. */
   expirationTimestamp?: number;
 }