Class SiweServiceClient

Implements

Description

Implements SIWE (Sign In With Ethereum) functionality. This class is responsible for initializing the SIWE message, sending requests, connecting, and requesting the download of QR codes.

See

https://didpass-wallet.gitbook.io/didpass-wallet-sdk/

Hierarchy

SiweServiceClient

Implements

ISiweServiceClient

Index

Constructors

constructor

new SiweServiceClient(): SiweServiceClient
Returns SiweServiceClient
Description
Initializes a new instance of the SiweServiceClient class.
- Defined in services/SiweServiceClient.ts:50

Properties

`Private` `Readonly` ERROR_CREDENTIAL_ID_MISSING

ERROR_CREDENTIAL_ID_MISSING: "Credential ID is missing." = 'Credential ID is missing.'

`Private` `Readonly` ERROR_DID_MISSING

ERROR_DID_MISSING: "Decentralized Identifier (DID) is missing." = 'Decentralized Identifier (DID) is missing.'

`Private` `Readonly` ERROR_INIT_NOT_CALLED

ERROR_INIT_NOT_CALLED: "Init not called" = 'Init not called'

`Private` `Readonly` ERROR_PROOF_TOKEN_MISSING

ERROR_PROOF_TOKEN_MISSING: "Proof Token is missing." = 'Proof Token is missing.'

`Private` `Readonly` ERROR_QR_MISSING

ERROR_QR_MISSING: "QR code data is missing." = 'QR code data is missing.'

credentialId

credentialId: null | string = null

did

did: null | string = null

qr

qr: null | QrScanResult = null

signer

signer: null | Wallet = null

siweMessageObj

siweMessageObj: null | SiweMessage = null

Methods

connectToIssuer

connectToIssuer(): Promise<VerifiedMessage>
Returns Promise<VerifiedMessage>
Returns a promise that resolves with the verified message.

Method
Async
Name
connectToIssuer

Description
Sends a connect request to issuer and returns the response.

Throws
Will throw an error if initialization is not done, QR code data is missing, or DID is missing.
Implementation of ISiweServiceClient.connectToIssuer
- Defined in services/SiweServiceClient.ts:100

`Private` findValue

findValue(obj, field): any
Parameters
- obj: any
- field: string
Returns any
- Defined in services/SiweServiceClient.ts:234

init

init(key, domain, baseUrl, did, qr, credentialId?): Promise<void>
Parameters
- key: string
  The key for the ethers Wallet.
- domain: string
  The domain for the SIWE message.
- baseUrl: string
  The base URL for the SIWE message.
- did: string
  The Decentralized Identifier (DID).
- qr: QrScanResult
  The QR scan result.
- Optional credentialId: string
  The optional Credential ID.
Returns Promise<void>
Method
Async
Name
init

Description
Initializes the SIWE service client with the provided parameters.
Implementation of ISiweServiceClient.init
- Defined in services/SiweServiceClient.ts:64

requestCredential

requestCredential(): Promise<RequestCredentialResponse>
Returns Promise<RequestCredentialResponse>
Returns a promise that resolves with the request Credential response.

Method
Async
Name
requestCredential

Description
Sends a request to get credentials and returns the response.

Throws
Will throw an error if QR code data, DID, or Credential ID is missing.
Implementation of ISiweServiceClient.requestCredential
- Defined in services/SiweServiceClient.ts:131

requestSignedDvr

requestSignedDvr(): Promise<VerifiedMessage>
Returns Promise<VerifiedMessage>
Returns a promise that resolves with the verified message.

Method
Async
Name
requestSignedDvr

Description
Sends a request to get the signed dvr and return the response.
Implementation of ISiweServiceClient.requestSignedDvr
- Defined in services/SiweServiceClient.ts:166

`Private` sendRequest

sendRequest(requestBody): Promise<VerifiedMessage>
Parameters
- requestBody: any
Returns Promise<VerifiedMessage>
- Defined in services/SiweServiceClient.ts:194

verifyProof

verifyProof(proofToken): Promise<VerifiedMessage>
Parameters
- proofToken: string
Returns Promise<VerifiedMessage>
Returns a promise that resolves with the verified message.

Method
Async
Name
verifyProof

Description
Sends a request to verify proof token to verifier.

Throws
Will throw an error if Proof Token is missing.
Implementation of ISiweServiceClient.verifyProof
- Defined in services/SiweServiceClient.ts:180

Class SiweServiceClient

Implements

Description

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SiweServiceClient

Description

Properties

Private Readonly ERROR_CREDENTIAL_ID_MISSING

Private Readonly ERROR_DID_MISSING

Private Readonly ERROR_INIT_NOT_CALLED

Private Readonly ERROR_PROOF_TOKEN_MISSING

Private Readonly ERROR_QR_MISSING

credentialId

did

qr

signer

siweMessageObj

Methods

connectToIssuer

Returns Promise<VerifiedMessage>

Method

Async

Name

Description

Throws

Private findValue

Parameters

obj: any

field: string

Returns any

init

Parameters

key: string

domain: string

baseUrl: string

did: string

qr: QrScanResult

Optional credentialId: string

Returns Promise<void>

Method

Async

Name

Description

requestCredential

Returns Promise<RequestCredentialResponse>

Method

Async

Name

Description

Throws

requestSignedDvr

Returns Promise<VerifiedMessage>

Method

Async

Name

Description

Private sendRequest

Parameters

requestBody: any

Returns Promise<VerifiedMessage>

verifyProof

Parameters

proofToken: string

Returns Promise<VerifiedMessage>

Method

Async

Name

Description

Throws

Settings

Member Visibility

Theme

`Private` `Readonly` ERROR_CREDENTIAL_ID_MISSING

`Private` `Readonly` ERROR_DID_MISSING

`Private` `Readonly` ERROR_INIT_NOT_CALLED

`Private` `Readonly` ERROR_PROOF_TOKEN_MISSING

`Private` `Readonly` ERROR_QR_MISSING

`Private` findValue

`Optional` credentialId: string

`Private` sendRequest