feat(examples): Gnofundme

examples/gno.land/p/malek_/gnofundme/contributor.gno

@@ -0,0 +1,59 @@
+package gnofundme
+
+import (
+	"time"
+
+	"gno.land/p/demo/json"
+	"gno.land/p/demo/ufmt"
+	pusers "gno.land/p/demo/users"
+)
+
+type Contributor struct {
+	// the user who contributed
+	user *pusers.User
+	// the date of the contribution
+	Date time.Time
+	// the amount of the contribution
+	Amount uint64
+	// whether the contributor wants to be displayed (Anonymous in case of false)
+	display bool
+}
+
+func NewContributor(user *pusers.User, date time.Time, amount uint64, display bool) *Contributor {
+	return &Contributor{
+		user:    user,
+		Date:    date,
+		Amount:  amount,
+		display: display,
+	}
+}
+
+func (c Contributor) GetUser() *pusers.User {
+	return c.user
+}
+
+func (c Contributor) GetDisplay() bool {
+	return c.display
+}
+
+func (c Contributor) String() string {
+	node := json.ObjectNode("Contributor", map[string]*json.Node{
+		"Address": json.StringNode("Address", c.user.Address.String()),
+		"date":    json.StringNode("date", c.Date.Format(time.RFC822)),
+		"amount":  json.NumberNode("amount", float64(c.Amount)),
+		"display": json.StringNode("display", FormatBool(c.display)),
+	})
+	value, err := json.Marshal(node)
+	if err != nil {
+		panic(ufmt.Sprintf("unexpected error: %s", err))
+	}
+
+	return string(value)
+}
+
+func FormatBool(b bool) string {
+	if b {
+		return "true"
+	}
+	return "false"
+}

examples/gno.land/p/malek_/gnofundme/contributor_test.gno

@@ -0,0 +1,29 @@
+package gnofundme
+
+import (
+	"testing"
+	"time"
+
+	"gno.land/p/demo/uassert"
+	"gno.land/r/demo/users"
+)
+
+func TestNewContributor(t *testing.T) {
+	user := users.GetUserByName("demo")
+	amount := uint64(500)
+	display := true
+	date := time.Unix(time.Now().Unix(), 0)
+	contributor := NewContributor(user, date, amount, display)
+
+	uassert.Equal(t, contributor.GetUser().Address, user.Address)
+
+	uassert.False(t, contributor.Date.IsZero())
+
+	uassert.Equal(t, contributor.Amount, amount)
+
+	uassert.Equal(t, contributor.GetDisplay(), display)
+
+	json := `{"Address":"g13ek2zz9qurzynzvssyc4sthwppnruhnp0gdz8n","date":"13 Feb 09 23:31 UTC","amount":500,"display":"true"}`
+
+	uassert.Equal(t, contributor.String(), json)
+}

examples/gno.land/p/malek_/gnofundme/gno.mod

@@ -0,0 +1,10 @@
+module gno.land/p/malek_/gnofundme
+
+require (
+	gno.land/p/demo/json v0.0.0-latest
+	gno.land/p/demo/testutils v0.0.0-latest
+	gno.land/p/demo/uassert v0.0.0-latest
+	gno.land/p/demo/ufmt v0.0.0-latest
+	gno.land/p/demo/users v0.0.0-latest
+	gno.land/r/demo/users v0.0.0-latest
+)

examples/gno.land/p/malek_/gnofundme/gnofundme.gno

@@ -0,0 +1,151 @@
+package gnofundme // Package gnofundme provides a simple crowdfunding system.
+
+import (
+	"bytes"
+	"strconv"
+	"strings"
+	"time"
+
+	"gno.land/p/demo/json"
+	"gno.land/p/demo/ufmt"
+	pusers "gno.land/p/demo/users"
+)
+
+type ctype int
+
+const (
+	Personal ctype = iota
+	// for a person (yourself or another person): can be for humanitarian reason, emergency needs, or other (beneficiary = owner)
+	Cause
+	// for a cause: you will manage the funds (based on trust) (beneficiary = owner)
+	Organism
+	// for an organism, charity... (beneficiary != owner)
+	// the next types are for companies(startup projects...) crowdfunding
+	Donation
+	Reward
+	Equity
+)
+
+func (c ctype) String() string {
+	return [...]string{"Personal", "Cause", "Organism", "Donation", "Reward", "Equity"}[c]
+}
+
+type Campaign struct {
+	// Campaign type
+	Ctype       ctype
+	Title       string
+	Description string
+	Goal        uint64
+	Current     uint64
+	Begin       time.Time
+	Deadline    time.Time
+	Owner       *pusers.User
+	// Campaign beneficiary (can be the owner or another address)
+	Beneficiary  *pusers.User
+	contributors []*Contributor
+}
+
+func NewCampaign(ct int, title string, description string, goal uint64, begin time.Time, deadline time.Time, owner *pusers.User, beneficiary *pusers.User) *Campaign {
+	campaign := &Campaign{
+		Ctype:        ctype(ct),
+		Title:        title,
+		Description:  description,
+		Goal:         goal,
+		Current:      0,
+		Begin:        begin,
+		Deadline:     deadline,
+		Owner:        owner,
+		Beneficiary:  beneficiary,
+		contributors: make([]*Contributor, 0),
+	}
+
+	return campaign
+}
+
+func (c Campaign) GetContributors() []*Contributor {
+	return c.contributors
+}
+
+func (c *Campaign) AddContributor(user *pusers.User, date time.Time, amount uint64, display bool) *Contributor {
+	c.Current += amount
+	contributor := NewContributor(user, date, amount, display)
+	c.contributors = append(c.contributors, contributor)
+
+	return contributor
+}
+
+// CampaignsToJSONString converts a slice of Campaigns structs into a JSON string
+func CampaignsToJSONString(campaigns []*Campaign) string {
+	var sb strings.Builder
+
+	sb.WriteString("[")
+	for i, campaign := range campaigns {
+		if i > 0 {
+			sb.WriteString(",")
+		}
+
+		sb.WriteString(campaign.CampaignToJSONString())
+	}
+	sb.WriteString("]")
+
+	return sb.String()
+}
+
+// CampaignToJSONString returns a Campaign formatted as a JSON string
+func (c *Campaign) CampaignToJSONString() string {
+	node := json.ObjectNode("", map[string]*json.Node{
+		"Ctype":        json.StringNode("Ctype", c.Ctype.String()),
+		"Title":        json.StringNode("Title", c.Title),
+		"Description":  json.StringNode("Description", c.Description),
+		"Goal":         json.NumberNode("Goal", float64(c.Goal)),
+		"Current":      json.NumberNode("Current", float64(c.Current)),
+		"Begin":        json.StringNode("Begin", strconv.Itoa(int(c.Begin.Unix()))),
+		"Deadline":     json.StringNode("Deadline", strconv.Itoa(int(c.Deadline.Unix()))),
+		"Owner":        json.StringNode("Owner", c.Owner.Address.String()),
+		"Beneficiary":  json.StringNode("Beneficiary", c.Beneficiary.Address.String()),
+		"Contributors": json.NumberNode("Contributors", float64(len(c.contributors))),
+	})
+	value, err := json.Marshal(node)
+	if err != nil {
+		panic(ufmt.Sprintf("unexpected error: %s", err))
+	}
+
+	return string(value)
+}
+
+func (c Campaign) Render(id string) string {
+	var b bytes.Buffer
+	b.WriteString(ufmt.Sprintf("# Campaign %s\n", id))
+	b.WriteString(ufmt.Sprintf("## Title: %s\n", c.Title))
+	b.WriteString(ufmt.Sprintf("## Description: %s\n", c.Description))
+	b.WriteString(ufmt.Sprintf("### Goal: %d GNOT", c.Goal))
+	b.WriteString(ufmt.Sprintf("********** Current: %d GNOT\n", c.Current/1_000_000))
+	b.WriteString(ufmt.Sprintf("### Begin: %s", c.Begin.String()))
+	b.WriteString(ufmt.Sprintf("  ------------->  Deadline: %s\n", c.Deadline.String()))
+	b.WriteString(ufmt.Sprintf("### Owner: %s, %s\n", c.Owner.Name, c.Owner.Address.String()))
+	b.WriteString(ufmt.Sprintf("### Beneficiary: %s, %s\n", c.Beneficiary.Name, c.Beneficiary.Address.String()))
+	b.WriteString(ufmt.Sprintf("## Last contributors: %d\n", len(c.GetContributors())))
+	if contributors := c.GetContributors(); len(c.GetContributors()) != 0 {
+		length := len(c.GetContributors())
+		if length > 10 {
+			length = 10
+		}
+
+		for i := length - 1; i >= 0; i-- {
+			if contributors[i].GetDisplay() {
+				b.WriteString(
+					ufmt.Sprintf(
+						"### %s: %dugnot, %s\n", contributors[i].user.Name, contributors[i].Amount, contributors[i].Date.String(),
+					), // added the date of contribution in the display, but adds "m=+1726419880.000000001" after the date =>> the problems comes from time.now(), had to modify and use time.Unix(time.Now().Unix(), 0) to solve the problem.
+				)
+			} else {
+				b.WriteString(
+					ufmt.Sprintf(
+						"### Anonymous: %dugnot\n", contributors[i].Amount,
+					),
+				)
+			}
+		}
+	}
+	return b.String()
+}

examples/gno.land/p/malek_/gnofundme/gnofundme_test.gno

@@ -0,0 +1,75 @@
+package gnofundme
+
+import (
+	"strconv"
+	"testing"
+	"time"
+
+	"gno.land/p/demo/testutils"
+	"gno.land/p/demo/uassert"
+	"gno.land/r/demo/users"
+)
+
+const (
+	ct                 = ctype(0)
+	title              = "Campaign 1"
+	description        = "Description 1"
+	goal               = uint64(1000)
+	ownerAddress       = testutils.TestAddress("owner")
+	beneficiaryAddress = testutils.TestAddress("beneficiary")
+	owner              = users.GetUserByName("demo")
+	beneficiary        = users.GetUserByName("gno")
+	// Test case 1 Valid campaign
+	begin    = time.Now()
+	deadline = begin.Add(time.Hour * 24)
+)
+
+var campaign = NewCampaign(0, title, description, 1000, begin, deadline, owner, owner)
+
+func TestNewCampaign(t *testing.T) {
+	uassert.Equal(t, campaign.Ctype.String(), ct.String())
+
+	uassert.Equal(t, campaign.Title, title)
+	uassert.Equal(t, campaign.Description, description)
+	uassert.Equal(t, campaign.Goal, goal, "goal")
+	uassert.Equal(t, campaign.Current, uint64(0))
+	uassert.Equal(t, strconv.Itoa(int(campaign.Begin.Unix())), strconv.Itoa(int(begin.Unix())))
+	uassert.Equal(t, strconv.Itoa(int(campaign.Deadline.Unix())), strconv.Itoa(int(deadline.Unix())))
+	uassert.Equal(t, campaign.Owner.Address.String(), owner.Address.String())
+	uassert.Equal(t, campaign.Beneficiary.Address.String(), owner.Address.String())
+	uassert.Equal(t, len(campaign.GetContributors()), 0)
+}
+
+func TestAddContributor(t *testing.T) {
+	contributorAddress := testutils.TestAddress("contributor")
+	user := users.GetUserByName("demo")
+	var amount uint64 = 500
+	display := true
+	date := time.Unix(time.Now().Unix(), 0)
+	campaign.AddContributor(user, date, amount, display)
+
+	contributors := campaign.GetContributors()
+	uassert.Equal(t, campaign.Current, uint64(500))
+
+	uassert.Equal(t, len(contributors), 1)
+
+	uassert.Equal(t, contributors[0].user.Address.String(), user.Address.String())
+
+	uassert.Equal(t, contributors[0].Amount, uint64(500))
+}
+
+func TestCampaignToJSONString(t *testing.T) {
+	expected := `{"Ctype":"Personal","Title":"Campaign 1","Description":"Description 1","Goal":1000,"Current":500,"Begin":"` + strconv.Itoa(int(begin.Unix())) + `","Deadline":"` + strconv.Itoa(int(deadline.Unix())) + `","Owner":"` + owner.Address.String() + `","Beneficiary":"` + owner.Address.String() + `","Contributors":1}`
+
+	result := campaign.CampaignToJSONString()
+	uassert.Equal(t, result, expected)
+}
+
+func TestCampaignsToJSONString(t *testing.T) {
+	campaigns := []*Campaign{campaign, campaign}
+	campaignjson := `{"Ctype":"Personal","Title":"Campaign 1","Description":"Description 1","Goal":1000,"Current":500,"Begin":"` + strconv.Itoa(int(begin.Unix())) + `","Deadline":"` + strconv.Itoa(int(deadline.Unix())) + `","Owner":"` + owner.Address.String() + `","Beneficiary":"` + owner.Address.String() + `","Contributors":1}`
+	expected := `[` + campaignjson + `,` + campaignjson + `]`
+
+	result := CampaignsToJSONString(campaigns)
+	uassert.Equal(t, result, expected)
+}

examples/gno.land/r/malek_/gnofundme/gno.mod

@@ -0,0 +1,10 @@
+module gno.land/r/malek_/gnofundme
+
+require (
+	gno.land/p/demo/avl v0.0.0-latest
+	gno.land/p/demo/uassert v0.0.0-latest
+	gno.land/p/demo/ufmt v0.0.0-latest
+	gno.land/p/demo/users v0.0.0-latest
+	gno.land/p/malek_/gnofundme v0.0.0-latest
+	gno.land/r/demo/users v0.0.0-latest
+)