feat: add governance type (#53)

schema/metadata/governance.go

@@ -0,0 +1,49 @@
+package metadata
+
+import (
+	"github.com/rss3-network/protocol-go/schema"
+	"github.com/rss3-network/protocol-go/schema/typex"
+)
+
+var _ Metadata = (*GovernanceProposal)(nil)
+
+func (t GovernanceProposal) Type() schema.Type {
+	return typex.GovernanceProposal
+}
+
+type GovernanceProposal struct {
+	ID         string   `json:"id"`
+	Body       string   `json:"body"`
+	StartBlock string   `json:"start_block"`
+	EndBlock   string   `json:"end_block"`
+	Options    []string `json:"options"`
+	Link       string   `json:"link"`
+}
+
+var _ Metadata = (*GovernanceVote)(nil)
+
+func (t GovernanceVote) Type() schema.Type {
+	return typex.GovernanceVote
+}
+
+//go:generate go run --mod=mod github.com/dmarkham/enumer --values --type=GovernanceVoteAction --transform=snake --trimprefix=ActionGovernanceVote --output governance_vote.go --json --sql
+type GovernanceVoteAction uint64
+
+var _ Metadata = (*GovernanceVoteAction)(nil)
+
+type GovernanceVote struct {
+	Action   GovernanceVoteAction `json:"action"`
+	Count    uint64               `json:"count"`
+	Reason   string               `json:"reason"`
+	Proposal GovernanceProposal   `json:"token"`
+}
+
+func (r GovernanceVoteAction) Type() schema.Type {
+	return typex.GovernanceVote
+}
+
+const (
+	ActionGovernanceFor GovernanceVoteAction = iota + 1
+	ActionGovernanceAgainst
+	ActionGovernanceAbstain
+)

schema/metadata/metadata.go

@@ -19,6 +19,8 @@ func Unmarshal(metadataType schema.Type, data json.RawMessage) (Metadata, error)
 		return unmarshalCollectibleMetadata(metadataType, data)
 	case tag.Exchange:
 		return unmarshalExchangeMetadata(metadataType, data)
+	case tag.Governance:
+		return unmarshalGovernanceMetadata(metadataType, data)
 	case tag.Metaverse:
 		return unmarshalMetaverseMetadata(metadataType, data)
 	case tag.RSS:
@@ -53,6 +55,25 @@ func unmarshalCollectibleMetadata(metadataType schema.Type, data json.RawMessage
 	return result, nil
 }
 
+func unmarshalGovernanceMetadata(metadataType schema.Type, data json.RawMessage) (Metadata, error) {
+	var result Metadata
+
+	switch metadataType {
+	case typex.GovernanceProposal:
+		result = new(GovernanceProposal)
+	case typex.GovernanceVote:
+		result = new(GovernanceVote)
+	default:
+		return nil, fmt.Errorf("invalid metadata type: %s.%s", metadataType.Tag(), metadataType.Name())
+	}
+
+	if err := json.Unmarshal(data, &result); err != nil {
+		return nil, fmt.Errorf("invalid metadata: %w", err)
+	}
+
+	return result, nil
+}
+
 func unmarshalTransactionMetadata(metadataType schema.Type, data json.RawMessage) (Metadata, error) {
 	var result Metadata
 

schema/tag/tag.go

@@ -13,6 +13,7 @@ const (
 	Unknown Tag = iota
 	Collectible
 	Exchange
+	Governance
 	Metaverse
 	RSS
 	Social

schema/tag_type.go

@@ -21,6 +21,8 @@ func ParseTypeFromString(parentTag tag.Tag, typeValue string) (Type, error) {
 		return typex.CollectibleTypeString(typeValue)
 	case tag.Exchange:
 		return typex.ExchangeTypeString(typeValue)
+	case tag.Governance:
+		return typex.GovernanceTypeString(typeValue)
 	case tag.Metaverse:
 		return typex.MetaverseTypeString(typeValue)
 	case tag.Social:
@@ -58,6 +60,8 @@ func GetTypesByTag(tagValue tag.Tag) []Type {
 		return convertToTypeSlice(typex.CollectibleTypeValues())
 	case tag.Exchange:
 		return convertToTypeSlice(typex.ExchangeTypeValues())
+	case tag.Governance:
+		return convertToTypeSlice(typex.GovernanceTypeValues())
 	case tag.Metaverse:
 		return convertToTypeSlice(typex.MetaverseTypeValues())
 	case tag.Social:

schema/typex/governance.go

@@ -0,0 +1,21 @@
+package typex
+
+import "github.com/rss3-network/protocol-go/schema/tag"
+
+//go:generate go run --mod=mod github.com/dmarkham/enumer --values --type=GovernanceType --transform=snake --trimprefix=Governance --output governance_string.go --json --sql
+type GovernanceType uint64
+
+//goland:noinspection GoMixedReceiverTypes
+func (i GovernanceType) Name() string {
+	return i.String()
+}
+
+//goland:noinspection GoMixedReceiverTypes
+func (i GovernanceType) Tag() tag.Tag {
+	return tag.Governance
+}
+
+const (
+	GovernanceProposal GovernanceType = iota + 1
+	GovernanceVote
+)