Class IdentityClient

Represents the IdentityClient class providing identity-related functionality.

Hierarchy

IdentityModule
- IdentityClient

Index

Constructors

constructor

new IdentityClient(signer, authToken?): IdentityClient
Constructs a new instance of the IdentityClient class.
Parameters
- signer: Signer
  
  The signer to use for authentication.
- Optional authToken: string
  
  The authentication token to use for offchain drivers.
Returns IdentityClient
Overrides IdentityModule.constructor
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:81

Properties

`Protected` _honeycomb

_honeycomb: Honeycomb

`Protected` _signer

_signer: Signer

Accessors

address

get address(): PublicKey
Gets the public key of the current identity.

Returns PublicKey
Inherited from IdentityModule.address
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:29

authToken

get authToken(): string
Gets the authentication token.

Returns string
Overrides IdentityModule.authToken
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:85

isGuest

get isGuest(): boolean
Checks if the identity is a guest identity.

Returns boolean
Inherited from IdentityModule.isGuest
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:37

signer

get signer(): Signer
Gets the signer used by the identity module.

Returns Signer
Inherited from IdentityModule.signer
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:33

Methods

authenticate

authenticate(): Promise<string>
Authenticates the user and obtains an authentication token.

Returns Promise<string>
A promise that resolves with the authentication token.

Throws
Error if the user is a guest user.
Overrides IdentityModule.authenticate
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:151

create

create(): IdentityCreate
Access to all create methods i.e. user, profiles.

Returns IdentityCreate
A new IdentityCreate instance.
Overrides IdentityModule.create
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:90

delegateAuthority

delegateAuthority(): DelegateAuthorityWithAddress
Gets the delegate authority with address information.

Returns DelegateAuthorityWithAddress
The delegate authority with address information.
Overrides IdentityModule.delegateAuthority
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:122

fetch

fetch(): IdentityFetch
Access to all fetch methods i.e. user, profiles.

Returns IdentityFetch
A new IdentityFetch instance.
Overrides IdentityModule.fetch
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:95

honeycomb

honeycomb(): Honeycomb
Get the Honeycomb client instance associated with the module.

Returns Honeycomb
The Honeycomb client instance.
Inherited from IdentityModule.honeycomb
- Defined in packages/hive-control/Abstracts.d.ts:13

install

install(honeycomb): Honeycomb
Installs the IdentityModule into the Honeycomb instance.
Parameters
- honeycomb: Honeycomb
  
  The Honeycomb instance to install the module into.
Returns Honeycomb
The modified Honeycomb instance with the IdentityModule installed.
Inherited from IdentityModule.install
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:68

loadDelegateAuthority

loadDelegateAuthority(projectKey?, commitmentOrConfig?): Promise<DelegateAuthorityWithAddress>
Loads the delegate authority of this identity for a specific project.
Parameters
- Optional projectKey: string | PublicKey
  
  The project key or address for which to load the delegate authority.
- Optional commitmentOrConfig: Commitment | GetAccountInfoConfig
  
  The commitment level or account info config.
Returns Promise<DelegateAuthorityWithAddress>
The delegate authority with address information.
Overrides IdentityModule.loadDelegateAuthority
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:112

loadProfiles

loadProfiles(): Promise<Profiles>
Loads all profiles for the current user.

Returns Promise<Profiles>
A promise that resolves with the loaded profiles.
Overrides IdentityModule.loadProfiles
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:117

profile

profile(projectKey?, identity?, reFetch?, commitmentOrConfig?): Promise<IdentityProfile>
Loads the profile for a given user identity and project.
Parameters
- Optional projectKey: PublicKey
  
  The project key or address.
- Optional identity: string | PublicKey
  
  The user's identity key or address.
- Optional reFetch: boolean
  
  If true, the profile will be re-fetched.
- Optional commitmentOrConfig: Commitment | GetAccountInfoConfig
  
  The commitment level or account info config.
Returns Promise<IdentityProfile>
A promise that resolves with the loaded profile.
Overrides IdentityModule.profile
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:145

register

register(item): IdentityUser
Registers a new user or profile to this instannnce.
Parameters
- item: User
  
  The user or profile to register.
Returns IdentityUser
The registered user or profile.

Throws
Error if the provided item is of an invalid type.
Overrides IdentityModule.register
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:102
register(item): IdentityUser
Parameters
- item: IdentityUser
Returns IdentityUser
Overrides IdentityModule.register
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:103
register(item): IdentityProfile
Parameters
- item: Profile
Returns IdentityProfile
Overrides IdentityModule.register
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:104
register(item): IdentityProfile
Parameters
- item: IdentityProfile
Returns IdentityProfile
Overrides IdentityModule.register
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:105

signAllTransactions

signAllTransactions<T>(transactions): Promise<T[]>
Signs all the provided transactions using the identity's signer.
Type Parameters
- T = Transaction | VersionedTransaction
Parameters
- transactions: T[]
  
  An array of transactions to sign.
Returns Promise<T[]>
A Promise that resolves to an array of signed transactions.

Throws
Error if the identity is a guest identity.
Inherited from IdentityModule.signAllTransactions
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:61

signMessage

signMessage(message): Promise<Uint8Array>
Signs the provided message using the identity's signer.
Parameters
- message: Uint8Array
  
  The message to sign as a Uint8Array.
Returns Promise<Uint8Array>
A Promise that resolves to the signature as a Uint8Array.

Throws
Error if the identity is a guest identity.
Inherited from IdentityModule.signMessage
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:45

signTransaction

signTransaction<T>(transaction): Promise<T>
Signs the provided transaction using the identity's signer.
Type Parameters
- T = Transaction | VersionedTransaction
Parameters
- transaction: T
  
  The transaction to sign.
Returns Promise<T>
A Promise that resolves to the signed transaction.

Throws
Error if the identity is a guest identity.
Inherited from IdentityModule.signTransaction
- Defined in packages/hive-control/modules/Identity/IdentityModule.d.ts:53

user

user(reFetch?, commitmentOrConfig?): Promise<IdentityUser>
Loads the current user.
Parameters
- Optional reFetch: boolean
  
  If true, the user will be re-fetched and the cache will reset.
- Optional commitmentOrConfig: Commitment | GetAccountInfoConfig
  
  The commitment level or account info config.
Returns Promise<IdentityUser>
A promise that resolves with the loaded user.
Overrides IdentityModule.user
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:136

walletResolver

walletResolver(reFetch?, commitmentOrConfig?): Promise<WalletResolver>
Loads the wallet resolver for the current identity.
Parameters
- Optional reFetch: boolean
  
  If true, the wallet resolver will be re-fetched and the cache will reset.
- Optional commitmentOrConfig: Commitment | GetAccountInfoConfig
  
  The commitment level or account info config.
Returns Promise<WalletResolver>
A promise that resolves with the wallet resolver.
Overrides IdentityModule.walletResolver
- Defined in packages/hive-control/modules/Identity/IdentityClient.d.ts:129

Class IdentityClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

signer: Signer

Optional authToken: string

Returns IdentityClient

Properties

Protected _honeycomb

Protected _signer

Accessors

address

Returns PublicKey

authToken

Returns string

isGuest

Returns boolean

signer

Returns Signer

Methods

authenticate

Returns Promise<string>

Throws

create

Returns IdentityCreate

delegateAuthority

Returns DelegateAuthorityWithAddress

fetch

Returns IdentityFetch

honeycomb

Returns Honeycomb

install

Parameters

honeycomb: Honeycomb

Returns Honeycomb

loadDelegateAuthority

Parameters

Optional projectKey: string | PublicKey

Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

Returns Promise<DelegateAuthorityWithAddress>

loadProfiles

Returns Promise<Profiles>

profile

Parameters

Optional projectKey: PublicKey

Optional identity: string | PublicKey

Optional reFetch: boolean

Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

Returns Promise<IdentityProfile>

register

Parameters

item: User

Returns IdentityUser

Throws

Parameters

item: IdentityUser

Returns IdentityUser

Parameters

item: Profile

Returns IdentityProfile

Parameters

item: IdentityProfile

Returns IdentityProfile

signAllTransactions

Type Parameters

T = Transaction | VersionedTransaction

Parameters

transactions: T[]

Returns Promise<T[]>

Throws

signMessage

Parameters

message: Uint8Array

Returns Promise<Uint8Array>

`Optional` authToken: string

`Protected` _honeycomb

`Protected` _signer

`Optional` projectKey: string | PublicKey

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig

`Optional` projectKey: PublicKey

`Optional` identity: string | PublicKey

`Optional` reFetch: boolean

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig

`Optional` reFetch: boolean

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig

`Optional` reFetch: boolean

`Optional` commitmentOrConfig: Commitment | GetAccountInfoConfig