Support description and image URL for mint metadata

Author: jeffyanta

go.mod

@@ -6,7 +6,7 @@ require (
 	filippo.io/edwards25519 v1.1.0
 	github.com/aws/aws-sdk-go-v2 v0.17.0
 	github.com/bits-and-blooms/bloom/v3 v3.1.0
-	github.com/code-payments/code-protobuf-api v1.19.1-0.20250909140022-32d989862f5a
+	github.com/code-payments/code-protobuf-api v1.19.1-0.20250919185855-0de34de496c2
 	github.com/code-payments/code-vm-indexer v0.1.11-0.20241028132209-23031e814fba
 	github.com/emirpasic/gods v1.12.0
 	github.com/envoyproxy/protoc-gen-validate v1.2.1

go.sum

@@ -80,8 +80,8 @@ github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnht
 github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
 github.com/cockroachdb/apd v1.1.0 h1:3LFP3629v+1aKXU5Q37mxmRxX/pIu1nijXydLShEq5I=
 github.com/cockroachdb/apd v1.1.0/go.mod h1:8Sl8LxpKi29FqWXR16WEFZRNSz3SoPzUzeMeY4+DwBQ=
-github.com/code-payments/code-protobuf-api v1.19.1-0.20250909140022-32d989862f5a h1:KJHqqNz1gEOhjg97mw1B81Fvd4CClWeaSJw2AMOqSkA=
-github.com/code-payments/code-protobuf-api v1.19.1-0.20250909140022-32d989862f5a/go.mod h1:ee6TzKbgMS42ZJgaFEMG3c4R3dGOiffHSu6MrY7WQvs=
+github.com/code-payments/code-protobuf-api v1.19.1-0.20250919185855-0de34de496c2 h1:IQJnBLjMUNgL2Drqck86/rtsgL38uCQ+vgEUzJbUsL0=
+github.com/code-payments/code-protobuf-api v1.19.1-0.20250919185855-0de34de496c2/go.mod h1:ee6TzKbgMS42ZJgaFEMG3c4R3dGOiffHSu6MrY7WQvs=
 github.com/code-payments/code-vm-indexer v0.1.11-0.20241028132209-23031e814fba h1:Bkp+gmeb6Y2PWXfkSCTMBGWkb2P1BujRDSjWeI+0j5I=
 github.com/code-payments/code-vm-indexer v0.1.11-0.20241028132209-23031e814fba/go.mod h1:jSiifpiBpyBQ8q2R0MGEbkSgWC6sbdRTyDBntmW+j1E=
 github.com/containerd/continuity v0.0.0-20190827140505-75bee3e2ccb6 h1:NmTXa/uVnDyp0TY5MKi197+3HWcnYWfnHGyaFthlnGw=

pkg/code/config/config.go

@@ -16,6 +16,8 @@ const (
 	CoreMintDecimals        = usdc.Decimals
 	CoreMintName            = "USDC"
 	CoreMintSymbol          = "USDC"
+	CoreMintDescription     = "USDC is a regulated digital currency established in 2018 and issued by Circle, a regulated financial service business that follows strict US laws and standards to protect your money. Every USDC in existence is backed by a US dollar or cash equivalent asset that Circle has in its publicly visible reserves, with assurances issued monthly by a Big Four accounting firm."
+	CoreMintImageUrl        = "https://pbs.twimg.com/profile_images/1916937910928211968/CKblfanr_400x400.png"
 
 	// Random value. Replace with real subsidizer public keys
 	SubsidizerPublicKey = "84ydcM4Yp59W6aZP6eSaKiAMaKidNLfb5k318sT2pm14"

pkg/code/data/currency/model.go

@@ -22,8 +22,10 @@ type MultiRateRecord struct {
 type MetadataRecord struct {
 	Id uint64
 
-	Name   string
-	Symbol string
+	Name        string
+	Symbol      string
+	Description string
+	ImageUrl    string
 
 	Seed string
 
@@ -64,6 +66,14 @@ func (m *MetadataRecord) Validate() error {
 		return errors.New("symbol is required")
 	}
 
+	if len(m.Description) == 0 {
+		return errors.New("description is required")
+	}
+
+	if len(m.ImageUrl) == 0 {
+		return errors.New("image url is required")
+	}
+
 	if len(m.Seed) == 0 {
 		return errors.New("seed is required")
 	}
@@ -147,8 +157,10 @@ func (m *MetadataRecord) Clone() *MetadataRecord {
 	return &MetadataRecord{
 		Id: m.Id,
 
-		Name:   m.Name,
-		Symbol: m.Symbol,
+		Name:        m.Name,
+		Symbol:      m.Symbol,
+		Description: m.Description,
+		ImageUrl:    m.ImageUrl,
 
 		Seed: m.Seed,
 
@@ -186,6 +198,8 @@ func (m *MetadataRecord) CopyTo(dst *MetadataRecord) {
 
 	dst.Name = m.Name
 	dst.Symbol = m.Symbol
+	dst.Description = m.Description
+	dst.ImageUrl = m.ImageUrl
 
 	dst.Seed = m.Seed
 

pkg/code/data/currency/postgres/model.go

@@ -51,8 +51,10 @@ func fromExchangeRateModel(obj *exchangeRateModel) *currency.ExchangeRateRecord
 type metadataModel struct {
 	Id sql.NullInt64 `db:"id"`
 
-	Name   string `db:"name"`
-	Symbol string `db:"symbol"`
+	Name        string `db:"name"`
+	Symbol      string `db:"symbol"`
+	Description string `db:"description"`
+	ImageUrl    string `db:"image_url"`
 
 	Seed string `db:"seed"`
 
@@ -92,8 +94,10 @@ func toMetadataModel(obj *currency.MetadataRecord) (*metadataModel, error) {
 	return &metadataModel{
 		Id: sql.NullInt64{Int64: int64(obj.Id), Valid: obj.Id > 0},
 
-		Name:   obj.Name,
-		Symbol: obj.Symbol,
+		Name:        obj.Name,
+		Symbol:      obj.Symbol,
+		Description: obj.Description,
+		ImageUrl:    obj.ImageUrl,
 
 		Seed: obj.Seed,
 
@@ -130,8 +134,10 @@ func fromMetadataModel(obj *metadataModel) *currency.MetadataRecord {
 	return &currency.MetadataRecord{
 		Id: uint64(obj.Id.Int64),
 
-		Name:   obj.Name,
-		Symbol: obj.Symbol,
+		Name:        obj.Name,
+		Symbol:      obj.Symbol,
+		Description: obj.Description,
+		ImageUrl:    obj.ImageUrl,
 
 		Seed: obj.Seed,
 
@@ -246,11 +252,13 @@ func (m *metadataModel) dbSave(ctx context.Context, db *sqlx.DB) error {
 	return pgutil.ExecuteInTx(ctx, db, sql.LevelDefault, func(tx *sqlx.Tx) error {
 		err := tx.QueryRowxContext(ctx,
 			`INSERT INTO `+metadataTableName+`
-			(name, symbol, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at)
-			VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21)
-			RETURNING id, name, symbol, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at`,
+			(name, symbol, description, image_url, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at)
+			VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19, $20, $21, $22, $23)
+			RETURNING id, name, symbol, description, image_url, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at`,
 			m.Name,
 			m.Symbol,
+			m.Description,
+			m.ImageUrl,
 			m.Seed,
 			m.Authority,
 			m.Mint,
@@ -347,7 +355,7 @@ func dbGetAllExchangeRatesForRange(ctx context.Context, db *sqlx.DB, symbol stri
 func dbGetMetadataByMint(ctx context.Context, db *sqlx.DB, mint string) (*metadataModel, error) {
 	res := &metadataModel{}
 	err := db.GetContext(ctx, res,
-		`SELECT id, name, symbol, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at
+		`SELECT id, name, symbol, description, image_url, seed, authority, mint, mint_bump, decimals, currency_config, currency_config_bump, liquidity_pool, liquidity_pool_bump, vault_mint, vault_mint_bump, vault_core, vault_core_bump, fees_mint, buy_fee_bps, fees_core, sell_fee_bps, created_by, created_at
 		FROM `+metadataTableName+`
 		WHERE mint = $1`,
 		mint,

pkg/code/data/currency/postgres/store_test.go

@@ -35,6 +35,8 @@ const (
 
 		name TEXT NOT NULL,
 		symbol TEXT NOT NULL,
+		description TEXT NOT NULL,
+		image_url TEXT NOT NULL,
 
 		seed TEXT UNIQUE NOT NULL,
 

pkg/code/data/currency/tests/tests.go

@@ -118,8 +118,10 @@ func testGetExchangeRatesInRange(t *testing.T, s currency.Store) {
 
 func testMetadataRoundTrip(t *testing.T, s currency.Store) {
 	expected := &currency.MetadataRecord{
-		Name:   "Jeffy",
-		Symbol: "JFY",
+		Name:        "Jeffy",
+		Symbol:      "JFY",
+		Description: "A test currency for Flipcash created by Jeff Yanta so we can eat our own dog food as we build out the platform. Pun intended",
+		ImageUrl:    "https://flipcash-currency-assets.s3.us-east-1.amazonaws.com/52MNGpgvydSwCtC2H4qeiZXZ1TxEuRVCRGa8LAfk2kSj/icon.png",
 
 		Seed: "H7WNaHtCa5h2k7AwZ8DbdLfM6bU2bi2jmWiUkFqgeBYk",
 
@@ -202,6 +204,8 @@ func testReserveRoundTrip(t *testing.T, s currency.Store) {
 func assertEquivalentMetadataRecords(t *testing.T, obj1, obj2 *currency.MetadataRecord) {
 	assert.Equal(t, obj1.Name, obj2.Name)
 	assert.Equal(t, obj1.Symbol, obj2.Symbol)
+	assert.Equal(t, obj1.Description, obj2.Description)
+	assert.Equal(t, obj1.ImageUrl, obj2.ImageUrl)
 	assert.Equal(t, obj1.Seed, obj2.Seed)
 	assert.Equal(t, obj1.Authority, obj2.Authority)
 	assert.Equal(t, obj1.Mint, obj2.Mint)

pkg/code/server/currency/currency.go

@@ -14,6 +14,7 @@ import (
 	currencypb "github.com/code-payments/code-protobuf-api/generated/go/currency/v1"
 
 	"github.com/code-payments/code-server/pkg/code/common"
+	"github.com/code-payments/code-server/pkg/code/config"
 	currency_util "github.com/code-payments/code-server/pkg/code/currency"
 	code_data "github.com/code-payments/code-server/pkg/code/data"
 	"github.com/code-payments/code-server/pkg/code/data/currency"
@@ -83,10 +84,12 @@ func (s *currencyServer) GetMints(ctx context.Context, req *currencypb.GetMintsR
 		switch mintAccount.PublicKey().ToBase58() {
 		case common.CoreMintAccount.PublicKey().ToBase58():
 			protoMetadata = &currencypb.Mint{
-				Address:  protoMintAddress,
-				Decimals: uint32(common.CoreMintDecimals),
-				Name:     common.CoreMintName,
-				Symbol:   strings.ToUpper(string(common.CoreMintSymbol)),
+				Address:     protoMintAddress,
+				Decimals:    uint32(common.CoreMintDecimals),
+				Name:        common.CoreMintName,
+				Symbol:      strings.ToUpper(string(common.CoreMintSymbol)),
+				Description: config.CoreMintDescription,
+				ImageUrl:    config.CoreMintImageUrl,
 				VmMetadata: &currencypb.VmMetadata{
 					Vm:                 common.CodeVmAccount.ToProto(),
 					Authority:          common.GetSubsidizer().ToProto(),
@@ -108,6 +111,12 @@ func (s *currencyServer) GetMints(ctx context.Context, req *currencypb.GetMintsR
 				return nil, status.Error(codes.Internal, "")
 			}
 
+			vmConfig, err := common.GetVmConfigForMint(ctx, s.data, mintAccount)
+			if err != nil {
+				log.WithError(err).Warn("failure getting vm config")
+				return nil, status.Error(codes.Internal, "")
+			}
+
 			seed, err := common.NewAccountFromPublicKeyString(metadataRecord.Seed)
 			if err != nil {
 				log.WithError(err).Warn("invalid seed")
@@ -144,18 +153,16 @@ func (s *currencyServer) GetMints(ctx context.Context, req *currencypb.GetMintsR
 				return nil, status.Error(codes.Internal, "")
 			}
 
-			// todo: Need a DB table for VMs
-			vmAccount, _ := common.NewAccountFromPublicKeyString("Bii3UFB9DzPq6UxgewF5iv9h1Gi8ZnP6mr7PtocHGNta")
-			vmAuthorityAccount := currencyAuthorityAccount
-
 			protoMetadata = &currencypb.Mint{
-				Address:  protoMintAddress,
-				Decimals: uint32(metadataRecord.Decimals),
-				Name:     metadataRecord.Name,
-				Symbol:   metadataRecord.Symbol,
+				Address:     protoMintAddress,
+				Decimals:    uint32(metadataRecord.Decimals),
+				Name:        metadataRecord.Name,
+				Symbol:      metadataRecord.Symbol,
+				Description: metadataRecord.Description,
+				ImageUrl:    metadataRecord.ImageUrl,
 				VmMetadata: &currencypb.VmMetadata{
-					Vm:                 vmAccount.ToProto(),
-					Authority:          vmAuthorityAccount.ToProto(),
+					Vm:                 vmConfig.Vm.ToProto(),
+					Authority:          vmConfig.Authority.ToProto(),
 					LockDurationInDays: uint32(timelock_token.DefaultNumDaysLocked),
 				},
 				LaunchpadMetadata: &currencypb.LaunchpadMetadata{