Class PlayerProfile

constructor

• new PlayerProfile(_data, _key, _profileKeys): PlayerProfile

• Parameters

  • _data: AnchorTypeDef<Object, AnchorDefined<PlayerProfileIDL, Record<string, never>>>

  • _key: PublicKey

  • _profileKeys: ProfileKey[]

  Returns PlayerProfile

Static Readonly ACCOUNT_NAME

Static Readonly MIN_DATA_SIZE

data

• get data(): Readonly<AnchorTypeDef<Object, AnchorDefined<PlayerProfileIDL, Record<string, never>>>>

• Returns Readonly<AnchorTypeDef<Object, AnchorDefined<PlayerProfileIDL, Record<string, never>>>>

key

• get key(): Readonly<PublicKey>

• Returns Readonly<PublicKey>

profileKeys

• get profileKeys(): readonly ProfileKey[]

• Returns readonly ProfileKey[]

Static addKeys

• addKeys<T, U>(program, key, profile, permissionsClass, scope, keys, optionalProfileOrRoleInput?): InstructionReturn

• Add keys to a profile's permissions list

  Type Parameters

  • T extends PermissionTypeStatic<U>

  • U extends PermissionType<U>

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • key: AsyncSigner<unknown>

    The key to use to sign the transaction

  • profile: PlayerProfile

    the player profile

  • permissionsClass: T

    the permissions class

  • scope: PublicKey

    the permissions scope

  • keys: {
        expireTime: null | BN;
        key: PublicKey;
        permissions: U;
    }[]

    the keys to add

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    optional profiles or roles

  Returns InstructionReturn

  InstructionReturn

Static adjustAuth

• adjustAuth(program, keyInputs, addKeys, removeRange, newKeyThreshold, optionalProfileOrRoleInput?): InstructionReturn

• Adjust authorized keys on a player profile

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInputs: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>[]

    they keys that will sign the transaction

  • addKeys: (<R>(cont) => R)[]

    keys to be added

  • removeRange: [number, number]

    the range of keys to remove (these are indices)

  • newKeyThreshold: number

    new key threshold

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    optional profiles or roles

  Returns InstructionReturn

  InstructionReturn

Static createProfile

• createProfile(program, profile, keys, keyThreshold): InstructionReturn

• Create a new player profile

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • profile: AsyncSigner<unknown>

    the player profile account address

  • keys: KeyEntry<unknown>[]

    the keys to add to the player profile

  • keyThreshold: number

    the ey thresh hold

  Returns InstructionReturn

  InstructionReturn

Static createRole

• createRole(program, keyInput, newRoleAccount, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      role: [PublicKey, number];
  }

• Creates a new role for the associated Profile

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>

    The key to use to sign the transaction

  • newRoleAccount: [PublicKey, number]

    the new role account PDA & bump

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

  Returns {
      instructions: InstructionReturn;
      role: [PublicKey, number];
  }

  InstructionReturn & newRoleAccount

  • instructions: InstructionReturn

  • role: [PublicKey, number]

Static decodeData

• decodeData(account, program): DecodedAccountData<PlayerProfile>

• Parameters

  • account: KeyedAccountInfo

  • program: PlayerProfileIDLProgram

  Returns DecodedAccountData<PlayerProfile>

Static removeKeys

• removeKeys(program, keyInput, fundsTo, keysRange, optionalProfileOrRoleInput?): InstructionReturn

• Removes a set of non-auth keys to a profile.

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>

    the key input

  • fundsTo: "funder" | PublicKey

    the address where rent refunds will be sent

  • keysRange: [number, number]

    the range of keys to remove (these are indices)

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    optional profiles or roles

  Returns InstructionReturn

  InstructionReturn

Static removeRole

• removeRole(program, keyInput, roleAccount, optionalProfileOrRoleInput?): InstructionReturn

• Removes a role from the associated Profile

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>

    The key to use to sign the transaction

  • roleAccount: PublicKey

    The role being removed

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

  Returns InstructionReturn

  InstructionReturn

Static setName

• setName(program, keyInput, name, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      name: [PublicKey, number];
  }

• Sets the name of the profile.

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>

    The key to use to sign the transaction

  • name: string

    the name account

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    optional profiles or roles for validation

  Returns {
      instructions: InstructionReturn;
      name: [PublicKey, number];
  }

  InstructionReturn

  • instructions: InstructionReturn

  • name: [PublicKey, number]