Skip to content

Commit

Permalink
chore: added comments in proto files for storage cost and coin weights
Browse files Browse the repository at this point in the history
  • Loading branch information
troykessler committed May 14, 2024
1 parent 87eb63e commit 66a8651
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 11 deletions.
27 changes: 22 additions & 5 deletions docs/static/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions proto/kyve/bundles/v1beta1/params.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion proto/kyve/funders/v1beta1/params.proto
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions x/bundles/types/params.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion x/funders/types/params.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 66a8651

Please sign in to comment.