From 615ecbfb6e3fd4c73585f04eae1c02b5757459c0 Mon Sep 17 00:00:00 2001 From: kwt <4344285+kwtalley@users.noreply.github.com> Date: Wed, 27 Mar 2024 16:50:50 -0500 Subject: [PATCH] update README --- README.md | 121 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 63 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 374d43a0..72a353b8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ The following table shows provwasm version compatibility for smart contract deve | provwasm | wasmd | cosmos | provenance | module support | |----------|---------|---------|-------------------|---------------------------------------------------------------------| +| v2.2.0 | v0.30.X | v0.46.X | v1.18.X | attribute,exchange,hold,marker,metadata,msgfees,name,reward,trigger | | v2.1.0 | v0.30.X | v0.46.X | v1.17.X | attribute,exchange,hold,marker,metadata,msgfees,name,reward,trigger | | v2.0.0 | v0.30.X | v0.46.X | v1.15.X | attribute,marker,metadata,msgfees,name,reward | | v1.2.0 | v0.30.X | v0.46.X | v1.15.X | attribute,marker,metadata,msgfees,name | @@ -30,7 +31,8 @@ contracts for the Provenance Blockchain. ## IBC Once the tutorial has been completed and you are ready for a more advanced topic, checkout the -[IBC Overview](contracts/ibc/README.md) to learn more about IBC Smart Contracts and a guided tour of a multi-contract IBC project. +[IBC Overview](contracts/ibc/README.md) to learn more about IBC Smart Contracts and a guided tour of a multi-contract +IBC project. ## Contents @@ -39,76 +41,78 @@ In addition to the core CosmWasm functionality, the provenance bindings include ### Query Support Queries are available for these Provenance modules: + - [Attribute](./packages/provwasm-std/src/types/provenance/attribute) - - provenance.attribute.v1.QueryParamsRequest - - provenance.attribute.v1.QueryAttributeRequest - - provenance.attribute.v1.QueryAttributesRequest - - provenance.attribute.v1.QueryScanRequest + - provenance.attribute.v1.QueryParamsRequest + - provenance.attribute.v1.QueryAttributeRequest + - provenance.attribute.v1.QueryAttributesRequest + - provenance.attribute.v1.QueryScanRequest - [Exchange](./packages/provwasm-std/src/types/provenance/exchange) - - provenance.exchange.v1.QueryOrderFeeCalcRequest - - provenance.exchange.v1.QueryGetOrderRequest - - provenance.exchange.v1.QueryGetOrderByExternalIDRequest - - provenance.exchange.v1.QueryGetMarketOrdersRequest - - provenance.exchange.v1.QueryGetOwnerOrdersRequest - - provenance.exchange.v1.QueryGetAssetOrdersRequest - - provenance.exchange.v1.QueryGetAllOrdersRequest - - provenance.exchange.v1.QueryGetMarketRequest - - provenance.exchange.v1.QueryGetAllMarketsRequest - - provenance.exchange.v1.QueryParamsRequest - - provenance.exchange.v1.QueryValidateCreateMarketRequest - - provenance.exchange.v1.QueryValidateMarketRequest - - provenance.exchange.v1.QueryValidateManageFeesRequest + - provenance.exchange.v1.QueryOrderFeeCalcRequest + - provenance.exchange.v1.QueryGetOrderRequest + - provenance.exchange.v1.QueryGetOrderByExternalIDRequest + - provenance.exchange.v1.QueryGetMarketOrdersRequest + - provenance.exchange.v1.QueryGetOwnerOrdersRequest + - provenance.exchange.v1.QueryGetAssetOrdersRequest + - provenance.exchange.v1.QueryGetAllOrdersRequest + - provenance.exchange.v1.QueryGetMarketRequest + - provenance.exchange.v1.QueryGetAllMarketsRequest + - provenance.exchange.v1.QueryParamsRequest + - provenance.exchange.v1.QueryValidateCreateMarketRequest + - provenance.exchange.v1.QueryValidateMarketRequest + - provenance.exchange.v1.QueryValidateManageFeesRequest - [Hold](./packages/provwasm-std/src/types/provenance/hold) - - provenance.hold.v1.GetHoldsRequest - - provenance.hold.v1.GetAllHoldsRequest + - provenance.hold.v1.GetHoldsRequest + - provenance.hold.v1.GetAllHoldsRequest - [Marker](./packages/provwasm-std/src/types/provenance/marker) - - provenance.marker.v1.QueryParamsRequest - - provenance.marker.v1.QueryMarkerRequest - - provenance.marker.v1.QueryHoldingRequest - - provenance.marker.v1.QuerySupplyRequest - - provenance.marker.v1.QueryEscrowRequest - - provenance.marker.v1.QueryAccessRequest - - provenance.marker.v1.QueryDenomMetadataRequest + - provenance.marker.v1.QueryParamsRequest + - provenance.marker.v1.QueryMarkerRequest + - provenance.marker.v1.QueryHoldingRequest + - provenance.marker.v1.QuerySupplyRequest + - provenance.marker.v1.QueryEscrowRequest + - provenance.marker.v1.QueryAccessRequest + - provenance.marker.v1.QueryDenomMetadataRequest - [Metadata](./packages/provwasm-std/src/types/provenance/metadata) - - provenance.metadata.v1.QueryParamsRequest - - provenance.metadata.v1.ScopeRequest - - provenance.metadata.v1.SessionsRequest - - provenance.metadata.v1.RecordsRequest - - provenance.metadata.v1.OwnershipRequest - - provenance.metadata.v1.ValueOwnershipRequest - - provenance.metadata.v1.ScopeSpecificationRequest - - provenance.metadata.v1.ContractSpecificationRequest - - provenance.metadata.v1.RecordSpecificationsForContractSpecificationRequest - - provenance.metadata.v1.RecordSpecificationRequest - - provenance.metadata.v1.OSLocatorParamsRequest - - provenance.metadata.v1.OSLocatorRequest - - provenance.metadata.v1.OSLocatorsByURIRequest - - provenance.metadata.v1.OSLocatorsByScopeRequest - - The following has deserialization issues and will be `None` until fixed: - - `ContractSpecification.source` - - `InputSpecification.source` - - `Process.process_id` - - `SessionIdComponents.scope_identifier` + - provenance.metadata.v1.QueryParamsRequest + - provenance.metadata.v1.ScopeRequest + - provenance.metadata.v1.SessionsRequest + - provenance.metadata.v1.RecordsRequest + - provenance.metadata.v1.OwnershipRequest + - provenance.metadata.v1.ValueOwnershipRequest + - provenance.metadata.v1.ScopeSpecificationRequest + - provenance.metadata.v1.ContractSpecificationRequest + - provenance.metadata.v1.RecordSpecificationsForContractSpecificationRequest + - provenance.metadata.v1.RecordSpecificationRequest + - provenance.metadata.v1.OSLocatorParamsRequest + - provenance.metadata.v1.OSLocatorRequest + - provenance.metadata.v1.OSLocatorsByURIRequest + - provenance.metadata.v1.OSLocatorsByScopeRequest + - The following has deserialization issues and will be `None` until fixed: + - `ContractSpecification.source` + - `InputSpecification.source` + - `Process.process_id` + - `SessionIdComponents.scope_identifier` - [MsgFees](./packages/provwasm-std/src/types/provenance/msgfees) - - provenance.msgfees.v1.QueryParamsRequest + - provenance.msgfees.v1.QueryParamsRequest - [Name](./packages/provwasm-std/src/types/provenance/name) - - provenance.name.v1.QueryParamsRequest - - provenance.name.v1.QueryResolveRequest - - provenance.name.v1.QueryReverseLookupRequest + - provenance.name.v1.QueryParamsRequest + - provenance.name.v1.QueryResolveRequest + - provenance.name.v1.QueryReverseLookupRequest - [Reward](./packages/provwasm-std/src/types/provenance/reward) - - provenance.reward.v1.QueryRewardProgramByIDRequest - - provenance.reward.v1.QueryRewardProgramsRequest - - provenance.reward.v1.QueryClaimPeriodRewardDistributionsRequest - - provenance.reward.v1.QueryClaimPeriodRewardDistributionsByIDRequest - - provenance.reward.v1.QueryRewardDistributionsByAddressRequest - - The following has deserialization issues and will be `None` until fixed: - - `QualifyingAction.type` + - provenance.reward.v1.QueryRewardProgramByIDRequest + - provenance.reward.v1.QueryRewardProgramsRequest + - provenance.reward.v1.QueryClaimPeriodRewardDistributionsRequest + - provenance.reward.v1.QueryClaimPeriodRewardDistributionsByIDRequest + - provenance.reward.v1.QueryRewardDistributionsByAddressRequest + - The following has deserialization issues and will be `None` until fixed: + - `QualifyingAction.type` - [Trigger](./packages/provwasm-std/src/types/provenance/trigger) - - Query support unavailable until [#123](https://github.com/provenance-io/provwasm/issues/123) is resolved + - Query support unavailable until [#123](https://github.com/provenance-io/provwasm/issues/123) is resolved ### Message Encoding All messages are available for these Provenance modules: + - [Attribute](./packages/provwasm-std/src/types/provenance/attribute) - [Exchange](./packages/provwasm-std/src/types/provenance/exchange) - [Hold](./packages/provwasm-std/src/types/provenance/hold) @@ -120,4 +124,5 @@ All messages are available for these Provenance modules: - [Trigger](./packages/provwasm-std/src/types/provenance/trigger) ## Migration + Please see this [guide](./MIGRATION.md) for information regarding api changes and upgrading contracts \ No newline at end of file