contract

package

v1.4.0 Latest Latest Go to latest Published: Dec 15, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Sifchain/sifnode

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CompileContracts(contracts BridgeContracts) error
func GenerateBindings(contracts BridgeContracts) error
func LoadABI(contractType txs.ContractRegistry) abi.ABI
type BridgeContract
- func (d BridgeContract) String() string
type BridgeContracts
- func LoadBridgeContracts() BridgeContracts

Constants ¶

View Source

const (
	BridgeBankABI   = "/generated/abi/BridgeBank/BridgeBank.abi"
	CosmosBridgeABI = "/generated/abi/CosmosBridge/CosmosBridge.abi"
)

File paths to Peggy smart contract ABIs

View Source

const (
	SolcCmdText   = "[SOLC_CMD]"
	DirectoryText = "[DIRECTORY]"
	ContractText  = "[CONTRACT]"
)

Variables ¶

View Source

var (
	// BaseABIBINGenCmd is the base command for contract compilation to ABI and BIN
	BaseABIBINGenCmd = strings.Join([]string{"solc ",
		fmt.Sprintf("--%s ./contracts/%s%s.sol ", SolcCmdText, DirectoryText, ContractText),
		fmt.Sprintf("-o ../cmd/ebrelayer/contract/generated/%s/%s ", SolcCmdText, ContractText),
		"--overwrite ",
		"--allow-paths *,"},
		"")
	// BaseBindingGenCmd is the base command for contract binding generation
	BaseBindingGenCmd = strings.Join([]string{"abigen ",
		fmt.Sprintf("--bin ../cmd/ebrelayer/contract/generated/bin/%s/%s.bin ", ContractText, ContractText),
		fmt.Sprintf("--abi ../cmd/ebrelayer/contract/generated/abi/%s/%s.abi ", ContractText, ContractText),
		fmt.Sprintf("--pkg %s ", ContractText),
		fmt.Sprintf("--type %s ", ContractText),
		fmt.Sprintf("--out ../cmd/ebrelayer/contract/generated/bindings/%s/%s.go", ContractText, ContractText)},
		"")
)

View Source

var BridgeContractToString = [...]string{"BridgeRegistry", "Valset", "Oracle", "CosmosBridge", "BridgeBank"}

BridgeContractToString returns the string associated with a BridgeContract

Functions ¶

func CompileContracts ¶

func CompileContracts(contracts BridgeContracts) error

CompileContracts compiles contracts to BIN and ABI files

func GenerateBindings ¶

func GenerateBindings(contracts BridgeContracts) error

GenerateBindings generates bindings for each contract

func LoadABI ¶

func LoadABI(contractType txs.ContractRegistry) abi.ABI

LoadABI loads a smart contract as an abi.ABI

Types ¶

type BridgeContract ¶

type BridgeContract int

BridgeContract is an enum containing supported contract names

const (
	// BridgeRegistry registers deployed addresses of the other contracts
	BridgeRegistry BridgeContract = iota + 1
	// Valset manages the validator set and signature verification
	Valset
	// Oracle enables validators to make OracleClaims and processes ProphecyClaims
	Oracle
	// CosmosBridge enables validators to make ProphecyClaims
	CosmosBridge
	// BridgeBank manages protocol assets on both Ethereum and Cosmos
	BridgeBank
)

func (BridgeContract) String ¶

func (d BridgeContract) String() string

String returns the BridgeContract as a string

type BridgeContracts ¶

type BridgeContracts []BridgeContract

BridgeContracts is a slice of BridgeContract

func LoadBridgeContracts ¶

func LoadBridgeContracts() BridgeContracts

LoadBridgeContracts loads populated slice of BridgeContract

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
generated
bindings/bridgebank
bindings/bridgeregistry
bindings/cosmosbridge
bindings/oracle
bindings/valset

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL