aboutsummaryrefslogblamecommitdiffstats
path: root/rpc/packages.go
blob: b51bde7ce0bb8add66faf890f6d306b45d4973c6 (plain) (tree)
1
2
3
4
5
6
7
8
  


                                                                                                                    

                                                                                                   

  


           
             

                  
              
              
 
                                              
                                                    
                                                
                                               
                                                 

                                                      
                                              

 




                                          

                                
                                   

                                           
                           
                                 

                                
                                          


                                                                 

                           

 
                                                  
                                              
                            
                                   
                                                   
                                                                                 

                                                            
                                  

                                    
                      

                  

 





























                                                                            


                                                                                   
                                                
                                                     

                                          
 
                                          

                                                     

                                                       




                   






                                                                            




                                                                                 


                                          




                                                                       












                                                     
                                                                          

                                  
 


                                                    




                                                                 


                                  
                                                  


                                              

                  

 








                                                                                 




                                                                              
 
                                 
                                                               
                
                                                      

                  

 
                                                                           





                                               
         
 






                                                                                                                                 
 








                                                                                                                       

                       

 

                                                                          
                       
                          
         
                                           

                       

 
                                                                                
                                  
                       
                          
         
 
                                                     
 
                                              







                                                                           











                                                                                    
                  

 
                                                              
                                   



                                                                
                                     



                                                             
                                  


                  




                                                          
                                                             
                                  


                  




                                                                            




                                                                        



                                                                                    
         
                                               


                  
                                                                                    



                                  
                                                     
                                               


                  




                                                                                
                                            


                  














                                                                               
                                                                      
                                                       


                  





















                                                                     









                                                                                      



                                                                            






                                                                            

                                       
 


                                                




                                                                                       
                                                                                                           







                          









                                                                                 
                                                                                  
                                                                       
                                                               






                                              





                                               

                                            



                                           


















                                                   






                                                  









                                                    





                                              





                                              





                                               





                                                     





                                                        
                           
                                           



                                                   
                              
                                           



                                          





                                               
                            
                                        
                          

















                                                 







                                                    





                                             











                                              








                                                      
                                           






                                                     
                                  

                                                 






                                                           
                                           



                                                     
                
                                                                                              

         
                                                            

                  





















                                                                                

                                                 








                                  
/*
For each request type, define the following:

1. RpcRequest "To" method [message.go], which does basic validation and conversion to "Args" type via json.Decoder()
2. json.Decoder() calls "UnmarshalON" defined on each "Args" struct
3. EthereumApi method, taking the "Args" type and replying with an interface to be marshalled to ON

*/
package rpc

import (
    "fmt"
    "math/big"
    "strings"
    "sync"
    "time"

    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/ethutil"
    "github.com/ethereum/go-ethereum/event/filter"
    "github.com/ethereum/go-ethereum/state"
    "github.com/ethereum/go-ethereum/xeth"
)

const (
    defaultGasPrice = "10000000000000"
    defaultGas      = "10000"
)

type EthereumApi struct {
    xeth          *xeth.XEth
    quit          chan struct{}
    filterManager *filter.FilterManager

    logMut sync.RWMutex
    logs   map[int]*logFilter

    messagesMut sync.RWMutex
    messages    map[int]*whisperFilter
    // Register keeps a list of accounts and transaction data
    regmut   sync.Mutex
    register map[string][]*NewTxArgs

    db ethutil.Database
}

func NewEthereumApi(eth *xeth.XEth) *EthereumApi {
    db, _ := ethdb.NewLDBDatabase("dapps")
    api := &EthereumApi{
        xeth:          eth,
        quit:          make(chan struct{}),
        filterManager: filter.NewFilterManager(eth.Backend().EventMux()),
        logs:          make(map[int]*logFilter),
        messages:      make(map[int]*whisperFilter),
        db:            db,
    }
    go api.filterManager.Start()
    go api.start()

    return api
}

func (self *EthereumApi) Register(args string, reply *interface{}) error {
    self.regmut.Lock()
    defer self.regmut.Unlock()

    if _, ok := self.register[args]; ok {
        self.register[args] = nil // register with empty
    }
    return nil
}

func (self *EthereumApi) Unregister(args string, reply *interface{}) error {
    self.regmut.Lock()
    defer self.regmut.Unlock()

    delete(self.register, args)

    return nil
}

func (self *EthereumApi) WatchTx(args string, reply *interface{}) error {
    self.regmut.Lock()
    defer self.regmut.Unlock()

    txs := self.register[args]
    self.register[args] = nil

    *reply = txs
    return nil
}

func (self *EthereumApi) NewFilter(args *FilterOptions, reply *interface{}) error {
    var id int
    filter := core.NewFilter(self.xeth.Backend())
    filter.SetOptions(toFilterOptions(args))
    filter.LogsCallback = func(logs state.Logs) {
        self.logMut.Lock()
        defer self.logMut.Unlock()

        self.logs[id].add(logs...)
    }
    id = self.filterManager.InstallFilter(filter)
    self.logs[id] = &logFilter{timeout: time.Now()}

    *reply = id

    return nil
}

func (self *EthereumApi) UninstallFilter(id int, reply *interface{}) error {
    delete(self.logs, id)
    self.filterManager.UninstallFilter(id)
    *reply = true
    return nil
}

func (self *EthereumApi) NewFilterString(args string, reply *interface{}) error {
    var id int
    filter := core.NewFilter(self.xeth.Backend())

    callback := func(block *types.Block) {
        self.logMut.Lock()
        defer self.logMut.Unlock()

        if self.logs[id] == nil {
            self.logs[id] = &logFilter{timeout: time.Now()}
        }

        self.logs[id].add(&state.StateLog{})
    }
    if args == "pending" {
        filter.PendingCallback = callback
    } else if args == "chain" {
        filter.BlockCallback = callback
    }

    id = self.filterManager.InstallFilter(filter)
    *reply = id

    return nil
}

func (self *EthereumApi) FilterChanged(id int, reply *interface{}) error {
    self.logMut.Lock()
    defer self.logMut.Unlock()

    if self.logs[id] != nil {
        *reply = toLogs(self.logs[id].get())
    }

    return nil
}

func (self *EthereumApi) Logs(id int, reply *interface{}) error {
    self.logMut.Lock()
    defer self.logMut.Unlock()

    filter := self.filterManager.GetFilter(id)
    if filter != nil {
        *reply = toLogs(filter.Find())
    }

    return nil
}

func (self *EthereumApi) AllLogs(args *FilterOptions, reply *interface{}) error {
    filter := core.NewFilter(self.xeth.Backend())
    filter.SetOptions(toFilterOptions(args))

    *reply = toLogs(filter.Find())

    return nil
}

func (p *EthereumApi) GetBlock(args *GetBlockArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }

    if args.BlockNumber > 0 {
        *reply = p.xeth.BlockByNumber(args.BlockNumber)
    } else {
        *reply = p.xeth.BlockByHash(args.Hash)
    }
    return nil
}

func (p *EthereumApi) Transact(args *NewTxArgs, reply *interface{}) error {
    if len(args.Gas) == 0 {
        args.Gas = defaultGas
    }

    if len(args.GasPrice) == 0 {
        args.GasPrice = defaultGasPrice
    }

    // TODO if no_private_key then
    if _, exists := p.register[args.From]; exists {
        p.register[args.From] = append(p.register[args.From], args)
    } else {
        result, _ := p.xeth.Transact( /* TODO specify account */ args.To, args.Value, args.Gas, args.GasPrice, args.Data)
        *reply = result
    }

    return nil
}

func (p *EthereumApi) Call(args *NewTxArgs, reply *interface{}) error {
    result, err := p.xeth.Call( /* TODO specify account */ args.To, args.Value, args.Gas, args.GasPrice, args.Data)
    if err != nil {
        return err
    }

    *reply = result
    return nil
}

func (p *EthereumApi) PushTx(args *PushTxArgs, reply *interface{}) error {
    err := args.requirementsPushTx()
    if err != nil {
        return err
    }
    result, _ := p.xeth.PushTx(args.Tx)
    *reply = result
    return nil
}

func (p *EthereumApi) GetStateAt(args *GetStateArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }

    state := p.xeth.State().SafeGet(args.Address)

    value := state.StorageString(args.Key)
    var hx string
    if strings.Index(args.Key, "0x") == 0 {
        hx = string([]byte(args.Key)[2:])
    } else {
        // Convert the incoming string (which is a bigint) into hex
        i, _ := new(big.Int).SetString(args.Key, 10)
        hx = ethutil.Bytes2Hex(i.Bytes())
    }
    rpclogger.Debugf("GetStateAt(%s, %s)\n", args.Address, hx)
    *reply = map[string]string{args.Key: value.Str()}
    return nil
}

func (p *EthereumApi) GetStorageAt(args *GetStorageArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }

    *reply = p.xeth.State().SafeGet(args.Address).Storage()
    return nil
}

func (p *EthereumApi) GetPeerCount(reply *interface{}) error {
    *reply = p.xeth.PeerCount()
    return nil
}

func (p *EthereumApi) GetIsListening(reply *interface{}) error {
    *reply = p.xeth.IsListening()
    return nil
}

func (p *EthereumApi) GetCoinbase(reply *interface{}) error {
    *reply = p.xeth.Coinbase()
    return nil
}

func (p *EthereumApi) Accounts(reply *interface{}) error {
    *reply = p.xeth.Accounts()
    return nil
}

func (p *EthereumApi) GetIsMining(reply *interface{}) error {
    *reply = p.xeth.IsMining()
    return nil
}

func (p *EthereumApi) SetMining(shouldmine bool, reply *interface{}) error {
    *reply = p.xeth.SetMining(shouldmine)
    return nil
}

func (p *EthereumApi) BlockNumber(reply *interface{}) error {
    *reply = p.xeth.Backend().ChainManager().CurrentBlock().Number()
    return nil
}

func (p *EthereumApi) GetTxCountAt(args *GetTxCountArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }
    *reply = p.xeth.TxCountAt(args.Address)
    return nil
}

func (p *EthereumApi) GetBalanceAt(args *GetBalanceArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }
    state := p.xeth.State().SafeGet(args.Address)
    *reply = toHex(state.Balance().Bytes())
    return nil
}

func (p *EthereumApi) GetCodeAt(args *GetCodeAtArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }
    *reply = p.xeth.CodeAt(args.Address)
    return nil
}

func (p *EthereumApi) GetCompilers(reply *interface{}) error {
    c := []string{"serpent"}
    *reply = c
    return nil
}

func (p *EthereumApi) CompileSerpent(script string, reply *interface{}) error {
    res, err := ethutil.Compile(script, false)
    if err != nil {
        return err
    }
    *reply = res
    return nil
}

func (p *EthereumApi) Sha3(args *Sha3Args, reply *interface{}) error {
    *reply = toHex(crypto.Sha3(fromHex(args.Data)))
    return nil
}

func (p *EthereumApi) DbPut(args *DbArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }

    p.db.Put([]byte(args.Database+args.Key), []byte(args.Value))
    *reply = true
    return nil
}

func (p *EthereumApi) DbGet(args *DbArgs, reply *interface{}) error {
    err := args.requirements()
    if err != nil {
        return err
    }

    res, _ := p.db.Get([]byte(args.Database + args.Key))
    *reply = string(res)
    return nil
}

func (p *EthereumApi) NewWhisperIdentity(reply *interface{}) error {
    *reply = p.xeth.Whisper().NewIdentity()
    return nil
}

func (p *EthereumApi) NewWhisperFilter(args *xeth.Options, reply *interface{}) error {
    var id int
    args.Fn = func(msg xeth.WhisperMessage) {
        p.messagesMut.Lock()
        defer p.messagesMut.Unlock()
        if p.messages[id] == nil {
            p.messages[id] = &whisperFilter{timeout: time.Now()}
        }
        p.messages[id].add(msg) // = append(p.messages[id], msg)
    }
    id = p.xeth.Whisper().Watch(args)
    *reply = id
    return nil
}

func (self *EthereumApi) MessagesChanged(id int, reply *interface{}) error {
    self.messagesMut.Lock()
    defer self.messagesMut.Unlock()

    if self.messages[id] != nil {
        *reply = self.messages[id].get()
    }

    return nil
}

func (p *EthereumApi) WhisperPost(args *WhisperMessageArgs, reply *interface{}) error {
    err := p.xeth.Whisper().Post(args.Payload, args.To, args.From, args.Topic, args.Priority, args.Ttl)
    if err != nil {
        return err
    }

    *reply = true
    return nil
}

func (p *EthereumApi) HasWhisperIdentity(args string, reply *interface{}) error {
    *reply = p.xeth.Whisper().HasIdentity(args)
    return nil
}

func (p *EthereumApi) WhisperMessages(id int, reply *interface{}) error {
    *reply = p.xeth.Whisper().Messages(id)
    return nil
}

func (p *EthereumApi) GetRequestReply(req *RpcRequest, reply *interface{}) error {
    // Spec at https://github.com/ethereum/wiki/wiki/Generic-ON-RPC
    rpclogger.DebugDetailf("%T %s", req.Params, req.Params)
    switch req.Method {
    case "eth_coinbase":
        return p.GetCoinbase(reply)
    case "eth_listening":
        return p.GetIsListening(reply)
    case "eth_mining":
        return p.GetIsMining(reply)
    case "eth_setMining":
        args, err := req.ToBoolArgs()
        if err != nil {
            return err
        }
        return p.SetMining(args, reply)
    case "eth_peerCount":
        return p.GetPeerCount(reply)
    case "eth_number":
        return p.BlockNumber(reply)
    case "eth_accounts":
        return p.Accounts(reply)
    case "eth_countAt":
        args, err := req.ToGetTxCountArgs()
        if err != nil {
            return err
        }
        return p.GetTxCountAt(args, reply)
    case "eth_codeAt":
        args, err := req.ToGetCodeAtArgs()
        if err != nil {
            return err
        }
        return p.GetCodeAt(args, reply)
    case "eth_balanceAt":
        args, err := req.ToGetBalanceArgs()
        if err != nil {
            return err
        }
        return p.GetBalanceAt(args, reply)
    case "eth_stateAt":
        args, err := req.ToGetStateArgs()
        if err != nil {
            return err
        }
        return p.GetStateAt(args, reply)
    case "eth_storageAt":
        args, err := req.ToStorageAtArgs()
        if err != nil {
            return err
        }
        return p.GetStorageAt(args, reply)
    case "eth_blockByNumber", "eth_blockByHash":
        args, err := req.ToGetBlockArgs()
        if err != nil {
            return err
        }
        return p.GetBlock(args, reply)
    case "eth_transact":
        args, err := req.ToNewTxArgs()
        if err != nil {
            return err
        }
        return p.Transact(args, reply)
    case "eth_call":
        args, err := req.ToNewTxArgs()
        if err != nil {
            return err
        }
        return p.Call(args, reply)
    case "eth_newFilter":
        args, err := req.ToFilterArgs()
        if err != nil {
            return err
        }
        return p.NewFilter(args, reply)
    case "eth_newFilterString":
        args, err := req.ToFilterStringArgs()
        if err != nil {
            return err
        }
        return p.NewFilterString(args, reply)
    case "eth_uninstallFilter":
        args, err := req.ToUninstallFilterArgs()
        if err != nil {
            return err
        }
        return p.UninstallFilter(args, reply)
    case "eth_changed":
        args, err := req.ToIdArgs()
        if err != nil {
            return err
        }
        return p.FilterChanged(args, reply)
    case "eth_filterLogs":
        args, err := req.ToIdArgs()
        if err != nil {
            return err
        }
        return p.Logs(args, reply)
    case "eth_logs":
        args, err := req.ToFilterArgs()
        if err != nil {
            return err
        }
        return p.AllLogs(args, reply)
    case "eth_gasPrice":
        *reply = defaultGasPrice
        return nil
    case "eth_register":
        args, err := req.ToRegisterArgs()
        if err != nil {
            return err
        }
        return p.Register(args, reply)
    case "eth_unregister":
        args, err := req.ToRegisterArgs()
        if err != nil {
            return err
        }
        return p.Unregister(args, reply)
    case "eth_watchTx":
        args, err := req.ToWatchTxArgs()
        if err != nil {
            return err
        }
        return p.WatchTx(args, reply)
    case "eth_compilers":
        return p.GetCompilers(reply)
    case "eth_serpent":
        args, err := req.ToCompileArgs()
        if err != nil {
            return err
        }
        return p.CompileSerpent(args, reply)
    case "web3_sha3":
        args, err := req.ToSha3Args()
        if err != nil {
            return err
        }
        return p.Sha3(args, reply)
    case "db_put":
        args, err := req.ToDbPutArgs()
        if err != nil {
            return err
        }
        return p.DbPut(args, reply)
    case "db_get":
        args, err := req.ToDbGetArgs()
        if err != nil {
            return err
        }
        return p.DbGet(args, reply)
    case "shh_newIdentity":
        return p.NewWhisperIdentity(reply)
    case "shh_newFilter":
        args, err := req.ToWhisperFilterArgs()
        if err != nil {
            return err
        }
        return p.NewWhisperFilter(args, reply)
    case "shh_changed":
        args, err := req.ToIdArgs()
        if err != nil {
            return err
        }
        return p.MessagesChanged(args, reply)
    case "shh_post":
        args, err := req.ToWhisperPostArgs()
        if err != nil {
            return err
        }
        return p.WhisperPost(args, reply)
    case "shh_haveIdentity":
        args, err := req.ToWhisperHasIdentityArgs()
        if err != nil {
            return err
        }
        return p.HasWhisperIdentity(args, reply)
    case "shh_getMessages":
        args, err := req.ToIdArgs()
        if err != nil {
            return err
        }
        return p.WhisperMessages(args, reply)
    default:
        return NewErrorResponse(fmt.Sprintf("%v %s", ErrorNotImplemented, req.Method))
    }

    rpclogger.DebugDetailf("Reply: %T %s", reply, reply)
    return nil
}

var filterTickerTime = 15 * time.Second

func (self *EthereumApi) start() {
    timer := time.NewTicker(filterTickerTime)
done:
    for {
        select {
        case <-timer.C:
            self.logMut.Lock()
            self.messagesMut.Lock()
            for id, filter := range self.logs {
                if time.Since(filter.timeout) > 20*time.Second {
                    delete(self.logs, id)
                }
            }

            for id, filter := range self.messages {
                if time.Since(filter.timeout) > 20*time.Second {
                    delete(self.messages, id)
                }
            }
            self.logMut.Unlock()
            self.messagesMut.Unlock()
        case <-self.quit:
            break done
        }
    }
}

func (self *EthereumApi) stop() {
    close(self.quit)
}