Merge pull request #4 from numary/dev/machine-02

Script execution

Author: Azorlogh

api/http.go

@@ -95,6 +95,25 @@ func NewHttpAPI(lc fx.Lifecycle, resolver *ledger.Resolver) *HttpAPI {
 		})
 	})
 
+	r.POST("/:ledger/script", func(c *gin.Context) {
+		l, _ := c.Get("ledger")
+
+		var script core.Script
+		c.ShouldBind(&script)
+
+		err := l.(*ledger.Ledger).Execute(script)
+
+		res := gin.H{
+			"ok": err == nil,
+		}
+
+		if err != nil {
+			res["err"] = err.Error()
+		}
+
+		c.JSON(200, res)
+	})
+
 	r.GET("/:ledger/accounts", func(c *gin.Context) {
 		l, _ := c.Get("ledger")
 

core/script.go

@@ -1,10 +1,8 @@
 package core
 
-type Script struct {
-	Plain    string `json:"plain"`
-	AST      AST    `json:"ast"`
-	Compiled []byte `json:"bytecode"`
-}
+import "encoding/json"
 
-type AST struct {
+type Script struct {
+	Plain string                     `json:"plain"`
+	Vars  map[string]json.RawMessage `json:"vars"`
 }

core/transaction.go

@@ -20,7 +20,6 @@ type Transaction struct {
 	Timestamp string    `json:"timestamp"`
 	Hash      string    `json:"hash"`
 	Metadata  Metadata  `json:"metadata"`
-	Script    string    `json:"script,omitempty"`
 }
 
 func (t *Transaction) AppendPosting(p Posting) {

go.mod

@@ -7,9 +7,8 @@ require (
 	github.com/gin-gonic/gin v1.7.1
 	github.com/huandu/go-sqlbuilder v1.12.1
 	github.com/jackc/pgx/v4 v4.11.0
-	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/mattn/go-sqlite3 v1.14.7
-	github.com/numary/machine v0.0.0-20210702091459-23a82555adbf
+	github.com/numary/machine v0.0.0-20210719124351-aad80bd74032
 	github.com/pkg/errors v0.8.1
 	github.com/spf13/cobra v1.1.3
 	github.com/spf13/viper v1.8.1

go.sum

@@ -204,8 +204,9 @@ github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
+github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
@@ -341,8 +342,6 @@ github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/X
 github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo=
 github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
 github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w=
-github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
-github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
 github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
@@ -411,8 +410,12 @@ github.com/nats-io/nats.go v1.9.1/go.mod h1:ZjDU1L/7fJ09jvUSRVBR2e7+RnLiiIQyqyzE
 github.com/nats-io/nkeys v0.1.0/go.mod h1:xpnFELMwJABBLVhffcfd1MZx6VsNRFpEugbxziKVo7w=
 github.com/nats-io/nkeys v0.1.3/go.mod h1:xpnFELMwJABBLVhffcfd1MZx6VsNRFpEugbxziKVo7w=
 github.com/nats-io/nuid v1.0.1/go.mod h1:19wcPz3Ph3q0Jbyiqsd0kePYG7A95tJPxeL+1OSON2c=
-github.com/numary/machine v0.0.0-20210702091459-23a82555adbf h1:edD04W2rv475M6PBiQ6avKdzpsE5GQZ/GRSG8y/p1Lk=
+github.com/numary/ledger v0.0.0-20210702172952-a5bd30e551d0/go.mod h1:u2K28z9TDYd6id1qeD2uv7JDlajuRZ0fvOnCeDZmDxk=
 github.com/numary/machine v0.0.0-20210702091459-23a82555adbf/go.mod h1:WAFvefAGYNjdDmPtDoZ305F58QDtUJyB0QWN3vzSZao=
+github.com/numary/machine v0.0.0-20210715161621-302dfd46d8db h1:TVGE+0BIHcVXNPMfsxGeD6TCyNwLXhoBJOxyr8zbXuk=
+github.com/numary/machine v0.0.0-20210715161621-302dfd46d8db/go.mod h1:dvm8ZK8ywVDLDCKX8RyVT5bnD5/9A2RRmK8ZdJ9OvSM=
+github.com/numary/machine v0.0.0-20210719124351-aad80bd74032 h1:/0PgX+JYoyHa776kR98XXqLGvqHWPiDTCQAYT0siY2c=
+github.com/numary/machine v0.0.0-20210719124351-aad80bd74032/go.mod h1:dvm8ZK8ywVDLDCKX8RyVT5bnD5/9A2RRmK8ZdJ9OvSM=
 github.com/oklog/oklog v0.3.2/go.mod h1:FCV+B7mhrz4o+ueLpx+KqkyXRGMWOYEvfiXtdGtbWGs=
 github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
 github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=

ledger/executor.go

@@ -1,4 +1,69 @@
 package ledger
 
-type Executor struct {
+import (
+	"errors"
+	"fmt"
+
+	"github.com/numary/ledger/core"
+	"github.com/numary/machine/script/compiler"
+	"github.com/numary/machine/vm"
+)
+
+func (l *Ledger) Execute(script core.Script) error {
+	if script.Plain == "" {
+		return errors.New("no script to execute")
+	}
+
+	p, err := compiler.Compile(script.Plain)
+	if err != nil {
+		return fmt.Errorf("compile error: %v", err)
+	}
+	m := vm.NewMachine(p)
+
+	err = m.SetVarsFromJSON(script.Vars)
+	if err != nil {
+		return fmt.Errorf("error while setting variables: %v", err)
+	}
+
+	needed_balances, err := m.GetNeededBalances()
+	if err != nil {
+		return err
+	}
+
+	balances := map[string]map[string]uint64{}
+
+	for account_address, needed_assets := range needed_balances {
+		account, err := l.GetAccount(account_address)
+		if err != nil {
+			return fmt.Errorf("invalid account address: %v\n", err)
+		}
+		balances[account_address] = map[string]uint64{}
+		for asset := range needed_assets {
+			amt := account.Balances[asset]
+			if amt < 0 {
+				amt = 0
+			}
+			balances[account_address][asset] = uint64(amt)
+		}
+	}
+
+	err = m.SetBalances(balances)
+	if err != nil {
+		return err
+	}
+
+	c, err := m.Execute()
+	if err != nil {
+		return fmt.Errorf("script failed: %v", err)
+	}
+	if c == vm.EXIT_FAIL {
+		return errors.New("script exited with error code EXIT_FAIL")
+	}
+
+	t := core.Transaction{
+		Postings: m.Postings,
+	}
+
+	err = l.Commit([]core.Transaction{t})
+	return err
 }

ledger/executor_test.go

@@ -0,0 +1,192 @@
+package ledger
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"testing"
+
+	"github.com/numary/ledger/core"
+)
+
+func TestTransactionInvalidScript(t *testing.T) {
+	with(func(l *Ledger) {
+		script := core.Script{
+			Plain: "this is not a valid script",
+		}
+
+		err := l.Execute(script)
+
+		if err == nil {
+			t.Error(errors.New(
+				"script was invalid yet the transaction was commited",
+			))
+		}
+		l.Close()
+	})
+}
+
+func TestTransactionFail(t *testing.T) {
+	with(func(l *Ledger) {
+		script := core.Script{
+			Plain: "fail",
+		}
+
+		err := l.Execute(script)
+
+		if err == nil {
+			t.Error(errors.New(
+				"script failed yet the transaction was commited",
+			))
+		}
+		l.Close()
+	})
+}
+
+func TestSend(t *testing.T) {
+	with(func(l *Ledger) {
+		defer l.Close()
+		script := core.Script{
+			Plain: `send [USD/2 99] (
+				source=@world
+				destination=@user:001
+			)`,
+		}
+
+		err := l.Execute(script)
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		user, err := l.GetAccount("user:001")
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		if b := user.Balances["USD/2"]; b != 99 {
+			t.Error(fmt.Sprintf(
+				"wrong USD/2 balance for account user:001, expected: %d got: %d",
+				99,
+				b,
+			))
+		}
+	})
+}
+
+func TestVariables(t *testing.T) {
+	with(func(l *Ledger) {
+		defer l.Close()
+
+		var script core.Script
+		json.Unmarshal(
+			[]byte(`{
+				"plain": "vars {\naccount $dest\n}\nsend [CAD/2 42] (\n source=@world \n destination=$dest \n)",
+				"vars": {
+					"dest": "user:042"
+				}
+			}`),
+			&script)
+
+		err := l.Execute(script)
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		user, err := l.GetAccount("user:042")
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		if b := user.Balances["CAD/2"]; b != 42 {
+			t.Error(fmt.Sprintf(
+				"wrong CAD/2 balance for account user:042, expected: %d got: %d",
+				42,
+				b,
+			))
+		}
+	})
+}
+
+func TestEnoughFunds(t *testing.T) {
+	with(func(l *Ledger) {
+		defer l.Close()
+
+		tx := core.Transaction{
+			Postings: []core.Posting{
+				{
+					Source:      "world",
+					Destination: "user:001",
+					Amount:      100,
+					Asset:       "COIN",
+				},
+			},
+		}
+
+		err := l.Commit([]core.Transaction{tx})
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		var script core.Script
+		json.Unmarshal(
+			[]byte(`{
+				"plain": "send [COIN 95] (\n source=@user:001 \n destination=@world \n)"
+			}`),
+			&script)
+
+		err = l.Execute(script)
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+	})
+}
+
+func TestNotEnoughFunds(t *testing.T) {
+	with(func(l *Ledger) {
+		defer l.Close()
+
+		tx := core.Transaction{
+			Postings: []core.Posting{
+				{
+					Source:      "world",
+					Destination: "user:002",
+					Amount:      100,
+					Asset:       "COIN",
+				},
+			},
+		}
+
+		err := l.Commit([]core.Transaction{tx})
+
+		if err != nil {
+			t.Error(err)
+			return
+		}
+
+		var script core.Script
+		json.Unmarshal(
+			[]byte(`{
+				"plain": "send [COIN 105] (\n source=@user:002 \n destination=@world \n)"
+			}`),
+			&script)
+
+		err = l.Execute(script)
+
+		if err == nil {
+			t.Error("error wasn't supposed to be nil")
+			return
+		}
+	})
+}