Client

CLI

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

Query

The query commands allow users to query the relationships state.

desmos query relationships --help

relationships

The relationships command allows user to query the relationships inside a subspace having a specific id, providing an optional creator and counterparty.

desmos query relationships [subspace-id] [[creator]] [[counterparty]] [flags]

Example:

desmos query relationships relationships 1 desmos1... desmos1...

Example Output:

pagination:
  next_key: null
  total: "0"
relationships:
- counterparty: desmos1tamzg6rfj9wlmqhthgfmn9awq0d8ssgfr8fjns
  creator: desmos13yp2fq3tslq6mmtq4628q38xzj75ethzela9uu
  subspace_id: "1"

blocks

The blocks command allows to query the user blocks stored inside a subspace having a given id, providing an optional blocker and blocked addresses.

desmos query relationships blocks [subspace-id] [[blocker]] [[blocked]] [flags]

Example:

desmos query relationships blocks 1 desmos1... desmos1...

Example Output:

blocks:
  - blocked: desmos1tamzg6rfj9wlmqhthgfmn9awq0d8ssgfr8fjns
    blocker: desmos13yp2fq3tslq6mmtq4628q38xzj75ethzela9uu
    reason: ""
    subspace_id: "1"
pagination:
  next_key: null
  total: "0"

Transactions

The tx commands allow users to interact with the relationships module.

desmos tx relationships --help

create-relationship

The create-relationship allows users to create a relationship with another user inside a specific subspace.

desmos tx relationships create-relationship [counterparty] [subspace-id] [flags]

Example:

desmos tx relationships create-relationship desmos1... 1

delete-relationship

The delete-relationship allows users to delete an existing relationship.

desmos tx relationships delete-relationship [counterparty] [subspace-id] [flags]

Example:

desmos tx relationships delete-relationship desmos1... 1

block

The block command allows users to block another user inside a specific subspace, optionally providing a reason.

desmos tx relationships block [address] [subspace] [[reason]] [flags]

Example:

desmos tx relationships block desmos1... 1 "My reason"

unblock

The unblock command allows users to unblock a previously blocked user.

desmos tx relationships unblock [address] [subspace] [flags]

Example:

desmos tx relationships unblock desmos1... 1

gRPC

A user can query the relationships module gRPC endpoints.

Relationships

The Relationships endpoint allows users to query for the relationships inside a subspace having a given id, optionally providing user and counterparty addresses.

desmos.relationships.v1.Query/Relationships

Example:

grpcurl -plaintext \
  -d '{"subspace_id": "1"}' localhost:9090 desmos.relationships.v1.Query/Relationships

Example Output:

{
  "relationships": [
    {
      "creator": "desmos13yp2fq3tslq6mmtq4628q38xzj75ethzela9uu",
      "counterparty": "desmos1tamzg6rfj9wlmqhthgfmn9awq0d8ssgfr8fjns",
      "subspaceId": "1"
    }
  ],
  "pagination": {
    "total": "1"
  }
}

Blocks

The Blocks endpoint allows users to query for the user blocks inside a subspace having a given id, optionally providing user and counterparty addresses.

desmos.relationships.v1.Query/Blocks

Example:

grpcurl -plaintext \
  -d '{"subspace_id": "1"}' localhost:9090 desmos.relationships.v1.Query/Blocks

Example Output:

{
  "blocks": [
    {
      "blocker": "desmos13yp2fq3tslq6mmtq4628q38xzj75ethzela9uu",
      "blocked": "desmos1tamzg6rfj9wlmqhthgfmn9awq0d8ssgfr8fjns",
      "subspaceId": "1"
    }
  ],
  "pagination": {
    "total": "1"
  }
}

REST

A user can query the relationships module using REST endpoints.

Relationships

The relationships endpoint allows users to query for the relationships inside a subspace having a given id, optionally providing user and counterparty addresses.

/desmos/relationships/v1/relationships?subspace_id={subspaceID}&user={userAddress}&counterparty={counterpartyAddress}

Blocks

The blocks endpoint allows users to query for the user blocks inside a subspace having a given id, optionally providing user and counterparty addresses.

/desmos/relationships/v1/blocks?subspace_id={subspaceID}&blocker={blockerAddress}&blocked={blockedAddress}