// Package client provides an interface for interacting with a running ethereum full node. // As part of the initial phases of sharding, actors will need access to the sharding management // contract on the main PoW chain. package client import ( "bufio" "context" "errors" "fmt" "math/big" "os" "time" ethereum "github.com/ethereum/go-ethereum" "github.com/ethereum/go-ethereum/accounts" "github.com/ethereum/go-ethereum/accounts/abi/bind" "github.com/ethereum/go-ethereum/accounts/keystore" "github.com/ethereum/go-ethereum/cmd/utils" "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/core/types" "github.com/ethereum/go-ethereum/ethclient" "github.com/ethereum/go-ethereum/log" "github.com/ethereum/go-ethereum/node" "github.com/ethereum/go-ethereum/rpc" "github.com/ethereum/go-ethereum/sharding" "github.com/ethereum/go-ethereum/sharding/contracts" cli "gopkg.in/urfave/cli.v1" ) const ( clientIdentifier = "geth" // Used to determine the ipc name. ) // General client for Notary/Proposer - Communicates to Geth node via JSON RPC. type shardingClient struct { endpoint string // Endpoint to JSON RPC. client *ethclient.Client // Ethereum RPC client. keystore *keystore.KeyStore // Keystore containing the single signer. ctx *cli.Context // Command line context. smc *contracts.SMC // The deployed sharding management contract. rpcClient *rpc.Client // The RPC client connection to the main geth node. } // Client methods that must be implemented to run a sharded system. type Client interface { Start() error Close() CreateTXOpts(*big.Int) (*bind.TransactOpts, error) ChainReader() ethereum.ChainReader Account() *accounts.Account SMCCaller() *contracts.SMCCaller SMCTransactor() *contracts.SMCTransactor DepositFlagSet() bool } // NewClient forms a new struct instance. func NewClient(ctx *cli.Context) Client { path := node.DefaultDataDir() if ctx.GlobalIsSet(utils.DataDirFlag.Name) { path = ctx.GlobalString(utils.DataDirFlag.Name) } endpoint := ctx.Args().First() if endpoint == "" { endpoint = fmt.Sprintf("%s/%s.ipc", path, clientIdentifier) } if ctx.GlobalIsSet(utils.IPCPathFlag.Name) { endpoint = ctx.GlobalString(utils.IPCPathFlag.Name) } config := &node.Config{ DataDir: path, } scryptN, scryptP, keydir, err := config.AccountConfig() if err != nil { panic(err) // TODO(prestonvanloon): handle this. } ks := keystore.NewKeyStore(keydir, scryptN, scryptP) return &shardingClient{ endpoint: endpoint, keystore: ks, ctx: ctx, } } // Start the sharding client. // Connects to Geth node. // Verifies or deploys the sharding manager contract. func (c *shardingClient) Start() error { rpcClient, err := dialRPC(c.endpoint) if err != nil { return fmt.Errorf("cannot start rpc client. %v", err) } c.rpcClient = rpcClient c.client = ethclient.NewClient(rpcClient) // Check account existence and unlock account before starting notary client. accounts := c.keystore.Accounts() if len(accounts) == 0 { return fmt.Errorf("no accounts found") } if err := c.unlockAccount(accounts[0]); err != nil { return fmt.Errorf("cannot unlock account. %v", err) } smc, err := initSMC(c) if err != nil { return err } c.smc = smc return nil } // Close the RPC client connection. func (c *shardingClient) Close() { c.rpcClient.Close() } // UnlockAccount will unlock the specified account using utils.PasswordFileFlag or empty string if unset. func (c *shardingClient) unlockAccount(account accounts.Account) error { pass := "" if c.ctx.GlobalIsSet(utils.PasswordFileFlag.Name) { file, err := os.Open(c.ctx.GlobalString(utils.PasswordFileFlag.Name)) if err != nil { return fmt.Errorf("unable to open file containing account password %s. %v", utils.PasswordFileFlag.Value, err) } scanner := bufio.NewScanner(file) scanner.Split(bufio.ScanWords) if !scanner.Scan() { err = scanner.Err() if err != nil { return fmt.Errorf("unable to read contents of file %v", err) } return errors.New("password not found in file") } pass = scanner.Text() } return c.keystore.Unlock(account, pass) } // CreateTXOpts creates a *TransactOpts with a signer using the default account on the keystore. func (c *shardingClient) CreateTXOpts(value *big.Int) (*bind.TransactOpts, error) { account := c.Account() return &bind.TransactOpts{ From: account.Address, Value: value, Signer: func(signer types.Signer, addr common.Address, tx *types.Transaction) (*types.Transaction, error) { networkID, err := c.client.NetworkID(context.Background()) if err != nil { return nil, fmt.Errorf("unable to fetch networkID: %v", err) } return c.keystore.SignTx(*account, tx, networkID /* chainID */) }, }, nil } // Account to use for sharding transactions. func (c *shardingClient) Account() *accounts.Account { accounts := c.keystore.Accounts() return &accounts[0] } // ChainReader for interacting with the chain. func (c *shardingClient) ChainReader() ethereum.ChainReader { return ethereum.ChainReader(c.client) } // Client to interact with ethereum node. func (c *shardingClient) ethereumClient() *ethclient.Client { return c.client } // SMCCaller to interact with the sharding manager contract. func (c *shardingClient) SMCCaller() *contracts.SMCCaller { return &c.smc.SMCCaller } // SMCTransactor allows us to send tx's to the SMC programmatically. func (c *shardingClient) SMCTransactor() *contracts.SMCTransactor { return &c.smc.SMCTransactor } // dialRPC endpoint to node. func dialRPC(endpoint string) (*rpc.Client, error) { if endpoint == "" { endpoint = node.DefaultIPCEndpoint(clientIdentifier) } return rpc.Dial(endpoint) } // initSMC initializes the sharding manager contract bindings. // If the SMC does not exist, it will be deployed. func initSMC(c *shardingClient) (*contracts.SMC, error) { b, err := c.client.CodeAt(context.Background(), sharding.ShardingManagerAddress, nil) if err != nil { return nil, fmt.Errorf("unable to get contract code at %s: %v", sharding.ShardingManagerAddress, err) } // Deploy SMC for development only. // TODO: Separate contract deployment from the sharding client. It would only need to be deployed // once on the mainnet, so this code would not need to ship with the client. if len(b) == 0 { log.Info(fmt.Sprintf("No sharding manager contract found at %s. Deploying new contract.", sharding.ShardingManagerAddress.String())) txOps, err := c.CreateTXOpts(big.NewInt(0)) if err != nil { return nil, fmt.Errorf("unable to intiate the transaction: %v", err) } addr, tx, contract, err := contracts.DeploySMC(txOps, c.client) if err != nil { return nil, fmt.Errorf("unable to deploy sharding manager contract: %v", err) } for pending := true; pending; _, pending, err = c.client.TransactionByHash(context.Background(), tx.Hash()) { if err != nil { return nil, fmt.Errorf("unable to get transaction by hash: %v", err) } time.Sleep(1 * time.Second) } log.Info(fmt.Sprintf("New contract deployed at %s", addr.String())) return contract, nil } contract, err := contracts.NewSMC(sharding.ShardingManagerAddress, c.client) if err != nil { } return contract, nil } func (c *shardingClient) DepositFlagSet() bool { return c.ctx.GlobalBool(utils.DepositFlag.Name) }