-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:desmos-labs/desmos into paul/add-…
…post-reactions-query
- Loading branch information
Showing
77 changed files
with
2,622 additions
and
1,621 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # Chain link | ||
| A chain link represents a link to an external chain account that has been created by the user to connect their Desmos profile to such accounts. These links can be created either offline or using IBC following the specification described inside the [_"Create a chain link"_ section](#create-a-chain-link). | ||
|
|
||
| ## Contained data | ||
| Here follows the data contained inside a chain link. | ||
|
|
||
| ### `User` | ||
| Represents the Desmos address to which the chain link is associated. | ||
|
|
||
| ### `Address` | ||
| Contains the data of the external chain address. Currently, it can be of two different types: | ||
|
|
||
| - `Bech32Address` to represent Bech32-based addresses | ||
| - `Base58Address` to support Base58-encoded addresses | ||
|
|
||
| ### `Proof` | ||
| Contains the data proving the ownership of the external chain account. | ||
|
|
||
| #### `PubKey` | ||
| Contains the data of the public key associated with the external address that is used to verify the ownership of such address. | ||
|
|
||
| #### `Signature` | ||
| Represents the hex-encoded signature of the plain text that has been created signing it with the private key associated with the provided public key. | ||
|
|
||
| #### `PlainText` | ||
| Represents the plain text value that has been signed with the private key associated with the address in order to get the signature. | ||
|
|
||
| ### `ChainConfig` | ||
| Contains the details of the external chain to which the link is associated. | ||
|
|
||
| #### `Name` | ||
| Contains the human readable chain name. | ||
|
|
||
| ### `CreationTime` | ||
| Represents the time in which the link has been created. | ||
|
|
||
| ## Create a chain link | ||
| ### 1. Create the ownership proofs | ||
| When creating a chain link, you need to provide two different proofs to make sure the link is valid: | ||
|
|
||
| 1. The proof that you own the external chain account | ||
| 2. The proof that you own the Desmos profile to which you want to link | ||
|
|
||
| In order to create a proof, the following steps are needed: | ||
|
|
||
| 1. Get a generic plain text data to sign | ||
| 2. Sign the plain text data using your private key | ||
| 3. Assemble the signature, plain text and public key into a `Proof` object. | ||
|
|
||
| Here is an example of a valid proof object encoded using JSON: | ||
| ```json | ||
| { | ||
| "pub_key": { | ||
| "@type": "/cosmos.crypto.secp256k1.PubKey", | ||
| "key": "A58DXR/lXKVkIjLofXgST/OHi+pkOQbVIiOjnTy7Zoqo" | ||
| }, | ||
| "signature": "ecc6175e730917fb289d3a9f4e49a5630a44b42d972f481342f540e09def2ec5169780d85c4e060d52cc3ffb3d677745a4d56cd385760735bc6db0f1816713be", | ||
| "plain_text": "cosmos15uc89vnzufu5kuhhsxdkltt38zfx8vcyggzwfm" | ||
| } | ||
| ``` | ||
|
|
||
| Note that the `pub_key` field must be encoded using Protobuf and must be compatible with the public key types that are currently supported by Cosmos. You can see a list of such key types [here](https://github.com/cosmos/cosmos-sdk/tree/master/proto/cosmos/crypto). | ||
|
|
||
| ### 2. Create the link | ||
| Once you have created the two ownership proofs, you are now ready to create the link. This can be done in two ways: | ||
| 1. [Using IBC](#using-ibc) | ||
| 2. [Usign a chain message](#using-chain-message) | ||
|
|
||
| #### Using IBC | ||
| This is the way that you want to use when integrating the Desmos connection from your chain. | ||
| To implement the IBC capability of connecting an external account to a Desmos profile, the `x/profiles` module supports the following packet data type: | ||
|
|
||
| ```go | ||
| // LinkChainAccountPacketData defines the object that should be sent inside a | ||
| // MsgSendPacket when wanting to link an external chain to a Desmos profile | ||
| // using IBC | ||
| type LinkChainAccountPacketData struct { | ||
| // SourceAddress contains the details of the external chain address | ||
| SourceAddress *types.Any `protobuf:"bytes,1,opt,name=source_address,json=sourceAddress,proto3" json:"source_address,omitempty" yaml:"source_address"` | ||
| // SourceProof represents the proof of ownership of the source address | ||
| SourceProof Proof `protobuf:"bytes,2,opt,name=source_proof,json=sourceProof,proto3" json:"source_proof" yaml:"source_proof"` | ||
| // SourceChainConfig contains the details of the source chain | ||
| SourceChainConfig ChainConfig `protobuf:"bytes,3,opt,name=source_chain_config,json=sourceChainConfig,proto3" json:"source_chain_config" yaml:"source_chain_config"` | ||
| // DestinationAddress represents the Desmos address of the profile that should | ||
| // be linked with the external account | ||
| DestinationAddress string `protobuf:"bytes,4,opt,name=destination_address,json=destinationAddress,proto3" json:"destination_address,omitempty" yaml:"destination_address"` | ||
| // DestinationProof contains the proof of ownership of the DestinationAddress | ||
| DestinationProof Proof `protobuf:"bytes,5,opt,name=destination_proof,json=destinationProof,proto3" json:"destination_proof" yaml:"destination_proof"` | ||
| } | ||
| ``` | ||
|
|
||
| | Field | Type | Description | | ||
| | :----: | :-----: | :------ | | ||
| | `SourceAddress` | `AddressData` | Contains the details of the external address to be linked | | ||
| | `SourceProof` | `Proof` | Contains the data to verify the ownership of the external address | | ||
| | `SourceChainConfig` | `ChainConfig` | Contains the data of the external chain to be linked | | ||
| | `DestinationAddress` | `string` | Desmos address of the profile to which link the external address | | ||
| | `DestinationProof` | `Proof` | Proof of ownership of the Desmos profile | | ||
|
|
||
| Note that the `SourceAddress` field must one of the currently supported types: | ||
| - `Base58Address` if the external address is represented by the Base58 encoded public key of the account | ||
| - `Bech32Address` if the external address is Bech 32 encoded | ||
|
|
||
| The overall view is the following: | ||
|
|
||
| <img :src="$withBase('/assets/desmos-chain-link-ibc.png')"> | ||
|
|
||
| #### Using a chain message | ||
| In the case you don't want or cannot integrate IBC into your project, you can always rely on `MsgLinkChainAccount` to link an external profile to a Desmos profile: | ||
|
|
||
| ```go | ||
| // MsgLinkChainAccount represents a message to link an account to a profile. | ||
| type MsgLinkChainAccount struct { | ||
| // ChainAddress contains the details of the external chain address to be | ||
| // linked | ||
| ChainAddress *types.Any `protobuf:"bytes,1,opt,name=chain_address,json=chainAddress,proto3" json:"chain_address,omitempty" yaml:"source_address"` | ||
| // Proof contains the proof of ownership of the external chain address | ||
| Proof Proof `protobuf:"bytes,2,opt,name=proof,proto3" json:"proof" yaml:"source_proof"` | ||
| // ChainConfig contains the configuration of the external chain | ||
| ChainConfig ChainConfig `protobuf:"bytes,3,opt,name=chain_config,json=chainConfig,proto3" json:"chain_config" yaml:"source_chain_config"` | ||
| // Signer represents the Desmos address associated with the | ||
| // profile to which link the external account | ||
| Signer string `protobuf:"bytes,4,opt,name=signer,proto3" json:"signer,omitempty" yaml:"signer"` | ||
| } | ||
| ``` | ||
|
|
||
| | Field | Type | Description | | ||
| | :----: | :-----: | :------ | | ||
| | `ChainAddress` | `AddressData` | Contains the details of the external address to be linked | | ||
| | `Proof` | `Proof` | Contains the data to verify the ownership of the external address | | ||
| | `ChainConfig` | `ChainConfig` | Contains the data of the external chain to be linked | | ||
| | `Signer` | `string` | Desmos address of the profile to which link the external address, which must be the signer of the transaction | | ||
|
|
||
| ##### Using the CLI | ||
| Note that you can compose this message using the `desmos tx profiles link-chain` command. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.