@kamino-finance/klend-sdk/src/@codegen/klend/accounts/UserMetadata.ts

Typescript SDK for interacting with the Kamino Lending (klend) protocol

/* eslint-disable @typescript-eslint/no-unused-vars */
import {
  address,
  Address,
  fetchEncodedAccount,
  fetchEncodedAccounts,
  GetAccountInfoApi,
  GetMultipleAccountsApi,
  Rpc,
} from "@solana/kit"
/* eslint-enable @typescript-eslint/no-unused-vars */
import BN from "bn.js" // eslint-disable-line @typescript-eslint/no-unused-vars
import * as borsh from "@coral-xyz/borsh" // eslint-disable-line @typescript-eslint/no-unused-vars
import { borshAddress } from "../utils" // eslint-disable-line @typescript-eslint/no-unused-vars
import * as types from "../types" // eslint-disable-line @typescript-eslint/no-unused-vars
import { PROGRAM_ID } from "../programId"

export interface UserMetadataFields {
  /** Pubkey of the referrer/owner - pubkey::default if no referrer */
  referrer: Address
  /** Bump used for validation of account address */
  bump: BN
  /** User lookup table - used to store all user accounts - atas for each reserve mint, each obligation PDA, UserMetadata itself and all referrer_token_states if there is a referrer */
  userLookupTable: Address
  /** User metadata account owner */
  owner: Address
  padding1: Array<BN>
  padding2: Array<BN>
}

export interface UserMetadataJSON {
  /** Pubkey of the referrer/owner - pubkey::default if no referrer */
  referrer: string
  /** Bump used for validation of account address */
  bump: string
  /** User lookup table - used to store all user accounts - atas for each reserve mint, each obligation PDA, UserMetadata itself and all referrer_token_states if there is a referrer */
  userLookupTable: string
  /** User metadata account owner */
  owner: string
  padding1: Array<string>
  padding2: Array<string>
}

/** Referrer account -> each owner can have multiple accounts for specific reserves */
export class UserMetadata {
  /** Pubkey of the referrer/owner - pubkey::default if no referrer */
  readonly referrer: Address
  /** Bump used for validation of account address */
  readonly bump: BN
  /** User lookup table - used to store all user accounts - atas for each reserve mint, each obligation PDA, UserMetadata itself and all referrer_token_states if there is a referrer */
  readonly userLookupTable: Address
  /** User metadata account owner */
  readonly owner: Address
  readonly padding1: Array<BN>
  readonly padding2: Array<BN>

  static readonly discriminator = Buffer.from([
    157, 214, 220, 235, 98, 135, 171, 28,
  ])

  static readonly layout = borsh.struct<UserMetadata>([
    borshAddress("referrer"),
    borsh.u64("bump"),
    borshAddress("userLookupTable"),
    borshAddress("owner"),
    borsh.array(borsh.u64(), 51, "padding1"),
    borsh.array(borsh.u64(), 64, "padding2"),
  ])

  constructor(fields: UserMetadataFields) {
    this.referrer = fields.referrer
    this.bump = fields.bump
    this.userLookupTable = fields.userLookupTable
    this.owner = fields.owner
    this.padding1 = fields.padding1
    this.padding2 = fields.padding2
  }

  static async fetch(
    rpc: Rpc<GetAccountInfoApi>,
    address: Address,
    programId: Address = PROGRAM_ID
  ): Promise<UserMetadata | null> {
    const info = await fetchEncodedAccount(rpc, address)

    if (!info.exists) {
      return null
    }
    if (info.programAddress !== programId) {
      throw new Error(
        `UserMetadataFields account ${address} belongs to wrong program ${info.programAddress}, expected ${programId}`
      )
    }

    return this.decode(Buffer.from(info.data))
  }

  static async fetchMultiple(
    rpc: Rpc<GetMultipleAccountsApi>,
    addresses: Address[],
    programId: Address = PROGRAM_ID
  ): Promise<Array<UserMetadata | null>> {
    const infos = await fetchEncodedAccounts(rpc, addresses)

    return infos.map((info) => {
      if (!info.exists) {
        return null
      }
      if (info.programAddress !== programId) {
        throw new Error(
          `UserMetadataFields account ${info.address} belongs to wrong program ${info.programAddress}, expected ${programId}`
        )
      }

      return this.decode(Buffer.from(info.data))
    })
  }

  static decode(data: Buffer): UserMetadata {
    if (!data.slice(0, 8).equals(UserMetadata.discriminator)) {
      throw new Error("invalid account discriminator")
    }

    const dec = UserMetadata.layout.decode(data.slice(8))

    return new UserMetadata({
      referrer: dec.referrer,
      bump: dec.bump,
      userLookupTable: dec.userLookupTable,
      owner: dec.owner,
      padding1: dec.padding1,
      padding2: dec.padding2,
    })
  }

  toJSON(): UserMetadataJSON {
    return {
      referrer: this.referrer,
      bump: this.bump.toString(),
      userLookupTable: this.userLookupTable,
      owner: this.owner,
      padding1: this.padding1.map((item) => item.toString()),
      padding2: this.padding2.map((item) => item.toString()),
    }
  }

  static fromJSON(obj: UserMetadataJSON): UserMetadata {
    return new UserMetadata({
      referrer: address(obj.referrer),
      bump: new BN(obj.bump),
      userLookupTable: address(obj.userLookupTable),
      owner: address(obj.owner),
      padding1: obj.padding1.map((item) => new BN(item)),
      padding2: obj.padding2.map((item) => new BN(item)),
    })
  }
}