Class ArnAuthContext

Hierarchy

ArnAuthContext

Index

Constructors

constructor

new ArnAuthContext(log: ArnLogger, _connector: undefined | ArnConnector, _status?: ArnAuthStatus, persist?: boolean): ArnAuthContext
Parameters
- log: ArnLogger
- _connector: undefined | ArnConnector
- _status: ArnAuthStatus = ArnAuthContext.DEFAULT_STATUS
- persist: boolean = true
Returns ArnAuthContext
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:70

Properties

`Protected` _connector

_connector: undefined | ArnConnector

`Protected` _status

_status: ArnAuthStatus = ArnAuthContext.DEFAULT_STATUS

`Protected` _status$

_status$: BehaviorSubject<ArnAuthStatus>

`Readonly` id

id: string

`Protected` `Readonly` log

log: ArnLogger

`Protected` persist

persist: boolean = true

`Static` `Readonly` AAT_JWT_HEADER

AAT_JWT_HEADER: JWTHeader = ...

`Static` `Readonly` AUTH_CACHE_KEY

AUTH_CACHE_KEY: "arianee-auth-" = 'arianee-auth-'

`Static` `Readonly` DEFAULT_STATUS

DEFAULT_STATUS: ArnAuthStatus = ...

`Static` `Protected` n

n: number = 0

Accessors

connector

get connector(): ArnConnector
Returns ArnConnector
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:48

hasConnector

get hasConnector(): boolean
Returns boolean
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:44

status

get status(): ArnAuthStatus
Returns ArnAuthStatus
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:224
set status(newStatus: ArnAuthStatus): void
Parameters
- newStatus: ArnAuthStatus
Returns void
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:212

status$

get status$(): Observable<ArnAuthStatus>
Returns Observable<ArnAuthStatus>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:40

Methods

disconnect

disconnect(): Promise<void>
Disconnect from the current connector

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

getAddress

getAddress(): Promise<string>
Request the user's wallet address.

Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:173

getChainId

getChainId(): Promise<number>
Request the user's chain ID.

Returns Promise<number>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:180

`Readonly` isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:250

sendTransaction

sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>
Request the user to send a transaction using his wallet.

Returns
The transaction response (not the receipt)
Parameters
- transaction: Deferrable<TransactionRequest>
  
  The transaction to send
Returns Promise<TransactionResponse>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:153

sendUncheckedTransaction

sendUncheckedTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>
Request the user to send a transaction using his wallet.

Returns
The transaction hash (hex string)
Parameters
- transaction: Deferrable<TransactionRequest>
  
  The transaction to send
Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:164

signAAT

signAAT(jwtPayload: AnyArianeeJWT, message?: string, sep?: string, jwtHeader?: JWTHeader): Promise<string>
Ask the wallet to sign an AAT.
Parameters
- jwtPayload: AnyArianeeJWT
  
  The AAT JWT Payload.
- Optional message: string
- Optional sep: string
- jwtHeader: JWTHeader = ArnAuthContext.AAT_JWT_HEADER
Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:94

signMessage

signMessage(message: string): Promise<string>
Request the user to sign a message using his wallet.

Returns
The signature of the message (hex string)
Parameters
- message: string
  
  The message to sign
Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:120

signTransaction

signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>
Request the user to sign a transaction using his wallet.

Returns
The signed transaction (hex string)
Parameters
- transaction: Deferrable<TransactionRequest>
  
  The transaction to sign
Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:142

signTypedData

signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Promise<string>
Request the user to sign typed data using his wallet.

See
https://eips.ethereum.org/EIPS/eip-712

Returns
The signature of the typed data (hex string)
Parameters
- domain: TypedDataDomain
- types: Record<string, TypedDataField[]>
- value: Record<string, any>
Returns Promise<string>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:129

switchChain

switchChain(chainId: number): Promise<void>
Request the user to switch to a specific chain.
Parameters
- chainId: number
  
  The chain ID to switch to
Returns Promise<void>
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:188

`Static` asConnected

asConnected(context: undefined | ArnAuthContext): ArnAuthContext
Parameters
- context: undefined | ArnAuthContext
Returns ArnAuthContext
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:232

`Static` asDisconnected

asDisconnected(context: undefined | ArnAuthContext, connectedError?: (() => AlreadyConnectedError)): undefined | ArnAuthContext
Parameters
- context: undefined | ArnAuthContext
- connectedError: (() => AlreadyConnectedError) = ...
  - - (): AlreadyConnectedError
    - Returns AlreadyConnectedError
Returns undefined | ArnAuthContext
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:240

`Static` asSet

asSet(context: undefined | ArnAuthContext): ArnAuthContext
Parameters
- context: undefined | ArnAuthContext
Returns ArnAuthContext
- Defined in packages/arn-client/src/auth/ArnAuthContext.ts:228

Class ArnAuthContext

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

log: ArnLogger

_connector: undefined | ArnConnector

_status: ArnAuthStatus = ArnAuthContext.DEFAULT_STATUS

persist: boolean = true

Returns ArnAuthContext

Properties

Protected _connector

Protected _status

Protected _status$

Readonly id

Protected Readonly log

Protected persist

Static Readonly AAT_JWT_HEADER

Static Readonly AUTH_CACHE_KEY

Static Readonly DEFAULT_STATUS

Static Protected n

Accessors

connector

Returns ArnConnector

hasConnector

Returns boolean

status

Returns ArnAuthStatus

Parameters

newStatus: ArnAuthStatus

Returns void

status$

Returns Observable<ArnAuthStatus>

Methods

disconnect

Returns Promise<void>

getAddress

Returns Promise<string>

getChainId

Returns Promise<number>

Readonly isConnected

Returns boolean

sendTransaction

Returns

Parameters

transaction: Deferrable<TransactionRequest>

Returns Promise<TransactionResponse>

sendUncheckedTransaction

Returns

Parameters

transaction: Deferrable<TransactionRequest>

Returns Promise<string>

signAAT

Parameters

jwtPayload: AnyArianeeJWT

Optional message: string

Optional sep: string

jwtHeader: JWTHeader = ArnAuthContext.AAT_JWT_HEADER

Returns Promise<string>

signMessage

Returns

Parameters

message: string

Returns Promise<string>

signTransaction

Returns

Parameters

transaction: Deferrable<TransactionRequest>

Returns Promise<string>

signTypedData

See

Returns

Parameters

domain: TypedDataDomain

types: Record<string, TypedDataField[]>

`Protected` _connector

`Protected` _status

`Protected` _status$

`Readonly` id

`Protected` `Readonly` log

`Protected` persist

`Static` `Readonly` AAT_JWT_HEADER

`Static` `Readonly` AUTH_CACHE_KEY

`Static` `Readonly` DEFAULT_STATUS

`Static` `Protected` n

`Readonly` isConnected

`Optional` message: string

`Optional` sep: string

`Static` asConnected

`Static` asDisconnected

`Static` asSet