Skip to main content

Fetch Roles & Permissions

Roles and Permissions, as a functionality, enable on-chain moderation for spaces entities on the Subsocial Blockchain. You can leverage the roles pallet from the SDK methods to choose who can do different activities in a space.

Role​

A role is a configuration created for a space, with a set of permissions, that is created on-chain and can be granted to any Space or Account. These permissions can include CreatePosts, UpdateSpace, UpdateOwnPosts, HideOwnPosts, etc.

This section covers how you can fetch roles data from the JS SDK via different methods.

Fetch a role by id​

This following example shows how you can fetch a role by its id.

  const roleId = '4'

  const substrateApi = await api.substrateApi

  const role = await substrateApi.query.roles.roleById(
    roleId 
  )

  console.log(role)

Try it live on the Playground:

Fetch a list of users with a particular role​

This following example shows how you can fetch a list of users by a role id.

  const roleId = '4'

  const substrateApi = await api.substrateApi

  const users = await substrateApi.query.roles.usersByRoleId(
    roleId 
  )
  console.log(users)

Try it live on the Playground:

Fetch roles by space id​

This following example shows how you can fetch all the roles of a space by the id of that space.

  const spaceId = '1005'

  const substrateApi = await api.substrateApi

  const roleIds = await substrateApi.query.roles.roleIdsBySpaceId(
    spaceId 
  )
  console.log(roleIds)

Try it live on the Playground:

Fetch roles by user​

This following example shows how you can fetch all the roles of a user based on their account address.

  const spaceId = '1005'

  const user = {
    Account: '5HYYeCa1Hae5YYGJ2pHskHLVrA7V5WjaSuSbntidhhD9qqgs'
  }

  const substrateApi = await api.substrateApi

  const roleIds = await substrateApi.query.roles.roleIdsByUserInSpace(
    user,
    spaceId 
  )

  console.log(roleIds)

Try it live on the Playground:

Next up, we will see how you can create custom roles for spaces and grant permission to users.