Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fixed profiles specs links #918

Merged
merged 1 commit into from Jun 21, 2022
Merged

docs: fixed profiles specs links #918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion x/profiles/spec/02-concepts.md
View file
Open in desktop
Expand Up @@ -99,7 +99,9 @@ To implement the IBC capability of connecting an external account to a Desmos pr
###### LinkChainAccountPacketData
`LinkChainAccountPacketData` defines the object that should be sent inside a `MsgSendPacket` when wanting to link an external chain to a Desmos profile using IBC.

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/x/profiles/types/models_packets.pb.go#L28-L43
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/x/profiles/types/models_packets.pb.go#L28-L43
```

Note that the `SourceAddress` field must be one of the currently supported types:

Expand Down
40 changes: 30 additions & 10 deletions x/profiles/spec/04-messages.md
View file
Open in desktop
Expand Up @@ -12,7 +12,9 @@ A profile can be created or edited with the `MsgSaveProfile`, which allows to sp

If a profile already exists, and you want to edit only a subset of the fields, you can use `[do-not-modify]` to specify the fields which values should not be changed (i.e. setting the `DTag` to `[do-not-modify]` will preserve the current value of the DTag).

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_profile.proto#L12-L32
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_profile.proto#L12-L32
```

It's expected to fail if a profile with the same DTag exists.

Expand All @@ -21,28 +23,36 @@ A profile can be deleted using the `MsgDeleteProfile`. This will remove all the

Beware that using this message you will lose the ownership of your DTag and you will delete everything that is related to your profile (i.e. incoming DTag transfer requests).

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_profile.proto#L39-L45
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_profile.proto#L39-L45
```

It's expected to fail if the signer does not have a profile.

## Msg/RequestDTagTransfer
A DTag transfer request can be created using the `MsgRequestDTagTransfer`.

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L12-L25
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L12-L25
```

It's expected to fail if the recipient of the request has no profile.

## Msg/CancelDTagTransferRequest
An outgoing DTag transfer request can be canceled using the `MsgCancelDTagTransferRequest`.

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L33-L44
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L33-L44
```

It's expected to fail if the request does not exist.

## Msg/AcceptDTagTransferRequest
An incoming DTag transfer request can be accepted using the `MsgAcceptDTagTransferRequest`. When accepting a DTag transfer request, the user accepting it **must** specify a new DTag that they want after their old one gets transferred to the request sender.

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L52-L70
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L52-L70
```

It's expected to fail if:
* the request does not exist.
Expand All @@ -51,14 +61,18 @@ It's expected to fail if:
## Msg/RefuseDTagTransferRequest
An incoming DTag transfer request can be refused using `MsgRefuseDTagTransferRequest`

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L78-L89
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_dtag_requests.proto#L78-L89
```

It's expected to fail if the request does not exist.

## Msg/LinkChainAccount
A new chain link can be created using the `MsgLinkChainAccount`

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_chain_links.proto#L11-L35
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_chain_links.proto#L11-L35
```

It's expected to fail if:
* the signer does not have a profile.
Expand All @@ -67,20 +81,26 @@ It's expected to fail if:
## Msg/UnlinkChainAccount
An existing chain link can be deleted using the `MsgUnlinkChainAccount`

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_chain_links.proto#L42-L54
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_chain_links.proto#L42-L54
```

It's expected to fail if the chain link does not exist.

## Msg/LinkApplication
A new application link can be created using the `MsgLinkApplication`

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_app_links.proto#L11-L48
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_app_links.proto#L11-L48
```

It's expected to fail if the signer does not have a profile.

## Msg/UnlinkApplication
An existing application link can be deleted using the `MsgUnlinkApplication`

+++ https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_app_links.proto#L56-L71
```js reference
https://github.com/desmos-labs/desmos/blob/v3.0.0/proto/desmos/profiles/v2/msgs_app_links.proto#L56-L71
```

It's expected to fail if the application link does not exist.