Class RoleAccount

constructor

• new RoleAccount(_data, _key, _roleMembers): RoleAccount

• Parameters

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

  • _key: PublicKey

  • _roleMembers: RoleMembership[]

  Returns RoleAccount

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(): PublicKey

• Returns PublicKey

roleMembers

• get roleMembers(): readonly RoleMembership[]

• Returns readonly RoleMembership[]

Static acceptInvite

• acceptInvite(program, keyInput, roleAccount, profileRoleMemberships, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      roleMembership: [PublicKey, number];
  }

• Accepts an invite to join a Role

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: {
        profile: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>;
    } | {
        key: AsyncSigner<unknown>;
    }

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • profileRoleMemberships: ProfileRoleMembership

    the role membership account for the new member

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

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

  InstructionReturn

  • instructions: InstructionReturn

  • roleMembership: [PublicKey, number]

Static addExistingMemberToRole

• addExistingMemberToRole(program, keyInput, roleAccount, newMemberProfileMembershipAccount, newMember, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      roleMembership: [PublicKey, number];
  }

• Adds an existing member to a role

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • newMemberProfileMembershipAccount: ProfileRoleMembership

    the role membership account for the new member

  • newMember: PublicKey

    the profile of the member to be added to the role

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

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

  InstructionReturn

  • instructions: InstructionReturn

  • roleMembership: [PublicKey, number]

Static decodeData

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

• Parameters

  • account: KeyedAccountInfo

  • program: PlayerProfileIDLProgram

  Returns DecodedAccountData<RoleAccount>

Static findAddress

• findAddress(program, profile, sequenceId): [PublicKey, number]

• Find the PDA of the Role account

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • profile: PublicKey

    the player profile account address

  • sequenceId: BN

    the sequence id

  Returns [PublicKey, number]

  InstructionReturn

Static inviteToRole

• inviteToRole(program, keyInput, roleAccount, newMember, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      roleMembership: [PublicKey, number];
  }

• Invites a new member to a role on a Profile

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • newMember: PublicKey

    the profile of the user to be added to the role

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

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

  InstructionReturn

  • instructions: InstructionReturn

  • roleMembership: [PublicKey, number]

Static joinRole

• joinRole(program, keyInput, roleAccount, optionalProfileOrRoleInput?): {
      instructions: InstructionReturn;
      roleMembership: [PublicKey, number];
  }

• Allows a player to join a role if accepting_new_members is enabled

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: {
        profile: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>;
    } | {
        key: AsyncSigner<unknown>;
    }

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

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

  InstructionReturn

  • instructions: InstructionReturn

  • roleMembership: [PublicKey, number]

Static leaveRole

• leaveRole(program, keyInput, roleAccount, profileRoleMemberships, optionalProfileOrRoleInput?): InstructionReturn

• Allows a player to leave a role

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

  • keyInput: {
        profile: ProfileKeyInput<ProfilePermissions, AsyncSigner<unknown>>;
    } | {
        key: AsyncSigner<unknown>;
    }

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • profileRoleMemberships: ProfileRoleMembership

    the role membership account for the member

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

  Returns InstructionReturn

  InstructionReturn

Static removeMemberFromRole

• removeMemberFromRole(program, keyInput, roleAccount, memberProfileMembershipAccount, member, optionalProfileOrRoleInput?): InstructionReturn

• Removes a member from a role

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: RoleAccount

    the role account address

  • memberProfileMembershipAccount: ProfileRoleMembership

    the role membership account for the new member

  • member: PublicKey

    the profile of the member to be added to the role

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

  Returns InstructionReturn

  InstructionReturn

Static setAcceptingNewMembers

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

• Flags the role as accepting members.

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: PublicKey

    the role account address

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

  Returns InstructionReturn

  InstructionReturn

Static setAuthorizer

• setAuthorizer(program, keyInput, roleAccount, newAuthorizer, optionalProfileOrRoleInput?): InstructionReturn

• Sets the authorizer field on a role if it is not already set

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: PublicKey

    the role account address

  • newAuthorizer: PublicKey

    the new authorizer

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

  Returns InstructionReturn

  InstructionReturn

Static setName

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

• Sets the name of the role

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: PublicKey

    the role account address

  • name: string

    the role's new name

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

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

  InstructionReturn & PDA of name account

  • instructions: InstructionReturn

  • name: [PublicKey, number]

Static setNotAcceptingNewMembers

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

• Flags the role as NOT accepting members.

  Parameters

  • program: PlayerProfileIDLProgram

    the player profile program

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

    the key to use to sign the transaction

  • roleAccount: PublicKey

    the role account address

  • Optional optionalProfileOrRoleInput: OptionalProfileOrRoleInput[]

    Optional Input in case a role or profile is creating the tx

  Returns InstructionReturn

  InstructionReturn