Version: master

Client

CLI

A user can query and interact with the subspaces module using the CLI.

Query

The query commands allow users to query the subspaces state.

desmos query subspaces --help

subspace

The subspace query command allows users to query a subspace with the given id.

desmos query subspaces subspace [id] [flags]

Example:

desmos query subspaces subspace 1

Example output:

subspace:
  creation_time: "2022-06-20T14:52:23.049305Z"
  creator: desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc
  description: "this is a test subspace"
  id: "1"
  name: test
  owner: desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3
  treasury: desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3

subspaces

The subspaces query command allows users to query all the subspaces. Optional pagination is available.

desmos query subspaces subspaces [flags]

Example:

desmos query subspaces subspaces --page=2 --limit=100

Example output:

pagination:
  next_key: null
  total: "0"
subspaces:
- creation_time: "2022-06-20T14:52:23.049305Z"
  creator: desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc
  description: ""
  id: "1"
  name: test
  owner: desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3
  treasury: desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3

sections

The sections query command allows users to query the sections state.

desmos query subspaces sections [command] [flags] --help

list

The list query command allows users to query all the sections of a subspace. Optional pagination is available.

desmos query subspaces sections list [subspace-id] [flags]

Example:

desmos query subspaces sections list 1 --page=2 --limit=100

Example output:

pagination:
  next_key: null
  total: "0"
sections:
- description: This is the default subspace section
  id: 0
  name: Default section
  parent_id: 0
  subspace_id: "1"
- description: ""
  id: 1
  name: "1"
  parent_id: 0
  subspace_id: "1"
- description: this is a test section
  id: 2
  name: "1"
  parent_id: 0
  subspace_id: "1"
- description: this is a test section 2
  id: 3
  name: "1"
  parent_id: 0
  subspace_id: "1"

section

The section query command allows users to query a specific section inside a subspace.

desmos query subspaces sections section [subspace-id] [section-id] [flags]

Example:

desmos query subspaces sections section 1 2

Example output:

section:
  description: this is a test section
  id: 2
  name: "1"
  parent_id: 0
  subspace_id: "1"

groups

The groups query command allows users to query the groups state.

desmos query subspaces groups [command] --help

list

The list query command allows users to query all the groups of a subspace. Optional pagination is available.

desmos query subspaces groups list [subspace-id] [flags] --help

Example:

desmos query subspaces groups list 1 

Example output:

groups:
- description: This is a default user group which all users are automatically part
    of
  id: 0
  name: Default
  permissions: []
  section_id: 0
  subspace_id: "1"
- description: A test group
  id: 1
  name: TestGroup
  permissions: []
  section_id: 0
  subspace_id: "1"
pagination:
  next_key: null
  total: "0"

group

The group query command allows users to query a specific group of a subspace.

desmos query subspaces groups group [subspace-id] [group-id] [flags]

Example:

desmos query subspaces groups group 1 1

Example output:

group:
  description: A test group
  id: 1
  name: TestGroup
  permissions: []
  section_id: 0
  subspace_id: "1"

members

The members query command allows users to query the members of a group.

desmos query subspaces members [subspace-id] [group-id] [flags]

Example:

desmos query subspaces members 1 1

Example output:

members:
- desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc
- desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3
pagination:
  next_key: null
  total: "0"

permissions

The permissions query command allows users to query user's permissions of a specific subspace or section.

desmos query subspaces permissions [subspace-id] [section-id] [user] [flags]

Example:

desmos query subspaces permissions 1 0 desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc  

Example output:

details:
- section_id: 0
  subspace_id: "1"
  user:
    permission:
    - EVERYTHING
    user: desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc
- group:
    group_id: 0
    permission: []
  section_id: 0
  subspace_id: "1"
permissions:
- EVERYTHING

allowances

The allowances query command allows users to query the allowances state.

desmos query subspaces allowances [command] [flags]

user-allowances

The user-allowances query command allows users to query the allowances of a specific user.

desmos query subspaces allowances user-allowances [subspace-id] [[grantee]] [flags]

Example:

desmos query subspaces allowances user-allowances 1 desmos1f39c3qlgc7mgu0v505easutdrukr8yal0246fs

Example output:

grants:
  - allowance:
      '@type': /cosmos.feegrant.v1beta1.BasicAllowance
      expiration: null
      spend_limit: []
    grantee:
      '@type': /desmos.subspaces.v3.UserGrantee
      user: desmos1f39c3qlgc7mgu0v505easutdrukr8yal0246fs
    granter: desmos1dm3saw9gwx0ha4mdd67rn2ahfwhewzgvd7q5vn
    subspace_id: "1"
pagination:
  next_key: null
  total: "0"

group-allowances

The group-allowances query command allows users to query the allowances of a specific group.

desmos query subspaces allowances group-allowances [subspace-id] [group-id] [flags]

Example:

desmos query subspaces allowances group-allowances 1 1

Example output:

grants:
  - allowance:
      '@type': /cosmos.feegrant.v1beta1.BasicAllowance
      expiration: null
      spend_limit: []
    grantee:
      '@type': /desmos.subspaces.v3.GroupGrantee
      group_id: 1
    granter: desmos1dm3saw9gwx0ha4mdd67rn2ahfwhewzgvd7q5vn
    subspace_id: "1"
pagination:
  next_key: null
  total: "0"

gRPC

Users can query the subspaces module gRPC endpoints.

Subspaces

The Subspaces endpoint allows users to query all the subspaces inside Desmos.

desmos.subspaces.v3.Query/Subspaces

Example:

grpcurl -plaintext localhost:9090 desmos.subspaces.v3.Query/Subspaces

Example output:

{
  "subspaces": [
    {
      "id": "1",
      "name": "test",
      "treasury": "desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3",
      "owner": "desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3",
      "creator": "desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc",
      "creationTime": "2022-06-20T14:52:23.049305Z"
    }
  ],
  "pagination": {
    "total": "1"
  }
}

Subspace

The Subspace endpoint allows users to query a subspace associated with the given ID.

desmos.subspaces.v3.Query/Subspace

Example:

grpcurl -plaintext -d '{"subspace_id":1}' localhost:9090 desmos.subspaces.v3.Query/Subspace

Example output:

{
  "subspace": {
    "id": "1",
    "name": "test",
    "treasury": "desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3",
    "owner": "desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3",
    "creator": "desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc",
    "creationTime": "2022-06-20T14:52:23.049305Z"
  }
}

Sections

The Sections endpoint allows users to query the sections associated with the given subspace ID.

desmos.subspaces.v3.Query/Sections

Example:

grpcurl -plaintext -d '{"subspace_id":1}' localhost:9090 desmos.subspaces.v3.Query/Sections 

Example output:

{
  "sections": [
    {
      "subspaceId": "1",
      "name": "Default section",
      "description": "This is the default subspace section"
    },
    {
      "subspaceId": "1",
      "id": 1,
      "name": "1"
    },
    {
      "subspaceId": "1",
      "id": 2,
      "name": "1",
      "description": "this is a test section"
    },
    {
      "subspaceId": "1",
      "id": 3,
      "name": "1",
      "description": "this is a test section 2"
    }
  ],
  "pagination": {
    "total": "4"
  }
}

Section

The Section endpoint allows users to query a section with the given ID inside the subspace with the given ID.

desmos.subspaces.v3.Query/Section

Example:

grpcurl -plaintext -d '{"subspace_id":1, "section_id":1}' localhost:9090 desmos.subspaces.v3.Query/Section

Example output:

{
  "section": {
    "subspaceId": "1",
    "id": 1,
    "name": "1"
  }
}

UserGroups

The UserGroups endpoint allows users to query all the user groups associated with a given subspace ID and section ID.

desmos.subspaces.v3.Query/UserGroups

Example:

grpcurl -plaintext -d '{"subspace_id":1, "section_id": 0}' localhost:9090 desmos.subspaces.v3.Query/UserGroups

Example output:

{
  "groups": [
    {
      "subspaceId": "1",
      "name": "Default",
      "description": "This is a default user group which all users are automatically part of"
    },
    {
      "subspaceId": "1",
      "id": 1,
      "name": "TestGroup",
      "description": "A test group"
    }
  ],
  "pagination": {
    "total": "2"
  }
}

UserGroup

The UserGroup endpoint allows users to query a specific user group with the given ID associated with a given subspace ID.

desmos.subspaces.v3.Query/UserGroup

Example:

grpcurl -plaintext -d '{"subspace_id":1, "group_id":1}' localhost:9090 desmos.subspaces.v3.Query/UserGroup 

Example output:

{
  "group": {
    "subspaceId": "1",
    "id": 1,
    "name": "TestGroup",
    "description": "A test group"
  }
}

UserGroupMembers

The UserGroupMembers endpoint allows users to query all the members of the user group with the given ID inside the subspace with the given ID.

desmos.subspaces.v3.Query/UserGroupMembers

Example:

grpcurl -plaintext -d '{"subspace_id":1, "group_id":1}' localhost:9090 desmos.subspaces.v3.Query/UserGroupMembers

Example output:

{
  "members": [
    "desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc",
    "desmos1rfv0f7mx7w9d3jv3h803u38vqym9ygg344asm3"
  ],
  "pagination": {
    "total": "2"
  }
}

UserPermissions

The UserPermissions endpoint allows users to query all the user's permissions inside the subspace with the given ID and the section with the given ID.

desmos.subspaces.v3.Query/UserPermissions

Example:

grpcurl -plaintext -d '{"subspace_id":1, "section_id":0, "user": "desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc"}' localhost:9090 desmos.subspaces.v3.Query/UserPermissions

Example output:

{
  "permissions": [
    "EVERYTHING"
  ],
  "details": [
    {
      "subspaceId": "1",
      "user": {
        "user": "desmos1nwp8gxrnmrsrzjdhvk47vvmthzxjtphgxp5ftc",
        "permission": [
          "EVERYTHING"
        ]
      }
    },
    {
      "subspaceId": "1",
      "group": {
        
      }
    },
    {
      "subspaceId": "1",
      "group": {
        "groupId": 1
      }
    }
  ]
}

UserAllowances

The UserAllowances endpoint allows users to query all the user's allowances inside the subspace with the given ID.

desmos.subspaces.v3.Query/UserAllowances

Example:

grpcurl -plaintext -d '{"subspace_id":1, "grantee": "desmos1f39c3qlgc7mgu0v505easutdrukr8yal0246fs"}' localhost:9090 desmos.subspaces.v3.Query/UserAllowances

Example output:

{
  "grants": [
    {
      "subspaceId": "1",
      "granter": "desmos1dm3saw9gwx0ha4mdd67rn2ahfwhewzgvd7q5vn",
      "grantee": {"@type":"/desmos.subspaces.v3.UserGrantee","user":"desmos1f39c3qlgc7mgu0v505easutdrukr8yal0246fs"},
      "allowance": {"@type":"/cosmos.feegrant.v1beta1.BasicAllowance"}
    }
  ],
  "pagination": {
    "total": "1"
  }
}

GroupAllowances

The GroupAllowances endpoint allows users to query all the group's allowances inside the subspace with the given ID.

desmos.subspaces.v3.Query/GroupAllowances

Example:

grpcurl -plaintext -d '{"subspace_id":1, "group_id": 1}' localhost:9090 desmos.subspaces.v3.Query/GroupAllowances

Example output:

{
  "grants": [
    {
      "subspaceId": "1",
      "granter": "desmos1dm3saw9gwx0ha4mdd67rn2ahfwhewzgvd7q5vn",
      "grantee": {"@type":"/desmos.subspaces.v3.GroupGrantee","groupId":1},
      "allowance": {"@type":"/cosmos.feegrant.v1beta1.BasicAllowance"}
    }
  ],
  "pagination": {
    "total": "1"
  }
}

REST

A user can query the subspaces module using REST endpoints.

Subspaces

The Subspaces endpoint allows users to query all the subspaces inside Desmos.

/desmos/subspaces/v3/subspaces

Subspace

The Subspace endpoint allows users to query a subspace associated with the given ID.

/desmos/subspaces/v3/subspaces/{subspace_id}

Sections

The Sections endpoint allows users to query the sections associated with the given subspace ID.

/desmos/subspaces/v3/{subspace_id}/sections

Section

The Section endpoint allows users to query a section with the given ID associated with the subspace with the given ID.

/desmos/subspaces/v3/{subspace_id}/sections/{section_id}

UserGroups

The UserGroups endpoint allows users to query all the user groups associated with a given subspace ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/groups

UserGroup

The UserGroup endpoint allows users to query a specific user group with the given ID associated with a given subspace ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/groups/{group_id}

UserGroupMembers

The UserGroupMembers endpoint allows users to query all the members of the user group with the given ID inside the subspace with the given ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/groups/{group_id}/members

UserPermissions

The UserPermissions endpoint allows users to query all the user's permissions inside the subspace with the given ID and the section with the given ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/permissions/{user}

UserAllowances

The UserAllowances endpoint allows users to query all the user's allowances inside the subspace with the given ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/allowances/users?grantee={grantee}

GroupAllowances

The GroupAllowances endpoint allows users to query all the group's allowances inside the subspace with the given ID.

/desmos/subspaces/v3/subspaces/{subspace_id}/allowances/groups?group_id={group_id}

Client

CLI​

Query​

subspace​

subspaces​

sections​

list​

section​

groups​

list​

group​

members​

permissions​

allowances​

user-allowances​

group-allowances​

gRPC​

Subspaces​

Subspace​

Sections​

Section​

UserGroups​

UserGroup​

UserGroupMembers​

UserPermissions​

UserAllowances​

GroupAllowances​

REST​

Subspaces​

Subspace​

Sections​

Section​

UserGroups​

UserGroup​

UserGroupMembers​

UserPermissions​

UserAllowances​

GroupAllowances​

CLI

Query

subspace

subspaces

sections

list

section

groups

list

group

members

permissions

allowances

user-allowances

group-allowances

gRPC

Subspaces

Subspace

Sections

Section

UserGroups

UserGroup

UserGroupMembers

UserPermissions

UserAllowances

GroupAllowances

REST

Subspaces

Subspace

Sections

Section

UserGroups

UserGroup

UserGroupMembers

UserPermissions

UserAllowances

GroupAllowances