Class HoneycombProject

constructor

• new HoneycombProject(connection, projectAddress, _project): HoneycombProject

• Parameters

  • connection: Connection

  • projectAddress: PublicKey

  • _project: Project

  Returns HoneycombProject

Readonly connection

Readonly programId

Readonly projectAddress

address

• get address(): PublicKey

• The public address of the project.

  Returns PublicKey

authority

• get authority(): PublicKey

• The project's authority.

  Returns PublicKey

collections

• get collections(): PublicKey[]

• The project's collections.

  Returns PublicKey[]

creators

• get creators(): PublicKey[]

• The project's creators.

  Returns PublicKey[]

data

• get data(): Project

• The project data.

  Returns Project

mintIndexing

• get mintIndexing(): Indexing

• The project's mint indexing data.

  Returns Indexing

mints

• get mints(): AddressContainer[]

• The project's mint containers.

  Returns AddressContainer[]

name

• get name(): string

• The project's name.

  Returns string

profileDataConfig

• get profileDataConfig(): Map<string, ProfileDataType>

• The project's profile data configuration.

  Returns Map<string, ProfileDataType>

services

• get services(): Service[]

• The project's services.

  Returns Service[]

addCriteria

• addCriteria(args, confirmOptions?): Promise<ConfirmedContext>

• Adds criteria to the project.

  Parameters

  • args: CriteriaArgs

    Arguments for adding the criteria.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

addDelegation

• addDelegation(delegate, delegation, confirmOptions?): Promise<ConfirmedContext>

• Adds a delegation to the project.

  Parameters

  • delegate: PublicKey

    The delegate to be added.

  • delegation: ServiceDelegation

    The service delegation.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

addService

• addService(service, confirmOptions?): Promise<ConfirmedContext>

• Adds a service to the project.

  Parameters

  • service: Service

    The service to be added.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

changeDriver

• changeDriver(keypair?, confirmOptions?): Promise<Keypair>

• Changes the driver of the project.

  Parameters

  • Optional keypair: Keypair

    The new driver keypair (optional).

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<Keypair>

  The new driver keypair if created, or the current keypair if provided.

createDelegateAuthority

• createDelegateAuthority(delegate, delegations, confirmOptions?): Promise<ConfirmedContext>

• Creates a delegate authority for the project.

  Parameters

  • delegate: PublicKey

    The delegate to be assigned authority.

  • delegations: ServiceDelegation[]

    The service delegations.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

delegateDriver

• delegateDriver(keypair, confirmOptions?): Promise<Keypair>

• Delegates the driver role to the provided keypair.

  Parameters

  • keypair: Keypair

    The new driver keypair.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<Keypair>

  The new driver keypair.

fetch

• fetch(): HoneycombProjectFetch

• Fetches additional data for the project.

  Returns HoneycombProjectFetch

  The HoneycombProjectFetch instance for fetching additional data.

findMintFromReference

• findMintFromReference(reference): PublicKey

• Finds the mint address from the indexed reference.

  Parameters

  • reference: IndexedReference

    The indexed reference.

  Returns PublicKey

  The mint address if found, or null if not found.

findMintReference

• findMintReference(lookingFor): null | IndexedReference

• Finds the indexed reference for a given mint address.

  Parameters

  • lookingFor: PublicKey

    The mint address to find the indexed reference for.

  Returns null | IndexedReference

  The indexed reference if found, or null if not found.

generateDriver

• generateDriver(confirmOptions?): Promise<Keypair>

• Generates a new driver keypair for the project.

  Parameters

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<Keypair>

  The new driver keypair.

indexAllMints

• indexAllMints(mintAddresses): Promise<ConfirmedContext[]>

• Indexes all mint addresses for the project.

  Parameters

  • mintAddresses: PublicKey[]

    An array of mint addresses to be indexed.

  Returns Promise<ConfirmedContext[]>

  An array of confirmation contexts for the transactions.

indexMints

• indexMints(index, mints): Promise<ConfirmedContext[]>

• Indexes mints for the project.

  Parameters

  • index: number

    The index of the mint container.

  • mints: PublicKey[]

    An array of mint addresses to be indexed.

  Returns Promise<ConfirmedContext[]>

  An array of confirmation contexts for the transactions.

install

• install(honeycomb): Honeycomb

• Installs the Honeycomb project module in the provided Honeycomb instance.

  Parameters

  • honeycomb: Honeycomb

    The Honeycomb instance to install the module in.

  Returns Honeycomb

  The installed Honeycomb instance.

loadMints

• loadMints(commitmentOrConfig?): Promise<AddressContainer[]>

• Loads mint containers for the project.

  Parameters

  • Optional commitmentOrConfig: Commitment | GetMultipleAccountsConfig

    Commitment or config object for the request.

  Returns Promise<AddressContainer[]>

  An array of mint containers.

removeCriteria

• removeCriteria(args, confirmOptions?): Promise<ConfirmedContext>

• Removes criteria from the project.

  Parameters

  • args: CriteriaArgs

    Arguments for removing the criteria.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

removeDelegation

• removeDelegation(delegate, index, confirmOptions?): Promise<ConfirmedContext>

• Removes a delegation from the project.

  Parameters

  • delegate: PublicKey

    The delegate to be removed.

  • index: number

    The index of the delegation to be removed.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

removeService

• removeService(service, confirmOptions?): Promise<ConfirmedContext>

• Removes a service from the project.

  Parameters

  • service: Service

    The service to be removed.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<ConfirmedContext>

  The confirmation context of the transaction.

Static filterUniqueMints

• filterUniqueMints(mintAddresses, alreeadyCachedMints?): Promise<PublicKey[]>

• Filters unique mint addresses and returns the filtered array.

  Parameters

  • mintAddresses: PublicKey[]

    An array of mint addresses to be filtered.

  • Optional alreeadyCachedMints: AddressContainer[]

  Returns Promise<PublicKey[]>

  An array of unique mint addresses.

Static fromAddress

• fromAddress(connection, projectAddress): Promise<HoneycombProject>

• Creates an instance of HoneycombProject using the provided connection and project address.

  Parameters

  • connection: Connection

    The connection to the Solana blockchain.

  • projectAddress: PublicKey

    The public address of the Honeycomb project.

  Returns Promise<HoneycombProject>

  An instance of HoneycombProject.

Static new

• new(honeycomb, args, confirmOptions?): Promise<HoneycombProject>

• Creates a new Honeycomb project.

  Parameters

  • honeycomb: Honeycomb

    The Honeycomb instance.

  • args: NewHoneycombProjectArgs

    Arguments for creating the new project.

  • Optional confirmOptions: ConfirmOptions

    Confirm options for the transaction.

  Returns Promise<HoneycombProject>

  A newly created HoneycombProject.