Interface ArnAuthService

ARN Client authentication service.

Hierarchy

ArnAuthService

Implemented by

DefaultArnAuthService

Index

Properties

config currentContext currentContext$ emitter status$

Methods

cleanLegacyAuthCache connect connectFromCache connectFromToken connectFromUrl disconnect generateAuthorizationHeader isConnected signJwt trySwitchChain

Properties

`Readonly` config

config: ArnValidAuthConfig

`Readonly` currentContext

currentContext: undefined | ArnAuthContext

`Readonly` currentContext$

currentContext$: Observable<undefined | ArnAuthContext>

The state of the current authentication context.

`Readonly` emitter

emitter: EventEmitter<string | symbol, any>

status$

status$: Observable<undefined | ArnAuthStatus>

Methods

cleanLegacyAuthCache

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

Returns void
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:95

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
- Optional params: {
      assignCurrentContext?: boolean;
      authConfig?: ArnValidAuthConfig;
      resolveContextStep?: ArnAuthContextResolveStep;
  }
  
  The authentication configuration.
  - Optional assignCurrentContext?: boolean
  - Optional authConfig?: ArnValidAuthConfig
  - Optional resolveContextStep?: ArnAuthContextResolveStep
Returns Promise<ArnAuthContext>
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:67

connectFromCache

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

Returns Promise<void>
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:58

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
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:53

connectFromUrl

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

disconnect

disconnect(context?: ArnAuthContext): Promise<void>
Deprecated
Use ArnAuthContext.disconnect() instead.
Parameters
- Optional context: ArnAuthContext
Returns Promise<void>
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:81

generateAuthorizationHeader

generateAuthorizationHeader(context?: 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
- Optional context: ArnAuthContext
  
  The authentication context to produce the header for, or the latest one by default.
Returns string
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:89

isConnected

isConnected(context?: ArnAuthContext): boolean
Return if a context is connected.
Parameters
- Optional context: ArnAuthContext
  
  The auth context to check (current one by default).
Returns boolean
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:43

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>
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:104

trySwitchChain

trySwitchChain(chainId: number, context?: ArnAuthContext): Promise<void>
Deprecated
Use ArnAuthContext.trySwitchChain() instead.
Parameters
- chainId: number
- Optional context: ArnAuthContext
Returns Promise<void>
- Defined in packages/arn-client/src/auth/ArnAuthService.ts:76

Interface ArnAuthService

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly config

Readonly currentContext

Readonly currentContext$

Readonly emitter

status$

Methods

cleanLegacyAuthCache

Returns void

connect

Returns

Parameters

Optional 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

disconnect

Deprecated

Parameters

Optional context: ArnAuthContext

Returns Promise<void>

generateAuthorizationHeader

Throws

Parameters

Optional context: ArnAuthContext

Returns string

isConnected

Parameters

Optional context: ArnAuthContext

Returns boolean

signJwt

Parameters

jwt: JWT

keyName: string

Optional tokenId: string

Returns Promise<string>

trySwitchChain

Deprecated

Parameters

chainId: number

Optional context: ArnAuthContext

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` config

`Readonly` currentContext

`Readonly` currentContext$

`Readonly` emitter

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

`Optional` assignCurrentContext?: boolean

`Optional` authConfig?: ArnValidAuthConfig

`Optional` resolveContextStep?: ArnAuthContextResolveStep

`Optional` context: ArnAuthContext

`Optional` context: ArnAuthContext

`Optional` context: ArnAuthContext

`Optional` tokenId: string

`Optional` context: ArnAuthContext