From d296716a6884d3b7a973a35745dac9926d67d2c7 Mon Sep 17 00:00:00 2001 From: Joao Luna Date: Tue, 17 Dec 2024 20:13:22 +0000 Subject: [PATCH 1/4] docs: add deployment v1 docs --- go/inventory/v1/cluster.pb.go | 2 +- go/node/deployment/v1/authz.pb.go | 2 +- go/node/deployment/v1/deployment.pb.go | 12 ++++++-- go/node/deployment/v1/msg.pb.go | 16 ++++++---- proto/node/akash/deployment/v1/authz.proto | 2 +- .../node/akash/deployment/v1/deployment.proto | 29 ++++++++++++++----- proto/node/akash/deployment/v1/event.proto | 26 +++++++++++++---- proto/node/akash/deployment/v1/group.proto | 16 +++++++++- proto/node/akash/deployment/v1/msg.proto | 10 +++++-- .../provider/akash/inventory/v1/cluster.proto | 2 +- proto/provider/buf.yaml | 3 +- 11 files changed, 92 insertions(+), 28 deletions(-) diff --git a/go/inventory/v1/cluster.pb.go b/go/inventory/v1/cluster.pb.go index c0eaeb19..eadbf447 100644 --- a/go/inventory/v1/cluster.pb.go +++ b/go/inventory/v1/cluster.pb.go @@ -23,7 +23,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Cluster reports inventory across entire cluster +// Cluster reports inventory across entire cluster. type Cluster struct { Nodes Nodes `protobuf:"bytes,1,rep,name=nodes,proto3,castrepeated=Nodes" json:"nodes" yaml:"nodes"` Storage ClusterStorage `protobuf:"bytes,2,rep,name=storage,proto3,castrepeated=ClusterStorage" json:"storage" yaml:"storage"` diff --git a/go/node/deployment/v1/authz.pb.go b/go/node/deployment/v1/authz.pb.go index e0e42038..a828a26c 100644 --- a/go/node/deployment/v1/authz.pb.go +++ b/go/node/deployment/v1/authz.pb.go @@ -25,7 +25,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// DepositDeploymentAuthorization allows the grantee to deposit up to spend_limit coins from +// DepositAuthorization allows the grantee to deposit up to spend_limit coins from // the granter's account for a deployment. type DepositAuthorization struct { // SpendLimit is the amount the grantee is authorized to spend from the granter's account for diff --git a/go/node/deployment/v1/deployment.pb.go b/go/node/deployment/v1/deployment.pb.go index b668ac26..f387ed79 100644 --- a/go/node/deployment/v1/deployment.pb.go +++ b/go/node/deployment/v1/deployment.pb.go @@ -56,10 +56,18 @@ func (Deployment_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_289f09354ec3dad5, []int{1, 0} } -// DeploymentID stores owner and sequence number +// DeploymentID represents a unique identifier for a specific deployment on the network. +// It is composed of two fields: an owner address and a sequence number (dseq). type DeploymentID struct { + // owner is the account address of the user who owns the deployment. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` } func (m *DeploymentID) Reset() { *m = DeploymentID{} } diff --git a/go/node/deployment/v1/msg.pb.go b/go/node/deployment/v1/msg.pb.go index 8c29710b..a24a6ed2 100644 --- a/go/node/deployment/v1/msg.pb.go +++ b/go/node/deployment/v1/msg.pb.go @@ -25,11 +25,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgDepositDeployment deposits more funds into the deposit account +// MsgDepositDeployment represents a message to deposit funds into an existing deployment +// on the blockchain. This is part of the interaction mechanism for managing +// deployment-related resources. type MsgDepositDeployment struct { - ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - Amount types.Coin `protobuf:"bytes,2,opt,name=amount,proto3" json:"amount" yaml:"amount"` - // Depositor pays for the deposit + // id is the unique identifier of the deployment. + ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // amount defines the funds to deposit into the deployment. + // It is specified as a coin amount (denomination and value). + Amount types.Coin `protobuf:"bytes,2,opt,name=amount,proto3" json:"amount" yaml:"amount"` + // depositor is the address of the account depositing funds into the deployment. + // This must be a valid blockchain account address. Depositor string `protobuf:"bytes,3,opt,name=depositor,proto3" json:"depositor" yaml:"depositor"` } @@ -87,7 +93,7 @@ func (m *MsgDepositDeployment) GetDepositor() string { return "" } -// MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. +// MsgDepositDeploymentResponse defines response type for the MsgDepositDeployment. type MsgDepositDeploymentResponse struct { } diff --git a/proto/node/akash/deployment/v1/authz.proto b/proto/node/akash/deployment/v1/authz.proto index c7529c67..34329c31 100644 --- a/proto/node/akash/deployment/v1/authz.proto +++ b/proto/node/akash/deployment/v1/authz.proto @@ -7,7 +7,7 @@ import "cosmos/base/v1beta1/coin.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1"; -// DepositDeploymentAuthorization allows the grantee to deposit up to spend_limit coins from +// DepositAuthorization allows the grantee to deposit up to spend_limit coins from // the granter's account for a deployment. message DepositAuthorization { option (cosmos_proto.implements_interface) = "Authorization"; diff --git a/proto/node/akash/deployment/v1/deployment.proto b/proto/node/akash/deployment/v1/deployment.proto index 2e7026fd..259a113f 100644 --- a/proto/node/akash/deployment/v1/deployment.proto +++ b/proto/node/akash/deployment/v1/deployment.proto @@ -6,16 +6,25 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1"; -// DeploymentID stores owner and sequence number +// DeploymentID represents a unique identifier for a specific deployment on the network. +// It is composed of two fields: an owner address and a sequence number (dseq). message DeploymentID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account address of the user who owns the deployment. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", @@ -23,22 +32,23 @@ message DeploymentID { ]; } -// Deployment stores deploymentID, state and checksum details +// Deployment stores deploymentID, state and checksum details. message Deployment { option (gogoproto.equal) = false; - // State is an enum which refers to state of deployment + // State is an enum which refers to state of deployment. enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [(gogoproto.enumvalue_customname) = "DeploymentStateInvalid"]; - // DeploymentActive denotes state for deployment active + // DeploymentActive denotes state for deployment active. active = 1 [(gogoproto.enumvalue_customname) = "DeploymentActive"]; - // DeploymentClosed denotes state for deployment closed + // DeploymentClosed denotes state for deployment closed. closed = 2 [(gogoproto.enumvalue_customname) = "DeploymentClosed"]; } + // ID is the unique identifier of the deployment. DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -46,13 +56,18 @@ message Deployment { (gogoproto.moretags) = "yaml:\"id\"" ]; - State state = 2 [ + // State defines the sate of the deployment. A deployment can be either active or inactive. + State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; + + // Hash is an hashed representation of the deployment. bytes hash = 3 [ (gogoproto.jsontag) = "hash", (gogoproto.moretags) = "yaml:\"hash\"" ]; + + // CreatedAt indicates when the deployment was created as a block height value. int64 created_at = 4; } diff --git a/proto/node/akash/deployment/v1/event.proto b/proto/node/akash/deployment/v1/event.proto index 672e17ce..423c19dc 100644 --- a/proto/node/akash/deployment/v1/event.proto +++ b/proto/node/akash/deployment/v1/event.proto @@ -8,10 +8,12 @@ import "akash/deployment/v1/group.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1"; -// EventDeploymentCreated event is triggered when deployment is created on chain +// EventDeploymentCreated event is triggered when deployment is created on chain. +// It contains all the information required to identify a deployment. message EventDeploymentCreated { option (gogoproto.equal) = false; + // ID is the unique identifier of the deployment. DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -19,16 +21,19 @@ message EventDeploymentCreated { (gogoproto.moretags) = "yaml:\"id\"" ]; + // Hash is an hashed representation of the deployment. bytes hash = 2 [ (gogoproto.jsontag) = "hash", (gogoproto.moretags) = "yaml:\"hash\"" ]; } -// EventDeploymentUpdated is triggered when deployment is updated on chain +// EventDeploymentUpdated is triggered when deployment is updated on chain. +// It contains all the information required to identify a deployment. message EventDeploymentUpdated { option (gogoproto.equal) = false; + // ID is the unique identifier of the deployment. DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -36,16 +41,19 @@ message EventDeploymentUpdated { (gogoproto.moretags) = "yaml:\"id\"" ]; + // Hash is an hashed representation of the deployment. bytes hash = 2 [ (gogoproto.jsontag) = "hash", (gogoproto.moretags) = "yaml:\"hash\"" ]; } -// EventDeploymentClosed is triggered when deployment is closed on chain +// EventDeploymentClosed is triggered when deployment is closed on chain. +// It contains all the information required to identify a deployment. message EventDeploymentClosed { option (gogoproto.equal) = false; + // ID is the unique identifier of the deployment. DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -54,10 +62,12 @@ message EventDeploymentClosed { ]; } -// EventGroupStarted is triggered when deployment group is started +// EventGroupStarted is triggered when deployment group is started. +// It contains all the information required to identify a group. message EventGroupStarted { option (gogoproto.equal) = false; + // ID is the unique identifier of the group. GroupID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -66,10 +76,12 @@ message EventGroupStarted { ]; } -// EventGroupPaused is triggered when deployment group is paused +// EventGroupPaused is triggered when deployment group is paused. +// It contains all the information required to identify a group. message EventGroupPaused { option (gogoproto.equal) = false; + // ID is the unique identifier of the group. GroupID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -78,10 +90,12 @@ message EventGroupPaused { ]; } -// EventGroupClosed is triggered when deployment group is closed +// EventGroupClosed is triggered when deployment group is closed. +// It contains all the information required to identify a group. message EventGroupClosed { option (gogoproto.equal) = false; + // ID is the unique identifier of the group. GroupID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", diff --git a/proto/node/akash/deployment/v1/group.proto b/proto/node/akash/deployment/v1/group.proto index 582291e4..31bbf409 100644 --- a/proto/node/akash/deployment/v1/group.proto +++ b/proto/node/akash/deployment/v1/group.proto @@ -6,21 +6,35 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1"; -// GroupID stores owner, deployment sequence number and group sequence number +// GroupID uniquely identifies a group within a deployment on the network. +// A group represents a specific collection of resources or configurations +// within a deployment. +// It stores owner, deployment sequence number (dseq) and group sequence number (gseq). message GroupID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account address of the user who owns the group. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", diff --git a/proto/node/akash/deployment/v1/msg.proto b/proto/node/akash/deployment/v1/msg.proto index 34f6cf24..ef176351 100644 --- a/proto/node/akash/deployment/v1/msg.proto +++ b/proto/node/akash/deployment/v1/msg.proto @@ -10,10 +10,13 @@ import "akash/deployment/v1/deployment.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1"; -// MsgDepositDeployment deposits more funds into the deposit account +// MsgDepositDeployment represents a message to deposit funds into an existing deployment +// on the blockchain. This is part of the interaction mechanism for managing +// deployment-related resources. message MsgDepositDeployment { option (gogoproto.equal) = false; + // ID is the unique identifier of the deployment. DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -21,13 +24,16 @@ message MsgDepositDeployment { (gogoproto.moretags) = "yaml:\"id\"" ]; + // Amount defines the funds to deposit into the deployment. + // It is specified as a coin amount (denomination and value). cosmos.base.v1beta1.Coin amount = 2 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "amount", (gogoproto.moretags) = "yaml:\"amount\"" ]; - // Depositor pays for the deposit + // Depositor is the address of the account depositing funds into the deployment. + // This must be a valid blockchain account address. string depositor = 3 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "depositor", diff --git a/proto/provider/akash/inventory/v1/cluster.proto b/proto/provider/akash/inventory/v1/cluster.proto index 23273c47..1157ff5d 100644 --- a/proto/provider/akash/inventory/v1/cluster.proto +++ b/proto/provider/akash/inventory/v1/cluster.proto @@ -8,7 +8,7 @@ import "akash/inventory/v1/storage.proto"; option go_package = "pkg.akt.dev/go/inventory/v1"; -// Cluster reports inventory across entire cluster +// Cluster reports inventory across entire cluster. message Cluster { option (gogoproto.equal) = false; diff --git a/proto/provider/buf.yaml b/proto/provider/buf.yaml index 05bf8c9e..ebad918e 100644 --- a/proto/provider/buf.yaml +++ b/proto/provider/buf.yaml @@ -1,4 +1,4 @@ -# This module represents buf.build/akash-network/manifest +# This module represents buf.build/akash-network/provider version: v1 name: buf.build/akash-network/provider deps: @@ -8,6 +8,7 @@ deps: - buf.build/cosmos/cosmos-proto - buf.build/googleapis/googleapis - buf.build/protocolbuffers/wellknowntypes + - buf.build/kubernetes/apimachinery lint: allow_comment_ignores: true use: From 1395a54bee86ca285468f60a8cc14b76e556fb9f Mon Sep 17 00:00:00 2001 From: Joao Luna Date: Fri, 20 Dec 2024 19:19:29 +0000 Subject: [PATCH 2/4] fix: add docs and fix wrong json tag --- go/node/audit/v1/audit.pb.go | 29 +++-- go/node/audit/v1/event.pb.go | 28 ++++- go/node/audit/v1/genesis.pb.go | 3 +- go/node/audit/v1/msg.pb.go | 35 ++++-- go/node/audit/v1/query.pb.go | 72 +++++++++---- go/node/audit/v1/service.pb.go | 8 +- go/node/cert/v1/cert.pb.go | 29 +++-- go/node/cert/v1/filters.pb.go | 15 ++- go/node/cert/v1/genesis.pb.go | 13 ++- go/node/cert/v1/msg.pb.go | 16 ++- go/node/cert/v1/query.pb.go | 22 ++-- go/node/cert/v1/service.pb.go | 4 +- go/node/client/akash.pb.go | 3 +- go/node/client/client_info.pb.go | 3 +- go/node/deployment/v1/deployment.pb.go | 28 ++--- go/node/deployment/v1/event.pb.go | 34 ++++-- go/node/deployment/v1/group.pb.go | 18 +++- go/node/deployment/v1/msg.pb.go | 6 +- .../deployment/v1beta4/deploymentmsg.pb.go | 31 ++++-- go/node/deployment/v1beta4/filters.pb.go | 27 ++++- go/node/deployment/v1beta4/genesis.pb.go | 12 ++- go/node/deployment/v1beta4/group.pb.go | 23 ++-- go/node/deployment/v1beta4/groupmsg.pb.go | 7 +- go/node/deployment/v1beta4/groupspec.pb.go | 12 ++- go/node/deployment/v1beta4/params.pb.go | 3 +- go/node/deployment/v1beta4/paramsmsg.pb.go | 4 +- go/node/deployment/v1beta4/query.pb.go | 42 +++++--- go/node/deployment/v1beta4/resourceunit.pb.go | 9 +- go/node/deployment/v1beta4/service.pb.go | 4 +- go/node/escrow/v1/account.pb.go | 34 +++--- go/node/escrow/v1/accountid.pb.go | 6 +- go/node/escrow/v1/fractional_payment.pb.go | 35 +++--- go/node/escrow/v1/genesis.pb.go | 6 +- go/node/escrow/v1/query.pb.go | 56 +++++++--- go/node/gov/v1beta3/genesis.pb.go | 3 +- go/node/gov/v1beta3/params.pb.go | 4 +- go/node/inflation/types/v1beta2/genesis.pb.go | 3 +- go/node/inflation/types/v1beta2/params.pb.go | 2 +- go/node/inflation/v1beta3/genesis.pb.go | 3 +- go/node/inflation/v1beta3/params.pb.go | 2 +- go/node/market/v1/bid.pb.go | 26 ++++- go/node/market/v1/event.pb.go | 30 ++++-- go/node/market/v1/filters.pb.go | 29 +++-- go/node/market/v1/lease.pb.go | 56 +++++++--- go/node/market/v1/order.pb.go | 19 +++- go/node/market/v1beta5/bid.pb.go | 98 +++++++++-------- go/node/market/v1beta5/bidmsg.pb.go | 22 ++-- go/node/market/v1beta5/filters.pb.go | 48 +++++++-- go/node/market/v1beta5/genesis.pb.go | 12 ++- go/node/market/v1beta5/leasemsg.pb.go | 11 +- go/node/market/v1beta5/order.pb.go | 13 +-- go/node/market/v1beta5/params.pb.go | 6 +- go/node/market/v1beta5/query.pb.go | 80 ++++++++------ go/node/market/v1beta5/resourcesoffer.pb.go | 6 +- go/node/staking/v1beta3/genesis.pb.go | 3 +- go/node/staking/v1beta3/params.pb.go | 4 +- go/node/staking/v1beta3/query.pb.go | 2 +- go/node/take/v1/genesis.pb.go | 3 +- go/node/take/v1/params.pb.go | 15 +-- go/node/types/attributes/v1/attribute.pb.go | 22 ++-- go/node/types/resources/v1beta4/cpu.pb.go | 8 +- .../types/resources/v1beta4/endpoint.pb.go | 16 +-- go/node/types/resources/v1beta4/gpu.pb.go | 4 +- go/node/types/resources/v1beta4/memory.pb.go | 8 +- .../types/resources/v1beta4/resources.pb.go | 20 +++- .../resources/v1beta4/resourcevalue.pb.go | 2 +- go/node/types/resources/v1beta4/storage.pb.go | 11 +- proto/node/akash/audit/v1/audit.proto | 41 +++++-- proto/node/akash/audit/v1/event.proto | 26 ++++- proto/node/akash/audit/v1/genesis.proto | 4 +- proto/node/akash/audit/v1/msg.proto | 29 ++++- proto/node/akash/audit/v1/query.proto | 61 ++++++++--- proto/node/akash/audit/v1/service.proto | 6 +- .../akash/base/attributes/v1/attribute.proto | 23 ++-- .../akash/base/resources/v1beta4/cpu.proto | 7 +- .../base/resources/v1beta4/endpoint.proto | 13 ++- .../akash/base/resources/v1beta4/gpu.proto | 7 +- .../akash/base/resources/v1beta4/memory.proto | 8 +- .../base/resources/v1beta4/resources.proto | 15 +++ .../resources/v1beta4/resourcevalue.proto | 2 +- .../base/resources/v1beta4/storage.proto | 10 +- proto/node/akash/cert/v1/cert.proto | 24 +++-- proto/node/akash/cert/v1/filters.proto | 11 +- proto/node/akash/cert/v1/genesis.proto | 12 ++- proto/node/akash/cert/v1/msg.proto | 12 ++- proto/node/akash/cert/v1/query.proto | 17 ++- proto/node/akash/cert/v1/service.proto | 4 +- .../node/akash/deployment/v1/deployment.proto | 4 +- .../deployment/v1beta4/deploymentmsg.proto | 24 ++++- .../akash/deployment/v1beta4/filters.proto | 63 +++++++---- .../akash/deployment/v1beta4/genesis.proto | 8 +- .../node/akash/deployment/v1beta4/group.proto | 15 +-- .../akash/deployment/v1beta4/groupmsg.proto | 7 +- .../akash/deployment/v1beta4/groupspec.proto | 8 +- .../akash/deployment/v1beta4/params.proto | 4 +- .../akash/deployment/v1beta4/paramsmsg.proto | 4 +- .../node/akash/deployment/v1beta4/query.proto | 32 ++++-- .../deployment/v1beta4/resourceunit.proto | 5 +- .../akash/deployment/v1beta4/service.proto | 4 +- proto/node/akash/discovery/v1/akash.proto | 3 +- .../node/akash/discovery/v1/client_info.proto | 3 +- proto/node/akash/escrow/v1/account.proto | 40 ++++--- proto/node/akash/escrow/v1/accountid.proto | 5 +- .../akash/escrow/v1/fractional_payment.proto | 25 +++-- proto/node/akash/escrow/v1/genesis.proto | 5 +- proto/node/akash/escrow/v1/query.proto | 34 +++++- proto/node/akash/gov/v1beta3/genesis.proto | 3 +- proto/node/akash/gov/v1beta3/params.proto | 4 +- .../akash/inflation/v1beta2/genesis.proto | 3 +- .../node/akash/inflation/v1beta2/params.proto | 2 +- .../akash/inflation/v1beta3/genesis.proto | 3 +- .../node/akash/inflation/v1beta3/params.proto | 2 +- proto/node/akash/market/v1/bid.proto | 21 +++- proto/node/akash/market/v1/event.proto | 27 +++-- proto/node/akash/market/v1/filters.proto | 35 ++++-- proto/node/akash/market/v1/lease.proto | 43 ++++++-- proto/node/akash/market/v1/order.proto | 16 ++- proto/node/akash/market/v1beta5/bid.proto | 22 ++-- proto/node/akash/market/v1beta5/bidmsg.proto | 18 +++- proto/node/akash/market/v1beta5/filters.proto | 100 ++++++++++++------ proto/node/akash/market/v1beta5/genesis.proto | 9 +- .../node/akash/market/v1beta5/leasemsg.proto | 11 +- proto/node/akash/market/v1beta5/order.proto | 15 +-- proto/node/akash/market/v1beta5/params.proto | 6 +- proto/node/akash/market/v1beta5/query.proto | 52 ++++++--- .../akash/market/v1beta5/resourcesoffer.proto | 4 +- proto/node/akash/market/v1beta5/service.proto | 2 +- .../node/akash/staking/v1beta3/genesis.proto | 3 +- proto/node/akash/staking/v1beta3/params.proto | 4 +- proto/node/akash/staking/v1beta3/query.proto | 4 +- .../node/akash/staking/v1beta3/service.proto | 2 +- proto/node/akash/take/v1/genesis.proto | 3 +- proto/node/akash/take/v1/params.proto | 10 +- proto/node/akash/take/v1/query.proto | 2 +- 134 files changed, 1664 insertions(+), 655 deletions(-) diff --git a/go/node/audit/v1/audit.pb.go b/go/node/audit/v1/audit.pb.go index 1a7eb270..bdb47900 100644 --- a/go/node/audit/v1/audit.pb.go +++ b/go/node/audit/v1/audit.pb.go @@ -25,10 +25,22 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Provider stores owner auditor and attributes details +// Provider stores owner, auditor and attributes details. type AuditedProvider struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` + // Attributes holds a list of key-value pairs of provider attributes. + // Attributes are arbitrary values that a provider exposes. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,4,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes" yaml:"attributes"` } @@ -86,8 +98,11 @@ func (m *AuditedProvider) GetAttributes() pkg_akt_dev_go_node_types_attributes_v return nil } -// Attributes +// AuditedAttributesStore stores the audited attributes of the provider. +// Audited attributes are attributes verified by the auditor. type AuditedAttributesStore struct { + // Attributes holds a list of key-value pairs of provider attributes. + // Attributes are arbitrary values that a provider exposes. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,1,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes" yaml:"attributes"` } @@ -131,10 +146,12 @@ func (m *AuditedAttributesStore) GetAttributes() pkg_akt_dev_go_node_types_attri return nil } -// AttributesFilters defines filters used to filter deployments +// AttributesFilters defines attribute filters that can be used to filter deployments. type AttributesFilters struct { + // Auditors contains a list of account addresses. Auditors []string `protobuf:"bytes,1,rep,name=auditors,proto3" json:"auditors" yaml:"auditors"` - Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners" yaml:"owners"` + // Owners contains a list of account addresses. + Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners" yaml:"owners"` } func (m *AttributesFilters) Reset() { *m = AttributesFilters{} } diff --git a/go/node/audit/v1/event.pb.go b/go/node/audit/v1/event.pb.go index 908338ba..598533f2 100644 --- a/go/node/audit/v1/event.pb.go +++ b/go/node/audit/v1/event.pb.go @@ -24,9 +24,19 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// EventTrustedAuditorCreated defines an SDK message for signing a provider attributes +// EventTrustedAuditorCreated defines an SDK message for when a trusted auditor is created. type EventTrustedAuditorCreated struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` } @@ -77,9 +87,19 @@ func (m *EventTrustedAuditorCreated) GetAuditor() string { return "" } -// EventTrustedAuditorCreated defines an SDK message for signing a provider attributes +// EventTrustedAuditorDeleted defines an event for when a trusted auditor is deleted. type EventTrustedAuditorDeleted struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` } diff --git a/go/node/audit/v1/genesis.pb.go b/go/node/audit/v1/genesis.pb.go index b45b6e44..9ddb31f1 100644 --- a/go/node/audit/v1/genesis.pb.go +++ b/go/node/audit/v1/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState defines the basic genesis state used by audit module +// GenesisState defines the basic genesis state used by audit module. type GenesisState struct { + // Providers contains a list of audited provided account addresses. Providers []AuditedProvider `protobuf:"bytes,1,rep,name=providers,proto3" json:"providers" yaml:"providers"` } diff --git a/go/node/audit/v1/msg.pb.go b/go/node/audit/v1/msg.pb.go index e7a42a58..7f39bcdf 100644 --- a/go/node/audit/v1/msg.pb.go +++ b/go/node/audit/v1/msg.pb.go @@ -27,10 +27,22 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgSignProviderAttributes defines an SDK message for signing a provider attributes +// MsgSignProviderAttributes defines an SDK message for signing a provider attributes. type MsgSignProviderAttributes struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` + // Attributes holds a list of key-value pairs of provider attributes to be audited. + // Attributes are arbitrary values that a provider exposes. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,3,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes" yaml:"attributes"` } @@ -127,9 +139,20 @@ var xxx_messageInfo_MsgSignProviderAttributesResponse proto.InternalMessageInfo // MsgDeleteProviderAttributes defined the Msg/DeleteProviderAttributes type MsgDeleteProviderAttributes struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` - Keys []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys" yaml:"keys"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Auditor string `protobuf:"bytes,2,opt,name=auditor,proto3" json:"auditor" yaml:"auditor"` + // Keys holds a list of keys of audited provider attributes to delete from the audit. + Keys []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys" yaml:"keys"` } func (m *MsgDeleteProviderAttributes) Reset() { *m = MsgDeleteProviderAttributes{} } diff --git a/go/node/audit/v1/query.pb.go b/go/node/audit/v1/query.pb.go index 12313d8e..a69851d9 100644 --- a/go/node/audit/v1/query.pb.go +++ b/go/node/audit/v1/query.pb.go @@ -30,9 +30,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// QueryProvidersResponse is response type for the Query/Providers RPC method +// QueryProvidersResponse is response type for the Query/Providers RPC method. type QueryProvidersResponse struct { - Providers AuditedProviders `protobuf:"bytes,1,rep,name=providers,proto3,castrepeated=AuditedProviders" json:"providers"` + // Providers contains a list of audited provided account addresses. + Providers AuditedProviders `protobuf:"bytes,1,rep,name=providers,proto3,castrepeated=AuditedProviders" json:"providers"` + // Pagination is used to paginate results. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -85,8 +87,18 @@ func (m *QueryProvidersResponse) GetPagination() *query.PageResponse { // QueryProviderRequest is request type for the Query/Provider RPC method type QueryProviderRequest struct { + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Auditor string `protobuf:"bytes,1,opt,name=auditor,proto3" json:"auditor,omitempty"` - Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"` } func (m *QueryProviderRequest) Reset() { *m = QueryProviderRequest{} } @@ -136,8 +148,9 @@ func (m *QueryProviderRequest) GetOwner() string { return "" } -// QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method +// QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method. type QueryAllProvidersAttributesRequest struct { + // Pagination is used to paginate the request. Pagination *query.PageRequest `protobuf:"bytes,1,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -181,9 +194,15 @@ func (m *QueryAllProvidersAttributesRequest) GetPagination() *query.PageRequest return nil } -// QueryProviderAttributesRequest is request type for the Query/Provider RPC method +// QueryProviderAttributesRequest is request type for the Query/Provider RPC method. type QueryProviderAttributesRequest struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -234,10 +253,20 @@ func (m *QueryProviderAttributesRequest) GetPagination() *query.PageRequest { return nil } -// QueryProviderAuditorRequest is request type for the Query/Providers RPC method +// QueryProviderAuditorRequest is request type for the Query/Providers RPC method. type QueryProviderAuditorRequest struct { + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Auditor string `protobuf:"bytes,1,opt,name=auditor,proto3" json:"auditor,omitempty"` - Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"` + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"` } func (m *QueryProviderAuditorRequest) Reset() { *m = QueryProviderAuditorRequest{} } @@ -287,9 +316,16 @@ func (m *QueryProviderAuditorRequest) GetOwner() string { return "" } -// QueryAuditorAttributesRequest is request type for the Query/Providers RPC method +// QueryAuditorAttributesRequest is request type for the Query/Providers RPC method. type QueryAuditorAttributesRequest struct { - Auditor string `protobuf:"bytes,1,opt,name=auditor,proto3" json:"auditor,omitempty"` + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // + // "akash1..." + Auditor string `protobuf:"bytes,1,opt,name=auditor,proto3" json:"auditor,omitempty"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -402,19 +438,19 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type QueryClient interface { - // AllProvidersAttributes queries all providers + // AllProvidersAttributes queries all providers. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME AllProvidersAttributes(ctx context.Context, in *QueryAllProvidersAttributesRequest, opts ...grpc.CallOption) (*QueryProvidersResponse, error) - // ProviderAttributes queries all provider signed attributes + // ProviderAttributes queries all provider signed attributes. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME ProviderAttributes(ctx context.Context, in *QueryProviderAttributesRequest, opts ...grpc.CallOption) (*QueryProvidersResponse, error) - // ProviderAuditorAttributes queries provider signed attributes by specific auditor + // ProviderAuditorAttributes queries provider signed attributes by specific auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME ProviderAuditorAttributes(ctx context.Context, in *QueryProviderAuditorRequest, opts ...grpc.CallOption) (*QueryProvidersResponse, error) - // AuditorAttributes queries all providers signed by this auditor + // AuditorAttributes queries all providers signed by this auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME AuditorAttributes(ctx context.Context, in *QueryAuditorAttributesRequest, opts ...grpc.CallOption) (*QueryProvidersResponse, error) @@ -466,19 +502,19 @@ func (c *queryClient) AuditorAttributes(ctx context.Context, in *QueryAuditorAtt // QueryServer is the server API for Query service. type QueryServer interface { - // AllProvidersAttributes queries all providers + // AllProvidersAttributes queries all providers. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME AllProvidersAttributes(context.Context, *QueryAllProvidersAttributesRequest) (*QueryProvidersResponse, error) - // ProviderAttributes queries all provider signed attributes + // ProviderAttributes queries all provider signed attributes. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME ProviderAttributes(context.Context, *QueryProviderAttributesRequest) (*QueryProvidersResponse, error) - // ProviderAuditorAttributes queries provider signed attributes by specific auditor + // ProviderAuditorAttributes queries provider signed attributes by specific auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME ProviderAuditorAttributes(context.Context, *QueryProviderAuditorRequest) (*QueryProvidersResponse, error) - // AuditorAttributes queries all providers signed by this auditor + // AuditorAttributes queries all providers signed by this auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME AuditorAttributes(context.Context, *QueryAuditorAttributesRequest) (*QueryProvidersResponse, error) diff --git a/go/node/audit/v1/service.pb.go b/go/node/audit/v1/service.pb.go index ae2ca479..7efb5d28 100644 --- a/go/node/audit/v1/service.pb.go +++ b/go/node/audit/v1/service.pb.go @@ -59,9 +59,9 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type MsgClient interface { - // SignProviderAttributes defines a method that signs provider attributes + // SignProviderAttributes defines a method that signs provider attributes. SignProviderAttributes(ctx context.Context, in *MsgSignProviderAttributes, opts ...grpc.CallOption) (*MsgSignProviderAttributesResponse, error) - // DeleteProviderAttributes defines a method that deletes provider attributes + // DeleteProviderAttributes defines a method that deletes provider attributes. DeleteProviderAttributes(ctx context.Context, in *MsgDeleteProviderAttributes, opts ...grpc.CallOption) (*MsgDeleteProviderAttributesResponse, error) } @@ -93,9 +93,9 @@ func (c *msgClient) DeleteProviderAttributes(ctx context.Context, in *MsgDeleteP // MsgServer is the server API for Msg service. type MsgServer interface { - // SignProviderAttributes defines a method that signs provider attributes + // SignProviderAttributes defines a method that signs provider attributes. SignProviderAttributes(context.Context, *MsgSignProviderAttributes) (*MsgSignProviderAttributesResponse, error) - // DeleteProviderAttributes defines a method that deletes provider attributes + // DeleteProviderAttributes defines a method that deletes provider attributes. DeleteProviderAttributes(context.Context, *MsgDeleteProviderAttributes) (*MsgDeleteProviderAttributesResponse, error) } diff --git a/go/node/cert/v1/cert.pb.go b/go/node/cert/v1/cert.pb.go index ceb1cacf..fe68898c 100644 --- a/go/node/cert/v1/cert.pb.go +++ b/go/node/cert/v1/cert.pb.go @@ -24,15 +24,15 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State is an enum which refers to state of deployment +// State is an enum which refers to state of the certificate. type State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. CertificateStateInvalid State = 0 - // CertificateValid denotes state for deployment active + // CertificateValid denotes state for deployment active. CertificateValid State = 1 - // CertificateRevoked denotes state for deployment closed + // CertificateRevoked denotes state for deployment closed. CertificateRevoked State = 2 ) @@ -56,9 +56,15 @@ func (State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_aed64ec87f738ef2, []int{0} } -// ID stores owner and sequence number +// ID stores owner and sequence number. type ID struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Serial is a sequence number for the certificate. Serial string `protobuf:"bytes,2,opt,name=serial,proto3" json:"serial" yaml:"serial"` } @@ -108,10 +114,15 @@ func (m *ID) GetSerial() string { return "" } -// Certificate stores state, certificate and it's public key +// Certificate stores state, certificate and it's public key. type Certificate struct { - State State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.cert.v1.State" json:"state" yaml:"state"` - Cert []byte `protobuf:"bytes,3,opt,name=cert,proto3" json:"cert" yaml:"cert"` + // State is the state of the certificate. + // CertificateValid denotes state for deployment active. + // CertificateRevoked denotes state for deployment closed. + State State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.cert.v1.State" json:"state" yaml:"state"` + // Cert holds the bytes representing the certificate. + Cert []byte `protobuf:"bytes,3,opt,name=cert,proto3" json:"cert" yaml:"cert"` + // PubKey holds the public key. Pubkey []byte `protobuf:"bytes,4,opt,name=pubkey,proto3" json:"pubkey" yaml:"pubkey"` } diff --git a/go/node/cert/v1/filters.pb.go b/go/node/cert/v1/filters.pb.go index c7c0033b..58682324 100644 --- a/go/node/cert/v1/filters.pb.go +++ b/go/node/cert/v1/filters.pb.go @@ -24,11 +24,20 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// CertificateFilter defines filters used to filter certificates +// CertificateFilter defines filters used to filter certificates. type CertificateFilter struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Serial is a sequence number for the certificate. Serial string `protobuf:"bytes,2,opt,name=serial,proto3" json:"serial" yaml:"serial"` - State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state" yaml:"state"` + // State is the state of the certificate. + // CertificateValid denotes state for deployment active. + // CertificateRevoked denotes state for deployment closed. + State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state" yaml:"state"` } func (m *CertificateFilter) Reset() { *m = CertificateFilter{} } diff --git a/go/node/cert/v1/genesis.pb.go b/go/node/cert/v1/genesis.pb.go index 27eb028c..1db1f87a 100644 --- a/go/node/cert/v1/genesis.pb.go +++ b/go/node/cert/v1/genesis.pb.go @@ -24,9 +24,15 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisCertificate defines certificate entry at genesis +// GenesisCertificate defines certificate entry at genesis. type GenesisCertificate struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Certificate holds the certificate. Certificate Certificate `protobuf:"bytes,2,opt,name=certificate,proto3" json:"certificate" yaml:"certificate"` } @@ -77,8 +83,9 @@ func (m *GenesisCertificate) GetCertificate() Certificate { return Certificate{} } -// GenesisState defines the basic genesis state used by cert module +// GenesisState defines the basic genesis state used by cert module. type GenesisState struct { + // Certificates is a list of genesis certificates. Certificates GenesisCertificates `protobuf:"bytes,1,rep,name=certificates,proto3,castrepeated=GenesisCertificates" json:"certificates" yaml:"certificates"` } diff --git a/go/node/cert/v1/msg.pb.go b/go/node/cert/v1/msg.pb.go index 25c3f83f..aeb16b94 100644 --- a/go/node/cert/v1/msg.pb.go +++ b/go/node/cert/v1/msg.pb.go @@ -25,10 +25,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgCreateCertificate defines an SDK message for creating certificate +// MsgCreateCertificate defines an SDK message for creating certificate. type MsgCreateCertificate struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - Cert []byte `protobuf:"bytes,2,opt,name=cert,proto3" json:"cert" yaml:"cert"` + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Cert holds the bytes representing the certificate. + Cert []byte `protobuf:"bytes,2,opt,name=cert,proto3" json:"cert" yaml:"cert"` + // PubKey holds the public key. Pubkey []byte `protobuf:"bytes,3,opt,name=pubkey,proto3" json:"pubkey" yaml:"pubkey"` } @@ -123,8 +130,9 @@ func (m *MsgCreateCertificateResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgCreateCertificateResponse proto.InternalMessageInfo -// MsgRevokeCertificate defines an SDK message for revoking certificate +// MsgRevokeCertificate defines an SDK message for revoking certificate. type MsgRevokeCertificate struct { + // Id corresponds to the certificate ID which includes owner and sequence number. ID ID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/cert/v1/query.pb.go b/go/node/cert/v1/query.pb.go index 58340375..6bc233d7 100644 --- a/go/node/cert/v1/query.pb.go +++ b/go/node/cert/v1/query.pb.go @@ -30,10 +30,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// CertificateResponse contains a single X509 certificate and its serial number +// CertificateResponse contains a single X509 certificate and its serial number. type CertificateResponse struct { + // Certificate holds the certificate. Certificate Certificate `protobuf:"bytes,1,opt,name=certificate,proto3" json:"certificate" yaml:"certificate"` - Serial string `protobuf:"bytes,2,opt,name=serial,proto3" json:"serial" yaml:"serial"` + // Serial is a sequence number for the certificate. + Serial string `protobuf:"bytes,2,opt,name=serial,proto3" json:"serial" yaml:"serial"` } func (m *CertificateResponse) Reset() { *m = CertificateResponse{} } @@ -83,9 +85,11 @@ func (m *CertificateResponse) GetSerial() string { return "" } -// QueryDeploymentsRequest is request type for the Query/Deployments RPC method +// QueryDeploymentsRequest is request type for the Query/Deployments RPC method. type QueryCertificatesRequest struct { - Filter CertificateFilter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter"` + // Filter allows for filtering of results. + Filter CertificateFilter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -136,10 +140,12 @@ func (m *QueryCertificatesRequest) GetPagination() *query.PageRequest { return nil } -// QueryCertificatesResponse is response type for the Query/Certificates RPC method +// QueryCertificatesResponse is response type for the Query/Certificates RPC method. type QueryCertificatesResponse struct { + // Certificates is a list of certificate. Certificates CertificatesResponse `protobuf:"bytes,1,rep,name=certificates,proto3,castrepeated=CertificatesResponse" json:"certificates"` - Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` + // Pagination contains the information about response pagination. + Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } func (m *QueryCertificatesResponse) Reset() { *m = QueryCertificatesResponse{} } @@ -243,7 +249,7 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type QueryClient interface { - // Certificates queries certificates + // Certificates queries certificates on-chain. Certificates(ctx context.Context, in *QueryCertificatesRequest, opts ...grpc.CallOption) (*QueryCertificatesResponse, error) } @@ -266,7 +272,7 @@ func (c *queryClient) Certificates(ctx context.Context, in *QueryCertificatesReq // QueryServer is the server API for Query service. type QueryServer interface { - // Certificates queries certificates + // Certificates queries certificates on-chain. Certificates(context.Context, *QueryCertificatesRequest) (*QueryCertificatesResponse, error) } diff --git a/go/node/cert/v1/service.pb.go b/go/node/cert/v1/service.pb.go index 2a708270..1d144885 100644 --- a/go/node/cert/v1/service.pb.go +++ b/go/node/cert/v1/service.pb.go @@ -60,7 +60,7 @@ const _ = grpc.SupportPackageIsVersion4 type MsgClient interface { // CreateCertificate defines a method to create new certificate given proper inputs. CreateCertificate(ctx context.Context, in *MsgCreateCertificate, opts ...grpc.CallOption) (*MsgCreateCertificateResponse, error) - // RevokeCertificate defines a method to revoke the certificate + // RevokeCertificate defines a method to revoke the certificate. RevokeCertificate(ctx context.Context, in *MsgRevokeCertificate, opts ...grpc.CallOption) (*MsgRevokeCertificateResponse, error) } @@ -94,7 +94,7 @@ func (c *msgClient) RevokeCertificate(ctx context.Context, in *MsgRevokeCertific type MsgServer interface { // CreateCertificate defines a method to create new certificate given proper inputs. CreateCertificate(context.Context, *MsgCreateCertificate) (*MsgCreateCertificateResponse, error) - // RevokeCertificate defines a method to revoke the certificate + // RevokeCertificate defines a method to revoke the certificate. RevokeCertificate(context.Context, *MsgRevokeCertificate) (*MsgRevokeCertificateResponse, error) } diff --git a/go/node/client/akash.pb.go b/go/node/client/akash.pb.go index 9ddf2681..cbc72b53 100644 --- a/go/node/client/akash.pb.go +++ b/go/node/client/akash.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Akash akash specific RPC parameters +// Akash akash specific RPC parameters. type Akash struct { + // ClientInfo holds information about the client. ClientInfo *ClientInfo `protobuf:"bytes,1,opt,name=client_info,json=clientInfo,proto3" json:"client_info" yaml:"client_info"` } diff --git a/go/node/client/client_info.pb.go b/go/node/client/client_info.pb.go index 7a304072..15ee7b9b 100644 --- a/go/node/client/client_info.pb.go +++ b/go/node/client/client_info.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// ClientInfo akash specific client info +// ClientInfo is the akash specific client info. type ClientInfo struct { + // ApiVersion is the version of the API running on the client. ApiVersion string `protobuf:"bytes,1,opt,name=api_version,json=apiVersion,proto3" json:"api_version" yaml:"api_version"` } diff --git a/go/node/deployment/v1/deployment.pb.go b/go/node/deployment/v1/deployment.pb.go index f387ed79..8dcf1cb2 100644 --- a/go/node/deployment/v1/deployment.pb.go +++ b/go/node/deployment/v1/deployment.pb.go @@ -24,15 +24,15 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State is an enum which refers to state of deployment +// State is an enum which refers to state of deployment. type Deployment_State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. DeploymentStateInvalid Deployment_State = 0 - // DeploymentActive denotes state for deployment active + // DeploymentActive denotes state for deployment active. DeploymentActive Deployment_State = 1 - // DeploymentClosed denotes state for deployment closed + // DeploymentClosed denotes state for deployment closed. DeploymentClosed Deployment_State = 2 ) @@ -59,13 +59,13 @@ func (Deployment_State) EnumDescriptor() ([]byte, []int) { // DeploymentID represents a unique identifier for a specific deployment on the network. // It is composed of two fields: an owner address and a sequence number (dseq). type DeploymentID struct { - // owner is the account address of the user who owns the deployment. - // It is a string representing a valid account address. + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. // // Example: // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - // dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. // It is used to differentiate deployments created by the same owner. DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` } @@ -116,12 +116,16 @@ func (m *DeploymentID) GetDSeq() uint64 { return 0 } -// Deployment stores deploymentID, state and checksum details +// Deployment stores deploymentID, state and checksum details. type Deployment struct { - ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - State Deployment_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1.Deployment_State" json:"state" yaml:"state"` - Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` - CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // ID is the unique identifier of the deployment. + ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // State defines the sate of the deployment. A deployment can be either active or inactive. + State Deployment_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1.Deployment_State" json:"state" yaml:"state"` + // Hash is an hashed representation of the deployment. + Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` + // CreatedAt indicates when the deployment was created as a block height value. + CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` } func (m *Deployment) Reset() { *m = Deployment{} } diff --git a/go/node/deployment/v1/event.pb.go b/go/node/deployment/v1/event.pb.go index afd3c505..91edfce5 100644 --- a/go/node/deployment/v1/event.pb.go +++ b/go/node/deployment/v1/event.pb.go @@ -23,10 +23,13 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// EventDeploymentCreated event is triggered when deployment is created on chain +// EventDeploymentCreated event is triggered when deployment is created on chain. +// It contains all the information required to identify a deployment. type EventDeploymentCreated struct { - ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash" yaml:"hash"` + // ID is the unique identifier of the deployment. + ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Hash is an hashed representation of the deployment. + Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash" yaml:"hash"` } func (m *EventDeploymentCreated) Reset() { *m = EventDeploymentCreated{} } @@ -76,10 +79,13 @@ func (m *EventDeploymentCreated) GetHash() []byte { return nil } -// EventDeploymentUpdated is triggered when deployment is updated on chain +// EventDeploymentUpdated is triggered when deployment is updated on chain. +// It contains all the information required to identify a deployment. type EventDeploymentUpdated struct { - ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash" yaml:"hash"` + // ID is the unique identifier of the deployment. + ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Hash is an hashed representation of the deployment. + Hash []byte `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash" yaml:"hash"` } func (m *EventDeploymentUpdated) Reset() { *m = EventDeploymentUpdated{} } @@ -129,8 +135,10 @@ func (m *EventDeploymentUpdated) GetHash() []byte { return nil } -// EventDeploymentClosed is triggered when deployment is closed on chain +// EventDeploymentClosed is triggered when deployment is closed on chain. +// It contains all the information required to identify a deployment. type EventDeploymentClosed struct { + // ID is the unique identifier of the deployment. ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -174,8 +182,10 @@ func (m *EventDeploymentClosed) GetID() DeploymentID { return DeploymentID{} } -// EventGroupStarted is triggered when deployment group is started +// EventGroupStarted is triggered when deployment group is started. +// It contains all the information required to identify a group. type EventGroupStarted struct { + // ID is the unique identifier of the group. ID GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -219,8 +229,10 @@ func (m *EventGroupStarted) GetID() GroupID { return GroupID{} } -// EventGroupPaused is triggered when deployment group is paused +// EventGroupPaused is triggered when deployment group is paused. +// It contains all the information required to identify a group. type EventGroupPaused struct { + // ID is the unique identifier of the group. ID GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -264,8 +276,10 @@ func (m *EventGroupPaused) GetID() GroupID { return GroupID{} } -// EventGroupClosed is triggered when deployment group is closed +// EventGroupClosed is triggered when deployment group is closed. +// It contains all the information required to identify a group. type EventGroupClosed struct { + // ID is the unique identifier of the group. ID GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/deployment/v1/group.pb.go b/go/node/deployment/v1/group.pb.go index 7080e52c..a9f773d8 100644 --- a/go/node/deployment/v1/group.pb.go +++ b/go/node/deployment/v1/group.pb.go @@ -24,11 +24,23 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GroupID stores owner, deployment sequence number and group sequence number +// GroupID uniquely identifies a group within a deployment on the network. +// A group represents a specific collection of resources or configurations +// within a deployment. +// It stores owner, deployment sequence number (dseq) and group sequence number (gseq). type GroupID struct { + // Owner is the account address of the user who owns the group. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` } func (m *GroupID) Reset() { *m = GroupID{} } diff --git a/go/node/deployment/v1/msg.pb.go b/go/node/deployment/v1/msg.pb.go index a24a6ed2..234af0b4 100644 --- a/go/node/deployment/v1/msg.pb.go +++ b/go/node/deployment/v1/msg.pb.go @@ -29,12 +29,12 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // on the blockchain. This is part of the interaction mechanism for managing // deployment-related resources. type MsgDepositDeployment struct { - // id is the unique identifier of the deployment. + // ID is the unique identifier of the deployment. ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - // amount defines the funds to deposit into the deployment. + // Amount defines the funds to deposit into the deployment. // It is specified as a coin amount (denomination and value). Amount types.Coin `protobuf:"bytes,2,opt,name=amount,proto3" json:"amount" yaml:"amount"` - // depositor is the address of the account depositing funds into the deployment. + // Depositor is the address of the account depositing funds into the deployment. // This must be a valid blockchain account address. Depositor string `protobuf:"bytes,3,opt,name=depositor,proto3" json:"depositor" yaml:"depositor"` } diff --git a/go/node/deployment/v1beta4/deploymentmsg.pb.go b/go/node/deployment/v1beta4/deploymentmsg.pb.go index 90413d31..2510fa42 100644 --- a/go/node/deployment/v1beta4/deploymentmsg.pb.go +++ b/go/node/deployment/v1beta4/deploymentmsg.pb.go @@ -27,13 +27,23 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgCreateDeployment defines an SDK message for creating deployment +// MsgCreateDeployment defines an SDK message for creating deployment. type MsgCreateDeployment struct { - ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - Groups GroupSpecs `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=GroupSpecs" json:"groups" yaml:"groups"` - Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` - Deposit types.Coin `protobuf:"bytes,4,opt,name=deposit,proto3" json:"deposit" yaml:"deposit"` - // Depositor pays for the deposit + // ID is the unique identifier of the deployment. + ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // GroupSpec is a list of group specifications for the deployment. + // This field is required and must be a list of GroupSpec. + Groups GroupSpecs `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=GroupSpecs" json:"groups" yaml:"groups"` + // Hash of the deployment. + Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` + // Deposit specifies the amount of coins to include in the deployment's first deposit. + Deposit types.Coin `protobuf:"bytes,4,opt,name=deposit,proto3" json:"deposit" yaml:"deposit"` + // Depositor is the account address of the user who will deposit funds to the deployment. + // This value can be different than the owner of the deployment if there is authorized spend grants applied. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Depositor string `protobuf:"bytes,5,opt,name=depositor,proto3" json:"depositor" yaml:"depositor"` } @@ -142,10 +152,12 @@ func (m *MsgCreateDeploymentResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgCreateDeploymentResponse proto.InternalMessageInfo -// MsgUpdateDeployment defines an SDK message for updating deployment +// MsgUpdateDeployment defines an SDK message for updating deployment. type MsgUpdateDeployment struct { - ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` + // ID is the unique identifier of the deployment. + ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Hash of the deployment. + Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` } func (m *MsgUpdateDeployment) Reset() { *m = MsgUpdateDeployment{} } @@ -234,6 +246,7 @@ var xxx_messageInfo_MsgUpdateDeploymentResponse proto.InternalMessageInfo // MsgCloseDeployment defines an SDK message for closing deployment type MsgCloseDeployment struct { + // ID is the unique identifier of the deployment. ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/deployment/v1beta4/filters.pb.go b/go/node/deployment/v1beta4/filters.pb.go index 0187144a..e03ea3f8 100644 --- a/go/node/deployment/v1beta4/filters.pb.go +++ b/go/node/deployment/v1beta4/filters.pb.go @@ -24,10 +24,18 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// DeploymentFilters defines filters used to filter deployments +// DeploymentFilters defines filters used to filter deployments. type DeploymentFilters struct { + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // State defines the sate of the deployment. A deployment can be either active or inactive. State string `protobuf:"bytes,3,opt,name=state,proto3" json:"state" yaml:"state"` } @@ -87,9 +95,20 @@ func (m *DeploymentFilters) GetState() string { // GroupFilters defines filters used to filter groups type GroupFilters struct { + // Owner is the account address of the user who owns the group. + // It is a string representing a valid account address. + // + // Example: + // + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint64 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint64 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // State defines the sate of the deployment. A deployment can be either active or inactive. State string `protobuf:"bytes,4,opt,name=state,proto3" json:"state" yaml:"state"` } diff --git a/go/node/deployment/v1beta4/genesis.pb.go b/go/node/deployment/v1beta4/genesis.pb.go index 6774701c..2a589504 100644 --- a/go/node/deployment/v1beta4/genesis.pb.go +++ b/go/node/deployment/v1beta4/genesis.pb.go @@ -24,10 +24,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisDeployment defines the basic genesis state used by deployment module +// GenesisDeployment defines the basic genesis state used by deployment module. type GenesisDeployment struct { + // Deployments represents a deployment on the network. Deployment v1.Deployment `protobuf:"bytes,1,opt,name=deployment,proto3" json:"deployment" yaml:"deployment"` - Groups Groups `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=Groups" json:"groups" yaml:"groups"` + // Groups is a list of groups within a Deployment. + Groups Groups `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=Groups" json:"groups" yaml:"groups"` } func (m *GenesisDeployment) Reset() { *m = GenesisDeployment{} } @@ -77,10 +79,12 @@ func (m *GenesisDeployment) GetGroups() Groups { return nil } -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis deployment instance. type GenesisState struct { + // Deployments is a list of deployments on the network. Deployments []GenesisDeployment `protobuf:"bytes,1,rep,name=deployments,proto3" json:"deployments" yaml:"deployments"` - Params Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params" yaml:"params"` + // Params defines the parameters for the x/deployment module. + Params Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params" yaml:"params"` } func (m *GenesisState) Reset() { *m = GenesisState{} } diff --git a/go/node/deployment/v1beta4/group.pb.go b/go/node/deployment/v1beta4/group.pb.go index 13772c30..75cd61ff 100644 --- a/go/node/deployment/v1beta4/group.pb.go +++ b/go/node/deployment/v1beta4/group.pb.go @@ -28,15 +28,15 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package type Group_State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. GroupStateInvalid Group_State = 0 - // GroupOpen denotes state for group open + // GroupOpen denotes state for group open. GroupOpen Group_State = 1 - // GroupOrdered denotes state for group ordered + // GroupOrdered denotes state for group ordered. GroupPaused Group_State = 2 - // GroupInsufficientFunds denotes state for group insufficient_funds + // GroupInsufficientFunds denotes state for group insufficient_funds. GroupInsufficientFunds Group_State = 3 - // GroupClosed denotes state for group closed + // GroupClosed denotes state for group closed. GroupClosed Group_State = 4 ) @@ -64,12 +64,15 @@ func (Group_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_a45c04780ffee23e, []int{0, 0} } -// Group stores group id, state and specifications of group +// Group stores group id, state and specifications of a group. type Group struct { - ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - State Group_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1beta4.Group_State" json:"state" yaml:"state"` - GroupSpec GroupSpec `protobuf:"bytes,3,opt,name=group_spec,json=groupSpec,proto3,castrepeated=GroupSpecs" json:"spec" yaml:"spec"` - CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // Id is the unique identifier for the group. + ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // State represents the state of the group. + State Group_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1beta4.Group_State" json:"state" yaml:"state"` + // GroupSpec holds the specification of a the Group. + GroupSpec GroupSpec `protobuf:"bytes,3,opt,name=group_spec,json=groupSpec,proto3,castrepeated=GroupSpecs" json:"spec" yaml:"spec"` + CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` } func (m *Group) Reset() { *m = Group{} } diff --git a/go/node/deployment/v1beta4/groupmsg.pb.go b/go/node/deployment/v1beta4/groupmsg.pb.go index 2281f778..ab2b95f3 100644 --- a/go/node/deployment/v1beta4/groupmsg.pb.go +++ b/go/node/deployment/v1beta4/groupmsg.pb.go @@ -27,6 +27,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // MsgCloseGroup defines SDK message to close a single Group within a Deployment. type MsgCloseGroup struct { + // Id is the unique identifier of the Group. ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -107,8 +108,9 @@ func (m *MsgCloseGroupResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgCloseGroupResponse proto.InternalMessageInfo -// MsgPauseGroup defines SDK message to close a single Group within a Deployment. +// MsgPauseGroup defines SDK message to pause a single Group within a Deployment. type MsgPauseGroup struct { + // Id is the unique identifier of the Group. ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -189,8 +191,9 @@ func (m *MsgPauseGroupResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgPauseGroupResponse proto.InternalMessageInfo -// MsgStartGroup defines SDK message to close a single Group within a Deployment. +// MsgStartGroup defines SDK message to start a single Group within a Deployment. type MsgStartGroup struct { + // Id is the unique identifier of the Group. ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/deployment/v1beta4/groupspec.pb.go b/go/node/deployment/v1beta4/groupspec.pb.go index cc3753f1..dc7fa4a3 100644 --- a/go/node/deployment/v1beta4/groupspec.pb.go +++ b/go/node/deployment/v1beta4/groupspec.pb.go @@ -24,11 +24,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Spec stores group specifications +// GroupSpec defines a specification for a group in a deployment on the network. +// This includes attributes like the group name, placement requirements, and resource units. type GroupSpec struct { - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name" yaml:"name"` + // Name is the name of the group. + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name" yaml:"name"` + // Requirements specifies the placement requirements for the group. + // This determines where the resources in the group can be deployed. Requirements v1.PlacementRequirements `protobuf:"bytes,2,opt,name=requirements,proto3" json:"requirements" yaml:"requirements"` - Resources ResourceUnits `protobuf:"bytes,3,rep,name=resources,proto3,castrepeated=ResourceUnits" json:"resources" yaml:"resources"` + // Resources is a list containing the resource units allocated to the group. + // Each ResourceUnit defines the specific resources (e.g., CPU, memory) assigned. + Resources ResourceUnits `protobuf:"bytes,3,rep,name=resources,proto3,castrepeated=ResourceUnits" json:"resources" yaml:"resources"` } func (m *GroupSpec) Reset() { *m = GroupSpec{} } diff --git a/go/node/deployment/v1beta4/params.pb.go b/go/node/deployment/v1beta4/params.pb.go index 800b78a9..f43fe42c 100644 --- a/go/node/deployment/v1beta4/params.pb.go +++ b/go/node/deployment/v1beta4/params.pb.go @@ -25,8 +25,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Params defines the parameters for the x/deployment module +// Params defines the parameters for the x/deployment module. type Params struct { + // MinDeposits holds a list of the minimum amount of deposits for each a coin. MinDeposits github_com_cosmos_cosmos_sdk_types.Coins `protobuf:"bytes,1,rep,name=min_deposits,json=minDeposits,proto3,castrepeated=github.com/cosmos/cosmos-sdk/types.Coins" json:"min_deposits" yaml:"min_deposits"` } diff --git a/go/node/deployment/v1beta4/paramsmsg.pb.go b/go/node/deployment/v1beta4/paramsmsg.pb.go index 9cd0bbd8..77c1a4c1 100644 --- a/go/node/deployment/v1beta4/paramsmsg.pb.go +++ b/go/node/deployment/v1beta4/paramsmsg.pb.go @@ -29,9 +29,9 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // // Since: akash v1.0.0 type MsgUpdateParams struct { - // authority is the address of the governance account. + // Authority is the address of the governance account. Authority string `protobuf:"bytes,1,opt,name=authority,proto3" json:"authority,omitempty"` - // params defines the x/deployment parameters to update. + // Params defines the x/deployment parameters to update. // // NOTE: All parameters must be supplied. Params Params `protobuf:"bytes,2,opt,name=params,proto3" json:"params"` diff --git a/go/node/deployment/v1beta4/query.pb.go b/go/node/deployment/v1beta4/query.pb.go index cb3259c3..f30e690d 100644 --- a/go/node/deployment/v1beta4/query.pb.go +++ b/go/node/deployment/v1beta4/query.pb.go @@ -33,9 +33,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// QueryDeploymentsRequest is request type for the Query/Deployments RPC method +// QueryDeploymentsRequest is request type for the Query/Deployments RPC method. type QueryDeploymentsRequest struct { - Filters DeploymentFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Filters holds the deployment fields to filter the request. + Filters DeploymentFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Pagination is used to paginate the request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -88,8 +90,10 @@ func (m *QueryDeploymentsRequest) GetPagination() *query.PageRequest { // QueryDeploymentsResponse is response type for the Query/Deployments RPC method type QueryDeploymentsResponse struct { + // Deployments is a list of Deployments. Deployments DeploymentResponses `protobuf:"bytes,1,rep,name=deployments,proto3,castrepeated=DeploymentResponses" json:"deployments"` - Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` + // Pagination contains the information about response pagination. + Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } func (m *QueryDeploymentsResponse) Reset() { *m = QueryDeploymentsResponse{} } @@ -139,8 +143,9 @@ func (m *QueryDeploymentsResponse) GetPagination() *query.PageResponse { return nil } -// QueryDeploymentRequest is request type for the Query/Deployment RPC method +// QueryDeploymentRequest is request type for the Query/Deployment RPC method. type QueryDeploymentRequest struct { + // Id is the unique identifier of the deployment. ID v1.DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` } @@ -186,9 +191,14 @@ func (m *QueryDeploymentRequest) GetID() v1.DeploymentID { // QueryDeploymentResponse is response type for the Query/Deployment RPC method type QueryDeploymentResponse struct { - Deployment v1.Deployment `protobuf:"bytes,1,opt,name=deployment,proto3" json:"deployment" yaml:"deployment"` - Groups Groups `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=Groups" json:"groups" yaml:"groups"` - EscrowAccount v11.Account `protobuf:"bytes,3,opt,name=escrow_account,json=escrowAccount,proto3" json:"escrow_account"` + // Deployment represents a deployment on the network. + Deployment v1.Deployment `protobuf:"bytes,1,opt,name=deployment,proto3" json:"deployment" yaml:"deployment"` + // Groups is a list of deployment groups. + Groups Groups `protobuf:"bytes,2,rep,name=groups,proto3,castrepeated=Groups" json:"groups" yaml:"groups"` + // EscrowAccount represents an escrow mechanism where funds are held. + // This ensures that obligations of both tenants and providers involved in the + // transaction are met without direct access to each other's accounts. + EscrowAccount v11.Account `protobuf:"bytes,3,opt,name=escrow_account,json=escrowAccount,proto3" json:"escrow_account"` } func (m *QueryDeploymentResponse) Reset() { *m = QueryDeploymentResponse{} } @@ -245,8 +255,9 @@ func (m *QueryDeploymentResponse) GetEscrowAccount() v11.Account { return v11.Account{} } -// QueryGroupRequest is request type for the Query/Group RPC method +// QueryGroupRequest is request type for the Query/Group RPC method. type QueryGroupRequest struct { + // Id is the unique identifer of the Group. ID v1.GroupID `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` } @@ -290,8 +301,9 @@ func (m *QueryGroupRequest) GetID() v1.GroupID { return v1.GroupID{} } -// QueryGroupResponse is response type for the Query/Group RPC method +// QueryGroupResponse is response type for the Query/Group RPC method. type QueryGroupResponse struct { + // Group holds a deployment Group. Group Group `protobuf:"bytes,1,opt,name=group,proto3" json:"group"` } @@ -497,11 +509,11 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type QueryClient interface { - // Deployments queries deployments + // Deployments queries deployments. Deployments(ctx context.Context, in *QueryDeploymentsRequest, opts ...grpc.CallOption) (*QueryDeploymentsResponse, error) - // Deployment queries deployment details + // Deployment queries deployment details. Deployment(ctx context.Context, in *QueryDeploymentRequest, opts ...grpc.CallOption) (*QueryDeploymentResponse, error) - // Group queries group details + // Group queries group details. Group(ctx context.Context, in *QueryGroupRequest, opts ...grpc.CallOption) (*QueryGroupResponse, error) // Params returns the total set of minting parameters. Params(ctx context.Context, in *QueryParamsRequest, opts ...grpc.CallOption) (*QueryParamsResponse, error) @@ -553,11 +565,11 @@ func (c *queryClient) Params(ctx context.Context, in *QueryParamsRequest, opts . // QueryServer is the server API for Query service. type QueryServer interface { - // Deployments queries deployments + // Deployments queries deployments. Deployments(context.Context, *QueryDeploymentsRequest) (*QueryDeploymentsResponse, error) - // Deployment queries deployment details + // Deployment queries deployment details. Deployment(context.Context, *QueryDeploymentRequest) (*QueryDeploymentResponse, error) - // Group queries group details + // Group queries group details. Group(context.Context, *QueryGroupRequest) (*QueryGroupResponse, error) // Params returns the total set of minting parameters. Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error) diff --git a/go/node/deployment/v1beta4/resourceunit.pb.go b/go/node/deployment/v1beta4/resourceunit.pb.go index 179b0d33..0f4e49bb 100644 --- a/go/node/deployment/v1beta4/resourceunit.pb.go +++ b/go/node/deployment/v1beta4/resourceunit.pb.go @@ -25,11 +25,14 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// ResourceUnit extends Resources and adds Count along with the Price +// ResourceUnit extends Resources and adds Count along with the Price. type ResourceUnit struct { + // Resource holds the amount of resources. v1beta4.Resources `protobuf:"bytes,1,opt,name=resource,proto3,embedded=resource" json:"resource" yaml:"resource"` - Count uint32 `protobuf:"varint,2,opt,name=count,proto3" json:"count" yaml:"count"` - Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` + // Count corresponds to the amount of replicas to run of the resources. + Count uint32 `protobuf:"varint,2,opt,name=count,proto3" json:"count" yaml:"count"` + // Price holds the pricing for the resource units. + Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` } func (m *ResourceUnit) Reset() { *m = ResourceUnit{} } diff --git a/go/node/deployment/v1beta4/service.pb.go b/go/node/deployment/v1beta4/service.pb.go index 6d6468e4..15a463be 100644 --- a/go/node/deployment/v1beta4/service.pb.go +++ b/go/node/deployment/v1beta4/service.pb.go @@ -72,7 +72,7 @@ const _ = grpc.SupportPackageIsVersion4 type MsgClient interface { // CreateDeployment defines a method to create new deployment given proper inputs. CreateDeployment(ctx context.Context, in *MsgCreateDeployment, opts ...grpc.CallOption) (*MsgCreateDeploymentResponse, error) - // DepositDeployment deposits more funds into the deployment account + // DepositDeployment deposits more funds into the deployment account. DepositDeployment(ctx context.Context, in *v1.MsgDepositDeployment, opts ...grpc.CallOption) (*v1.MsgDepositDeploymentResponse, error) // UpdateDeployment defines a method to update a deployment given proper inputs. UpdateDeployment(ctx context.Context, in *MsgUpdateDeployment, opts ...grpc.CallOption) (*MsgUpdateDeploymentResponse, error) @@ -175,7 +175,7 @@ func (c *msgClient) UpdateParams(ctx context.Context, in *MsgUpdateParams, opts type MsgServer interface { // CreateDeployment defines a method to create new deployment given proper inputs. CreateDeployment(context.Context, *MsgCreateDeployment) (*MsgCreateDeploymentResponse, error) - // DepositDeployment deposits more funds into the deployment account + // DepositDeployment deposits more funds into the deployment account. DepositDeployment(context.Context, *v1.MsgDepositDeployment) (*v1.MsgDepositDeploymentResponse, error) // UpdateDeployment defines a method to update a deployment given proper inputs. UpdateDeployment(context.Context, *MsgUpdateDeployment) (*MsgUpdateDeploymentResponse, error) diff --git a/go/node/escrow/v1/account.pb.go b/go/node/escrow/v1/account.pb.go index b683bbb6..cf63eb71 100644 --- a/go/node/escrow/v1/account.pb.go +++ b/go/node/escrow/v1/account.pb.go @@ -25,17 +25,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State stores state for an escrow account +// State stores state for an escrow account. type Account_State int32 const ( - // AccountStateInvalid is an invalid state + // AccountStateInvalid is an invalid state. AccountStateInvalid Account_State = 0 - // AccountOpen is the state when an account is open + // AccountOpen is the state when an account is open. AccountOpen Account_State = 1 - // AccountClosed is the state when an account is closed + // AccountClosed is the state when an account is closed. AccountClosed Account_State = 2 - // AccountOverdrawn is the state when an account is overdrawn + // AccountOverdrawn is the state when an account is overdrawn. AccountOverdrawn Account_State = 3 ) @@ -61,21 +61,29 @@ func (Account_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_6835c04008686422, []int{0, 0} } -// Account stores state for an escrow account +// Account stores state for an escrow account. type Account struct { - // unique identifier for this escrow account + // Id is the unique identifier for an escrow account. ID AccountID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - // bech32 encoded account address of the owner of this escrow account + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner" yaml:"owner"` - // current state of this escrow account + // State represents the current state of an Account. State Account_State `protobuf:"varint,3,opt,name=state,proto3,enum=akash.escrow.v1.Account_State" json:"state" yaml:"state"` - // unspent coins received from the owner's wallet + // Balance holds the unspent coins received from the owner's wallet. Balance types.DecCoin `protobuf:"bytes,4,opt,name=balance,proto3" json:"balance" yaml:"balance"` - // total coins spent by this account + // Transferred total coins spent by this account. Transferred types.DecCoin `protobuf:"bytes,5,opt,name=transferred,proto3" json:"transferred" yaml:"transferred"` - // block height at which this account was last settled + // SettledAt represents the block height at which this account was last settled. SettledAt int64 `protobuf:"varint,6,opt,name=settled_at,json=settledAt,proto3" json:"settledAt" yaml:"settledAt"` - // bech32 encoded account address of the depositor. + // Depositor is the bech32 address of the depositor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." // If depositor is same as the owner, then any incoming coins are added to the Balance. // If depositor isn't same as the owner, then any incoming coins are added to the Funds. Depositor string `protobuf:"bytes,7,opt,name=depositor,proto3" json:"depositor" yaml:"depositor"` diff --git a/go/node/escrow/v1/accountid.pb.go b/go/node/escrow/v1/accountid.pb.go index 2722a483..c4de2fd6 100644 --- a/go/node/escrow/v1/accountid.pb.go +++ b/go/node/escrow/v1/accountid.pb.go @@ -23,10 +23,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// AccountID is the account identifier +// AccountID is the account identifier. type AccountID struct { + // Scope holds the scope of the account. Scope string `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope" yaml:"scope"` - XID string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid" yaml:"xid"` + // Xid TODO: What is this? + XID string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid" yaml:"xid"` } func (m *AccountID) Reset() { *m = AccountID{} } diff --git a/go/node/escrow/v1/fractional_payment.pb.go b/go/node/escrow/v1/fractional_payment.pb.go index d8e51b25..75f0d8ab 100644 --- a/go/node/escrow/v1/fractional_payment.pb.go +++ b/go/node/escrow/v1/fractional_payment.pb.go @@ -29,13 +29,13 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package type FractionalPayment_State int32 const ( - // PaymentStateInvalid is the state when the payment is invalid + // PaymentStateInvalid is the state when the payment is invalid. PaymentStateInvalid FractionalPayment_State = 0 - // PaymentStateOpen is the state when the payment is open + // PaymentStateOpen is the state when the payment is open. PaymentOpen FractionalPayment_State = 1 - // PaymentStateClosed is the state when the payment is closed + // PaymentStateClosed is the state when the payment is closed. PaymentClosed FractionalPayment_State = 2 - // PaymentStateOverdrawn is the state when the payment is overdrawn + // PaymentStateOverdrawn is the state when the payment is overdrawn. PaymentOverdrawn FractionalPayment_State = 3 ) @@ -61,15 +61,26 @@ func (FractionalPayment_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_deaabcd18f9ef7ba, []int{0, 0} } -// Payment stores state for a payment +// FractionalPayment stores state for a payment. type FractionalPayment struct { - AccountID AccountID `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"accountID" yaml:"accountID"` - PaymentID string `protobuf:"bytes,2,opt,name=payment_id,json=paymentId,proto3" json:"paymentID" yaml:"paymentID"` - Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner" yaml:"owner"` - State FractionalPayment_State `protobuf:"varint,4,opt,name=state,proto3,enum=akash.escrow.v1.FractionalPayment_State" json:"state" yaml:"state"` - Rate types.DecCoin `protobuf:"bytes,5,opt,name=rate,proto3" json:"rate" yaml:"rate"` - Balance types.DecCoin `protobuf:"bytes,6,opt,name=balance,proto3" json:"balance" yaml:"balance"` - Withdrawn types.Coin `protobuf:"bytes,7,opt,name=withdrawn,proto3" json:"withdrawn" yaml:"withdrawn"` + // AccountId is the unique identifier for the account. + AccountID AccountID `protobuf:"bytes,1,opt,name=account_id,json=accountId,proto3" json:"accountID" yaml:"accountID"` + // PaymentId is the unique identifier for the payment. + PaymentID string `protobuf:"bytes,2,opt,name=payment_id,json=paymentId,proto3" json:"paymentID" yaml:"paymentID"` + // Owner is the bech32 address of the payment. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // State represents the state of the FractionalPayment. + State FractionalPayment_State `protobuf:"varint,4,opt,name=state,proto3,enum=akash.escrow.v1.FractionalPayment_State" json:"state" yaml:"state"` + // Rate holds the rate of the FractionalPayment. + Rate types.DecCoin `protobuf:"bytes,5,opt,name=rate,proto3" json:"rate" yaml:"rate"` + // Balance is the current available balance. + Balance types.DecCoin `protobuf:"bytes,6,opt,name=balance,proto3" json:"balance" yaml:"balance"` + // Withdrawn is the amount of coins withdrawn by the FractionalPayment. + Withdrawn types.Coin `protobuf:"bytes,7,opt,name=withdrawn,proto3" json:"withdrawn" yaml:"withdrawn"` } func (m *FractionalPayment) Reset() { *m = FractionalPayment{} } diff --git a/go/node/escrow/v1/genesis.pb.go b/go/node/escrow/v1/genesis.pb.go index b19ca9dc..2b3d91cf 100644 --- a/go/node/escrow/v1/genesis.pb.go +++ b/go/node/escrow/v1/genesis.pb.go @@ -23,9 +23,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState defines the basic genesis state used by the escrow module +// GenesisState defines the basic genesis state used by the escrow module. type GenesisState struct { - Accounts Accounts `protobuf:"bytes,1,rep,name=accounts,proto3,castrepeated=Accounts" json:"accounts" yaml:"accounts"` + // Accounts is a list of accounts on the genesis state. + Accounts Accounts `protobuf:"bytes,1,rep,name=accounts,proto3,castrepeated=Accounts" json:"accounts" yaml:"accounts"` + // Payments is a list of fractional payments. Payments FractionalPayments `protobuf:"bytes,2,rep,name=payments,proto3,castrepeated=FractionalPayments" json:"payments" yaml:"payments"` } diff --git a/go/node/escrow/v1/query.pb.go b/go/node/escrow/v1/query.pb.go index f3e81e6c..b6a343b8 100644 --- a/go/node/escrow/v1/query.pb.go +++ b/go/node/escrow/v1/query.pb.go @@ -30,12 +30,21 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// QueryAccountRequest is request type for the Query/Account RPC method +// QueryAccountRequest is request type for the Query/Account RPC method. type QueryAccountsRequest struct { - Scope string `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope,omitempty"` - Xid string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid,omitempty"` - Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"` - State string `protobuf:"bytes,4,opt,name=state,proto3" json:"state,omitempty"` + // Scope holds the scope of the account. + Scope string `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope,omitempty"` + // Xid TODO: What is this? + Xid string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid,omitempty"` + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,3,opt,name=owner,proto3" json:"owner,omitempty"` + // State represents the current state of an Account. + State string `protobuf:"bytes,4,opt,name=state,proto3" json:"state,omitempty"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,5,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -109,7 +118,9 @@ func (m *QueryAccountsRequest) GetPagination() *query.PageRequest { // QueryProvidersResponse is response type for the Query/Providers RPC method type QueryAccountsResponse struct { - Accounts Accounts `protobuf:"bytes,1,rep,name=accounts,proto3,castrepeated=Accounts" json:"accounts"` + // Accounts is a list of Account. + Accounts Accounts `protobuf:"bytes,1,rep,name=accounts,proto3,castrepeated=Accounts" json:"accounts"` + // Pagination contains the information about response pagination. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -162,11 +173,22 @@ func (m *QueryAccountsResponse) GetPagination() *query.PageResponse { // QueryPaymentRequest is request type for the Query/Payment RPC method type QueryPaymentsRequest struct { - Scope string `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope,omitempty"` - Xid string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid,omitempty"` - Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"` - Owner string `protobuf:"bytes,4,opt,name=owner,proto3" json:"owner,omitempty"` - State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"` + // Scope holds the scope of the payment. + Scope string `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope,omitempty"` + // Xid TODO: What is this? + Xid string `protobuf:"bytes,2,opt,name=xid,proto3" json:"xid,omitempty"` + // Id is the unique identifier of the payment. + Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"` + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // + // "akash1..." + Owner string `protobuf:"bytes,4,opt,name=owner,proto3" json:"owner,omitempty"` + // State represents the current state of an Account. + State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state,omitempty"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,6,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -247,7 +269,9 @@ func (m *QueryPaymentsRequest) GetPagination() *query.PageRequest { // QueryProvidersResponse is response type for the Query/Providers RPC method type QueryPaymentsResponse struct { - Payments FractionalPayments `protobuf:"bytes,1,rep,name=payments,proto3,castrepeated=FractionalPayments" json:"payments"` + // Payments is a list of fractional payments. + Payments FractionalPayments `protobuf:"bytes,1,rep,name=payments,proto3,castrepeated=FractionalPayments" json:"payments"` + // Pagination contains the information about response pagination. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -358,11 +382,11 @@ const _ = grpc.SupportPackageIsVersion4 type QueryClient interface { // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Accounts queries all accounts + // Accounts queries all accounts. Accounts(ctx context.Context, in *QueryAccountsRequest, opts ...grpc.CallOption) (*QueryAccountsResponse, error) // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Payments queries all payments + // Payments queries all payments. Payments(ctx context.Context, in *QueryPaymentsRequest, opts ...grpc.CallOption) (*QueryPaymentsResponse, error) } @@ -396,11 +420,11 @@ func (c *queryClient) Payments(ctx context.Context, in *QueryPaymentsRequest, op type QueryServer interface { // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Accounts queries all accounts + // Accounts queries all accounts. Accounts(context.Context, *QueryAccountsRequest) (*QueryAccountsResponse, error) // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Payments queries all payments + // Payments queries all payments. Payments(context.Context, *QueryPaymentsRequest) (*QueryPaymentsResponse, error) } diff --git a/go/node/gov/v1beta3/genesis.pb.go b/go/node/gov/v1beta3/genesis.pb.go index d9bd0229..0de60739 100644 --- a/go/node/gov/v1beta3/genesis.pb.go +++ b/go/node/gov/v1beta3/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis deployment instance. type GenesisState struct { + // DepositParams defines all the parameters related to deposits. DepositParams DepositParams `protobuf:"bytes,1,opt,name=deposit_params,json=depositParams,proto3" json:"deposit_params" yaml:"deposit_params"` } diff --git a/go/node/gov/v1beta3/params.pb.go b/go/node/gov/v1beta3/params.pb.go index 89a12037..d71d8d78 100644 --- a/go/node/gov/v1beta3/params.pb.go +++ b/go/node/gov/v1beta3/params.pb.go @@ -24,9 +24,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// DepositParams defines the parameters for the x/gov module +// DepositParams defines the parameters for the x/gov module. type DepositParams struct { - // min_initial_deposit_rate minimum % of TotalDeposit + // MinInitialDepositRate is the minimum % of TotalDeposit // author of the proposal must put in order for proposal tx to be committed MinInitialDepositRate github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=min_initial_deposit_rate,json=minInitialDepositRate,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"min_initial_deposit_rate" yaml:"min_initial_deposit_rate"` } diff --git a/go/node/inflation/types/v1beta2/genesis.pb.go b/go/node/inflation/types/v1beta2/genesis.pb.go index 6c2fd704..96fbb17f 100644 --- a/go/node/inflation/types/v1beta2/genesis.pb.go +++ b/go/node/inflation/types/v1beta2/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis inflation parameters. type GenesisState struct { + // Params holds parameters of the genesis of inflation. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` } diff --git a/go/node/inflation/types/v1beta2/params.pb.go b/go/node/inflation/types/v1beta2/params.pb.go index df246402..5c17594d 100644 --- a/go/node/inflation/types/v1beta2/params.pb.go +++ b/go/node/inflation/types/v1beta2/params.pb.go @@ -24,7 +24,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Params defines the parameters for the x/deployment package +// Params defines the parameters for the x/deployment package. type Params struct { // InflationDecayFactor is the number of years it takes inflation to halve. InflationDecayFactor github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=inflation_decay_factor,json=inflationDecayFactor,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"inflation_decay_factor" yaml:"inflation_decay_factor"` diff --git a/go/node/inflation/v1beta3/genesis.pb.go b/go/node/inflation/v1beta3/genesis.pb.go index dfe67572..318f67f6 100644 --- a/go/node/inflation/v1beta3/genesis.pb.go +++ b/go/node/inflation/v1beta3/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis inflation. type GenesisState struct { + // Params holds parameters of the genesis of inflation. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` } diff --git a/go/node/inflation/v1beta3/params.pb.go b/go/node/inflation/v1beta3/params.pb.go index 678be612..c0b0d41e 100644 --- a/go/node/inflation/v1beta3/params.pb.go +++ b/go/node/inflation/v1beta3/params.pb.go @@ -24,7 +24,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Params defines the parameters for the x/deployment package +// Params defines the parameters for the x/deployment package. type Params struct { // InflationDecayFactor is the number of years it takes inflation to halve. InflationDecayFactor github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=inflation_decay_factor,json=inflationDecayFactor,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"inflation_decay_factor" yaml:"inflation_decay_factor"` diff --git a/go/node/market/v1/bid.pb.go b/go/node/market/v1/bid.pb.go index f1567ab5..ca9bc6e9 100644 --- a/go/node/market/v1/bid.pb.go +++ b/go/node/market/v1/bid.pb.go @@ -24,13 +24,29 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// BidID stores owner and all other seq numbers +// BidID stores owner and all other seq numbers. // A successful bid becomes a Lease(ID). type BidID struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." Provider string `protobuf:"bytes,5,opt,name=provider,proto3" json:"provider" yaml:"provider"` } diff --git a/go/node/market/v1/event.pb.go b/go/node/market/v1/event.pb.go index 8af0e99e..8dd1b429 100644 --- a/go/node/market/v1/event.pb.go +++ b/go/node/market/v1/event.pb.go @@ -24,8 +24,10 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// EventOrderCreated +// EventOrderCreated is triggered when an order is created. +// It contains all the information required to identify an order. type EventOrderCreated struct { + // Id is the unique identifier of the Order. ID OrderID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -69,8 +71,10 @@ func (m *EventOrderCreated) GetID() OrderID { return OrderID{} } -// EventOrderClosed +// EventOrderClosed is triggered when an order is closed. +// It contains all the information required to identify an order. type EventOrderClosed struct { + // Id is the unique identifier of the Order. ID OrderID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -114,9 +118,12 @@ func (m *EventOrderClosed) GetID() OrderID { return OrderID{} } -// EventBidCreated +// EventBidCreated is triggered when a bid is created. +// It contains all the information required to identify a bid. type EventBidCreated struct { - ID BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Id is the unique identifier of the Bid. + ID BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Price stated on the Bid. Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` } @@ -167,8 +174,10 @@ func (m *EventBidCreated) GetPrice() types.DecCoin { return types.DecCoin{} } -// EventBidClosed +// EventBidClosed is triggered when a bid is closed. +// It contains all the information required to identify a bid. type EventBidClosed struct { + // Id is the unique identifier of the Bid. ID BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } @@ -212,9 +221,12 @@ func (m *EventBidClosed) GetID() BidID { return BidID{} } -// EventLeaseCreated +// EventLeaseCreated is triggered when a lease is created. +// It contains all the information required to identify a lease. type EventLeaseCreated struct { - ID LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Id is the unique identifier of the Lease. + ID LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // Price settled for the lease. Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` } @@ -265,8 +277,10 @@ func (m *EventLeaseCreated) GetPrice() types.DecCoin { return types.DecCoin{} } -// EventLeaseClosed +// EventLeaseClosed is triggered when a lease is closed. +// It contains all the information required to identify a lease. type EventLeaseClosed struct { + // Id is the unique identifier of the Lease. ID LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/market/v1/filters.pb.go b/go/node/market/v1/filters.pb.go index e5998e5f..1169e561 100644 --- a/go/node/market/v1/filters.pb.go +++ b/go/node/market/v1/filters.pb.go @@ -24,14 +24,31 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// LeaseFilters defines flags for lease list filter +// LeaseFilters defines flags for lease list filtering. type LeaseFilters struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." Provider string `protobuf:"bytes,5,opt,name=provider,proto3" json:"provider" yaml:"provider"` - State string `protobuf:"bytes,6,opt,name=state,proto3" json:"state" yaml:"state"` + // State represents the state of the lease. + State string `protobuf:"bytes,6,opt,name=state,proto3" json:"state" yaml:"state"` } func (m *LeaseFilters) Reset() { *m = LeaseFilters{} } diff --git a/go/node/market/v1/lease.pb.go b/go/node/market/v1/lease.pb.go index 4e188807..edabcc6b 100644 --- a/go/node/market/v1/lease.pb.go +++ b/go/node/market/v1/lease.pb.go @@ -25,17 +25,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State is an enum which refers to state of lease +// State is an enum which refers to state of lease. type Lease_State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. LeaseStateInvalid Lease_State = 0 - // LeaseActive denotes state for lease active + // LeaseActive denotes state for lease active. LeaseActive Lease_State = 1 - // LeaseInsufficientFunds denotes state for lease insufficient_funds + // LeaseInsufficientFunds denotes state for lease insufficient_funds. LeaseInsufficientFunds Lease_State = 2 - // LeaseClosed denotes state for lease closed + // LeaseClosed denotes state for lease closed. LeaseClosed Lease_State = 3 ) @@ -61,12 +61,28 @@ func (Lease_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_122c076f440f07dc, []int{1, 0} } -// LeaseID stores bid details of lease +// LeaseID stores bid details of lease. type LeaseID struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." Provider string `protobuf:"bytes,5,opt,name=provider,proto3" json:"provider" yaml:"provider"` } @@ -137,13 +153,21 @@ func (m *LeaseID) GetProvider() string { return "" } -// Lease stores LeaseID, state of lease and price +// Lease stores LeaseID, state of lease and price. +// The Lease defines the terms under which the provider allocates resources to fulfill +// the tenant's deployment requirements. +// Leases are paid from the tenant to the provider through a deposit and withdraw mechanism and are priced in blocks. type Lease struct { - ID LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - State Lease_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.market.v1.Lease_State" json:"state" yaml:"state"` - Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` - CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at" yaml:"created_at"` - ClosedOn int64 `protobuf:"varint,5,opt,name=closed_on,json=closedOn,proto3" json:"closed_on" yaml:"closed_on"` + // Id is the unique identifier of the Lease. + ID LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // State represents the state of the Lease. + State Lease_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.market.v1.Lease_State" json:"state" yaml:"state"` + // Price holds the settled price for the Lease. + Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` + // CreatedAt is the block height at which the Lease was created. + CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at" yaml:"created_at"` + // ClosedOn is the block height at which the Lease was closed. + ClosedOn int64 `protobuf:"varint,5,opt,name=closed_on,json=closedOn,proto3" json:"closed_on" yaml:"closed_on"` } func (m *Lease) Reset() { *m = Lease{} } diff --git a/go/node/market/v1/order.pb.go b/go/node/market/v1/order.pb.go index 34d3ea39..bc723a78 100644 --- a/go/node/market/v1/order.pb.go +++ b/go/node/market/v1/order.pb.go @@ -24,12 +24,23 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// OrderID stores owner and all other seq numbers +// OrderId stores owner and all other seq numbers. type OrderID struct { + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` } func (m *OrderID) Reset() { *m = OrderID{} } diff --git a/go/node/market/v1beta5/bid.pb.go b/go/node/market/v1beta5/bid.pb.go index 5949dd4a..50f9d417 100644 --- a/go/node/market/v1beta5/bid.pb.go +++ b/go/node/market/v1beta5/bid.pb.go @@ -25,19 +25,19 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// BidState is an enum which refers to state of bid +// BidState is an enum which refers to state of bid. type Bid_State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. BidStateInvalid Bid_State = 0 - // BidOpen denotes state for bid open + // BidOpen denotes state for bid open. BidOpen Bid_State = 1 - // BidMatched denotes state for bid open + // BidMatched denotes state for bid open. BidActive Bid_State = 2 - // BidLost denotes state for bid lost + // BidLost denotes state for bid lost. BidLost Bid_State = 3 - // BidClosed denotes state for bid closed + // BidClosed denotes state for bid closed. BidClosed Bid_State = 4 ) @@ -65,12 +65,18 @@ func (Bid_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_9a051a9ee62f13b0, []int{0, 0} } -// Bid stores BidID, state of bid and price +// Bid stores BidID, state of bid and price. type Bid struct { - ID v1.BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - State Bid_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.market.v1beta5.Bid_State" json:"state" yaml:"state"` - Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` - CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"state" yaml:"created_at"` + // BidID stores owner and all other seq numbers. + // A successful bid becomes a Lease(ID). + ID v1.BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` + // State represents the state of the Bid. + State Bid_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.market.v1beta5.Bid_State" json:"state" yaml:"state"` + // Price holds the pricing stated on the Bid. + Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` + // CreatedAt is the block height at which the Bid was created. + CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"createdAt" yaml:"created_at"` + // ResourceOffer is a list of offers. ResourcesOffer ResourcesOffer `protobuf:"bytes,5,rep,name=resources_offer,json=resourcesOffer,proto3,castrepeated=ResourcesOffer" json:"resources_offer" yaml:"resources_offer"` } @@ -149,41 +155,41 @@ func init() { func init() { proto.RegisterFile("akash/market/v1beta5/bid.proto", fileDescriptor_9a051a9ee62f13b0) } var fileDescriptor_9a051a9ee62f13b0 = []byte{ - // 536 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x52, 0x3f, 0x6f, 0xd3, 0x40, - 0x1c, 0xb5, 0x9d, 0xa4, 0xa5, 0x57, 0x48, 0x83, 0x29, 0x55, 0x62, 0x81, 0x6d, 0x99, 0x25, 0x2c, - 0x67, 0x25, 0x88, 0xa5, 0x82, 0xa1, 0x6e, 0x18, 0x22, 0x21, 0x15, 0x8c, 0x58, 0x58, 0xaa, 0x8b, - 0xef, 0x1a, 0x4e, 0x49, 0x7c, 0x91, 0xef, 0x88, 0xc4, 0x37, 0x40, 0x99, 0x90, 0x58, 0x58, 0x22, - 0x55, 0xea, 0xc6, 0x27, 0xe9, 0xd8, 0x91, 0xc9, 0xa0, 0x64, 0x41, 0x19, 0x33, 0x30, 0x23, 0xdf, - 0x99, 0x04, 0xac, 0x6c, 0xf9, 0xbd, 0x7f, 0x79, 0x7e, 0x3a, 0x60, 0xa3, 0x01, 0xe2, 0xef, 0xfd, - 0x11, 0x4a, 0x06, 0x44, 0xf8, 0x93, 0x56, 0x8f, 0x08, 0xf4, 0xd4, 0xef, 0x51, 0x0c, 0xc7, 0x09, - 0x13, 0xcc, 0x3c, 0x94, 0x3c, 0x54, 0x3c, 0xcc, 0x79, 0xeb, 0xb0, 0xcf, 0xfa, 0x4c, 0x0a, 0xfc, - 0xec, 0x97, 0xd2, 0x5a, 0x76, 0xc4, 0xf8, 0x88, 0x71, 0xbf, 0x87, 0x38, 0xc9, 0xa3, 0x5a, 0x7e, - 0xc4, 0x68, 0x9c, 0xf3, 0x8f, 0xb7, 0xfe, 0x57, 0x42, 0x38, 0xfb, 0x90, 0x44, 0x84, 0xb3, 0x8b, - 0x0b, 0x92, 0xe4, 0xd2, 0x46, 0x41, 0xba, 0x69, 0xe4, 0xfd, 0x2e, 0x83, 0x52, 0x40, 0xb1, 0xf9, - 0x02, 0x18, 0x14, 0xd7, 0x75, 0x57, 0x6f, 0xee, 0xb7, 0x8f, 0x60, 0xa1, 0x26, 0x0c, 0x28, 0xee, - 0x76, 0x82, 0x87, 0xd7, 0xa9, 0xa3, 0xcd, 0x53, 0xc7, 0xe8, 0x76, 0x96, 0xa9, 0x63, 0x50, 0xbc, - 0x4a, 0x9d, 0xbd, 0x8f, 0x68, 0x34, 0x3c, 0xf6, 0x28, 0xf6, 0x42, 0x83, 0x62, 0xf3, 0x15, 0xa8, - 0x70, 0x81, 0x04, 0xa9, 0x1b, 0xae, 0xde, 0xac, 0xb6, 0x1d, 0xb8, 0xed, 0x83, 0xb3, 0x38, 0xf8, - 0x26, 0x93, 0x05, 0x8d, 0x65, 0xea, 0x28, 0xc7, 0x2a, 0x75, 0x6e, 0xab, 0x2c, 0x79, 0x7a, 0xa1, - 0x82, 0xcd, 0xd7, 0xa0, 0x32, 0x4e, 0x68, 0x44, 0xea, 0x25, 0xd9, 0xed, 0x01, 0x54, 0xb3, 0xc0, - 0x6c, 0x96, 0x3c, 0xb0, 0x05, 0x3b, 0x24, 0x3a, 0x65, 0x34, 0x56, 0x0d, 0xb3, 0x48, 0x69, 0xd9, - 0x44, 0xca, 0xd3, 0x0b, 0x15, 0x6c, 0x3e, 0x07, 0x20, 0x4a, 0x08, 0x12, 0x04, 0x9f, 0x23, 0x51, - 0x2f, 0xbb, 0x7a, 0xb3, 0x14, 0xd8, 0xff, 0x16, 0xb9, 0xab, 0x5c, 0x1b, 0x91, 0x17, 0xee, 0xe5, - 0xc7, 0x89, 0x30, 0xaf, 0x74, 0x70, 0xb0, 0x9e, 0xf9, 0x5c, 0xee, 0x5c, 0xaf, 0xb8, 0xa5, 0xe6, - 0x7e, 0xfb, 0xd1, 0xf6, 0xcf, 0x0d, 0x73, 0xf1, 0x59, 0x26, 0x0d, 0xde, 0xe6, 0x2b, 0x56, 0xff, - 0xc2, 0x5c, 0xe2, 0xcb, 0xd4, 0x29, 0xa6, 0xae, 0x52, 0xe7, 0x48, 0x35, 0x29, 0x10, 0xde, 0xb7, - 0x1f, 0x45, 0x7b, 0x58, 0x4d, 0xfe, 0xbb, 0xbd, 0x2f, 0x3a, 0xa8, 0xc8, 0x8d, 0x4d, 0x17, 0xec, - 0xd2, 0x78, 0x82, 0x86, 0x14, 0xd7, 0x34, 0xeb, 0xde, 0x74, 0xe6, 0x1e, 0x04, 0x14, 0x4b, 0xaa, - 0xab, 0x60, 0xf3, 0x3e, 0x28, 0xb3, 0x31, 0x89, 0x6b, 0xba, 0xb5, 0x3f, 0x9d, 0xb9, 0xbb, 0x01, - 0xc5, 0x67, 0x63, 0x12, 0x9b, 0x0d, 0xb0, 0x83, 0x22, 0x41, 0x27, 0xa4, 0x66, 0x58, 0x77, 0xa6, - 0x33, 0x77, 0x2f, 0xa0, 0xf8, 0x44, 0x02, 0x99, 0x63, 0xc8, 0xb8, 0xa8, 0x95, 0xd6, 0x8e, 0x97, - 0x8c, 0x8b, 0xcc, 0x11, 0x0d, 0x19, 0x27, 0xb8, 0x56, 0x5e, 0x3b, 0x4e, 0x25, 0x60, 0x95, 0x3f, - 0x5d, 0xd9, 0xda, 0xf1, 0xad, 0xaf, 0x97, 0x8e, 0xf6, 0xeb, 0xd2, 0xd1, 0x82, 0x67, 0xd7, 0x73, - 0x5b, 0xbf, 0x99, 0xdb, 0xfa, 0xcf, 0xb9, 0xad, 0x7f, 0x5e, 0xd8, 0xda, 0xcd, 0xc2, 0xd6, 0xbe, - 0x2f, 0x6c, 0xed, 0x9d, 0x37, 0x1e, 0xf4, 0x21, 0x1a, 0x08, 0x88, 0xc9, 0xc4, 0xef, 0x33, 0x3f, - 0x66, 0x98, 0x14, 0x9e, 0x79, 0x6f, 0x47, 0xbe, 0xde, 0x27, 0x7f, 0x02, 0x00, 0x00, 0xff, 0xff, - 0x8e, 0x2a, 0xbe, 0xba, 0x71, 0x03, 0x00, 0x00, + // 539 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x6c, 0x52, 0x3d, 0x6f, 0xd3, 0x40, + 0x00, 0xb5, 0x9d, 0xa4, 0xa5, 0x57, 0x48, 0x83, 0x29, 0x55, 0x62, 0x81, 0xcf, 0x32, 0x4b, 0x58, + 0xce, 0x4a, 0x10, 0x4b, 0xc5, 0x12, 0x37, 0x0c, 0x91, 0x90, 0x0a, 0x46, 0x2c, 0x2c, 0xd5, 0xc5, + 0x77, 0x0d, 0xa7, 0x24, 0xbe, 0xc8, 0x3e, 0x22, 0xf1, 0x0f, 0x50, 0x26, 0x24, 0x16, 0x96, 0x48, + 0x95, 0xba, 0xf1, 0x4b, 0x3a, 0x76, 0x64, 0x32, 0x28, 0x59, 0x50, 0xc6, 0x8c, 0x4c, 0xc8, 0x77, + 0x26, 0x11, 0x56, 0x36, 0xdf, 0xfb, 0xf2, 0xbb, 0xa7, 0x03, 0x36, 0x1e, 0xe2, 0xe4, 0x83, 0x37, + 0xc6, 0xf1, 0x90, 0x0a, 0x6f, 0xda, 0xea, 0x53, 0x81, 0x9f, 0x7b, 0x7d, 0x46, 0xd0, 0x24, 0xe6, + 0x82, 0x9b, 0xc7, 0x92, 0x47, 0x8a, 0x47, 0x39, 0x6f, 0x1d, 0x0f, 0xf8, 0x80, 0x4b, 0x81, 0x97, + 0x7d, 0x29, 0xad, 0x65, 0x87, 0x3c, 0x19, 0xf3, 0xc4, 0xeb, 0xe3, 0x84, 0xe6, 0x51, 0x2d, 0x2f, + 0xe4, 0x2c, 0xca, 0xf9, 0xa7, 0x3b, 0xff, 0x15, 0xd3, 0x84, 0x7f, 0x8c, 0x43, 0x9a, 0xf0, 0xcb, + 0x4b, 0x1a, 0xe7, 0xd2, 0x46, 0x41, 0xba, 0x6d, 0xe4, 0xfe, 0x29, 0x83, 0x92, 0xcf, 0x88, 0xf9, + 0x12, 0x18, 0x8c, 0xd4, 0x75, 0x47, 0x6f, 0x1e, 0xb6, 0x4f, 0x50, 0xa1, 0x26, 0xf2, 0x19, 0xe9, + 0x75, 0xfd, 0xc7, 0x37, 0x29, 0xd4, 0x16, 0x29, 0x34, 0x7a, 0xdd, 0x55, 0x0a, 0x0d, 0x46, 0xd6, + 0x29, 0x3c, 0xf8, 0x84, 0xc7, 0xa3, 0x53, 0x97, 0x11, 0x37, 0x30, 0x18, 0x31, 0x5f, 0x83, 0x4a, + 0x22, 0xb0, 0xa0, 0x75, 0xc3, 0xd1, 0x9b, 0xd5, 0x36, 0x44, 0xbb, 0x2e, 0x9c, 0xc5, 0xa1, 0xb7, + 0x99, 0xcc, 0x6f, 0xac, 0x52, 0xa8, 0x1c, 0xeb, 0x14, 0xde, 0x55, 0x59, 0xf2, 0xe8, 0x06, 0x0a, + 0x36, 0xdf, 0x80, 0xca, 0x24, 0x66, 0x21, 0xad, 0x97, 0x64, 0xb7, 0x47, 0x48, 0xcd, 0x82, 0xb2, + 0x59, 0xf2, 0xc0, 0x16, 0xea, 0xd2, 0xf0, 0x8c, 0xb3, 0x48, 0x35, 0xcc, 0x22, 0xa5, 0x65, 0x1b, + 0x29, 0x8f, 0x6e, 0xa0, 0x60, 0xb3, 0x03, 0x40, 0x18, 0x53, 0x2c, 0x28, 0xb9, 0xc0, 0xa2, 0x5e, + 0x76, 0xf4, 0x66, 0xc9, 0x77, 0x57, 0x29, 0x3c, 0xc8, 0xd1, 0x8e, 0x58, 0xa7, 0xf0, 0xbe, 0x72, + 0x6e, 0x85, 0x6e, 0xb0, 0xe5, 0xcd, 0x6b, 0x1d, 0x1c, 0x6d, 0xa6, 0xbe, 0x90, 0x5b, 0xd7, 0x2b, + 0x4e, 0xa9, 0x79, 0xd8, 0x7e, 0xb2, 0xfb, 0xca, 0x41, 0x2e, 0x3e, 0xcf, 0xa4, 0xfe, 0xbb, 0x7c, + 0xc9, 0xea, 0x3f, 0x38, 0x91, 0xf8, 0x2a, 0x85, 0xc5, 0xd4, 0x75, 0x0a, 0x4f, 0x54, 0x93, 0x02, + 0xe1, 0x7e, 0xff, 0x59, 0xb4, 0x07, 0xd5, 0xf8, 0xbf, 0xb3, 0xfb, 0x55, 0x07, 0x15, 0xb9, 0xb3, + 0xe9, 0x80, 0x7d, 0x16, 0x4d, 0xf1, 0x88, 0x91, 0x9a, 0x66, 0x3d, 0x98, 0xcd, 0x9d, 0x23, 0x9f, + 0x11, 0x49, 0xf5, 0x14, 0x6c, 0x3e, 0x04, 0x65, 0x3e, 0xa1, 0x51, 0x4d, 0xb7, 0x0e, 0x67, 0x73, + 0x67, 0xdf, 0x67, 0xe4, 0x7c, 0x42, 0x23, 0xb3, 0x01, 0xf6, 0x70, 0x28, 0xd8, 0x94, 0xd6, 0x0c, + 0xeb, 0xde, 0x6c, 0xee, 0x1c, 0xf8, 0x8c, 0x74, 0x24, 0x90, 0x39, 0x46, 0x3c, 0x11, 0xb5, 0xd2, + 0xc6, 0xf1, 0x8a, 0x27, 0x22, 0x73, 0x84, 0x23, 0x9e, 0x50, 0x52, 0x2b, 0x6f, 0x1c, 0x67, 0x12, + 0xb0, 0xca, 0x9f, 0xaf, 0x6d, 0xed, 0xf4, 0xce, 0xb7, 0x2b, 0xa8, 0xfd, 0xbe, 0x82, 0x9a, 0xff, + 0xe2, 0x66, 0x61, 0xeb, 0xb7, 0x0b, 0x5b, 0xff, 0xb5, 0xb0, 0xf5, 0x2f, 0x4b, 0x5b, 0xbb, 0x5d, + 0xda, 0xda, 0x8f, 0xa5, 0xad, 0xbd, 0x77, 0x27, 0xc3, 0x01, 0xc2, 0x43, 0x81, 0x08, 0x9d, 0x7a, + 0x03, 0xee, 0x45, 0x9c, 0xd0, 0xc2, 0x53, 0xef, 0xef, 0xc9, 0x17, 0xfc, 0xec, 0x6f, 0x00, 0x00, + 0x00, 0xff, 0xff, 0xfa, 0x36, 0x4f, 0x1f, 0x75, 0x03, 0x00, 0x00, } func (m *Bid) Marshal() (dAtA []byte, err error) { diff --git a/go/node/market/v1beta5/bidmsg.pb.go b/go/node/market/v1beta5/bidmsg.pb.go index 775d70e5..afc3e49a 100644 --- a/go/node/market/v1beta5/bidmsg.pb.go +++ b/go/node/market/v1beta5/bidmsg.pb.go @@ -27,12 +27,21 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgCreateBid defines an SDK message for creating Bid +// MsgCreateBid defines an SDK message for creating Bid. type MsgCreateBid struct { - OrderID v1.OrderID `protobuf:"bytes,1,opt,name=order_id,json=orderId,proto3" json:"order_id" yaml:"order_id"` - Provider string `protobuf:"bytes,2,opt,name=provider,proto3" json:"provider" yaml:"provider"` - Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` - Deposit types.Coin `protobuf:"bytes,4,opt,name=deposit,proto3" json:"deposit" yaml:"deposit"` + // OrderId is the unique identifier for the order. + OrderID v1.OrderID `protobuf:"bytes,1,opt,name=order_id,json=orderId,proto3" json:"order_id" yaml:"order_id"` + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." + Provider string `protobuf:"bytes,2,opt,name=provider,proto3" json:"provider" yaml:"provider"` + // Price holds the pricing stated on the Bid. + Price types.DecCoin `protobuf:"bytes,3,opt,name=price,proto3" json:"price" yaml:"price"` + // Deposit holds the amount of coins to deposit. + Deposit types.Coin `protobuf:"bytes,4,opt,name=deposit,proto3" json:"deposit" yaml:"deposit"` + // ResourceOffer is a list of resource offers. ResourcesOffer ResourcesOffer `protobuf:"bytes,5,rep,name=resources_offer,json=resourcesOffer,proto3,castrepeated=ResourcesOffer" json:"resources_offer" yaml:"resources_offer"` } @@ -141,8 +150,9 @@ func (m *MsgCreateBidResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgCreateBidResponse proto.InternalMessageInfo -// MsgCloseBid defines an SDK message for closing bid +// MsgCloseBid defines an SDK message for closing bid. type MsgCloseBid struct { + // Id is the unique identifier of the Bid. ID v1.BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` } diff --git a/go/node/market/v1beta5/filters.pb.go b/go/node/market/v1beta5/filters.pb.go index 07681336..f3d88ad6 100644 --- a/go/node/market/v1beta5/filters.pb.go +++ b/go/node/market/v1beta5/filters.pb.go @@ -24,14 +24,31 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// BidFilters defines flags for bid list filter +// BidFilters defines flags for bid list filter. type BidFilters struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." Provider string `protobuf:"bytes,5,opt,name=provider,proto3" json:"provider" yaml:"provider"` - State string `protobuf:"bytes,6,opt,name=state,proto3" json:"state" yaml:"state"` + // State represents the state of the lease. + State string `protobuf:"bytes,6,opt,name=state,proto3" json:"state" yaml:"state"` } func (m *BidFilters) Reset() { *m = BidFilters{} } @@ -111,10 +128,23 @@ func (m *BidFilters) GetState() string { // OrderFilters defines flags for order list filter type OrderFilters struct { + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` - GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` - OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + DSeq uint64 `protobuf:"varint,2,opt,name=dseq,proto3" json:"dseq" yaml:"dseq"` + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + GSeq uint32 `protobuf:"varint,3,opt,name=gseq,proto3" json:"gseq" yaml:"gseq"` + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + OSeq uint32 `protobuf:"varint,4,opt,name=oseq,proto3" json:"oseq" yaml:"oseq"` + // State represents the state of the lease. State string `protobuf:"bytes,5,opt,name=state,proto3" json:"state" yaml:"state"` } diff --git a/go/node/market/v1beta5/genesis.pb.go b/go/node/market/v1beta5/genesis.pb.go index 76201ba6..86410ebc 100644 --- a/go/node/market/v1beta5/genesis.pb.go +++ b/go/node/market/v1beta5/genesis.pb.go @@ -25,12 +25,16 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState defines the basic genesis state used by market module +// GenesisState defines the basic genesis state used by market module. type GenesisState struct { - Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` - Orders Orders `protobuf:"bytes,2,rep,name=orders,proto3,castrepeated=Orders" json:"orders" yaml:"orders"` + // Params holds parameters of the genesis of market. + Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` + // Orders is a list of orders in the genesis state. + Orders Orders `protobuf:"bytes,2,rep,name=orders,proto3,castrepeated=Orders" json:"orders" yaml:"orders"` + // Leases is a list of leases in the genesis state. Leases pkg_akt_dev_go_node_market_v1.Leases `protobuf:"bytes,3,rep,name=leases,proto3,castrepeated=pkg.akt.dev/go/node/market/v1.Leases" json:"leases" yaml:"leases"` - Bids Bids `protobuf:"bytes,4,rep,name=bids,proto3,castrepeated=Bids" json:"bids" yaml:"bids"` + // Bids is a list of bids in the genesis state. + Bids Bids `protobuf:"bytes,4,rep,name=bids,proto3,castrepeated=Bids" json:"bids" yaml:"bids"` } func (m *GenesisState) Reset() { *m = GenesisState{} } diff --git a/go/node/market/v1beta5/leasemsg.pb.go b/go/node/market/v1beta5/leasemsg.pb.go index 39bd3017..d80db6a1 100644 --- a/go/node/market/v1beta5/leasemsg.pb.go +++ b/go/node/market/v1beta5/leasemsg.pb.go @@ -25,8 +25,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgCreateLease is sent to create a lease +// MsgCreateLease is sent to create a lease. type MsgCreateLease struct { + // BidId is the unique identifier of the Bid. BidID v1.BidID `protobuf:"bytes,1,opt,name=bid_id,json=bidId,proto3" json:"id" yaml:"id"` } @@ -70,7 +71,7 @@ func (m *MsgCreateLease) GetBidID() v1.BidID { return v1.BidID{} } -// MsgCreateLeaseResponse is the response from creating a lease +// MsgCreateLeaseResponse is the response from creating a lease. type MsgCreateLeaseResponse struct { } @@ -107,8 +108,9 @@ func (m *MsgCreateLeaseResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgCreateLeaseResponse proto.InternalMessageInfo -// MsgWithdrawLease defines an SDK message for withdrawing lease funds +// MsgWithdrawLease defines an SDK message for withdrawing lease funds. type MsgWithdrawLease struct { + // BidId is the unique identifier of the Bid. ID v1.LeaseID `protobuf:"bytes,1,opt,name=bid_id,json=bidId,proto3" json:"id" yaml:"id"` } @@ -189,8 +191,9 @@ func (m *MsgWithdrawLeaseResponse) XXX_DiscardUnknown() { var xxx_messageInfo_MsgWithdrawLeaseResponse proto.InternalMessageInfo -// MsgCloseLease defines an SDK message for closing order +// MsgCloseLease defines an SDK message for closing order. type MsgCloseLease struct { + // BidId is the unique identifier of the Bid. ID v1.LeaseID `protobuf:"bytes,1,opt,name=lease_id,json=leaseId,proto3" json:"id" yaml:"id"` } diff --git a/go/node/market/v1beta5/order.pb.go b/go/node/market/v1beta5/order.pb.go index 5f099d08..f379ded5 100644 --- a/go/node/market/v1beta5/order.pb.go +++ b/go/node/market/v1beta5/order.pb.go @@ -25,17 +25,17 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State is an enum which refers to state of order +// State is an enum which refers to state of order. type Order_State int32 const ( - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. OrderStateInvalid Order_State = 0 - // OrderOpen denotes state for order open + // OrderOpen denotes state for order open. OrderOpen Order_State = 1 - // OrderMatched denotes state for order matched + // OrderMatched denotes state for order matched. OrderActive Order_State = 2 - // OrderClosed denotes state for order lost + // OrderClosed denotes state for order lost. OrderClosed Order_State = 3 ) @@ -61,8 +61,9 @@ func (Order_State) EnumDescriptor() ([]byte, []int) { return fileDescriptor_a72454f2c693d67f, []int{0, 0} } -// Order stores orderID, state of order and other details +// Order stores orderID, state of order and other details. type Order struct { + // Id is the unique identifier of the order. ID v1.OrderID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` State Order_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.market.v1beta5.Order_State" json:"state" yaml:"state"` Spec v1beta4.GroupSpec `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec" yaml:"spec"` diff --git a/go/node/market/v1beta5/params.pb.go b/go/node/market/v1beta5/params.pb.go index 2efe7cee..c8c5fb94 100644 --- a/go/node/market/v1beta5/params.pb.go +++ b/go/node/market/v1beta5/params.pb.go @@ -24,10 +24,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Params is the params for the x/market module +// Params is the params for the x/market module. type Params struct { + // BidMinDeposit is a parameter for the minimum deposit on a Bid. BidMinDeposit types.Coin `protobuf:"bytes,1,opt,name=bid_min_deposit,json=bidMinDeposit,proto3" json:"bid_min_deposit" yaml:"bid_min_deposit"` - OrderMaxBids uint32 `protobuf:"varint,2,opt,name=order_max_bids,json=orderMaxBids,proto3" json:"order_max_bids" yaml:"order_max_bids"` + // OrderMaxBids is a parameter for the maximum number of bids in an order. + OrderMaxBids uint32 `protobuf:"varint,2,opt,name=order_max_bids,json=orderMaxBids,proto3" json:"order_max_bids" yaml:"order_max_bids"` } func (m *Params) Reset() { *m = Params{} } diff --git a/go/node/market/v1beta5/query.pb.go b/go/node/market/v1beta5/query.pb.go index ba1fd095..1d426df6 100644 --- a/go/node/market/v1beta5/query.pb.go +++ b/go/node/market/v1beta5/query.pb.go @@ -33,9 +33,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// QueryOrdersRequest is request type for the Query/Orders RPC method +// QueryOrdersRequest is request type for the Query/Orders RPC method. type QueryOrdersRequest struct { - Filters OrderFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Filters holds the fields to filter orders. + Filters OrderFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -88,7 +90,9 @@ func (m *QueryOrdersRequest) GetPagination() *query.PageRequest { // QueryOrdersResponse is response type for the Query/Orders RPC method type QueryOrdersResponse struct { - Orders Orders `protobuf:"bytes,1,rep,name=orders,proto3,castrepeated=Orders" json:"orders"` + // Orders is a list of market orders. + Orders Orders `protobuf:"bytes,1,rep,name=orders,proto3,castrepeated=Orders" json:"orders"` + // Pagination contains the information about response pagination. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -139,8 +143,9 @@ func (m *QueryOrdersResponse) GetPagination() *query.PageResponse { return nil } -// QueryOrderRequest is request type for the Query/Order RPC method +// QueryOrderRequest is request type for the Query/Order RPC method. type QueryOrderRequest struct { + // Id is the unique identifier of the Order. ID v1.OrderID `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` } @@ -184,8 +189,9 @@ func (m *QueryOrderRequest) GetID() v1.OrderID { return v1.OrderID{} } -// QueryOrderResponse is response type for the Query/Order RPC method +// QueryOrderResponse is response type for the Query/Order RPC method. type QueryOrderResponse struct { + // Order represents a market order. Order Order `protobuf:"bytes,1,opt,name=order,proto3" json:"order"` } @@ -229,9 +235,11 @@ func (m *QueryOrderResponse) GetOrder() Order { return Order{} } -// QueryBidsRequest is request type for the Query/Bids RPC method +// QueryBidsRequest is request type for the Query/Bids RPC method. type QueryBidsRequest struct { - Filters BidFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Filters holds the fields to filter bids. + Filters BidFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -284,7 +292,9 @@ func (m *QueryBidsRequest) GetPagination() *query.PageRequest { // QueryBidsResponse is response type for the Query/Bids RPC method type QueryBidsResponse struct { - Bids []QueryBidResponse `protobuf:"bytes,1,rep,name=bids,proto3" json:"bids"` + // Bids is a list of deployment bids. + Bids []QueryBidResponse `protobuf:"bytes,1,rep,name=bids,proto3" json:"bids"` + // Pagination contains the information about response pagination. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -335,8 +345,9 @@ func (m *QueryBidsResponse) GetPagination() *query.PageResponse { return nil } -// QueryBidRequest is request type for the Query/Bid RPC method +// QueryBidRequest is request type for the Query/Bid RPC method. type QueryBidRequest struct { + // Id is the unique identifier for the Bid. ID v1.BidID `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` } @@ -380,9 +391,11 @@ func (m *QueryBidRequest) GetID() v1.BidID { return v1.BidID{} } -// QueryBidResponse is response type for the Query/Bid RPC method +// QueryBidResponse is response type for the Query/Bid RPC method. type QueryBidResponse struct { - Bid Bid `protobuf:"bytes,1,opt,name=bid,proto3" json:"bid"` + // Bid represents a deployment bid. + Bid Bid `protobuf:"bytes,1,opt,name=bid,proto3" json:"bid"` + // EscrowAccount represents the escrow account created for the Bid. EscrowAccount v11.Account `protobuf:"bytes,2,opt,name=escrow_account,json=escrowAccount,proto3" json:"escrow_account"` } @@ -433,9 +446,11 @@ func (m *QueryBidResponse) GetEscrowAccount() v11.Account { return v11.Account{} } -// QueryLeasesRequest is request type for the Query/Leases RPC method +// QueryLeasesRequest is request type for the Query/Leases RPC method. type QueryLeasesRequest struct { - Filters v1.LeaseFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Filters holds the fields to filter leases. + Filters v1.LeaseFilters `protobuf:"bytes,1,opt,name=filters,proto3" json:"filters"` + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -486,10 +501,12 @@ func (m *QueryLeasesRequest) GetPagination() *query.PageRequest { return nil } -// QueryLeasesResponse is response type for the Query/Leases RPC method +// QueryLeasesResponse is response type for the Query/Leases RPC method. type QueryLeasesResponse struct { - Leases []QueryLeaseResponse `protobuf:"bytes,1,rep,name=leases,proto3" json:"leases"` - Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` + // Leases is a list of Lease. + Leases []QueryLeaseResponse `protobuf:"bytes,1,rep,name=leases,proto3" json:"leases"` + // Pagination contains the information about response pagination. + Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } func (m *QueryLeasesResponse) Reset() { *m = QueryLeasesResponse{} } @@ -539,8 +556,9 @@ func (m *QueryLeasesResponse) GetPagination() *query.PageResponse { return nil } -// QueryLeaseRequest is request type for the Query/Lease RPC method +// QueryLeaseRequest is request type for the Query/Lease RPC method. type QueryLeaseRequest struct { + // Id is the unique identifier of the Lease. ID v1.LeaseID `protobuf:"bytes,1,opt,name=id,proto3" json:"id"` } @@ -586,7 +604,9 @@ func (m *QueryLeaseRequest) GetID() v1.LeaseID { // QueryLeaseResponse is response type for the Query/Lease RPC method type QueryLeaseResponse struct { - Lease v1.Lease `protobuf:"bytes,1,opt,name=lease,proto3" json:"lease"` + // Lease holds the lease for a deployment. + Lease v1.Lease `protobuf:"bytes,1,opt,name=lease,proto3" json:"lease"` + // EscrowPayment holds information about the Lease's fractional payment. EscrowPayment v11.FractionalPayment `protobuf:"bytes,2,opt,name=escrow_payment,json=escrowPayment,proto3" json:"escrow_payment"` } @@ -813,17 +833,17 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type QueryClient interface { - // Orders queries orders with filters + // Orders queries orders with filters. Orders(ctx context.Context, in *QueryOrdersRequest, opts ...grpc.CallOption) (*QueryOrdersResponse, error) - // Order queries order details + // Order queries order details. Order(ctx context.Context, in *QueryOrderRequest, opts ...grpc.CallOption) (*QueryOrderResponse, error) - // Bids queries bids with filters + // Bids queries bids with filters. Bids(ctx context.Context, in *QueryBidsRequest, opts ...grpc.CallOption) (*QueryBidsResponse, error) - // Bid queries bid details + // Bid queries bid details. Bid(ctx context.Context, in *QueryBidRequest, opts ...grpc.CallOption) (*QueryBidResponse, error) - // Leases queries leases with filters + // Leases queries leases with filters. Leases(ctx context.Context, in *QueryLeasesRequest, opts ...grpc.CallOption) (*QueryLeasesResponse, error) - // Lease queries lease details + // Lease queries lease details. Lease(ctx context.Context, in *QueryLeaseRequest, opts ...grpc.CallOption) (*QueryLeaseResponse, error) // Params returns the total set of minting parameters. Params(ctx context.Context, in *QueryParamsRequest, opts ...grpc.CallOption) (*QueryParamsResponse, error) @@ -902,17 +922,17 @@ func (c *queryClient) Params(ctx context.Context, in *QueryParamsRequest, opts . // QueryServer is the server API for Query service. type QueryServer interface { - // Orders queries orders with filters + // Orders queries orders with filters. Orders(context.Context, *QueryOrdersRequest) (*QueryOrdersResponse, error) - // Order queries order details + // Order queries order details. Order(context.Context, *QueryOrderRequest) (*QueryOrderResponse, error) - // Bids queries bids with filters + // Bids queries bids with filters. Bids(context.Context, *QueryBidsRequest) (*QueryBidsResponse, error) - // Bid queries bid details + // Bid queries bid details. Bid(context.Context, *QueryBidRequest) (*QueryBidResponse, error) - // Leases queries leases with filters + // Leases queries leases with filters. Leases(context.Context, *QueryLeasesRequest) (*QueryLeasesResponse, error) - // Lease queries lease details + // Lease queries lease details. Lease(context.Context, *QueryLeaseRequest) (*QueryLeaseResponse, error) // Params returns the total set of minting parameters. Params(context.Context, *QueryParamsRequest) (*QueryParamsResponse, error) diff --git a/go/node/market/v1beta5/resourcesoffer.pb.go b/go/node/market/v1beta5/resourcesoffer.pb.go index 08613a81..bf7c7fa3 100644 --- a/go/node/market/v1beta5/resourcesoffer.pb.go +++ b/go/node/market/v1beta5/resourcesoffer.pb.go @@ -25,10 +25,12 @@ var _ = math.Inf const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // ResourceOffer describes resources that provider is offering -// for deployment +// for deployment. type ResourceOffer struct { + // Resources holds information about bid resources. Resources v1beta4.Resources `protobuf:"bytes,1,opt,name=resources,proto3" json:"resources" yaml:"resources"` - Count uint32 `protobuf:"varint,2,opt,name=count,proto3" json:"count" yaml:"count"` + // Count is the number of resources. + Count uint32 `protobuf:"varint,2,opt,name=count,proto3" json:"count" yaml:"count"` } func (m *ResourceOffer) Reset() { *m = ResourceOffer{} } diff --git a/go/node/staking/v1beta3/genesis.pb.go b/go/node/staking/v1beta3/genesis.pb.go index 7a8e296c..494d41c8 100644 --- a/go/node/staking/v1beta3/genesis.pb.go +++ b/go/node/staking/v1beta3/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis staking parameters. type GenesisState struct { + // Params holds parameters of the genesis of staking. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` } diff --git a/go/node/staking/v1beta3/params.pb.go b/go/node/staking/v1beta3/params.pb.go index 4a737f99..7b5728be 100644 --- a/go/node/staking/v1beta3/params.pb.go +++ b/go/node/staking/v1beta3/params.pb.go @@ -24,9 +24,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Params extends the parameters for the x/staking module +// Params extends the parameters for the x/staking module. type Params struct { - // min_commission_rate is the chain-wide minimum commission rate that a validator can charge their delegators + // MinCommissionRate is the chain-wide minimum commission rate that a validator can charge their delegators. MinCommissionRate github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=min_commission_rate,json=minCommissionRate,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"min_commission_rate" yaml:"min_commission_rate"` } diff --git a/go/node/staking/v1beta3/query.pb.go b/go/node/staking/v1beta3/query.pb.go index bbc3ce3a..ebb26025 100644 --- a/go/node/staking/v1beta3/query.pb.go +++ b/go/node/staking/v1beta3/query.pb.go @@ -69,7 +69,7 @@ var xxx_messageInfo_QueryParamsRequest proto.InternalMessageInfo // QueryParamsResponse is the response type for the Query/Params RPC method. type QueryParamsResponse struct { - // params defines the parameters of the module. + // Params defines the parameters of the module. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params"` } diff --git a/go/node/take/v1/genesis.pb.go b/go/node/take/v1/genesis.pb.go index 2da83065..832782e6 100644 --- a/go/node/take/v1/genesis.pb.go +++ b/go/node/take/v1/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis staking parameters. type GenesisState struct { + // Params holds parameters of the genesis of staking. Params Params `protobuf:"bytes,1,opt,name=params,proto3" json:"params" yaml:"params"` } diff --git a/go/node/take/v1/params.pb.go b/go/node/take/v1/params.pb.go index 9dc11ecc..48c2163a 100644 --- a/go/node/take/v1/params.pb.go +++ b/go/node/take/v1/params.pb.go @@ -23,10 +23,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// DenomTakeRate describes take rate for specified denom +// DenomTakeRate describes take rate for specified denom. type DenomTakeRate struct { + // Denom is the denomination of the take rate (uakt, usdc, etc.). Denom string `protobuf:"bytes,1,opt,name=denom,proto3" json:"denom" yaml:"denom"` - Rate uint32 `protobuf:"varint,2,opt,name=rate,proto3" json:"rate" yaml:"rate"` + // Rate is the value of the take rate. + Rate uint32 `protobuf:"varint,2,opt,name=rate,proto3" json:"rate" yaml:"rate"` } func (m *DenomTakeRate) Reset() { *m = DenomTakeRate{} } @@ -76,11 +78,12 @@ func (m *DenomTakeRate) GetRate() uint32 { return 0 } -// Params defines the parameters for the x/take package +// Params defines the parameters for the x/take package. type Params struct { - // denom -> % take rate - DenomTakeRates DenomTakeRates `protobuf:"bytes,1,rep,name=denom_take_rates,json=denomTakeRates,proto3,castrepeated=DenomTakeRates" json:"denom_take_rates" yaml:"denom_take_rates"` - DefaultTakeRate uint32 `protobuf:"varint,2,opt,name=default_take_rate,json=defaultTakeRate,proto3" json:"default_take_rate" yaml:"default_take_rate"` + // DenomTakeRates is a list of configured take rates. + DenomTakeRates DenomTakeRates `protobuf:"bytes,1,rep,name=denom_take_rates,json=denomTakeRates,proto3,castrepeated=DenomTakeRates" json:"denom_take_rates" yaml:"denom_take_rates"` + // DefaultTakeRate holds the default take rate. + DefaultTakeRate uint32 `protobuf:"varint,2,opt,name=default_take_rate,json=defaultTakeRate,proto3" json:"default_take_rate" yaml:"default_take_rate"` } func (m *Params) Reset() { *m = Params{} } diff --git a/go/node/types/attributes/v1/attribute.pb.go b/go/node/types/attributes/v1/attribute.pb.go index 699f1c65..baa54bca 100644 --- a/go/node/types/attributes/v1/attribute.pb.go +++ b/go/node/types/attributes/v1/attribute.pb.go @@ -23,9 +23,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Attribute represents key value pair +// Attribute represents an arbitrary attribute key-value pair. type Attribute struct { - Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty" yaml:"key"` + // Key of the attribute (e.g., "region", "cpu_architecture", etc.). + Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty" yaml:"key"` + // Value of the attribute (e.g., "us-west", "x86_64", etc.). Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty" yaml:"value"` } @@ -61,14 +63,13 @@ func (m *Attribute) XXX_DiscardUnknown() { var xxx_messageInfo_Attribute proto.InternalMessageInfo -// SignedBy represents validation accounts that tenant expects signatures for provider attributes +// SignedBy represents validation accounts that tenant expects signatures for provider attributes. // AllOf has precedence i.e. if there is at least one entry AnyOf is ignored regardless to how many -// entries there -// this behaviour to be discussed +// entries there. type SignedBy struct { - // all_of all keys in this list must have signed attributes + // AllOf indicates all keys in this list must have signed attributes. AllOf []string `protobuf:"bytes,1,rep,name=all_of,json=allOf,proto3" json:"all_of" yaml:"allOf"` - // any_of at least of of the keys from the list must have signed attributes + // AnyOf means that at least of of the keys from the list must have signed attributes. AnyOf []string `protobuf:"bytes,2,rep,name=any_of,json=anyOf,proto3" json:"any_of" yaml:"anyOf"` } @@ -104,11 +105,12 @@ func (m *SignedBy) XXX_DiscardUnknown() { var xxx_messageInfo_SignedBy proto.InternalMessageInfo -// PlacementRequirements +// PlacementRequirements represents the requirements for a provider placement on the network. +// It is used to specify the characteristics and constraints of a provider that can be used to satisfy a deployment request. type PlacementRequirements struct { - // SignedBy list of keys that tenants expect to have signatures from + // SignedBy holds the list of keys that tenants expect to have signatures from. SignedBy SignedBy `protobuf:"bytes,1,opt,name=signed_by,json=signedBy,proto3" json:"signed_by" yaml:"signed_by"` - // Attribute list of attributes tenant expects from the provider + // Attribute holds the list of attributes tenant expects from the provider. Attributes Attributes `protobuf:"bytes,2,rep,name=attributes,proto3,castrepeated=Attributes" json:"attributes" yaml:"attributes"` } diff --git a/go/node/types/resources/v1beta4/cpu.pb.go b/go/node/types/resources/v1beta4/cpu.pb.go index f7cb1683..a0e96d42 100644 --- a/go/node/types/resources/v1beta4/cpu.pb.go +++ b/go/node/types/resources/v1beta4/cpu.pb.go @@ -25,9 +25,13 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// CPU stores resource units and cpu config attributes +// CPU stores resource units and cpu config attributes. type CPU struct { - Units ResourceValue `protobuf:"bytes,1,opt,name=units,proto3" json:"units"` + // Units of the CPU, which represents the number of CPUs available. + // This field is required and must be a non-negative integer. + Units ResourceValue `protobuf:"bytes,1,opt,name=units,proto3" json:"units"` + // Attributes holds a list of key-value attributes that describe the GPU, such as its model, memory and interface. + // This field is required and must be a list of `Attribute` messages. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,2,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes,omitempty" yaml:"attributes,omitempty"` } diff --git a/go/node/types/resources/v1beta4/endpoint.pb.go b/go/node/types/resources/v1beta4/endpoint.pb.go index 9a86b830..f42a9315 100644 --- a/go/node/types/resources/v1beta4/endpoint.pb.go +++ b/go/node/types/resources/v1beta4/endpoint.pb.go @@ -23,15 +23,15 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// This describes how the endpoint is implemented when the lease is deployed +// Kind describes how the endpoint is implemented when the lease is deployed. type Endpoint_Kind int32 const ( - // Describes an endpoint that becomes a Kubernetes Ingress + // Describes an endpoint that becomes a Kubernetes Ingress. Endpoint_SHARED_HTTP Endpoint_Kind = 0 - // Describes an endpoint that becomes a Kubernetes NodePort + // Describes an endpoint that becomes a Kubernetes NodePort. Endpoint_RANDOM_PORT Endpoint_Kind = 1 - // Describes an endpoint that becomes a leased IP + // Describes an endpoint that becomes a leased IP. Endpoint_LEASED_IP Endpoint_Kind = 2 ) @@ -55,10 +55,12 @@ func (Endpoint_Kind) EnumDescriptor() ([]byte, []int) { return fileDescriptor_7476b67ee95ddefb, []int{0, 0} } -// Endpoint describes a publicly accessible IP service +// Endpoint describes a publicly accessible IP service. type Endpoint struct { - Kind Endpoint_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=akash.base.resources.v1beta4.Endpoint_Kind" json:"kind,omitempty"` - SequenceNumber uint32 `protobuf:"varint,2,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number" yaml:"sequence_number"` + // Kind describes how the endpoint is implemented when the lease is deployed. + Kind Endpoint_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=akash.base.resources.v1beta4.Endpoint_Kind" json:"kind,omitempty"` + // SequenceNumber represents a sequence number for the Endpoint. + SequenceNumber uint32 `protobuf:"varint,2,opt,name=sequence_number,json=sequenceNumber,proto3" json:"sequence_number" yaml:"sequence_number"` } func (m *Endpoint) Reset() { *m = Endpoint{} } diff --git a/go/node/types/resources/v1beta4/gpu.pb.go b/go/node/types/resources/v1beta4/gpu.pb.go index 4b50b2d8..9aaace74 100644 --- a/go/node/types/resources/v1beta4/gpu.pb.go +++ b/go/node/types/resources/v1beta4/gpu.pb.go @@ -25,8 +25,10 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GPU stores resource units and cpu config attributes +// GPU stores resource units and gpu configuration attributes. type GPU struct { + // The resource value of the GPU, which represents the number of GPUs available. + // This field is required and must be a non-negative integer. Units ResourceValue `protobuf:"bytes,1,opt,name=units,proto3" json:"units"` Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,2,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes,omitempty" yaml:"attributes,omitempty"` } diff --git a/go/node/types/resources/v1beta4/memory.pb.go b/go/node/types/resources/v1beta4/memory.pb.go index 69128bf8..91a4f64d 100644 --- a/go/node/types/resources/v1beta4/memory.pb.go +++ b/go/node/types/resources/v1beta4/memory.pb.go @@ -25,9 +25,13 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Memory stores resource quantity and memory attributes +// Memory stores resource quantity and memory attributes. type Memory struct { - Quantity ResourceValue `protobuf:"bytes,1,opt,name=quantity,proto3" json:"size" yaml:"size"` + // Quantity of memory available, which represents the amount of memory in bytes. + // This field is required and must be a non-negative integer. + Quantity ResourceValue `protobuf:"bytes,1,opt,name=quantity,proto3" json:"size" yaml:"size"` + // Attributes that describe the memory, such as its type and speed. + // This field is required and must be a list of Attribute key-values. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,2,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes,omitempty" yaml:"attributes,omitempty"` } diff --git a/go/node/types/resources/v1beta4/resources.pb.go b/go/node/types/resources/v1beta4/resources.pb.go index f56dfe67..d3e7b580 100644 --- a/go/node/types/resources/v1beta4/resources.pb.go +++ b/go/node/types/resources/v1beta4/resources.pb.go @@ -26,11 +26,21 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // Resources describes all available resources types for deployment/node etc // if field is nil resource is not present in the given data-structure type Resources struct { - ID uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id" yaml:"id"` - CPU *CPU `protobuf:"bytes,2,opt,name=cpu,proto3" json:"cpu,omitempty" yaml:"cpu,omitempty"` - Memory *Memory `protobuf:"bytes,3,opt,name=memory,proto3" json:"memory,omitempty" yaml:"memory,omitempty"` - Storage Volumes `protobuf:"bytes,4,rep,name=storage,proto3,castrepeated=Volumes" json:"storage,omitempty" yaml:"storage,omitempty"` - GPU *GPU `protobuf:"bytes,5,opt,name=gpu,proto3" json:"gpu,omitempty" yaml:"gpu,omitempty"` + // Id is a unique identifier for the resources. + ID uint32 `protobuf:"varint,1,opt,name=id,proto3" json:"id" yaml:"id"` + // CPU resources available, including the architecture, number of cores and other details. + // This field is optional and can be empty if no CPU resources are available. + CPU *CPU `protobuf:"bytes,2,opt,name=cpu,proto3" json:"cpu,omitempty" yaml:"cpu,omitempty"` + // Memory resources available, including the quantity and attributes. + // This field is optional and can be empty if no memory resources are available. + Memory *Memory `protobuf:"bytes,3,opt,name=memory,proto3" json:"memory,omitempty" yaml:"memory,omitempty"` + // Storage resources available, including the quantity and attributes. + // This field is optional and can be empty if no storage resources are available. + Storage Volumes `protobuf:"bytes,4,rep,name=storage,proto3,castrepeated=Volumes" json:"storage,omitempty" yaml:"storage,omitempty"` + // GPU resources available, including the type, architecture and other details. + // This field is optional and can be empty if no GPU resources are available. + GPU *GPU `protobuf:"bytes,5,opt,name=gpu,proto3" json:"gpu,omitempty" yaml:"gpu,omitempty"` + // Endpoint resources available Endpoints Endpoints `protobuf:"bytes,6,rep,name=endpoints,proto3,castrepeated=Endpoints" json:"endpoints,omitempty" yaml:"endpoints,omitempty"` } diff --git a/go/node/types/resources/v1beta4/resourcevalue.pb.go b/go/node/types/resources/v1beta4/resourcevalue.pb.go index 7e6108fb..2a572bc8 100644 --- a/go/node/types/resources/v1beta4/resourcevalue.pb.go +++ b/go/node/types/resources/v1beta4/resourcevalue.pb.go @@ -24,7 +24,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Unit stores cpu, memory and storage metrics +// Unit stores cpu, memory and storage metrics. type ResourceValue struct { Val github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,1,opt,name=val,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"val"` } diff --git a/go/node/types/resources/v1beta4/storage.pb.go b/go/node/types/resources/v1beta4/storage.pb.go index ffecbdbb..7b7588d7 100644 --- a/go/node/types/resources/v1beta4/storage.pb.go +++ b/go/node/types/resources/v1beta4/storage.pb.go @@ -25,10 +25,15 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Storage stores resource quantity and storage attributes +// Storage stores resource quantity and storage attributes. type Storage struct { - Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name" yaml:"name"` - Quantity ResourceValue `protobuf:"bytes,2,opt,name=quantity,proto3" json:"size" yaml:"size"` + // Name holds an arbitrary name for the storage resource. + Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name" yaml:"name"` + // Quantity of storage available, which represents the amount of memory in bytes. + // This field is required and must be a non-negative integer. + Quantity ResourceValue `protobuf:"bytes,2,opt,name=quantity,proto3" json:"size" yaml:"size"` + // Attributes that describe the storage. + // This field is required and must be a list of Attribute key-values. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,3,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes,omitempty" yaml:"attributes,omitempty"` } diff --git a/proto/node/akash/audit/v1/audit.proto b/proto/node/akash/audit/v1/audit.proto index 3ad92634..aa82020a 100644 --- a/proto/node/akash/audit/v1/audit.proto +++ b/proto/node/akash/audit/v1/audit.proto @@ -6,16 +6,30 @@ import "akash/base/attributes/v1/attribute.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// Provider stores owner auditor and attributes details +// Provider stores owner, auditor and attributes details. message AuditedProvider { + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 2 [ (gogoproto.jsontag) = "auditor", (gogoproto.moretags) = "yaml:\"auditor\"" ]; + + // Attributes holds a list of key-value pairs of provider attributes. + // Attributes are arbitrary values that a provider exposes. repeated akash.base.attributes.v1.Attribute attributes = 4 [ (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", (gogoproto.nullable) = false, @@ -24,25 +38,32 @@ message AuditedProvider { ]; } -// Attributes +// AuditedAttributesStore stores the audited attributes of the provider. +// Audited attributes are attributes verified by the auditor. message AuditedAttributesStore { - option (gogoproto.equal) = false; - repeated akash.base.attributes.v1.Attribute attributes = 1 [ - (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", - (gogoproto.nullable) = false, - (gogoproto.jsontag) = "attributes", - (gogoproto.moretags) = "yaml:\"attributes\"" - ]; + option (gogoproto.equal) = false; + + // Attributes holds a list of key-value pairs of provider attributes. + // Attributes are arbitrary values that a provider exposes. + repeated akash.base.attributes.v1.Attribute attributes = 1 [ + (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", + (gogoproto.nullable) = false, + (gogoproto.jsontag) = "attributes", + (gogoproto.moretags) = "yaml:\"attributes\"" + ]; } -// AttributesFilters defines filters used to filter deployments +// AttributesFilters defines attribute filters that can be used to filter deployments. message AttributesFilters { option (gogoproto.equal) = false; + // Auditors contains a list of account addresses. repeated string auditors = 1 [ (gogoproto.jsontag) = "auditors", (gogoproto.moretags) = "yaml:\"auditors\"" ]; + + // Owners contains a list of account addresses. repeated string owners = 2 [ (gogoproto.jsontag) = "owners", (gogoproto.moretags) = "yaml:\"owners\"" diff --git a/proto/node/akash/audit/v1/event.proto b/proto/node/akash/audit/v1/event.proto index eb036f71..ee73ab17 100644 --- a/proto/node/akash/audit/v1/event.proto +++ b/proto/node/akash/audit/v1/event.proto @@ -7,13 +7,24 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// EventTrustedAuditorCreated defines an SDK message for signing a provider attributes +// EventTrustedAuditorCreated defines an SDK message for when a trusted auditor is created. message EventTrustedAuditorCreated { + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "auditor", @@ -21,13 +32,24 @@ message EventTrustedAuditorCreated { ]; } -// EventTrustedAuditorCreated defines an SDK message for signing a provider attributes +// EventTrustedAuditorDeleted defines an event for when a trusted auditor is deleted. message EventTrustedAuditorDeleted { + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "auditor", diff --git a/proto/node/akash/audit/v1/genesis.proto b/proto/node/akash/audit/v1/genesis.proto index 932109fc..3740699c 100644 --- a/proto/node/akash/audit/v1/genesis.proto +++ b/proto/node/akash/audit/v1/genesis.proto @@ -7,8 +7,10 @@ import "akash/audit/v1/audit.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// GenesisState defines the basic genesis state used by audit module +// GenesisState defines the basic genesis state used by audit module. message GenesisState { + + // Providers contains a list of audited provided account addresses. repeated AuditedProvider providers = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "providers", diff --git a/proto/node/akash/audit/v1/msg.proto b/proto/node/akash/audit/v1/msg.proto index 6d554f7a..2b7ac674 100644 --- a/proto/node/akash/audit/v1/msg.proto +++ b/proto/node/akash/audit/v1/msg.proto @@ -10,21 +10,35 @@ import "akash/base/attributes/v1/attribute.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// MsgSignProviderAttributes defines an SDK message for signing a provider attributes +// MsgSignProviderAttributes defines an SDK message for signing a provider attributes. message MsgSignProviderAttributes { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "auditor"; + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "auditor", (gogoproto.moretags) = "yaml:\"auditor\"" ]; + + // Attributes holds a list of key-value pairs of provider attributes to be audited. + // Attributes are arbitrary values that a provider exposes. repeated akash.base.attributes.v1.Attribute attributes = 3 [ (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", (gogoproto.nullable) = false, @@ -41,16 +55,29 @@ message MsgDeleteProviderAttributes { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "auditor"; + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "auditor", (gogoproto.moretags) = "yaml:\"auditor\"" ]; + + // Keys holds a list of keys of audited provider attributes to delete from the audit. repeated string keys = 3 [ (gogoproto.jsontag) = "keys", (gogoproto.moretags) = "yaml:\"keys\"" diff --git a/proto/node/akash/audit/v1/query.proto b/proto/node/akash/audit/v1/query.proto index 267a685c..c1dfe44e 100644 --- a/proto/node/akash/audit/v1/query.proto +++ b/proto/node/akash/audit/v1/query.proto @@ -12,30 +12,30 @@ import "akash/audit/v1/audit.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for the audit package. service Query { - // AllProvidersAttributes queries all providers + // AllProvidersAttributes queries all providers. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME rpc AllProvidersAttributes(QueryAllProvidersAttributesRequest) returns (QueryProvidersResponse) { option (google.api.http).get = "/akash/audit/v1/audit/attributes/list"; } - // ProviderAttributes queries all provider signed attributes + // ProviderAttributes queries all provider signed attributes. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME rpc ProviderAttributes(QueryProviderAttributesRequest) returns (QueryProvidersResponse) { option (google.api.http).get = "/akash/audit/v1/audit/attributes/{owner}/list"; } - // ProviderAuditorAttributes queries provider signed attributes by specific auditor + // ProviderAuditorAttributes queries provider signed attributes by specific auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME rpc ProviderAuditorAttributes(QueryProviderAuditorRequest) returns (QueryProvidersResponse) { option (google.api.http).get = "/akash/audit/v1/audit/attributes/{auditor}/{owner}"; } - // AuditorAttributes queries all providers signed by this auditor + // AuditorAttributes queries all providers signed by this auditor. // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME rpc AuditorAttributes(QueryAuditorAttributesRequest) returns (QueryProvidersResponse) { @@ -43,41 +43,78 @@ service Query { } } -// QueryProvidersResponse is response type for the Query/Providers RPC method +// QueryProvidersResponse is response type for the Query/Providers RPC method. message QueryProvidersResponse { + + // Providers contains a list of audited provided account addresses. repeated AuditedProvider providers = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "AuditedProviders" ]; + // Pagination is used to paginate results. cosmos.base.query.v1beta1.PageResponse pagination = 2; } // QueryProviderRequest is request type for the Query/Provider RPC method message QueryProviderRequest { + + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 1; + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 2; } -// QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method +// QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method. message QueryAllProvidersAttributesRequest { + // Pagination is used to paginate the request. cosmos.base.query.v1beta1.PageRequest pagination = 1; } -// QueryProviderAttributesRequest is request type for the Query/Provider RPC method +// QueryProviderAttributesRequest is request type for the Query/Provider RPC method. message QueryProviderAttributesRequest { - string owner = 1; + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string owner = 1; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } -// QueryProviderAuditorRequest is request type for the Query/Providers RPC method +// QueryProviderAuditorRequest is request type for the Query/Providers RPC method. message QueryProviderAuditorRequest { + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string auditor = 1; + // Owner is the account bech32 address of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 2; } -// QueryAuditorAttributesRequest is request type for the Query/Providers RPC method +// QueryAuditorAttributesRequest is request type for the Query/Providers RPC method. message QueryAuditorAttributesRequest { - string auditor = 1; + // Auditor is the account address of the auditor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string auditor = 1; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } diff --git a/proto/node/akash/audit/v1/service.proto b/proto/node/akash/audit/v1/service.proto index 36e6ba77..30fad129 100644 --- a/proto/node/akash/audit/v1/service.proto +++ b/proto/node/akash/audit/v1/service.proto @@ -7,13 +7,13 @@ import "akash/audit/v1/msg.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// Msg defines the provider Msg service +// Msg defines the audit Msg service. service Msg { option (cosmos.msg.v1.service) = true; - // SignProviderAttributes defines a method that signs provider attributes + // SignProviderAttributes defines a method that signs provider attributes. rpc SignProviderAttributes(MsgSignProviderAttributes) returns (MsgSignProviderAttributesResponse); - // DeleteProviderAttributes defines a method that deletes provider attributes + // DeleteProviderAttributes defines a method that deletes provider attributes. rpc DeleteProviderAttributes(MsgDeleteProviderAttributes) returns (MsgDeleteProviderAttributesResponse); } diff --git a/proto/node/akash/base/attributes/v1/attribute.proto b/proto/node/akash/base/attributes/v1/attribute.proto index dc5bd411..74b16e7d 100644 --- a/proto/node/akash/base/attributes/v1/attribute.proto +++ b/proto/node/akash/base/attributes/v1/attribute.proto @@ -8,46 +8,49 @@ option (gogoproto.goproto_stringer_all) = false; option (gogoproto.stringer_all) = false; option go_package = "pkg.akt.dev/go/node/types/attributes/v1"; -// Attribute represents key value pair +// Attribute represents an arbitrary attribute key-value pair. message Attribute { option (gogoproto.goproto_getters) = false; + + // Key of the attribute (e.g., "region", "cpu_architecture", etc.). string key = 1 [(gogoproto.moretags) = "yaml:\"key\""]; + // Value of the attribute (e.g., "us-west", "x86_64", etc.). string value = 2 [(gogoproto.moretags) = "yaml:\"value\""]; } -// SignedBy represents validation accounts that tenant expects signatures for provider attributes +// SignedBy represents validation accounts that tenant expects signatures for provider attributes. // AllOf has precedence i.e. if there is at least one entry AnyOf is ignored regardless to how many -// entries there -// this behaviour to be discussed -message SignedBy { +// entries there. +message SignedBy { // TODO: this behaviour to be discussed option (gogoproto.goproto_getters) = false; option (gogoproto.stringer) = false; - // all_of all keys in this list must have signed attributes + // AllOf indicates all keys in this list must have signed attributes. repeated string all_of = 1 [ (gogoproto.jsontag) = "all_of", (gogoproto.moretags) = "yaml:\"allOf\"" ]; - // any_of at least of of the keys from the list must have signed attributes + // AnyOf means that at least of of the keys from the list must have signed attributes. repeated string any_of = 2 [ (gogoproto.jsontag) = "any_of", (gogoproto.moretags) = "yaml:\"anyOf\"" ]; } -// PlacementRequirements +// PlacementRequirements represents the requirements for a provider placement on the network. +// It is used to specify the characteristics and constraints of a provider that can be used to satisfy a deployment request. message PlacementRequirements { option (gogoproto.goproto_getters) = false; option (gogoproto.stringer) = false; - // SignedBy list of keys that tenants expect to have signatures from + // SignedBy holds the list of keys that tenants expect to have signatures from. SignedBy signed_by = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "signed_by", (gogoproto.moretags) = "yaml:\"signed_by\"" ]; - // Attribute list of attributes tenant expects from the provider + // Attribute holds the list of attributes tenant expects from the provider. repeated Attribute attributes = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Attributes", diff --git a/proto/node/akash/base/resources/v1beta4/cpu.proto b/proto/node/akash/base/resources/v1beta4/cpu.proto index 9be985e7..ae785f1a 100644 --- a/proto/node/akash/base/resources/v1beta4/cpu.proto +++ b/proto/node/akash/base/resources/v1beta4/cpu.proto @@ -8,12 +8,17 @@ import "akash/base/resources/v1beta4/resourcevalue.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// CPU stores resource units and cpu config attributes +// CPU stores resource units and cpu config attributes. message CPU { option (gogoproto.equal) = true; + // Units of the CPU, which represents the number of CPUs available. + // This field is required and must be a non-negative integer. ResourceValue units = 1 [ (gogoproto.nullable) = false ]; + + // Attributes holds a list of key-value attributes that describe the GPU, such as its model, memory and interface. + // This field is required and must be a list of `Attribute` messages. repeated akash.base.attributes.v1.Attribute attributes = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", diff --git a/proto/node/akash/base/resources/v1beta4/endpoint.proto b/proto/node/akash/base/resources/v1beta4/endpoint.proto index 8c1dc297..b8950b70 100644 --- a/proto/node/akash/base/resources/v1beta4/endpoint.proto +++ b/proto/node/akash/base/resources/v1beta4/endpoint.proto @@ -5,21 +5,24 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// Endpoint describes a publicly accessible IP service +// Endpoint describes a publicly accessible IP service. message Endpoint { option (gogoproto.equal) = true; - // This describes how the endpoint is implemented when the lease is deployed + // Kind describes how the endpoint is implemented when the lease is deployed. enum Kind { - // Describes an endpoint that becomes a Kubernetes Ingress + // Describes an endpoint that becomes a Kubernetes Ingress. SHARED_HTTP = 0; - // Describes an endpoint that becomes a Kubernetes NodePort + // Describes an endpoint that becomes a Kubernetes NodePort. RANDOM_PORT = 1; - // Describes an endpoint that becomes a leased IP + // Describes an endpoint that becomes a leased IP. LEASED_IP = 2; } + // Kind describes how the endpoint is implemented when the lease is deployed. Kind kind = 1; + + // SequenceNumber represents a sequence number for the Endpoint. uint32 sequence_number = 2 [ (gogoproto.customname) = "SequenceNumber", (gogoproto.jsontag) = "sequence_number", diff --git a/proto/node/akash/base/resources/v1beta4/gpu.proto b/proto/node/akash/base/resources/v1beta4/gpu.proto index 01c40105..9a1eb713 100644 --- a/proto/node/akash/base/resources/v1beta4/gpu.proto +++ b/proto/node/akash/base/resources/v1beta4/gpu.proto @@ -7,12 +7,17 @@ import "akash/base/resources/v1beta4/resourcevalue.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// GPU stores resource units and cpu config attributes +// GPU stores resource units and gpu configuration attributes. message GPU { option (gogoproto.equal) = true; + + // The resource value of the GPU, which represents the number of GPUs available. + // This field is required and must be a non-negative integer. ResourceValue units = 1 [ (gogoproto.nullable) = false ]; + + repeated akash.base.attributes.v1.Attribute attributes = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", diff --git a/proto/node/akash/base/resources/v1beta4/memory.proto b/proto/node/akash/base/resources/v1beta4/memory.proto index 1b9ad7ba..f09d1633 100644 --- a/proto/node/akash/base/resources/v1beta4/memory.proto +++ b/proto/node/akash/base/resources/v1beta4/memory.proto @@ -8,14 +8,20 @@ import "akash/base/resources/v1beta4/resourcevalue.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// Memory stores resource quantity and memory attributes +// Memory stores resource quantity and memory attributes. message Memory { option (gogoproto.equal) = true; + + // Quantity of memory available, which represents the amount of memory in bytes. + // This field is required and must be a non-negative integer. ResourceValue quantity = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "size", (gogoproto.moretags) = "yaml:\"size\"" ]; + + // Attributes that describe the memory, such as its type and speed. + // This field is required and must be a list of Attribute key-values. repeated akash.base.attributes.v1.Attribute attributes = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", diff --git a/proto/node/akash/base/resources/v1beta4/resources.proto b/proto/node/akash/base/resources/v1beta4/resources.proto index cc580a95..c428d304 100644 --- a/proto/node/akash/base/resources/v1beta4/resources.proto +++ b/proto/node/akash/base/resources/v1beta4/resources.proto @@ -15,34 +15,49 @@ option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; // if field is nil resource is not present in the given data-structure message Resources { option (gogoproto.equal) = true; + // Id is a unique identifier for the resources. uint32 id = 1 [ (gogoproto.customname) = "ID", (gogoproto.jsontag) = "id", (gogoproto.moretags) = "yaml:\"id\"" ]; + + // CPU resources available, including the architecture, number of cores and other details. + // This field is optional and can be empty if no CPU resources are available. CPU cpu = 2 [ (gogoproto.nullable) = true, (gogoproto.customname) = "CPU", (gogoproto.jsontag) = "cpu,omitempty", (gogoproto.moretags) = "yaml:\"cpu,omitempty\"" ]; + + // Memory resources available, including the quantity and attributes. + // This field is optional and can be empty if no memory resources are available. Memory memory = 3 [ (gogoproto.nullable) = true, (gogoproto.jsontag) = "memory,omitempty", (gogoproto.moretags) = "yaml:\"memory,omitempty\"" ]; + + // Storage resources available, including the quantity and attributes. + // This field is optional and can be empty if no storage resources are available. repeated Storage storage = 4 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Volumes", (gogoproto.jsontag) = "storage,omitempty", (gogoproto.moretags) = "yaml:\"storage,omitempty\"" ]; + + // GPU resources available, including the type, architecture and other details. + // This field is optional and can be empty if no GPU resources are available. GPU gpu = 5 [ (gogoproto.nullable) = true, (gogoproto.customname) = "GPU", (gogoproto.jsontag) = "gpu,omitempty", (gogoproto.moretags) = "yaml:\"gpu,omitempty\"" ]; + + // Endpoint resources available repeated Endpoint endpoints = 6 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Endpoints", diff --git a/proto/node/akash/base/resources/v1beta4/resourcevalue.proto b/proto/node/akash/base/resources/v1beta4/resourcevalue.proto index c969c4c8..0c4e59a3 100644 --- a/proto/node/akash/base/resources/v1beta4/resourcevalue.proto +++ b/proto/node/akash/base/resources/v1beta4/resourcevalue.proto @@ -5,7 +5,7 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// Unit stores cpu, memory and storage metrics +// Unit stores cpu, memory and storage metrics. message ResourceValue { option (gogoproto.equal) = true; bytes val = 1 [ diff --git a/proto/node/akash/base/resources/v1beta4/storage.proto b/proto/node/akash/base/resources/v1beta4/storage.proto index 2f37082d..4c2e5528 100644 --- a/proto/node/akash/base/resources/v1beta4/storage.proto +++ b/proto/node/akash/base/resources/v1beta4/storage.proto @@ -7,18 +7,26 @@ import "akash/base/resources/v1beta4/resourcevalue.proto"; option go_package = "pkg.akt.dev/go/node/types/resources/v1beta4"; -// Storage stores resource quantity and storage attributes +// Storage stores resource quantity and storage attributes. message Storage { option (gogoproto.equal) = true; + + // Name holds an arbitrary name for the storage resource. string name = 1 [ (gogoproto.jsontag) = "name", (gogoproto.moretags) = "yaml:\"name\"" ]; + + // Quantity of storage available, which represents the amount of memory in bytes. + // This field is required and must be a non-negative integer. ResourceValue quantity = 2 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "size", (gogoproto.moretags) = "yaml:\"size\"" ]; + + // Attributes that describe the storage. + // This field is required and must be a list of Attribute key-values. repeated akash.base.attributes.v1.Attribute attributes = 3 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", diff --git a/proto/node/akash/cert/v1/cert.proto b/proto/node/akash/cert/v1/cert.proto index d8826ff5..3d75e384 100644 --- a/proto/node/akash/cert/v1/cert.proto +++ b/proto/node/akash/cert/v1/cert.proto @@ -6,53 +6,65 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// State is an enum which refers to state of deployment +// State is an enum which refers to state of the certificate. enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [ (gogoproto.enumvalue_customname) = "CertificateStateInvalid" ]; - // CertificateValid denotes state for deployment active + // CertificateValid denotes state for deployment active. valid = 1 [ (gogoproto.enumvalue_customname) = "CertificateValid" ]; - // CertificateRevoked denotes state for deployment closed + // CertificateRevoked denotes state for deployment closed. revoked = 2 [ (gogoproto.enumvalue_customname) = "CertificateRevoked" ]; } -// ID stores owner and sequence number +// ID stores owner and sequence number. message ID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // Serial is a sequence number for the certificate. string serial = 2 [ (gogoproto.jsontag) = "serial", (gogoproto.moretags) = "yaml:\"serial\"" ]; } -// Certificate stores state, certificate and it's public key +// Certificate stores state, certificate and it's public key. message Certificate { + + // State is the state of the certificate. + // CertificateValid denotes state for deployment active. + // CertificateRevoked denotes state for deployment closed. State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; + // Cert holds the bytes representing the certificate. bytes cert = 3 [ (gogoproto.jsontag) = "cert", (gogoproto.moretags) = "yaml:\"cert\"" ]; + // PubKey holds the public key. bytes pubkey = 4 [ (gogoproto.jsontag) = "pubkey", (gogoproto.moretags) = "yaml:\"pubkey\"" diff --git a/proto/node/akash/cert/v1/filters.proto b/proto/node/akash/cert/v1/filters.proto index a4473f7e..0a5e5e1d 100644 --- a/proto/node/akash/cert/v1/filters.proto +++ b/proto/node/akash/cert/v1/filters.proto @@ -7,21 +7,30 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// CertificateFilter defines filters used to filter certificates +// CertificateFilter defines filters used to filter certificates. message CertificateFilter { option (gogoproto.equal) = false; + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // Serial is a sequence number for the certificate. string serial = 2 [ (gogoproto.jsontag) = "serial", (gogoproto.moretags) = "yaml:\"serial\"" ]; + // State is the state of the certificate. + // CertificateValid denotes state for deployment active. + // CertificateRevoked denotes state for deployment closed. string state = 3 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" diff --git a/proto/node/akash/cert/v1/genesis.proto b/proto/node/akash/cert/v1/genesis.proto index e7034117..46c875d1 100644 --- a/proto/node/akash/cert/v1/genesis.proto +++ b/proto/node/akash/cert/v1/genesis.proto @@ -7,14 +7,21 @@ import "akash/cert/v1/cert.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// GenesisCertificate defines certificate entry at genesis +// GenesisCertificate defines certificate entry at genesis. message GenesisCertificate { + + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // Certificate holds the certificate. akash.cert.v1.Certificate certificate = 2 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "certificate", @@ -22,8 +29,9 @@ message GenesisCertificate { ]; } -// GenesisState defines the basic genesis state used by cert module +// GenesisState defines the basic genesis state used by cert module. message GenesisState { + // Certificates is a list of genesis certificates. repeated GenesisCertificate certificates = 1 [ (gogoproto.castrepeated) = "GenesisCertificates", (gogoproto.nullable) = false, diff --git a/proto/node/akash/cert/v1/msg.proto b/proto/node/akash/cert/v1/msg.proto index c69a24f5..7cd5d13b 100644 --- a/proto/node/akash/cert/v1/msg.proto +++ b/proto/node/akash/cert/v1/msg.proto @@ -10,22 +10,29 @@ import "akash/cert/v1/cert.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// MsgCreateCertificate defines an SDK message for creating certificate +// MsgCreateCertificate defines an SDK message for creating certificate. message MsgCreateCertificate { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "owner"; + // Owner is the account address of the user who owns the certificate. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // Cert holds the bytes representing the certificate. bytes cert = 2 [ (gogoproto.jsontag) = "cert", (gogoproto.moretags) = "yaml:\"cert\"" ]; + // PubKey holds the public key. bytes pubkey = 3 [ (gogoproto.jsontag) = "pubkey", (gogoproto.moretags) = "yaml:\"pubkey\"" @@ -35,11 +42,12 @@ message MsgCreateCertificate { // MsgCreateCertificateResponse defines the Msg/CreateCertificate response type. message MsgCreateCertificateResponse {} -// MsgRevokeCertificate defines an SDK message for revoking certificate +// MsgRevokeCertificate defines an SDK message for revoking certificate. message MsgRevokeCertificate { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // Id corresponds to the certificate ID which includes owner and sequence number. akash.cert.v1.ID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", diff --git a/proto/node/akash/cert/v1/query.proto b/proto/node/akash/cert/v1/query.proto index 04b058a3..aa879916 100644 --- a/proto/node/akash/cert/v1/query.proto +++ b/proto/node/akash/cert/v1/query.proto @@ -9,43 +9,50 @@ import "akash/cert/v1/filters.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for certificates. service Query { - // Certificates queries certificates + // Certificates queries certificates on-chain. rpc Certificates(QueryCertificatesRequest) returns (QueryCertificatesResponse) { option (google.api.http).get = "/akash/cert/v1/certificates/list"; } } -// CertificateResponse contains a single X509 certificate and its serial number +// CertificateResponse contains a single X509 certificate and its serial number. message CertificateResponse { + + // Certificate holds the certificate. akash.cert.v1.Certificate certificate = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "certificate", (gogoproto.moretags) = "yaml:\"certificate\"" ]; + // Serial is a sequence number for the certificate. string serial = 2 [ (gogoproto.jsontag) = "serial", (gogoproto.moretags) = "yaml:\"serial\"" ]; } -// QueryDeploymentsRequest is request type for the Query/Deployments RPC method +// QueryDeploymentsRequest is request type for the Query/Deployments RPC method. message QueryCertificatesRequest { + // Filter allows for filtering of results. CertificateFilter filter = 1 [ (gogoproto.nullable) = false ]; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } -// QueryCertificatesResponse is response type for the Query/Certificates RPC method +// QueryCertificatesResponse is response type for the Query/Certificates RPC method. message QueryCertificatesResponse { + // Certificates is a list of certificate. repeated CertificateResponse certificates = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "CertificatesResponse" ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } diff --git a/proto/node/akash/cert/v1/service.proto b/proto/node/akash/cert/v1/service.proto index 7b613251..7d1daa4a 100644 --- a/proto/node/akash/cert/v1/service.proto +++ b/proto/node/akash/cert/v1/service.proto @@ -7,12 +7,12 @@ import "akash/cert/v1/msg.proto"; option go_package = "pkg.akt.dev/go/node/cert/v1"; -// Msg defines the provider Msg service +// Msg defines the provider Msg service. service Msg { option (cosmos.msg.v1.service) = true; // CreateCertificate defines a method to create new certificate given proper inputs. rpc CreateCertificate(MsgCreateCertificate) returns(MsgCreateCertificateResponse); - // RevokeCertificate defines a method to revoke the certificate + // RevokeCertificate defines a method to revoke the certificate. rpc RevokeCertificate(MsgRevokeCertificate) returns(MsgRevokeCertificateResponse); } diff --git a/proto/node/akash/deployment/v1/deployment.proto b/proto/node/akash/deployment/v1/deployment.proto index 259a113f..fc291a0b 100644 --- a/proto/node/akash/deployment/v1/deployment.proto +++ b/proto/node/akash/deployment/v1/deployment.proto @@ -12,8 +12,8 @@ message DeploymentID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; - // Owner is the account address of the user who owns the deployment. - // It is a string representing a valid account address. + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. // // Example: // "akash1..." diff --git a/proto/node/akash/deployment/v1beta4/deploymentmsg.proto b/proto/node/akash/deployment/v1beta4/deploymentmsg.proto index 57ad8192..00c0d0e3 100644 --- a/proto/node/akash/deployment/v1beta4/deploymentmsg.proto +++ b/proto/node/akash/deployment/v1beta4/deploymentmsg.proto @@ -11,32 +11,46 @@ import "akash/deployment/v1beta4/groupspec.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// MsgCreateDeployment defines an SDK message for creating deployment +// MsgCreateDeployment defines an SDK message for creating deployment. message MsgCreateDeployment { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // ID is the unique identifier of the deployment. akash.deployment.v1.DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", (gogoproto.jsontag) = "id", (gogoproto.moretags) = "yaml:\"id\"" ]; + + // GroupSpec is a list of group specifications for the deployment. + // This field is required and must be a list of GroupSpec. repeated GroupSpec groups = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "GroupSpecs", (gogoproto.jsontag) = "groups", (gogoproto.moretags) = "yaml:\"groups\"" ]; + + // Hash of the deployment. bytes hash = 3 [ (gogoproto.jsontag) = "hash", (gogoproto.moretags) = "yaml:\"hash\"" ]; + + // Deposit specifies the amount of coins to include in the deployment's first deposit. cosmos.base.v1beta1.Coin deposit = 4 [ (gogoproto.nullable) = false, (gogoproto.moretags) = "yaml:\"deposit\"" ]; - // Depositor pays for the deposit + + // Depositor is the account address of the user who will deposit funds to the deployment. + // This value can be different than the owner of the deployment if there is authorized spend grants applied. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string depositor = 5 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "depositor", @@ -47,17 +61,20 @@ message MsgCreateDeployment { // MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. message MsgCreateDeploymentResponse {} -// MsgUpdateDeployment defines an SDK message for updating deployment +// MsgUpdateDeployment defines an SDK message for updating deployment. message MsgUpdateDeployment { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // ID is the unique identifier of the deployment. akash.deployment.v1.DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", (gogoproto.jsontag) = "id", (gogoproto.moretags) = "yaml:\"id\"" ]; + + // Hash of the deployment. bytes hash = 3 [ (gogoproto.jsontag) = "hash", (gogoproto.moretags) = "yaml:\"hash\"" @@ -72,6 +89,7 @@ message MsgCloseDeployment { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // ID is the unique identifier of the deployment. akash.deployment.v1.DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", diff --git a/proto/node/akash/deployment/v1beta4/filters.proto b/proto/node/akash/deployment/v1beta4/filters.proto index 2319480f..240e9c23 100644 --- a/proto/node/akash/deployment/v1beta4/filters.proto +++ b/proto/node/akash/deployment/v1beta4/filters.proto @@ -6,20 +6,30 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// DeploymentFilters defines filters used to filter deployments +// DeploymentFilters defines filters used to filter deployments. message DeploymentFilters { option (gogoproto.equal) = false; + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // State defines the sate of the deployment. A deployment can be either active or inactive. string state = 3 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" @@ -30,23 +40,36 @@ message DeploymentFilters { message GroupFilters { option (gogoproto.equal) = false; - string owner = 1 [ - (cosmos_proto.scalar) = "cosmos.AddressString", - (gogoproto.jsontag) = "owner", - (gogoproto.moretags) = "yaml:\"owner\"" - ]; - uint64 dseq = 2 [ - (gogoproto.customname) = "DSeq", - (gogoproto.jsontag) = "dseq", - (gogoproto.moretags) = "yaml:\"dseq\"" - ]; - uint64 gseq = 3 [ - (gogoproto.customname) = "GSeq", - (gogoproto.jsontag) = "gseq", - (gogoproto.moretags) = "yaml:\"gseq\"" - ]; - string state = 4 [ - (gogoproto.jsontag) = "state", - (gogoproto.moretags) = "yaml:\"state\"" - ]; + // Owner is the account address of the user who owns the group. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string owner = 1 [ + (cosmos_proto.scalar) = "cosmos.AddressString", + (gogoproto.jsontag) = "owner", + (gogoproto.moretags) = "yaml:\"owner\"" + ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + uint64 dseq = 2 [ + (gogoproto.customname) = "DSeq", + (gogoproto.jsontag) = "dseq", + (gogoproto.moretags) = "yaml:\"dseq\"" + ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + uint64 gseq = 3 [ + (gogoproto.customname) = "GSeq", + (gogoproto.jsontag) = "gseq", + (gogoproto.moretags) = "yaml:\"gseq\"" + ]; + + // State defines the sate of the deployment. A deployment can be either active or inactive. + string state = 4 [ + (gogoproto.jsontag) = "state", + (gogoproto.moretags) = "yaml:\"state\"" + ]; } diff --git a/proto/node/akash/deployment/v1beta4/genesis.proto b/proto/node/akash/deployment/v1beta4/genesis.proto index 2839cb60..2c0040d2 100644 --- a/proto/node/akash/deployment/v1beta4/genesis.proto +++ b/proto/node/akash/deployment/v1beta4/genesis.proto @@ -10,14 +10,16 @@ import "akash/deployment/v1beta4/params.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// GenesisDeployment defines the basic genesis state used by deployment module +// GenesisDeployment defines the basic genesis state used by deployment module. message GenesisDeployment { + // Deployments represents a deployment on the network. akash.deployment.v1.Deployment deployment = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "deployment", (gogoproto.moretags) = "yaml:\"deployment\"" ]; + // Groups is a list of groups within a Deployment. repeated Group groups = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Groups", @@ -26,14 +28,16 @@ message GenesisDeployment { ]; } -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis deployment instance. message GenesisState { + // Deployments is a list of deployments on the network. repeated GenesisDeployment deployments = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "deployments", (gogoproto.moretags) = "yaml:\"deployments\"" ]; + // Params defines the parameters for the x/deployment module. Params params = 2 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", diff --git a/proto/node/akash/deployment/v1beta4/group.proto b/proto/node/akash/deployment/v1beta4/group.proto index 21b3d56a..119f051d 100644 --- a/proto/node/akash/deployment/v1beta4/group.proto +++ b/proto/node/akash/deployment/v1beta4/group.proto @@ -7,7 +7,7 @@ import "akash/deployment/v1beta4/groupspec.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// Group stores group id, state and specifications of group +// Group stores group id, state and specifications of a group. message Group { option (gogoproto.equal) = false; @@ -15,28 +15,29 @@ message Group { enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [ (gogoproto.enumvalue_customname) = "GroupStateInvalid" ]; - // GroupOpen denotes state for group open + // GroupOpen denotes state for group open. open = 1 [ (gogoproto.enumvalue_customname) = "GroupOpen" ]; - // GroupOrdered denotes state for group ordered + // GroupOrdered denotes state for group ordered. paused = 2 [ (gogoproto.enumvalue_customname) = "GroupPaused" ]; - // GroupInsufficientFunds denotes state for group insufficient_funds + // GroupInsufficientFunds denotes state for group insufficient_funds. insufficient_funds = 3 [ (gogoproto.enumvalue_customname) = "GroupInsufficientFunds" ]; - // GroupClosed denotes state for group closed + // GroupClosed denotes state for group closed. closed = 4 [ (gogoproto.enumvalue_customname) = "GroupClosed" ]; } + // Id is the unique identifier for the group. akash.deployment.v1.GroupID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -44,11 +45,13 @@ message Group { (gogoproto.moretags) = "yaml:\"id\"" ]; + // State represents the state of the group. State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; + // GroupSpec holds the specification of a the Group. GroupSpec group_spec = 3 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "GroupSpecs", diff --git a/proto/node/akash/deployment/v1beta4/groupmsg.proto b/proto/node/akash/deployment/v1beta4/groupmsg.proto index fb83931a..6e806f73 100644 --- a/proto/node/akash/deployment/v1beta4/groupmsg.proto +++ b/proto/node/akash/deployment/v1beta4/groupmsg.proto @@ -14,6 +14,7 @@ message MsgCloseGroup { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // Id is the unique identifier of the Group. akash.deployment.v1.GroupID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -25,11 +26,12 @@ message MsgCloseGroup { // MsgCloseGroupResponse defines the Msg/CloseGroup response type. message MsgCloseGroupResponse {} -// MsgPauseGroup defines SDK message to close a single Group within a Deployment. +// MsgPauseGroup defines SDK message to pause a single Group within a Deployment. message MsgPauseGroup { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // Id is the unique identifier of the Group. akash.deployment.v1.GroupID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -41,11 +43,12 @@ message MsgPauseGroup { // MsgPauseGroupResponse defines the Msg/PauseGroup response type. message MsgPauseGroupResponse {} -// MsgStartGroup defines SDK message to close a single Group within a Deployment. +// MsgStartGroup defines SDK message to start a single Group within a Deployment. message MsgStartGroup { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.owner"; + // Id is the unique identifier of the Group. akash.deployment.v1.GroupID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, diff --git a/proto/node/akash/deployment/v1beta4/groupspec.proto b/proto/node/akash/deployment/v1beta4/groupspec.proto index f75128c5..ed2f6e7a 100644 --- a/proto/node/akash/deployment/v1beta4/groupspec.proto +++ b/proto/node/akash/deployment/v1beta4/groupspec.proto @@ -8,22 +8,28 @@ import "akash/deployment/v1beta4/resourceunit.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// Spec stores group specifications +// GroupSpec defines a specification for a group in a deployment on the network. +// This includes attributes like the group name, placement requirements, and resource units. message GroupSpec { option (gogoproto.equal) = false; option (gogoproto.goproto_getters) = false; + // Name is the name of the group. string name = 1 [ (gogoproto.jsontag) = "name", (gogoproto.moretags) = "yaml:\"name\"" ]; + // Requirements specifies the placement requirements for the group. + // This determines where the resources in the group can be deployed. akash.base.attributes.v1.PlacementRequirements requirements = 2 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "requirements", (gogoproto.moretags) = "yaml:\"requirements\"" ]; + // Resources is a list containing the resource units allocated to the group. + // Each ResourceUnit defines the specific resources (e.g., CPU, memory) assigned. repeated ResourceUnit resources = 3 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "ResourceUnits", diff --git a/proto/node/akash/deployment/v1beta4/params.proto b/proto/node/akash/deployment/v1beta4/params.proto index 608f7455..f02a3761 100644 --- a/proto/node/akash/deployment/v1beta4/params.proto +++ b/proto/node/akash/deployment/v1beta4/params.proto @@ -7,8 +7,10 @@ import "cosmos/base/v1beta1/coin.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// Params defines the parameters for the x/deployment module +// Params defines the parameters for the x/deployment module. message Params { + + // MinDeposits holds a list of the minimum amount of deposits for each a coin. repeated cosmos.base.v1beta1.Coin min_deposits = 1[ (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins", (gogoproto.customname) = "MinDeposits", diff --git a/proto/node/akash/deployment/v1beta4/paramsmsg.proto b/proto/node/akash/deployment/v1beta4/paramsmsg.proto index 4e47bd30..fe42c6ce 100644 --- a/proto/node/akash/deployment/v1beta4/paramsmsg.proto +++ b/proto/node/akash/deployment/v1beta4/paramsmsg.proto @@ -16,12 +16,12 @@ option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; message MsgUpdateParams { option (cosmos.msg.v1.signer) = "authority"; - // authority is the address of the governance account. + // Authority is the address of the governance account. string authority = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ]; - // params defines the x/deployment parameters to update. + // Params defines the x/deployment parameters to update. // // NOTE: All parameters must be supplied. Params params = 2 [ diff --git a/proto/node/akash/deployment/v1beta4/query.proto b/proto/node/akash/deployment/v1beta4/query.proto index 444f909c..28bd5ad1 100644 --- a/proto/node/akash/deployment/v1beta4/query.proto +++ b/proto/node/akash/deployment/v1beta4/query.proto @@ -17,19 +17,19 @@ import "akash/escrow/v1/account.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for the Deployments package. service Query { - // Deployments queries deployments + // Deployments queries deployments. rpc Deployments(QueryDeploymentsRequest) returns (QueryDeploymentsResponse) { option (google.api.http).get = "/akash/deployment/v1beta4/deployments/list"; } - // Deployment queries deployment details + // Deployment queries deployment details. rpc Deployment(QueryDeploymentRequest) returns (QueryDeploymentResponse) { option (google.api.http).get = "/akash/deployment/v1beta4/deployments/info"; } - // Group queries group details + // Group queries group details. rpc Group(QueryGroupRequest) returns (QueryGroupResponse) { option (google.api.http).get = "/akash/deployment/v1beta4/groups/info"; } @@ -40,27 +40,32 @@ service Query { } } -// QueryDeploymentsRequest is request type for the Query/Deployments RPC method +// QueryDeploymentsRequest is request type for the Query/Deployments RPC method. message QueryDeploymentsRequest { + // Filters holds the deployment fields to filter the request. DeploymentFilters filters = 1 [ (gogoproto.nullable) = false ]; + // Pagination is used to paginate the request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } // QueryDeploymentsResponse is response type for the Query/Deployments RPC method message QueryDeploymentsResponse { + // Deployments is a list of Deployments. repeated QueryDeploymentResponse deployments = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "DeploymentResponses" ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } -// QueryDeploymentRequest is request type for the Query/Deployment RPC method +// QueryDeploymentRequest is request type for the Query/Deployment RPC method. message QueryDeploymentRequest { + // Id is the unique identifier of the deployment. akash.deployment.v1.DeploymentID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID" @@ -70,32 +75,43 @@ message QueryDeploymentRequest { // QueryDeploymentResponse is response type for the Query/Deployment RPC method message QueryDeploymentResponse { option (gogoproto.equal) = false; + + // Deployment represents a deployment on the network. akash.deployment.v1.Deployment deployment = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "deployment", (gogoproto.moretags) = "yaml:\"deployment\"" ]; + + // Groups is a list of deployment groups. repeated Group groups = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Groups", (gogoproto.jsontag) = "groups", (gogoproto.moretags) = "yaml:\"groups\"" ]; + + // EscrowAccount represents an escrow mechanism where funds are held. + // This ensures that obligations of both tenants and providers involved in the + // transaction are met without direct access to each other's accounts. akash.escrow.v1.Account escrow_account = 3 [ (gogoproto.nullable) = false ]; } -// QueryGroupRequest is request type for the Query/Group RPC method +// QueryGroupRequest is request type for the Query/Group RPC method. message QueryGroupRequest { + + // Id is the unique identifer of the Group. akash.deployment.v1.GroupID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID" ]; } -// QueryGroupResponse is response type for the Query/Group RPC method +// QueryGroupResponse is response type for the Query/Group RPC method. message QueryGroupResponse { + // Group holds a deployment Group. Group group = 1 [ (gogoproto.nullable) = false ]; diff --git a/proto/node/akash/deployment/v1beta4/resourceunit.proto b/proto/node/akash/deployment/v1beta4/resourceunit.proto index a646869f..fd5211d8 100644 --- a/proto/node/akash/deployment/v1beta4/resourceunit.proto +++ b/proto/node/akash/deployment/v1beta4/resourceunit.proto @@ -9,20 +9,23 @@ import "akash/base/resources/v1beta4/resources.proto"; option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; -// ResourceUnit extends Resources and adds Count along with the Price +// ResourceUnit extends Resources and adds Count along with the Price. message ResourceUnit { option (gogoproto.equal) = true; + // Resource holds the amount of resources. akash.base.resources.v1beta4.Resources resource = 1 [ (gogoproto.nullable) = false, (gogoproto.embed) = true, (gogoproto.jsontag) = "resource", (gogoproto.moretags) = "yaml:\"resource\"" ]; + // Count corresponds to the amount of replicas to run of the resources. uint32 count = 2 [ (gogoproto.jsontag) = "count", (gogoproto.moretags) = "yaml:\"count\"" ]; + // Price holds the pricing for the resource units. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", diff --git a/proto/node/akash/deployment/v1beta4/service.proto b/proto/node/akash/deployment/v1beta4/service.proto index 24d458a3..262f6c59 100644 --- a/proto/node/akash/deployment/v1beta4/service.proto +++ b/proto/node/akash/deployment/v1beta4/service.proto @@ -17,7 +17,7 @@ service Msg { // CreateDeployment defines a method to create new deployment given proper inputs. rpc CreateDeployment(MsgCreateDeployment) returns (MsgCreateDeploymentResponse); - // DepositDeployment deposits more funds into the deployment account + // DepositDeployment deposits more funds into the deployment account. rpc DepositDeployment(akash.deployment.v1.MsgDepositDeployment) returns (akash.deployment.v1.MsgDepositDeploymentResponse); // UpdateDeployment defines a method to update a deployment given proper inputs. @@ -38,6 +38,6 @@ service Msg { // UpdateParams defines a governance operation for updating the x/deployment module // parameters. The authority is hard-coded to the x/gov module account. // - // Since: akash v1.0.0 + // Since: akash v1.0.0 rpc UpdateParams(MsgUpdateParams) returns (MsgUpdateParamsResponse); } diff --git a/proto/node/akash/discovery/v1/akash.proto b/proto/node/akash/discovery/v1/akash.proto index 0e4fd445..37778ba3 100644 --- a/proto/node/akash/discovery/v1/akash.proto +++ b/proto/node/akash/discovery/v1/akash.proto @@ -7,8 +7,9 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/client"; -// Akash akash specific RPC parameters +// Akash akash specific RPC parameters. message Akash { + // ClientInfo holds information about the client. ClientInfo client_info = 1 [ (gogoproto.customname) = "ClientInfo", (gogoproto.jsontag) = "client_info", diff --git a/proto/node/akash/discovery/v1/client_info.proto b/proto/node/akash/discovery/v1/client_info.proto index be852158..96115524 100644 --- a/proto/node/akash/discovery/v1/client_info.proto +++ b/proto/node/akash/discovery/v1/client_info.proto @@ -6,8 +6,9 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/client"; -// ClientInfo akash specific client info +// ClientInfo is the akash specific client info. message ClientInfo { + // ApiVersion is the version of the API running on the client. string api_version = 1 [ (gogoproto.customname) = "ApiVersion", (gogoproto.jsontag) = "api_version", diff --git a/proto/node/akash/escrow/v1/account.proto b/proto/node/akash/escrow/v1/account.proto index 671f7b61..11186b35 100644 --- a/proto/node/akash/escrow/v1/account.proto +++ b/proto/node/akash/escrow/v1/account.proto @@ -10,30 +10,30 @@ import "akash/escrow/v1/accountid.proto"; option go_package = "pkg.akt.dev/go/node/escrow/v1"; -// Account stores state for an escrow account +// Account stores state for an escrow account. message Account { - // State stores state for an escrow account + // State stores state for an escrow account. enum State { option (gogoproto.goproto_enum_prefix) = false; - // AccountStateInvalid is an invalid state - invalid = 0 [ + // AccountStateInvalid is an invalid state. + invalid = 0 [ (gogoproto.enumvalue_customname) = "AccountStateInvalid" ]; - // AccountOpen is the state when an account is open - open = 1 [ + // AccountOpen is the state when an account is open. + open = 1 [ (gogoproto.enumvalue_customname) = "AccountOpen" ]; - // AccountClosed is the state when an account is closed - closed = 2 [ + // AccountClosed is the state when an account is closed. + closed = 2 [ (gogoproto.enumvalue_customname) = "AccountClosed" ]; - // AccountOverdrawn is the state when an account is overdrawn + // AccountOverdrawn is the state when an account is overdrawn. overdrawn = 3 [ (gogoproto.enumvalue_customname) = "AccountOverdrawn" ]; } - // unique identifier for this escrow account + // Id is the unique identifier for an escrow account. AccountID id = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "id", @@ -41,41 +41,49 @@ message Account { (gogoproto.customname) = "ID" ]; - // bech32 encoded account address of the owner of this escrow account + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; - // current state of this escrow account + // State represents the current state of an Account. State state = 3 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; - // unspent coins received from the owner's wallet + // Balance holds the unspent coins received from the owner's wallet. cosmos.base.v1beta1.DecCoin balance = 4 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "balance", (gogoproto.moretags) = "yaml:\"balance\"" ]; - // total coins spent by this account + // Transferred total coins spent by this account. cosmos.base.v1beta1.DecCoin transferred = 5 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "transferred", (gogoproto.moretags) = "yaml:\"transferred\"" ]; - // block height at which this account was last settled + // SettledAt represents the block height at which this account was last settled. int64 settled_at = 6 [ (gogoproto.jsontag) = "settledAt", (gogoproto.moretags) = "yaml:\"settledAt\"", (gogoproto.customname) = "SettledAt" ]; - // bech32 encoded account address of the depositor. + // Depositor is the bech32 address of the depositor. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." // If depositor is same as the owner, then any incoming coins are added to the Balance. // If depositor isn't same as the owner, then any incoming coins are added to the Funds. string depositor = 7 [ diff --git a/proto/node/akash/escrow/v1/accountid.proto b/proto/node/akash/escrow/v1/accountid.proto index 69be58fb..394e5c95 100644 --- a/proto/node/akash/escrow/v1/accountid.proto +++ b/proto/node/akash/escrow/v1/accountid.proto @@ -5,12 +5,15 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/escrow/v1"; -// AccountID is the account identifier +// AccountID is the account identifier. message AccountID { + // Scope holds the scope of the account. string scope = 1 [ (gogoproto.jsontag) = "scope", (gogoproto.moretags) = "yaml:\"scope\"" ]; + + // Xid TODO: What is this? string xid = 2 [ (gogoproto.jsontag) = "xid", (gogoproto.moretags) = "yaml:\"xid\"", diff --git a/proto/node/akash/escrow/v1/fractional_payment.proto b/proto/node/akash/escrow/v1/fractional_payment.proto index 47b621ed..ddf358b8 100644 --- a/proto/node/akash/escrow/v1/fractional_payment.proto +++ b/proto/node/akash/escrow/v1/fractional_payment.proto @@ -10,29 +10,30 @@ import "akash/escrow/v1/accountid.proto"; option go_package = "pkg.akt.dev/go/node/escrow/v1"; -// Payment stores state for a payment +// FractionalPayment stores state for a payment. message FractionalPayment { // State defines payment state enum State { option (gogoproto.goproto_enum_prefix) = false; - // PaymentStateInvalid is the state when the payment is invalid + // PaymentStateInvalid is the state when the payment is invalid. invalid = 0 [ (gogoproto.enumvalue_customname) = "PaymentStateInvalid" ]; - // PaymentStateOpen is the state when the payment is open + // PaymentStateOpen is the state when the payment is open. open = 1 [ (gogoproto.enumvalue_customname) = "PaymentOpen" ]; - // PaymentStateClosed is the state when the payment is closed + // PaymentStateClosed is the state when the payment is closed. closed = 2 [ (gogoproto.enumvalue_customname) = "PaymentClosed" ]; - // PaymentStateOverdrawn is the state when the payment is overdrawn + // PaymentStateOverdrawn is the state when the payment is overdrawn. overdrawn = 3 [ (gogoproto.enumvalue_customname) = "PaymentOverdrawn" ]; } + // AccountId is the unique identifier for the account. AccountID account_id = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "accountID", @@ -40,35 +41,45 @@ message FractionalPayment { (gogoproto.customname) = "AccountID" ]; + // PaymentId is the unique identifier for the payment. string payment_id = 2 [ (gogoproto.jsontag) = "paymentID", (gogoproto.moretags) = "yaml:\"paymentID\"", (gogoproto.customname) = "PaymentID" ]; + // Owner is the bech32 address of the payment. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 3 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // State represents the state of the FractionalPayment. State state = 4 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; - cosmos.base.v1beta1.DecCoin rate = 5 [ + // Rate holds the rate of the FractionalPayment. + cosmos.base.v1beta1.DecCoin rate = 5 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "rate", (gogoproto.moretags) = "yaml:\"rate\"" ]; - cosmos.base.v1beta1.DecCoin balance = 6 [ + // Balance is the current available balance. + cosmos.base.v1beta1.DecCoin balance = 6 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "balance", (gogoproto.moretags) = "yaml:\"balance\"" ]; + // Withdrawn is the amount of coins withdrawn by the FractionalPayment. cosmos.base.v1beta1.Coin withdrawn = 7 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "withdrawn", diff --git a/proto/node/akash/escrow/v1/genesis.proto b/proto/node/akash/escrow/v1/genesis.proto index 2616fca6..495070a6 100644 --- a/proto/node/akash/escrow/v1/genesis.proto +++ b/proto/node/akash/escrow/v1/genesis.proto @@ -7,8 +7,10 @@ import "akash/escrow/v1/fractional_payment.proto"; option go_package = "pkg.akt.dev/go/node/escrow/v1"; -// GenesisState defines the basic genesis state used by the escrow module +// GenesisState defines the basic genesis state used by the escrow module. message GenesisState { + + // Accounts is a list of accounts on the genesis state. repeated Account accounts = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Accounts", @@ -16,6 +18,7 @@ message GenesisState { (gogoproto.moretags) = "yaml:\"accounts\"" ]; + // Payments is a list of fractional payments. repeated FractionalPayment payments = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "FractionalPayments", diff --git a/proto/node/akash/escrow/v1/query.proto b/proto/node/akash/escrow/v1/query.proto index 6abe6d3d..91552ce7 100644 --- a/proto/node/akash/escrow/v1/query.proto +++ b/proto/node/akash/escrow/v1/query.proto @@ -11,56 +11,82 @@ import "akash/escrow/v1/fractional_payment.proto"; option go_package = "pkg.akt.dev/go/node/escrow/v1"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for the escrow package. service Query { // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Accounts queries all accounts + // Accounts queries all accounts. rpc Accounts(QueryAccountsRequest) returns (QueryAccountsResponse) { option (google.api.http).get = "/akash/escrow/v1/types/accounts/list"; } // buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE // buf:lint:ignore RPC_RESPONSE_STANDARD_NAME - // Payments queries all payments + // Payments queries all payments. rpc Payments(QueryPaymentsRequest) returns (QueryPaymentsResponse) { option (google.api.http).get = "/akash/escrow/v1/types/payments/list"; } } -// QueryAccountRequest is request type for the Query/Account RPC method +// QueryAccountRequest is request type for the Query/Account RPC method. message QueryAccountsRequest { + // Scope holds the scope of the account. string scope = 1; + // Xid TODO: What is this? string xid = 2; + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 3; + // State represents the current state of an Account. string state = 4; + + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 5; } // QueryProvidersResponse is response type for the Query/Providers RPC method message QueryAccountsResponse { + // Accounts is a list of Account. repeated Account accounts = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Accounts" ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } // QueryPaymentRequest is request type for the Query/Payment RPC method message QueryPaymentsRequest { + // Scope holds the scope of the payment. string scope = 1; + // Xid TODO: What is this? string xid = 2; + // Id is the unique identifier of the payment. string id = 3; + // Owner is the bech32 address of the account. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 4; + // State represents the current state of an Account. string state = 5; + + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 6; } // QueryProvidersResponse is response type for the Query/Providers RPC method message QueryPaymentsResponse { + // Payments is a list of fractional payments. repeated FractionalPayment payments = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "FractionalPayments" ]; + + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } diff --git a/proto/node/akash/gov/v1beta3/genesis.proto b/proto/node/akash/gov/v1beta3/genesis.proto index 48bfb06f..befecf8c 100644 --- a/proto/node/akash/gov/v1beta3/genesis.proto +++ b/proto/node/akash/gov/v1beta3/genesis.proto @@ -6,8 +6,9 @@ import "akash/gov/v1beta3/params.proto"; option go_package = "pkg.akt.dev/go/node/gov/v1beta3"; -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis deployment instance. message GenesisState { + // DepositParams defines all the parameters related to deposits. DepositParams deposit_params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "deposit_params", diff --git a/proto/node/akash/gov/v1beta3/params.proto b/proto/node/akash/gov/v1beta3/params.proto index ac40e3e6..7aea7865 100644 --- a/proto/node/akash/gov/v1beta3/params.proto +++ b/proto/node/akash/gov/v1beta3/params.proto @@ -4,9 +4,9 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/gov/v1beta3"; -// DepositParams defines the parameters for the x/gov module +// DepositParams defines the parameters for the x/gov module. message DepositParams { - // min_initial_deposit_rate minimum % of TotalDeposit + // MinInitialDepositRate is the minimum % of TotalDeposit // author of the proposal must put in order for proposal tx to be committed bytes min_initial_deposit_rate = 1 [ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", diff --git a/proto/node/akash/inflation/v1beta2/genesis.proto b/proto/node/akash/inflation/v1beta2/genesis.proto index 98607aa0..34af979c 100644 --- a/proto/node/akash/inflation/v1beta2/genesis.proto +++ b/proto/node/akash/inflation/v1beta2/genesis.proto @@ -6,8 +6,9 @@ import "akash/inflation/v1beta2/params.proto"; option go_package = "pkg.akt.dev/go/node/inflation/types/v1beta2"; -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis inflation parameters. message GenesisState { + // Params holds parameters of the genesis of inflation. Params params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", diff --git a/proto/node/akash/inflation/v1beta2/params.proto b/proto/node/akash/inflation/v1beta2/params.proto index f74bd905..231cb607 100644 --- a/proto/node/akash/inflation/v1beta2/params.proto +++ b/proto/node/akash/inflation/v1beta2/params.proto @@ -4,7 +4,7 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/inflation/types/v1beta2"; -// Params defines the parameters for the x/deployment package +// Params defines the parameters for the x/deployment package. message Params { // InflationDecayFactor is the number of years it takes inflation to halve. string inflation_decay_factor = 1 [ diff --git a/proto/node/akash/inflation/v1beta3/genesis.proto b/proto/node/akash/inflation/v1beta3/genesis.proto index 5690d621..5e065f45 100644 --- a/proto/node/akash/inflation/v1beta3/genesis.proto +++ b/proto/node/akash/inflation/v1beta3/genesis.proto @@ -6,8 +6,9 @@ import "akash/inflation/v1beta3/params.proto"; option go_package = "pkg.akt.dev/go/node/inflation/v1beta3"; -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis inflation. message GenesisState { + // Params holds parameters of the genesis of inflation. Params params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", diff --git a/proto/node/akash/inflation/v1beta3/params.proto b/proto/node/akash/inflation/v1beta3/params.proto index c8c36bc2..b0197ab8 100644 --- a/proto/node/akash/inflation/v1beta3/params.proto +++ b/proto/node/akash/inflation/v1beta3/params.proto @@ -4,7 +4,7 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/inflation/v1beta3"; -// Params defines the parameters for the x/deployment package +// Params defines the parameters for the x/deployment package. message Params { // InflationDecayFactor is the number of years it takes inflation to halve. string inflation_decay_factor = 1 [ diff --git a/proto/node/akash/market/v1/bid.proto b/proto/node/akash/market/v1/bid.proto index 99559499..f4faded8 100644 --- a/proto/node/akash/market/v1/bid.proto +++ b/proto/node/akash/market/v1/bid.proto @@ -6,32 +6,51 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/market/v1"; -// BidID stores owner and all other seq numbers +// BidID stores owner and all other seq numbers. // A successful bid becomes a Lease(ID). message BidID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", (gogoproto.moretags) = "yaml:\"gseq\"" ]; + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. uint32 oseq = 4 [ (gogoproto.customname) = "OSeq", (gogoproto.jsontag) = "oseq", (gogoproto.moretags) = "yaml:\"oseq\"" ]; + + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." string provider = 5 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "provider", diff --git a/proto/node/akash/market/v1/event.proto b/proto/node/akash/market/v1/event.proto index d44874a3..b965f293 100644 --- a/proto/node/akash/market/v1/event.proto +++ b/proto/node/akash/market/v1/event.proto @@ -11,10 +11,12 @@ import "akash/market/v1/lease.proto"; option go_package = "pkg.akt.dev/go/node/market/v1"; -// EventOrderCreated +// EventOrderCreated is triggered when an order is created. +// It contains all the information required to identify an order. message EventOrderCreated { option (gogoproto.equal) = false; + // Id is the unique identifier of the Order. OrderID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -23,10 +25,12 @@ message EventOrderCreated { ]; } -// EventOrderClosed +// EventOrderClosed is triggered when an order is closed. +// It contains all the information required to identify an order. message EventOrderClosed { option (gogoproto.equal) = false; + // Id is the unique identifier of the Order. OrderID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -35,16 +39,20 @@ message EventOrderClosed { ]; } -// EventBidCreated +// EventBidCreated is triggered when a bid is created. +// It contains all the information required to identify a bid. message EventBidCreated { option (gogoproto.equal) = false; + // Id is the unique identifier of the Bid. BidID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", (gogoproto.jsontag) = "id", (gogoproto.moretags) = "yaml:\"id\"" ]; + + // Price stated on the Bid. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", @@ -52,10 +60,12 @@ message EventBidCreated { ]; } -// EventBidClosed +// EventBidClosed is triggered when a bid is closed. +// It contains all the information required to identify a bid. message EventBidClosed { option (gogoproto.equal) = false; + // Id is the unique identifier of the Bid. BidID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -64,10 +74,12 @@ message EventBidClosed { ]; } -// EventLeaseCreated +// EventLeaseCreated is triggered when a lease is created. +// It contains all the information required to identify a lease. message EventLeaseCreated { option (gogoproto.equal) = false; + // Id is the unique identifier of the Lease. LeaseID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", @@ -75,6 +87,7 @@ message EventLeaseCreated { (gogoproto.moretags) = "yaml:\"id\"" ]; + // Price settled for the lease. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", @@ -82,10 +95,12 @@ message EventLeaseCreated { ]; } -// EventLeaseClosed +// EventLeaseClosed is triggered when a lease is closed. +// It contains all the information required to identify a lease. message EventLeaseClosed { option (gogoproto.equal) = false; + // Id is the unique identifier of the Lease. LeaseID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID", diff --git a/proto/node/akash/market/v1/filters.proto b/proto/node/akash/market/v1/filters.proto index aa36720a..db6e8e70 100644 --- a/proto/node/akash/market/v1/filters.proto +++ b/proto/node/akash/market/v1/filters.proto @@ -6,36 +6,57 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/market/v1"; -// LeaseFilters defines flags for lease list filter +// LeaseFilters defines flags for lease list filtering. message LeaseFilters { option (gogoproto.equal) = false; - - string owner = 1 [ + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; - uint64 dseq = 2 [ + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; - uint32 gseq = 3 [ + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", (gogoproto.moretags) = "yaml:\"gseq\"" ]; - uint32 oseq = 4 [ + + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + uint32 oseq = 4 [ (gogoproto.customname) = "OSeq", (gogoproto.jsontag) = "oseq", (gogoproto.moretags) = "yaml:\"oseq\"" ]; + + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." string provider = 5 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "provider", (gogoproto.moretags) = "yaml:\"provider\"" ]; - string state = 6 [ + + // State represents the state of the lease. + string state = 6 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; diff --git a/proto/node/akash/market/v1/lease.proto b/proto/node/akash/market/v1/lease.proto index d47f0631..bb3e2ac2 100644 --- a/proto/node/akash/market/v1/lease.proto +++ b/proto/node/akash/market/v1/lease.proto @@ -8,31 +8,51 @@ import "cosmos/base/v1beta1/coin.proto"; option go_package = "pkg.akt.dev/go/node/market/v1"; -// LeaseID stores bid details of lease +// LeaseID stores bid details of lease. message LeaseID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", (gogoproto.moretags) = "yaml:\"gseq\"" ]; + + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. uint32 oseq = 4 [ (gogoproto.customname) = "OSeq", (gogoproto.jsontag) = "oseq", (gogoproto.moretags) = "yaml:\"oseq\"" ]; + + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." string provider = 5 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "provider", @@ -40,33 +60,37 @@ message LeaseID { ]; } -// Lease stores LeaseID, state of lease and price +// Lease stores LeaseID, state of lease and price. +// The Lease defines the terms under which the provider allocates resources to fulfill +// the tenant's deployment requirements. +// Leases are paid from the tenant to the provider through a deposit and withdraw mechanism and are priced in blocks. message Lease { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; - // State is an enum which refers to state of lease + // State is an enum which refers to state of lease. enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [ (gogoproto.enumvalue_customname) = "LeaseStateInvalid" ]; - // LeaseActive denotes state for lease active + // LeaseActive denotes state for lease active. active = 1 [ (gogoproto.enumvalue_customname) = "LeaseActive" ]; - // LeaseInsufficientFunds denotes state for lease insufficient_funds + // LeaseInsufficientFunds denotes state for lease insufficient_funds. insufficient_funds = 2 [ (gogoproto.enumvalue_customname) = "LeaseInsufficientFunds" ]; - // LeaseClosed denotes state for lease closed + // LeaseClosed denotes state for lease closed. closed = 3 [ (gogoproto.enumvalue_customname) = "LeaseClosed" ]; } + // Id is the unique identifier of the Lease. LeaseID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -74,20 +98,25 @@ message Lease { (gogoproto.moretags) = "yaml:\"id\"" ]; + // State represents the state of the Lease. State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; + // Price holds the settled price for the Lease. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", (gogoproto.moretags) = "yaml:\"price\"" ]; + + // CreatedAt is the block height at which the Lease was created. int64 created_at = 4 [ (gogoproto.jsontag) = "created_at", (gogoproto.moretags) = "yaml:\"created_at\"" ]; + // ClosedOn is the block height at which the Lease was closed. int64 closed_on = 5 [ (gogoproto.jsontag) = "closed_on", (gogoproto.moretags) = "yaml:\"closed_on\"" diff --git a/proto/node/akash/market/v1/order.proto b/proto/node/akash/market/v1/order.proto index ad6452cf..51046ce2 100644 --- a/proto/node/akash/market/v1/order.proto +++ b/proto/node/akash/market/v1/order.proto @@ -6,26 +6,40 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/market/v1"; -// OrderID stores owner and all other seq numbers +// OrderId stores owner and all other seq numbers. message OrderID { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", (gogoproto.moretags) = "yaml:\"gseq\"" ]; + + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. uint32 oseq = 4 [ (gogoproto.customname) = "OSeq", (gogoproto.jsontag) = "oseq", diff --git a/proto/node/akash/market/v1beta5/bid.proto b/proto/node/akash/market/v1beta5/bid.proto index 5b9fcd1a..ed354de3 100644 --- a/proto/node/akash/market/v1beta5/bid.proto +++ b/proto/node/akash/market/v1beta5/bid.proto @@ -9,37 +9,39 @@ import "akash/market/v1/bid.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// Bid stores BidID, state of bid and price +// Bid stores BidID, state of bid and price. message Bid { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; - // BidState is an enum which refers to state of bid + // BidState is an enum which refers to state of bid. enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [ (gogoproto.enumvalue_customname) = "BidStateInvalid" ]; - // BidOpen denotes state for bid open + // BidOpen denotes state for bid open. open = 1 [ (gogoproto.enumvalue_customname) = "BidOpen" ]; - // BidMatched denotes state for bid open + // BidMatched denotes state for bid open. active = 2 [ (gogoproto.enumvalue_customname) = "BidActive" ]; - // BidLost denotes state for bid lost + // BidLost denotes state for bid lost. lost = 3 [ (gogoproto.enumvalue_customname) = "BidLost" ]; - // BidClosed denotes state for bid closed + // BidClosed denotes state for bid closed. closed = 4 [ (gogoproto.enumvalue_customname) = "BidClosed" ]; } + // BidID stores owner and all other seq numbers. + // A successful bid becomes a Lease(ID). akash.market.v1.BidID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -47,22 +49,26 @@ message Bid { (gogoproto.moretags) = "yaml:\"id\"" ]; + // State represents the state of the Bid. State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" ]; + // Price holds the pricing stated on the Bid. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", (gogoproto.moretags) = "yaml:\"price\"" ]; + // CreatedAt is the block height at which the Bid was created. int64 created_at = 4 [ - (gogoproto.jsontag) = "state", + (gogoproto.jsontag) = "createdAt", (gogoproto.moretags) = "yaml:\"created_at\"" ]; + // ResourceOffer is a list of offers. repeated ResourceOffer resources_offer = 5 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "ResourcesOffer", diff --git a/proto/node/akash/market/v1beta5/bidmsg.proto b/proto/node/akash/market/v1beta5/bidmsg.proto index 783321b7..08020253 100644 --- a/proto/node/akash/market/v1beta5/bidmsg.proto +++ b/proto/node/akash/market/v1beta5/bidmsg.proto @@ -14,32 +14,45 @@ import "akash/market/v1/order.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// MsgCreateBid defines an SDK message for creating Bid +// MsgCreateBid defines an SDK message for creating Bid. message MsgCreateBid { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "provider"; + // OrderId is the unique identifier for the order. akash.market.v1.OrderID order_id = 1 [ (gogoproto.customname) = "OrderID", (gogoproto.nullable) = false, (gogoproto.jsontag) = "order_id", (gogoproto.moretags) = "yaml:\"order_id\"" ]; + + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." string provider = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "provider", (gogoproto.moretags) = 'yaml:"provider"' ]; + + // Price holds the pricing stated on the Bid. cosmos.base.v1beta1.DecCoin price = 3 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "price", (gogoproto.moretags) = "yaml:\"price\"" ]; + + // Deposit holds the amount of coins to deposit. cosmos.base.v1beta1.Coin deposit = 4 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "deposit", (gogoproto.moretags) = "yaml:\"deposit\"" ]; + + // ResourceOffer is a list of resource offers. repeated ResourceOffer resources_offer = 5 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "ResourcesOffer", @@ -52,11 +65,12 @@ message MsgCreateBid { // MsgCreateBidResponse defines the Msg/CreateBid response type. message MsgCreateBidResponse {} -// MsgCloseBid defines an SDK message for closing bid +// MsgCloseBid defines an SDK message for closing bid. message MsgCloseBid { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "id.provider"; + // Id is the unique identifier of the Bid. akash.market.v1.BidID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, diff --git a/proto/node/akash/market/v1beta5/filters.proto b/proto/node/akash/market/v1beta5/filters.proto index acf4f481..bfa835ac 100644 --- a/proto/node/akash/market/v1beta5/filters.proto +++ b/proto/node/akash/market/v1beta5/filters.proto @@ -6,65 +6,103 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// BidFilters defines flags for bid list filter +// BidFilters defines flags for bid list filter. message BidFilters { - option (gogoproto.equal) = false; + option (gogoproto.equal) = false; + + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." + string owner = 1 [ + (cosmos_proto.scalar) = "cosmos.AddressString", + (gogoproto.jsontag) = "owner", + (gogoproto.moretags) = "yaml:\"owner\"" + ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. + uint64 dseq = 2 [ + (gogoproto.customname) = "DSeq", + (gogoproto.jsontag) = "dseq", + (gogoproto.moretags) = "yaml:\"dseq\"" + ]; - string owner = 1 [ - (cosmos_proto.scalar) = "cosmos.AddressString", - (gogoproto.jsontag) = "owner", - (gogoproto.moretags) = "yaml:\"owner\"" - ]; - uint64 dseq = 2 [ - (gogoproto.customname) = "DSeq", - (gogoproto.jsontag) = "dseq", - (gogoproto.moretags) = "yaml:\"dseq\"" - ]; - uint32 gseq = 3 [ - (gogoproto.customname) = "GSeq", - (gogoproto.jsontag) = "gseq", - (gogoproto.moretags) = "yaml:\"gseq\"" - ]; - uint32 oseq = 4 [ - (gogoproto.customname) = "OSeq", - (gogoproto.jsontag) = "oseq", - (gogoproto.moretags) = "yaml:\"oseq\"" - ]; - string provider = 5 [ - (cosmos_proto.scalar) = "cosmos.AddressString", - (gogoproto.jsontag) = "provider", - (gogoproto.moretags) = "yaml:\"provider\"" - ]; - string state = 6 [ - (gogoproto.jsontag) = "state", - (gogoproto.moretags) = "yaml:\"state\"" - ]; + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. + uint32 gseq = 3 [ + (gogoproto.customname) = "GSeq", + (gogoproto.jsontag) = "gseq", + (gogoproto.moretags) = "yaml:\"gseq\"" + ]; + + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. + uint32 oseq = 4 [ + (gogoproto.customname) = "OSeq", + (gogoproto.jsontag) = "oseq", + (gogoproto.moretags) = "yaml:\"oseq\"" + ]; + + // Provider is the account bech32 address of the provider making the bid. + // It is a string representing a valid account bech32 address. + // + // Example: + // "akash1..." + string provider = 5 [ + (cosmos_proto.scalar) = "cosmos.AddressString", + (gogoproto.jsontag) = "provider", + (gogoproto.moretags) = "yaml:\"provider\"" + ]; + + // State represents the state of the lease. + string state = 6 [ + (gogoproto.jsontag) = "state", + (gogoproto.moretags) = "yaml:\"state\"" + ]; } // OrderFilters defines flags for order list filter message OrderFilters { option (gogoproto.equal) = false; + // Owner is the account bech32 address of the user who owns the deployment. + // It is a string representing a valid bech32 account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + + // Dseq (deployment sequence number) is a unique numeric identifier for the deployment. + // It is used to differentiate deployments created by the same owner. uint64 dseq = 2 [ (gogoproto.customname) = "DSeq", (gogoproto.jsontag) = "dseq", (gogoproto.moretags) = "yaml:\"dseq\"" ]; + + // Gseq (group sequence number) is a unique numeric identifier for the group. + // It is used to differentiate groups created by the same owner in a deployment. uint32 gseq = 3 [ (gogoproto.customname) = "GSeq", (gogoproto.jsontag) = "gseq", (gogoproto.moretags) = "yaml:\"gseq\"" ]; + + // Oseq (order sequence) distinguishes multiple orders associated with a single deployment. + // Oseq is incremented when a lease associated with an existing deployment is closed, and a new order is generated. uint32 oseq = 4 [ (gogoproto.customname) = "OSeq", (gogoproto.jsontag) = "oseq", (gogoproto.moretags) = "yaml:\"oseq\"" ]; + + // State represents the state of the lease. string state = 5 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" diff --git a/proto/node/akash/market/v1beta5/genesis.proto b/proto/node/akash/market/v1beta5/genesis.proto index 46077d27..53fe63cc 100644 --- a/proto/node/akash/market/v1beta5/genesis.proto +++ b/proto/node/akash/market/v1beta5/genesis.proto @@ -11,25 +11,32 @@ import "akash/market/v1beta5/order.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// GenesisState defines the basic genesis state used by market module +// GenesisState defines the basic genesis state used by market module. message GenesisState { + // Params holds parameters of the genesis of market. Params params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", (gogoproto.moretags) = 'yaml:"params"' ]; + + // Orders is a list of orders in the genesis state. repeated Order orders = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Orders", (gogoproto.jsontag) = "orders", (gogoproto.moretags) = "yaml:\"orders\"" ]; + + // Leases is a list of leases in the genesis state. repeated akash.market.v1.Lease leases = 3 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "pkg.akt.dev/go/node/market/v1.Leases", (gogoproto.jsontag) = "leases", (gogoproto.moretags) = "yaml:\"leases\"" ]; + + // Bids is a list of bids in the genesis state. repeated Bid bids = 4 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Bids", diff --git a/proto/node/akash/market/v1beta5/leasemsg.proto b/proto/node/akash/market/v1beta5/leasemsg.proto index 78477914..eb1f0781 100644 --- a/proto/node/akash/market/v1beta5/leasemsg.proto +++ b/proto/node/akash/market/v1beta5/leasemsg.proto @@ -10,11 +10,12 @@ import "akash/market/v1/lease.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// MsgCreateLease is sent to create a lease +// MsgCreateLease is sent to create a lease. message MsgCreateLease { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "bid_id.owner"; + // BidId is the unique identifier of the Bid. akash.market.v1.BidID bid_id = 1 [ (gogoproto.customname) = "BidID", (gogoproto.nullable) = false, @@ -23,14 +24,15 @@ message MsgCreateLease { ]; } -// MsgCreateLeaseResponse is the response from creating a lease +// MsgCreateLeaseResponse is the response from creating a lease. message MsgCreateLeaseResponse {} -// MsgWithdrawLease defines an SDK message for withdrawing lease funds +// MsgWithdrawLease defines an SDK message for withdrawing lease funds. message MsgWithdrawLease { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "bid_id.provider"; + // BidId is the unique identifier of the Bid. akash.market.v1.LeaseID bid_id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, @@ -43,11 +45,12 @@ message MsgWithdrawLease { message MsgWithdrawLeaseResponse {} -// MsgCloseLease defines an SDK message for closing order +// MsgCloseLease defines an SDK message for closing order. message MsgCloseLease { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "lease_id.owner"; + // BidId is the unique identifier of the Bid. akash.market.v1.LeaseID lease_id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, diff --git a/proto/node/akash/market/v1beta5/order.proto b/proto/node/akash/market/v1beta5/order.proto index d25a9f95..56961dc7 100644 --- a/proto/node/akash/market/v1beta5/order.proto +++ b/proto/node/akash/market/v1beta5/order.proto @@ -9,34 +9,35 @@ import "akash/market/v1/order.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// Order stores orderID, state of order and other details +// Order stores orderID, state of order and other details. message Order { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; - // State is an enum which refers to state of order + // State is an enum which refers to state of order. enum State { option (gogoproto.goproto_enum_prefix) = false; - // Prefix should start with 0 in enum. So declaring dummy state + // Prefix should start with 0 in enum. So declaring dummy state. invalid = 0 [ (gogoproto.enumvalue_customname) = "OrderStateInvalid" ]; - // OrderOpen denotes state for order open + // OrderOpen denotes state for order open. open = 1 [ (gogoproto.enumvalue_customname) = "OrderOpen" ]; - // OrderMatched denotes state for order matched + // OrderMatched denotes state for order matched. active = 2 [ (gogoproto.enumvalue_customname) = "OrderActive" ]; - // OrderClosed denotes state for order lost + // OrderClosed denotes state for order lost. closed = 3 [ (gogoproto.enumvalue_customname) = "OrderClosed" ]; } - akash.market.v1.OrderID id = 1 [ + // Id is the unique identifier of the order. + akash.market.v1.OrderID id = 1 [ (gogoproto.customname) = "ID", (gogoproto.nullable) = false, (gogoproto.jsontag) = "id", diff --git a/proto/node/akash/market/v1beta5/params.proto b/proto/node/akash/market/v1beta5/params.proto index 266fda49..c9d50032 100644 --- a/proto/node/akash/market/v1beta5/params.proto +++ b/proto/node/akash/market/v1beta5/params.proto @@ -6,14 +6,18 @@ import "cosmos/base/v1beta1/coin.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// Params is the params for the x/market module +// Params is the params for the x/market module. message Params { + + // BidMinDeposit is a parameter for the minimum deposit on a Bid. cosmos.base.v1beta1.Coin bid_min_deposit = 1 [ (gogoproto.customname) = "BidMinDeposit", (gogoproto.nullable) = false, (gogoproto.jsontag) = "bid_min_deposit", (gogoproto.moretags) = "yaml:\"bid_min_deposit\"" ]; + + // OrderMaxBids is a parameter for the maximum number of bids in an order. uint32 order_max_bids = 2 [ (gogoproto.customname) = "OrderMaxBids", (gogoproto.jsontag) = "order_max_bids", diff --git a/proto/node/akash/market/v1beta5/query.proto b/proto/node/akash/market/v1beta5/query.proto index b4217307..c8c4a828 100644 --- a/proto/node/akash/market/v1beta5/query.proto +++ b/proto/node/akash/market/v1beta5/query.proto @@ -22,34 +22,34 @@ import "akash/market/v1beta5/params.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for the market package. service Query { - // Orders queries orders with filters + // Orders queries orders with filters. rpc Orders(QueryOrdersRequest) returns (QueryOrdersResponse) { option (google.api.http).get = "/akash/market/v1beta5/orders/list"; } - // Order queries order details + // Order queries order details. rpc Order(QueryOrderRequest) returns (QueryOrderResponse) { option (google.api.http).get = "/akash/market/v1beta5/orders/info"; } - // Bids queries bids with filters + // Bids queries bids with filters. rpc Bids(QueryBidsRequest) returns (QueryBidsResponse) { option (google.api.http).get = "/akash/market/v1beta5/bids/list"; } - // Bid queries bid details + // Bid queries bid details. rpc Bid(QueryBidRequest) returns (QueryBidResponse) { option (google.api.http).get = "/akash/market/v1beta5/bids/info"; } - // Leases queries leases with filters + // Leases queries leases with filters. rpc Leases(QueryLeasesRequest) returns (QueryLeasesResponse) { option (google.api.http).get = "/akash/market/v1beta5/leases/list"; } - // Lease queries lease details + // Lease queries lease details. rpc Lease(QueryLeaseRequest) returns (QueryLeaseResponse) { option (google.api.http).get = "/akash/market/v1beta5/leases/info"; } @@ -60,96 +60,114 @@ service Query { } } -// QueryOrdersRequest is request type for the Query/Orders RPC method +// QueryOrdersRequest is request type for the Query/Orders RPC method. message QueryOrdersRequest { + // Filters holds the fields to filter orders. akash.market.v1beta5.OrderFilters filters = 1 [ (gogoproto.nullable) = false ]; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } // QueryOrdersResponse is response type for the Query/Orders RPC method message QueryOrdersResponse { + // Orders is a list of market orders. repeated Order orders = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Orders" ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } -// QueryOrderRequest is request type for the Query/Order RPC method +// QueryOrderRequest is request type for the Query/Order RPC method. message QueryOrderRequest { + // Id is the unique identifier of the Order. akash.market.v1.OrderID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID" ]; } -// QueryOrderResponse is response type for the Query/Order RPC method +// QueryOrderResponse is response type for the Query/Order RPC method. message QueryOrderResponse { + // Order represents a market order. Order order = 1 [ (gogoproto.nullable) = false ]; } -// QueryBidsRequest is request type for the Query/Bids RPC method +// QueryBidsRequest is request type for the Query/Bids RPC method. message QueryBidsRequest { + // Filters holds the fields to filter bids. akash.market.v1beta5.BidFilters filters = 1 [ (gogoproto.nullable) = false ]; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } // QueryBidsResponse is response type for the Query/Bids RPC method message QueryBidsResponse { + // Bids is a list of deployment bids. repeated QueryBidResponse bids = 1 [ (gogoproto.nullable) = false ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } -// QueryBidRequest is request type for the Query/Bid RPC method +// QueryBidRequest is request type for the Query/Bid RPC method. message QueryBidRequest { + // Id is the unique identifier for the Bid. akash.market.v1.BidID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID" ]; } -// QueryBidResponse is response type for the Query/Bid RPC method +// QueryBidResponse is response type for the Query/Bid RPC method. message QueryBidResponse { + // Bid represents a deployment bid. Bid bid = 1 [ (gogoproto.nullable) = false ]; + // EscrowAccount represents the escrow account created for the Bid. akash.escrow.v1.Account escrow_account = 2 [ (gogoproto.nullable) = false ]; } -// QueryLeasesRequest is request type for the Query/Leases RPC method +// QueryLeasesRequest is request type for the Query/Leases RPC method. message QueryLeasesRequest { + // Filters holds the fields to filter leases. akash.market.v1.LeaseFilters filters = 1 [ (gogoproto.nullable) = false ]; + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 2; } -// QueryLeasesResponse is response type for the Query/Leases RPC method +// QueryLeasesResponse is response type for the Query/Leases RPC method. message QueryLeasesResponse { + // Leases is a list of Lease. repeated QueryLeaseResponse leases = 1 [ (gogoproto.nullable) = false ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } -// QueryLeaseRequest is request type for the Query/Lease RPC method +// QueryLeaseRequest is request type for the Query/Lease RPC method. message QueryLeaseRequest { + // Id is the unique identifier of the Lease. akash.market.v1.LeaseID id = 1 [ (gogoproto.nullable) = false, (gogoproto.customname) = "ID" @@ -158,9 +176,11 @@ message QueryLeaseRequest { // QueryLeaseResponse is response type for the Query/Lease RPC method message QueryLeaseResponse { + // Lease holds the lease for a deployment. akash.market.v1.Lease lease = 1 [ (gogoproto.nullable) = false ]; + // EscrowPayment holds information about the Lease's fractional payment. akash.escrow.v1.FractionalPayment escrow_payment = 2 [ (gogoproto.nullable) = false ]; diff --git a/proto/node/akash/market/v1beta5/resourcesoffer.proto b/proto/node/akash/market/v1beta5/resourcesoffer.proto index e0f1243c..9b86bf76 100644 --- a/proto/node/akash/market/v1beta5/resourcesoffer.proto +++ b/proto/node/akash/market/v1beta5/resourcesoffer.proto @@ -8,14 +8,16 @@ import "akash/base/resources/v1beta4/resources.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; // ResourceOffer describes resources that provider is offering -// for deployment +// for deployment. message ResourceOffer { option (gogoproto.equal) = true; + // Resources holds information about bid resources. akash.base.resources.v1beta4.Resources resources = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "resources", (gogoproto.moretags) = "yaml:\"resources\"" ]; + // Count is the number of resources. uint32 count = 2 [ (gogoproto.jsontag) = "count", (gogoproto.moretags) = "yaml:\"count\"" diff --git a/proto/node/akash/market/v1beta5/service.proto b/proto/node/akash/market/v1beta5/service.proto index c545bc67..4cc729d5 100644 --- a/proto/node/akash/market/v1beta5/service.proto +++ b/proto/node/akash/market/v1beta5/service.proto @@ -8,7 +8,7 @@ import "cosmos/msg/v1/msg.proto"; option go_package = "pkg.akt.dev/go/node/market/v1beta5"; -// Msg defines the market Msg service +// Msg defines the market Msg service. service Msg { option (cosmos.msg.v1.service) = true; // CreateBid defines a method to create a bid given proper inputs. diff --git a/proto/node/akash/staking/v1beta3/genesis.proto b/proto/node/akash/staking/v1beta3/genesis.proto index ed814ec7..b0376836 100644 --- a/proto/node/akash/staking/v1beta3/genesis.proto +++ b/proto/node/akash/staking/v1beta3/genesis.proto @@ -6,8 +6,9 @@ import "akash/staking/v1beta3/params.proto"; option go_package = "pkg.akt.dev/go/node/staking/v1beta3"; -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis staking parameters. message GenesisState { + // Params holds parameters of the genesis of staking. Params params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", diff --git a/proto/node/akash/staking/v1beta3/params.proto b/proto/node/akash/staking/v1beta3/params.proto index 032ed383..0f97d7a1 100644 --- a/proto/node/akash/staking/v1beta3/params.proto +++ b/proto/node/akash/staking/v1beta3/params.proto @@ -4,9 +4,9 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/staking/v1beta3"; -// Params extends the parameters for the x/staking module +// Params extends the parameters for the x/staking module. message Params { - // min_commission_rate is the chain-wide minimum commission rate that a validator can charge their delegators + // MinCommissionRate is the chain-wide minimum commission rate that a validator can charge their delegators. string min_commission_rate = 1 [ (gogoproto.moretags) = "yaml:\"min_commission_rate\"", (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", diff --git a/proto/node/akash/staking/v1beta3/query.proto b/proto/node/akash/staking/v1beta3/query.proto index dc1c9abd..37701057 100644 --- a/proto/node/akash/staking/v1beta3/query.proto +++ b/proto/node/akash/staking/v1beta3/query.proto @@ -9,7 +9,7 @@ import "akash/staking/v1beta3/params.proto"; option go_package = "pkg.akt.dev/go/node/staking/v1beta3"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service of the staking package. service Query { // Params returns the total set of minting parameters. rpc Params(QueryParamsRequest) returns (QueryParamsResponse) { @@ -22,7 +22,7 @@ message QueryParamsRequest {} // QueryParamsResponse is the response type for the Query/Params RPC method. message QueryParamsResponse { - // params defines the parameters of the module. + // Params defines the parameters of the module. Params params = 1 [ (gogoproto.nullable) = false, (amino.dont_omitempty) = true diff --git a/proto/node/akash/staking/v1beta3/service.proto b/proto/node/akash/staking/v1beta3/service.proto index 00834332..bc0a21cb 100644 --- a/proto/node/akash/staking/v1beta3/service.proto +++ b/proto/node/akash/staking/v1beta3/service.proto @@ -6,7 +6,7 @@ import "cosmos/msg/v1/msg.proto"; option go_package = "pkg.akt.dev/go/node/staking/v1beta3"; -// Msg defines the market Msg service +// Msg defines the market Msg service. service Msg { option (cosmos.msg.v1.service) = true; // UpdateParams defines a governance operation for updating the x/market module diff --git a/proto/node/akash/take/v1/genesis.proto b/proto/node/akash/take/v1/genesis.proto index 9e01a192..21d44be3 100644 --- a/proto/node/akash/take/v1/genesis.proto +++ b/proto/node/akash/take/v1/genesis.proto @@ -6,8 +6,9 @@ import "akash/take/v1/params.proto"; option go_package = "pkg.akt.dev/go/node/take/v1"; -// GenesisState stores slice of genesis deployment instance +// GenesisState stores slice of genesis staking parameters. message GenesisState { + // Params holds parameters of the genesis of staking. Params params = 1 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "params", diff --git a/proto/node/akash/take/v1/params.proto b/proto/node/akash/take/v1/params.proto index 8a4b7dfe..f0d9133b 100644 --- a/proto/node/akash/take/v1/params.proto +++ b/proto/node/akash/take/v1/params.proto @@ -6,13 +6,16 @@ import "gogoproto/gogo.proto"; option go_package = "pkg.akt.dev/go/node/take/v1"; -// DenomTakeRate describes take rate for specified denom +// DenomTakeRate describes take rate for specified denom. message DenomTakeRate { + // Denom is the denomination of the take rate (uakt, usdc, etc.). string denom = 1 [ (gogoproto.customname) = "Denom", (gogoproto.jsontag) = "denom", (gogoproto.moretags) = "yaml:\"denom\"" ]; + + // Rate is the value of the take rate. uint32 rate = 2 [ (gogoproto.customname) = "Rate", (gogoproto.jsontag) = "rate", @@ -20,9 +23,9 @@ message DenomTakeRate { ]; } -// Params defines the parameters for the x/take package +// Params defines the parameters for the x/take package. message Params { - // denom -> % take rate + // DenomTakeRates is a list of configured take rates. repeated DenomTakeRate denom_take_rates = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "DenomTakeRates", @@ -31,6 +34,7 @@ message Params { (gogoproto.moretags) = "yaml:\"denom_take_rates\"" ]; + // DefaultTakeRate holds the default take rate. uint32 default_take_rate = 2 [ (gogoproto.customname) = "DefaultTakeRate", (gogoproto.jsontag) = "default_take_rate", diff --git a/proto/node/akash/take/v1/query.proto b/proto/node/akash/take/v1/query.proto index 0489a1dd..ff467980 100644 --- a/proto/node/akash/take/v1/query.proto +++ b/proto/node/akash/take/v1/query.proto @@ -21,7 +21,7 @@ message QueryParamsResponse { ]; } -// Query defines the gRPC querier service +// Query defines the gRPC querier service of the take package. service Query { // Params returns the total set of minting parameters. rpc Params(QueryParamsRequest) returns (QueryParamsResponse) { From 027484908f394e2bebcb5cf7ba7623037b2a8187 Mon Sep 17 00:00:00 2001 From: Joao Luna Date: Fri, 20 Dec 2024 22:57:45 +0000 Subject: [PATCH 3/4] docs: add provider package docs and improve existing ones --- go/node/audit/v1/audit.pb.go | 13 +++++--- go/node/cert/v1/cert.pb.go | 5 +-- go/node/deployment/v1/deployment.pb.go | 3 +- go/node/escrow/v1/fractional_payment.pb.go | 2 +- go/node/provider/v1beta4/event.pb.go | 23 +++++++++++-- go/node/provider/v1beta4/genesis.pb.go | 3 +- go/node/provider/v1beta4/msg.pb.go | 17 +++++++--- go/node/provider/v1beta4/provider.pb.go | 27 +++++++++++---- go/node/provider/v1beta4/query.pb.go | 13 ++++++-- go/node/provider/v1beta4/service.pb.go | 12 +++---- proto/node/akash/audit/v1/audit.proto | 13 +++++--- .../akash/base/attributes/v1/attribute.proto | 4 +-- proto/node/akash/cert/v1/cert.proto | 5 +-- .../node/akash/deployment/v1/deployment.proto | 3 +- proto/node/akash/escrow/v1/account.proto | 2 +- .../akash/escrow/v1/fractional_payment.proto | 2 +- proto/node/akash/provider/v1beta4/event.proto | 33 ++++++++++++++----- .../node/akash/provider/v1beta4/genesis.proto | 3 +- proto/node/akash/provider/v1beta4/msg.proto | 14 ++++++-- .../akash/provider/v1beta4/provider.proto | 22 +++++++++++-- proto/node/akash/provider/v1beta4/query.proto | 13 ++++++-- .../node/akash/provider/v1beta4/service.proto | 8 ++--- 22 files changed, 177 insertions(+), 63 deletions(-) diff --git a/go/node/audit/v1/audit.pb.go b/go/node/audit/v1/audit.pb.go index bdb47900..1b303875 100644 --- a/go/node/audit/v1/audit.pb.go +++ b/go/node/audit/v1/audit.pb.go @@ -25,7 +25,10 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Provider stores owner, auditor and attributes details. +// AuditedProvider stores owner, auditor and attributes details. +// An AuditedProvider is a provider that has undergone a verification or auditing process to ensure that it meets certain standards or requirements by an auditor. +// An auditor can be any valid account on-chain. +// NOTE: There are certain teams providing auditing services, which should be accounted for when deploying. type AuditedProvider struct { // Owner is the account bech32 address of the provider. // It is a string representing a valid account address. @@ -33,7 +36,7 @@ type AuditedProvider struct { // Example: // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - // Auditor is the account address of the auditor. + // Auditor is the account bech32 address of the auditor. // It is a string representing a valid account address. // // Example: @@ -99,7 +102,7 @@ func (m *AuditedProvider) GetAttributes() pkg_akt_dev_go_node_types_attributes_v } // AuditedAttributesStore stores the audited attributes of the provider. -// Audited attributes are attributes verified by the auditor. +// Attributes that have been audited are those that have been verified by an auditor. type AuditedAttributesStore struct { // Attributes holds a list of key-value pairs of provider attributes. // Attributes are arbitrary values that a provider exposes. @@ -148,9 +151,9 @@ func (m *AuditedAttributesStore) GetAttributes() pkg_akt_dev_go_node_types_attri // AttributesFilters defines attribute filters that can be used to filter deployments. type AttributesFilters struct { - // Auditors contains a list of account addresses. + // Auditors contains a list of auditor account bech32 addresses. Auditors []string `protobuf:"bytes,1,rep,name=auditors,proto3" json:"auditors" yaml:"auditors"` - // Owners contains a list of account addresses. + // Owners contains a list of owner account bech32 addresses. Owners []string `protobuf:"bytes,2,rep,name=owners,proto3" json:"owners" yaml:"owners"` } diff --git a/go/node/cert/v1/cert.pb.go b/go/node/cert/v1/cert.pb.go index fe68898c..d3e10aed 100644 --- a/go/node/cert/v1/cert.pb.go +++ b/go/node/cert/v1/cert.pb.go @@ -115,14 +115,15 @@ func (m *ID) GetSerial() string { } // Certificate stores state, certificate and it's public key. +// The certificate is required for several transactions including deployment of a workload to verify the identity of the tenant and secure the deployment. type Certificate struct { // State is the state of the certificate. // CertificateValid denotes state for deployment active. // CertificateRevoked denotes state for deployment closed. State State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.cert.v1.State" json:"state" yaml:"state"` - // Cert holds the bytes representing the certificate. + // Cert holds the bytes of the certificate. Cert []byte `protobuf:"bytes,3,opt,name=cert,proto3" json:"cert" yaml:"cert"` - // PubKey holds the public key. + // PubKey holds the public key of the certificate. Pubkey []byte `protobuf:"bytes,4,opt,name=pubkey,proto3" json:"pubkey" yaml:"pubkey"` } diff --git a/go/node/deployment/v1/deployment.pb.go b/go/node/deployment/v1/deployment.pb.go index 8dcf1cb2..d981c366 100644 --- a/go/node/deployment/v1/deployment.pb.go +++ b/go/node/deployment/v1/deployment.pb.go @@ -120,7 +120,8 @@ func (m *DeploymentID) GetDSeq() uint64 { type Deployment struct { // ID is the unique identifier of the deployment. ID DeploymentID `protobuf:"bytes,1,opt,name=id,proto3" json:"id" yaml:"id"` - // State defines the sate of the deployment. A deployment can be either active or inactive. + // State defines the sate of the deployment. + // A deployment can be either active or inactive. State Deployment_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1.Deployment_State" json:"state" yaml:"state"` // Hash is an hashed representation of the deployment. Hash []byte `protobuf:"bytes,3,opt,name=hash,proto3" json:"hash" yaml:"hash"` diff --git a/go/node/escrow/v1/fractional_payment.pb.go b/go/node/escrow/v1/fractional_payment.pb.go index 75f0d8ab..f983a4a6 100644 --- a/go/node/escrow/v1/fractional_payment.pb.go +++ b/go/node/escrow/v1/fractional_payment.pb.go @@ -79,7 +79,7 @@ type FractionalPayment struct { Rate types.DecCoin `protobuf:"bytes,5,opt,name=rate,proto3" json:"rate" yaml:"rate"` // Balance is the current available balance. Balance types.DecCoin `protobuf:"bytes,6,opt,name=balance,proto3" json:"balance" yaml:"balance"` - // Withdrawn is the amount of coins withdrawn by the FractionalPayment. + // Withdrawn corresponds to the amount of coins withdrawn by the FractionalPayment. Withdrawn types.Coin `protobuf:"bytes,7,opt,name=withdrawn,proto3" json:"withdrawn" yaml:"withdrawn"` } diff --git a/go/node/provider/v1beta4/event.pb.go b/go/node/provider/v1beta4/event.pb.go index d9711e1c..e4efa288 100644 --- a/go/node/provider/v1beta4/event.pb.go +++ b/go/node/provider/v1beta4/event.pb.go @@ -24,8 +24,14 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// EventProviderCreated defines an SDK message for provider created event +// EventProviderCreated defines an SDK message for provider created event. +// It contains all the required information to identify a provider on-chain. type EventProviderCreated struct { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` } @@ -69,8 +75,14 @@ func (m *EventProviderCreated) GetOwner() string { return "" } -// EventProviderUpdated defines an SDK message for provider updated event +// EventProviderUpdated defines an SDK message for provider updated event. +// It contains all the required information to identify a provider on-chain. type EventProviderUpdated struct { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` } @@ -114,8 +126,13 @@ func (m *EventProviderUpdated) GetOwner() string { return "" } -// EventProviderDeleted defines an SDK message for provider deleted event +// EventProviderDeleted defines an SDK message for provider deleted event. type EventProviderDeleted struct { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` } diff --git a/go/node/provider/v1beta4/genesis.pb.go b/go/node/provider/v1beta4/genesis.pb.go index 5d571439..37d3c86c 100644 --- a/go/node/provider/v1beta4/genesis.pb.go +++ b/go/node/provider/v1beta4/genesis.pb.go @@ -23,8 +23,9 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// GenesisState defines the basic genesis state used by provider module +// GenesisState defines the basic genesis state used by provider module. type GenesisState struct { + // Providers is a list of genesis providers. Providers Providers `protobuf:"bytes,1,rep,name=providers,proto3,castrepeated=Providers" json:"providers" yaml:"providers"` } diff --git a/go/node/provider/v1beta4/msg.pb.go b/go/node/provider/v1beta4/msg.pb.go index 986bb01b..e047aa77 100644 --- a/go/node/provider/v1beta4/msg.pb.go +++ b/go/node/provider/v1beta4/msg.pb.go @@ -27,12 +27,21 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// MsgCreateProvider defines an SDK message for creating a provider +// MsgCreateProvider defines an SDK message for creating a provider. type MsgCreateProvider struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - HostURI string `protobuf:"bytes,2,opt,name=host_uri,json=hostUri,proto3" json:"host_uri" yaml:"host_uri"` + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // HostURI is the Uniform Resource Identifier for provider connection. + // This URI is used to directly connect to the provider to perform tasks such as sending the manifest. + HostURI string `protobuf:"bytes,2,opt,name=host_uri,json=hostUri,proto3" json:"host_uri" yaml:"host_uri"` + // Attributes is a list of arbitrary attribute key-value pairs. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,3,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes" yaml:"attributes"` - Info Info `protobuf:"bytes,4,opt,name=info,proto3" json:"info" yaml:"info"` + // Info contains additional provider information. + Info Info `protobuf:"bytes,4,opt,name=info,proto3" json:"info" yaml:"info"` } func (m *MsgCreateProvider) Reset() { *m = MsgCreateProvider{} } diff --git a/go/node/provider/v1beta4/provider.pb.go b/go/node/provider/v1beta4/provider.pb.go index 442e3e58..488d8bf8 100644 --- a/go/node/provider/v1beta4/provider.pb.go +++ b/go/node/provider/v1beta4/provider.pb.go @@ -26,9 +26,11 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// Info +// Info contains information on the provider. type Info struct { - EMail string `protobuf:"bytes,1,opt,name=email,proto3" json:"email" yaml:"email"` + // Email is the email address to contact the provider. + EMail string `protobuf:"bytes,1,opt,name=email,proto3" json:"email" yaml:"email"` + // Website is the URL to the landing page or socials of the provider. Website string `protobuf:"bytes,2,opt,name=website,proto3" json:"website" yaml:"website"` } @@ -79,12 +81,25 @@ func (m *Info) GetWebsite() string { return "" } -// Provider stores owner and host details +// Provider stores owner and host details. +// Akash providers are entities that contribute computing resources to the network. +// They can be individuals or organizations with underutilized computing resources, such as data centers or personal servers. +// Providers participate in the network by running the Akash node software and setting the price for their services. +// Users can then choose a provider based on factors such as cost, performance, and location. type Provider struct { - Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` - HostURI string `protobuf:"bytes,2,opt,name=host_uri,json=hostUri,proto3" json:"host_uri" yaml:"host_uri"` + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner" yaml:"owner"` + // HostURI is the Uniform Resource Identifier for provider connection. + // This URI is used to directly connect to the provider to perform tasks such as sending the manifest. + HostURI string `protobuf:"bytes,2,opt,name=host_uri,json=hostUri,proto3" json:"host_uri" yaml:"host_uri"` + // Attributes is a list of arbitrary attribute key-value pairs. Attributes pkg_akt_dev_go_node_types_attributes_v1.Attributes `protobuf:"bytes,3,rep,name=attributes,proto3,castrepeated=pkg.akt.dev/go/node/types/attributes/v1.Attributes" json:"attributes" yaml:"attributes"` - Info Info `protobuf:"bytes,4,opt,name=info,proto3" json:"info" yaml:"info"` + // Info contains additional provider information. + Info Info `protobuf:"bytes,4,opt,name=info,proto3" json:"info" yaml:"info"` } func (m *Provider) Reset() { *m = Provider{} } diff --git a/go/node/provider/v1beta4/query.pb.go b/go/node/provider/v1beta4/query.pb.go index 92a4a195..e86f0241 100644 --- a/go/node/provider/v1beta4/query.pb.go +++ b/go/node/provider/v1beta4/query.pb.go @@ -32,6 +32,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // QueryProvidersRequest is request type for the Query/Providers RPC method type QueryProvidersRequest struct { + // Pagination is used to paginate request. Pagination *query.PageRequest `protobuf:"bytes,1,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -77,7 +78,9 @@ func (m *QueryProvidersRequest) GetPagination() *query.PageRequest { // QueryProvidersResponse is response type for the Query/Providers RPC method type QueryProvidersResponse struct { - Providers Providers `protobuf:"bytes,1,rep,name=providers,proto3,castrepeated=Providers" json:"providers"` + // Providers is a list of providers on the network. + Providers Providers `protobuf:"bytes,1,rep,name=providers,proto3,castrepeated=Providers" json:"providers"` + // Pagination contains the information about response pagination. Pagination *query.PageResponse `protobuf:"bytes,2,opt,name=pagination,proto3" json:"pagination,omitempty"` } @@ -130,6 +133,11 @@ func (m *QueryProvidersResponse) GetPagination() *query.PageResponse { // QueryProviderRequest is request type for the Query/Provider RPC method type QueryProviderRequest struct { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"` } @@ -173,8 +181,9 @@ func (m *QueryProviderRequest) GetOwner() string { return "" } -// QueryProviderResponse is response type for the Query/Provider RPC method +// QueryProviderResponse is response type for the Query/Provider RPC method. type QueryProviderResponse struct { + // Provider holds the representation of a provider on the network. Provider Provider `protobuf:"bytes,1,opt,name=provider,proto3" json:"provider"` } diff --git a/go/node/provider/v1beta4/service.pb.go b/go/node/provider/v1beta4/service.pb.go index a7b50e43..470561b3 100644 --- a/go/node/provider/v1beta4/service.pb.go +++ b/go/node/provider/v1beta4/service.pb.go @@ -61,11 +61,11 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type MsgClient interface { - // CreateProvider defines a method that creates a provider given the proper inputs + // CreateProvider defines a method that creates a provider given the proper inputs. CreateProvider(ctx context.Context, in *MsgCreateProvider, opts ...grpc.CallOption) (*MsgCreateProviderResponse, error) - // UpdateProvider defines a method that updates a provider given the proper inputs + // UpdateProvider defines a method that updates a provider given the proper inputs. UpdateProvider(ctx context.Context, in *MsgUpdateProvider, opts ...grpc.CallOption) (*MsgUpdateProviderResponse, error) - // DeleteProvider defines a method that deletes a provider given the proper inputs + // DeleteProvider defines a method that deletes a provider given the proper inputs. DeleteProvider(ctx context.Context, in *MsgDeleteProvider, opts ...grpc.CallOption) (*MsgDeleteProviderResponse, error) } @@ -106,11 +106,11 @@ func (c *msgClient) DeleteProvider(ctx context.Context, in *MsgDeleteProvider, o // MsgServer is the server API for Msg service. type MsgServer interface { - // CreateProvider defines a method that creates a provider given the proper inputs + // CreateProvider defines a method that creates a provider given the proper inputs. CreateProvider(context.Context, *MsgCreateProvider) (*MsgCreateProviderResponse, error) - // UpdateProvider defines a method that updates a provider given the proper inputs + // UpdateProvider defines a method that updates a provider given the proper inputs. UpdateProvider(context.Context, *MsgUpdateProvider) (*MsgUpdateProviderResponse, error) - // DeleteProvider defines a method that deletes a provider given the proper inputs + // DeleteProvider defines a method that deletes a provider given the proper inputs. DeleteProvider(context.Context, *MsgDeleteProvider) (*MsgDeleteProviderResponse, error) } diff --git a/proto/node/akash/audit/v1/audit.proto b/proto/node/akash/audit/v1/audit.proto index aa82020a..50442ad1 100644 --- a/proto/node/akash/audit/v1/audit.proto +++ b/proto/node/akash/audit/v1/audit.proto @@ -6,7 +6,10 @@ import "akash/base/attributes/v1/attribute.proto"; option go_package = "pkg.akt.dev/go/node/audit/v1"; -// Provider stores owner, auditor and attributes details. +// AuditedProvider stores owner, auditor and attributes details. +// An AuditedProvider is a provider that has undergone a verification or auditing process to ensure that it meets certain standards or requirements by an auditor. +// An auditor can be any valid account on-chain. +// NOTE: There are certain teams providing auditing services, which should be accounted for when deploying. message AuditedProvider { // Owner is the account bech32 address of the provider. // It is a string representing a valid account address. @@ -18,7 +21,7 @@ message AuditedProvider { (gogoproto.moretags) = "yaml:\"owner\"" ]; - // Auditor is the account address of the auditor. + // Auditor is the account bech32 address of the auditor. // It is a string representing a valid account address. // // Example: @@ -39,7 +42,7 @@ message AuditedProvider { } // AuditedAttributesStore stores the audited attributes of the provider. -// Audited attributes are attributes verified by the auditor. +// Attributes that have been audited are those that have been verified by an auditor. message AuditedAttributesStore { option (gogoproto.equal) = false; @@ -57,13 +60,13 @@ message AuditedAttributesStore { message AttributesFilters { option (gogoproto.equal) = false; - // Auditors contains a list of account addresses. + // Auditors contains a list of auditor account bech32 addresses. repeated string auditors = 1 [ (gogoproto.jsontag) = "auditors", (gogoproto.moretags) = "yaml:\"auditors\"" ]; - // Owners contains a list of account addresses. + // Owners contains a list of owner account bech32 addresses. repeated string owners = 2 [ (gogoproto.jsontag) = "owners", (gogoproto.moretags) = "yaml:\"owners\"" diff --git a/proto/node/akash/base/attributes/v1/attribute.proto b/proto/node/akash/base/attributes/v1/attribute.proto index 74b16e7d..63b1e643 100644 --- a/proto/node/akash/base/attributes/v1/attribute.proto +++ b/proto/node/akash/base/attributes/v1/attribute.proto @@ -13,9 +13,9 @@ message Attribute { option (gogoproto.goproto_getters) = false; // Key of the attribute (e.g., "region", "cpu_architecture", etc.). - string key = 1 [(gogoproto.moretags) = "yaml:\"key\""]; + string key = 1 [(gogoproto.moretags) = "yaml:\"key\""]; // Value of the attribute (e.g., "us-west", "x86_64", etc.). - string value = 2 [(gogoproto.moretags) = "yaml:\"value\""]; + string value = 2 [(gogoproto.moretags) = "yaml:\"value\""]; } // SignedBy represents validation accounts that tenant expects signatures for provider attributes. diff --git a/proto/node/akash/cert/v1/cert.proto b/proto/node/akash/cert/v1/cert.proto index 3d75e384..7832a040 100644 --- a/proto/node/akash/cert/v1/cert.proto +++ b/proto/node/akash/cert/v1/cert.proto @@ -48,6 +48,7 @@ message ID { } // Certificate stores state, certificate and it's public key. +// The certificate is required for several transactions including deployment of a workload to verify the identity of the tenant and secure the deployment. message Certificate { // State is the state of the certificate. @@ -58,13 +59,13 @@ message Certificate { (gogoproto.moretags) = "yaml:\"state\"" ]; - // Cert holds the bytes representing the certificate. + // Cert holds the bytes of the certificate. bytes cert = 3 [ (gogoproto.jsontag) = "cert", (gogoproto.moretags) = "yaml:\"cert\"" ]; - // PubKey holds the public key. + // PubKey holds the public key of the certificate. bytes pubkey = 4 [ (gogoproto.jsontag) = "pubkey", (gogoproto.moretags) = "yaml:\"pubkey\"" diff --git a/proto/node/akash/deployment/v1/deployment.proto b/proto/node/akash/deployment/v1/deployment.proto index fc291a0b..63cc8eac 100644 --- a/proto/node/akash/deployment/v1/deployment.proto +++ b/proto/node/akash/deployment/v1/deployment.proto @@ -56,7 +56,8 @@ message Deployment { (gogoproto.moretags) = "yaml:\"id\"" ]; - // State defines the sate of the deployment. A deployment can be either active or inactive. + // State defines the sate of the deployment. + // A deployment can be either active or inactive. State state = 2 [ (gogoproto.jsontag) = "state", (gogoproto.moretags) = "yaml:\"state\"" diff --git a/proto/node/akash/escrow/v1/account.proto b/proto/node/akash/escrow/v1/account.proto index 11186b35..ae9881d5 100644 --- a/proto/node/akash/escrow/v1/account.proto +++ b/proto/node/akash/escrow/v1/account.proto @@ -59,7 +59,7 @@ message Account { ]; // Balance holds the unspent coins received from the owner's wallet. - cosmos.base.v1beta1.DecCoin balance = 4 [ + cosmos.base.v1beta1.DecCoin balance = 4 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "balance", (gogoproto.moretags) = "yaml:\"balance\"" diff --git a/proto/node/akash/escrow/v1/fractional_payment.proto b/proto/node/akash/escrow/v1/fractional_payment.proto index ddf358b8..11fa4427 100644 --- a/proto/node/akash/escrow/v1/fractional_payment.proto +++ b/proto/node/akash/escrow/v1/fractional_payment.proto @@ -79,7 +79,7 @@ message FractionalPayment { (gogoproto.moretags) = "yaml:\"balance\"" ]; - // Withdrawn is the amount of coins withdrawn by the FractionalPayment. + // Withdrawn corresponds to the amount of coins withdrawn by the FractionalPayment. cosmos.base.v1beta1.Coin withdrawn = 7 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "withdrawn", diff --git a/proto/node/akash/provider/v1beta4/event.proto b/proto/node/akash/provider/v1beta4/event.proto index 5ff9c7fe..fff19a2a 100644 --- a/proto/node/akash/provider/v1beta4/event.proto +++ b/proto/node/akash/provider/v1beta4/event.proto @@ -7,8 +7,14 @@ import "cosmos_proto/cosmos.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// EventProviderCreated defines an SDK message for provider created event +// EventProviderCreated defines an SDK message for provider created event. +// It contains all the required information to identify a provider on-chain. message EventProviderCreated { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", @@ -16,8 +22,14 @@ message EventProviderCreated { ]; } -// EventProviderUpdated defines an SDK message for provider updated event +// EventProviderUpdated defines an SDK message for provider updated event. +// It contains all the required information to identify a provider on-chain. message EventProviderUpdated { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", @@ -25,11 +37,16 @@ message EventProviderUpdated { ]; } -// EventProviderDeleted defines an SDK message for provider deleted event +// EventProviderDeleted defines an SDK message for provider deleted event. message EventProviderDeleted { - string owner = 1 [ - (cosmos_proto.scalar) = "cosmos.AddressString", - (gogoproto.jsontag) = "owner", - (gogoproto.moretags) = "yaml:\"owner\"" - ]; + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string owner = 1 [ + (cosmos_proto.scalar) = "cosmos.AddressString", + (gogoproto.jsontag) = "owner", + (gogoproto.moretags) = "yaml:\"owner\"" + ]; } diff --git a/proto/node/akash/provider/v1beta4/genesis.proto b/proto/node/akash/provider/v1beta4/genesis.proto index 35455f67..58ea24b9 100644 --- a/proto/node/akash/provider/v1beta4/genesis.proto +++ b/proto/node/akash/provider/v1beta4/genesis.proto @@ -6,8 +6,9 @@ import "akash/provider/v1beta4/provider.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// GenesisState defines the basic genesis state used by provider module +// GenesisState defines the basic genesis state used by provider module. message GenesisState { + // Providers is a list of genesis providers. repeated Provider providers = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Providers", diff --git a/proto/node/akash/provider/v1beta4/msg.proto b/proto/node/akash/provider/v1beta4/msg.proto index f629ad76..0347269b 100644 --- a/proto/node/akash/provider/v1beta4/msg.proto +++ b/proto/node/akash/provider/v1beta4/msg.proto @@ -11,21 +11,30 @@ import "akash/provider/v1beta4/provider.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// MsgCreateProvider defines an SDK message for creating a provider +// MsgCreateProvider defines an SDK message for creating a provider. message MsgCreateProvider { option (gogoproto.equal) = false; option (cosmos.msg.v1.signer) = "owner"; - string owner = 1 [ + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // HostURI is the Uniform Resource Identifier for provider connection. + // This URI is used to directly connect to the provider to perform tasks such as sending the manifest. string host_uri = 2 [ (gogoproto.customname) = "HostURI", (gogoproto.jsontag) = "host_uri", (gogoproto.moretags) = "yaml:\"host_uri\"" ]; + + // Attributes is a list of arbitrary attribute key-value pairs. repeated akash.base.attributes.v1.Attribute attributes = 3 [ (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", (gogoproto.nullable) = false, @@ -33,6 +42,7 @@ message MsgCreateProvider { (gogoproto.moretags) = "yaml:\"attributes\"" ]; + // Info contains additional provider information. akash.provider.v1beta4.Info info = 4 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "info", diff --git a/proto/node/akash/provider/v1beta4/provider.proto b/proto/node/akash/provider/v1beta4/provider.proto index ed341725..737f5a82 100644 --- a/proto/node/akash/provider/v1beta4/provider.proto +++ b/proto/node/akash/provider/v1beta4/provider.proto @@ -8,34 +8,49 @@ import "akash/base/attributes/v1/attribute.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// Info +// Info contains information on the provider. message Info { + // Email is the email address to contact the provider. string email = 1 [ (gogoproto.customname) = "EMail", (gogoproto.jsontag) = "email", (gogoproto.moretags) = "yaml:\"email\"" ]; + // Website is the URL to the landing page or socials of the provider. string website = 2 [ (gogoproto.jsontag) = "website", (gogoproto.moretags) = "yaml:\"website\"" ]; } -// Provider stores owner and host details +// Provider stores owner and host details. +// Akash providers are entities that contribute computing resources to the network. +// They can be individuals or organizations with underutilized computing resources, such as data centers or personal servers. +// Providers participate in the network by running the Akash node software and setting the price for their services. +// Users can then choose a provider based on factors such as cost, performance, and location. message Provider { option (gogoproto.equal) = false; option (gogoproto.goproto_stringer) = false; - string owner = 1 [ + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." + string owner = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString", (gogoproto.jsontag) = "owner", (gogoproto.moretags) = "yaml:\"owner\"" ]; + // HostURI is the Uniform Resource Identifier for provider connection. + // This URI is used to directly connect to the provider to perform tasks such as sending the manifest. string host_uri = 2 [ (gogoproto.customname) = "HostURI", (gogoproto.jsontag) = "host_uri", (gogoproto.moretags) = "yaml:\"host_uri\"" ]; + + // Attributes is a list of arbitrary attribute key-value pairs. repeated akash.base.attributes.v1.Attribute attributes = 3 [ (gogoproto.castrepeated) = "pkg.akt.dev/go/node/types/attributes/v1.Attributes", (gogoproto.nullable) = false, @@ -43,6 +58,7 @@ message Provider { (gogoproto.moretags) = "yaml:\"attributes\"" ]; + // Info contains additional provider information. Info info = 4 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "info", diff --git a/proto/node/akash/provider/v1beta4/query.proto b/proto/node/akash/provider/v1beta4/query.proto index ed8e609e..8dc7d69b 100644 --- a/proto/node/akash/provider/v1beta4/query.proto +++ b/proto/node/akash/provider/v1beta4/query.proto @@ -9,7 +9,7 @@ import "akash/provider/v1beta4/provider.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// Query defines the gRPC querier service +// Query defines the gRPC querier service for the provider package. service Query { // Providers queries providers rpc Providers(QueryProvidersRequest) returns (QueryProvidersResponse) { @@ -24,26 +24,35 @@ service Query { // QueryProvidersRequest is request type for the Query/Providers RPC method message QueryProvidersRequest { + // Pagination is used to paginate request. cosmos.base.query.v1beta1.PageRequest pagination = 1; } // QueryProvidersResponse is response type for the Query/Providers RPC method message QueryProvidersResponse { + // Providers is a list of providers on the network. repeated Provider providers = 1 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "Providers" ]; + // Pagination contains the information about response pagination. cosmos.base.query.v1beta1.PageResponse pagination = 2; } // QueryProviderRequest is request type for the Query/Provider RPC method message QueryProviderRequest { + // Owner is the bech32 address of the account of the provider. + // It is a string representing a valid account address. + // + // Example: + // "akash1..." string owner = 1; } -// QueryProviderResponse is response type for the Query/Provider RPC method +// QueryProviderResponse is response type for the Query/Provider RPC method. message QueryProviderResponse { + // Provider holds the representation of a provider on the network. Provider provider = 1 [ (gogoproto.nullable) = false ]; diff --git a/proto/node/akash/provider/v1beta4/service.proto b/proto/node/akash/provider/v1beta4/service.proto index 8f0bca86..51d6efaa 100644 --- a/proto/node/akash/provider/v1beta4/service.proto +++ b/proto/node/akash/provider/v1beta4/service.proto @@ -7,16 +7,16 @@ import "akash/provider/v1beta4/msg.proto"; option go_package = "pkg.akt.dev/go/node/provider/v1beta4"; -// Msg defines the provider Msg service +// Msg defines the provider Msg service. service Msg { option (cosmos.msg.v1.service) = true; - // CreateProvider defines a method that creates a provider given the proper inputs + // CreateProvider defines a method that creates a provider given the proper inputs. rpc CreateProvider(MsgCreateProvider) returns (MsgCreateProviderResponse); - // UpdateProvider defines a method that updates a provider given the proper inputs + // UpdateProvider defines a method that updates a provider given the proper inputs. rpc UpdateProvider(MsgUpdateProvider) returns (MsgUpdateProviderResponse); - // DeleteProvider defines a method that deletes a provider given the proper inputs + // DeleteProvider defines a method that deletes a provider given the proper inputs. rpc DeleteProvider(MsgDeleteProvider) returns (MsgDeleteProviderResponse); } From 30127565c314a253afbd6c8c58df76cb6a999e67 Mon Sep 17 00:00:00 2001 From: Joao Luna Date: Mon, 23 Dec 2024 19:23:19 +0000 Subject: [PATCH 4/4] docs: small improvements --- go/node/deployment/v1beta4/group.pb.go | 5 +++-- go/node/escrow/v1/fractional_payment.pb.go | 2 +- go/node/escrow/v1/genesis.pb.go | 2 +- go/node/gov/v1beta3/params.pb.go | 2 +- proto/node/akash/deployment/v1beta4/group.proto | 3 ++- proto/node/akash/escrow/v1/fractional_payment.proto | 2 +- proto/node/akash/escrow/v1/genesis.proto | 2 +- proto/node/akash/gov/v1beta3/params.proto | 2 +- 8 files changed, 11 insertions(+), 9 deletions(-) diff --git a/go/node/deployment/v1beta4/group.pb.go b/go/node/deployment/v1beta4/group.pb.go index 75cd61ff..d9aace27 100644 --- a/go/node/deployment/v1beta4/group.pb.go +++ b/go/node/deployment/v1beta4/group.pb.go @@ -24,7 +24,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package -// State is an enum which refers to state of group +// State is an enum which refers to state of group. type Group_State int32 const ( @@ -72,7 +72,8 @@ type Group struct { State Group_State `protobuf:"varint,2,opt,name=state,proto3,enum=akash.deployment.v1beta4.Group_State" json:"state" yaml:"state"` // GroupSpec holds the specification of a the Group. GroupSpec GroupSpec `protobuf:"bytes,3,opt,name=group_spec,json=groupSpec,proto3,castrepeated=GroupSpecs" json:"spec" yaml:"spec"` - CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` + // CreatedAt is the block height at which the deployment was created. + CreatedAt int64 `protobuf:"varint,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` } func (m *Group) Reset() { *m = Group{} } diff --git a/go/node/escrow/v1/fractional_payment.pb.go b/go/node/escrow/v1/fractional_payment.pb.go index f983a4a6..e6519aa2 100644 --- a/go/node/escrow/v1/fractional_payment.pb.go +++ b/go/node/escrow/v1/fractional_payment.pb.go @@ -77,7 +77,7 @@ type FractionalPayment struct { State FractionalPayment_State `protobuf:"varint,4,opt,name=state,proto3,enum=akash.escrow.v1.FractionalPayment_State" json:"state" yaml:"state"` // Rate holds the rate of the FractionalPayment. Rate types.DecCoin `protobuf:"bytes,5,opt,name=rate,proto3" json:"rate" yaml:"rate"` - // Balance is the current available balance. + // Balance is the current available coins. Balance types.DecCoin `protobuf:"bytes,6,opt,name=balance,proto3" json:"balance" yaml:"balance"` // Withdrawn corresponds to the amount of coins withdrawn by the FractionalPayment. Withdrawn types.Coin `protobuf:"bytes,7,opt,name=withdrawn,proto3" json:"withdrawn" yaml:"withdrawn"` diff --git a/go/node/escrow/v1/genesis.pb.go b/go/node/escrow/v1/genesis.pb.go index 2b3d91cf..d36bf449 100644 --- a/go/node/escrow/v1/genesis.pb.go +++ b/go/node/escrow/v1/genesis.pb.go @@ -27,7 +27,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package type GenesisState struct { // Accounts is a list of accounts on the genesis state. Accounts Accounts `protobuf:"bytes,1,rep,name=accounts,proto3,castrepeated=Accounts" json:"accounts" yaml:"accounts"` - // Payments is a list of fractional payments. + // Payments is a list of fractional payments on the genesis state.. Payments FractionalPayments `protobuf:"bytes,2,rep,name=payments,proto3,castrepeated=FractionalPayments" json:"payments" yaml:"payments"` } diff --git a/go/node/gov/v1beta3/params.pb.go b/go/node/gov/v1beta3/params.pb.go index d71d8d78..52ab14ae 100644 --- a/go/node/gov/v1beta3/params.pb.go +++ b/go/node/gov/v1beta3/params.pb.go @@ -27,7 +27,7 @@ const _ = proto.GoGoProtoPackageIsVersion3 // please upgrade the proto package // DepositParams defines the parameters for the x/gov module. type DepositParams struct { // MinInitialDepositRate is the minimum % of TotalDeposit - // author of the proposal must put in order for proposal tx to be committed + // author of the proposal must put in order for proposal tx to be committed. MinInitialDepositRate github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=min_initial_deposit_rate,json=minInitialDepositRate,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"min_initial_deposit_rate" yaml:"min_initial_deposit_rate"` } diff --git a/proto/node/akash/deployment/v1beta4/group.proto b/proto/node/akash/deployment/v1beta4/group.proto index 119f051d..c0a82f4d 100644 --- a/proto/node/akash/deployment/v1beta4/group.proto +++ b/proto/node/akash/deployment/v1beta4/group.proto @@ -11,7 +11,7 @@ option go_package = "pkg.akt.dev/go/node/deployment/v1beta4"; message Group { option (gogoproto.equal) = false; - // State is an enum which refers to state of group + // State is an enum which refers to state of group. enum State { option (gogoproto.goproto_enum_prefix) = false; @@ -59,5 +59,6 @@ message Group { (gogoproto.moretags) = "yaml:\"spec\"" ]; + // CreatedAt is the block height at which the deployment was created. int64 created_at = 4; } diff --git a/proto/node/akash/escrow/v1/fractional_payment.proto b/proto/node/akash/escrow/v1/fractional_payment.proto index 11fa4427..fae39b4d 100644 --- a/proto/node/akash/escrow/v1/fractional_payment.proto +++ b/proto/node/akash/escrow/v1/fractional_payment.proto @@ -72,7 +72,7 @@ message FractionalPayment { (gogoproto.moretags) = "yaml:\"rate\"" ]; - // Balance is the current available balance. + // Balance is the current available coins. cosmos.base.v1beta1.DecCoin balance = 6 [ (gogoproto.nullable) = false, (gogoproto.jsontag) = "balance", diff --git a/proto/node/akash/escrow/v1/genesis.proto b/proto/node/akash/escrow/v1/genesis.proto index 495070a6..399abdb1 100644 --- a/proto/node/akash/escrow/v1/genesis.proto +++ b/proto/node/akash/escrow/v1/genesis.proto @@ -18,7 +18,7 @@ message GenesisState { (gogoproto.moretags) = "yaml:\"accounts\"" ]; - // Payments is a list of fractional payments. + // Payments is a list of fractional payments on the genesis state.. repeated FractionalPayment payments = 2 [ (gogoproto.nullable) = false, (gogoproto.castrepeated) = "FractionalPayments", diff --git a/proto/node/akash/gov/v1beta3/params.proto b/proto/node/akash/gov/v1beta3/params.proto index 7aea7865..6375ba60 100644 --- a/proto/node/akash/gov/v1beta3/params.proto +++ b/proto/node/akash/gov/v1beta3/params.proto @@ -7,7 +7,7 @@ option go_package = "pkg.akt.dev/go/node/gov/v1beta3"; // DepositParams defines the parameters for the x/gov module. message DepositParams { // MinInitialDepositRate is the minimum % of TotalDeposit - // author of the proposal must put in order for proposal tx to be committed + // author of the proposal must put in order for proposal tx to be committed. bytes min_initial_deposit_rate = 1 [ (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false,