Class DefaultArnAuthService

ARN Client authentication service.

Hierarchy

DefaultArnAuthService

Implements

ArnAuthService

Constructors

constructor

new DefaultArnAuthService(config: ArnValidAuthConfig, connectorFactory: ArnConnectorFactory, log: ArnLogger, http: ArnHttpService): DefaultArnAuthService
Parameters
- config: ArnValidAuthConfig
- connectorFactory: ArnConnectorFactory
- log: ArnLogger
- http: ArnHttpService
Returns DefaultArnAuthService
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:57

Properties

`Protected` _currentContext

_currentContext: undefined | ArnAuthContext = undefined

`Protected` _currentContext$

_currentContext$: BehaviorSubject<undefined | ArnAuthContext> = ...

`Readonly` config

config: ArnValidAuthConfig

`Readonly` connectorFactory

connectorFactory: ArnConnectorFactory

`Readonly` emitter

emitter: EventEmitter<string | symbol, any>

`Readonly` http

http: ArnHttpService

`Protected` `Readonly` log

log: ArnLogger

`Readonly` status$

status$: Observable<undefined | ArnAuthStatus> = ...

`Static` `Protected` `Readonly` LEGACY_AUTH_CACHE_KEY

LEGACY_AUTH_CACHE_KEY: "wcSessionSigned" = 'wcSessionSigned'

Deprecated

This key should not be used anymore. It is kept for backward compatibility.

`Static` `Readonly` QUERY_PARAM_ARIANEE_ACCESS_TOKEN

QUERY_PARAM_ARIANEE_ACCESS_TOKEN: "arianeeAccessToken" = 'arianeeAccessToken'

`Static` `Protected` `Readonly` WC_CACHE_KEY

WC_CACHE_KEY: "walletconnect" = 'walletconnect'

Deprecated

This key should not be used outside the cleanWalletConnectInternalCache method.

Accessors

`Protected` context

set context(newContext: undefined | ArnAuthContext): void
Parameters
- newContext: undefined | ArnAuthContext
Returns void
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:271

currentContext

get currentContext(): undefined | ArnAuthContext
Returns undefined | ArnAuthContext
Implementation of ArnAuthService.currentContext
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:49

currentContext$

get currentContext$(): Observable<undefined | ArnAuthContext>
The state of the current authentication context.

Returns Observable<undefined | ArnAuthContext>
Implementation of ArnAuthService.currentContext$
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:45

Methods

`Protected` _connect

_connect(connector: ArnConnector, context: ArnAuthContext, message: undefined | string, resolveContext: undefined | ((value: ArnAuthContext | PromiseLike<ArnAuthContext>) => void)): Promise<void>
Protected
Parameters
- connector: ArnConnector
- context: ArnAuthContext
- message: undefined | string
  
  The message to sign.
- resolveContext: undefined | ((value: ArnAuthContext | PromiseLike<ArnAuthContext>) => void)
Returns Promise<void>
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:214

cleanLegacyAuthCache

cleanLegacyAuthCache(): void
Clean the legacy auth cache to avoid conflicts with the new auth system

Returns void
Implementation of ArnAuthService.cleanLegacyAuthCache
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:336

`Private` cleanWalletConnectInternalCache

cleanWalletConnectInternalCache(): void
Clean the internal cache of WalletConnect (used by internally by their sdk)

Returns void
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:349

connect

connect(params: {
    assignCurrentContext?: boolean;
    authConfig?: ArnValidAuthConfig;
    resolveContextStep?: ArnAuthContextResolveStep;
}): Promise<ArnAuthContext>
Connect the user using the provided authentication configuration. Returns the authentication context after the connection is established or throw an error otherwise.

Returns
The authentication context.
Parameters
- params: {
      assignCurrentContext?: boolean;
      authConfig?: ArnValidAuthConfig;
      resolveContextStep?: ArnAuthContextResolveStep;
  }
  
  The authentication configuration.
  - Optional assignCurrentContext?: boolean
  - Optional authConfig?: ArnValidAuthConfig
  - Optional resolveContextStep?: ArnAuthContextResolveStep
Returns Promise<ArnAuthContext>
Implementation of ArnAuthService.connect
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:136

connectFromCache

connectFromCache(): Promise<void>
Restore connection status as read from local web storage.

Returns Promise<void>
Implementation of ArnAuthService.connectFromCache
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:108

connectFromToken

connectFromToken(aat: string): ArnToken
Connect using an Arianee Access Token (AAT).

Returns
The relevant AAT.
Parameters
- aat: string
  
  The string serialization of the AAT.
Returns ArnToken
Implementation of ArnAuthService.connectFromToken
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:86

connectFromUrl

connectFromUrl(url: URL): ArnToken
Parameters
- url: URL
Returns ArnToken
Implementation of ArnAuthService.connectFromUrl
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:74

`Protected` createContext

createContext(connector: undefined | ArnConnector, newStatus: ArnAuthStatus, persist: boolean): ArnAuthContext
Parameters
- connector: undefined | ArnConnector
- newStatus: ArnAuthStatus
- persist: boolean
Returns ArnAuthContext
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:276

disconnect

disconnect(context?: undefined | ArnAuthContext): Promise<void>
Deprecated
Use ArnAuthContext.disconnect() instead.
Parameters
- context: undefined | ArnAuthContext = ...
Returns Promise<void>
Implementation of ArnAuthService.disconnect
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:314

generateAuthorizationHeader

generateAuthorizationHeader(context?: undefined | ArnAuthContext): string
Produces an Authorization header to authenticate the connected user in a request to the server.

Throws
If no user is connected on the provided/default context.
Parameters
- context: undefined | ArnAuthContext = ...
  
  The authentication context to produce the header for, or the latest one by default.
Returns string
Implementation of ArnAuthService.generateAuthorizationHeader
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:320

`Private` getAuthStatusCache

getAuthStatusCache(): undefined | ArnAuthStatus
Returns undefined | ArnAuthStatus
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:357

`Protected` getSignerAddress

getSignerAddress(signature: string, message: string): string
Parameters
- signature: string
- message: string
Returns string
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:353

isConnected

isConnected(context?: undefined | ArnAuthContext): boolean
Return if a context is connected.
Parameters
- context: undefined | ArnAuthContext = ...
  
  The auth context to check (current one by default).
Returns boolean
Implementation of ArnAuthService.isConnected
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:67

signJwt

signJwt(jwt: JWT, keyName: string, tokenId?: string): Promise<string>
Sign a jwt with a given key.
Parameters
- jwt: JWT
  
  The JWT to sign.
- keyName: string
  
  The symbolic name of the key, to be found in the ARN project auth configuration.
- Optional tokenId: string
  
  The id of the token to use for signing (if the key is restricted token owners of a specific contract).
Returns Promise<string>
Implementation of ArnAuthService.signJwt
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:383

trySwitchChain

trySwitchChain(chainId: number, context?: undefined | ArnAuthContext): Promise<void>
Deprecated
Use ArnAuthContext.trySwitchChain() instead.
Parameters
- chainId: number
- context: undefined | ArnAuthContext = ...
Returns Promise<void>
Implementation of ArnAuthService.trySwitchChain
- Defined in packages/arn-client/src/auth/DefaultArnAuthService.ts:305

Class DefaultArnAuthService

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: ArnValidAuthConfig

connectorFactory: ArnConnectorFactory

log: ArnLogger

http: ArnHttpService

Returns DefaultArnAuthService

Properties

Protected _currentContext

Protected _currentContext$

Readonly config

Readonly connectorFactory

Readonly emitter

Readonly http

Protected Readonly log

Readonly status$

Static Protected Readonly LEGACY_AUTH_CACHE_KEY

Deprecated

Static Readonly QUERY_PARAM_ARIANEE_ACCESS_TOKEN

Static Protected Readonly WC_CACHE_KEY

Deprecated

Accessors

Protected context

Parameters

newContext: undefined | ArnAuthContext

Returns void

currentContext

Returns undefined | ArnAuthContext

currentContext$

Returns Observable<undefined | ArnAuthContext>

Methods

Protected _connect

Parameters

connector: ArnConnector

context: ArnAuthContext

message: undefined | string

resolveContext: undefined | ((value: ArnAuthContext | PromiseLike<ArnAuthContext>) => void)

Returns Promise<void>

cleanLegacyAuthCache

Returns void

Private cleanWalletConnectInternalCache

Returns void

connect

Returns

Parameters

params: { assignCurrentContext?: boolean; authConfig?: ArnValidAuthConfig; resolveContextStep?: ArnAuthContextResolveStep; }

Optional assignCurrentContext?: boolean

Optional authConfig?: ArnValidAuthConfig

Optional resolveContextStep?: ArnAuthContextResolveStep

Returns Promise<ArnAuthContext>

connectFromCache

Returns Promise<void>

connectFromToken

Returns

Parameters

aat: string

Returns ArnToken

connectFromUrl

Parameters

url: URL

Returns ArnToken

Protected createContext

Parameters

connector: undefined | ArnConnector

newStatus: ArnAuthStatus

persist: boolean

Returns ArnAuthContext

disconnect

Deprecated

Parameters

context: undefined | ArnAuthContext = ...

`Protected` _currentContext

`Protected` _currentContext$

`Readonly` config

`Readonly` connectorFactory

`Readonly` emitter

`Readonly` http

`Protected` `Readonly` log

`Readonly` status$

`Static` `Protected` `Readonly` LEGACY_AUTH_CACHE_KEY

`Static` `Readonly` QUERY_PARAM_ARIANEE_ACCESS_TOKEN

`Static` `Protected` `Readonly` WC_CACHE_KEY

`Protected` context

`Protected` _connect

`Private` cleanWalletConnectInternalCache

params: {
assignCurrentContext?: boolean;
authConfig?: ArnValidAuthConfig;
resolveContextStep?: ArnAuthContextResolveStep;
}

`Optional` assignCurrentContext?: boolean

`Optional` authConfig?: ArnValidAuthConfig

`Optional` resolveContextStep?: ArnAuthContextResolveStep

`Protected` createContext

`Private` getAuthStatusCache

`Protected` getSignerAddress

`Optional` tokenId: string