forked from cerc-io/ipld-eth-server
reorganizing omni directory and beginning light watcher work
This commit is contained in:
Ian Norden
@@ -0,0 +1,114 @@
|
||||
// VulcanizeDB
|
||||
// Copyright © 2018 Vulcanize
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package contract
|
||||
|
||||
import (
|
||||
"errors"
|
||||
|
||||
"github.com/ethereum/go-ethereum/accounts/abi"
|
||||
|
||||
"github.com/vulcanize/vulcanizedb/pkg/core"
|
||||
"github.com/vulcanize/vulcanizedb/pkg/filters"
|
||||
"github.com/vulcanize/vulcanizedb/pkg/omni/shared/helpers"
|
||||
"github.com/vulcanize/vulcanizedb/pkg/omni/shared/types"
|
||||
)
|
||||
|
||||
// Contract object to hold our contract data
|
||||
type Contract struct {
|
||||
Name string // Name of the contract
|
||||
Address string // Address of the contract
|
||||
Network string // Network on which the contract is deployed; default empty "" is Ethereum mainnet
|
||||
StartingBlock int64 // Starting block of the contract
|
||||
LastBlock int64 // Most recent block on the network
|
||||
Abi string // Abi string
|
||||
ParsedAbi abi.ABI // Parsed abi
|
||||
Events map[string]types.Event // Map of events to their names
|
||||
Methods map[string]types.Method // Map of methods to their names
|
||||
Filters map[string]filters.LogFilter // Map of event filters to their names
|
||||
EventAddrs map[string]bool // User-input list of account addresses to watch events for
|
||||
MethodAddrs map[string]bool // User-input list of account addresses to poll methods for
|
||||
TknHolderAddrs map[string]bool // List of all contract-associated addresses, populated as events are transformed
|
||||
}
|
||||
|
||||
// Use contract info to generate event filters
|
||||
func (c *Contract) GenerateFilters() error {
|
||||
c.Filters = map[string]filters.LogFilter{}
|
||||
|
||||
for name, event := range c.Events {
|
||||
c.Filters[name] = filters.LogFilter{
|
||||
Name: name,
|
||||
FromBlock: c.StartingBlock,
|
||||
ToBlock: -1,
|
||||
Address: c.Address,
|
||||
Topics: core.Topics{helpers.GenerateSignature(event.Sig())}, // move generate signatrue to pkg
|
||||
}
|
||||
}
|
||||
// If no filters were generated, throw an error (no point in continuing with this contract)
|
||||
if len(c.Filters) == 0 {
|
||||
return errors.New("error: no filters created")
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Returns true if address is in list of addresses to
|
||||
// filter events for or if no filtering is specified
|
||||
func (c *Contract) IsEventAddr(addr string) bool {
|
||||
if c.EventAddrs == nil {
|
||||
return false
|
||||
} else if len(c.EventAddrs) == 0 {
|
||||
return true
|
||||
} else if a, ok := c.EventAddrs[addr]; ok {
|
||||
return a
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// Returns true if address is in list of addresses to
|
||||
// poll methods for or if no filtering is specified
|
||||
func (c *Contract) IsMethodAddr(addr string) bool {
|
||||
if c.MethodAddrs == nil {
|
||||
return false
|
||||
} else if len(c.MethodAddrs) == 0 {
|
||||
return true
|
||||
} else if a, ok := c.MethodAddrs[addr]; ok {
|
||||
return a
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// Returns true if mapping value matches filtered for address or if not filter exists
|
||||
// Used to check if an event log name-value mapping should be filtered or not
|
||||
func (c *Contract) PassesEventFilter(args map[string]string) bool {
|
||||
for _, arg := range args {
|
||||
if c.IsEventAddr(arg) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// Used to add an address to the token holder address list
|
||||
// if it is on the method polling list or the filter is open
|
||||
func (c *Contract) AddTokenHolderAddress(addr string) {
|
||||
if c.TknHolderAddrs != nil && c.IsMethodAddr(addr) {
|
||||
c.TknHolderAddrs[addr] = true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
// VulcanizeDB
|
||||
// Copyright © 2018 Vulcanize
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package contract_test
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"testing"
|
||||
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
func TestContract(t *testing.T) {
|
||||
RegisterFailHandler(Fail)
|
||||
RunSpecs(t, "Contract Suite Test")
|
||||
}
|
||||
|
||||
var _ = BeforeSuite(func() {
|
||||
log.SetOutput(ioutil.Discard)
|
||||
})
|
||||
@@ -0,0 +1,233 @@
|
||||
// VulcanizeDB
|
||||
// Copyright © 2018 Vulcanize
|
||||
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Affero General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Affero General Public License for more details.
|
||||
|
||||
// You should have received a copy of the GNU Affero General Public License
|
||||
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package contract_test
|
||||
|
||||
import (
|
||||
. "github.com/onsi/ginkgo"
|
||||
. "github.com/onsi/gomega"
|
||||
|
||||
"github.com/vulcanize/vulcanizedb/pkg/omni/shared/contract"
|
||||
"github.com/vulcanize/vulcanizedb/pkg/omni/shared/helpers/test_helpers"
|
||||
)
|
||||
|
||||
var _ = Describe("Contract", func() {
|
||||
var err error
|
||||
var info *contract.Contract
|
||||
var wantedEvents = []string{"Transfer", "Approval"}
|
||||
|
||||
Describe("GenerateFilters", func() {
|
||||
|
||||
It("Generates filters from contract data", func() {
|
||||
info = test_helpers.SetupTusdContract(wantedEvents, nil)
|
||||
err = info.GenerateFilters()
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
val, ok := info.Filters["Transfer"]
|
||||
Expect(ok).To(Equal(true))
|
||||
Expect(val).To(Equal(test_helpers.ExpectedTransferFilter))
|
||||
|
||||
val, ok = info.Filters["Approval"]
|
||||
Expect(ok).To(Equal(true))
|
||||
Expect(val).To(Equal(test_helpers.ExpectedApprovalFilter))
|
||||
|
||||
val, ok = info.Filters["Mint"]
|
||||
Expect(ok).To(Equal(false))
|
||||
|
||||
})
|
||||
|
||||
It("Fails with an empty contract", func() {
|
||||
info = &contract.Contract{}
|
||||
err = info.GenerateFilters()
|
||||
Expect(err).To(HaveOccurred())
|
||||
})
|
||||
})
|
||||
|
||||
Describe("IsEventAddr", func() {
|
||||
|
||||
BeforeEach(func() {
|
||||
info = &contract.Contract{}
|
||||
info.MethodAddrs = map[string]bool{}
|
||||
info.EventAddrs = map[string]bool{}
|
||||
})
|
||||
|
||||
It("Returns true if address is in event address filter list", func() {
|
||||
info.EventAddrs["testAddress1"] = true
|
||||
info.EventAddrs["testAddress2"] = true
|
||||
|
||||
is := info.IsEventAddr("testAddress1")
|
||||
Expect(is).To(Equal(true))
|
||||
is = info.IsEventAddr("testAddress2")
|
||||
Expect(is).To(Equal(true))
|
||||
|
||||
info.MethodAddrs["testAddress3"] = true
|
||||
is = info.IsEventAddr("testAddress3")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
|
||||
It("Returns true if event address filter is empty (no filter)", func() {
|
||||
is := info.IsEventAddr("testAddress1")
|
||||
Expect(is).To(Equal(true))
|
||||
is = info.IsEventAddr("testAddress2")
|
||||
Expect(is).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Returns false if address is not in event address filter list", func() {
|
||||
info.EventAddrs["testAddress1"] = true
|
||||
info.EventAddrs["testAddress2"] = true
|
||||
|
||||
is := info.IsEventAddr("testAddress3")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
|
||||
It("Returns false if event address filter is nil (block all)", func() {
|
||||
info.EventAddrs = nil
|
||||
|
||||
is := info.IsEventAddr("testAddress1")
|
||||
Expect(is).To(Equal(false))
|
||||
is = info.IsEventAddr("testAddress2")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("IsMethodAddr", func() {
|
||||
BeforeEach(func() {
|
||||
info = &contract.Contract{}
|
||||
info.MethodAddrs = map[string]bool{}
|
||||
info.EventAddrs = map[string]bool{}
|
||||
})
|
||||
|
||||
It("Returns true if address is in method address filter list", func() {
|
||||
info.MethodAddrs["testAddress1"] = true
|
||||
info.MethodAddrs["testAddress2"] = true
|
||||
|
||||
is := info.IsMethodAddr("testAddress1")
|
||||
Expect(is).To(Equal(true))
|
||||
is = info.IsMethodAddr("testAddress2")
|
||||
Expect(is).To(Equal(true))
|
||||
|
||||
info.EventAddrs["testAddress3"] = true
|
||||
is = info.IsMethodAddr("testAddress3")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
|
||||
It("Returns true if method address filter list is empty (no filter)", func() {
|
||||
is := info.IsMethodAddr("testAddress1")
|
||||
Expect(is).To(Equal(true))
|
||||
is = info.IsMethodAddr("testAddress2")
|
||||
Expect(is).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Returns false if address is not in method address filter list", func() {
|
||||
info.MethodAddrs["testAddress1"] = true
|
||||
info.MethodAddrs["testAddress2"] = true
|
||||
|
||||
is := info.IsMethodAddr("testAddress3")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
|
||||
It("Returns false if method address filter list is nil (block all)", func() {
|
||||
info.MethodAddrs = nil
|
||||
|
||||
is := info.IsMethodAddr("testAddress1")
|
||||
Expect(is).To(Equal(false))
|
||||
is = info.IsMethodAddr("testAddress2")
|
||||
Expect(is).To(Equal(false))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("PassesEventFilter", func() {
|
||||
var mapping map[string]string
|
||||
BeforeEach(func() {
|
||||
info = &contract.Contract{}
|
||||
info.EventAddrs = map[string]bool{}
|
||||
mapping = map[string]string{}
|
||||
|
||||
})
|
||||
|
||||
It("Return true if event log name-value mapping has filtered for address as a value", func() {
|
||||
info.EventAddrs["testAddress1"] = true
|
||||
info.EventAddrs["testAddress2"] = true
|
||||
|
||||
mapping["testInputName1"] = "testAddress1"
|
||||
mapping["testInputName2"] = "testAddress2"
|
||||
mapping["testInputName3"] = "testAddress3"
|
||||
|
||||
pass := info.PassesEventFilter(mapping)
|
||||
Expect(pass).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Return true if event address filter list is empty (no filter)", func() {
|
||||
mapping["testInputName1"] = "testAddress1"
|
||||
mapping["testInputName2"] = "testAddress2"
|
||||
mapping["testInputName3"] = "testAddress3"
|
||||
|
||||
pass := info.PassesEventFilter(mapping)
|
||||
Expect(pass).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Return false if event log name-value mapping does not have filtered for address as a value", func() {
|
||||
info.EventAddrs["testAddress1"] = true
|
||||
info.EventAddrs["testAddress2"] = true
|
||||
|
||||
mapping["testInputName3"] = "testAddress3"
|
||||
|
||||
pass := info.PassesEventFilter(mapping)
|
||||
Expect(pass).To(Equal(false))
|
||||
})
|
||||
|
||||
It("Return false if event address filter list is nil (block all)", func() {
|
||||
info.EventAddrs = nil
|
||||
|
||||
mapping["testInputName1"] = "testAddress1"
|
||||
mapping["testInputName2"] = "testAddress2"
|
||||
mapping["testInputName3"] = "testAddress3"
|
||||
|
||||
pass := info.PassesEventFilter(mapping)
|
||||
Expect(pass).To(Equal(false))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("AddTokenHolderAddress", func() {
|
||||
BeforeEach(func() {
|
||||
info = &contract.Contract{}
|
||||
info.EventAddrs = map[string]bool{}
|
||||
info.MethodAddrs = map[string]bool{}
|
||||
info.TknHolderAddrs = map[string]bool{}
|
||||
})
|
||||
|
||||
It("Adds address to list if it is on the method filter address list", func() {
|
||||
info.MethodAddrs["testAddress2"] = true
|
||||
info.AddTokenHolderAddress("testAddress2")
|
||||
b := info.TknHolderAddrs["testAddress2"]
|
||||
Expect(b).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Adds address to list if method filter is empty", func() {
|
||||
info.AddTokenHolderAddress("testAddress2")
|
||||
b := info.TknHolderAddrs["testAddress2"]
|
||||
Expect(b).To(Equal(true))
|
||||
})
|
||||
|
||||
It("Does not add address to list if both filters are closed (nil)", func() {
|
||||
info.EventAddrs = nil // close both
|
||||
info.MethodAddrs = nil
|
||||
info.AddTokenHolderAddress("testAddress1")
|
||||
b := info.TknHolderAddrs["testAddress1"]
|
||||
Expect(b).To(Equal(false))
|
||||
})
|
||||
})
|
||||
})
|
||||
Reference in New Issue
Block a user