diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml index 0493e2dd..72ec91bf 100644 --- a/docs/static/openapi.yml +++ b/docs/static/openapi.yml @@ -31,15 +31,15 @@ paths: type: integer format: int64 description: >- - storage_provider_id is a unique id for each storage - provider like Arweave, Irys, Filecoin etc... + storage_provider_id is a unique identifier for each + storage provider, such as Arweave, Irys, Filecoin, + etc. cost: type: string - title: >- + description: >- cost is the amount in USD to store one byte on the - storage provider and should be kept up-to-date. - - The unit of this is USD/byte + storage provider. This value should be kept + up-to-date. title: StorageCost defines the cost for storage providers description: storage_costs ... network_fee: @@ -4430,15 +4430,15 @@ paths: type: integer format: int64 description: >- - storage_provider_id is a unique id for each storage - provider like Arweave, Irys, Filecoin etc... + storage_provider_id is a unique identifier for each + storage provider, such as Arweave, Irys, Filecoin, + etc. cost: type: string - title: >- + description: >- cost is the amount in USD to store one byte on the - storage provider and should be kept up-to-date. - - The unit of this is USD/byte + storage provider. This value should be kept + up-to-date. title: StorageCost defines the cost for storage providers description: storage_costs ... network_fee: @@ -4735,14 +4735,12 @@ paths: that needs to be funded per bundle coin_weight: type: string - title: >- + description: >- coin_weight is a factor used to sort funders after their funding amounts. - This should be the market price of that coin in - USD/coin and should be - - kept up-to-date + This should be the market price of the coin in + USD/coin. This value should be kept up-to-date. title: >- WhitelistCoinEntry is an object containing information around a coin which diff --git a/proto/kyve/bundles/v1beta1/params.proto b/proto/kyve/bundles/v1beta1/params.proto index 8591047d..6394563d 100644 --- a/proto/kyve/bundles/v1beta1/params.proto +++ b/proto/kyve/bundles/v1beta1/params.proto @@ -8,10 +8,9 @@ option go_package = "github.com/KYVENetwork/chain/x/bundles/types"; // StorageCost defines the cost for storage providers message StorageCost { - // storage_provider_id is a unique id for each storage provider like Arweave, Irys, Filecoin etc... + // storage_provider_id is a unique identifier for each storage provider, such as Arweave, Irys, Filecoin, etc. uint32 storage_provider_id = 1; - // cost is the amount in USD to store one byte on the storage provider and should be kept up-to-date. - // The unit of this is USD/byte + // cost is the amount in USD to store one byte on the storage provider. This value should be kept up-to-date. string cost = 2 [ (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec", (gogoproto.nullable) = false diff --git a/proto/kyve/funders/v1beta1/params.proto b/proto/kyve/funders/v1beta1/params.proto index 1523524b..2c114036 100644 --- a/proto/kyve/funders/v1beta1/params.proto +++ b/proto/kyve/funders/v1beta1/params.proto @@ -19,8 +19,7 @@ message WhitelistCoinEntry { // that needs to be funded per bundle uint64 min_funding_amount_per_bundle = 3; // coin_weight is a factor used to sort funders after their funding amounts. - // This should be the market price of that coin in USD/coin and should be - // kept up-to-date + // This should be the market price of the coin in USD/coin. This value should be kept up-to-date. string coin_weight = 4 [ (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec", (gogoproto.nullable) = false diff --git a/x/bundles/types/params.pb.go b/x/bundles/types/params.pb.go index 2e2fa1f7..0bbfba61 100644 --- a/x/bundles/types/params.pb.go +++ b/x/bundles/types/params.pb.go @@ -26,10 +26,9 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // StorageCost defines the cost for storage providers type StorageCost struct { - // storage_provider_id is a unique id for each storage provider like Arweave, Irys, Filecoin etc... + // storage_provider_id is a unique identifier for each storage provider, such as Arweave, Irys, Filecoin, etc. StorageProviderId uint32 `protobuf:"varint,1,opt,name=storage_provider_id,json=storageProviderId,proto3" json:"storage_provider_id,omitempty"` - // cost is the amount in USD to store one byte on the storage provider and should be kept up-to-date. - // The unit of this is USD/byte + // cost is the amount in USD to store one byte on the storage provider. This value should be kept up-to-date. Cost cosmossdk_io_math.LegacyDec `protobuf:"bytes,2,opt,name=cost,proto3,customtype=cosmossdk.io/math.LegacyDec" json:"cost"` } diff --git a/x/funders/types/params.pb.go b/x/funders/types/params.pb.go index 74e2c50e..4493ce71 100644 --- a/x/funders/types/params.pb.go +++ b/x/funders/types/params.pb.go @@ -37,8 +37,7 @@ type WhitelistCoinEntry struct { // that needs to be funded per bundle MinFundingAmountPerBundle uint64 `protobuf:"varint,3,opt,name=min_funding_amount_per_bundle,json=minFundingAmountPerBundle,proto3" json:"min_funding_amount_per_bundle,omitempty"` // coin_weight is a factor used to sort funders after their funding amounts. - // This should be the market price of that coin in USD/coin and should be - // kept up-to-date + // This should be the market price of the coin in USD/coin. This value should be kept up-to-date. CoinWeight cosmossdk_io_math.LegacyDec `protobuf:"bytes,4,opt,name=coin_weight,json=coinWeight,proto3,customtype=cosmossdk.io/math.LegacyDec" json:"coin_weight"` }