feat(nft): nft module

.github/workflows/interchaintest-e2e.yml

@@ -2,12 +2,20 @@ name: ictest E2E
 
 on:
   pull_request:
+    branches:
+      - main
+      - master
+    branches-ignore:
+      - "mvp/**"
+
   push:
     tags:
       - "**"
     branches:
-      - "main"
-      - "master"
+      - main
+      - master
+    branches-ignore:
+      - "mvp/**"
 
 permissions:
   contents: read

app/keepers/keepers.go

@@ -26,6 +26,8 @@ import (
 	"github.com/bitsongofficial/go-bitsong/x/fantoken"
 	fantokenkeeper "github.com/bitsongofficial/go-bitsong/x/fantoken/keeper"
 	fantokentypes "github.com/bitsongofficial/go-bitsong/x/fantoken/types"
+	nftkeeper "github.com/bitsongofficial/go-bitsong/x/nft/keeper"
+	nfttypes "github.com/bitsongofficial/go-bitsong/x/nft/types"
 	"github.com/bitsongofficial/go-bitsong/x/smart-account/authenticator"
 	smartaccountkeeper "github.com/bitsongofficial/go-bitsong/x/smart-account/keeper"
 	smartaccounttypes "github.com/bitsongofficial/go-bitsong/x/smart-account/types"
@@ -149,6 +151,7 @@ type AppKeepers struct {
 	ICQKeeper            *icqkeeper.Keeper
 	EvidenceKeeper       evidencekeeper.Keeper
 	FanTokenKeeper       fantokenkeeper.Keeper
+	NftKeeper            nftkeeper.Keeper
 	WasmKeeper           wasmkeeper.Keeper
 	CadenceKeeper        cadencekeeper.Keeper
 	IBCFeeKeeper         ibcfeekeeper.Keeper
@@ -406,6 +409,13 @@ func NewAppKeepers(
 		BlockedAddrs(),
 	)
 
+	appKeepers.NftKeeper = nftkeeper.NewKeeper(
+		appCodec,
+		runtime.NewKVStoreService(appKeepers.keys[nfttypes.StoreKey]),
+		appKeepers.AccountKeeper,
+		bApp.Logger(),
+	)
+
 	// Stargate Queries
 	acceptedStargateQueries := wasmkeeper.AcceptedQueries{
 		// ibc

app/keepers/keys.go

@@ -2,6 +2,7 @@ package keepers
 
 import (
 	storetypes "cosmossdk.io/store/types"
+	nfttypes "github.com/bitsongofficial/go-bitsong/x/nft/types"
 
 	"cosmossdk.io/x/feegrant"
 	wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types"
@@ -57,6 +58,7 @@ func (appKeepers *AppKeepers) GenerateKeys() {
 		wasmtypes.StoreKey,
 		icqtypes.StoreKey,
 		fantokentypes.StoreKey,
+		nfttypes.StoreKey,
 		cadencetypes.StoreKey,
 		smartaccounttypes.StoreKey,
 		protocolpooltypes.StoreKey,

proto/bitsong/nft/v1beta1/nft.proto

@@ -0,0 +1,38 @@
+syntax = "proto3";
+package bitsong.nft.v1beta1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/bitsongofficial/go-bitsong/x/nft/types";
+
+message Collection {
+  option (gogoproto.goproto_getters) = false;
+
+  string symbol = 1;
+  string name = 2;
+  string description = 3;
+  string uri = 4;
+
+  string creator = 5;
+  string minter = 6;
+  uint64 num_tokens = 7;
+  // bool is_mutable
+  // update_autority (who can update name, description and uri if is_mutable = true)
+}
+
+message Nft {
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+  string token_id = 2;
+
+  string name = 3;
+  string description = 4;
+  string uri = 5;
+
+  string owner = 6;
+  // seller_fee_bps
+  // payment_address
+  // bool is_mutable
+  // update_autority (who can update name, description and uri if is_mutable = true)
+}

proto/bitsong/nft/v1beta1/query.proto

@@ -0,0 +1,136 @@
+syntax = "proto3";
+package bitsong.nft.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "cosmos/query/v1/query.proto";
+import "cosmos/base/query/v1beta1/pagination.proto";
+import "bitsong/nft/v1beta1/nft.proto";
+
+option go_package = "github.com/bitsongofficial/go-bitsong/x/nft/types";
+
+service Query {
+  rpc Collection(QueryCollectionRequest) returns (QueryCollectionResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/collection/{collection}";
+  }
+
+  rpc OwnerOf(QueryOwnerOfRequest) returns (QueryOwnerOfResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/owner/{collection}/{token_id}";
+  }
+
+  rpc NumTokens(QueryNumTokensRequest) returns (QueryNumTokensResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/num_tokens/{collection}";
+  }
+
+  rpc NftInfo(QueryNftInfoRequest) returns (QueryNftInfoResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/nft_info/{collection}/{token_id}";
+  }
+
+  rpc Nfts(QueryNftsRequest) returns (QueryNftsResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/nfts/{collection}";
+  }
+
+  rpc AllNftsByOwner(QueryAllNftsByOwnerRequest) returns (QueryAllNftsByOwnerResponse) {
+    option (cosmos.query.v1.module_query_safe) = true;
+    option (google.api.http).get = "/bitsong/nft/v1beta1/nfts_by_owner/{owner}";
+  }
+}
+
+message QueryCollectionRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+}
+
+message QueryCollectionResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  bitsong.nft.v1beta1.Collection collection = 1;
+}
+
+message QueryOwnerOfRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+  string token_id = 2;
+}
+
+message QueryOwnerOfResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string owner = 1;
+}
+
+message QueryNumTokensRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+}
+
+message QueryNumTokensResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  uint64 count = 1;
+}
+
+message QueryNftInfoRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+  string token_id = 2;
+}
+
+message QueryNftInfoResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  bitsong.nft.v1beta1.Nft nft = 1;
+}
+
+message QueryNftsRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string collection = 1;
+
+  cosmos.base.query.v1beta1.PageRequest pagination = 2;
+}
+
+message QueryNftsResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  repeated bitsong.nft.v1beta1.Nft nfts = 1 [
+    (gogoproto.nullable) = false
+  ];
+
+  cosmos.base.query.v1beta1.PageResponse pagination = 2;
+}
+
+message QueryAllNftsByOwnerRequest {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  string owner = 1;
+}
+
+message QueryAllNftsByOwnerResponse {
+  option (gogoproto.equal)           = false;
+  option (gogoproto.goproto_getters) = false;
+
+  repeated bitsong.nft.v1beta1.Nft nfts = 1 [
+    (gogoproto.nullable) = false
+  ];
+}

third_party/proto/cosmos/query/v1/query.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package cosmos.query.v1;
+
+import "google/protobuf/descriptor.proto";
+
+// TODO: once we fully migrate to protov2 the go_package needs to be updated.
+// We need this right now because gogoproto codegen needs to import the extension.
+option go_package = "github.com/cosmos/cosmos-sdk/types/query";
+
+extend google.protobuf.MethodOptions {
+  // module_query_safe is set to true when the query is safe to be called from
+  // within the state machine, for example from another module's Keeper, via
+  // ADR-033 calls or from CosmWasm contracts.
+  // Concretely, it means that the query is:
+  // 1. deterministic: given a block height, returns the exact same response
+  // upon multiple calls; and doesn't introduce any state-machine-breaking
+  // changes across SDK patch version.
+  // 2. consumes gas correctly.
+  //
+  // If you are a module developer and want to add this annotation to one of
+  // your own queries, please make sure that the corresponding query:
+  // 1. is deterministic and won't introduce state-machine-breaking changes
+  // without a coordinated upgrade path,
+  // 2. has its gas tracked, to avoid the attack vector where no gas is
+  // accounted for on potentially high-computation queries.
+  //
+  // For queries that potentially consume a large amount of gas (for example
+  // those with pagination, if the pagination field is incorrectly set), we
+  // also recommend adding Protobuf comments to warn module developers
+  // consuming these queries.
+  //
+  // When set to true, the query can safely be called
+  bool module_query_safe = 11110001;
+}

x/nft/keeper/collection.go

@@ -0,0 +1,89 @@
+package keeper
+
+import (
+	"fmt"
+
+	"cosmossdk.io/math"
+	"github.com/bitsongofficial/go-bitsong/x/nft/types"
+	tmcrypto "github.com/cometbft/cometbft/crypto"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+func (k Keeper) CreateCollection(ctx sdk.Context, creator sdk.AccAddress, coll types.Collection) (denom string, err error) {
+	denom, err = k.validateCollectionDenom(ctx, creator, coll.Symbol)
+	if err != nil {
+		return "", err
+	}
+
+	// TODO: charge fee
+
+	if err := k.setCollection(ctx, denom, coll); err != nil {
+		return "", err
+	}
+
+	return denom, nil
+}
+
+func (k Keeper) GetSupply(ctx sdk.Context, denom string) math.Int {
+	supply, err := k.Supply.Get(ctx, denom)
+	if err != nil {
+		return math.ZeroInt()
+	}
+
+	return supply
+}
+
+func (k Keeper) HasSupply(ctx sdk.Context, denom string) bool {
+	has, err := k.Supply.Has(ctx, denom)
+	return has && err == nil
+}
+
+func (k Keeper) setSupply(ctx sdk.Context, denom string, supply math.Int) error {
+	return k.Supply.Set(ctx, denom, supply)
+}
+
+func (k Keeper) incrementSupply(ctx sdk.Context, denom string) error {
+	supply := k.GetSupply(ctx, denom)
+	supply = supply.Add(math.NewInt(1))
+
+	return k.setSupply(ctx, denom, supply)
+}
+
+func (k Keeper) createCollectionDenom(creator sdk.AccAddress, symbol string) string {
+	// TODO: if necessary add a salt field
+
+	bz := []byte(fmt.Sprintf("%s/%s", creator.String(), symbol))
+	return fmt.Sprintf("nft%x", tmcrypto.AddressHash(bz))
+}
+
+func (k Keeper) validateCollectionDenom(ctx sdk.Context, creator sdk.AccAddress, symbol string) (string, error) {
+	denom := k.createCollectionDenom(creator, symbol)
+
+	if err := sdk.ValidateDenom(denom); err != nil {
+		return "", err
+	}
+
+	if k.HasCollection(ctx, denom) {
+		return "", types.ErrCollectionAlreadyExists
+	}
+
+	return denom, nil
+}
+
+func (k Keeper) setCollection(ctx sdk.Context, denom string, coll types.Collection) error {
+	return k.Collections.Set(ctx, denom, coll)
+}
+
+func (k Keeper) getCollection(ctx sdk.Context, denom string) (types.Collection, error) {
+	coll, err := k.Collections.Get(ctx, denom)
+	if err != nil {
+		return types.Collection{}, types.ErrCollectionNotFound
+	}
+
+	return coll, nil
+}
+
+func (k Keeper) HasCollection(ctx sdk.Context, denom string) bool {
+	has, err := k.Collections.Has(ctx, denom)
+	return has && err == nil
+}

x/nft/keeper/collection_test.go

@@ -0,0 +1,21 @@
+package keeper
+
+import (
+	"testing"
+
+	"github.com/cometbft/cometbft/crypto/tmhash"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+func TestKeeper_createCollectionDenom(t *testing.T) {
+	creator := sdk.AccAddress(tmhash.SumTruncated([]byte("creator")))
+	symbol := "MYNFT"
+
+	expectedDenom := "nft653AF6715F0C4EE2E24A54B191EBD0AD5DB33723"
+	k := Keeper{}
+
+	denom := k.createCollectionDenom(creator, symbol)
+	if denom != expectedDenom {
+		t.Errorf("expected %s, got %s", expectedDenom, denom)
+	}
+}