Class Project

Readonly allowedPrograms

Readonly authority

Readonly bump

Readonly collections

Readonly creators

Readonly driver

Readonly key

Readonly mintIndexing

Readonly name

Readonly profileDataConfig

Readonly services

pretty

• pretty(): {
      allowedPrograms: PublicKey[];
      authority: string;
      bump: number;
      collections: PublicKey[];
      creators: PublicKey[];
      driver: string;
      key: string;
      mintIndexing: Indexing;
      name: string;
      profileDataConfig: Map<string, ProfileDataType>;
      services: Service[];
  }

• Returns a readable version of Project properties and can be used to convert to JSON and/or logging

  Returns {
      allowedPrograms: PublicKey[];
      authority: string;
      bump: number;
      collections: PublicKey[];
      creators: PublicKey[];
      driver: string;
      key: string;
      mintIndexing: Indexing;
      name: string;
      profileDataConfig: Map<string, ProfileDataType>;
      services: Service[];
  }

  • allowedPrograms: PublicKey[]

  • authority: string

  • bump: number

  • collections: PublicKey[]

  • creators: PublicKey[]

  • driver: string

  • key: string

  • mintIndexing: Indexing

  • name: string

  • profileDataConfig: Map<string, ProfileDataType>

  • services: Service[]

serialize

• serialize(): [Buffer, number]

• Serializes the Project into a Buffer.

  Returns [Buffer, number]

  a tuple of the created Buffer and the offset up to which the buffer was written to store it.

Static byteSize

• byteSize(args): number

• Returns the byteSize of a Buffer holding the serialized data of Project for the provided args.

  Parameters

  • args: ProjectArgs

    need to be provided since the byte size for this account depends on them

  Returns number

Static deserialize

• deserialize(buf, offset?): [Project, number]

• Deserializes the Project from the provided data Buffer.

  Parameters

  • buf: Buffer

  • Optional offset: number

  Returns [Project, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromAccountAddress

• fromAccountAddress(connection, address, commitmentOrConfig?): Promise<Project>

• Retrieves the account info from the provided address and deserializes the Project from its data.

  Parameters

  • connection: Connection

  • address: PublicKey

  • Optional commitmentOrConfig: Commitment | GetAccountInfoConfig

  Returns Promise<Project>

  Throws

  Error if no account info is found at the address or if deserialization fails

Static fromAccountInfo

• fromAccountInfo(accountInfo, offset?): [Project, number]

• Deserializes the Project from the data of the provided web3.AccountInfo.

  Parameters

  • accountInfo: AccountInfo<Buffer>

  • Optional offset: number

  Returns [Project, number]

  a tuple of the account data and the offset up to which the buffer was read to obtain it.

Static fromArgs

• fromArgs(args): Project

• Creates a Project instance from the provided args.

  Parameters

  • args: ProjectArgs

  Returns Project

Static getMinimumBalanceForRentExemption

• getMinimumBalanceForRentExemption(args, connection, commitment?): Promise<number>

• Fetches the minimum balance needed to exempt an account holding Project data from rent

  Parameters

  • args: ProjectArgs

    need to be provided since the byte size for this account depends on them

  • connection: Connection

    used to retrieve the rent exemption information

  • Optional commitment: Commitment

  Returns Promise<number>

Static gpaBuilder

• gpaBuilder(programId?): GpaBuilder<ProjectArgs & {
      accountDiscriminator: number[];
  }>

• Provides a web3.Connection.getProgramAccounts config builder, to fetch accounts matching filters that can be specified via that builder.

  Parameters

  • Optional programId: PublicKey

    the program that owns the accounts we are filtering

  Returns GpaBuilder<ProjectArgs & {
      accountDiscriminator: number[];
  }>