Commit Graph

226 Commits

Author SHA1 Message Date
Robert Zaremba c061cc1c57
docs: ADR-43: Aligning on interoperability (#9709)
## Description

Following on:
+ NFT IBC [dependency](https://github.com/cosmos/cosmos-sdk/pull/9329#issuecomment-872415040) thread/issue
+ [interoperablity](https://github.com/cosmos/cosmos-sdk/pull/9329#pullrequestreview-704549373) with other NFT implementations 
+ x/bank interoperability [discussion](https://github.com/cosmos/cosmos-sdk/discussions/9065#discussioncomment-873206)

we need to be clear how the NFT token interoperability between modules and chains is achieved. 

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
2021-07-26 15:39:58 +00:00
Ryan Christoffersen 3439e5d025
docs: fix migrations directory (#9746)
Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-07-22 11:21:59 +02:00
vincent 8891fa26e4
Merge branch 'master' into hulatown/adr-043-nft 2021-07-03 21:13:06 +08:00
Haifeng Xi 013e9caeb4
incorporate feedbacks from aaron, shaun, billy... 2021-07-03 00:40:44 +08:00
Haifeng Xi c98ce3abdb
fix code formatting 2021-07-01 16:15:59 +08:00
Haifeng Xi 843f79c5ae
incorporate Billy's feedback
And make the spec better aligned with ERC721, ERC721Metadata and ERC721Enumerable
2021-07-01 16:13:29 +08:00
Robert Zaremba 856cc5b096
docs: use RFC 2119 keywords (#9532)
## Description

Recently when discussing NFT standard we stumbled upon the proper use of keywards such as SHOULD, MAY etc ...
Let's add them to our guidelines. 

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct `docs:` prefix in the PR title
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md)
- [x] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [x] confirmed the correct `docs:` prefix in the PR title
- [ ] confirmed all author checklist items have been addressed 
- [x] confirmed that this PR only changes documentation
- [x] reviewed content for consistency
- [x] reviewed content for thoroughness
- [x] reviewed content for spelling and grammar
- [ ] tested instructions (if applicable)
2021-06-22 00:04:55 +00:00
Haifeng Xi 0092c538f9
incorporate feedbacks from 6/18 call
1. MsgSend is really not necessary
2. add two restricted flags in the metadata
3. add MsgEdit
2021-06-21 17:35:31 +08:00
chengwenxi 5152044d25 minor fix 2021-06-18 18:25:04 +08:00
Haifeng Xi c8642f4c23
rename denom as type -- second batch
To avoid confusion with coin denom in `x/bank` metadata
2021-06-18 17:34:51 +08:00
Haifeng Xi 0dbfbdbda3
rename denom as type -- first batch
To avoid confusion with coin denom in `x/bank` metadata
2021-06-18 17:07:14 +08:00
chengwenxi 9d60dfdfeb fix note 2021-06-18 11:43:05 +08:00
chengwenxi b641f4caba refactor nft to base nft 2021-06-18 09:59:56 +08:00
chengwenxi 899e2a27bc store nft in bank module 2021-06-15 19:43:51 +08:00
Federico Kunze f1e81fa1db
Merge branch 'master' into hulatown/adr-043-nft 2021-06-14 11:04:39 -04:00
Robert Zaremba 7bca49e2d2
refactor(client): add client/Context.Codec and deprecate JSONCodec (#9498)
* chore(types): add sdk.Context.Codec and deprecate JSONCodec

* Use clientContext.Codec rather than JSONCodec everywhere

* update tests to use clientContext.Codec

* added a note that EncodingConfig.Marshaler will be renamed to Codec

* update changelog

* fix tests to use clientCtx.WithCodec instead of WithJSONCodec

* fix genutil build

* Update simapp/params/encoding.go

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
2021-06-11 11:49:39 +00:00
Haifeng Xi 5e2f4c3234
Merge branch 'master' into hulatown/adr-043-nft 2021-06-10 22:03:47 +08:00
chengwenxi 51df2170f2 apply comments 2021-06-10 19:21:50 +08:00
Haifeng Xi 745154aec0
docs: Fix ADR 030 reference link (#9487) 2021-06-10 12:46:14 +02:00
chengwenxi e39f05907d apply comments 2021-05-31 14:42:56 +08:00
vincent 835b58183c
Merge branch 'master' into hulatown/adr-043-nft 2021-05-28 09:45:55 +08:00
Ryan Christoffersen cb66c99eab
chore: add markdownlint to lint commands (#9353)
* add markdownlint config

* update make lint commands

* update markdownlint config

* run make lint-fix

* fix empty link

* resuse docker container

* run lint-fix

* do not echo commands

Co-authored-by: ryanchrypto <12519942+ryanchrypto@users.noreply.github.com>
2021-05-27 15:31:04 +00:00
Federico Kunze b5a36b3752
Update docs/architecture/adr-043-nft-module.md 2021-05-27 09:53:24 -04:00
Shahan Khatchadourian 1f3ec2ae5f
Adding clarity to ADR 043 nft data field (#9388)
* Added clarity to data field description

* Update docs/architecture/adr-043-nft-module.md

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>
2021-05-26 10:22:54 +08:00
chengwenxi 1571a5911b fix typo 2021-05-25 14:42:14 +08:00
chengwenxi 435c219999 more description 2021-05-25 14:34:34 +08:00
vincent 13cc5a283c
rename NFT to BaseNFT
Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
2021-05-18 17:42:15 +08:00
vincent 09c17a6f31
fix description
Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
2021-05-18 09:39:55 +08:00
vincent 96f9e114fa
fix typo
Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
2021-05-18 09:38:46 +08:00
vincent be60788e23
Merge branch 'master' into hulatown/adr-043-nft 2021-05-17 18:10:52 +08:00
chengwenxi af689350c7 resolve #9284 comments 2021-05-17 18:00:42 +08:00
Andrea Giacobino 25ecec6c15
rosetta: upgrade to newest version (#9314)
* feat:  update rosetta sdk to v0.6.10 

embed from v1.0.0 release branch of the library: https://github.com/tendermint/cosmos-rosetta-gateway/tree/release/v1.0.0

closes:
https://github.com/cosmos/cosmos-sdk/issues/9300

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
2021-05-15 00:18:59 +02:00
chengwenxi bdb6005015 Merge branch 'shahan/adr-043-nft' 2021-05-14 12:05:39 +08:00
Robert Zaremba f1de92fef0
ADR-040: Storage and SMT State Commitments (#8430)
* ADR-040: Storage and SMT State Commitments

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>

* Added more details for snapshotting and pruning.

* updated links and references

* add blockchains which already use SMT

* reorganize versioning and pruning

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Tomasz Zdybał <tomek@zdybal.lap.pl>

* Update docs/architecture/adr-040-storage-and-smt-state-commitments.md

Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>

* adding a paragraph about state management

* adr-40: update 'accessing old state' section

* update based on all recent discussions and validations

* adding more explanation about KV interface

* Apply suggestions from code review

Co-authored-by: Tomasz Zdybał <tomek@zdybal.lap.pl>
Co-authored-by: Marko <marbar3778@yahoo.com>

* Apply suggestions from code review

Co-authored-by: Marko <marbar3778@yahoo.com>

* review comments

* adding paragraph about commiting to an object without storying it

* review updates

* Apply suggestions from code review

Co-authored-by: Roy Crihfield <30845198+roysc@users.noreply.github.com>

* review udpates

* adding clarification

Co-authored-by: Ismail Khoffi <Ismail.Khoffi@gmail.com>
Co-authored-by: Tomasz Zdybał <tomek@zdybal.lap.pl>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Roy Crihfield <30845198+roysc@users.noreply.github.com>
2021-05-11 16:45:29 -04:00
Shahan Khatchadourian 6c923d39be Adding specifications to NFT fields and clarity on usage. 2021-05-10 15:35:30 -04:00
Shahan Khatchadourian 38762621a3
Merge branch 'master' into master 2021-05-10 11:50:18 -07:00
Marie Gauthier 6425825cac
ADR-042: Group module (#9089)
* Add ADR-042

* Fix link

* Small improvements

* Update link

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

* Update docs/architecture/adr-042-group-module.md

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

* Update docs/architecture/adr-042-group-module.md

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Update docs/architecture/adr-042-group-module.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Move orm to specific section

* Update docs/architecture/adr-042-group-module.md

* Update naming

* Add concrete use cases

* Rework ### Proposal

* Rework Vote, Exec and implementation sections

* Update to account for removal of ServiceMsg

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-05-10 12:53:47 +00:00
HackMD 8701e97c65 Add ADR-043 BaseNFT Module 2021-05-08 07:00:58 +00:00
Robert Zaremba 1986104ef4
ADR-30 (authz) update based on authz audit (#9270)
* ADR-30 (authz) update based on authz audit

* changelog and comment update

* fix linter issue

* Apply suggestions from code review

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

* Update MsgGrant to reuse the Grant type

* Update docs/architecture/adr-030-authz-module.md

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Aaron Craelius <aaron@regen.network>
2021-05-07 19:38:43 +00:00
MD Aleem 1e1c812de2
x/feegrant remove height base expiration (#9206)
* remove height from proto files

* remove PrepareForExport

* fix basic fee

* fix periodic fee

* fix errors

* fix error

* fix errors

* add tests

* review changes

* fix errors

* fix tests

* fix lint error

* Update x/feegrant/types/basic_fee.go

Co-authored-by: technicallyty <48813565+technicallyty@users.noreply.github.com>

* fix errors

* fix keeper tests

* Update x/feegrant/keeper/keeper_test.go

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

* review changes

* review changes

* fix tests

* run make proto-gen

* fix errors

* Update x/feegrant/keeper/keeper_test.go

Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>

* Update x/feegrant/keeper/keeper_test.go

* update ADR

* add test

* review changes

* review changes

Co-authored-by: technicallyty <48813565+technicallyty@users.noreply.github.com>
Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
Co-authored-by: atheeshp <59333759+atheeshp@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-05-05 16:29:22 +00:00
Amaury d19791be89
Rename clientCtx.JSONMarshaler to JSONCodec (#9251)
* Rename clientCtx.JSONMarshaler to JSONCodec

* change md files

* Fix lint
2021-05-03 14:45:47 +00:00
Amaury dfe3e7a8d7
Remove ServiceMsgs from ADR-031 (#9139)
* wip

* wip

* wip

* wip on refactoring adr 031 type URLs

* Fix msg_service_router

* Fix gov client queries

* Fix some modules tests

* Remove all instances of "*.Msg/*"

* Uncomment code

* Remove commented code

* // simulation.NewWeightedOperation(

* Fix CopyTx

* Fix more tests

* Fix x/gov test

* proto.MessageName->sdk.MsgName

* Fix authz tests

* Use MsgRoute in feegrant and staking/authz

* Fix more tests

* Fix sims?

* Add norace tag

* Add CL

* rebuild rosetta api test data

* Update ADR

* Rename MsgRoute -> MsgTypeURL

* Fix codec registration

* Remove sdk.GetLegacySignBytes

* Update types/tx_msg.go

* Update x/authz/simulation/operations.go

* Move LegacyMsg to legacytx

* Update CHANGELOG.md

Co-authored-by: Aaron Craelius <aaron@regen.network>

* Remove NewAnyWithCustomTypeURL

* Keep support for ServiceMsgs

* Fix TxBody UnpackInterfaces

* Fix test

* Address review

* Remove support for ServiceMsg typeURLs

* Fix lint

* Update changelog

* Fix tests

* Use sdk.MsgTypeURL everywhere

* Fix tests

* Fix rosetta, run make rosetta-data

* Fix rosetta thanks to froydi

* Address reviews

* Fix test

* Remove stray log

* Update CL

Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Aaron Craelius <aaron@regen.network>
2021-04-30 11:00:47 +00:00
Robert Zaremba be4a965599
codec: Rename codec and marshaler interfaces (#9226)
* codec: Rename codec and marshaler interfaces, ref: 8413

* codec: remove BinaryBare

* changelog update

* Update comments and documentation

* adding doc string comments

* Update CHANGELOG.md

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

* Update codec/codec.go

Co-authored-by: Marko <marbar3778@yahoo.com>

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-29 10:46:22 +00:00
colin axnér 556134c89b
remove IBC ADRs (#9191)
* remove IBC ADRs

* remove ADR references from README

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-04-26 11:05:24 +00:00
Frojdi Dymylja 83645e0360
ADR036: Arbitrary signature (#7727)
* add: arbitrary signature adr draft

* fix: adr number

* change: adjust scope, address feedback

* fix: missing sentence

* change: address wording

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* change: address wording and formatting

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* change: address formatting

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* change: message name, address modal verbs changes

* change: document how MsgSignData should be used

* change: address wording

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* add: how verification works

* Update docs/architecture/adr-036-arbitrary-signature.md

* Update docs/architecture/adr-036-arbitrary-signature.md

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

* Apply suggestions from code review

* Update docs/architecture/adr-036-arbitrary-signature.md

* add: expand further discussion items

* fix: wording

* add: context references

* change: split offchain tx specific from MsgSignData

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
Co-authored-by: Marko <marbar3778@yahoo.com>
2021-04-19 16:18:48 +00:00
Robert Zaremba e43edc4749
ADR-28 derive address functions (#9088)
* update Derive functions

* update adr-028

* changelog update

* Apply suggestions from code review

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>

* review updates

* remove DeriveMulti and rollback some changes in CHANGELOG

* add noop error check

Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com>
2021-04-15 21:32:45 +00:00
Ian Norden feed37dc56
ADR-038 Part 1: WriteListener, listen.KVStore, MultiStore and KVStore updates (#8551)
* StoreKVPair protobuf message definition and generated go types

* store WriteListener

* update MultiStore, CacheWrap, CacheWrapper interfaces

* adjust KVStores to fit new CacheWrapper interface

* new ListenKVStore

* adjust multistores to fit new MultiStore interface and enable wrapping returned KVStores with the new ListenKVStore

* typo fixes in adr

* ListenKV Store test

* update server mock KVStore and MultiStore

* multistore unit test; fix multistore constructor

* update changelog

* fix bug identified in CI

* improve codecov, minor fixes/adjustments

* review fixes

* review updates; flip set to delete in KVStorePair, updated proto-docs from running 'make proto-gen'
2021-03-30 16:13:51 -04:00
Robert Zaremba 823620c231
docs: update bech32 account docs (#9006)
* docs: update bech32 account docs

* docs: update other places for bech32 and pubkeys

Co-authored-by: Marko <marbar3778@yahoo.com>
2021-03-29 11:22:30 +00:00
Tim Lind 5a142db6f0
Fix broken ICS links on ADR001 (#8971)
Docs have moved to IBC repo

Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
2021-03-25 07:20:28 +00:00
Tim Lind 5b10af48c6
Fix broken relative link in ADR033 (#8977)
* Fix broken relative link in ADR033

Replaced with absolute URL

* Update docs/architecture/adr-033-protobuf-inter-module-comm.md

Co-authored-by: Marko <marko@baricevic.me>

Co-authored-by: Marko <marbar3778@yahoo.com>
Co-authored-by: Alessio Treglia <quadrispro@ubuntu.com>
Co-authored-by: Marko <marko@baricevic.me>
Co-authored-by: Alessio Treglia <alessio@tendermint.com>
Co-authored-by: SaReN <sahithnarahari@gmail.com>
2021-03-25 07:12:42 +00:00