feat: ADR-004: Application links expiration time #723
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| name: Benchmarks | ||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: | ||
| - master | ||
| env: | ||
| GO111MODULE: "on" | ||
| jobs: | ||
| Benchmarks: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Setup Go 🧰 | ||
| uses: actions/[email protected] | ||
| with: | ||
| go-version: 1.15 | ||
|
|
||
| - name: Checkout 🛎️ | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Go cache 💾 | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: ~/go/pkg | ||
| key: ${{ runner.os }}-go-pkg-${{ hashFiles('**/go.mod') }} | ||
|
|
||
| - name: Restore benchstat 🪛 | ||
| uses: actions/[email protected] | ||
| with: | ||
| path: ~/go/bin/benchstat | ||
| key: ${{ runner.os }}-benchstat | ||
|
|
||
| - name: Restore base benchmark result 📝 | ||
| uses: actions/cache@v2 | ||
| with: | ||
| path: | | ||
| bench-master.txt | ||
| # Using base sha for PR or new commit hash for master/main push in benchmark result key. | ||
| key: ${{ runner.os }}-bench-${{ (github.event.pull_request.base.sha != github.event.after) && github.event.pull_request.base.sha || github.event.after }} | ||
|
|
||
| - name: Benchmark 🧮 | ||
| run: REF_NAME=${GITHUB_REF##*/} make benchmark | ||
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,155 @@ | ||
| syntax = "proto3"; | ||
| package desmos.profiles.legacy.v200; | ||
|
|
||
| option go_package = "github.com/desmos-labs/desmos/v2/x/profiles/legacy/v200"; | ||
|
There was a problem hiding this comment. Why v200 but not v230? I think the legacy version should be the last version. There was a problem hiding this comment. because it was since v2.0.0 that the There was a problem hiding this comment. You are right, I thought it means the legacy There was a problem hiding this comment. @dadamu actually also your thought makes sense. @RiccardoM How should we handle legacy code? There was a problem hiding this comment. I'm actually looking into this problem inside #730 by reviewing where different things are located for legacy stuff and updates |
||
|
|
||
| import "gogoproto/gogo.proto"; | ||
| import "google/protobuf/timestamp.proto"; | ||
|
|
||
| // ApplicationLink contains the data of a link to a centralized application | ||
| message ApplicationLink { | ||
| option (gogoproto.goproto_getters) = false; | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // User to which the link is associated | ||
| string user = 1 [ (gogoproto.moretags) = "yaml:\"user\"" ]; | ||
|
|
||
| // Data contains the details of this specific link | ||
| Data data = 2 | ||
| [ (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"data\"" ]; | ||
|
|
||
| // State of the link | ||
| ApplicationLinkState state = 3 [ (gogoproto.moretags) = "yaml:\"state\"" ]; | ||
|
|
||
| // OracleRequest represents the request that has been made to the oracle | ||
| OracleRequest oracle_request = 4 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"oracle_request\"" | ||
| ]; | ||
|
|
||
| // Data coming from the result of the verification. | ||
| // Only available when the state is STATE_SUCCESS | ||
| Result result = 5 [ (gogoproto.moretags) = "yaml:\"result\"" ]; | ||
|
|
||
| // CreationTime represents the time in which the link was created | ||
| google.protobuf.Timestamp creation_time = 6 [ | ||
| (gogoproto.stdtime) = true, | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"creation_time\"" | ||
| ]; | ||
| } | ||
|
|
||
| // Data contains the data associated to a specific user of a | ||
| // generic centralized application | ||
| message Data { | ||
| option (gogoproto.goproto_getters) = false; | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // The application name (eg. Twitter, GitHub, etc) | ||
| string application = 1 [ (gogoproto.moretags) = "yaml:\"application\"" ]; | ||
| // Username on the application (eg. Twitter tag, GitHub profile, etc) | ||
| string username = 2 [ (gogoproto.moretags) = "yaml:\"username\"" ]; | ||
| } | ||
|
|
||
| // OracleRequest represents a generic oracle request used to | ||
| // verify the ownership of a centralized application account | ||
| message OracleRequest { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| option (gogoproto.equal) = true; | ||
|
|
||
| // ID is the ID of the request | ||
| uint64 id = 1 | ||
| [ (gogoproto.customname) = "ID", (gogoproto.moretags) = "yaml:\"id\"" ]; | ||
|
|
||
| // OracleScriptID is ID of an oracle script | ||
| uint64 oracle_script_id = 2 [ | ||
| (gogoproto.customname) = "OracleScriptID", | ||
| (gogoproto.moretags) = "yaml:\"oracle_script_id\"" | ||
| ]; | ||
|
|
||
| // CallData contains the data used to perform the oracle request | ||
| CallData call_data = 3 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"call_data\"" | ||
| ]; | ||
|
|
||
| // ClientID represents the ID of the client that has called the oracle script | ||
| string client_id = 4 [ | ||
| (gogoproto.customname) = "ClientID", | ||
| (gogoproto.moretags) = "yaml:\"client_id\"" | ||
| ]; | ||
|
|
||
| // CallData contains the data sent to a single oracle request in order to | ||
| // verify the ownership of a centralized application by a Desmos profile | ||
| message CallData { | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // The application for which the ownership should be verified | ||
| string application = 1 [ (gogoproto.moretags) = "yaml:\"application\"" ]; | ||
|
|
||
| // The hex encoded call data that should be used to verify the application | ||
| // account ownership | ||
| string call_data = 2 [ (gogoproto.moretags) = "yaml:\"call_data\"" ]; | ||
| } | ||
| } | ||
|
|
||
| // ApplicationLinkState defines if an application link is in the following | ||
| // states: STARTED, ERRORED, SUCCESSFUL, TIMED_OUT | ||
| enum ApplicationLinkState { | ||
| option (gogoproto.goproto_enum_prefix) = false; | ||
|
|
||
| // A link has just been initialized | ||
| APPLICATION_LINK_STATE_INITIALIZED_UNSPECIFIED = 0 | ||
| [ (gogoproto.enumvalue_customname) = "ApplicationLinkStateInitialized" ]; | ||
| // A link has just started being verified | ||
| APPLICATION_LINK_STATE_VERIFICATION_STARTED = 1 | ||
| [ (gogoproto.enumvalue_customname) = "AppLinkStateVerificationStarted" ]; | ||
| // A link has errored during the verification process | ||
| APPLICATION_LINK_STATE_VERIFICATION_ERROR = 2 | ||
| [ (gogoproto.enumvalue_customname) = "AppLinkStateVerificationError" ]; | ||
| // A link has being verified successfully | ||
| APPLICATION_LINK_STATE_VERIFICATION_SUCCESS = 3 | ||
| [ (gogoproto.enumvalue_customname) = "AppLinkStateVerificationSuccess" ]; | ||
| // A link has timed out while waiting for the verification | ||
| APPLICATION_LINK_STATE_TIMED_OUT = 4 | ||
| [ (gogoproto.enumvalue_customname) = "AppLinkStateVerificationTimedOut" ]; | ||
| } | ||
|
|
||
| // Result represents a verification result | ||
| message Result { | ||
| option (gogoproto.goproto_getters) = false; | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // sum is the oneof that specifies whether this represents a success or | ||
| // failure result | ||
| oneof sum { | ||
| // Success represents a successful verification | ||
| Success success = 1; | ||
|
|
||
| // Failed represents a failed verification | ||
| Failed failed = 2; | ||
| } | ||
|
|
||
| // Success is the result of an application link that has been successfully | ||
| // verified | ||
| message Success { | ||
| option (gogoproto.goproto_getters) = false; | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // Hex-encoded value that has be signed by the profile | ||
| string value = 1 [ (gogoproto.moretags) = "yaml:\"value\"" ]; | ||
| // Hex-encoded signature that has been produced by signing the value | ||
| string signature = 2 [ (gogoproto.moretags) = "yaml:\"signature\"" ]; | ||
| } | ||
|
|
||
| // Failed is the result of an application link that has not been verified | ||
| // successfully | ||
| message Failed { | ||
| option (gogoproto.goproto_getters) = false; | ||
| option (gogoproto.equal) = true; | ||
|
|
||
| // Error that is associated with the failure | ||
| string error = 1 [ (gogoproto.moretags) = "yaml:\"error\"" ]; | ||
| } | ||
| } | ||
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,117 @@ | ||
| syntax = "proto3"; | ||
| package desmos.profiles.legacy.v200; | ||
|
|
||
| import "gogoproto/gogo.proto"; | ||
| import "cosmos/base/v1beta1/coin.proto"; | ||
|
|
||
| option go_package = "github.com/desmos-labs/desmos/v2/x/profiles/legacy/v200"; | ||
|
|
||
| // Params contains the parameters for the profiles module | ||
| message Params { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| NicknameParams nickname = 1 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"nickname\"" | ||
| ]; | ||
|
|
||
| DTagParams dtag = 2 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"dtag\"", | ||
| (gogoproto.customname) = "DTag" | ||
| ]; | ||
|
|
||
| BioParams bio = 3 | ||
| [ (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"bio\"" ]; | ||
|
|
||
| OracleParams oracle = 4 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"oracle\"" | ||
| ]; | ||
| } | ||
|
|
||
| // NicknameParams defines the parameters related to the profiles nicknames | ||
| message NicknameParams { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| bytes min_length = 1 [ | ||
| (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"min_length\"" | ||
| ]; | ||
|
|
||
| bytes max_length = 2 [ | ||
| (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"max_length\"" | ||
| ]; | ||
| } | ||
|
|
||
| // DTagParams defines the parameters related to profile DTags | ||
| message DTagParams { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| string reg_ex = 1 [ (gogoproto.moretags) = "yaml:\"reg_ex\"" ]; | ||
|
|
||
| bytes min_length = 2 [ | ||
| (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"min_length\"", | ||
| (gogoproto.customname) = "MinLength" | ||
| ]; | ||
|
|
||
| bytes max_length = 3 [ | ||
| (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"max_length\"", | ||
| (gogoproto.customname) = "MaxLength" | ||
| ]; | ||
| } | ||
|
|
||
| // BioParams defines the parameters related to profile biography | ||
| message BioParams { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| bytes max_length = 3 [ | ||
| (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.moretags) = "yaml:\"max_length\"" | ||
| ]; | ||
| } | ||
|
|
||
| // OracleParams defines the parameters related to the oracle | ||
| // that will be used to verify the ownership of a centralized | ||
| // application account by a Desmos profile | ||
| message OracleParams { | ||
| option (gogoproto.goproto_getters) = false; | ||
|
|
||
| // ScriptID represents the ID of the oracle script to be called to verify the | ||
| // data | ||
| uint64 script_id = 1 [ | ||
| (gogoproto.customname) = "ScriptID", | ||
| (gogoproto.moretags) = "yaml:\"script_id\"" | ||
| ]; | ||
|
|
||
| // AskCount represents the number of oracles to which ask to verify the data | ||
| uint64 ask_count = 2 [ (gogoproto.moretags) = "yaml:\"ask_count\"" ]; | ||
|
|
||
| // MinCount represents the minimum count of oracles that should complete the | ||
| // verification successfully | ||
| uint64 min_count = 3 [ (gogoproto.moretags) = "yaml:\"min_count\"" ]; | ||
|
|
||
| // PrepareGas represents the amount of gas to be used during the preparation | ||
| // stage of the oracle script | ||
| uint64 prepare_gas = 4 [ (gogoproto.moretags) = "yaml:\"prepare_gas\"" ]; | ||
|
|
||
| // ExecuteGas represents the amount of gas to be used during the execution of | ||
| // the oracle script | ||
| uint64 execute_gas = 5 [ (gogoproto.moretags) = "yaml:\"execute_gas\"" ]; | ||
|
|
||
| // FeeAmount represents the amount of fees to be payed in order to execute the | ||
| // oracle script | ||
| repeated cosmos.base.v1beta1.Coin fee_amount = 6 [ | ||
| (gogoproto.nullable) = false, | ||
| (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins", | ||
| (gogoproto.moretags) = "yaml:\"fee_amount\"" | ||
| ]; | ||
| } |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This workflow uses benchstat a common go tool for comparing different benchmarks results.
In our case, the workflow will compare the
masterbranch benchmark's result with the ones of a new PR which is IMO very useful to let us understand if we have introduced a performance regression.In order to make this properly working, bench tests should be written when we consider it's the case.