diff --git a/.github/labeler.yaml b/.github/labeler.yaml index 43a13dba..f97d4b2e 100644 --- a/.github/labeler.yaml +++ b/.github/labeler.yaml @@ -30,3 +30,6 @@ "Type: CI": - changed-files: - any-glob-to-any-file: .github/**/* +"Typ: Docs": + - changed-files: + - any-glob-to-any-file: docs/**/* diff --git a/Makefile b/Makefile index e2f246d6..9da5fda9 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ endif GO := GO111MODULE=$(GO111MODULE) go GO_MOD_NAME := $(shell go list -m 2>/dev/null) -BUF_VERSION ?= 1.27.2 +BUF_VERSION ?= 1.28.1 PROTOC_VERSION ?= 21.12 GOGOPROTO_VERSION ?= $(shell $(GO) list -mod=readonly -m -f '{{ .Version }}' github.com/cosmos/gogoproto) # TODO https://github.com/akash-network/support/issues/77 @@ -35,6 +35,8 @@ PROTOC_GEN_GOCOSMOS_VERSION ?= $(shell $(GO) list -mod=readonly -m -f '{{ .V PROTOC_GEN_GO_PULSAR_VERSION ?= $(shell $(GO) list -mod=readonly -m -f '{{ .Version }}' github.com/cosmos/cosmos-proto) PROTOC_GEN_GO_VERSION ?= $(shell $(GO) list -mod=readonly -m -f '{{ .Version }}' google.golang.org/protobuf) PROTOC_GEN_GRPC_GATEWAY_VERSION := $(shell $(GO) list -mod=readonly -m -f '{{ .Version }}' github.com/grpc-ecosystem/grpc-gateway) +PROTOC_GEN_DOC_VERSION := $(shell $(GO) list -mod=readonly -m -f '{{ .Version }}' github.com/pseudomuto/protoc-gen-doc) + PROTOC_GEN_SWAGGER_VERSION := $(PROTOC_GEN_GRPC_GATEWAY_VERSION) MODVENDOR_VERSION ?= v0.5.0 @@ -46,6 +48,7 @@ PROTOC_GEN_GO_PULSAR_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/protoc-gen-go PROTOC_GEN_GO_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/protoc-gen-go/$(PROTOC_GEN_GO_VERSION) PROTOC_GEN_GRPC_GATEWAY_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/protoc-gen-grpc-gateway/$(PROTOC_GEN_GRPC_GATEWAY_VERSION) PROTOC_GEN_SWAGGER_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/protoc-gen-swagger/$(PROTOC_GEN_SWAGGER_VERSION) +PROTOC_GEN_DOC_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/protoc-gen-doc/$(PROTOC_GEN_DOC_VERSION) MODVENDOR_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/modvendor/$(MODVENDOR_VERSION) GIT_CHGLOG_VERSION_FILE := $(AKASH_DEVCACHE_VERSIONS)/git-chglog/$(GIT_CHGLOG_VERSION) @@ -57,6 +60,7 @@ PROTOC_GEN_GO_PULSAR := $(AKASH_DEVCACHE_BIN)/protoc-gen-go-pulsar PROTOC_GEN_GO := $(AKASH_DEVCACHE_BIN)/protoc-gen-go PROTOC_GEN_GRPC_GATEWAY := $(AKASH_DEVCACHE_BIN)/protoc-gen-grpc-gateway PROTOC_GEN_SWAGGER := $(AKASH_DEVCACHE_BIN)/protoc-gen-swagger +PROTOC_GEN_DOC := $(AKASH_DEVCACHE_BIN)/protoc-gen-doc MODVENDOR := $(AKASH_DEVCACHE_BIN)/modvendor GIT_CHGLOG := $(AKASH_DEVCACHE_BIN)/git-chglog SWAGGER_COMBINE := $(AKASH_DEVCACHE_NODE_BIN)/swagger-combine diff --git a/README.md b/README.md index 741c5571..5b398b9f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,11 @@ and [Akash provider](https://github.com/akash-network/provider) in a single plac There are currently defined two buf packages with further intentions to be published into BSR if there is demand for it: - `buf.build/akash-network/node` - Akash protobuf definitions previously located in [proto](https://github.com/akash-network/node/tree/master/proto/akash) have all been moved [under](./proto/node/akash). All generated code can be found [here](./go/node) - - `buf.build/akash-network/manifest` - Akash manifest definitions previously defined as plan Go structs have been converted into Protobuf [definitions](./proto/provider/akash) + - `buf.build/akash-network/provider` - Akash manifest definitions previously defined as plan Go structs have been converted into Protobuf [definitions](./proto/provider/akash) + +Proto docs are available: +- for [node](docs/proto/node/proto-docs.md) +- for [provider](docs/proto/provider/proto-docs.md) ## Contributing diff --git a/docs/proto/node/proto-docs.md b/docs/proto/node/proto-docs.md new file mode 100644 index 00000000..1a29db85 --- /dev/null +++ b/docs/proto/node/proto-docs.md @@ -0,0 +1,8628 @@ + + # Protobuf Documentation + + + ## Table of Contents + + - [akash/provider/v1beta3/query.proto](#akash/provider/v1beta3/query.proto) + - [QueryProviderRequest](#akash.provider.v1beta3.QueryProviderRequest) + - [QueryProviderResponse](#akash.provider.v1beta3.QueryProviderResponse) + - [QueryProvidersRequest](#akash.provider.v1beta3.QueryProvidersRequest) + - [QueryProvidersResponse](#akash.provider.v1beta3.QueryProvidersResponse) + + - [Query](#akash.provider.v1beta3.Query) + + - [akash/provider/v1beta3/genesis.proto](#akash/provider/v1beta3/genesis.proto) + - [GenesisState](#akash.provider.v1beta3.GenesisState) + + - [akash/provider/v1beta3/provider.proto](#akash/provider/v1beta3/provider.proto) + - [MsgCreateProvider](#akash.provider.v1beta3.MsgCreateProvider) + - [MsgCreateProviderResponse](#akash.provider.v1beta3.MsgCreateProviderResponse) + - [MsgDeleteProvider](#akash.provider.v1beta3.MsgDeleteProvider) + - [MsgDeleteProviderResponse](#akash.provider.v1beta3.MsgDeleteProviderResponse) + - [MsgUpdateProvider](#akash.provider.v1beta3.MsgUpdateProvider) + - [MsgUpdateProviderResponse](#akash.provider.v1beta3.MsgUpdateProviderResponse) + - [Provider](#akash.provider.v1beta3.Provider) + - [ProviderInfo](#akash.provider.v1beta3.ProviderInfo) + + - [Msg](#akash.provider.v1beta3.Msg) + + - [akash/provider/v1beta2/query.proto](#akash/provider/v1beta2/query.proto) + - [QueryProviderRequest](#akash.provider.v1beta2.QueryProviderRequest) + - [QueryProviderResponse](#akash.provider.v1beta2.QueryProviderResponse) + - [QueryProvidersRequest](#akash.provider.v1beta2.QueryProvidersRequest) + - [QueryProvidersResponse](#akash.provider.v1beta2.QueryProvidersResponse) + + - [Query](#akash.provider.v1beta2.Query) + + - [akash/provider/v1beta2/genesis.proto](#akash/provider/v1beta2/genesis.proto) + - [GenesisState](#akash.provider.v1beta2.GenesisState) + + - [akash/provider/v1beta2/provider.proto](#akash/provider/v1beta2/provider.proto) + - [MsgCreateProvider](#akash.provider.v1beta2.MsgCreateProvider) + - [MsgCreateProviderResponse](#akash.provider.v1beta2.MsgCreateProviderResponse) + - [MsgDeleteProvider](#akash.provider.v1beta2.MsgDeleteProvider) + - [MsgDeleteProviderResponse](#akash.provider.v1beta2.MsgDeleteProviderResponse) + - [MsgUpdateProvider](#akash.provider.v1beta2.MsgUpdateProvider) + - [MsgUpdateProviderResponse](#akash.provider.v1beta2.MsgUpdateProviderResponse) + - [Provider](#akash.provider.v1beta2.Provider) + - [ProviderInfo](#akash.provider.v1beta2.ProviderInfo) + + - [Msg](#akash.provider.v1beta2.Msg) + + - [akash/provider/v1beta1/provider.proto](#akash/provider/v1beta1/provider.proto) + - [MsgCreateProvider](#akash.provider.v1beta1.MsgCreateProvider) + - [MsgCreateProviderResponse](#akash.provider.v1beta1.MsgCreateProviderResponse) + - [MsgDeleteProvider](#akash.provider.v1beta1.MsgDeleteProvider) + - [MsgDeleteProviderResponse](#akash.provider.v1beta1.MsgDeleteProviderResponse) + - [MsgUpdateProvider](#akash.provider.v1beta1.MsgUpdateProvider) + - [MsgUpdateProviderResponse](#akash.provider.v1beta1.MsgUpdateProviderResponse) + - [Provider](#akash.provider.v1beta1.Provider) + - [ProviderInfo](#akash.provider.v1beta1.ProviderInfo) + + - [Msg](#akash.provider.v1beta1.Msg) + + - [akash/audit/v1beta3/audit.proto](#akash/audit/v1beta3/audit.proto) + - [AttributesFilters](#akash.audit.v1beta3.AttributesFilters) + - [AttributesResponse](#akash.audit.v1beta3.AttributesResponse) + - [AuditedAttributes](#akash.audit.v1beta3.AuditedAttributes) + - [MsgDeleteProviderAttributes](#akash.audit.v1beta3.MsgDeleteProviderAttributes) + - [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta3.MsgDeleteProviderAttributesResponse) + - [MsgSignProviderAttributes](#akash.audit.v1beta3.MsgSignProviderAttributes) + - [MsgSignProviderAttributesResponse](#akash.audit.v1beta3.MsgSignProviderAttributesResponse) + - [Provider](#akash.audit.v1beta3.Provider) + + - [Msg](#akash.audit.v1beta3.Msg) + + - [akash/audit/v1beta3/query.proto](#akash/audit/v1beta3/query.proto) + - [QueryAllProvidersAttributesRequest](#akash.audit.v1beta3.QueryAllProvidersAttributesRequest) + - [QueryAuditorAttributesRequest](#akash.audit.v1beta3.QueryAuditorAttributesRequest) + - [QueryProviderAttributesRequest](#akash.audit.v1beta3.QueryProviderAttributesRequest) + - [QueryProviderAuditorRequest](#akash.audit.v1beta3.QueryProviderAuditorRequest) + - [QueryProviderRequest](#akash.audit.v1beta3.QueryProviderRequest) + - [QueryProvidersResponse](#akash.audit.v1beta3.QueryProvidersResponse) + + - [Query](#akash.audit.v1beta3.Query) + + - [akash/audit/v1beta3/genesis.proto](#akash/audit/v1beta3/genesis.proto) + - [GenesisState](#akash.audit.v1beta3.GenesisState) + + - [akash/audit/v1beta2/audit.proto](#akash/audit/v1beta2/audit.proto) + - [AttributesFilters](#akash.audit.v1beta2.AttributesFilters) + - [AttributesResponse](#akash.audit.v1beta2.AttributesResponse) + - [AuditedAttributes](#akash.audit.v1beta2.AuditedAttributes) + - [MsgDeleteProviderAttributes](#akash.audit.v1beta2.MsgDeleteProviderAttributes) + - [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta2.MsgDeleteProviderAttributesResponse) + - [MsgSignProviderAttributes](#akash.audit.v1beta2.MsgSignProviderAttributes) + - [MsgSignProviderAttributesResponse](#akash.audit.v1beta2.MsgSignProviderAttributesResponse) + - [Provider](#akash.audit.v1beta2.Provider) + + - [Msg](#akash.audit.v1beta2.Msg) + + - [akash/audit/v1beta2/query.proto](#akash/audit/v1beta2/query.proto) + - [QueryAllProvidersAttributesRequest](#akash.audit.v1beta2.QueryAllProvidersAttributesRequest) + - [QueryAuditorAttributesRequest](#akash.audit.v1beta2.QueryAuditorAttributesRequest) + - [QueryProviderAttributesRequest](#akash.audit.v1beta2.QueryProviderAttributesRequest) + - [QueryProviderAuditorRequest](#akash.audit.v1beta2.QueryProviderAuditorRequest) + - [QueryProviderRequest](#akash.audit.v1beta2.QueryProviderRequest) + - [QueryProvidersResponse](#akash.audit.v1beta2.QueryProvidersResponse) + + - [Query](#akash.audit.v1beta2.Query) + + - [akash/audit/v1beta2/genesis.proto](#akash/audit/v1beta2/genesis.proto) + - [GenesisState](#akash.audit.v1beta2.GenesisState) + + - [akash/audit/v1beta1/audit.proto](#akash/audit/v1beta1/audit.proto) + - [AttributesFilters](#akash.audit.v1beta1.AttributesFilters) + - [AttributesResponse](#akash.audit.v1beta1.AttributesResponse) + - [AuditedAttributes](#akash.audit.v1beta1.AuditedAttributes) + - [MsgDeleteProviderAttributes](#akash.audit.v1beta1.MsgDeleteProviderAttributes) + - [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta1.MsgDeleteProviderAttributesResponse) + - [MsgSignProviderAttributes](#akash.audit.v1beta1.MsgSignProviderAttributes) + - [MsgSignProviderAttributesResponse](#akash.audit.v1beta1.MsgSignProviderAttributesResponse) + - [Provider](#akash.audit.v1beta1.Provider) + + - [Msg](#akash.audit.v1beta1.Msg) + + - [akash/take/v1beta3/query.proto](#akash/take/v1beta3/query.proto) + - [Query](#akash.take.v1beta3.Query) + + - [akash/take/v1beta3/genesis.proto](#akash/take/v1beta3/genesis.proto) + - [GenesisState](#akash.take.v1beta3.GenesisState) + + - [akash/take/v1beta3/params.proto](#akash/take/v1beta3/params.proto) + - [DenomTakeRate](#akash.take.v1beta3.DenomTakeRate) + - [Params](#akash.take.v1beta3.Params) + + - [akash/deployment/v1beta3/groupmsg.proto](#akash/deployment/v1beta3/groupmsg.proto) + - [MsgCloseGroup](#akash.deployment.v1beta3.MsgCloseGroup) + - [MsgCloseGroupResponse](#akash.deployment.v1beta3.MsgCloseGroupResponse) + - [MsgPauseGroup](#akash.deployment.v1beta3.MsgPauseGroup) + - [MsgPauseGroupResponse](#akash.deployment.v1beta3.MsgPauseGroupResponse) + - [MsgStartGroup](#akash.deployment.v1beta3.MsgStartGroup) + - [MsgStartGroupResponse](#akash.deployment.v1beta3.MsgStartGroupResponse) + + - [akash/deployment/v1beta3/resourceunit.proto](#akash/deployment/v1beta3/resourceunit.proto) + - [ResourceUnit](#akash.deployment.v1beta3.ResourceUnit) + + - [akash/deployment/v1beta3/group.proto](#akash/deployment/v1beta3/group.proto) + - [Group](#akash.deployment.v1beta3.Group) + + - [Group.State](#akash.deployment.v1beta3.Group.State) + + - [akash/deployment/v1beta3/groupid.proto](#akash/deployment/v1beta3/groupid.proto) + - [GroupID](#akash.deployment.v1beta3.GroupID) + + - [akash/deployment/v1beta3/deployment.proto](#akash/deployment/v1beta3/deployment.proto) + - [Deployment](#akash.deployment.v1beta3.Deployment) + - [DeploymentFilters](#akash.deployment.v1beta3.DeploymentFilters) + - [DeploymentID](#akash.deployment.v1beta3.DeploymentID) + + - [Deployment.State](#akash.deployment.v1beta3.Deployment.State) + + - [akash/deployment/v1beta3/query.proto](#akash/deployment/v1beta3/query.proto) + - [QueryDeploymentRequest](#akash.deployment.v1beta3.QueryDeploymentRequest) + - [QueryDeploymentResponse](#akash.deployment.v1beta3.QueryDeploymentResponse) + - [QueryDeploymentsRequest](#akash.deployment.v1beta3.QueryDeploymentsRequest) + - [QueryDeploymentsResponse](#akash.deployment.v1beta3.QueryDeploymentsResponse) + - [QueryGroupRequest](#akash.deployment.v1beta3.QueryGroupRequest) + - [QueryGroupResponse](#akash.deployment.v1beta3.QueryGroupResponse) + + - [Query](#akash.deployment.v1beta3.Query) + + - [akash/deployment/v1beta3/deploymentmsg.proto](#akash/deployment/v1beta3/deploymentmsg.proto) + - [MsgCloseDeployment](#akash.deployment.v1beta3.MsgCloseDeployment) + - [MsgCloseDeploymentResponse](#akash.deployment.v1beta3.MsgCloseDeploymentResponse) + - [MsgCreateDeployment](#akash.deployment.v1beta3.MsgCreateDeployment) + - [MsgCreateDeploymentResponse](#akash.deployment.v1beta3.MsgCreateDeploymentResponse) + - [MsgDepositDeployment](#akash.deployment.v1beta3.MsgDepositDeployment) + - [MsgDepositDeploymentResponse](#akash.deployment.v1beta3.MsgDepositDeploymentResponse) + - [MsgUpdateDeployment](#akash.deployment.v1beta3.MsgUpdateDeployment) + - [MsgUpdateDeploymentResponse](#akash.deployment.v1beta3.MsgUpdateDeploymentResponse) + + - [akash/deployment/v1beta3/service.proto](#akash/deployment/v1beta3/service.proto) + - [Msg](#akash.deployment.v1beta3.Msg) + + - [akash/deployment/v1beta3/authz.proto](#akash/deployment/v1beta3/authz.proto) + - [DepositDeploymentAuthorization](#akash.deployment.v1beta3.DepositDeploymentAuthorization) + + - [akash/deployment/v1beta3/genesis.proto](#akash/deployment/v1beta3/genesis.proto) + - [GenesisDeployment](#akash.deployment.v1beta3.GenesisDeployment) + - [GenesisState](#akash.deployment.v1beta3.GenesisState) + + - [akash/deployment/v1beta3/groupspec.proto](#akash/deployment/v1beta3/groupspec.proto) + - [GroupSpec](#akash.deployment.v1beta3.GroupSpec) + + - [akash/deployment/v1beta3/params.proto](#akash/deployment/v1beta3/params.proto) + - [Params](#akash.deployment.v1beta3.Params) + + - [akash/deployment/v1beta2/groupmsg.proto](#akash/deployment/v1beta2/groupmsg.proto) + - [MsgCloseGroup](#akash.deployment.v1beta2.MsgCloseGroup) + - [MsgCloseGroupResponse](#akash.deployment.v1beta2.MsgCloseGroupResponse) + - [MsgPauseGroup](#akash.deployment.v1beta2.MsgPauseGroup) + - [MsgPauseGroupResponse](#akash.deployment.v1beta2.MsgPauseGroupResponse) + - [MsgStartGroup](#akash.deployment.v1beta2.MsgStartGroup) + - [MsgStartGroupResponse](#akash.deployment.v1beta2.MsgStartGroupResponse) + + - [akash/deployment/v1beta2/group.proto](#akash/deployment/v1beta2/group.proto) + - [Group](#akash.deployment.v1beta2.Group) + + - [Group.State](#akash.deployment.v1beta2.Group.State) + + - [akash/deployment/v1beta2/groupid.proto](#akash/deployment/v1beta2/groupid.proto) + - [GroupID](#akash.deployment.v1beta2.GroupID) + + - [akash/deployment/v1beta2/deployment.proto](#akash/deployment/v1beta2/deployment.proto) + - [Deployment](#akash.deployment.v1beta2.Deployment) + - [DeploymentFilters](#akash.deployment.v1beta2.DeploymentFilters) + - [DeploymentID](#akash.deployment.v1beta2.DeploymentID) + + - [Deployment.State](#akash.deployment.v1beta2.Deployment.State) + + - [akash/deployment/v1beta2/query.proto](#akash/deployment/v1beta2/query.proto) + - [QueryDeploymentRequest](#akash.deployment.v1beta2.QueryDeploymentRequest) + - [QueryDeploymentResponse](#akash.deployment.v1beta2.QueryDeploymentResponse) + - [QueryDeploymentsRequest](#akash.deployment.v1beta2.QueryDeploymentsRequest) + - [QueryDeploymentsResponse](#akash.deployment.v1beta2.QueryDeploymentsResponse) + - [QueryGroupRequest](#akash.deployment.v1beta2.QueryGroupRequest) + - [QueryGroupResponse](#akash.deployment.v1beta2.QueryGroupResponse) + + - [Query](#akash.deployment.v1beta2.Query) + + - [akash/deployment/v1beta2/deploymentmsg.proto](#akash/deployment/v1beta2/deploymentmsg.proto) + - [MsgCloseDeployment](#akash.deployment.v1beta2.MsgCloseDeployment) + - [MsgCloseDeploymentResponse](#akash.deployment.v1beta2.MsgCloseDeploymentResponse) + - [MsgCreateDeployment](#akash.deployment.v1beta2.MsgCreateDeployment) + - [MsgCreateDeploymentResponse](#akash.deployment.v1beta2.MsgCreateDeploymentResponse) + - [MsgDepositDeployment](#akash.deployment.v1beta2.MsgDepositDeployment) + - [MsgDepositDeploymentResponse](#akash.deployment.v1beta2.MsgDepositDeploymentResponse) + - [MsgUpdateDeployment](#akash.deployment.v1beta2.MsgUpdateDeployment) + - [MsgUpdateDeploymentResponse](#akash.deployment.v1beta2.MsgUpdateDeploymentResponse) + + - [akash/deployment/v1beta2/service.proto](#akash/deployment/v1beta2/service.proto) + - [Msg](#akash.deployment.v1beta2.Msg) + + - [akash/deployment/v1beta2/authz.proto](#akash/deployment/v1beta2/authz.proto) + - [DepositDeploymentAuthorization](#akash.deployment.v1beta2.DepositDeploymentAuthorization) + + - [akash/deployment/v1beta2/genesis.proto](#akash/deployment/v1beta2/genesis.proto) + - [GenesisDeployment](#akash.deployment.v1beta2.GenesisDeployment) + - [GenesisState](#akash.deployment.v1beta2.GenesisState) + + - [akash/deployment/v1beta2/groupspec.proto](#akash/deployment/v1beta2/groupspec.proto) + - [GroupSpec](#akash.deployment.v1beta2.GroupSpec) + + - [akash/deployment/v1beta2/resource.proto](#akash/deployment/v1beta2/resource.proto) + - [Resource](#akash.deployment.v1beta2.Resource) + + - [akash/deployment/v1beta2/params.proto](#akash/deployment/v1beta2/params.proto) + - [Params](#akash.deployment.v1beta2.Params) + + - [akash/deployment/v1beta1/group.proto](#akash/deployment/v1beta1/group.proto) + - [Group](#akash.deployment.v1beta1.Group) + - [GroupID](#akash.deployment.v1beta1.GroupID) + - [GroupSpec](#akash.deployment.v1beta1.GroupSpec) + - [MsgCloseGroup](#akash.deployment.v1beta1.MsgCloseGroup) + - [MsgCloseGroupResponse](#akash.deployment.v1beta1.MsgCloseGroupResponse) + - [MsgPauseGroup](#akash.deployment.v1beta1.MsgPauseGroup) + - [MsgPauseGroupResponse](#akash.deployment.v1beta1.MsgPauseGroupResponse) + - [MsgStartGroup](#akash.deployment.v1beta1.MsgStartGroup) + - [MsgStartGroupResponse](#akash.deployment.v1beta1.MsgStartGroupResponse) + - [Resource](#akash.deployment.v1beta1.Resource) + + - [Group.State](#akash.deployment.v1beta1.Group.State) + + - [akash/deployment/v1beta1/deployment.proto](#akash/deployment/v1beta1/deployment.proto) + - [Deployment](#akash.deployment.v1beta1.Deployment) + - [DeploymentFilters](#akash.deployment.v1beta1.DeploymentFilters) + - [DeploymentID](#akash.deployment.v1beta1.DeploymentID) + - [MsgCloseDeployment](#akash.deployment.v1beta1.MsgCloseDeployment) + - [MsgCloseDeploymentResponse](#akash.deployment.v1beta1.MsgCloseDeploymentResponse) + - [MsgCreateDeployment](#akash.deployment.v1beta1.MsgCreateDeployment) + - [MsgCreateDeploymentResponse](#akash.deployment.v1beta1.MsgCreateDeploymentResponse) + - [MsgDepositDeployment](#akash.deployment.v1beta1.MsgDepositDeployment) + - [MsgDepositDeploymentResponse](#akash.deployment.v1beta1.MsgDepositDeploymentResponse) + - [MsgUpdateDeployment](#akash.deployment.v1beta1.MsgUpdateDeployment) + - [MsgUpdateDeploymentResponse](#akash.deployment.v1beta1.MsgUpdateDeploymentResponse) + + - [Deployment.State](#akash.deployment.v1beta1.Deployment.State) + + - [Msg](#akash.deployment.v1beta1.Msg) + + - [akash/deployment/v1beta1/query.proto](#akash/deployment/v1beta1/query.proto) + - [QueryDeploymentRequest](#akash.deployment.v1beta1.QueryDeploymentRequest) + - [QueryDeploymentResponse](#akash.deployment.v1beta1.QueryDeploymentResponse) + - [QueryDeploymentsRequest](#akash.deployment.v1beta1.QueryDeploymentsRequest) + - [QueryDeploymentsResponse](#akash.deployment.v1beta1.QueryDeploymentsResponse) + - [QueryGroupRequest](#akash.deployment.v1beta1.QueryGroupRequest) + - [QueryGroupResponse](#akash.deployment.v1beta1.QueryGroupResponse) + + - [Query](#akash.deployment.v1beta1.Query) + + - [akash/deployment/v1beta1/authz.proto](#akash/deployment/v1beta1/authz.proto) + - [DepositDeploymentAuthorization](#akash.deployment.v1beta1.DepositDeploymentAuthorization) + + - [akash/deployment/v1beta1/genesis.proto](#akash/deployment/v1beta1/genesis.proto) + - [GenesisDeployment](#akash.deployment.v1beta1.GenesisDeployment) + - [GenesisState](#akash.deployment.v1beta1.GenesisState) + + - [akash/deployment/v1beta1/params.proto](#akash/deployment/v1beta1/params.proto) + - [Params](#akash.deployment.v1beta1.Params) + + - [akash/staking/v1beta3/genesis.proto](#akash/staking/v1beta3/genesis.proto) + - [GenesisState](#akash.staking.v1beta3.GenesisState) + + - [akash/staking/v1beta3/params.proto](#akash/staking/v1beta3/params.proto) + - [Params](#akash.staking.v1beta3.Params) + + - [akash/cert/v1beta3/query.proto](#akash/cert/v1beta3/query.proto) + - [CertificateResponse](#akash.cert.v1beta3.CertificateResponse) + - [QueryCertificatesRequest](#akash.cert.v1beta3.QueryCertificatesRequest) + - [QueryCertificatesResponse](#akash.cert.v1beta3.QueryCertificatesResponse) + + - [Query](#akash.cert.v1beta3.Query) + + - [akash/cert/v1beta3/cert.proto](#akash/cert/v1beta3/cert.proto) + - [Certificate](#akash.cert.v1beta3.Certificate) + - [CertificateFilter](#akash.cert.v1beta3.CertificateFilter) + - [CertificateID](#akash.cert.v1beta3.CertificateID) + - [MsgCreateCertificate](#akash.cert.v1beta3.MsgCreateCertificate) + - [MsgCreateCertificateResponse](#akash.cert.v1beta3.MsgCreateCertificateResponse) + - [MsgRevokeCertificate](#akash.cert.v1beta3.MsgRevokeCertificate) + - [MsgRevokeCertificateResponse](#akash.cert.v1beta3.MsgRevokeCertificateResponse) + + - [Certificate.State](#akash.cert.v1beta3.Certificate.State) + + - [Msg](#akash.cert.v1beta3.Msg) + + - [akash/cert/v1beta3/genesis.proto](#akash/cert/v1beta3/genesis.proto) + - [GenesisCertificate](#akash.cert.v1beta3.GenesisCertificate) + - [GenesisState](#akash.cert.v1beta3.GenesisState) + + - [akash/cert/v1beta2/query.proto](#akash/cert/v1beta2/query.proto) + - [CertificateResponse](#akash.cert.v1beta2.CertificateResponse) + - [QueryCertificatesRequest](#akash.cert.v1beta2.QueryCertificatesRequest) + - [QueryCertificatesResponse](#akash.cert.v1beta2.QueryCertificatesResponse) + + - [Query](#akash.cert.v1beta2.Query) + + - [akash/cert/v1beta2/cert.proto](#akash/cert/v1beta2/cert.proto) + - [Certificate](#akash.cert.v1beta2.Certificate) + - [CertificateFilter](#akash.cert.v1beta2.CertificateFilter) + - [CertificateID](#akash.cert.v1beta2.CertificateID) + - [MsgCreateCertificate](#akash.cert.v1beta2.MsgCreateCertificate) + - [MsgCreateCertificateResponse](#akash.cert.v1beta2.MsgCreateCertificateResponse) + - [MsgRevokeCertificate](#akash.cert.v1beta2.MsgRevokeCertificate) + - [MsgRevokeCertificateResponse](#akash.cert.v1beta2.MsgRevokeCertificateResponse) + + - [Certificate.State](#akash.cert.v1beta2.Certificate.State) + + - [Msg](#akash.cert.v1beta2.Msg) + + - [akash/cert/v1beta2/genesis.proto](#akash/cert/v1beta2/genesis.proto) + - [GenesisCertificate](#akash.cert.v1beta2.GenesisCertificate) + - [GenesisState](#akash.cert.v1beta2.GenesisState) + + - [akash/escrow/v1beta3/types.proto](#akash/escrow/v1beta3/types.proto) + - [Account](#akash.escrow.v1beta3.Account) + - [AccountID](#akash.escrow.v1beta3.AccountID) + - [FractionalPayment](#akash.escrow.v1beta3.FractionalPayment) + + - [Account.State](#akash.escrow.v1beta3.Account.State) + - [FractionalPayment.State](#akash.escrow.v1beta3.FractionalPayment.State) + + - [akash/escrow/v1beta3/query.proto](#akash/escrow/v1beta3/query.proto) + - [QueryAccountsRequest](#akash.escrow.v1beta3.QueryAccountsRequest) + - [QueryAccountsResponse](#akash.escrow.v1beta3.QueryAccountsResponse) + - [QueryPaymentsRequest](#akash.escrow.v1beta3.QueryPaymentsRequest) + - [QueryPaymentsResponse](#akash.escrow.v1beta3.QueryPaymentsResponse) + + - [Query](#akash.escrow.v1beta3.Query) + + - [akash/escrow/v1beta3/genesis.proto](#akash/escrow/v1beta3/genesis.proto) + - [GenesisState](#akash.escrow.v1beta3.GenesisState) + + - [akash/escrow/v1beta2/types.proto](#akash/escrow/v1beta2/types.proto) + - [Account](#akash.escrow.v1beta2.Account) + - [AccountID](#akash.escrow.v1beta2.AccountID) + - [FractionalPayment](#akash.escrow.v1beta2.FractionalPayment) + + - [Account.State](#akash.escrow.v1beta2.Account.State) + - [FractionalPayment.State](#akash.escrow.v1beta2.FractionalPayment.State) + + - [akash/escrow/v1beta2/query.proto](#akash/escrow/v1beta2/query.proto) + - [QueryAccountsRequest](#akash.escrow.v1beta2.QueryAccountsRequest) + - [QueryAccountsResponse](#akash.escrow.v1beta2.QueryAccountsResponse) + - [QueryPaymentsRequest](#akash.escrow.v1beta2.QueryPaymentsRequest) + - [QueryPaymentsResponse](#akash.escrow.v1beta2.QueryPaymentsResponse) + + - [Query](#akash.escrow.v1beta2.Query) + + - [akash/escrow/v1beta2/genesis.proto](#akash/escrow/v1beta2/genesis.proto) + - [GenesisState](#akash.escrow.v1beta2.GenesisState) + + - [akash/escrow/v1beta1/types.proto](#akash/escrow/v1beta1/types.proto) + - [Account](#akash.escrow.v1beta1.Account) + - [AccountID](#akash.escrow.v1beta1.AccountID) + - [Payment](#akash.escrow.v1beta1.Payment) + + - [Account.State](#akash.escrow.v1beta1.Account.State) + - [Payment.State](#akash.escrow.v1beta1.Payment.State) + + - [akash/escrow/v1beta1/query.proto](#akash/escrow/v1beta1/query.proto) + - [QueryAccountsRequest](#akash.escrow.v1beta1.QueryAccountsRequest) + - [QueryAccountsResponse](#akash.escrow.v1beta1.QueryAccountsResponse) + - [QueryPaymentsRequest](#akash.escrow.v1beta1.QueryPaymentsRequest) + - [QueryPaymentsResponse](#akash.escrow.v1beta1.QueryPaymentsResponse) + + - [Query](#akash.escrow.v1beta1.Query) + + - [akash/escrow/v1beta1/genesis.proto](#akash/escrow/v1beta1/genesis.proto) + - [GenesisState](#akash.escrow.v1beta1.GenesisState) + + - [akash/market/v1beta4/bid.proto](#akash/market/v1beta4/bid.proto) + - [Bid](#akash.market.v1beta4.Bid) + - [BidFilters](#akash.market.v1beta4.BidFilters) + - [BidID](#akash.market.v1beta4.BidID) + - [MsgCloseBid](#akash.market.v1beta4.MsgCloseBid) + - [MsgCloseBidResponse](#akash.market.v1beta4.MsgCloseBidResponse) + - [MsgCreateBid](#akash.market.v1beta4.MsgCreateBid) + - [MsgCreateBidResponse](#akash.market.v1beta4.MsgCreateBidResponse) + - [ResourceOffer](#akash.market.v1beta4.ResourceOffer) + + - [Bid.State](#akash.market.v1beta4.Bid.State) + + - [akash/market/v1beta4/query.proto](#akash/market/v1beta4/query.proto) + - [QueryBidRequest](#akash.market.v1beta4.QueryBidRequest) + - [QueryBidResponse](#akash.market.v1beta4.QueryBidResponse) + - [QueryBidsRequest](#akash.market.v1beta4.QueryBidsRequest) + - [QueryBidsResponse](#akash.market.v1beta4.QueryBidsResponse) + - [QueryLeaseRequest](#akash.market.v1beta4.QueryLeaseRequest) + - [QueryLeaseResponse](#akash.market.v1beta4.QueryLeaseResponse) + - [QueryLeasesRequest](#akash.market.v1beta4.QueryLeasesRequest) + - [QueryLeasesResponse](#akash.market.v1beta4.QueryLeasesResponse) + - [QueryOrderRequest](#akash.market.v1beta4.QueryOrderRequest) + - [QueryOrderResponse](#akash.market.v1beta4.QueryOrderResponse) + - [QueryOrdersRequest](#akash.market.v1beta4.QueryOrdersRequest) + - [QueryOrdersResponse](#akash.market.v1beta4.QueryOrdersResponse) + + - [Query](#akash.market.v1beta4.Query) + + - [akash/market/v1beta4/service.proto](#akash/market/v1beta4/service.proto) + - [Msg](#akash.market.v1beta4.Msg) + + - [akash/market/v1beta4/lease.proto](#akash/market/v1beta4/lease.proto) + - [Lease](#akash.market.v1beta4.Lease) + - [LeaseFilters](#akash.market.v1beta4.LeaseFilters) + - [LeaseID](#akash.market.v1beta4.LeaseID) + - [MsgCloseLease](#akash.market.v1beta4.MsgCloseLease) + - [MsgCloseLeaseResponse](#akash.market.v1beta4.MsgCloseLeaseResponse) + - [MsgCreateLease](#akash.market.v1beta4.MsgCreateLease) + - [MsgCreateLeaseResponse](#akash.market.v1beta4.MsgCreateLeaseResponse) + - [MsgWithdrawLease](#akash.market.v1beta4.MsgWithdrawLease) + - [MsgWithdrawLeaseResponse](#akash.market.v1beta4.MsgWithdrawLeaseResponse) + + - [Lease.State](#akash.market.v1beta4.Lease.State) + + - [akash/market/v1beta4/genesis.proto](#akash/market/v1beta4/genesis.proto) + - [GenesisState](#akash.market.v1beta4.GenesisState) + + - [akash/market/v1beta4/order.proto](#akash/market/v1beta4/order.proto) + - [Order](#akash.market.v1beta4.Order) + - [OrderFilters](#akash.market.v1beta4.OrderFilters) + - [OrderID](#akash.market.v1beta4.OrderID) + + - [Order.State](#akash.market.v1beta4.Order.State) + + - [akash/market/v1beta4/params.proto](#akash/market/v1beta4/params.proto) + - [Params](#akash.market.v1beta4.Params) + + - [akash/market/v1beta3/bid.proto](#akash/market/v1beta3/bid.proto) + - [Bid](#akash.market.v1beta3.Bid) + - [BidFilters](#akash.market.v1beta3.BidFilters) + - [BidID](#akash.market.v1beta3.BidID) + - [MsgCloseBid](#akash.market.v1beta3.MsgCloseBid) + - [MsgCloseBidResponse](#akash.market.v1beta3.MsgCloseBidResponse) + - [MsgCreateBid](#akash.market.v1beta3.MsgCreateBid) + - [MsgCreateBidResponse](#akash.market.v1beta3.MsgCreateBidResponse) + + - [Bid.State](#akash.market.v1beta3.Bid.State) + + - [akash/market/v1beta3/query.proto](#akash/market/v1beta3/query.proto) + - [QueryBidRequest](#akash.market.v1beta3.QueryBidRequest) + - [QueryBidResponse](#akash.market.v1beta3.QueryBidResponse) + - [QueryBidsRequest](#akash.market.v1beta3.QueryBidsRequest) + - [QueryBidsResponse](#akash.market.v1beta3.QueryBidsResponse) + - [QueryLeaseRequest](#akash.market.v1beta3.QueryLeaseRequest) + - [QueryLeaseResponse](#akash.market.v1beta3.QueryLeaseResponse) + - [QueryLeasesRequest](#akash.market.v1beta3.QueryLeasesRequest) + - [QueryLeasesResponse](#akash.market.v1beta3.QueryLeasesResponse) + - [QueryOrderRequest](#akash.market.v1beta3.QueryOrderRequest) + - [QueryOrderResponse](#akash.market.v1beta3.QueryOrderResponse) + - [QueryOrdersRequest](#akash.market.v1beta3.QueryOrdersRequest) + - [QueryOrdersResponse](#akash.market.v1beta3.QueryOrdersResponse) + + - [Query](#akash.market.v1beta3.Query) + + - [akash/market/v1beta3/service.proto](#akash/market/v1beta3/service.proto) + - [Msg](#akash.market.v1beta3.Msg) + + - [akash/market/v1beta3/lease.proto](#akash/market/v1beta3/lease.proto) + - [Lease](#akash.market.v1beta3.Lease) + - [LeaseFilters](#akash.market.v1beta3.LeaseFilters) + - [LeaseID](#akash.market.v1beta3.LeaseID) + - [MsgCloseLease](#akash.market.v1beta3.MsgCloseLease) + - [MsgCloseLeaseResponse](#akash.market.v1beta3.MsgCloseLeaseResponse) + - [MsgCreateLease](#akash.market.v1beta3.MsgCreateLease) + - [MsgCreateLeaseResponse](#akash.market.v1beta3.MsgCreateLeaseResponse) + - [MsgWithdrawLease](#akash.market.v1beta3.MsgWithdrawLease) + - [MsgWithdrawLeaseResponse](#akash.market.v1beta3.MsgWithdrawLeaseResponse) + + - [Lease.State](#akash.market.v1beta3.Lease.State) + + - [akash/market/v1beta3/genesis.proto](#akash/market/v1beta3/genesis.proto) + - [GenesisState](#akash.market.v1beta3.GenesisState) + + - [akash/market/v1beta3/order.proto](#akash/market/v1beta3/order.proto) + - [Order](#akash.market.v1beta3.Order) + - [OrderFilters](#akash.market.v1beta3.OrderFilters) + - [OrderID](#akash.market.v1beta3.OrderID) + + - [Order.State](#akash.market.v1beta3.Order.State) + + - [akash/market/v1beta3/params.proto](#akash/market/v1beta3/params.proto) + - [Params](#akash.market.v1beta3.Params) + + - [akash/market/v1beta2/bid.proto](#akash/market/v1beta2/bid.proto) + - [Bid](#akash.market.v1beta2.Bid) + - [BidFilters](#akash.market.v1beta2.BidFilters) + - [BidID](#akash.market.v1beta2.BidID) + - [MsgCloseBid](#akash.market.v1beta2.MsgCloseBid) + - [MsgCloseBidResponse](#akash.market.v1beta2.MsgCloseBidResponse) + - [MsgCreateBid](#akash.market.v1beta2.MsgCreateBid) + - [MsgCreateBidResponse](#akash.market.v1beta2.MsgCreateBidResponse) + + - [Bid.State](#akash.market.v1beta2.Bid.State) + + - [akash/market/v1beta2/query.proto](#akash/market/v1beta2/query.proto) + - [QueryBidRequest](#akash.market.v1beta2.QueryBidRequest) + - [QueryBidResponse](#akash.market.v1beta2.QueryBidResponse) + - [QueryBidsRequest](#akash.market.v1beta2.QueryBidsRequest) + - [QueryBidsResponse](#akash.market.v1beta2.QueryBidsResponse) + - [QueryLeaseRequest](#akash.market.v1beta2.QueryLeaseRequest) + - [QueryLeaseResponse](#akash.market.v1beta2.QueryLeaseResponse) + - [QueryLeasesRequest](#akash.market.v1beta2.QueryLeasesRequest) + - [QueryLeasesResponse](#akash.market.v1beta2.QueryLeasesResponse) + - [QueryOrderRequest](#akash.market.v1beta2.QueryOrderRequest) + - [QueryOrderResponse](#akash.market.v1beta2.QueryOrderResponse) + - [QueryOrdersRequest](#akash.market.v1beta2.QueryOrdersRequest) + - [QueryOrdersResponse](#akash.market.v1beta2.QueryOrdersResponse) + + - [Query](#akash.market.v1beta2.Query) + + - [akash/market/v1beta2/service.proto](#akash/market/v1beta2/service.proto) + - [Msg](#akash.market.v1beta2.Msg) + + - [akash/market/v1beta2/lease.proto](#akash/market/v1beta2/lease.proto) + - [Lease](#akash.market.v1beta2.Lease) + - [LeaseFilters](#akash.market.v1beta2.LeaseFilters) + - [LeaseID](#akash.market.v1beta2.LeaseID) + - [MsgCloseLease](#akash.market.v1beta2.MsgCloseLease) + - [MsgCloseLeaseResponse](#akash.market.v1beta2.MsgCloseLeaseResponse) + - [MsgCreateLease](#akash.market.v1beta2.MsgCreateLease) + - [MsgCreateLeaseResponse](#akash.market.v1beta2.MsgCreateLeaseResponse) + - [MsgWithdrawLease](#akash.market.v1beta2.MsgWithdrawLease) + - [MsgWithdrawLeaseResponse](#akash.market.v1beta2.MsgWithdrawLeaseResponse) + + - [Lease.State](#akash.market.v1beta2.Lease.State) + + - [akash/market/v1beta2/genesis.proto](#akash/market/v1beta2/genesis.proto) + - [GenesisState](#akash.market.v1beta2.GenesisState) + + - [akash/market/v1beta2/order.proto](#akash/market/v1beta2/order.proto) + - [Order](#akash.market.v1beta2.Order) + - [OrderFilters](#akash.market.v1beta2.OrderFilters) + - [OrderID](#akash.market.v1beta2.OrderID) + + - [Order.State](#akash.market.v1beta2.Order.State) + + - [akash/market/v1beta2/params.proto](#akash/market/v1beta2/params.proto) + - [Params](#akash.market.v1beta2.Params) + + - [akash/inflation/v1beta3/genesis.proto](#akash/inflation/v1beta3/genesis.proto) + - [GenesisState](#akash.inflation.v1beta3.GenesisState) + + - [akash/inflation/v1beta3/params.proto](#akash/inflation/v1beta3/params.proto) + - [Params](#akash.inflation.v1beta3.Params) + + - [akash/inflation/v1beta2/genesis.proto](#akash/inflation/v1beta2/genesis.proto) + - [GenesisState](#akash.inflation.v1beta2.GenesisState) + + - [akash/inflation/v1beta2/params.proto](#akash/inflation/v1beta2/params.proto) + - [Params](#akash.inflation.v1beta2.Params) + + - [akash/base/v1beta3/memory.proto](#akash/base/v1beta3/memory.proto) + - [Memory](#akash.base.v1beta3.Memory) + + - [akash/base/v1beta3/cpu.proto](#akash/base/v1beta3/cpu.proto) + - [CPU](#akash.base.v1beta3.CPU) + + - [akash/base/v1beta3/resources.proto](#akash/base/v1beta3/resources.proto) + - [Resources](#akash.base.v1beta3.Resources) + + - [akash/base/v1beta3/attribute.proto](#akash/base/v1beta3/attribute.proto) + - [Attribute](#akash.base.v1beta3.Attribute) + - [PlacementRequirements](#akash.base.v1beta3.PlacementRequirements) + - [SignedBy](#akash.base.v1beta3.SignedBy) + + - [akash/base/v1beta3/endpoint.proto](#akash/base/v1beta3/endpoint.proto) + - [Endpoint](#akash.base.v1beta3.Endpoint) + + - [Endpoint.Kind](#akash.base.v1beta3.Endpoint.Kind) + + - [akash/base/v1beta3/gpu.proto](#akash/base/v1beta3/gpu.proto) + - [GPU](#akash.base.v1beta3.GPU) + + - [akash/base/v1beta3/storage.proto](#akash/base/v1beta3/storage.proto) + - [Storage](#akash.base.v1beta3.Storage) + + - [akash/base/v1beta3/resourcevalue.proto](#akash/base/v1beta3/resourcevalue.proto) + - [ResourceValue](#akash.base.v1beta3.ResourceValue) + + - [akash/base/v1beta2/resourceunits.proto](#akash/base/v1beta2/resourceunits.proto) + - [ResourceUnits](#akash.base.v1beta2.ResourceUnits) + + - [akash/base/v1beta2/attribute.proto](#akash/base/v1beta2/attribute.proto) + - [Attribute](#akash.base.v1beta2.Attribute) + - [PlacementRequirements](#akash.base.v1beta2.PlacementRequirements) + - [SignedBy](#akash.base.v1beta2.SignedBy) + + - [akash/base/v1beta2/endpoint.proto](#akash/base/v1beta2/endpoint.proto) + - [Endpoint](#akash.base.v1beta2.Endpoint) + + - [Endpoint.Kind](#akash.base.v1beta2.Endpoint.Kind) + + - [akash/base/v1beta2/resource.proto](#akash/base/v1beta2/resource.proto) + - [CPU](#akash.base.v1beta2.CPU) + - [Memory](#akash.base.v1beta2.Memory) + - [Storage](#akash.base.v1beta2.Storage) + + - [akash/base/v1beta2/resourcevalue.proto](#akash/base/v1beta2/resourcevalue.proto) + - [ResourceValue](#akash.base.v1beta2.ResourceValue) + + - [akash/base/v1beta1/attribute.proto](#akash/base/v1beta1/attribute.proto) + - [Attribute](#akash.base.v1beta1.Attribute) + - [PlacementRequirements](#akash.base.v1beta1.PlacementRequirements) + - [SignedBy](#akash.base.v1beta1.SignedBy) + + - [akash/base/v1beta1/endpoint.proto](#akash/base/v1beta1/endpoint.proto) + - [Endpoint](#akash.base.v1beta1.Endpoint) + + - [Endpoint.Kind](#akash.base.v1beta1.Endpoint.Kind) + + - [akash/base/v1beta1/resource.proto](#akash/base/v1beta1/resource.proto) + - [CPU](#akash.base.v1beta1.CPU) + - [Memory](#akash.base.v1beta1.Memory) + - [ResourceUnits](#akash.base.v1beta1.ResourceUnits) + - [Storage](#akash.base.v1beta1.Storage) + + - [akash/base/v1beta1/resourcevalue.proto](#akash/base/v1beta1/resourcevalue.proto) + - [ResourceValue](#akash.base.v1beta1.ResourceValue) + + - [akash/gov/v1beta3/genesis.proto](#akash/gov/v1beta3/genesis.proto) + - [GenesisState](#akash.gov.v1beta3.GenesisState) + + - [akash/gov/v1beta3/params.proto](#akash/gov/v1beta3/params.proto) + - [DepositParams](#akash.gov.v1beta3.DepositParams) + + - [Scalar Value Types](#scalar-value-types) + + + + +
+ + ## akash/provider/v1beta3/query.proto + + + + + + ### QueryProviderRequest + QueryProviderRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProviderResponse + QueryProviderResponse is response type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `provider` | [Provider](#akash.provider.v1beta3.Provider) | | | + + + + + + + + + ### QueryProvidersRequest + QueryProvidersRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProvidersResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.provider.v1beta3.Provider) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Providers` | [QueryProvidersRequest](#akash.provider.v1beta3.QueryProvidersRequest) | [QueryProvidersResponse](#akash.provider.v1beta3.QueryProvidersResponse) | Providers queries providers | GET|/akash/provider/v1beta3/providers| + | `Provider` | [QueryProviderRequest](#akash.provider.v1beta3.QueryProviderRequest) | [QueryProviderResponse](#akash.provider.v1beta3.QueryProviderResponse) | Provider queries provider details | GET|/akash/provider/v1beta3/providers/{owner}| + + + + + + + + + ## akash/provider/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by provider module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.provider.v1beta3.Provider) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/provider/v1beta3/provider.proto + + + + + + ### MsgCreateProvider + MsgCreateProvider defines an SDK message for creating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta3.ProviderInfo) | | | + + + + + + + + + ### MsgCreateProviderResponse + MsgCreateProviderResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### MsgDeleteProvider + MsgDeleteProvider defines an SDK message for deleting a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + + + + + + + + + ### MsgDeleteProviderResponse + MsgDeleteProviderResponse defines the Msg/DeleteProvider response type. + + + + + + + + + ### MsgUpdateProvider + MsgUpdateProvider defines an SDK message for updating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta3.ProviderInfo) | | | + + + + + + + + + ### MsgUpdateProviderResponse + MsgUpdateProviderResponse defines the Msg/UpdateProvider response type. + + + + + + + + + ### Provider + Provider stores owner and host details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta3.ProviderInfo) | | | + + + + + + + + + ### ProviderInfo + ProviderInfo + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `email` | [string](#string) | | | + | `website` | [string](#string) | | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateProvider` | [MsgCreateProvider](#akash.provider.v1beta3.MsgCreateProvider) | [MsgCreateProviderResponse](#akash.provider.v1beta3.MsgCreateProviderResponse) | CreateProvider defines a method that creates a provider given the proper inputs | | + | `UpdateProvider` | [MsgUpdateProvider](#akash.provider.v1beta3.MsgUpdateProvider) | [MsgUpdateProviderResponse](#akash.provider.v1beta3.MsgUpdateProviderResponse) | UpdateProvider defines a method that updates a provider given the proper inputs | | + | `DeleteProvider` | [MsgDeleteProvider](#akash.provider.v1beta3.MsgDeleteProvider) | [MsgDeleteProviderResponse](#akash.provider.v1beta3.MsgDeleteProviderResponse) | DeleteProvider defines a method that deletes a provider given the proper inputs | | + + + + + + + + + ## akash/provider/v1beta2/query.proto + + + + + + ### QueryProviderRequest + QueryProviderRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProviderResponse + QueryProviderResponse is response type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `provider` | [Provider](#akash.provider.v1beta2.Provider) | | | + + + + + + + + + ### QueryProvidersRequest + QueryProvidersRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProvidersResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.provider.v1beta2.Provider) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Providers` | [QueryProvidersRequest](#akash.provider.v1beta2.QueryProvidersRequest) | [QueryProvidersResponse](#akash.provider.v1beta2.QueryProvidersResponse) | Providers queries providers | GET|/akash/provider/v1beta2/providers| + | `Provider` | [QueryProviderRequest](#akash.provider.v1beta2.QueryProviderRequest) | [QueryProviderResponse](#akash.provider.v1beta2.QueryProviderResponse) | Provider queries provider details | GET|/akash/provider/v1beta2/providers/{owner}| + + + + + + + + + ## akash/provider/v1beta2/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by provider module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.provider.v1beta2.Provider) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/provider/v1beta2/provider.proto + + + + + + ### MsgCreateProvider + MsgCreateProvider defines an SDK message for creating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta2.ProviderInfo) | | | + + + + + + + + + ### MsgCreateProviderResponse + MsgCreateProviderResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### MsgDeleteProvider + MsgDeleteProvider defines an SDK message for deleting a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + + + + + + + + + ### MsgDeleteProviderResponse + MsgDeleteProviderResponse defines the Msg/DeleteProvider response type. + + + + + + + + + ### MsgUpdateProvider + MsgUpdateProvider defines an SDK message for updating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta2.ProviderInfo) | | | + + + + + + + + + ### MsgUpdateProviderResponse + MsgUpdateProviderResponse defines the Msg/UpdateProvider response type. + + + + + + + + + ### Provider + Provider stores owner and host details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta2.ProviderInfo) | | | + + + + + + + + + ### ProviderInfo + ProviderInfo + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `email` | [string](#string) | | | + | `website` | [string](#string) | | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateProvider` | [MsgCreateProvider](#akash.provider.v1beta2.MsgCreateProvider) | [MsgCreateProviderResponse](#akash.provider.v1beta2.MsgCreateProviderResponse) | CreateProvider defines a method that creates a provider given the proper inputs | | + | `UpdateProvider` | [MsgUpdateProvider](#akash.provider.v1beta2.MsgUpdateProvider) | [MsgUpdateProviderResponse](#akash.provider.v1beta2.MsgUpdateProviderResponse) | UpdateProvider defines a method that updates a provider given the proper inputs | | + | `DeleteProvider` | [MsgDeleteProvider](#akash.provider.v1beta2.MsgDeleteProvider) | [MsgDeleteProviderResponse](#akash.provider.v1beta2.MsgDeleteProviderResponse) | DeleteProvider defines a method that deletes a provider given the proper inputs | | + + + + + + + + + ## akash/provider/v1beta1/provider.proto + + + + + + ### MsgCreateProvider + MsgCreateProvider defines an SDK message for creating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta1.ProviderInfo) | | | + + + + + + + + + ### MsgCreateProviderResponse + MsgCreateProviderResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### MsgDeleteProvider + MsgDeleteProvider defines an SDK message for deleting a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + + + + + + + + + ### MsgDeleteProviderResponse + MsgDeleteProviderResponse defines the Msg/DeleteProvider response type. + + + + + + + + + ### MsgUpdateProvider + MsgUpdateProvider defines an SDK message for updating a provider + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta1.ProviderInfo) | | | + + + + + + + + + ### MsgUpdateProviderResponse + MsgUpdateProviderResponse defines the Msg/UpdateProvider response type. + + + + + + + + + ### Provider + Provider stores owner and host details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `host_uri` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + | `info` | [ProviderInfo](#akash.provider.v1beta1.ProviderInfo) | | | + + + + + + + + + ### ProviderInfo + ProviderInfo + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `email` | [string](#string) | | | + | `website` | [string](#string) | | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateProvider` | [MsgCreateProvider](#akash.provider.v1beta1.MsgCreateProvider) | [MsgCreateProviderResponse](#akash.provider.v1beta1.MsgCreateProviderResponse) | CreateProvider defines a method that creates a provider given the proper inputs | | + | `UpdateProvider` | [MsgUpdateProvider](#akash.provider.v1beta1.MsgUpdateProvider) | [MsgUpdateProviderResponse](#akash.provider.v1beta1.MsgUpdateProviderResponse) | UpdateProvider defines a method that updates a provider given the proper inputs | | + | `DeleteProvider` | [MsgDeleteProvider](#akash.provider.v1beta1.MsgDeleteProvider) | [MsgDeleteProviderResponse](#akash.provider.v1beta1.MsgDeleteProviderResponse) | DeleteProvider defines a method that deletes a provider given the proper inputs | | + + + + + + + + + ## akash/audit/v1beta3/audit.proto + + + + + + ### AttributesFilters + AttributesFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditors` | [string](#string) | repeated | | + | `owners` | [string](#string) | repeated | | + + + + + + + + + ### AttributesResponse + AttributesResponse represents details of deployment along with group details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `attributes` | [AuditedAttributes](#akash.audit.v1beta3.AuditedAttributes) | repeated | | + + + + + + + + + ### AuditedAttributes + Attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributes + MsgDeleteProviderAttributes defined the Msg/DeleteProviderAttributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `keys` | [string](#string) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributesResponse + MsgDeleteProviderAttributesResponse defines the Msg/ProviderAttributes response type. + + + + + + + + + ### MsgSignProviderAttributes + MsgSignProviderAttributes defines an SDK message for signing a provider attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + ### MsgSignProviderAttributesResponse + MsgSignProviderAttributesResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### Provider + Provider stores owner auditor and attributes details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `SignProviderAttributes` | [MsgSignProviderAttributes](#akash.audit.v1beta3.MsgSignProviderAttributes) | [MsgSignProviderAttributesResponse](#akash.audit.v1beta3.MsgSignProviderAttributesResponse) | SignProviderAttributes defines a method that signs provider attributes | | + | `DeleteProviderAttributes` | [MsgDeleteProviderAttributes](#akash.audit.v1beta3.MsgDeleteProviderAttributes) | [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta3.MsgDeleteProviderAttributesResponse) | DeleteProviderAttributes defines a method that deletes provider attributes | | + + + + + + + + + ## akash/audit/v1beta3/query.proto + + + + + + ### QueryAllProvidersAttributesRequest + QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryAuditorAttributesRequest + QueryAuditorAttributesRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProviderAttributesRequest + QueryProviderAttributesRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProviderAuditorRequest + QueryProviderAuditorRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProviderRequest + QueryProviderRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProvidersResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.audit.v1beta3.Provider) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `AllProvidersAttributes` | [QueryAllProvidersAttributesRequest](#akash.audit.v1beta3.QueryAllProvidersAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta3.QueryProvidersResponse) | AllProvidersAttributes queries all providers buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta3/audit/attributes/list| + | `ProviderAttributes` | [QueryProviderAttributesRequest](#akash.audit.v1beta3.QueryProviderAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta3.QueryProvidersResponse) | ProviderAttributes queries all provider signed attributes buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta3/audit/attributes/{owner}/list| + | `ProviderAuditorAttributes` | [QueryProviderAuditorRequest](#akash.audit.v1beta3.QueryProviderAuditorRequest) | [QueryProvidersResponse](#akash.audit.v1beta3.QueryProvidersResponse) | ProviderAuditorAttributes queries provider signed attributes by specific auditor buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta3/audit/attributes/{auditor}/{owner}| + | `AuditorAttributes` | [QueryAuditorAttributesRequest](#akash.audit.v1beta3.QueryAuditorAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta3.QueryProvidersResponse) | AuditorAttributes queries all providers signed by this auditor buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/provider/v1beta3/auditor/{auditor}/list| + + + + + + + + + ## akash/audit/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by audit module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `attributes` | [AuditedAttributes](#akash.audit.v1beta3.AuditedAttributes) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/audit/v1beta2/audit.proto + + + + + + ### AttributesFilters + AttributesFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditors` | [string](#string) | repeated | | + | `owners` | [string](#string) | repeated | | + + + + + + + + + ### AttributesResponse + AttributesResponse represents details of deployment along with group details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `attributes` | [AuditedAttributes](#akash.audit.v1beta2.AuditedAttributes) | repeated | | + + + + + + + + + ### AuditedAttributes + Attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributes + MsgDeleteProviderAttributes defined the Msg/DeleteProviderAttributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `keys` | [string](#string) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributesResponse + MsgDeleteProviderAttributesResponse defines the Msg/ProviderAttributes response type. + + + + + + + + + ### MsgSignProviderAttributes + MsgSignProviderAttributes defines an SDK message for signing a provider attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + ### MsgSignProviderAttributesResponse + MsgSignProviderAttributesResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### Provider + Provider stores owner auditor and attributes details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta2.Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `SignProviderAttributes` | [MsgSignProviderAttributes](#akash.audit.v1beta2.MsgSignProviderAttributes) | [MsgSignProviderAttributesResponse](#akash.audit.v1beta2.MsgSignProviderAttributesResponse) | SignProviderAttributes defines a method that signs provider attributes | | + | `DeleteProviderAttributes` | [MsgDeleteProviderAttributes](#akash.audit.v1beta2.MsgDeleteProviderAttributes) | [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta2.MsgDeleteProviderAttributesResponse) | DeleteProviderAttributes defines a method that deletes provider attributes | | + + + + + + + + + ## akash/audit/v1beta2/query.proto + + + + + + ### QueryAllProvidersAttributesRequest + QueryAllProvidersAttributesRequest is request type for the Query/All Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryAuditorAttributesRequest + QueryAuditorAttributesRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProviderAttributesRequest + QueryProviderAttributesRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryProviderAuditorRequest + QueryProviderAuditorRequest is request type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProviderRequest + QueryProviderRequest is request type for the Query/Provider RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditor` | [string](#string) | | | + | `owner` | [string](#string) | | | + + + + + + + + + ### QueryProvidersResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `providers` | [Provider](#akash.audit.v1beta2.Provider) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `AllProvidersAttributes` | [QueryAllProvidersAttributesRequest](#akash.audit.v1beta2.QueryAllProvidersAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta2.QueryProvidersResponse) | AllProvidersAttributes queries all providers buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta2/audit/attributes/list| + | `ProviderAttributes` | [QueryProviderAttributesRequest](#akash.audit.v1beta2.QueryProviderAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta2.QueryProvidersResponse) | ProviderAttributes queries all provider signed attributes buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta2/audit/attributes/{owner}/list| + | `ProviderAuditorAttributes` | [QueryProviderAuditorRequest](#akash.audit.v1beta2.QueryProviderAuditorRequest) | [QueryProvidersResponse](#akash.audit.v1beta2.QueryProvidersResponse) | ProviderAuditorAttributes queries provider signed attributes by specific auditor buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/audit/v1beta2/audit/attributes/{auditor}/{owner}| + | `AuditorAttributes` | [QueryAuditorAttributesRequest](#akash.audit.v1beta2.QueryAuditorAttributesRequest) | [QueryProvidersResponse](#akash.audit.v1beta2.QueryProvidersResponse) | AuditorAttributes queries all providers signed by this auditor buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | GET|/akash/provider/v1beta2/auditor/{auditor}/list| + + + + + + + + + ## akash/audit/v1beta2/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by audit module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `attributes` | [AuditedAttributes](#akash.audit.v1beta2.AuditedAttributes) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/audit/v1beta1/audit.proto + + + + + + ### AttributesFilters + AttributesFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `auditors` | [string](#string) | repeated | | + | `owners` | [string](#string) | repeated | | + + + + + + + + + ### AttributesResponse + AttributesResponse represents details of deployment along with group details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `attributes` | [AuditedAttributes](#akash.audit.v1beta1.AuditedAttributes) | repeated | | + + + + + + + + + ### AuditedAttributes + Attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributes + MsgDeleteProviderAttributes defined the Msg/DeleteProviderAttributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `keys` | [string](#string) | repeated | | + + + + + + + + + ### MsgDeleteProviderAttributesResponse + MsgDeleteProviderAttributesResponse defines the Msg/ProviderAttributes response type. + + + + + + + + + ### MsgSignProviderAttributes + MsgSignProviderAttributes defines an SDK message for signing a provider attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + ### MsgSignProviderAttributesResponse + MsgSignProviderAttributesResponse defines the Msg/CreateProvider response type. + + + + + + + + + ### Provider + Provider stores owner auditor and attributes details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `auditor` | [string](#string) | | | + | `attributes` | [akash.base.v1beta1.Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `SignProviderAttributes` | [MsgSignProviderAttributes](#akash.audit.v1beta1.MsgSignProviderAttributes) | [MsgSignProviderAttributesResponse](#akash.audit.v1beta1.MsgSignProviderAttributesResponse) | SignProviderAttributes defines a method that signs provider attributes | | + | `DeleteProviderAttributes` | [MsgDeleteProviderAttributes](#akash.audit.v1beta1.MsgDeleteProviderAttributes) | [MsgDeleteProviderAttributesResponse](#akash.audit.v1beta1.MsgDeleteProviderAttributesResponse) | DeleteProviderAttributes defines a method that deletes provider attributes | | + + + + + + + + + ## akash/take/v1beta3/query.proto + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + + + + + + + + + ## akash/take/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.take.v1beta3.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/take/v1beta3/params.proto + + + + + + ### DenomTakeRate + DenomTakeRate describes take rate for specified denom + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `denom` | [string](#string) | | | + | `rate` | [uint32](#uint32) | | | + + + + + + + + + ### Params + Params defines the parameters for the x/take package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `denom_take_rates` | [DenomTakeRate](#akash.take.v1beta3.DenomTakeRate) | repeated | denom -> % take rate | + | `default_take_rate` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/groupmsg.proto + + + + + + ### MsgCloseGroup + MsgCloseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta3.GroupID) | | | + + + + + + + + + ### MsgCloseGroupResponse + MsgCloseGroupResponse defines the Msg/CloseGroup response type. + + + + + + + + + ### MsgPauseGroup + MsgPauseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta3.GroupID) | | | + + + + + + + + + ### MsgPauseGroupResponse + MsgPauseGroupResponse defines the Msg/PauseGroup response type. + + + + + + + + + ### MsgStartGroup + MsgStartGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta3.GroupID) | | | + + + + + + + + + ### MsgStartGroupResponse + MsgStartGroupResponse defines the Msg/StartGroup response type. + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/resourceunit.proto + + + + + + ### ResourceUnit + ResourceUnit extends Resources and adds Count along with the Price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `resource` | [akash.base.v1beta3.Resources](#akash.base.v1beta3.Resources) | | | + | `count` | [uint32](#uint32) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/group.proto + + + + + + ### Group + Group stores group id, state and specifications of group + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group_id` | [GroupID](#akash.deployment.v1beta3.GroupID) | | | + | `state` | [Group.State](#akash.deployment.v1beta3.Group.State) | | | + | `group_spec` | [GroupSpec](#akash.deployment.v1beta3.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + + + ### Group.State + State is an enum which refers to state of group + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | GroupOpen denotes state for group open | + | paused | 2 | GroupOrdered denotes state for group ordered | + | insufficient_funds | 3 | GroupInsufficientFunds denotes state for group insufficient_funds | + | closed | 4 | GroupClosed denotes state for group closed | + + + + + + + + + + + + + + ## akash/deployment/v1beta3/groupid.proto + + + + + + ### GroupID + GroupID stores owner, deployment sequence number and group sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/deployment.proto + + + + + + ### Deployment + Deployment stores deploymentID, state and version details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment_id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + | `state` | [Deployment.State](#akash.deployment.v1beta3.Deployment.State) | | | + | `version` | [bytes](#bytes) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### DeploymentFilters + DeploymentFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### DeploymentID + DeploymentID stores owner and sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + + + + + + + + + + + ### Deployment.State + State is an enum which refers to state of deployment + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | DeploymentActive denotes state for deployment active | + | closed | 2 | DeploymentClosed denotes state for deployment closed | + + + + + + + + + + + + + + ## akash/deployment/v1beta3/query.proto + + + + + + ### QueryDeploymentRequest + QueryDeploymentRequest is request type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + + + + + + + + + ### QueryDeploymentResponse + QueryDeploymentResponse is response type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta3.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta3.Group) | repeated | | + | `escrow_account` | [akash.escrow.v1beta3.Account](#akash.escrow.v1beta3.Account) | | | + + + + + + + + + ### QueryDeploymentsRequest + QueryDeploymentsRequest is request type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [DeploymentFilters](#akash.deployment.v1beta3.DeploymentFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryDeploymentsResponse + QueryDeploymentsResponse is response type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [QueryDeploymentResponse](#akash.deployment.v1beta3.QueryDeploymentResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryGroupRequest + QueryGroupRequest is request type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta3.GroupID) | | | + + + + + + + + + ### QueryGroupResponse + QueryGroupResponse is response type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group` | [Group](#akash.deployment.v1beta3.Group) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Deployments` | [QueryDeploymentsRequest](#akash.deployment.v1beta3.QueryDeploymentsRequest) | [QueryDeploymentsResponse](#akash.deployment.v1beta3.QueryDeploymentsResponse) | Deployments queries deployments | GET|/akash/deployment/v1beta3/deployments/list| + | `Deployment` | [QueryDeploymentRequest](#akash.deployment.v1beta3.QueryDeploymentRequest) | [QueryDeploymentResponse](#akash.deployment.v1beta3.QueryDeploymentResponse) | Deployment queries deployment details | GET|/akash/deployment/v1beta3/deployments/info| + | `Group` | [QueryGroupRequest](#akash.deployment.v1beta3.QueryGroupRequest) | [QueryGroupResponse](#akash.deployment.v1beta3.QueryGroupResponse) | Group queries group details | GET|/akash/deployment/v1beta3/groups/info| + + + + + + + + + ## akash/deployment/v1beta3/deploymentmsg.proto + + + + + + ### MsgCloseDeployment + MsgCloseDeployment defines an SDK message for closing deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + + + + + + + + + ### MsgCloseDeploymentResponse + MsgCloseDeploymentResponse defines the Msg/CloseDeployment response type. + + + + + + + + + ### MsgCreateDeployment + MsgCreateDeployment defines an SDK message for creating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + | `groups` | [GroupSpec](#akash.deployment.v1beta3.GroupSpec) | repeated | | + | `version` | [bytes](#bytes) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `depositor` | [string](#string) | | Depositor pays for the deposit | + + + + + + + + + ### MsgCreateDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgDepositDeployment + MsgDepositDeployment deposits more funds into the deposit account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + | `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `depositor` | [string](#string) | | Depositor pays for the deposit | + + + + + + + + + ### MsgDepositDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgUpdateDeployment + MsgUpdateDeployment defines an SDK message for updating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta3.DeploymentID) | | | + | `version` | [bytes](#bytes) | | | + + + + + + + + + ### MsgUpdateDeploymentResponse + MsgUpdateDeploymentResponse defines the Msg/UpdateDeployment response type. + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/service.proto + + + + + + + + + + + + ### Msg + Msg defines the deployment Msg service. + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateDeployment` | [MsgCreateDeployment](#akash.deployment.v1beta3.MsgCreateDeployment) | [MsgCreateDeploymentResponse](#akash.deployment.v1beta3.MsgCreateDeploymentResponse) | CreateDeployment defines a method to create new deployment given proper inputs. | | + | `DepositDeployment` | [MsgDepositDeployment](#akash.deployment.v1beta3.MsgDepositDeployment) | [MsgDepositDeploymentResponse](#akash.deployment.v1beta3.MsgDepositDeploymentResponse) | DepositDeployment deposits more funds into the deployment account | | + | `UpdateDeployment` | [MsgUpdateDeployment](#akash.deployment.v1beta3.MsgUpdateDeployment) | [MsgUpdateDeploymentResponse](#akash.deployment.v1beta3.MsgUpdateDeploymentResponse) | UpdateDeployment defines a method to update a deployment given proper inputs. | | + | `CloseDeployment` | [MsgCloseDeployment](#akash.deployment.v1beta3.MsgCloseDeployment) | [MsgCloseDeploymentResponse](#akash.deployment.v1beta3.MsgCloseDeploymentResponse) | CloseDeployment defines a method to close a deployment given proper inputs. | | + | `CloseGroup` | [MsgCloseGroup](#akash.deployment.v1beta3.MsgCloseGroup) | [MsgCloseGroupResponse](#akash.deployment.v1beta3.MsgCloseGroupResponse) | CloseGroup defines a method to close a group of a deployment given proper inputs. | | + | `PauseGroup` | [MsgPauseGroup](#akash.deployment.v1beta3.MsgPauseGroup) | [MsgPauseGroupResponse](#akash.deployment.v1beta3.MsgPauseGroupResponse) | PauseGroup defines a method to close a group of a deployment given proper inputs. | | + | `StartGroup` | [MsgStartGroup](#akash.deployment.v1beta3.MsgStartGroup) | [MsgStartGroupResponse](#akash.deployment.v1beta3.MsgStartGroupResponse) | StartGroup defines a method to close a group of a deployment given proper inputs. | | + + + + + + + + + ## akash/deployment/v1beta3/authz.proto + + + + + + ### DepositDeploymentAuthorization + DepositDeploymentAuthorization allows the grantee to deposit up to spend_limit coins from +the granter's account for a deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `spend_limit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | SpendLimit is the amount the grantee is authorized to spend from the granter's account for the purpose of deployment. | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/genesis.proto + + + + + + ### GenesisDeployment + GenesisDeployment defines the basic genesis state used by deployment module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta3.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta3.Group) | repeated | | + + + + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [GenesisDeployment](#akash.deployment.v1beta3.GenesisDeployment) | repeated | | + | `params` | [Params](#akash.deployment.v1beta3.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/groupspec.proto + + + + + + ### GroupSpec + GroupSpec stores group specifications + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `requirements` | [akash.base.v1beta3.PlacementRequirements](#akash.base.v1beta3.PlacementRequirements) | | | + | `resources` | [ResourceUnit](#akash.deployment.v1beta3.ResourceUnit) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta3/params.proto + + + + + + ### Params + Params defines the parameters for the x/deployment package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `min_deposits` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/groupmsg.proto + + + + + + ### MsgCloseGroup + MsgCloseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta2.GroupID) | | | + + + + + + + + + ### MsgCloseGroupResponse + MsgCloseGroupResponse defines the Msg/CloseGroup response type. + + + + + + + + + ### MsgPauseGroup + MsgPauseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta2.GroupID) | | | + + + + + + + + + ### MsgPauseGroupResponse + MsgPauseGroupResponse defines the Msg/PauseGroup response type. + + + + + + + + + ### MsgStartGroup + MsgStartGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta2.GroupID) | | | + + + + + + + + + ### MsgStartGroupResponse + MsgStartGroupResponse defines the Msg/StartGroup response type. + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/group.proto + + + + + + ### Group + Group stores group id, state and specifications of group + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group_id` | [GroupID](#akash.deployment.v1beta2.GroupID) | | | + | `state` | [Group.State](#akash.deployment.v1beta2.Group.State) | | | + | `group_spec` | [GroupSpec](#akash.deployment.v1beta2.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + + + ### Group.State + State is an enum which refers to state of group + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | GroupOpen denotes state for group open | + | paused | 2 | GroupOrdered denotes state for group ordered | + | insufficient_funds | 3 | GroupInsufficientFunds denotes state for group insufficient_funds | + | closed | 4 | GroupClosed denotes state for group closed | + + + + + + + + + + + + + + ## akash/deployment/v1beta2/groupid.proto + + + + + + ### GroupID + GroupID stores owner, deployment sequence number and group sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/deployment.proto + + + + + + ### Deployment + Deployment stores deploymentID, state and version details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment_id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + | `state` | [Deployment.State](#akash.deployment.v1beta2.Deployment.State) | | | + | `version` | [bytes](#bytes) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### DeploymentFilters + DeploymentFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### DeploymentID + DeploymentID stores owner and sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + + + + + + + + + + + ### Deployment.State + State is an enum which refers to state of deployment + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | DeploymentActive denotes state for deployment active | + | closed | 2 | DeploymentClosed denotes state for deployment closed | + + + + + + + + + + + + + + ## akash/deployment/v1beta2/query.proto + + + + + + ### QueryDeploymentRequest + QueryDeploymentRequest is request type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + + + + + + + + + ### QueryDeploymentResponse + QueryDeploymentResponse is response type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta2.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta2.Group) | repeated | | + | `escrow_account` | [akash.escrow.v1beta2.Account](#akash.escrow.v1beta2.Account) | | | + + + + + + + + + ### QueryDeploymentsRequest + QueryDeploymentsRequest is request type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [DeploymentFilters](#akash.deployment.v1beta2.DeploymentFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryDeploymentsResponse + QueryDeploymentsResponse is response type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [QueryDeploymentResponse](#akash.deployment.v1beta2.QueryDeploymentResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryGroupRequest + QueryGroupRequest is request type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta2.GroupID) | | | + + + + + + + + + ### QueryGroupResponse + QueryGroupResponse is response type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group` | [Group](#akash.deployment.v1beta2.Group) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Deployments` | [QueryDeploymentsRequest](#akash.deployment.v1beta2.QueryDeploymentsRequest) | [QueryDeploymentsResponse](#akash.deployment.v1beta2.QueryDeploymentsResponse) | Deployments queries deployments | GET|/akash/deployment/v1beta2/deployments/list| + | `Deployment` | [QueryDeploymentRequest](#akash.deployment.v1beta2.QueryDeploymentRequest) | [QueryDeploymentResponse](#akash.deployment.v1beta2.QueryDeploymentResponse) | Deployment queries deployment details | GET|/akash/deployment/v1beta2/deployments/info| + | `Group` | [QueryGroupRequest](#akash.deployment.v1beta2.QueryGroupRequest) | [QueryGroupResponse](#akash.deployment.v1beta2.QueryGroupResponse) | Group queries group details | GET|/akash/deployment/v1beta2/groups/info| + + + + + + + + + ## akash/deployment/v1beta2/deploymentmsg.proto + + + + + + ### MsgCloseDeployment + MsgCloseDeployment defines an SDK message for closing deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + + + + + + + + + ### MsgCloseDeploymentResponse + MsgCloseDeploymentResponse defines the Msg/CloseDeployment response type. + + + + + + + + + ### MsgCreateDeployment + MsgCreateDeployment defines an SDK message for creating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + | `groups` | [GroupSpec](#akash.deployment.v1beta2.GroupSpec) | repeated | | + | `version` | [bytes](#bytes) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `depositor` | [string](#string) | | Depositor pays for the deposit | + + + + + + + + + ### MsgCreateDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgDepositDeployment + MsgDepositDeployment deposits more funds into the deposit account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + | `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `depositor` | [string](#string) | | Depositor pays for the deposit | + + + + + + + + + ### MsgDepositDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgUpdateDeployment + MsgUpdateDeployment defines an SDK message for updating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta2.DeploymentID) | | | + | `version` | [bytes](#bytes) | | | + + + + + + + + + ### MsgUpdateDeploymentResponse + MsgUpdateDeploymentResponse defines the Msg/UpdateDeployment response type. + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/service.proto + + + + + + + + + + + + ### Msg + Msg defines the deployment Msg service. + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateDeployment` | [MsgCreateDeployment](#akash.deployment.v1beta2.MsgCreateDeployment) | [MsgCreateDeploymentResponse](#akash.deployment.v1beta2.MsgCreateDeploymentResponse) | CreateDeployment defines a method to create new deployment given proper inputs. | | + | `DepositDeployment` | [MsgDepositDeployment](#akash.deployment.v1beta2.MsgDepositDeployment) | [MsgDepositDeploymentResponse](#akash.deployment.v1beta2.MsgDepositDeploymentResponse) | DepositDeployment deposits more funds into the deployment account | | + | `UpdateDeployment` | [MsgUpdateDeployment](#akash.deployment.v1beta2.MsgUpdateDeployment) | [MsgUpdateDeploymentResponse](#akash.deployment.v1beta2.MsgUpdateDeploymentResponse) | UpdateDeployment defines a method to update a deployment given proper inputs. | | + | `CloseDeployment` | [MsgCloseDeployment](#akash.deployment.v1beta2.MsgCloseDeployment) | [MsgCloseDeploymentResponse](#akash.deployment.v1beta2.MsgCloseDeploymentResponse) | CloseDeployment defines a method to close a deployment given proper inputs. | | + | `CloseGroup` | [MsgCloseGroup](#akash.deployment.v1beta2.MsgCloseGroup) | [MsgCloseGroupResponse](#akash.deployment.v1beta2.MsgCloseGroupResponse) | CloseGroup defines a method to close a group of a deployment given proper inputs. | | + | `PauseGroup` | [MsgPauseGroup](#akash.deployment.v1beta2.MsgPauseGroup) | [MsgPauseGroupResponse](#akash.deployment.v1beta2.MsgPauseGroupResponse) | PauseGroup defines a method to close a group of a deployment given proper inputs. | | + | `StartGroup` | [MsgStartGroup](#akash.deployment.v1beta2.MsgStartGroup) | [MsgStartGroupResponse](#akash.deployment.v1beta2.MsgStartGroupResponse) | StartGroup defines a method to close a group of a deployment given proper inputs. | | + + + + + + + + + ## akash/deployment/v1beta2/authz.proto + + + + + + ### DepositDeploymentAuthorization + DepositDeploymentAuthorization allows the grantee to deposit up to spend_limit coins from +the granter's account for a deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `spend_limit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | SpendLimit is the amount the grantee is authorized to spend from the granter's account for the purpose of deployment. | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/genesis.proto + + + + + + ### GenesisDeployment + GenesisDeployment defines the basic genesis state used by deployment module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta2.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta2.Group) | repeated | | + + + + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [GenesisDeployment](#akash.deployment.v1beta2.GenesisDeployment) | repeated | | + | `params` | [Params](#akash.deployment.v1beta2.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/groupspec.proto + + + + + + ### GroupSpec + GroupSpec stores group specifications + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `requirements` | [akash.base.v1beta2.PlacementRequirements](#akash.base.v1beta2.PlacementRequirements) | | | + | `resources` | [Resource](#akash.deployment.v1beta2.Resource) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/resource.proto + + + + + + ### Resource + Resource stores unit, total count and price of resource + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `resources` | [akash.base.v1beta2.ResourceUnits](#akash.base.v1beta2.ResourceUnits) | | | + | `count` | [uint32](#uint32) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta2/params.proto + + + + + + ### Params + Params defines the parameters for the x/deployment package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment_min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta1/group.proto + + + + + + ### Group + Group stores group id, state and specifications of group + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group_id` | [GroupID](#akash.deployment.v1beta1.GroupID) | | | + | `state` | [Group.State](#akash.deployment.v1beta1.Group.State) | | | + | `group_spec` | [GroupSpec](#akash.deployment.v1beta1.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### GroupID + GroupID stores owner, deployment sequence number and group sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + + + + + + + + + ### GroupSpec + GroupSpec stores group specifications + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `requirements` | [akash.base.v1beta1.PlacementRequirements](#akash.base.v1beta1.PlacementRequirements) | | | + | `resources` | [Resource](#akash.deployment.v1beta1.Resource) | repeated | | + + + + + + + + + ### MsgCloseGroup + MsgCloseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta1.GroupID) | | | + + + + + + + + + ### MsgCloseGroupResponse + MsgCloseGroupResponse defines the Msg/CloseGroup response type. + + + + + + + + + ### MsgPauseGroup + MsgPauseGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta1.GroupID) | | | + + + + + + + + + ### MsgPauseGroupResponse + MsgPauseGroupResponse defines the Msg/PauseGroup response type. + + + + + + + + + ### MsgStartGroup + MsgStartGroup defines SDK message to close a single Group within a Deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta1.GroupID) | | | + + + + + + + + + ### MsgStartGroupResponse + MsgStartGroupResponse defines the Msg/StartGroup response type. + + + + + + + + + ### Resource + Resource stores unit, total count and price of resource + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `resources` | [akash.base.v1beta1.ResourceUnits](#akash.base.v1beta1.ResourceUnits) | | | + | `count` | [uint32](#uint32) | | | + | `price` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + ### Group.State + State is an enum which refers to state of group + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | GroupOpen denotes state for group open | + | paused | 2 | GroupOrdered denotes state for group ordered | + | insufficient_funds | 3 | GroupInsufficientFunds denotes state for group insufficient_funds | + | closed | 4 | GroupClosed denotes state for group closed | + + + + + + + + + + + + + + ## akash/deployment/v1beta1/deployment.proto + + + + + + ### Deployment + Deployment stores deploymentID, state and version details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment_id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + | `state` | [Deployment.State](#akash.deployment.v1beta1.Deployment.State) | | | + | `version` | [bytes](#bytes) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### DeploymentFilters + DeploymentFilters defines filters used to filter deployments + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### DeploymentID + DeploymentID stores owner and sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + + + + + + + + + ### MsgCloseDeployment + MsgCloseDeployment defines an SDK message for closing deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + + + + + + + + + ### MsgCloseDeploymentResponse + MsgCloseDeploymentResponse defines the Msg/CloseDeployment response type. + + + + + + + + + ### MsgCreateDeployment + MsgCreateDeployment defines an SDK message for creating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + | `groups` | [GroupSpec](#akash.deployment.v1beta1.GroupSpec) | repeated | | + | `version` | [bytes](#bytes) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + ### MsgCreateDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgDepositDeployment + MsgDepositDeployment deposits more funds into the deposit account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + | `amount` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + ### MsgDepositDeploymentResponse + MsgCreateDeploymentResponse defines the Msg/CreateDeployment response type. + + + + + + + + + ### MsgUpdateDeployment + MsgUpdateDeployment defines an SDK message for updating deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + | `groups` | [GroupSpec](#akash.deployment.v1beta1.GroupSpec) | repeated | | + | `version` | [bytes](#bytes) | | | + + + + + + + + + ### MsgUpdateDeploymentResponse + MsgUpdateDeploymentResponse defines the Msg/UpdateDeployment response type. + + + + + + + + + + + ### Deployment.State + State is an enum which refers to state of deployment + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | DeploymentActive denotes state for deployment active | + | closed | 2 | DeploymentClosed denotes state for deployment closed | + + + + + + + + + + ### Msg + Msg defines the deployment Msg service. + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateDeployment` | [MsgCreateDeployment](#akash.deployment.v1beta1.MsgCreateDeployment) | [MsgCreateDeploymentResponse](#akash.deployment.v1beta1.MsgCreateDeploymentResponse) | CreateDeployment defines a method to create new deployment given proper inputs. | | + | `DepositDeployment` | [MsgDepositDeployment](#akash.deployment.v1beta1.MsgDepositDeployment) | [MsgDepositDeploymentResponse](#akash.deployment.v1beta1.MsgDepositDeploymentResponse) | DepositDeployment deposits more funds into the deployment account | | + | `UpdateDeployment` | [MsgUpdateDeployment](#akash.deployment.v1beta1.MsgUpdateDeployment) | [MsgUpdateDeploymentResponse](#akash.deployment.v1beta1.MsgUpdateDeploymentResponse) | UpdateDeployment defines a method to update a deployment given proper inputs. | | + | `CloseDeployment` | [MsgCloseDeployment](#akash.deployment.v1beta1.MsgCloseDeployment) | [MsgCloseDeploymentResponse](#akash.deployment.v1beta1.MsgCloseDeploymentResponse) | CloseDeployment defines a method to close a deployment given proper inputs. | | + | `CloseGroup` | [MsgCloseGroup](#akash.deployment.v1beta1.MsgCloseGroup) | [MsgCloseGroupResponse](#akash.deployment.v1beta1.MsgCloseGroupResponse) | CloseGroup defines a method to close a group of a deployment given proper inputs. | | + | `PauseGroup` | [MsgPauseGroup](#akash.deployment.v1beta1.MsgPauseGroup) | [MsgPauseGroupResponse](#akash.deployment.v1beta1.MsgPauseGroupResponse) | PauseGroup defines a method to close a group of a deployment given proper inputs. | | + | `StartGroup` | [MsgStartGroup](#akash.deployment.v1beta1.MsgStartGroup) | [MsgStartGroupResponse](#akash.deployment.v1beta1.MsgStartGroupResponse) | StartGroup defines a method to close a group of a deployment given proper inputs. | | + + + + + + + + + ## akash/deployment/v1beta1/query.proto + + + + + + ### QueryDeploymentRequest + QueryDeploymentRequest is request type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [DeploymentID](#akash.deployment.v1beta1.DeploymentID) | | | + + + + + + + + + ### QueryDeploymentResponse + QueryDeploymentResponse is response type for the Query/Deployment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta1.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta1.Group) | repeated | | + | `escrow_account` | [akash.escrow.v1beta1.Account](#akash.escrow.v1beta1.Account) | | | + + + + + + + + + ### QueryDeploymentsRequest + QueryDeploymentsRequest is request type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [DeploymentFilters](#akash.deployment.v1beta1.DeploymentFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryDeploymentsResponse + QueryDeploymentsResponse is response type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [QueryDeploymentResponse](#akash.deployment.v1beta1.QueryDeploymentResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryGroupRequest + QueryGroupRequest is request type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [GroupID](#akash.deployment.v1beta1.GroupID) | | | + + + + + + + + + ### QueryGroupResponse + QueryGroupResponse is response type for the Query/Group RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `group` | [Group](#akash.deployment.v1beta1.Group) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Deployments` | [QueryDeploymentsRequest](#akash.deployment.v1beta1.QueryDeploymentsRequest) | [QueryDeploymentsResponse](#akash.deployment.v1beta1.QueryDeploymentsResponse) | Deployments queries deployments | GET|/akash/deployment/v1beta1/deployments/list| + | `Deployment` | [QueryDeploymentRequest](#akash.deployment.v1beta1.QueryDeploymentRequest) | [QueryDeploymentResponse](#akash.deployment.v1beta1.QueryDeploymentResponse) | Deployment queries deployment details | GET|/akash/deployment/v1beta1/deployments/info| + | `Group` | [QueryGroupRequest](#akash.deployment.v1beta1.QueryGroupRequest) | [QueryGroupResponse](#akash.deployment.v1beta1.QueryGroupResponse) | Group queries group details | GET|/akash/deployment/v1beta1/groups/info| + + + + + + + + + ## akash/deployment/v1beta1/authz.proto + + + + + + ### DepositDeploymentAuthorization + DepositDeploymentAuthorization allows the grantee to deposit up to spend_limit coins from +the granter's account for a deployment. + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `spend_limit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | SpendLimit is the amount the grantee is authorized to spend from the granter's account for the purpose of deployment. | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta1/genesis.proto + + + + + + ### GenesisDeployment + GenesisDeployment defines the basic genesis state used by deployment module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment` | [Deployment](#akash.deployment.v1beta1.Deployment) | | | + | `groups` | [Group](#akash.deployment.v1beta1.Group) | repeated | | + + + + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployments` | [GenesisDeployment](#akash.deployment.v1beta1.GenesisDeployment) | repeated | | + | `params` | [Params](#akash.deployment.v1beta1.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/deployment/v1beta1/params.proto + + + + + + ### Params + Params defines the parameters for the x/deployment package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deployment_min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + + + + + + + + + ## akash/staking/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.staking.v1beta3.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/staking/v1beta3/params.proto + + + + + + ### Params + Params extends the parameters for the x/staking module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `min_commission_rate` | [string](#string) | | min_commission_rate is the chain-wide minimum commission rate that a validator can charge their delegators | + + + + + + + + + + + + + + + + + + + ## akash/cert/v1beta3/query.proto + + + + + + ### CertificateResponse + CertificateResponse contains a single X509 certificate and its serial number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificate` | [Certificate](#akash.cert.v1beta3.Certificate) | | | + | `serial` | [string](#string) | | | + + + + + + + + + ### QueryCertificatesRequest + QueryDeploymentsRequest is request type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filter` | [CertificateFilter](#akash.cert.v1beta3.CertificateFilter) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryCertificatesResponse + QueryCertificatesResponse is response type for the Query/Certificates RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificates` | [CertificateResponse](#akash.cert.v1beta3.CertificateResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Certificates` | [QueryCertificatesRequest](#akash.cert.v1beta3.QueryCertificatesRequest) | [QueryCertificatesResponse](#akash.cert.v1beta3.QueryCertificatesResponse) | Certificates queries certificates | GET|/akash/cert/v1beta3/certificates/list| + + + + + + + + + ## akash/cert/v1beta3/cert.proto + + + + + + ### Certificate + Certificate stores state, certificate and it's public key + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `state` | [Certificate.State](#akash.cert.v1beta3.Certificate.State) | | | + | `cert` | [bytes](#bytes) | | | + | `pubkey` | [bytes](#bytes) | | | + + + + + + + + + ### CertificateFilter + CertificateFilter defines filters used to filter certificates + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `serial` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### CertificateID + CertificateID stores owner and sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `serial` | [string](#string) | | | + + + + + + + + + ### MsgCreateCertificate + MsgCreateCertificate defines an SDK message for creating certificate + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `cert` | [bytes](#bytes) | | | + | `pubkey` | [bytes](#bytes) | | | + + + + + + + + + ### MsgCreateCertificateResponse + MsgCreateCertificateResponse defines the Msg/CreateCertificate response type. + + + + + + + + + ### MsgRevokeCertificate + MsgRevokeCertificate defines an SDK message for revoking certificate + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [CertificateID](#akash.cert.v1beta3.CertificateID) | | | + + + + + + + + + ### MsgRevokeCertificateResponse + MsgRevokeCertificateResponse defines the Msg/RevokeCertificate response type. + + + + + + + + + + + ### Certificate.State + State is an enum which refers to state of deployment + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | valid | 1 | CertificateValid denotes state for deployment active | + | revoked | 2 | CertificateRevoked denotes state for deployment closed | + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateCertificate` | [MsgCreateCertificate](#akash.cert.v1beta3.MsgCreateCertificate) | [MsgCreateCertificateResponse](#akash.cert.v1beta3.MsgCreateCertificateResponse) | CreateCertificate defines a method to create new certificate given proper inputs. | | + | `RevokeCertificate` | [MsgRevokeCertificate](#akash.cert.v1beta3.MsgRevokeCertificate) | [MsgRevokeCertificateResponse](#akash.cert.v1beta3.MsgRevokeCertificateResponse) | RevokeCertificate defines a method to revoke the certificate | | + + + + + + + + + ## akash/cert/v1beta3/genesis.proto + + + + + + ### GenesisCertificate + GenesisCertificate defines certificate entry at genesis + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `certificate` | [Certificate](#akash.cert.v1beta3.Certificate) | | | + + + + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by cert module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificates` | [GenesisCertificate](#akash.cert.v1beta3.GenesisCertificate) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/cert/v1beta2/query.proto + + + + + + ### CertificateResponse + CertificateResponse contains a single X509 certificate and its serial number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificate` | [Certificate](#akash.cert.v1beta2.Certificate) | | | + | `serial` | [string](#string) | | | + + + + + + + + + ### QueryCertificatesRequest + QueryDeploymentsRequest is request type for the Query/Deployments RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filter` | [CertificateFilter](#akash.cert.v1beta2.CertificateFilter) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryCertificatesResponse + QueryCertificatesResponse is response type for the Query/Certificates RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificates` | [CertificateResponse](#akash.cert.v1beta2.CertificateResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Certificates` | [QueryCertificatesRequest](#akash.cert.v1beta2.QueryCertificatesRequest) | [QueryCertificatesResponse](#akash.cert.v1beta2.QueryCertificatesResponse) | Certificates queries certificates | GET|/akash/cert/v1beta3/certificates/list| + + + + + + + + + ## akash/cert/v1beta2/cert.proto + + + + + + ### Certificate + Certificate stores state, certificate and it's public key + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `state` | [Certificate.State](#akash.cert.v1beta2.Certificate.State) | | | + | `cert` | [bytes](#bytes) | | | + | `pubkey` | [bytes](#bytes) | | | + + + + + + + + + ### CertificateFilter + CertificateFilter defines filters used to filter certificates + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `serial` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### CertificateID + CertificateID stores owner and sequence number + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `serial` | [string](#string) | | | + + + + + + + + + ### MsgCreateCertificate + MsgCreateCertificate defines an SDK message for creating certificate + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `cert` | [bytes](#bytes) | | | + | `pubkey` | [bytes](#bytes) | | | + + + + + + + + + ### MsgCreateCertificateResponse + MsgCreateCertificateResponse defines the Msg/CreateCertificate response type. + + + + + + + + + ### MsgRevokeCertificate + MsgRevokeCertificate defines an SDK message for revoking certificate + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [CertificateID](#akash.cert.v1beta2.CertificateID) | | | + + + + + + + + + ### MsgRevokeCertificateResponse + MsgRevokeCertificateResponse defines the Msg/RevokeCertificate response type. + + + + + + + + + + + ### Certificate.State + State is an enum which refers to state of deployment + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | valid | 1 | CertificateValid denotes state for deployment active | + | revoked | 2 | CertificateRevoked denotes state for deployment closed | + + + + + + + + + + ### Msg + Msg defines the provider Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateCertificate` | [MsgCreateCertificate](#akash.cert.v1beta2.MsgCreateCertificate) | [MsgCreateCertificateResponse](#akash.cert.v1beta2.MsgCreateCertificateResponse) | CreateCertificate defines a method to create new certificate given proper inputs. | | + | `RevokeCertificate` | [MsgRevokeCertificate](#akash.cert.v1beta2.MsgRevokeCertificate) | [MsgRevokeCertificateResponse](#akash.cert.v1beta2.MsgRevokeCertificateResponse) | RevokeCertificate defines a method to revoke the certificate | | + + + + + + + + + ## akash/cert/v1beta2/genesis.proto + + + + + + ### GenesisCertificate + GenesisCertificate defines certificate entry at genesis + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `certificate` | [Certificate](#akash.cert.v1beta2.Certificate) | | | + + + + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by cert module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `certificates` | [GenesisCertificate](#akash.cert.v1beta2.GenesisCertificate) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/escrow/v1beta3/types.proto + + + + + + ### Account + Account stores state for an escrow account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [AccountID](#akash.escrow.v1beta3.AccountID) | | unique identifier for this escrow account | + | `owner` | [string](#string) | | bech32 encoded account address of the owner of this escrow account | + | `state` | [Account.State](#akash.escrow.v1beta3.Account.State) | | current state of this escrow account | + | `balance` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | unspent coins received from the owner's wallet | + | `transferred` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | total coins spent by this account | + | `settled_at` | [int64](#int64) | | block height at which this account was last settled | + | `depositor` | [string](#string) | | bech32 encoded account address of the depositor. 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. | + | `funds` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | Funds are unspent coins received from the (non-Owner) Depositor's wallet. If there are any funds, they should be spent before spending the Balance. | + + + + + + + + + ### AccountID + AccountID is the account identifier + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + + + + + + + + + ### FractionalPayment + Payment stores state for a payment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `account_id` | [AccountID](#akash.escrow.v1beta3.AccountID) | | | + | `payment_id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [FractionalPayment.State](#akash.escrow.v1beta3.FractionalPayment.State) | | | + | `rate` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `balance` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `withdrawn` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + ### Account.State + State stores state for an escrow account + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | AccountStateInvalid is an invalid state | + | open | 1 | AccountOpen is the state when an account is open | + | closed | 2 | AccountClosed is the state when an account is closed | + | overdrawn | 3 | AccountOverdrawn is the state when an account is overdrawn | + + + + + + ### FractionalPayment.State + Payment State + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | PaymentStateInvalid is the state when the payment is invalid | + | open | 1 | PaymentStateOpen is the state when the payment is open | + | closed | 2 | PaymentStateClosed is the state when the payment is closed | + | overdrawn | 3 | PaymentStateOverdrawn is the state when the payment is overdrawn | + + + + + + + + + + + + + + ## akash/escrow/v1beta3/query.proto + + + + + + ### QueryAccountsRequest + QueryAccountRequest is request type for the Query/Account RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryAccountsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta3.Account) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryPaymentsRequest + QueryPaymentRequest is request type for the Query/Payment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryPaymentsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `payments` | [FractionalPayment](#akash.escrow.v1beta3.FractionalPayment) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Accounts` | [QueryAccountsRequest](#akash.escrow.v1beta3.QueryAccountsRequest) | [QueryAccountsResponse](#akash.escrow.v1beta3.QueryAccountsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Accounts queries all accounts | GET|/akash/escrow/v1beta3/types/accounts/list| + | `Payments` | [QueryPaymentsRequest](#akash.escrow.v1beta3.QueryPaymentsRequest) | [QueryPaymentsResponse](#akash.escrow.v1beta3.QueryPaymentsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Payments queries all payments | GET|/akash/escrow/v1beta3/types/payments/list| + + + + + + + + + ## akash/escrow/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by escrow module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta3.Account) | repeated | | + | `payments` | [FractionalPayment](#akash.escrow.v1beta3.FractionalPayment) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/escrow/v1beta2/types.proto + + + + + + ### Account + Account stores state for an escrow account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [AccountID](#akash.escrow.v1beta2.AccountID) | | unique identifier for this escrow account | + | `owner` | [string](#string) | | bech32 encoded account address of the owner of this escrow account | + | `state` | [Account.State](#akash.escrow.v1beta2.Account.State) | | current state of this escrow account | + | `balance` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | unspent coins received from the owner's wallet | + | `transferred` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | total coins spent by this account | + | `settled_at` | [int64](#int64) | | block height at which this account was last settled | + | `depositor` | [string](#string) | | bech32 encoded account address of the depositor. 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. | + | `funds` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | Funds are unspent coins received from the (non-Owner) Depositor's wallet. If there are any funds, they should be spent before spending the Balance. | + + + + + + + + + ### AccountID + AccountID is the account identifier + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + + + + + + + + + ### FractionalPayment + Payment stores state for a payment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `account_id` | [AccountID](#akash.escrow.v1beta2.AccountID) | | | + | `payment_id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [FractionalPayment.State](#akash.escrow.v1beta2.FractionalPayment.State) | | | + | `rate` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `balance` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `withdrawn` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + ### Account.State + State stores state for an escrow account + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | AccountStateInvalid is an invalid state | + | open | 1 | AccountOpen is the state when an account is open | + | closed | 2 | AccountClosed is the state when an account is closed | + | overdrawn | 3 | AccountOverdrawn is the state when an account is overdrawn | + + + + + + ### FractionalPayment.State + Payment State + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | PaymentStateInvalid is the state when the payment is invalid | + | open | 1 | PaymentStateOpen is the state when the payment is open | + | closed | 2 | PaymentStateClosed is the state when the payment is closed | + | overdrawn | 3 | PaymentStateOverdrawn is the state when the payment is overdrawn | + + + + + + + + + + + + + + ## akash/escrow/v1beta2/query.proto + + + + + + ### QueryAccountsRequest + QueryAccountRequest is request type for the Query/Account RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryAccountsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta2.Account) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryPaymentsRequest + QueryPaymentRequest is request type for the Query/Payment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryPaymentsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `payments` | [FractionalPayment](#akash.escrow.v1beta2.FractionalPayment) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Accounts` | [QueryAccountsRequest](#akash.escrow.v1beta2.QueryAccountsRequest) | [QueryAccountsResponse](#akash.escrow.v1beta2.QueryAccountsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Accounts queries all accounts | GET|/akash/escrow/v1beta2/types/accounts/list| + | `Payments` | [QueryPaymentsRequest](#akash.escrow.v1beta2.QueryPaymentsRequest) | [QueryPaymentsResponse](#akash.escrow.v1beta2.QueryPaymentsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Payments queries all payments | GET|/akash/escrow/v1beta2/types/payments/list| + + + + + + + + + ## akash/escrow/v1beta2/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by escrow module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta2.Account) | repeated | | + | `payments` | [FractionalPayment](#akash.escrow.v1beta2.FractionalPayment) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/escrow/v1beta1/types.proto + + + + + + ### Account + Account stores state for an escrow account + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [AccountID](#akash.escrow.v1beta1.AccountID) | | unique identifier for this escrow account | + | `owner` | [string](#string) | | bech32 encoded account address of the owner of this escrow account | + | `state` | [Account.State](#akash.escrow.v1beta1.Account.State) | | current state of this escrow account | + | `balance` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | unspent coins received from the owner's wallet | + | `transferred` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | total coins spent by this account | + | `settled_at` | [int64](#int64) | | block height at which this account was last settled | + + + + + + + + + ### AccountID + AccountID is the account identifier + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + + + + + + + + + ### Payment + Payment stores state for a payment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `account_id` | [AccountID](#akash.escrow.v1beta1.AccountID) | | | + | `payment_id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [Payment.State](#akash.escrow.v1beta1.Payment.State) | | | + | `rate` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `balance` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `withdrawn` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + + + ### Account.State + State stores state for an escrow account + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | AccountStateInvalid is an invalid state | + | open | 1 | AccountOpen is the state when an account is open | + | closed | 2 | AccountClosed is the state when an account is closed | + | overdrawn | 3 | AccountOverdrawn is the state when an account is overdrawn | + + + + + + ### Payment.State + Payment State + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | PaymentStateInvalid is the state when the payment is invalid | + | open | 1 | PaymentStateOpen is the state when the payment is open | + | closed | 2 | PaymentStateClosed is the state when the payment is closed | + | overdrawn | 3 | PaymentStateOverdrawn is the state when the payment is overdrawn | + + + + + + + + + + + + + + ## akash/escrow/v1beta1/query.proto + + + + + + ### QueryAccountsRequest + QueryAccountRequest is request type for the Query/Account RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryAccountsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta1.Account) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryPaymentsRequest + QueryPaymentRequest is request type for the Query/Payment RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `scope` | [string](#string) | | | + | `xid` | [string](#string) | | | + | `id` | [string](#string) | | | + | `owner` | [string](#string) | | | + | `state` | [string](#string) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryPaymentsResponse + QueryProvidersResponse is response type for the Query/Providers RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `payments` | [Payment](#akash.escrow.v1beta1.Payment) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Accounts` | [QueryAccountsRequest](#akash.escrow.v1beta1.QueryAccountsRequest) | [QueryAccountsResponse](#akash.escrow.v1beta1.QueryAccountsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Accounts queries all accounts | GET|/akash/escrow/v1beta1/types/accounts/list| + | `Payments` | [QueryPaymentsRequest](#akash.escrow.v1beta1.QueryPaymentsRequest) | [QueryPaymentsResponse](#akash.escrow.v1beta1.QueryPaymentsResponse) | buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME Payments queries all payments | GET|/akash/escrow/v1beta1/types/payments/list| + + + + + + + + + ## akash/escrow/v1beta1/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by escrow module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `accounts` | [Account](#akash.escrow.v1beta1.Account) | repeated | | + | `payments` | [Payment](#akash.escrow.v1beta1.Payment) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta4/bid.proto + + + + + + ### Bid + Bid stores BidID, state of bid and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta4.BidID) | | | + | `state` | [Bid.State](#akash.market.v1beta4.Bid.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + | `resources_offer` | [ResourceOffer](#akash.market.v1beta4.ResourceOffer) | repeated | | + + + + + + + + + ### BidFilters + BidFilters defines flags for bid list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### BidID + BidID stores owner and all other seq numbers +A successful bid becomes a Lease(ID). + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseBid + MsgCloseBid defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta4.BidID) | | | + + + + + + + + + ### MsgCloseBidResponse + MsgCloseBidResponse defines the Msg/CloseBid response type. + + + + + + + + + ### MsgCreateBid + MsgCreateBid defines an SDK message for creating Bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [OrderID](#akash.market.v1beta4.OrderID) | | | + | `provider` | [string](#string) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `resources_offer` | [ResourceOffer](#akash.market.v1beta4.ResourceOffer) | repeated | | + + + + + + + + + ### MsgCreateBidResponse + MsgCreateBidResponse defines the Msg/CreateBid response type. + + + + + + + + + ### ResourceOffer + ResourceOffer describes resources that provider is offering +for deployment + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `resources` | [akash.base.v1beta3.Resources](#akash.base.v1beta3.Resources) | | | + | `count` | [uint32](#uint32) | | | + + + + + + + + + + + ### Bid.State + State is an enum which refers to state of bid + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | BidOpen denotes state for bid open | + | active | 2 | BidMatched denotes state for bid open | + | lost | 3 | BidLost denotes state for bid lost | + | closed | 4 | BidClosed denotes state for bid closed | + + + + + + + + + + + + + + ## akash/market/v1beta4/query.proto + + + + + + ### QueryBidRequest + QueryBidRequest is request type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [BidID](#akash.market.v1beta4.BidID) | | | + + + + + + + + + ### QueryBidResponse + QueryBidResponse is response type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid` | [Bid](#akash.market.v1beta4.Bid) | | | + | `escrow_account` | [akash.escrow.v1beta3.Account](#akash.escrow.v1beta3.Account) | | | + + + + + + + + + ### QueryBidsRequest + QueryBidsRequest is request type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [BidFilters](#akash.market.v1beta4.BidFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryBidsResponse + QueryBidsResponse is response type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bids` | [QueryBidResponse](#akash.market.v1beta4.QueryBidResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryLeaseRequest + QueryLeaseRequest is request type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [LeaseID](#akash.market.v1beta4.LeaseID) | | | + + + + + + + + + ### QueryLeaseResponse + QueryLeaseResponse is response type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease` | [Lease](#akash.market.v1beta4.Lease) | | | + | `escrow_payment` | [akash.escrow.v1beta3.FractionalPayment](#akash.escrow.v1beta3.FractionalPayment) | | | + + + + + + + + + ### QueryLeasesRequest + QueryLeasesRequest is request type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [LeaseFilters](#akash.market.v1beta4.LeaseFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryLeasesResponse + QueryLeasesResponse is response type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `leases` | [QueryLeaseResponse](#akash.market.v1beta4.QueryLeaseResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryOrderRequest + QueryOrderRequest is request type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [OrderID](#akash.market.v1beta4.OrderID) | | | + + + + + + + + + ### QueryOrderResponse + QueryOrderResponse is response type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [Order](#akash.market.v1beta4.Order) | | | + + + + + + + + + ### QueryOrdersRequest + QueryOrdersRequest is request type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [OrderFilters](#akash.market.v1beta4.OrderFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryOrdersResponse + QueryOrdersResponse is response type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `orders` | [Order](#akash.market.v1beta4.Order) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Orders` | [QueryOrdersRequest](#akash.market.v1beta4.QueryOrdersRequest) | [QueryOrdersResponse](#akash.market.v1beta4.QueryOrdersResponse) | Orders queries orders with filters | GET|/akash/market/v1beta4/orders/list| + | `Order` | [QueryOrderRequest](#akash.market.v1beta4.QueryOrderRequest) | [QueryOrderResponse](#akash.market.v1beta4.QueryOrderResponse) | Order queries order details | GET|/akash/market/v1beta4/orders/info| + | `Bids` | [QueryBidsRequest](#akash.market.v1beta4.QueryBidsRequest) | [QueryBidsResponse](#akash.market.v1beta4.QueryBidsResponse) | Bids queries bids with filters | GET|/akash/market/v1beta4/bids/list| + | `Bid` | [QueryBidRequest](#akash.market.v1beta4.QueryBidRequest) | [QueryBidResponse](#akash.market.v1beta4.QueryBidResponse) | Bid queries bid details | GET|/akash/market/v1beta4/bids/info| + | `Leases` | [QueryLeasesRequest](#akash.market.v1beta4.QueryLeasesRequest) | [QueryLeasesResponse](#akash.market.v1beta4.QueryLeasesResponse) | Leases queries leases with filters | GET|/akash/market/v1beta4/leases/list| + | `Lease` | [QueryLeaseRequest](#akash.market.v1beta4.QueryLeaseRequest) | [QueryLeaseResponse](#akash.market.v1beta4.QueryLeaseResponse) | Lease queries lease details | GET|/akash/market/v1beta4/leases/info| + + + + + + + + + ## akash/market/v1beta4/service.proto + + + + + + + + + + + + ### Msg + Msg defines the market Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateBid` | [MsgCreateBid](#akash.market.v1beta4.MsgCreateBid) | [MsgCreateBidResponse](#akash.market.v1beta4.MsgCreateBidResponse) | CreateBid defines a method to create a bid given proper inputs. | | + | `CloseBid` | [MsgCloseBid](#akash.market.v1beta4.MsgCloseBid) | [MsgCloseBidResponse](#akash.market.v1beta4.MsgCloseBidResponse) | CloseBid defines a method to close a bid given proper inputs. | | + | `WithdrawLease` | [MsgWithdrawLease](#akash.market.v1beta4.MsgWithdrawLease) | [MsgWithdrawLeaseResponse](#akash.market.v1beta4.MsgWithdrawLeaseResponse) | WithdrawLease withdraws accrued funds from the lease payment | | + | `CreateLease` | [MsgCreateLease](#akash.market.v1beta4.MsgCreateLease) | [MsgCreateLeaseResponse](#akash.market.v1beta4.MsgCreateLeaseResponse) | CreateLease creates a new lease | | + | `CloseLease` | [MsgCloseLease](#akash.market.v1beta4.MsgCloseLease) | [MsgCloseLeaseResponse](#akash.market.v1beta4.MsgCloseLeaseResponse) | CloseLease defines a method to close an order given proper inputs. | | + + + + + + + + + ## akash/market/v1beta4/lease.proto + + + + + + ### Lease + Lease stores LeaseID, state of lease and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta4.LeaseID) | | | + | `state` | [Lease.State](#akash.market.v1beta4.Lease.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + | `closed_on` | [int64](#int64) | | | + + + + + + + + + ### LeaseFilters + LeaseFilters defines flags for lease list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### LeaseID + LeaseID stores bid details of lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseLease + MsgCloseLease defines an SDK message for closing order + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta4.LeaseID) | | | + + + + + + + + + ### MsgCloseLeaseResponse + MsgCloseLeaseResponse defines the Msg/CloseLease response type. + + + + + + + + + ### MsgCreateLease + MsgCreateLease is sent to create a lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta4.BidID) | | | + + + + + + + + + ### MsgCreateLeaseResponse + MsgCreateLeaseResponse is the response from creating a lease + + + + + + + + + ### MsgWithdrawLease + MsgWithdrawLease defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [LeaseID](#akash.market.v1beta4.LeaseID) | | | + + + + + + + + + ### MsgWithdrawLeaseResponse + MsgWithdrawLeaseResponse defines the Msg/WithdrawLease response type. + + + + + + + + + + + ### Lease.State + State is an enum which refers to state of lease + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | LeaseActive denotes state for lease active | + | insufficient_funds | 2 | LeaseInsufficientFunds denotes state for lease insufficient_funds | + | closed | 3 | LeaseClosed denotes state for lease closed | + + + + + + + + + + + + + + ## akash/market/v1beta4/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.market.v1beta4.Params) | | | + | `orders` | [Order](#akash.market.v1beta4.Order) | repeated | | + | `leases` | [Lease](#akash.market.v1beta4.Lease) | repeated | | + | `bids` | [Bid](#akash.market.v1beta4.Bid) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta4/order.proto + + + + + + ### Order + Order stores orderID, state of order and other details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order_id` | [OrderID](#akash.market.v1beta4.OrderID) | | | + | `state` | [Order.State](#akash.market.v1beta4.Order.State) | | | + | `spec` | [akash.deployment.v1beta3.GroupSpec](#akash.deployment.v1beta3.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### OrderFilters + OrderFilters defines flags for order list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### OrderID + OrderID stores owner and all other seq numbers + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + + + + + + + + + + + ### Order.State + State is an enum which refers to state of order + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | OrderOpen denotes state for order open | + | active | 2 | OrderMatched denotes state for order matched | + | closed | 3 | OrderClosed denotes state for order lost | + + + + + + + + + + + + + + ## akash/market/v1beta4/params.proto + + + + + + ### Params + Params is the params for the x/market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `order_max_bids` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta3/bid.proto + + + + + + ### Bid + Bid stores BidID, state of bid and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta3.BidID) | | | + | `state` | [Bid.State](#akash.market.v1beta3.Bid.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### BidFilters + BidFilters defines flags for bid list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### BidID + BidID stores owner and all other seq numbers +A successful bid becomes a Lease(ID). + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseBid + MsgCloseBid defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta3.BidID) | | | + + + + + + + + + ### MsgCloseBidResponse + MsgCloseBidResponse defines the Msg/CloseBid response type. + + + + + + + + + ### MsgCreateBid + MsgCreateBid defines an SDK message for creating Bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [OrderID](#akash.market.v1beta3.OrderID) | | | + | `provider` | [string](#string) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + ### MsgCreateBidResponse + MsgCreateBidResponse defines the Msg/CreateBid response type. + + + + + + + + + + + ### Bid.State + State is an enum which refers to state of bid + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | BidOpen denotes state for bid open | + | active | 2 | BidMatched denotes state for bid open | + | lost | 3 | BidLost denotes state for bid lost | + | closed | 4 | BidClosed denotes state for bid closed | + + + + + + + + + + + + + + ## akash/market/v1beta3/query.proto + + + + + + ### QueryBidRequest + QueryBidRequest is request type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [BidID](#akash.market.v1beta3.BidID) | | | + + + + + + + + + ### QueryBidResponse + QueryBidResponse is response type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid` | [Bid](#akash.market.v1beta3.Bid) | | | + | `escrow_account` | [akash.escrow.v1beta3.Account](#akash.escrow.v1beta3.Account) | | | + + + + + + + + + ### QueryBidsRequest + QueryBidsRequest is request type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [BidFilters](#akash.market.v1beta3.BidFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryBidsResponse + QueryBidsResponse is response type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bids` | [QueryBidResponse](#akash.market.v1beta3.QueryBidResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryLeaseRequest + QueryLeaseRequest is request type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [LeaseID](#akash.market.v1beta3.LeaseID) | | | + + + + + + + + + ### QueryLeaseResponse + QueryLeaseResponse is response type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease` | [Lease](#akash.market.v1beta3.Lease) | | | + | `escrow_payment` | [akash.escrow.v1beta3.FractionalPayment](#akash.escrow.v1beta3.FractionalPayment) | | | + + + + + + + + + ### QueryLeasesRequest + QueryLeasesRequest is request type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [LeaseFilters](#akash.market.v1beta3.LeaseFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryLeasesResponse + QueryLeasesResponse is response type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `leases` | [QueryLeaseResponse](#akash.market.v1beta3.QueryLeaseResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryOrderRequest + QueryOrderRequest is request type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [OrderID](#akash.market.v1beta3.OrderID) | | | + + + + + + + + + ### QueryOrderResponse + QueryOrderResponse is response type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [Order](#akash.market.v1beta3.Order) | | | + + + + + + + + + ### QueryOrdersRequest + QueryOrdersRequest is request type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [OrderFilters](#akash.market.v1beta3.OrderFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryOrdersResponse + QueryOrdersResponse is response type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `orders` | [Order](#akash.market.v1beta3.Order) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Orders` | [QueryOrdersRequest](#akash.market.v1beta3.QueryOrdersRequest) | [QueryOrdersResponse](#akash.market.v1beta3.QueryOrdersResponse) | Orders queries orders with filters | GET|/akash/market/v1beta3/orders/list| + | `Order` | [QueryOrderRequest](#akash.market.v1beta3.QueryOrderRequest) | [QueryOrderResponse](#akash.market.v1beta3.QueryOrderResponse) | Order queries order details | GET|/akash/market/v1beta3/orders/info| + | `Bids` | [QueryBidsRequest](#akash.market.v1beta3.QueryBidsRequest) | [QueryBidsResponse](#akash.market.v1beta3.QueryBidsResponse) | Bids queries bids with filters | GET|/akash/market/v1beta3/bids/list| + | `Bid` | [QueryBidRequest](#akash.market.v1beta3.QueryBidRequest) | [QueryBidResponse](#akash.market.v1beta3.QueryBidResponse) | Bid queries bid details | GET|/akash/market/v1beta3/bids/info| + | `Leases` | [QueryLeasesRequest](#akash.market.v1beta3.QueryLeasesRequest) | [QueryLeasesResponse](#akash.market.v1beta3.QueryLeasesResponse) | Leases queries leases with filters | GET|/akash/market/v1beta3/leases/list| + | `Lease` | [QueryLeaseRequest](#akash.market.v1beta3.QueryLeaseRequest) | [QueryLeaseResponse](#akash.market.v1beta3.QueryLeaseResponse) | Lease queries lease details | GET|/akash/market/v1beta3/leases/info| + + + + + + + + + ## akash/market/v1beta3/service.proto + + + + + + + + + + + + ### Msg + Msg defines the market Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateBid` | [MsgCreateBid](#akash.market.v1beta3.MsgCreateBid) | [MsgCreateBidResponse](#akash.market.v1beta3.MsgCreateBidResponse) | CreateBid defines a method to create a bid given proper inputs. | | + | `CloseBid` | [MsgCloseBid](#akash.market.v1beta3.MsgCloseBid) | [MsgCloseBidResponse](#akash.market.v1beta3.MsgCloseBidResponse) | CloseBid defines a method to close a bid given proper inputs. | | + | `WithdrawLease` | [MsgWithdrawLease](#akash.market.v1beta3.MsgWithdrawLease) | [MsgWithdrawLeaseResponse](#akash.market.v1beta3.MsgWithdrawLeaseResponse) | WithdrawLease withdraws accrued funds from the lease payment | | + | `CreateLease` | [MsgCreateLease](#akash.market.v1beta3.MsgCreateLease) | [MsgCreateLeaseResponse](#akash.market.v1beta3.MsgCreateLeaseResponse) | CreateLease creates a new lease | | + | `CloseLease` | [MsgCloseLease](#akash.market.v1beta3.MsgCloseLease) | [MsgCloseLeaseResponse](#akash.market.v1beta3.MsgCloseLeaseResponse) | CloseLease defines a method to close an order given proper inputs. | | + + + + + + + + + ## akash/market/v1beta3/lease.proto + + + + + + ### Lease + Lease stores LeaseID, state of lease and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta3.LeaseID) | | | + | `state` | [Lease.State](#akash.market.v1beta3.Lease.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + | `closed_on` | [int64](#int64) | | | + + + + + + + + + ### LeaseFilters + LeaseFilters defines flags for lease list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### LeaseID + LeaseID stores bid details of lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseLease + MsgCloseLease defines an SDK message for closing order + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta3.LeaseID) | | | + + + + + + + + + ### MsgCloseLeaseResponse + MsgCloseLeaseResponse defines the Msg/CloseLease response type. + + + + + + + + + ### MsgCreateLease + MsgCreateLease is sent to create a lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta3.BidID) | | | + + + + + + + + + ### MsgCreateLeaseResponse + MsgCreateLeaseResponse is the response from creating a lease + + + + + + + + + ### MsgWithdrawLease + MsgWithdrawLease defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [LeaseID](#akash.market.v1beta3.LeaseID) | | | + + + + + + + + + ### MsgWithdrawLeaseResponse + MsgWithdrawLeaseResponse defines the Msg/WithdrawLease response type. + + + + + + + + + + + ### Lease.State + State is an enum which refers to state of lease + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | LeaseActive denotes state for lease active | + | insufficient_funds | 2 | LeaseInsufficientFunds denotes state for lease insufficient_funds | + | closed | 3 | LeaseClosed denotes state for lease closed | + + + + + + + + + + + + + + ## akash/market/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.market.v1beta3.Params) | | | + | `orders` | [Order](#akash.market.v1beta3.Order) | repeated | | + | `leases` | [Lease](#akash.market.v1beta3.Lease) | repeated | | + | `bids` | [Bid](#akash.market.v1beta3.Bid) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta3/order.proto + + + + + + ### Order + Order stores orderID, state of order and other details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order_id` | [OrderID](#akash.market.v1beta3.OrderID) | | | + | `state` | [Order.State](#akash.market.v1beta3.Order.State) | | | + | `spec` | [akash.deployment.v1beta3.GroupSpec](#akash.deployment.v1beta3.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### OrderFilters + OrderFilters defines flags for order list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### OrderID + OrderID stores owner and all other seq numbers + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + + + + + + + + + + + ### Order.State + State is an enum which refers to state of order + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | OrderOpen denotes state for order open | + | active | 2 | OrderMatched denotes state for order matched | + | closed | 3 | OrderClosed denotes state for order lost | + + + + + + + + + + + + + + ## akash/market/v1beta3/params.proto + + + + + + ### Params + Params is the params for the x/market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `order_max_bids` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta2/bid.proto + + + + + + ### Bid + Bid stores BidID, state of bid and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta2.BidID) | | | + | `state` | [Bid.State](#akash.market.v1beta2.Bid.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### BidFilters + BidFilters defines flags for bid list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### BidID + BidID stores owner and all other seq numbers +A successful bid becomes a Lease(ID). + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseBid + MsgCloseBid defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta2.BidID) | | | + + + + + + + + + ### MsgCloseBidResponse + MsgCloseBidResponse defines the Msg/CloseBid response type. + + + + + + + + + ### MsgCreateBid + MsgCreateBid defines an SDK message for creating Bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [OrderID](#akash.market.v1beta2.OrderID) | | | + | `provider` | [string](#string) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + + + + + + + + + ### MsgCreateBidResponse + MsgCreateBidResponse defines the Msg/CreateBid response type. + + + + + + + + + + + ### Bid.State + State is an enum which refers to state of bid + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | BidOpen denotes state for bid open | + | active | 2 | BidMatched denotes state for bid open | + | lost | 3 | BidLost denotes state for bid lost | + | closed | 4 | BidClosed denotes state for bid closed | + + + + + + + + + + + + + + ## akash/market/v1beta2/query.proto + + + + + + ### QueryBidRequest + QueryBidRequest is request type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [BidID](#akash.market.v1beta2.BidID) | | | + + + + + + + + + ### QueryBidResponse + QueryBidResponse is response type for the Query/Bid RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid` | [Bid](#akash.market.v1beta2.Bid) | | | + | `escrow_account` | [akash.escrow.v1beta2.Account](#akash.escrow.v1beta2.Account) | | | + + + + + + + + + ### QueryBidsRequest + QueryBidsRequest is request type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [BidFilters](#akash.market.v1beta2.BidFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryBidsResponse + QueryBidsResponse is response type for the Query/Bids RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bids` | [QueryBidResponse](#akash.market.v1beta2.QueryBidResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryLeaseRequest + QueryLeaseRequest is request type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [LeaseID](#akash.market.v1beta2.LeaseID) | | | + + + + + + + + + ### QueryLeaseResponse + QueryLeaseResponse is response type for the Query/Lease RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease` | [Lease](#akash.market.v1beta2.Lease) | | | + | `escrow_payment` | [akash.escrow.v1beta2.FractionalPayment](#akash.escrow.v1beta2.FractionalPayment) | | | + + + + + + + + + ### QueryLeasesRequest + QueryLeasesRequest is request type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [LeaseFilters](#akash.market.v1beta2.LeaseFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryLeasesResponse + QueryLeasesResponse is response type for the Query/Leases RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `leases` | [QueryLeaseResponse](#akash.market.v1beta2.QueryLeaseResponse) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + ### QueryOrderRequest + QueryOrderRequest is request type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [OrderID](#akash.market.v1beta2.OrderID) | | | + + + + + + + + + ### QueryOrderResponse + QueryOrderResponse is response type for the Query/Order RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order` | [Order](#akash.market.v1beta2.Order) | | | + + + + + + + + + ### QueryOrdersRequest + QueryOrdersRequest is request type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `filters` | [OrderFilters](#akash.market.v1beta2.OrderFilters) | | | + | `pagination` | [cosmos.base.query.v1beta1.PageRequest](#cosmos.base.query.v1beta1.PageRequest) | | | + + + + + + + + + ### QueryOrdersResponse + QueryOrdersResponse is response type for the Query/Orders RPC method + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `orders` | [Order](#akash.market.v1beta2.Order) | repeated | | + | `pagination` | [cosmos.base.query.v1beta1.PageResponse](#cosmos.base.query.v1beta1.PageResponse) | | | + + + + + + + + + + + + + + + ### Query + Query defines the gRPC querier service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `Orders` | [QueryOrdersRequest](#akash.market.v1beta2.QueryOrdersRequest) | [QueryOrdersResponse](#akash.market.v1beta2.QueryOrdersResponse) | Orders queries orders with filters | GET|/akash/market/v1beta2/orders/list| + | `Order` | [QueryOrderRequest](#akash.market.v1beta2.QueryOrderRequest) | [QueryOrderResponse](#akash.market.v1beta2.QueryOrderResponse) | Order queries order details | GET|/akash/market/v1beta2/orders/info| + | `Bids` | [QueryBidsRequest](#akash.market.v1beta2.QueryBidsRequest) | [QueryBidsResponse](#akash.market.v1beta2.QueryBidsResponse) | Bids queries bids with filters | GET|/akash/market/v1beta2/bids/list| + | `Bid` | [QueryBidRequest](#akash.market.v1beta2.QueryBidRequest) | [QueryBidResponse](#akash.market.v1beta2.QueryBidResponse) | Bid queries bid details | GET|/akash/market/v1beta2/bids/info| + | `Leases` | [QueryLeasesRequest](#akash.market.v1beta2.QueryLeasesRequest) | [QueryLeasesResponse](#akash.market.v1beta2.QueryLeasesResponse) | Leases queries leases with filters | GET|/akash/market/v1beta2/leases/list| + | `Lease` | [QueryLeaseRequest](#akash.market.v1beta2.QueryLeaseRequest) | [QueryLeaseResponse](#akash.market.v1beta2.QueryLeaseResponse) | Lease queries lease details | GET|/akash/market/v1beta2/leases/info| + + + + + + + + + ## akash/market/v1beta2/service.proto + + + + + + + + + + + + ### Msg + Msg defines the market Msg service + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `CreateBid` | [MsgCreateBid](#akash.market.v1beta2.MsgCreateBid) | [MsgCreateBidResponse](#akash.market.v1beta2.MsgCreateBidResponse) | CreateBid defines a method to create a bid given proper inputs. | | + | `CloseBid` | [MsgCloseBid](#akash.market.v1beta2.MsgCloseBid) | [MsgCloseBidResponse](#akash.market.v1beta2.MsgCloseBidResponse) | CloseBid defines a method to close a bid given proper inputs. | | + | `WithdrawLease` | [MsgWithdrawLease](#akash.market.v1beta2.MsgWithdrawLease) | [MsgWithdrawLeaseResponse](#akash.market.v1beta2.MsgWithdrawLeaseResponse) | WithdrawLease withdraws accrued funds from the lease payment | | + | `CreateLease` | [MsgCreateLease](#akash.market.v1beta2.MsgCreateLease) | [MsgCreateLeaseResponse](#akash.market.v1beta2.MsgCreateLeaseResponse) | CreateLease creates a new lease | | + | `CloseLease` | [MsgCloseLease](#akash.market.v1beta2.MsgCloseLease) | [MsgCloseLeaseResponse](#akash.market.v1beta2.MsgCloseLeaseResponse) | CloseLease defines a method to close an order given proper inputs. | | + + + + + + + + + ## akash/market/v1beta2/lease.proto + + + + + + ### Lease + Lease stores LeaseID, state of lease and price + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta2.LeaseID) | | | + | `state` | [Lease.State](#akash.market.v1beta2.Lease.State) | | | + | `price` | [cosmos.base.v1beta1.DecCoin](#cosmos.base.v1beta1.DecCoin) | | | + | `created_at` | [int64](#int64) | | | + | `closed_on` | [int64](#int64) | | | + + + + + + + + + ### LeaseFilters + LeaseFilters defines flags for lease list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### LeaseID + LeaseID stores bid details of lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `provider` | [string](#string) | | | + + + + + + + + + ### MsgCloseLease + MsgCloseLease defines an SDK message for closing order + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `lease_id` | [LeaseID](#akash.market.v1beta2.LeaseID) | | | + + + + + + + + + ### MsgCloseLeaseResponse + MsgCloseLeaseResponse defines the Msg/CloseLease response type. + + + + + + + + + ### MsgCreateLease + MsgCreateLease is sent to create a lease + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [BidID](#akash.market.v1beta2.BidID) | | | + + + + + + + + + ### MsgCreateLeaseResponse + MsgCreateLeaseResponse is the response from creating a lease + + + + + + + + + ### MsgWithdrawLease + MsgWithdrawLease defines an SDK message for closing bid + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_id` | [LeaseID](#akash.market.v1beta2.LeaseID) | | | + + + + + + + + + ### MsgWithdrawLeaseResponse + MsgWithdrawLeaseResponse defines the Msg/WithdrawLease response type. + + + + + + + + + + + ### Lease.State + State is an enum which refers to state of lease + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | active | 1 | LeaseActive denotes state for lease active | + | insufficient_funds | 2 | LeaseInsufficientFunds denotes state for lease insufficient_funds | + | closed | 3 | LeaseClosed denotes state for lease closed | + + + + + + + + + + + + + + ## akash/market/v1beta2/genesis.proto + + + + + + ### GenesisState + GenesisState defines the basic genesis state used by market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `orders` | [Order](#akash.market.v1beta2.Order) | repeated | | + | `leases` | [Lease](#akash.market.v1beta2.Lease) | repeated | | + | `params` | [Params](#akash.market.v1beta2.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/market/v1beta2/order.proto + + + + + + ### Order + Order stores orderID, state of order and other details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `order_id` | [OrderID](#akash.market.v1beta2.OrderID) | | | + | `state` | [Order.State](#akash.market.v1beta2.Order.State) | | | + | `spec` | [akash.deployment.v1beta2.GroupSpec](#akash.deployment.v1beta2.GroupSpec) | | | + | `created_at` | [int64](#int64) | | | + + + + + + + + + ### OrderFilters + OrderFilters defines flags for order list filter + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + | `state` | [string](#string) | | | + + + + + + + + + ### OrderID + OrderID stores owner and all other seq numbers + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `owner` | [string](#string) | | | + | `dseq` | [uint64](#uint64) | | | + | `gseq` | [uint32](#uint32) | | | + | `oseq` | [uint32](#uint32) | | | + + + + + + + + + + + ### Order.State + State is an enum which refers to state of order + + | Name | Number | Description | + | ---- | ------ | ----------- | + | invalid | 0 | Prefix should start with 0 in enum. So declaring dummy state | + | open | 1 | OrderOpen denotes state for order open | + | active | 2 | OrderMatched denotes state for order matched | + | closed | 3 | OrderClosed denotes state for order lost | + + + + + + + + + + + + + + ## akash/market/v1beta2/params.proto + + + + + + ### Params + Params is the params for the x/market module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `bid_min_deposit` | [cosmos.base.v1beta1.Coin](#cosmos.base.v1beta1.Coin) | | | + | `order_max_bids` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/inflation/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.inflation.v1beta3.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/inflation/v1beta3/params.proto + + + + + + ### Params + Params defines the parameters for the x/deployment package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `inflation_decay_factor` | [string](#string) | | InflationDecayFactor is the number of years it takes inflation to halve. | + | `initial_inflation` | [string](#string) | | InitialInflation is the rate at which inflation starts at genesis. It is a decimal value in the range [0.0, 100.0]. | + | `variance` | [string](#string) | | Variance defines the fraction by which inflation can vary from ideal inflation in a block. It is a decimal value in the range [0.0, 1.0]. | + + + + + + + + + + + + + + + + + + + ## akash/inflation/v1beta2/genesis.proto + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `params` | [Params](#akash.inflation.v1beta2.Params) | | | + + + + + + + + + + + + + + + + + + + ## akash/inflation/v1beta2/params.proto + + + + + + ### Params + Params defines the parameters for the x/deployment package + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `inflation_decay_factor` | [string](#string) | | InflationDecayFactor is the number of years it takes inflation to halve. | + | `initial_inflation` | [string](#string) | | InitialInflation is the rate at which inflation starts at genesis. It is a decimal value in the range [0.0, 100.0]. | + | `variance` | [string](#string) | | Variance defines the fraction by which inflation can vary from ideal inflation in a block. It is a decimal value in the range [0.0, 1.0]. | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/memory.proto + + + + + + ### Memory + Memory stores resource quantity and memory attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourceValue](#akash.base.v1beta3.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/cpu.proto + + + + + + ### CPU + CPU stores resource units and cpu config attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `units` | [ResourceValue](#akash.base.v1beta3.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/resources.proto + + + + + + ### Resources + Resources describes all available resources types for deployment/node etc +if field is nil resource is not present in the given data-structure + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [uint32](#uint32) | | | + | `cpu` | [CPU](#akash.base.v1beta3.CPU) | | | + | `memory` | [Memory](#akash.base.v1beta3.Memory) | | | + | `storage` | [Storage](#akash.base.v1beta3.Storage) | repeated | | + | `gpu` | [GPU](#akash.base.v1beta3.GPU) | | | + | `endpoints` | [Endpoint](#akash.base.v1beta3.Endpoint) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/attribute.proto + + + + + + ### Attribute + Attribute represents key value pair + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `key` | [string](#string) | | | + | `value` | [string](#string) | | | + + + + + + + + + ### PlacementRequirements + PlacementRequirements + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `signed_by` | [SignedBy](#akash.base.v1beta3.SignedBy) | | SignedBy list of keys that tenants expect to have signatures from | + | `attributes` | [Attribute](#akash.base.v1beta3.Attribute) | repeated | Attribute list of attributes tenant expects from the provider | + + + + + + + + + ### SignedBy + 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 + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `all_of` | [string](#string) | repeated | all_of all keys in this list must have signed attributes | + | `any_of` | [string](#string) | repeated | any_of at least of of the keys from the list must have signed attributes | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/endpoint.proto + + + + + + ### Endpoint + Endpoint describes a publicly accessible IP service + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `kind` | [Endpoint.Kind](#akash.base.v1beta3.Endpoint.Kind) | | | + | `sequence_number` | [uint32](#uint32) | | | + + + + + + + + + + + ### Endpoint.Kind + This describes how the endpoint is implemented when the lease is deployed + + | Name | Number | Description | + | ---- | ------ | ----------- | + | SHARED_HTTP | 0 | Describes an endpoint that becomes a Kubernetes Ingress | + | RANDOM_PORT | 1 | Describes an endpoint that becomes a Kubernetes NodePort | + | LEASED_IP | 2 | Describes an endpoint that becomes a leased IP | + + + + + + + + + + + + + + ## akash/base/v1beta3/gpu.proto + + + + + + ### GPU + GPU stores resource units and cpu config attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `units` | [ResourceValue](#akash.base.v1beta3.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/storage.proto + + + + + + ### Storage + Storage stores resource quantity and storage attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `quantity` | [ResourceValue](#akash.base.v1beta3.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta3/resourcevalue.proto + + + + + + ### ResourceValue + Unit stores cpu, memory and storage metrics + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `val` | [bytes](#bytes) | | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta2/resourceunits.proto + + + + + + ### ResourceUnits + ResourceUnits describes all available resources types for deployment/node etc +if field is nil resource is not present in the given data-structure + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `cpu` | [CPU](#akash.base.v1beta2.CPU) | | | + | `memory` | [Memory](#akash.base.v1beta2.Memory) | | | + | `storage` | [Storage](#akash.base.v1beta2.Storage) | repeated | | + | `endpoints` | [Endpoint](#akash.base.v1beta2.Endpoint) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta2/attribute.proto + + + + + + ### Attribute + Attribute represents key value pair + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `key` | [string](#string) | | | + | `value` | [string](#string) | | | + + + + + + + + + ### PlacementRequirements + PlacementRequirements + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `signed_by` | [SignedBy](#akash.base.v1beta2.SignedBy) | | SignedBy list of keys that tenants expect to have signatures from | + | `attributes` | [Attribute](#akash.base.v1beta2.Attribute) | repeated | Attribute list of attributes tenant expects from the provider | + + + + + + + + + ### SignedBy + 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 + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `all_of` | [string](#string) | repeated | all_of all keys in this list must have signed attributes | + | `any_of` | [string](#string) | repeated | any_of at least of of the keys from the list must have signed attributes | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta2/endpoint.proto + + + + + + ### Endpoint + Endpoint describes a publicly accessible IP service + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `kind` | [Endpoint.Kind](#akash.base.v1beta2.Endpoint.Kind) | | | + | `sequence_number` | [uint32](#uint32) | | | + + + + + + + + + + + ### Endpoint.Kind + This describes how the endpoint is implemented when the lease is deployed + + | Name | Number | Description | + | ---- | ------ | ----------- | + | SHARED_HTTP | 0 | Describes an endpoint that becomes a Kubernetes Ingress | + | RANDOM_PORT | 1 | Describes an endpoint that becomes a Kubernetes NodePort | + | LEASED_IP | 2 | Describes an endpoint that becomes a leased IP | + + + + + + + + + + + + + + ## akash/base/v1beta2/resource.proto + + + + + + ### CPU + CPU stores resource units and cpu config attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `units` | [ResourceValue](#akash.base.v1beta2.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + ### Memory + Memory stores resource quantity and memory attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourceValue](#akash.base.v1beta2.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + ### Storage + Storage stores resource quantity and storage attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `quantity` | [ResourceValue](#akash.base.v1beta2.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta2.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta2/resourcevalue.proto + + + + + + ### ResourceValue + Unit stores cpu, memory and storage metrics + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `val` | [bytes](#bytes) | | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta1/attribute.proto + + + + + + ### Attribute + Attribute represents key value pair + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `key` | [string](#string) | | | + | `value` | [string](#string) | | | + + + + + + + + + ### PlacementRequirements + PlacementRequirements + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `signed_by` | [SignedBy](#akash.base.v1beta1.SignedBy) | | SignedBy list of keys that tenants expect to have signatures from | + | `attributes` | [Attribute](#akash.base.v1beta1.Attribute) | repeated | Attribute list of attributes tenant expects from the provider | + + + + + + + + + ### SignedBy + 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 + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `all_of` | [string](#string) | repeated | all_of all keys in this list must have signed attributes | + | `any_of` | [string](#string) | repeated | any_of at least of of the keys from the list must have signed attributes | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta1/endpoint.proto + + + + + + ### Endpoint + Endpoint describes a publicly accessible IP service + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `kind` | [Endpoint.Kind](#akash.base.v1beta1.Endpoint.Kind) | | | + + + + + + + + + + + ### Endpoint.Kind + This describes how the endpoint is implemented when the lease is deployed + + | Name | Number | Description | + | ---- | ------ | ----------- | + | SHARED_HTTP | 0 | Describes an endpoint that becomes a Kubernetes Ingress | + | RANDOM_PORT | 1 | Describes an endpoint that becomes a Kubernetes NodePort | + + + + + + + + + + + + + + ## akash/base/v1beta1/resource.proto + + + + + + ### CPU + CPU stores resource units and cpu config attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `units` | [ResourceValue](#akash.base.v1beta1.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + ### Memory + Memory stores resource quantity and memory attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourceValue](#akash.base.v1beta1.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + ### ResourceUnits + ResourceUnits describes all available resources types for deployment/node etc +if field is nil resource is not present in the given data-structure + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `cpu` | [CPU](#akash.base.v1beta1.CPU) | | | + | `memory` | [Memory](#akash.base.v1beta1.Memory) | | | + | `storage` | [Storage](#akash.base.v1beta1.Storage) | | | + | `endpoints` | [Endpoint](#akash.base.v1beta1.Endpoint) | repeated | | + + + + + + + + + ### Storage + Storage stores resource quantity and storage attributes + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourceValue](#akash.base.v1beta1.ResourceValue) | | | + | `attributes` | [Attribute](#akash.base.v1beta1.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/base/v1beta1/resourcevalue.proto + + + + + + ### ResourceValue + Unit stores cpu, memory and storage metrics + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `val` | [bytes](#bytes) | | | + + + + + + + + + + + + + + + + + + + ## akash/gov/v1beta3/genesis.proto + + + + + + ### GenesisState + GenesisState stores slice of genesis deployment instance + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `deposit_params` | [DepositParams](#akash.gov.v1beta3.DepositParams) | | | + + + + + + + + + + + + + + + + + + + ## akash/gov/v1beta3/params.proto + + + + + + ### DepositParams + DepositParams defines the parameters for the x/gov module + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `min_initial_deposit_rate` | [bytes](#bytes) | | min_initial_deposit_rate minimum % of TotalDeposit author of the proposal must put in order for proposal tx to be committed | + + + + + + + + + + + + + + + + ## Scalar Value Types + + | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | + | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | + | double | | double | double | float | float64 | double | float | Float | + | float | | float | float | float | float32 | float | float | Float | + | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | + | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | + | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | + | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | + | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | + | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | + | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/docs/proto/provider/proto-docs.md b/docs/proto/provider/proto-docs.md new file mode 100644 index 00000000..420052a9 --- /dev/null +++ b/docs/proto/provider/proto-docs.md @@ -0,0 +1,789 @@ + + # Protobuf Documentation + + + ## Table of Contents + + - [akash/manifest/v2beta1/group.proto](#akash/manifest/v2beta1/group.proto) + - [Group](#akash.manifest.v2beta1.Group) + + - [akash/manifest/v2beta1/httpoptions.proto](#akash/manifest/v2beta1/httpoptions.proto) + - [ServiceExposeHTTPOptions](#akash.manifest.v2beta1.ServiceExposeHTTPOptions) + + - [akash/manifest/v2beta1/serviceexpose.proto](#akash/manifest/v2beta1/serviceexpose.proto) + - [ServiceExpose](#akash.manifest.v2beta1.ServiceExpose) + + - [akash/manifest/v2beta1/service.proto](#akash/manifest/v2beta1/service.proto) + - [Service](#akash.manifest.v2beta1.Service) + - [ServiceParams](#akash.manifest.v2beta1.ServiceParams) + - [StorageParams](#akash.manifest.v2beta1.StorageParams) + + - [akash/manifest/v2beta2/group.proto](#akash/manifest/v2beta2/group.proto) + - [Group](#akash.manifest.v2beta2.Group) + + - [akash/manifest/v2beta2/httpoptions.proto](#akash/manifest/v2beta2/httpoptions.proto) + - [ServiceExposeHTTPOptions](#akash.manifest.v2beta2.ServiceExposeHTTPOptions) + + - [akash/manifest/v2beta2/serviceexpose.proto](#akash/manifest/v2beta2/serviceexpose.proto) + - [ServiceExpose](#akash.manifest.v2beta2.ServiceExpose) + + - [akash/manifest/v2beta2/service.proto](#akash/manifest/v2beta2/service.proto) + - [Service](#akash.manifest.v2beta2.Service) + - [ServiceParams](#akash.manifest.v2beta2.ServiceParams) + - [StorageParams](#akash.manifest.v2beta2.StorageParams) + + - [akash/inventory/v1/memory.proto](#akash/inventory/v1/memory.proto) + - [Memory](#akash.inventory.v1.Memory) + - [MemoryInfo](#akash.inventory.v1.MemoryInfo) + + - [akash/inventory/v1/cpu.proto](#akash/inventory/v1/cpu.proto) + - [CPU](#akash.inventory.v1.CPU) + - [CPUInfo](#akash.inventory.v1.CPUInfo) + + - [akash/inventory/v1/cluster.proto](#akash/inventory/v1/cluster.proto) + - [Cluster](#akash.inventory.v1.Cluster) + + - [akash/inventory/v1/node.proto](#akash/inventory/v1/node.proto) + - [Node](#akash.inventory.v1.Node) + + - [akash/inventory/v1/resourcepair.proto](#akash/inventory/v1/resourcepair.proto) + - [ResourcePair](#akash.inventory.v1.ResourcePair) + + - [akash/inventory/v1/gpu.proto](#akash/inventory/v1/gpu.proto) + - [GPU](#akash.inventory.v1.GPU) + - [GPUInfo](#akash.inventory.v1.GPUInfo) + + - [akash/inventory/v1/storage.proto](#akash/inventory/v1/storage.proto) + - [Storage](#akash.inventory.v1.Storage) + - [StorageInfo](#akash.inventory.v1.StorageInfo) + + - [akash/inventory/v1/service.proto](#akash/inventory/v1/service.proto) + - [VoidNoParam](#akash.inventory.v1.VoidNoParam) + + - [ClusterRPC](#akash.inventory.v1.ClusterRPC) + - [NodeRPC](#akash.inventory.v1.NodeRPC) + + - [Scalar Value Types](#scalar-value-types) + + + + + + + ## akash/manifest/v2beta1/group.proto + + + + + + ### Group + Group store name and list of services + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `services` | [Service](#akash.manifest.v2beta1.Service) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta1/httpoptions.proto + + + + + + ### ServiceExposeHTTPOptions + ServiceExposeHTTPOptions + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `max_body_size` | [uint32](#uint32) | | | + | `read_timeout` | [uint32](#uint32) | | | + | `send_timeout` | [uint32](#uint32) | | | + | `next_tries` | [uint32](#uint32) | | | + | `next_timeout` | [uint32](#uint32) | | | + | `next_cases` | [string](#string) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta1/serviceexpose.proto + + + + + + ### ServiceExpose + ServiceExpose stores exposed ports and hosts details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `port` | [uint32](#uint32) | | port on the container | + | `external_port` | [uint32](#uint32) | | port on the service definition | + | `proto` | [string](#string) | | | + | `service` | [string](#string) | | | + | `global` | [bool](#bool) | | | + | `hosts` | [string](#string) | repeated | | + | `http_options` | [ServiceExposeHTTPOptions](#akash.manifest.v2beta1.ServiceExposeHTTPOptions) | | | + | `ip` | [string](#string) | | The name of the IP address associated with this, if any | + | `endpoint_sequence_number` | [uint32](#uint32) | | The sequence number of the associated endpoint in the on-chain data | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta1/service.proto + + + + + + ### Service + Service stores name, image, args, env, unit, count and expose list of service + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `image` | [string](#string) | | | + | `command` | [string](#string) | repeated | | + | `args` | [string](#string) | repeated | | + | `env` | [string](#string) | repeated | | + | `resources` | [akash.base.v1beta2.ResourceUnits](#akash.base.v1beta2.ResourceUnits) | | | + | `count` | [uint32](#uint32) | | | + | `expose` | [ServiceExpose](#akash.manifest.v2beta1.ServiceExpose) | repeated | | + | `params` | [ServiceParams](#akash.manifest.v2beta1.ServiceParams) | | | + + + + + + + + + ### ServiceParams + ServiceParams + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `storage` | [StorageParams](#akash.manifest.v2beta1.StorageParams) | repeated | | + + + + + + + + + ### StorageParams + StorageParams + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `mount` | [string](#string) | | | + | `read_only` | [bool](#bool) | | | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta2/group.proto + + + + + + ### Group + Group store name and list of services + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `services` | [Service](#akash.manifest.v2beta2.Service) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta2/httpoptions.proto + + + + + + ### ServiceExposeHTTPOptions + ServiceExposeHTTPOptions + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `max_body_size` | [uint32](#uint32) | | | + | `read_timeout` | [uint32](#uint32) | | | + | `send_timeout` | [uint32](#uint32) | | | + | `next_tries` | [uint32](#uint32) | | | + | `next_timeout` | [uint32](#uint32) | | | + | `next_cases` | [string](#string) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta2/serviceexpose.proto + + + + + + ### ServiceExpose + ServiceExpose stores exposed ports and hosts details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `port` | [uint32](#uint32) | | port on the container | + | `external_port` | [uint32](#uint32) | | port on the service definition | + | `proto` | [string](#string) | | | + | `service` | [string](#string) | | | + | `global` | [bool](#bool) | | | + | `hosts` | [string](#string) | repeated | | + | `http_options` | [ServiceExposeHTTPOptions](#akash.manifest.v2beta2.ServiceExposeHTTPOptions) | | | + | `ip` | [string](#string) | | The name of the IP address associated with this, if any | + | `endpoint_sequence_number` | [uint32](#uint32) | | The sequence number of the associated endpoint in the on-chain data | + + + + + + + + + + + + + + + + + + + ## akash/manifest/v2beta2/service.proto + + + + + + ### Service + Service stores name, image, args, env, unit, count and expose list of service + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `image` | [string](#string) | | | + | `command` | [string](#string) | repeated | | + | `args` | [string](#string) | repeated | | + | `env` | [string](#string) | repeated | | + | `resources` | [akash.base.v1beta3.Resources](#akash.base.v1beta3.Resources) | | | + | `count` | [uint32](#uint32) | | | + | `expose` | [ServiceExpose](#akash.manifest.v2beta2.ServiceExpose) | repeated | | + | `params` | [ServiceParams](#akash.manifest.v2beta2.ServiceParams) | | | + + + + + + + + + ### ServiceParams + ServiceParams + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `storage` | [StorageParams](#akash.manifest.v2beta2.StorageParams) | repeated | | + + + + + + + + + ### StorageParams + StorageParams + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `name` | [string](#string) | | | + | `mount` | [string](#string) | | | + | `read_only` | [bool](#bool) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/memory.proto + + + + + + ### Memory + Memory reports Memory inventory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourcePair](#akash.inventory.v1.ResourcePair) | | | + | `info` | [MemoryInfo](#akash.inventory.v1.MemoryInfo) | repeated | | + + + + + + + + + ### MemoryInfo + MemoryInfo reports Memory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `vendor` | [string](#string) | | | + | `type` | [string](#string) | | | + | `total_size` | [string](#string) | | | + | `speed` | [string](#string) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/cpu.proto + + + + + + ### CPU + CPU reports CPU inventory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourcePair](#akash.inventory.v1.ResourcePair) | | | + | `info` | [CPUInfo](#akash.inventory.v1.CPUInfo) | repeated | | + + + + + + + + + ### CPUInfo + CPUInfo reports CPU details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `id` | [string](#string) | | | + | `vendor` | [string](#string) | | | + | `model` | [string](#string) | | | + | `vcores` | [uint32](#uint32) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/cluster.proto + + + + + + ### Cluster + Cluster reports inventory across entire cluster + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `nodes` | [Node](#akash.inventory.v1.Node) | repeated | | + | `storage` | [Storage](#akash.inventory.v1.Storage) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/node.proto + + + + + + ### Node + Node reports node inventory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `cpu` | [CPU](#akash.inventory.v1.CPU) | | | + | `memory` | [Memory](#akash.inventory.v1.Memory) | | | + | `gpu` | [GPU](#akash.inventory.v1.GPU) | | | + | `storage` | [Storage](#akash.inventory.v1.Storage) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/resourcepair.proto + + + + + + ### ResourcePair + ResourcePair to extents resource.Quantity to provide total and available units of the resource + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `allocatable` | [k8s.io.apimachinery.pkg.api.resource.Quantity](#k8s.io.apimachinery.pkg.api.resource.Quantity) | | | + | `allocated` | [k8s.io.apimachinery.pkg.api.resource.Quantity](#k8s.io.apimachinery.pkg.api.resource.Quantity) | | | + | `attributes` | [akash.base.v1beta3.Attribute](#akash.base.v1beta3.Attribute) | repeated | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/gpu.proto + + + + + + ### GPU + GPUInfo reports GPU inventory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourcePair](#akash.inventory.v1.ResourcePair) | | | + | `info` | [GPUInfo](#akash.inventory.v1.GPUInfo) | repeated | | + + + + + + + + + ### GPUInfo + GPUInfo reports GPU details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `vendor` | [string](#string) | | | + | `name` | [string](#string) | | | + | `modelid` | [string](#string) | | | + | `interface` | [string](#string) | | | + | `memory_size` | [string](#string) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/storage.proto + + + + + + ### Storage + Storage reports Storage inventory details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `quantity` | [ResourcePair](#akash.inventory.v1.ResourcePair) | | | + | `info` | [StorageInfo](#akash.inventory.v1.StorageInfo) | | | + + + + + + + + + ### StorageInfo + StorageInfo reports Storage details + + + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + | `class` | [string](#string) | | | + | `iops` | [string](#string) | | | + + + + + + + + + + + + + + + + + + + ## akash/inventory/v1/service.proto + + + + + + ### VoidNoParam + voidNoParam dummy param for RPC services + + + + + + + + + + + + + + + ### ClusterRPC + ClusterRPC defines the RPC server of cluster + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `QueryCluster` | [VoidNoParam](#akash.inventory.v1.VoidNoParam) | [Cluster](#akash.inventory.v1.Cluster) stream | QueryNode defines a method to query and stream hardware state of the cluster buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | | + + + + + ### NodeRPC + NodeRPC defines the RPC server of node + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + | `QueryNode` | [VoidNoParam](#akash.inventory.v1.VoidNoParam) | [Node](#akash.inventory.v1.Node) stream | QueryNode defines a method to query and stream hardware state of the node buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE buf:lint:ignore RPC_RESPONSE_STANDARD_NAME | | + + + + + + ## Scalar Value Types + + | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | + | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | + | double | | double | double | float | float64 | double | float | Float | + | float | | float | float | float | float32 | float | float | Float | + | int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | + | uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | + | sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | + | fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | + | sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | + | sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | + | bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | + | string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | + | bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/docs/protodoc-markdown.tmpl b/docs/protodoc-markdown.tmpl new file mode 100644 index 00000000..dc1b5f50 --- /dev/null +++ b/docs/protodoc-markdown.tmpl @@ -0,0 +1,105 @@ + + # Protobuf Documentation + + + ## Table of Contents + {{range .Files}} + {{$file_name := .Name}}- [{{.Name}}](#{{.Name}}) + {{- if .Messages }} + {{range .Messages}} - [{{.LongName}}](#{{.FullName}}) + {{end}} + {{- end -}} + {{- if .Enums }} + {{range .Enums}} - [{{.LongName}}](#{{.FullName}}) + {{end}} + {{- end -}} + {{- if .Extensions }} + {{range .Extensions}} - [File-level Extensions](#{{$file_name}}-extensions) + {{end}} + {{- end -}} + {{- if .Services }} + {{range .Services}} - [{{.Name}}](#{{.FullName}}) + {{end}} + {{- end -}} + {{end}} + - [Scalar Value Types](#scalar-value-types) + + {{range .Files}} + {{$file_name := .Name}} + + + + ## {{.Name}} + {{.Description}} + + {{range .Messages}} + + + ### {{.LongName}} + {{.Description}} + + {{if .HasFields}} + | Field | Type | Label | Description | + | ----- | ---- | ----- | ----------- | + {{range .Fields -}} + | `{{.Name}}` | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | + {{end}} + {{end}} + + {{if .HasExtensions}} + | Extension | Type | Base | Number | Description | + | --------- | ---- | ---- | ------ | ----------- | + {{range .Extensions -}} + | `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | + {{end}} + {{end}} + + {{end}} + + {{range .Enums}} + + + ### {{.LongName}} + {{.Description}} + + | Name | Number | Description | + | ---- | ------ | ----------- | + {{range .Values -}} + | {{.Name}} | {{.Number}} | {{nobr .Description}} | + {{end}} + + {{end}} + + {{if .HasExtensions}} + + + ### File-level Extensions + | Extension | Type | Base | Number | Description | + | --------- | ---- | ---- | ------ | ----------- | + {{range .Extensions -}} + | `{{.Name}}` | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | + {{end}} + {{end}} + + {{range .Services}} + + + ### {{.Name}} + {{.Description}} + + | Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint | + | ----------- | ------------ | ------------- | ------------| ------- | -------- | + {{range .Methods -}} + | `{{.Name}}` | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | {{with (index .Options "google.api.http")}}{{range .Rules}}{{.Method}}|{{.Pattern}}{{end}}{{end}}| + {{end}} + {{end}} + + {{end}} + + ## Scalar Value Types + + | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | + | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | + {{range .Scalars -}} + | {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} | + {{end}} diff --git a/go.mod b/go.mod index ee847f0f..dc16d4c5 100644 --- a/go.mod +++ b/go.mod @@ -10,6 +10,7 @@ require ( github.com/golang/protobuf v1.5.2 github.com/grpc-ecosystem/grpc-gateway v1.16.0 github.com/pkg/errors v0.9.1 + github.com/pseudomuto/protoc-gen-doc v1.5.1 github.com/regen-network/cosmos-proto v0.3.1 github.com/stretchr/testify v1.8.1 github.com/tendermint/tendermint v0.34.27 @@ -50,6 +51,9 @@ require ( github.com/ChainSafe/go-schnorrkel v0.0.0-20200405005733-88cbf1b4c40d // indirect github.com/DataDog/zstd v1.5.0 // indirect github.com/HdrHistogram/hdrhistogram-go v1.1.2 // indirect + github.com/Masterminds/semver v1.5.0 // indirect + github.com/Masterminds/sprig v2.15.0+incompatible // indirect + github.com/aokoli/goutils v1.0.1 // indirect github.com/armon/go-metrics v0.4.1 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/bgentry/speakeasy v0.1.1-0.20220910012023-760eaf8b6816 // indirect @@ -87,6 +91,7 @@ require ( github.com/golang/snappy v0.0.4 // indirect github.com/google/btree v1.1.2 // indirect github.com/google/gofuzz v1.2.0 // indirect + github.com/google/uuid v1.3.0 // indirect github.com/gorilla/mux v1.8.0 // indirect github.com/gorilla/websocket v1.5.0 // indirect github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 // indirect @@ -98,6 +103,8 @@ require ( github.com/hashicorp/golang-lru v0.5.5-0.20210104140557-80c98217689d // indirect github.com/hashicorp/hcl v1.0.1-0.20191016231534-914dc3f8dd7c // indirect github.com/hdevalence/ed25519consensus v0.0.0-20220222234857-c00d1f31bab3 // indirect + github.com/huandu/xstrings v1.0.0 // indirect + github.com/imdario/mergo v0.3.13 // indirect github.com/inconshreveable/mousetrap v1.0.1 // indirect github.com/jmhodges/levigo v1.0.1-0.20191019112844-b572e7f4cdac // indirect github.com/json-iterator/go v1.1.12 // indirect @@ -122,6 +129,7 @@ require ( github.com/prometheus/client_model v0.3.0 // indirect github.com/prometheus/common v0.37.0 // indirect github.com/prometheus/procfs v0.8.0 // indirect + github.com/pseudomuto/protokit v0.2.0 // indirect github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect github.com/rogpeppe/go-internal v1.9.0 // indirect github.com/sasha-s/go-deadlock v0.3.1 // indirect diff --git a/go.sum b/go.sum index 1b1da38d..2cd0f722 100644 --- a/go.sum +++ b/go.sum @@ -62,6 +62,10 @@ github.com/HdrHistogram/hdrhistogram-go v1.1.2 h1:5IcZpTvzydCQeHzK4Ef/D5rrSqwxob github.com/HdrHistogram/hdrhistogram-go v1.1.2/go.mod h1:yDgFjdqOqDEKOvasDdhWNXYg9BVp4O+o5f6V/ehm6Oo= github.com/Joker/hpp v1.0.0/go.mod h1:8x5n+M1Hp5hC0g8okX3sR3vFQwynaX/UgSOM9MeBKzY= github.com/Joker/jade v1.0.1-0.20190614124447-d475f43051e7/go.mod h1:6E6s8o2AE4KhCrqr6GRJjdC/gNfTdxkIXvuGZZda2VM= +github.com/Masterminds/semver v1.5.0 h1:H65muMkzWKEuNDnfl9d70GUjFniHKHRbFPGBuZ3QEww= +github.com/Masterminds/semver v1.5.0/go.mod h1:MB6lktGJrhw8PrUyiEoblNEGEQ+RzHPF078ddwwvV3Y= +github.com/Masterminds/sprig v2.15.0+incompatible h1:0gSxPGWS9PAr7U2NsQ2YQg6juRDINkUyuvbb4b2Xm8w= +github.com/Masterminds/sprig v2.15.0+incompatible/go.mod h1:y6hNFY5UBTIWBxnzTeuNhlNS5hqE0NB0E6fgfo2Br3o= github.com/OneOfOne/xxhash v1.2.2 h1:KMrpdQIwFcEqXDklaen+P1axHaj9BSKzvpUUfnHldSE= github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= github.com/Shopify/goreferrer v0.0.0-20181106222321-ec9c9a553398/go.mod h1:a1uqRtAwp2Xwc6WNPJEufxJ7fx3npB4UV/JOLmbu5I0= @@ -82,6 +86,8 @@ github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRF github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho= github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY= +github.com/aokoli/goutils v1.0.1 h1:7fpzNGoJ3VA8qcrm++XEE1QUe0mIwNeLa02Nwq7RDkg= +github.com/aokoli/goutils v1.0.1/go.mod h1:SijmP0QR8LtwsmDs8Yii5Z/S4trXFGFC2oO5g9DP+DQ= github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8= github.com/armon/go-metrics v0.4.1 h1:hR91U9KYmb6bLBYLQjyM+3j+rcd/UhE+G78SFnF8gJA= github.com/armon/go-metrics v0.4.1/go.mod h1:E6amYzXo6aW1tqzoZGT755KkbgrJsSdpwZ+3JqfkOG4= @@ -351,6 +357,8 @@ github.com/google/pprof v0.0.0-20201203190320-1bf35d6f28c2/go.mod h1:kpwsk12EmLe github.com/google/pprof v0.0.0-20201218002935-b9804c9f04c2/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE= github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI= github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg= github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk= github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8/go.mod h1:dvDLG8qkwmyD9a/MJJN3XJcT3xFxOKAvTZGvuZmac9g= @@ -394,10 +402,14 @@ github.com/hashicorp/hcl v1.0.1-0.20191016231534-914dc3f8dd7c/go.mod h1:E5yfLk+7 github.com/hdevalence/ed25519consensus v0.0.0-20220222234857-c00d1f31bab3 h1:aSVUgRRRtOrZOC1fYmY9gV0e9z/Iu+xNVSASWjsuyGU= github.com/hdevalence/ed25519consensus v0.0.0-20220222234857-c00d1f31bab3/go.mod h1:5PC6ZNPde8bBqU/ewGZig35+UIZtw9Ytxez8/q5ZyFE= github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= +github.com/huandu/xstrings v1.0.0 h1:pO2K/gKgKaat5LdpAhxhluX2GPQMaI3W5FUz/I/UnWk= +github.com/huandu/xstrings v1.0.0/go.mod h1:4qWG/gcEcfX4z/mBDHJ++3ReCw9ibxbsNJbcucJdbSo= github.com/hydrogen18/memlistener v0.0.0-20141126152155-54553eb933fb/go.mod h1:qEIFzExnS6016fRpRfxrExeVn2gbClQA99gQhnIcdhE= github.com/hydrogen18/memlistener v0.0.0-20200120041712-dcc25e7acd91/go.mod h1:qEIFzExnS6016fRpRfxrExeVn2gbClQA99gQhnIcdhE= github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= +github.com/imdario/mergo v0.3.13 h1:lFzP57bqS/wsqKssCGmtLAb8A0wKjLGrve2q3PPVcBk= +github.com/imdario/mergo v0.3.13/go.mod h1:4lJ1jqUDcsbIECGy0RUJAXNIhg+6ocWgb1ALK2O4oXg= github.com/imkira/go-interpol v1.1.0/go.mod h1:z0h2/2T3XF8kyEPpRgJ3kmNv+C43p+I/CoI+jC3w2iA= github.com/improbable-eng/grpc-web v0.14.1 h1:NrN4PY71A6tAz2sKDvC5JCauENWp0ykG8Oq1H3cpFvw= github.com/improbable-eng/grpc-web v0.14.1/go.mod h1:zEjGHa8DAlkoOXmswrNvhUGEYQA9UI7DhrGeHR1DMGU= @@ -591,6 +603,10 @@ github.com/prometheus/procfs v0.6.0/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1 github.com/prometheus/procfs v0.7.3/go.mod h1:cz+aTbrPOrUb4q7XlbU9ygM+/jj0fzG6c1xBZuNvfVA= github.com/prometheus/procfs v0.8.0 h1:ODq8ZFEaYeCaZOJlZZdJA2AbQR98dSHSM1KW/You5mo= github.com/prometheus/procfs v0.8.0/go.mod h1:z7EfXMXOkbkqb9IINtpCn86r/to3BnA0uaxHdg830/4= +github.com/pseudomuto/protoc-gen-doc v1.5.1 h1:Ah259kcrio7Ix1Rhb6u8FCaOkzf9qRBqXnvAufg061w= +github.com/pseudomuto/protoc-gen-doc v1.5.1/go.mod h1:XpMKYg6zkcpgfpCfQ8GcWBDRtRxOmMR5w7pz4Xo+dYM= +github.com/pseudomuto/protokit v0.2.0 h1:hlnBDcy3YEDXH7kc9gV+NLaN0cDzhDvD1s7Y6FZ8RpM= +github.com/pseudomuto/protokit v0.2.0/go.mod h1:2PdH30hxVHsup8KpBTOXTBeMVhJZVio3Q8ViKSAXT0Q= github.com/rakyll/statik v0.1.7 h1:OF3QCZUuyPxuGEP7B4ypUa7sB/iHtqOTDYZXGM8KOdQ= github.com/rakyll/statik v0.1.7/go.mod h1:AlZONWzMtEnMs7W4e/1LURLiI49pIMmp6V9Unghqrcc= github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 h1:N/ElC8H3+5XpJzTSTfLsJV/mx9Q9g7kxmchpfZyxgzM= @@ -1111,6 +1127,7 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20191120175047-4206685974f2/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gotest.tools/v3 v3.4.0 h1:ZazjZUfuVeZGLAmlKKuyv3IKP5orXcwtOwDQH6YVr6o= diff --git a/make/codegen.mk b/make/codegen.mk index 8a821aa7..2dbb8941 100644 --- a/make/codegen.mk +++ b/make/codegen.mk @@ -1,6 +1,6 @@ .PHONY: proto-gen ifeq ($(PROTO_LEGACY), true) -proto-gen: modvendor $(PROTOC) $(PROTOC_GEN_GOCOSMOS) $(PROTOC_GEN_GRPC_GATEWAY) +proto-gen: modvendor $(PROTOC) $(PROTOC_GEN_GOCOSMOS) $(PROTOC_GEN_GRPC_GATEWAY) $(PROTOC_GEN_DOC) ./script/protocgen-legacy.sh else proto-gen: modvendor gogoproto $(BUF) $(PROTOC_GEN_GRPC_GATEWAY) $(PROTOC_GEN_GO) diff --git a/make/setup-cache.mk b/make/setup-cache.mk index aac5e3d2..9ca0068e 100644 --- a/make/setup-cache.mk +++ b/make/setup-cache.mk @@ -34,7 +34,7 @@ $(PROTOC_VERSION_FILE): $(AKASH_DEVCACHE) (cd /tmp; \ curl -sOL "https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/${PROTOC_ZIP}"; \ unzip -oq ${PROTOC_ZIP} -d $(AKASH_DEVCACHE) bin/protoc; \ - unzip -oq ${PROTOC_ZIP} -d $(AKASH_DEVCACHE) 'include/*'; \ + unzip -oq ${PROTOC_ZIP} -d $(AKASH_DEVCACHE) 'include/google/protobuf/descriptor.proto'; \ rm -f ${PROTOC_ZIP}) rm -rf "$(dir $@)" mkdir -p "$(dir $@)" @@ -45,14 +45,14 @@ $(PROTOC): $(PROTOC_VERSION_FILE) # TODO https://github.com/akash-network/support/issues/77 -$(PROTOC_GEN_GOCOSMOS_VERSION_FILE): $(AKASH_DEVCACHE) modvendor +$(PROTOC_GEN_GOCOSMOS_VERSION_FILE): $(AKASH_DEVCACHE) @echo "installing protoc-gen-gocosmos $(PROTOC_GEN_GOCOSMOS_VERSION) ..." rm -f $(PROTOC_GEN_GOCOSMOS) GOBIN=$(AKASH_DEVCACHE_BIN)/legacy $(GO) install $(ROOT_DIR)/vendor/github.com/regen-network/cosmos-proto/protoc-gen-gocosmos rm -rf "$(dir $@)" mkdir -p "$(dir $@)" touch $@ -$(PROTOC_GEN_GOCOSMOS): $(PROTOC_GEN_GOCOSMOS_VERSION_FILE) +$(PROTOC_GEN_GOCOSMOS): $(PROTOC_GEN_GOCOSMOS_VERSION_FILE) modvendor $(GOGOPROTO_VERSION_FILE): $(AKASH_DEVCACHE) @echo "installing gogoproto binaries $(GOGOPROTO_VERSION) ..." @@ -81,6 +81,15 @@ $(PROTOC_GEN_GO_VERSION_FILE): $(AKASH_DEVCACHE) touch $@ $(PROTOC_GEN_GO): $(PROTOC_GEN_GO_VERSION_FILE) +$(PROTOC_GEN_DOC_VERSION_FILE): $(AKASH_DEVCACHE) + @echo "installing protoc-gen-doc $(PROTOC_GEN_DOC_VERSION) ..." + rm -f $(PROTOC_GEN_DOC) + GOBIN=$(AKASH_DEVCACHE_BIN) $(GO) install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@$(PROTOC_GEN_DOC_VERSION) + rm -rf "$(dir $@)" + mkdir -p "$(dir $@)" + touch $@ +$(PROTOC_GEN_DOC): $(PROTOC_GEN_DOC_VERSION_FILE) + $(PROTOC_GEN_GRPC_GATEWAY_VERSION_FILE): $(AKASH_DEVCACHE) @echo "Installing protoc-gen-grpc-gateway $(PROTOC_GEN_GRPC_GATEWAY_VERSION) ..." rm -f $(PROTOC_GEN_GRPC_GATEWAY) diff --git a/script/protocgen-legacy.sh b/script/protocgen-legacy.sh index d26e846a..f34cfac9 100755 --- a/script/protocgen-legacy.sh +++ b/script/protocgen-legacy.sh @@ -25,12 +25,22 @@ for dir in $proto_dirs; do # command to generate gRPC gateway (*.pb.gw.go in respective modules) files .cache/bin/protoc \ -I "proto/node" \ + -I ".cache/include" \ -I "vendor/github.com/cosmos/cosmos-sdk/proto" \ -I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \ --grpc-gateway_out=logtostderr=true:. \ $(find "${dir}" -maxdepth 1 -name '*.proto') done +# shellcheck disable=SC2046 +.cache/bin/protoc \ + -I "proto/node" \ + -I "vendor/github.com/cosmos/cosmos-sdk/proto" \ + -I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \ + --doc_out=./docs/proto/node \ + --doc_opt=./docs/protodoc-markdown.tmpl,proto-docs.md \ + $(find "./proto/node" -maxdepth 4 -name '*.proto') + proto_dirs=$(find ./proto/provider -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq) #shellcheck disable=SC2046 for dir in $proto_dirs; do @@ -44,5 +54,16 @@ for dir in $proto_dirs; do $(find "${dir}" -maxdepth 1 -name '*.proto') done +# shellcheck disable=SC2046 +.cache/bin/protoc \ + -I "proto/provider" \ + -I "proto/node" \ + -I "vendor/github.com/cosmos/cosmos-sdk/proto" \ + -I "vendor/github.com/cosmos/cosmos-sdk/third_party/proto" \ + -I "vendor" \ + --doc_out=./docs/proto/provider \ + --doc_opt=./docs/protodoc-markdown.tmpl,proto-docs.md \ + $(find "./proto/provider" -maxdepth 4 -name '*.proto') + # move proto files to the right places cp -rv github.com/akash-network/akash-api/* ./ diff --git a/tools.go b/tools.go index 5280dd91..62b9f5de 100644 --- a/tools.go +++ b/tools.go @@ -10,6 +10,8 @@ import ( _ "github.com/btcsuite/btcd/chaincfg/chainhash" + _ "github.com/pseudomuto/protoc-gen-doc" + // TODO https://github.com/akash-network/support/issues/77 _ "github.com/regen-network/cosmos-proto/protoc-gen-gocosmos" )