Class IdentityModule

constructor

• new IdentityModule(_signer): IdentityModule

• Creates a new instance of the IdentityModule.

  Parameters

  • _signer: Signer

    The signer to use for signing messages and transactions.

  Returns IdentityModule

authToken

address

• get address(): PublicKey

• Gets the public key of the current identity.

  Returns PublicKey

isGuest

• get isGuest(): boolean

• Checks if the identity is a guest identity.

  Returns boolean

signer

• get signer(): Signer

• Gets the signer used by the identity module.

  Returns Signer

authenticate

• authenticate(): Promise<string>

• Returns Promise<string>

create

• create(): IdentityCreate

• Returns IdentityCreate

delegateAuthority

• delegateAuthority(): DelegateAuthorityWithAddress

• Returns DelegateAuthorityWithAddress

fetch

• fetch(): IdentityFetch

• Returns IdentityFetch

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.

loadDelegateAuthority

• loadDelegateAuthority(projectKey?, commitmentOrConfig?): Promise<DelegateAuthorityWithAddress>

• Parameters

  • Optional projectKey: string | PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<DelegateAuthorityWithAddress>

loadProfiles

• loadProfiles(): Promise<Profiles>

• Returns Promise<Profiles>

profile

• profile(projectKey?, identity?, reFetch?, commitmentOrConfig?): Promise<IdentityProfile>

• Parameters

  • Optional projectKey: PublicKey

  • Optional identity: string | PublicKey

  • Optional reFetch: boolean

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<IdentityProfile>

register

• register(item): IdentityUser

• Parameters

  • item: User

  Returns IdentityUser

• register(item): IdentityUser

• Parameters

  • item: IdentityUser

  Returns IdentityUser

• register(item): IdentityProfile

• Parameters

  • item: Profile

  Returns IdentityProfile

• register(item): IdentityProfile

• Parameters

  • item: IdentityProfile

  Returns IdentityProfile

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.

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.

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.

user

• user(reFetch?, commitmentOrConfig?): Promise<IdentityUser>

• Parameters

  • Optional reFetch: boolean

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<IdentityUser>

walletResolver

• walletResolver(reFetch?, commitmentOrConfig?): Promise<WalletResolver>

• Parameters

  • Optional reFetch: boolean

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<WalletResolver>