feat: add claim request origin to Claim interface

energywebfoundation · Mar 14, 2022 · 0b5be66 · 0b5be66
1 parent c45a81c
commit 0b5be66
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 29 deletions.
diff --git a/docs/api/interfaces/Claim.md b/docs/api/interfaces/Claim.md
@@ -14,6 +14,7 @@
 - [issuedToken](Claim.md#issuedtoken)
 - [namespace](Claim.md#namespace)
 - [onChainProof](Claim.md#onchainproof)
+- [redirectUri](Claim.md#redirecturi)
 - [registrationTypes](Claim.md#registrationtypes)
 - [requester](Claim.md#requester)
 - [subject](Claim.md#subject)
@@ -82,6 +83,12 @@ ___
 
 ___
 
+### redirectUri
+
+• `Optional` **redirectUri**: `string`
+
+___
+
 ### registrationTypes
 
 • **registrationTypes**: [`RegistrationTypes`](../enums/RegistrationTypes.md)[]

diff --git a/docs/api/modules.md b/docs/api/modules.md
@@ -253,91 +253,91 @@ ___
 
 ### IS\_ETH\_SIGNER
 
-• **IS\_ETH\_SIGNER**: ``"isEthSigner"``
+• `Const` **IS\_ETH\_SIGNER**: ``"isEthSigner"``
 
 ___
 
 ### NODE\_FIELDS\_KEY
 
-• **NODE\_FIELDS\_KEY**: ``"metadata"``
+• `Const` **NODE\_FIELDS\_KEY**: ``"metadata"``
 
 ___
 
 ### PUBLIC\_KEY
 
-• **PUBLIC\_KEY**: ``"PublicKey"``
+• `Const` **PUBLIC\_KEY**: ``"PublicKey"``
 
 ___
 
 ### TEST\_LOGIN\_ENDPOINT
 
-• **TEST\_LOGIN\_ENDPOINT**: ``"/auth/status"``
+• `Const` **TEST\_LOGIN\_ENDPOINT**: ``"/auth/status"``
 
 ___
 
 ### VOLTA\_CHAIN\_ID
 
-• **VOLTA\_CHAIN\_ID**: ``73799``
+• `Const` **VOLTA\_CHAIN\_ID**: ``73799``
 
 ___
 
 ### agreement\_type\_hash
 
-• **agreement\_type\_hash**: `string`
+• `Const` **agreement\_type\_hash**: `string`
 
 ___
 
 ### defaultAzureProxyUrl
 
-• **defaultAzureProxyUrl**: ``"https://azure-proxy-server.energyweb.org/api/v1"``
+• `Const` **defaultAzureProxyUrl**: ``"https://azure-proxy-server.energyweb.org/api/v1"``
 
 ___
 
 ### defaultBridgeUrl
 
-• **defaultBridgeUrl**: ``"https://bridge.walletconnect.org"``
+• `Const` **defaultBridgeUrl**: ``"https://bridge.walletconnect.org"``
 
 ___
 
 ### defaultClaimExpiry
 
-• **defaultClaimExpiry**: `number`
+• `Const` **defaultClaimExpiry**: `number`
 
 ___
 
 ### defaultKmsServerUrl
 
-• **defaultKmsServerUrl**: ``"https://km.aws.energyweb.org/connect/new"``
+• `Const` **defaultKmsServerUrl**: ``"https://km.aws.energyweb.org/connect/new"``
 
 ___
 
 ### didPattern
 
-• **didPattern**: ``"^(?:did:(?<method>[a-z0-9]+?):)((?<chain>[a-z0-9]+?):)?(?<id>0x[A-Fa-f0-9]{40})$"``
+• `Const` **didPattern**: ``"^(?:did:(?<method>[a-z0-9]+?):)((?<chain>[a-z0-9]+?):)?(?<id>0x[A-Fa-f0-9]{40})$"``
 
 ___
 
 ### emptyAddress
 
-• **emptyAddress**: ``"0x0000000000000000000000000000000000000000"``
+• `Const` **emptyAddress**: ``"0x0000000000000000000000000000000000000000"``
 
 ___
 
 ### erc712\_type\_hash
 
-• **erc712\_type\_hash**: `string`
+• `Const` **erc712\_type\_hash**: `string`
 
 ___
 
 ### proof\_type\_hash
 
-• **proof\_type\_hash**: `string`
+• `Const` **proof\_type\_hash**: `string`
 
 ___
 
 ### typedMsgPrefix
 
-• **typedMsgPrefix**: ``"1901"``
+• `Const` **typedMsgPrefix**: ``"1901"``
 
 ## Functions
 
@@ -360,7 +360,7 @@ ___
 
 ### cacheConfigs
 
-▸ `Const` **cacheConfigs**(): `Object`
+▸ **cacheConfigs**(): `Object`
 
 #### Returns
 
@@ -386,7 +386,7 @@ ___
 
 ### chainConfigs
 
-▸ `Const` **chainConfigs**(): `Object`
+▸ **chainConfigs**(): `Object`
 
 #### Returns
 
@@ -415,7 +415,7 @@ ___
 
 ### createWalletConnectProvider
 
-▸ `Const` **createWalletConnectProvider**(`bridge`, `infuraId?`): `WalletConnectProvider`
+▸ **createWalletConnectProvider**(`bridge`, `infuraId?`): `WalletConnectProvider`
 
 #### Parameters
 
@@ -432,7 +432,7 @@ ___
 
 ### executionEnvironment
 
-▸ `Const` **executionEnvironment**(): `ExecutionEnvironment`
+▸ **executionEnvironment**(): `ExecutionEnvironment`
 
 #### Returns
 
@@ -442,7 +442,7 @@ ___
 
 ### fromGnosis
 
-▸ `Const` **fromGnosis**(`safeAppSdk`): `Promise`<[`SignerService`](classes/SignerService.md)\>
+▸ **fromGnosis**(`safeAppSdk`): `Promise`<[`SignerService`](classes/SignerService.md)\>
 
 **`description`** Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/).
 Dapp should provide SafeAppSdk injected by Gnosis interface
@@ -479,7 +479,7 @@ ___
 
 ### fromMetaMask
 
-▸ `Const` **fromMetaMask**(): `Promise`<[`SignerService`](classes/SignerService.md)\>
+▸ **fromMetaMask**(): `Promise`<[`SignerService`](classes/SignerService.md)\>
 
 #### Returns
 
@@ -489,7 +489,7 @@ ___
 
 ### fromPrivateKey
 
-▸ `Const` **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`<[`SignerService`](classes/SignerService.md)\>
+▸ **fromPrivateKey**(`privateKey`, `rpcUrl`): `Promise`<[`SignerService`](classes/SignerService.md)\>
 
 #### Parameters
 
@@ -506,7 +506,7 @@ ___
 
 ### fromWalletConnectMetamask
 
-▸ `Const` **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`<[`SignerService`](classes/SignerService.md)\>
+▸ **fromWalletConnectMetamask**(`bridge`, `infuraId?`): `Promise`<[`SignerService`](classes/SignerService.md)\>
 
 #### Parameters
 
@@ -523,7 +523,7 @@ ___
 
 ### getMessagingConfig
 
-▸ `Const` **getMessagingConfig**(): `Object`
+▸ **getMessagingConfig**(): `Object`
 
 #### Returns
 
@@ -642,7 +642,7 @@ ___
 
 ### isMetamaskExtensionPresent
 
-▸ `Const` **isMetamaskExtensionPresent**(): `Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\>
+▸ **isMetamaskExtensionPresent**(): `Promise`<{ `chainId`: `undefined` \| `number` ; `isMetamaskPresent`: `boolean` = !!provider }\>
 
 #### Returns
 
@@ -668,7 +668,7 @@ ___
 
 ### readyToBeRegisteredOnchain
 
-▸ `Const` **readyToBeRegisteredOnchain**(`claim`): claim is Required<Pick<Claim, "claimTypeVersion" \| "claimType" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>
+▸ **readyToBeRegisteredOnchain**(`claim`): claim is Required<Pick<Claim, "claimTypeVersion" \| "claimType" \| "subject" \| "onChainProof" \| "acceptedBy" \| "subjectAgreement"\>\>
 
 #### Parameters
 
@@ -684,7 +684,7 @@ ___
 
 ### setCacheConfig
 
-▸ `Const` **setCacheConfig**(`chainId`, `options`): `void`
+▸ **setCacheConfig**(`chainId`, `options`): `void`
 
 Used to override existing cache server configuration or add a missing one
 Configuration must be set before constructing `IAM`
@@ -704,7 +704,7 @@ ___
 
 ### setChainConfig
 
-▸ `Const` **setChainConfig**(`chainId`, `config`): `void`
+▸ **setChainConfig**(`chainId`, `config`): `void`
 
 Used to override existing chain configuration or add a missing one
 Configuration must be set before constructing `IAM`
@@ -724,7 +724,7 @@ ___
 
 ### setMessagingConfig
 
-▸ `Const` **setMessagingConfig**(`chainId`, `options`): `void`
+▸ **setMessagingConfig**(`chainId`, `options`): `void`
 
 Used to override existing messaging configuration or add a missing one
 Configuration must be set before constructing `IAM`

diff --git a/src/modules/claims/claims.types.ts b/src/modules/claims/claims.types.ts
@@ -52,6 +52,7 @@ export interface Claim {
   acceptedBy?: string;
   isRejected?: boolean;
   namespace: string;
+  redirectUri?: string;
 }
 
 export const readyToBeRegisteredOnchain = (