diff --git a/docs/static/openapi.yml b/docs/static/openapi.yml index 0bb94e32..0493e2dd 100644 --- a/docs/static/openapi.yml +++ b/docs/static/openapi.yml @@ -30,10 +30,16 @@ paths: storage_provider_id: type: integer format: int64 - description: storage_provider_id ... + description: >- + storage_provider_id is a unique id for each storage + provider like Arweave, Irys, Filecoin etc... cost: type: string - description: cost ... + title: >- + 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 title: StorageCost defines the cost for storage providers description: storage_costs ... network_fee: @@ -4423,10 +4429,16 @@ paths: storage_provider_id: type: integer format: int64 - description: storage_provider_id ... + description: >- + storage_provider_id is a unique id for each storage + provider like Arweave, Irys, Filecoin etc... cost: type: string - description: cost ... + title: >- + 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 title: StorageCost defines the cost for storage providers description: storage_costs ... network_fee: @@ -4725,7 +4737,12 @@ paths: type: string title: >- coin_weight is a factor used to sort funders after - their funding amounts + their funding amounts. + + This should be the market price of that coin in + USD/coin and 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 97e4bae3..8591047d 100644 --- a/proto/kyve/bundles/v1beta1/params.proto +++ b/proto/kyve/bundles/v1beta1/params.proto @@ -8,9 +8,10 @@ option go_package = "github.com/KYVENetwork/chain/x/bundles/types"; // StorageCost defines the cost for storage providers message StorageCost { - // storage_provider_id ... + // storage_provider_id is a unique id for each storage provider like Arweave, Irys, Filecoin etc... uint32 storage_provider_id = 1; - // cost ... + // 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 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 77d1ebf8..1523524b 100644 --- a/proto/kyve/funders/v1beta1/params.proto +++ b/proto/kyve/funders/v1beta1/params.proto @@ -18,7 +18,9 @@ message WhitelistCoinEntry { // min_funding_amount_per_bundle is the minimum required amount of this denom // 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 + // 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 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 0bc8581c..2e2fa1f7 100644 --- a/x/bundles/types/params.pb.go +++ b/x/bundles/types/params.pb.go @@ -26,9 +26,10 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // StorageCost defines the cost for storage providers type StorageCost struct { - // storage_provider_id ... + // storage_provider_id is a unique id for each storage provider like Arweave, Irys, Filecoin etc... StorageProviderId uint32 `protobuf:"varint,1,opt,name=storage_provider_id,json=storageProviderId,proto3" json:"storage_provider_id,omitempty"` - // cost ... + // 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 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 11bb9fc4..74e2c50e 100644 --- a/x/funders/types/params.pb.go +++ b/x/funders/types/params.pb.go @@ -36,7 +36,9 @@ type WhitelistCoinEntry struct { // min_funding_amount_per_bundle is the minimum required amount of this denom // 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 + // 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 CoinWeight cosmossdk_io_math.LegacyDec `protobuf:"bytes,4,opt,name=coin_weight,json=coinWeight,proto3,customtype=cosmossdk.io/math.LegacyDec" json:"coin_weight"` }