125 lines
4.2 KiB
Protocol Buffer
125 lines
4.2 KiB
Protocol Buffer
syntax = "proto3";
|
|
package cosmos.nft.v1beta1;
|
|
|
|
import "cosmos/base/query/v1beta1/pagination.proto";
|
|
import "google/api/annotations.proto";
|
|
import "cosmos/nft/v1beta1/nft.proto";
|
|
|
|
option go_package = "github.com/cosmos/cosmos-sdk/x/nft";
|
|
|
|
// Query defines the gRPC querier service.
|
|
service Query {
|
|
// Balance queries the number of NFTs of a given class owned by the owner, same as balanceOf in ERC721
|
|
rpc Balance(QueryBalanceRequest) returns (QueryBalanceResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/balance/{class_id}/{owner}";
|
|
}
|
|
|
|
// Owner queries the owner of the NFT based on its class and id, same as ownerOf in ERC721
|
|
rpc Owner(QueryOwnerRequest) returns (QueryOwnerResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/owner/{class_id}/{id}";
|
|
}
|
|
|
|
// Supply queries the number of NFTs from the given class, same as totalSupply of ERC721.
|
|
rpc Supply(QuerySupplyRequest) returns (QuerySupplyResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/supply/{class_id}";
|
|
}
|
|
|
|
// NFTsOfClass queries all NFTs of a given class or optional owner, similar to tokenByIndex in ERC721Enumerable
|
|
rpc NFTsOfClass(QueryNFTsOfClassRequest) returns (QueryNFTsOfClassResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/nfts/{class_id}";
|
|
}
|
|
|
|
// NFT queries an NFT based on its class and id.
|
|
rpc NFT(QueryNFTRequest) returns (QueryNFTResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/nfts/{class_id}/{id}";
|
|
}
|
|
|
|
// Class queries an NFT class based on its id
|
|
rpc Class(QueryClassRequest) returns (QueryClassResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/classes/{class_id}";
|
|
}
|
|
|
|
// Classes queries all NFT classes
|
|
rpc Classes(QueryClassesRequest) returns (QueryClassesResponse) {
|
|
option (google.api.http).get = "/cosmos/nft/v1beta1/classes";
|
|
}
|
|
}
|
|
|
|
// QueryBalanceRequest is the request type for the Query/Balance RPC method
|
|
message QueryBalanceRequest {
|
|
string class_id = 1;
|
|
string owner = 2;
|
|
}
|
|
|
|
// QueryBalanceResponse is the response type for the Query/Balance RPC method
|
|
message QueryBalanceResponse {
|
|
uint64 amount = 1;
|
|
}
|
|
|
|
// QueryOwnerRequest is the request type for the Query/Owner RPC method
|
|
message QueryOwnerRequest {
|
|
string class_id = 1;
|
|
string id = 2;
|
|
}
|
|
|
|
// QueryOwnerResponse is the response type for the Query/Owner RPC method
|
|
message QueryOwnerResponse {
|
|
string owner = 1;
|
|
}
|
|
|
|
// QuerySupplyRequest is the request type for the Query/Supply RPC method
|
|
message QuerySupplyRequest {
|
|
string class_id = 1;
|
|
}
|
|
|
|
// QuerySupplyResponse is the response type for the Query/Supply RPC method
|
|
message QuerySupplyResponse {
|
|
uint64 amount = 1;
|
|
}
|
|
|
|
// QueryNFTsOfClassRequest is the request type for the Query/NFTsOfClass RPC method
|
|
message QueryNFTsOfClassRequest {
|
|
string class_id = 1;
|
|
string owner = 2;
|
|
cosmos.base.query.v1beta1.PageRequest pagination = 3;
|
|
}
|
|
|
|
// QueryNFTsOfClassResponse is the response type for the Query/NFTsOfClass and Query/NFTsOfClassByOwner RPC methods
|
|
message QueryNFTsOfClassResponse {
|
|
repeated cosmos.nft.v1beta1.NFT nfts = 1;
|
|
cosmos.base.query.v1beta1.PageResponse pagination = 2;
|
|
}
|
|
|
|
// QueryNFTRequest is the request type for the Query/NFT RPC method
|
|
message QueryNFTRequest {
|
|
string class_id = 1;
|
|
string id = 2;
|
|
}
|
|
|
|
// QueryNFTResponse is the response type for the Query/NFT RPC method
|
|
message QueryNFTResponse {
|
|
cosmos.nft.v1beta1.NFT nft = 1;
|
|
}
|
|
|
|
// QueryClassRequest is the request type for the Query/Class RPC method
|
|
message QueryClassRequest {
|
|
string class_id = 1;
|
|
}
|
|
|
|
// QueryClassResponse is the response type for the Query/Class RPC method
|
|
message QueryClassResponse {
|
|
cosmos.nft.v1beta1.Class class = 1;
|
|
}
|
|
|
|
// QueryClassesRequest is the request type for the Query/Classes RPC method
|
|
message QueryClassesRequest {
|
|
// pagination defines an optional pagination for the request.
|
|
cosmos.base.query.v1beta1.PageRequest pagination = 1;
|
|
}
|
|
|
|
// QueryClassesResponse is the response type for the Query/Classes RPC method
|
|
message QueryClassesResponse {
|
|
repeated cosmos.nft.v1beta1.Class classes = 1;
|
|
cosmos.base.query.v1beta1.PageResponse pagination = 2;
|
|
}
|