-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1234 from Sifchain/featue/add-claim
Feature/add claim
- Loading branch information
Showing
37 changed files
with
1,268 additions
and
124 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "Input": [ | ||
| { | ||
| "address": "sif1syavy2npfyt9tcncdtsdzf7kny9lh777yqc2nd", | ||
| "coins": [ | ||
| { | ||
| "denom": "rowan", | ||
| "amount": "20000000000000000000" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
|
|
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,22 @@ | ||
| { | ||
| "Output": [ | ||
| { | ||
| "address": "sif1l7hypmqk2yc334vc6vmdwzp5sdefygj2ad93p5", | ||
| "coins": [ | ||
| { | ||
| "denom": "rowan", | ||
| "amount": "10000000000000000000" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "address": "sif1syavy2npfyt9tcncdtsdzf7kny9lh777yqc2nd", | ||
| "coins": [ | ||
| { | ||
| "denom": "rowan", | ||
| "amount": "10000000000000000000" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
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,32 @@ | ||
|
|
||
|
|
||
|
|
||
| # Multisig Key - It is a key composed of two or more keys (N) , with a signing threshold (K) ,such that the transaction needs K out of N votes to go through. | ||
| sifnodecli tx dispensation claim ValidatorSubsidy --from akasha --keyring-backend test --yes | ||
| sifnodecli tx dispensation claim ValidatorSubsidy --from sif --keyring-backend test --yes | ||
| # create airdrop | ||
| # mkey = multisig key | ||
| # ar1 = name for airdrop , needs to be unique for every airdrop . If not the tx gets rejected | ||
| # input.json list of funding addresses - Input address must be part of the multisig key | ||
| # output.json list of airdrop receivers. | ||
| sleep 8 | ||
| sifnodecli q dispensation claims-by-type ValidatorSubsidy | ||
| sleep 8 | ||
| sifnodecli tx dispensation create mkey ar1 ValidatorSubsidy input.json output.json --gas 200064128 --generate-only >> offlinetx.json | ||
| # First user signs | ||
| sifnodecli tx sign --multisig $(sifnodecli keys show mkey -a) --from $(sifnodecli keys show sif -a) offlinetx.json >> sig1.json | ||
| # Second user signs | ||
| sifnodecli tx sign --multisig $(sifnodecli keys show mkey -a) --from $(sifnodecli keys show akasha -a) offlinetx.json >> sig2.json | ||
| # Multisign created from the above signatures | ||
| sifnodecli tx multisign offlinetx.json mkey sig1.json sig2.json >> signedtx.json | ||
| # transaction broadcast , distribution happens | ||
| sifnodecli tx broadcast signedtx.json | ||
| sleep 8 | ||
| sifnodecli q dispensation distributions-all | ||
| sifnodecli q dispensation records-by-name-all ar1 >> all.json | ||
| sifnodecli q dispensation records-by-name-pending ar1 >> pending.json | ||
| sifnodecli q dispensation records-by-name-completed ar1 >> completed.json | ||
| sifnodecli q dispensation records-by-addr sif1cp23ye3h49nl5ty35vewrtvsgwnuczt03jwg00 | ||
| rm -rf offlinetx.json sig1.json sig2.json signedtx.json | ||
|
|
||
|
|
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,158 @@ | ||
| # Claims Flow | ||
|
|
||
| ### Users will create claims throughout the week . | ||
| The wallet can use | ||
| ```/dispensation/createClaim``` | ||
| This expects the following input | ||
| ```go | ||
| package main | ||
|
|
||
| type DistributionType int64 | ||
| const Airdrop DistributionType = 1 | ||
| const LiquidityMining DistributionType = 2 | ||
| const ValidatorSubsidy DistributionType = 3 | ||
|
|
||
| type CreateClaimReq struct { | ||
| BaseReq rest.BaseReq `json:"base_req"` | ||
| Signer string `json:"signer"` | ||
| ClaimType DistributionType `json:"claim_type"` | ||
| } | ||
| ``` | ||
|
|
||
| ### On friday we get a list of all the claims (After Cut-off time) for the week. Any claims submitted after cutoff would be processed next week. | ||
| (This step can be done through CLI on friday , or process events throughout the week . Processing events would be the preferred approach) | ||
| This query through the cli would look like | ||
| ```shell | ||
| sifnodecli q dispensation claims-by-type ValidatorSubsidy --chain-id sifchain --node tcp://rpc.sifchain.finance:80 | ||
| ``` | ||
| Which returns | ||
| ```json | ||
| { | ||
| "claims": [ | ||
| { | ||
| "user_address": "sif1l7hypmqk2yc334vc6vmdwzp5sdefygj2ad93p5", | ||
| "user_claim_type": "3", | ||
| "user_claim_time": "2021-05-02T02:43:10.593125Z", | ||
| "locked": false | ||
| }, | ||
| { | ||
| "user_address": "sif1syavy2npfyt9tcncdtsdzf7kny9lh777yqc2nd", | ||
| "user_claim_type": "3", | ||
| "user_claim_time": "2021-05-02T02:43:10.593125Z", | ||
| "locked": false | ||
| } | ||
| ], | ||
| "height": "7" | ||
| } | ||
|
|
||
| ``` | ||
| We can also parse events instead of the using this query . This event would be in the same block as the one which has the dispensation/createClaim request | ||
| ```json | ||
| {"type": "claim_created", | ||
| "attributes": [ | ||
| { | ||
| "key": "Y2xhaW1fY3JlYXRvcg==", | ||
| "value": "c2lmMWw3aHlwbXFrMnljMzM0dmM2dm1kd3pwNXNkZWZ5Z2oyYWQ5M3A1" | ||
| }, | ||
| { | ||
| "key": "Y2xhaW1fdHlwZQ==", | ||
| "value": "VmFsaWRhdG9yU3Vic2lkeQ==" | ||
| }, | ||
| { | ||
| "key": "dXNlckNsYWltX2NyZWF0aW9uVGltZQ==", | ||
| "value": "MjAyMS0wNS0wMlQwMjo0MzoxMC41OTMxMjVa" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| After parsing should become | ||
| ```json | ||
| {"type": "claim_created", | ||
| "attributes": [ | ||
| { | ||
| "key": "claim_creator", | ||
| "value": "sif1l7hypmqk2yc334vc6vmdwzp5sdefygj2ad93p5" | ||
| }, | ||
| { | ||
| "key": "claim_type", | ||
| "value": "ValidatorSubsidy" | ||
| }, | ||
| { | ||
| "key": "userClaim_creationTime", | ||
| "value": "2021-05-02T02:43:10.593125Z" | ||
| } | ||
| ] | ||
| } | ||
|
|
||
| ``` | ||
|
|
||
| ### This list obtained above is run through the parsing API(Niko) , which should create a file like below | ||
| ```json | ||
| { | ||
| "Output": [ | ||
| { | ||
| "address": "sif1l7hypmqk2yc334vc6vmdwzp5sdefygj2ad93p5", | ||
| "coins": [ | ||
| { | ||
| "denom": "rowan", | ||
| "amount": "10000000000000000000" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "address": "sif1syavy2npfyt9tcncdtsdzf7kny9lh777yqc2nd", | ||
| "coins": [ | ||
| { | ||
| "denom": "rowan", | ||
| "amount": "10000000000000000000" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ### This file is then used to create a distribution | ||
| ```shell | ||
| sifnodecli tx dispensation create mkey ar1 ValidatorSubsidy input.json output.json --gas 200064128 --generate-only >> offlinetx.json | ||
| # First user signs | ||
| sifnodecli tx sign --multisig $(sifnodecli keys show mkey -a) --from $(sifnodecli keys show sif -a) offlinetx.json >> sig1.json | ||
| # Second user signs | ||
| sifnodecli tx sign --multisig $(sifnodecli keys show mkey -a) --from $(sifnodecli keys show akasha -a) offlinetx.json >> sig2.json | ||
| # Multisign created from the above signatures | ||
| sifnodecli tx multisign offlinetx.json mkey sig1.json sig2.json >> signedtx.json | ||
| # transaction broadcast , distribution happens | ||
| sifnodecli tx broadcast signedtx.json | ||
| ``` | ||
| ### Post Dispensation | ||
| - Suppose we do the dispensation at height X , The block results should contain this event | ||
| ```json | ||
| { | ||
| "type": "distribution_started", | ||
| "attributes": [ | ||
| { | ||
| "key": "module_account", | ||
| "value": "sif1zvwfuvy3nh949rn68haw78rg8jxjevgm2c820c" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
| - This event signifies that the distribution started , and transfers should begin at height X+1 . The transfer events can be used as confirmation to reset account multipliers. | ||
| The sender address for the transfers should be the module account in the distribution_started event . | ||
| ```json | ||
| [ | ||
| { | ||
| "key": "recipient", | ||
| "value": "sif1l7hypmqk2yc334vc6vmdwzp5sdefygj2ad93p5" | ||
| }, | ||
| { | ||
| "key": "sender", | ||
| "value": "sif1zvwfuvy3nh949rn68haw78rg8jxjevgm2c820c" | ||
| }, | ||
| { | ||
| "key": "amount", | ||
| "value": "10000000000000000000rowan" | ||
| } | ||
| ] | ||
|
|
||
| ``` |
Oops, something went wrong.