12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236 |
- // Copyright 2015 The go-ethereum Authors
- // This file is part of the go-ethereum library.
- //
- // The go-ethereum library is free software: you can redistribute it and/or modify
- // it under the terms of the GNU Lesser General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // The go-ethereum library 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 Lesser General Public License for more details.
- //
- // You should have received a copy of the GNU Lesser General Public License
- // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
- package ethapi
- import (
- "bytes"
- "context"
- "encoding/base64"
- "encoding/hex"
- "encoding/json"
- "errors"
- "fmt"
- "math/big"
- "net/http"
- "strings"
- "sync"
- "time"
- "github.com/davecgh/go-spew/spew"
- "github.com/ethereum/go-ethereum/accounts"
- "github.com/ethereum/go-ethereum/accounts/abi"
- "github.com/ethereum/go-ethereum/accounts/keystore"
- "github.com/ethereum/go-ethereum/accounts/pluggable"
- "github.com/ethereum/go-ethereum/accounts/scwallet"
- "github.com/ethereum/go-ethereum/common"
- "github.com/ethereum/go-ethereum/common/hexutil"
- "github.com/ethereum/go-ethereum/common/math"
- "github.com/ethereum/go-ethereum/consensus/clique"
- "github.com/ethereum/go-ethereum/consensus/ethash"
- "github.com/ethereum/go-ethereum/core"
- "github.com/ethereum/go-ethereum/core/mps"
- "github.com/ethereum/go-ethereum/core/state"
- "github.com/ethereum/go-ethereum/core/types"
- "github.com/ethereum/go-ethereum/core/vm"
- "github.com/ethereum/go-ethereum/crypto"
- "github.com/ethereum/go-ethereum/log"
- "github.com/ethereum/go-ethereum/multitenancy"
- "github.com/ethereum/go-ethereum/p2p"
- "github.com/ethereum/go-ethereum/params"
- "github.com/ethereum/go-ethereum/private"
- "github.com/ethereum/go-ethereum/private/engine"
- "github.com/ethereum/go-ethereum/rlp"
- "github.com/ethereum/go-ethereum/rpc"
- "github.com/tyler-smith/go-bip39"
- )
- type TransactionType uint8
- const (
- FillTransaction TransactionType = iota + 1
- RawTransaction
- NormalTransaction
- )
- // PublicEthereumAPI provides an API to access Ethereum related information.
- // It offers only methods that operate on public data that is freely available to anyone.
- type PublicEthereumAPI struct {
- b Backend
- }
- // NewPublicEthereumAPI creates a new Ethereum protocol API.
- func NewPublicEthereumAPI(b Backend) *PublicEthereumAPI {
- return &PublicEthereumAPI{b}
- }
- // GasPrice returns a suggestion for a gas price.
- func (s *PublicEthereumAPI) GasPrice(ctx context.Context) (*hexutil.Big, error) {
- price, err := s.b.SuggestPrice(ctx)
- return (*hexutil.Big)(price), err
- }
- // Syncing returns false in case the node is currently not syncing with the network. It can be up to date or has not
- // yet received the latest block headers from its pears. In case it is synchronizing:
- // - startingBlock: block number this node started to synchronise from
- // - currentBlock: block number this node is currently importing
- // - highestBlock: block number of the highest block header this node has received from peers
- // - pulledStates: number of state entries processed until now
- // - knownStates: number of known state entries that still need to be pulled
- func (s *PublicEthereumAPI) Syncing() (interface{}, error) {
- progress := s.b.Downloader().Progress()
- // Return not syncing if the synchronisation already completed
- if progress.CurrentBlock >= progress.HighestBlock {
- return false, nil
- }
- // Otherwise gather the block sync stats
- return map[string]interface{}{
- "startingBlock": hexutil.Uint64(progress.StartingBlock),
- "currentBlock": hexutil.Uint64(progress.CurrentBlock),
- "highestBlock": hexutil.Uint64(progress.HighestBlock),
- "pulledStates": hexutil.Uint64(progress.PulledStates),
- "knownStates": hexutil.Uint64(progress.KnownStates),
- }, nil
- }
- func (s *PublicEthereumAPI) GetPrivacyPrecompileAddress() common.Address {
- return common.QuorumPrivacyPrecompileContractAddress()
- }
- // PublicTxPoolAPI offers and API for the transaction pool. It only operates on data that is non confidential.
- type PublicTxPoolAPI struct {
- b Backend
- }
- // NewPublicTxPoolAPI creates a new tx pool service that gives information about the transaction pool.
- func NewPublicTxPoolAPI(b Backend) *PublicTxPoolAPI {
- return &PublicTxPoolAPI{b}
- }
- // Content returns the transactions contained within the transaction pool.
- func (s *PublicTxPoolAPI) Content() map[string]map[string]map[string]*RPCTransaction {
- content := map[string]map[string]map[string]*RPCTransaction{
- "pending": make(map[string]map[string]*RPCTransaction),
- "queued": make(map[string]map[string]*RPCTransaction),
- }
- pending, queue := s.b.TxPoolContent()
- // Flatten the pending transactions
- for account, txs := range pending {
- dump := make(map[string]*RPCTransaction)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
- }
- content["pending"][account.Hex()] = dump
- }
- // Flatten the queued transactions
- for account, txs := range queue {
- dump := make(map[string]*RPCTransaction)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = newRPCPendingTransaction(tx)
- }
- content["queued"][account.Hex()] = dump
- }
- return content
- }
- // Status returns the number of pending and queued transaction in the pool.
- func (s *PublicTxPoolAPI) Status() map[string]hexutil.Uint {
- pending, queue := s.b.Stats()
- return map[string]hexutil.Uint{
- "pending": hexutil.Uint(pending),
- "queued": hexutil.Uint(queue),
- }
- }
- // Inspect retrieves the content of the transaction pool and flattens it into an
- // easily inspectable list.
- func (s *PublicTxPoolAPI) Inspect() map[string]map[string]map[string]string {
- content := map[string]map[string]map[string]string{
- "pending": make(map[string]map[string]string),
- "queued": make(map[string]map[string]string),
- }
- pending, queue := s.b.TxPoolContent()
- // Define a formatter to flatten a transaction into a string
- var format = func(tx *types.Transaction) string {
- if to := tx.To(); to != nil {
- return fmt.Sprintf("%s: %v wei + %v gas × %v wei", tx.To().Hex(), tx.Value(), tx.Gas(), tx.GasPrice())
- }
- return fmt.Sprintf("contract creation: %v wei + %v gas × %v wei", tx.Value(), tx.Gas(), tx.GasPrice())
- }
- // Flatten the pending transactions
- for account, txs := range pending {
- dump := make(map[string]string)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
- }
- content["pending"][account.Hex()] = dump
- }
- // Flatten the queued transactions
- for account, txs := range queue {
- dump := make(map[string]string)
- for _, tx := range txs {
- dump[fmt.Sprintf("%d", tx.Nonce())] = format(tx)
- }
- content["queued"][account.Hex()] = dump
- }
- return content
- }
- // PublicAccountAPI provides an API to access accounts managed by this node.
- // It offers only methods that can retrieve accounts.
- type PublicAccountAPI struct {
- am *accounts.Manager
- }
- // NewPublicAccountAPI creates a new PublicAccountAPI.
- func NewPublicAccountAPI(am *accounts.Manager) *PublicAccountAPI {
- return &PublicAccountAPI{am: am}
- }
- // Accounts returns the collection of accounts this node manages
- func (s *PublicAccountAPI) Accounts() []common.Address {
- return s.am.Accounts()
- }
- // PrivateAccountAPI provides an API to access accounts managed by this node.
- // It offers methods to create, (un)lock en list accounts. Some methods accept
- // passwords and are therefore considered private by default.
- type PrivateAccountAPI struct {
- am *accounts.Manager
- nonceLock *AddrLocker
- b Backend
- }
- // NewPrivateAccountAPI create a new PrivateAccountAPI.
- func NewPrivateAccountAPI(b Backend, nonceLock *AddrLocker) *PrivateAccountAPI {
- return &PrivateAccountAPI{
- am: b.AccountManager(),
- nonceLock: nonceLock,
- b: b,
- }
- }
- // listAccounts will return a list of addresses for accounts this node manages.
- func (s *PrivateAccountAPI) ListAccounts() []common.Address {
- return s.am.Accounts()
- }
- // rawWallet is a JSON representation of an accounts.Wallet interface, with its
- // data contents extracted into plain fields.
- type rawWallet struct {
- URL string `json:"url"`
- Status string `json:"status"`
- Failure string `json:"failure,omitempty"`
- Accounts []accounts.Account `json:"accounts,omitempty"`
- }
- // ListWallets will return a list of wallets this node manages.
- func (s *PrivateAccountAPI) ListWallets() []rawWallet {
- wallets := make([]rawWallet, 0) // return [] instead of nil if empty
- for _, wallet := range s.am.Wallets() {
- status, failure := wallet.Status()
- raw := rawWallet{
- URL: wallet.URL().String(),
- Status: status,
- Accounts: wallet.Accounts(),
- }
- if failure != nil {
- raw.Failure = failure.Error()
- }
- wallets = append(wallets, raw)
- }
- return wallets
- }
- // OpenWallet initiates a hardware wallet opening procedure, establishing a USB
- // connection and attempting to authenticate via the provided passphrase. Note,
- // the method may return an extra challenge requiring a second open (e.g. the
- // Trezor PIN matrix challenge).
- func (s *PrivateAccountAPI) OpenWallet(url string, passphrase *string) error {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return err
- }
- pass := ""
- if passphrase != nil {
- pass = *passphrase
- }
- return wallet.Open(pass)
- }
- // DeriveAccount requests a HD wallet to derive a new account, optionally pinning
- // it for later reuse.
- func (s *PrivateAccountAPI) DeriveAccount(url string, path string, pin *bool) (accounts.Account, error) {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return accounts.Account{}, err
- }
- derivPath, err := accounts.ParseDerivationPath(path)
- if err != nil {
- return accounts.Account{}, err
- }
- if pin == nil {
- pin = new(bool)
- }
- return wallet.Derive(derivPath, *pin)
- }
- // NewAccount will create a new account and returns the address for the new account.
- func (s *PrivateAccountAPI) NewAccount(password string) (common.Address, error) {
- ks, err := fetchKeystore(s.am)
- if err != nil {
- return common.Address{}, err
- }
- acc, err := ks.NewAccount(password)
- if err == nil {
- log.Info("Your new key was generated", "address", acc.Address)
- log.Warn("Please backup your key file!", "path", acc.URL.Path)
- log.Warn("Please remember your password!")
- return acc.Address, nil
- }
- return common.Address{}, err
- }
- // fetchKeystore retrieves the encrypted keystore from the account manager.
- func fetchKeystore(am *accounts.Manager) (*keystore.KeyStore, error) {
- if ks := am.Backends(keystore.KeyStoreType); len(ks) > 0 {
- return ks[0].(*keystore.KeyStore), nil
- }
- return nil, errors.New("local keystore not used")
- }
- // ImportRawKey stores the given hex encoded ECDSA key into the key directory,
- // encrypting it with the passphrase.
- func (s *PrivateAccountAPI) ImportRawKey(privkey string, password string) (common.Address, error) {
- key, err := crypto.HexToECDSA(privkey)
- if err != nil {
- return common.Address{}, err
- }
- ks, err := fetchKeystore(s.am)
- if err != nil {
- return common.Address{}, err
- }
- acc, err := ks.ImportECDSA(key, password)
- return acc.Address, err
- }
- // UnlockAccount will unlock the account associated with the given address with
- // the given password for duration seconds. If duration is nil it will use a
- // default of 300 seconds. It returns an indication if the account was unlocked.
- func (s *PrivateAccountAPI) UnlockAccount(ctx context.Context, addr common.Address, password string, duration *uint64) (bool, error) {
- // When the API is exposed by external RPC(http, ws etc), unless the user
- // explicitly specifies to allow the insecure account unlocking, otherwise
- // it is disabled.
- if s.b.ExtRPCEnabled() && !s.b.AccountManager().Config().InsecureUnlockAllowed {
- return false, errors.New("account unlock with HTTP access is forbidden")
- }
- const max = uint64(time.Duration(math.MaxInt64) / time.Second)
- var d time.Duration
- if duration == nil {
- d = 300 * time.Second
- } else if *duration > max {
- return false, errors.New("unlock duration too large")
- } else {
- d = time.Duration(*duration) * time.Second
- }
- err := s.unlockAccount(addr, password, d)
- if err != nil {
- log.Warn("Failed account unlock attempt", "address", addr, "err", err)
- }
- return err == nil, err
- }
- func (s *PrivateAccountAPI) unlockAccount(addr common.Address, password string, duration time.Duration) error {
- acct := accounts.Account{Address: addr}
- backend, err := s.am.Backend(acct)
- if err != nil {
- return err
- }
- switch b := backend.(type) {
- case *pluggable.Backend:
- return b.TimedUnlock(acct, password, duration)
- case *keystore.KeyStore:
- return b.TimedUnlock(acct, password, duration)
- default:
- return errors.New("unlock only supported for keystore or plugin wallets")
- }
- }
- // LockAccount will lock the account associated with the given address when it's unlocked.
- func (s *PrivateAccountAPI) LockAccount(addr common.Address) bool {
- if err := s.lockAccount(addr); err != nil {
- log.Warn("Failed account lock attempt", "address", addr, "err", err)
- return false
- }
- return true
- }
- func (s *PrivateAccountAPI) lockAccount(addr common.Address) error {
- acct := accounts.Account{Address: addr}
- backend, err := s.am.Backend(acct)
- if err != nil {
- return err
- }
- switch b := backend.(type) {
- case *pluggable.Backend:
- return b.Lock(acct)
- case *keystore.KeyStore:
- return b.Lock(addr)
- default:
- return errors.New("lock only supported for keystore or plugin wallets")
- }
- }
- // signTransaction sets defaults and signs the given transaction
- // NOTE: the caller needs to ensure that the nonceLock is held, if applicable,
- // and release it after the transaction has been submitted to the tx pool
- func (s *PrivateAccountAPI) signTransaction(ctx context.Context, args *SendTxArgs, passwd string) (*types.Transaction, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: args.From}
- wallet, err := s.am.Find(account)
- if err != nil {
- return nil, err
- }
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Assemble the transaction and sign with the wallet
- tx := args.toTransaction()
- // Quorum
- if args.IsPrivate() {
- tx.SetPrivate()
- }
- var chainID *big.Int
- if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) && !tx.IsPrivate() {
- chainID = config.ChainID
- }
- // /Quorum
- return wallet.SignTxWithPassphrase(account, passwd, tx, chainID)
- }
- // SendTransaction will create a transaction from the given arguments and
- // tries to sign it with the key associated with args.From. If the given passwd isn't
- // able to decrypt the key it fails.
- func (s *PrivateAccountAPI) SendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
- if args.Nonce == nil {
- // Hold the addresse's mutex around signing to prevent concurrent assignment of
- // the same nonce to multiple accounts.
- s.nonceLock.LockAddr(args.From)
- defer s.nonceLock.UnlockAddr(args.From)
- }
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return common.Hash{}, err
- }
- // Quorum
- _, replaceDataWithHash, data, err := checkAndHandlePrivateTransaction(ctx, s.b, args.toTransaction(), &args.PrivateTxArgs, args.From, NormalTransaction)
- if err != nil {
- return common.Hash{}, err
- }
- if replaceDataWithHash {
- // replace the original payload with encrypted payload hash
- args.Data = data.BytesTypeRef()
- }
- // /Quorum
- signed, err := s.signTransaction(ctx, &args, passwd)
- if err != nil {
- log.Warn("Failed transaction send attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- // Quorum
- if signed.IsPrivate() && s.b.IsPrivacyMarkerTransactionCreationEnabled() {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: args.From}
- wallet, err := s.am.Find(account)
- if err != nil {
- return common.Hash{}, err
- }
- pmt, err := createPrivacyMarkerTransaction(s.b, signed, &args.PrivateTxArgs)
- if err != nil {
- log.Warn("Failed to create privacy marker transaction for private transaction", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- var pmtChainID *big.Int // PMT is public so will have different chainID used in signing compared to the internal tx
- if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
- pmtChainID = config.ChainID
- }
- signed, err = wallet.SignTxWithPassphrase(account, passwd, pmt, pmtChainID)
- if err != nil {
- log.Warn("Failed to sign privacy marker transaction for private transaction", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- }
- // /Quorum
- return SubmitTransaction(ctx, s.b, signed, args.PrivateFrom, false)
- }
- // SignTransaction will create a transaction from the given arguments and
- // tries to sign it with the key associated with args.From. If the given passwd isn't
- // able to decrypt the key it fails. The transaction is returned in RLP-form, not broadcast
- // to other nodes
- func (s *PrivateAccountAPI) SignTransaction(ctx context.Context, args SendTxArgs, passwd string) (*SignTransactionResult, error) {
- // No need to obtain the noncelock mutex, since we won't be sending this
- // tx into the transaction pool, but right back to the user
- if args.Gas == nil {
- return nil, fmt.Errorf("gas not specified")
- }
- if args.GasPrice == nil {
- return nil, fmt.Errorf("gasPrice not specified")
- }
- if args.Nonce == nil {
- return nil, fmt.Errorf("nonce not specified")
- }
- // Before actually sign the transaction, ensure the transaction fee is reasonable.
- if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil {
- return nil, err
- }
- signed, err := s.signTransaction(ctx, &args, passwd)
- if err != nil {
- log.Warn("Failed transaction sign attempt", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return nil, err
- }
- data, err := signed.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, signed}, nil
- }
- // Sign calculates an Ethereum ECDSA signature for:
- // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message))
- //
- // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
- // where the V value will be 27 or 28 for legacy reasons.
- //
- // The key used to calculate the signature is decrypted with the given password.
- //
- // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_sign
- func (s *PrivateAccountAPI) Sign(ctx context.Context, data hexutil.Bytes, addr common.Address, passwd string) (hexutil.Bytes, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Assemble sign the data with the wallet
- signature, err := wallet.SignTextWithPassphrase(account, passwd, data)
- if err != nil {
- log.Warn("Failed data sign attempt", "address", addr, "err", err)
- return nil, err
- }
- signature[crypto.RecoveryIDOffset] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
- return signature, nil
- }
- // EcRecover returns the address for the account that was used to create the signature.
- // Note, this function is compatible with eth_sign and personal_sign. As such it recovers
- // the address of:
- // hash = keccak256("\x19Ethereum Signed Message:\n"${message length}${message})
- // addr = ecrecover(hash, signature)
- //
- // Note, the signature must conform to the secp256k1 curve R, S and V values, where
- // the V value must be 27 or 28 for legacy reasons.
- //
- // https://github.com/ethereum/go-ethereum/wiki/Management-APIs#personal_ecRecover
- func (s *PrivateAccountAPI) EcRecover(ctx context.Context, data, sig hexutil.Bytes) (common.Address, error) {
- if len(sig) != crypto.SignatureLength {
- return common.Address{}, fmt.Errorf("signature must be %d bytes long", crypto.SignatureLength)
- }
- if sig[crypto.RecoveryIDOffset] != 27 && sig[crypto.RecoveryIDOffset] != 28 {
- return common.Address{}, fmt.Errorf("invalid Ethereum signature (V is not 27 or 28)")
- }
- sig[crypto.RecoveryIDOffset] -= 27 // Transform yellow paper V from 27/28 to 0/1
- rpk, err := crypto.SigToPub(accounts.TextHash(data), sig)
- if err != nil {
- return common.Address{}, err
- }
- return crypto.PubkeyToAddress(*rpk), nil
- }
- // SignAndSendTransaction was renamed to SendTransaction. This method is deprecated
- // and will be removed in the future. It primary goal is to give clients time to update.
- func (s *PrivateAccountAPI) SignAndSendTransaction(ctx context.Context, args SendTxArgs, passwd string) (common.Hash, error) {
- return s.SendTransaction(ctx, args, passwd)
- }
- // InitializeWallet initializes a new wallet at the provided URL, by generating and returning a new private key.
- func (s *PrivateAccountAPI) InitializeWallet(ctx context.Context, url string) (string, error) {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return "", err
- }
- entropy, err := bip39.NewEntropy(256)
- if err != nil {
- return "", err
- }
- mnemonic, err := bip39.NewMnemonic(entropy)
- if err != nil {
- return "", err
- }
- seed := bip39.NewSeed(mnemonic, "")
- switch wallet := wallet.(type) {
- case *scwallet.Wallet:
- return mnemonic, wallet.Initialize(seed)
- default:
- return "", fmt.Errorf("specified wallet does not support initialization")
- }
- }
- // Unpair deletes a pairing between wallet and geth.
- func (s *PrivateAccountAPI) Unpair(ctx context.Context, url string, pin string) error {
- wallet, err := s.am.Wallet(url)
- if err != nil {
- return err
- }
- switch wallet := wallet.(type) {
- case *scwallet.Wallet:
- return wallet.Unpair([]byte(pin))
- default:
- return fmt.Errorf("specified wallet does not support pairing")
- }
- }
- // PublicBlockChainAPI provides an API to access the Ethereum blockchain.
- // It offers only methods that operate on public data that is freely available to anyone.
- type PublicBlockChainAPI struct {
- b Backend
- }
- // NewPublicBlockChainAPI creates a new Ethereum blockchain API.
- func NewPublicBlockChainAPI(b Backend) *PublicBlockChainAPI {
- return &PublicBlockChainAPI{b}
- }
- // ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.
- func (api *PublicBlockChainAPI) ChainId() (*hexutil.Big, error) {
- // if current block is at or past the EIP-155 replay-protection fork block, return chainID from config
- if config := api.b.ChainConfig(); config.IsEIP155(api.b.CurrentBlock().Number()) {
- return (*hexutil.Big)(config.ChainID), nil
- }
- return nil, fmt.Errorf("chain not synced beyond EIP-155 replay-protection fork block")
- }
- // GetPSI - retunrs the PSI that was resolved based on the client request
- func (s *PublicBlockChainAPI) GetPSI(ctx context.Context) (string, error) {
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return "", err
- }
- return psm.ID.String(), nil
- }
- // BlockNumber returns the block number of the chain head.
- func (s *PublicBlockChainAPI) BlockNumber() hexutil.Uint64 {
- header, _ := s.b.HeaderByNumber(context.Background(), rpc.LatestBlockNumber) // latest header should always be available
- return hexutil.Uint64(header.Number.Uint64())
- }
- // GetBalance returns the amount of wei for the given address in the state of the
- // given block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta
- // block numbers are also allowed.
- func (s *PublicBlockChainAPI) GetBalance(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Big, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- return (*hexutil.Big)(state.GetBalance(address)), state.Error()
- }
- // Result structs for GetProof
- type AccountResult struct {
- Address common.Address `json:"address"`
- AccountProof []string `json:"accountProof"`
- Balance *hexutil.Big `json:"balance"`
- CodeHash common.Hash `json:"codeHash"`
- Nonce hexutil.Uint64 `json:"nonce"`
- StorageHash common.Hash `json:"storageHash"`
- StorageProof []StorageResult `json:"storageProof"`
- }
- type StorageResult struct {
- Key string `json:"key"`
- Value *hexutil.Big `json:"value"`
- Proof []string `json:"proof"`
- }
- // GetProof returns the Merkle-proof for a given account and optionally some storage keys.
- func (s *PublicBlockChainAPI) GetProof(ctx context.Context, address common.Address, storageKeys []string, blockNrOrHash rpc.BlockNumberOrHash) (*AccountResult, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- storageTrie := state.StorageTrie(address)
- storageHash := types.EmptyRootHash
- codeHash := state.GetCodeHash(address)
- storageProof := make([]StorageResult, len(storageKeys))
- // if we have a storageTrie, (which means the account exists), we can update the storagehash
- if storageTrie != nil {
- storageHash = storageTrie.Hash()
- } else {
- // no storageTrie means the account does not exist, so the codeHash is the hash of an empty bytearray.
- codeHash = crypto.Keccak256Hash(nil)
- }
- // create the proof for the storageKeys
- for i, key := range storageKeys {
- if storageTrie != nil {
- proof, storageError := state.GetStorageProof(address, common.HexToHash(key))
- if storageError != nil {
- return nil, storageError
- }
- storageProof[i] = StorageResult{key, (*hexutil.Big)(state.GetState(address, common.HexToHash(key)).Big()), toHexSlice(proof)}
- } else {
- storageProof[i] = StorageResult{key, &hexutil.Big{}, []string{}}
- }
- }
- // create the accountProof
- accountProof, proofErr := state.GetProof(address)
- if proofErr != nil {
- return nil, proofErr
- }
- return &AccountResult{
- Address: address,
- AccountProof: toHexSlice(accountProof),
- Balance: (*hexutil.Big)(state.GetBalance(address)),
- CodeHash: codeHash,
- Nonce: hexutil.Uint64(state.GetNonce(address)),
- StorageHash: storageHash,
- StorageProof: storageProof,
- }, state.Error()
- }
- // GetHeaderByNumber returns the requested canonical block header.
- // * When blockNr is -1 the chain head is returned.
- // * When blockNr is -2 the pending chain head is returned.
- func (s *PublicBlockChainAPI) GetHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (map[string]interface{}, error) {
- header, err := s.b.HeaderByNumber(ctx, number)
- if header != nil && err == nil {
- response := s.rpcMarshalHeader(ctx, header)
- if number == rpc.PendingBlockNumber {
- // Pending header need to nil out a few fields
- for _, field := range []string{"hash", "nonce", "miner"} {
- response[field] = nil
- }
- }
- return response, err
- }
- return nil, err
- }
- // GetHeaderByHash returns the requested header by hash.
- func (s *PublicBlockChainAPI) GetHeaderByHash(ctx context.Context, hash common.Hash) map[string]interface{} {
- header, _ := s.b.HeaderByHash(ctx, hash)
- if header != nil {
- return s.rpcMarshalHeader(ctx, header)
- }
- return nil
- }
- // GetBlockByNumber returns the requested canonical block.
- // * When blockNr is -1 the chain head is returned.
- // * When blockNr is -2 the pending chain head is returned.
- // * When fullTx is true all transactions in the block are returned, otherwise
- // only the transaction hash is returned.
- func (s *PublicBlockChainAPI) GetBlockByNumber(ctx context.Context, number rpc.BlockNumber, fullTx bool) (map[string]interface{}, error) {
- block, err := s.b.BlockByNumber(ctx, number)
- if block != nil && err == nil {
- response, err := s.rpcMarshalBlock(ctx, block, true, fullTx)
- if err == nil && number == rpc.PendingBlockNumber {
- // Pending blocks need to nil out a few fields
- for _, field := range []string{"hash", "nonce", "miner"} {
- response[field] = nil
- }
- }
- return response, err
- }
- return nil, err
- }
- // GetBlockByHash returns the requested block. When fullTx is true all transactions in the block are returned in full
- // detail, otherwise only the transaction hash is returned.
- func (s *PublicBlockChainAPI) GetBlockByHash(ctx context.Context, hash common.Hash, fullTx bool) (map[string]interface{}, error) {
- block, err := s.b.BlockByHash(ctx, hash)
- if block != nil {
- return s.rpcMarshalBlock(ctx, block, true, fullTx)
- }
- return nil, err
- }
- // GetUncleByBlockNumberAndIndex returns the uncle block for the given block hash and index. When fullTx is true
- // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
- func (s *PublicBlockChainAPI) GetUncleByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) (map[string]interface{}, error) {
- block, err := s.b.BlockByNumber(ctx, blockNr)
- if block != nil {
- uncles := block.Uncles()
- if index >= hexutil.Uint(len(uncles)) {
- log.Debug("Requested uncle not found", "number", blockNr, "hash", block.Hash(), "index", index)
- return nil, nil
- }
- block = types.NewBlockWithHeader(uncles[index])
- return s.rpcMarshalBlock(ctx, block, false, false)
- }
- return nil, err
- }
- // GetUncleByBlockHashAndIndex returns the uncle block for the given block hash and index. When fullTx is true
- // all transactions in the block are returned in full detail, otherwise only the transaction hash is returned.
- func (s *PublicBlockChainAPI) GetUncleByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) (map[string]interface{}, error) {
- block, err := s.b.BlockByHash(ctx, blockHash)
- if block != nil {
- uncles := block.Uncles()
- if index >= hexutil.Uint(len(uncles)) {
- log.Debug("Requested uncle not found", "number", block.Number(), "hash", blockHash, "index", index)
- return nil, nil
- }
- block = types.NewBlockWithHeader(uncles[index])
- return s.rpcMarshalBlock(ctx, block, false, false)
- }
- return nil, err
- }
- // GetUncleCountByBlockNumber returns number of uncles in the block for the given block number
- func (s *PublicBlockChainAPI) GetUncleCountByBlockNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- n := hexutil.Uint(len(block.Uncles()))
- return &n
- }
- return nil
- }
- // GetUncleCountByBlockHash returns number of uncles in the block for the given block hash
- func (s *PublicBlockChainAPI) GetUncleCountByBlockHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- n := hexutil.Uint(len(block.Uncles()))
- return &n
- }
- return nil
- }
- // GetCode returns the code stored at the given address in the state for the given block number.
- func (s *PublicBlockChainAPI) GetCode(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- code := state.GetCode(address)
- return code, state.Error()
- }
- // GetStorageAt returns the storage from the state at the given address, key and
- // block number. The rpc.LatestBlockNumber and rpc.PendingBlockNumber meta block
- // numbers are also allowed.
- func (s *PublicBlockChainAPI) GetStorageAt(ctx context.Context, address common.Address, key string, blockNrOrHash rpc.BlockNumberOrHash) (hexutil.Bytes, error) {
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- res := state.GetState(address, common.HexToHash(key))
- return res[:], state.Error()
- }
- // CallArgs represents the arguments for a call.
- type CallArgs struct {
- From *common.Address `json:"from"`
- To *common.Address `json:"to"`
- Gas *hexutil.Uint64 `json:"gas"`
- GasPrice *hexutil.Big `json:"gasPrice"`
- Value *hexutil.Big `json:"value"`
- Data *hexutil.Bytes `json:"data"`
- AccessList *types.AccessList `json:"accessList"`
- }
- // ToMessage converts CallArgs to the Message type used by the core evm
- func (args *CallArgs) ToMessage(globalGasCap uint64) types.Message {
- // Set sender address or use zero address if none specified.
- var addr common.Address
- if args.From != nil {
- addr = *args.From
- }
- // Set default gas & gas price if none were set
- gas := globalGasCap
- if gas == 0 {
- gas = uint64(math.MaxUint64 / 2)
- }
- if args.Gas != nil {
- gas = uint64(*args.Gas)
- }
- if globalGasCap != 0 && globalGasCap < gas {
- log.Warn("Caller gas above allowance, capping", "requested", gas, "cap", globalGasCap)
- gas = globalGasCap
- }
- gasPrice := new(big.Int)
- if args.GasPrice != nil {
- gasPrice = args.GasPrice.ToInt()
- }
- value := new(big.Int)
- if args.Value != nil {
- value = args.Value.ToInt()
- }
- var data []byte
- if args.Data != nil {
- data = *args.Data
- }
- var accessList types.AccessList
- if args.AccessList != nil {
- accessList = *args.AccessList
- }
- msg := types.NewMessage(addr, args.To, 0, value, gas, gasPrice, data, accessList, false)
- return msg
- }
- // OverrideAccount indicates the overriding fields of account during the execution
- // of a message call.
- // Note, state and stateDiff can't be specified at the same time. If state is
- // set, message execution will only use the data in the given state. Otherwise
- // if statDiff is set, all diff will be applied first and then execute the call
- // message.
- type OverrideAccount struct {
- Nonce *hexutil.Uint64 `json:"nonce"`
- Code *hexutil.Bytes `json:"code"`
- Balance **hexutil.Big `json:"balance"`
- State *map[common.Hash]common.Hash `json:"state"`
- StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
- }
- // StateOverride is the collection of overridden accounts.
- type StateOverride map[common.Address]OverrideAccount
- // Apply overrides the fields of specified accounts into the given state.
- func (diff *StateOverride) Apply(state *state.StateDB) error {
- if diff == nil {
- return nil
- }
- for addr, account := range *diff {
- // Override account nonce.
- if account.Nonce != nil {
- state.SetNonce(addr, uint64(*account.Nonce))
- }
- // Override account(contract) code.
- if account.Code != nil {
- state.SetCode(addr, *account.Code)
- }
- // Override account balance.
- if account.Balance != nil {
- state.SetBalance(addr, (*big.Int)(*account.Balance))
- }
- if account.State != nil && account.StateDiff != nil {
- return fmt.Errorf("account %s has both 'state' and 'stateDiff'", addr.Hex())
- }
- // Replace entire state if caller requires.
- if account.State != nil {
- state.SetStorage(addr, *account.State)
- }
- // Apply state diff into specified accounts.
- if account.StateDiff != nil {
- for key, value := range *account.StateDiff {
- state.SetState(addr, key, value)
- }
- }
- }
- return nil
- }
- // Quorum - Multitenancy
- // Before returning the result, we need to inspect the EVM and
- // perform verification check
- func DoCall(ctx context.Context, b Backend, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride, vmCfg vm.Config, timeout time.Duration, globalGasCap uint64) (*core.ExecutionResult, error) {
- defer func(start time.Time) { log.Debug("Executing EVM call finished", "runtime", time.Since(start)) }(time.Now())
- state, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- /*if err := overrides.Apply(state.(eth.EthAPIState)); err != nil {
- return nil, err
- }*/
- // Setup context so it may be cancelled the call has completed
- // or, in case of unmetered gas, setup a context with a timeout.
- var cancel context.CancelFunc
- if timeout > 0 {
- ctx, cancel = context.WithTimeout(ctx, timeout)
- } else {
- ctx, cancel = context.WithCancel(ctx)
- }
- // Make sure the context is cancelled when the call has completed
- // this makes sure resources are cleaned up.
- defer cancel()
- // Get a new instance of the EVM.
- msg := args.ToMessage(globalGasCap)
- evm, vmError, err := b.GetEVM(ctx, msg, state, header, nil)
- if err != nil {
- return nil, err
- }
- // Wait for the context to be done and cancel the evm. Even if the
- // EVM has finished, cancelling may be done (repeatedly)
- go func() {
- <-ctx.Done()
- evm.Cancel()
- }()
- // Execute the message.
- gp := new(core.GasPool).AddGas(math.MaxUint64)
- result, applyErr := core.ApplyMessage(evm, msg, gp)
- if err := vmError(); err != nil {
- return nil, err
- }
- // If the timer caused an abort, return an appropriate error message
- if evm.Cancelled() {
- return nil, fmt.Errorf("execution aborted (timeout = %v)", timeout)
- }
- if applyErr != nil {
- return result, fmt.Errorf("err: %w (supplied gas %d)", applyErr, msg.Gas())
- }
- return result, nil
- }
- func newRevertError(result *core.ExecutionResult) *revertError {
- reason, errUnpack := abi.UnpackRevert(result.Revert())
- err := errors.New("execution reverted")
- if errUnpack == nil {
- err = fmt.Errorf("execution reverted: %v", reason)
- }
- return &revertError{
- error: err,
- reason: hexutil.Encode(result.Revert()),
- }
- }
- // revertError is an API error that encompassas an EVM revertal with JSON error
- // code and a binary data blob.
- type revertError struct {
- error
- reason string // revert reason hex encoded
- }
- // ErrorCode returns the JSON error code for a revertal.
- // See: https://github.com/ethereum/wiki/wiki/JSON-RPC-Error-Codes-Improvement-Proposal
- func (e *revertError) ErrorCode() int {
- return 3
- }
- // ErrorData returns the hex encoded revert reason.
- func (e *revertError) ErrorData() interface{} {
- return e.reason
- }
- // Call executes the given transaction on the state for the given block number.
- //
- // Additionally, the caller can specify a batch of contract for fields overriding.
- //
- // Note, this function doesn't make and changes in the state/blockchain and is
- // useful to execute and retrieve values.
- // Quorum
- // - replaced the default 5s time out with the value passed in vm.calltimeout
- // - multi tenancy verification
- func (s *PublicBlockChainAPI) Call(ctx context.Context, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, overrides *StateOverride) (hexutil.Bytes, error) {
- var accounts map[common.Address]OverrideAccount
- if overrides != nil {
- accounts = *overrides
- }
- stateOverride := StateOverride(accounts)
- result, err := DoCall(ctx, s.b, args, blockNrOrHash, &stateOverride, vm.Config{}, s.b.CallTimeOut(), s.b.RPCGasCap())
- if err != nil {
- return nil, err
- }
- // If the result contains a revert reason, try to unpack and return it.
- if len(result.Revert()) > 0 {
- return nil, newRevertError(result)
- }
- return result.Return(), result.Err
- }
- func DoEstimateGas(ctx context.Context, b Backend, args CallArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64) (hexutil.Uint64, error) {
- // Binary search the gas requirement, as it may be higher than the amount used
- var (
- lo uint64 = params.TxGas - 1
- hi uint64
- cap uint64
- )
- // Use zero address if sender unspecified.
- if args.From == nil {
- args.From = new(common.Address)
- }
- // Determine the highest gas limit can be used during the estimation.
- if args.Gas != nil && uint64(*args.Gas) >= params.TxGas {
- hi = uint64(*args.Gas)
- } else {
- // Retrieve the block to act as the gas ceiling
- block, err := b.BlockByNumberOrHash(ctx, blockNrOrHash)
- if err != nil {
- return 0, err
- }
- if block == nil {
- return 0, errors.New("block not found")
- }
- hi = block.GasLimit()
- }
- // Recap the highest gas limit with account's available balance.
- if args.GasPrice != nil && args.GasPrice.ToInt().BitLen() != 0 {
- state, _, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if err != nil {
- return 0, err
- }
- balance := state.GetBalance(*args.From) // from can't be nil
- available := new(big.Int).Set(balance)
- if args.Value != nil {
- if args.Value.ToInt().Cmp(available) >= 0 {
- return 0, errors.New("insufficient funds for transfer")
- }
- available.Sub(available, args.Value.ToInt())
- }
- allowance := new(big.Int).Div(available, args.GasPrice.ToInt())
- // If the allowance is larger than maximum uint64, skip checking
- if allowance.IsUint64() && hi > allowance.Uint64() {
- transfer := args.Value
- if transfer == nil {
- transfer = new(hexutil.Big)
- }
- log.Warn("Gas estimation capped by limited funds", "original", hi, "balance", balance,
- "sent", transfer.ToInt(), "gasprice", args.GasPrice.ToInt(), "fundable", allowance)
- hi = allowance.Uint64()
- }
- }
- // Recap the highest gas allowance with specified gascap.
- if gasCap != 0 && hi > gasCap {
- log.Warn("Caller gas above allowance, capping", "requested", hi, "cap", gasCap)
- hi = gasCap
- }
- cap = hi
- // Create a helper to check if a gas allowance results in an executable transaction
- executable := func(gas uint64) (bool, *core.ExecutionResult, error) {
- args.Gas = (*hexutil.Uint64)(&gas)
- result, err := DoCall(ctx, b, args, blockNrOrHash, nil, vm.Config{}, 0, gasCap)
- if err != nil {
- if errors.Is(err, core.ErrIntrinsicGas) {
- return true, nil, nil // Special case, raise gas limit
- }
- return true, nil, err // Bail out
- }
- return result.Failed(), result, nil
- }
- // Execute the binary search and hone in on an executable gas limit
- for lo+1 < hi {
- mid := (hi + lo) / 2
- failed, _, err := executable(mid)
- // If the error is not nil(consensus error), it means the provided message
- // call or transaction will never be accepted no matter how much gas it is
- // assigned. Return the error directly, don't struggle any more.
- if err != nil {
- return 0, err
- }
- if failed {
- lo = mid
- } else {
- hi = mid
- }
- }
- // Reject the transaction as invalid if it still fails at the highest allowance
- if hi == cap {
- failed, result, err := executable(hi)
- if err != nil {
- return 0, err
- }
- if failed {
- if result != nil && result.Err != vm.ErrOutOfGas {
- if len(result.Revert()) > 0 {
- return 0, newRevertError(result)
- }
- return 0, result.Err
- }
- // Otherwise, the specified gas cap is too low
- return 0, fmt.Errorf("gas required exceeds allowance (%d)", cap)
- }
- }
- //QUORUM
- //We don't know if this is going to be a private or public transaction
- //It is possible to have a data field that has a lower intrinsic value than the PTM hash
- //so this checks that if we were to place a PTM hash (with all non-zero values) here then the transaction would
- //still run
- //This makes the return value a potential over-estimate of gas, rather than the exact cost to run right now
- //if the transaction has a value then it cannot be private, so we can skip this check
- if args.Value != nil && args.Value.ToInt().Cmp(big.NewInt(0)) == 0 {
- currentBlockHeight := b.CurrentHeader().Number
- homestead := b.ChainConfig().IsHomestead(currentBlockHeight)
- istanbul := b.ChainConfig().IsIstanbul(currentBlockHeight)
- var data []byte
- if args.Data == nil {
- data = nil
- } else {
- data = []byte(*args.Data)
- }
- var accessList types.AccessList
- if args.AccessList != nil {
- accessList = *args.AccessList
- }
- intrinsicGasPublic, err := core.IntrinsicGas(data, accessList, args.To == nil, homestead, istanbul)
- if err != nil {
- return 0, err
- }
- intrinsicGasPrivate, err := core.IntrinsicGas(common.Hex2Bytes(common.MaxPrivateIntrinsicDataHex), accessList, args.To == nil, homestead, istanbul)
- if err != nil {
- return 0, err
- }
- if intrinsicGasPrivate > intrinsicGasPublic {
- if math.MaxUint64-hi < intrinsicGasPrivate-intrinsicGasPublic {
- return 0, fmt.Errorf("private intrinsic gas addition exceeds allowance")
- }
- return hexutil.Uint64(hi + (intrinsicGasPrivate - intrinsicGasPublic)), nil
- }
- }
- //END QUORUM
- return hexutil.Uint64(hi), nil
- }
- // EstimateGas returns an estimate of the amount of gas needed to execute the
- // given transaction against the current pending block.
- func (s *PublicBlockChainAPI) EstimateGas(ctx context.Context, args CallArgs, blockNrOrHash *rpc.BlockNumberOrHash) (hexutil.Uint64, error) {
- bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
- if blockNrOrHash != nil {
- bNrOrHash = *blockNrOrHash
- }
- return DoEstimateGas(ctx, s.b, args, bNrOrHash, s.b.RPCGasCap())
- }
- // ExecutionResult groups all structured logs emitted by the EVM
- // while replaying a transaction in debug mode as well as transaction
- // execution status, the amount of gas used and the return value
- type ExecutionResult struct {
- Gas uint64 `json:"gas"`
- Failed bool `json:"failed"`
- ReturnValue string `json:"returnValue"`
- StructLogs []StructLogRes `json:"structLogs"`
- }
- // StructLogRes stores a structured log emitted by the EVM while replaying a
- // transaction in debug mode
- type StructLogRes struct {
- Pc uint64 `json:"pc"`
- Op string `json:"op"`
- Gas uint64 `json:"gas"`
- GasCost uint64 `json:"gasCost"`
- Depth int `json:"depth"`
- Error error `json:"error,omitempty"`
- Stack *[]string `json:"stack,omitempty"`
- Memory *[]string `json:"memory,omitempty"`
- Storage *map[string]string `json:"storage,omitempty"`
- }
- // FormatLogs formats EVM returned structured logs for json output
- func FormatLogs(logs []vm.StructLog) []StructLogRes {
- formatted := make([]StructLogRes, len(logs))
- for index, trace := range logs {
- formatted[index] = StructLogRes{
- Pc: trace.Pc,
- Op: trace.Op.String(),
- Gas: trace.Gas,
- GasCost: trace.GasCost,
- Depth: trace.Depth,
- Error: trace.Err,
- }
- if trace.Stack != nil {
- stack := make([]string, len(trace.Stack))
- for i, stackValue := range trace.Stack {
- stack[i] = fmt.Sprintf("%x", math.PaddedBigBytes(stackValue, 32))
- }
- formatted[index].Stack = &stack
- }
- if trace.Memory != nil {
- memory := make([]string, 0, (len(trace.Memory)+31)/32)
- for i := 0; i+32 <= len(trace.Memory); i += 32 {
- memory = append(memory, fmt.Sprintf("%x", trace.Memory[i:i+32]))
- }
- formatted[index].Memory = &memory
- }
- if trace.Storage != nil {
- storage := make(map[string]string)
- for i, storageValue := range trace.Storage {
- storage[fmt.Sprintf("%x", i)] = fmt.Sprintf("%x", storageValue)
- }
- formatted[index].Storage = &storage
- }
- }
- return formatted
- }
- // RPCMarshalHeader converts the given header to the RPC output .
- func RPCMarshalHeader(head *types.Header) map[string]interface{} {
- return map[string]interface{}{
- "number": (*hexutil.Big)(head.Number),
- "hash": head.Hash(),
- "parentHash": head.ParentHash,
- "nonce": head.Nonce,
- "mixHash": head.MixDigest,
- "sha3Uncles": head.UncleHash,
- "logsBloom": head.Bloom,
- "stateRoot": head.Root,
- "miner": head.Coinbase,
- "difficulty": (*hexutil.Big)(head.Difficulty),
- "extraData": hexutil.Bytes(head.Extra),
- "size": hexutil.Uint64(head.Size()),
- "gasLimit": hexutil.Uint64(head.GasLimit),
- "gasUsed": hexutil.Uint64(head.GasUsed),
- "timestamp": hexutil.Uint64(head.Time),
- "transactionsRoot": head.TxHash,
- "receiptsRoot": head.ReceiptHash,
- }
- }
- // RPCMarshalBlock converts the given block to the RPC output which depends on fullTx. If inclTx is true transactions are
- // returned. When fullTx is true the returned block contains full transaction details, otherwise it will only contain
- // transaction hashes.
- func RPCMarshalBlock(block *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
- fields := RPCMarshalHeader(block.Header())
- fields["size"] = hexutil.Uint64(block.Size())
- if inclTx {
- formatTx := func(tx *types.Transaction) (interface{}, error) {
- return tx.Hash(), nil
- }
- if fullTx {
- formatTx = func(tx *types.Transaction) (interface{}, error) {
- return newRPCTransactionFromBlockHash(block, tx.Hash()), nil
- }
- }
- txs := block.Transactions()
- transactions := make([]interface{}, len(txs))
- var err error
- for i, tx := range txs {
- if transactions[i], err = formatTx(tx); err != nil {
- return nil, err
- }
- }
- fields["transactions"] = transactions
- }
- uncles := block.Uncles()
- uncleHashes := make([]common.Hash, len(uncles))
- for i, uncle := range uncles {
- uncleHashes[i] = uncle.Hash()
- }
- fields["uncles"] = uncleHashes
- return fields, nil
- }
- // rpcMarshalHeader uses the generalized output filler, then adds the total difficulty field, which requires
- // a `PublicBlockchainAPI`.
- func (s *PublicBlockChainAPI) rpcMarshalHeader(ctx context.Context, header *types.Header) map[string]interface{} {
- fields := RPCMarshalHeader(header)
- fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, header.Hash()))
- return fields
- }
- // rpcMarshalBlock uses the generalized output filler, then adds the total difficulty field, which requires
- // a `PublicBlockchainAPI`.
- func (s *PublicBlockChainAPI) rpcMarshalBlock(ctx context.Context, b *types.Block, inclTx bool, fullTx bool) (map[string]interface{}, error) {
- fields, err := RPCMarshalBlock(b, inclTx, fullTx)
- if err != nil {
- return nil, err
- }
- if inclTx {
- fields["totalDifficulty"] = (*hexutil.Big)(s.b.GetTd(ctx, b.Hash()))
- }
- return fields, err
- }
- // RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction
- type RPCTransaction struct {
- BlockHash *common.Hash `json:"blockHash"`
- BlockNumber *hexutil.Big `json:"blockNumber"`
- From common.Address `json:"from"`
- Gas hexutil.Uint64 `json:"gas"`
- GasPrice *hexutil.Big `json:"gasPrice"`
- Hash common.Hash `json:"hash"`
- Input hexutil.Bytes `json:"input"`
- Nonce hexutil.Uint64 `json:"nonce"`
- To *common.Address `json:"to"`
- TransactionIndex *hexutil.Uint64 `json:"transactionIndex"`
- Value *hexutil.Big `json:"value"`
- Type hexutil.Uint64 `json:"type"`
- Accesses *types.AccessList `json:"accessList,omitempty"`
- ChainID *hexutil.Big `json:"chainId,omitempty"`
- V *hexutil.Big `json:"v"`
- R *hexutil.Big `json:"r"`
- S *hexutil.Big `json:"s"`
- }
- // newRPCTransaction returns a transaction that will serialize to the RPC
- // representation, with the given location metadata set (if available).
- func newRPCTransaction(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, index uint64) *RPCTransaction {
- // Determine the signer. For replay-protected transactions, use the most permissive
- // signer, because we assume that signers are backwards-compatible with old
- // transactions. For non-protected transactions, the homestead signer signer is used
- // because the return value of ChainId is zero for those transactions.
- var signer types.Signer
- if tx.Protected() && !tx.IsPrivate() {
- signer = types.LatestSignerForChainID(tx.ChainId())
- } else {
- signer = types.HomesteadSigner{}
- }
- from, _ := types.Sender(signer, tx)
- v, r, s := tx.RawSignatureValues()
- result := &RPCTransaction{
- Type: hexutil.Uint64(tx.Type()),
- From: from,
- Gas: hexutil.Uint64(tx.Gas()),
- GasPrice: (*hexutil.Big)(tx.GasPrice()),
- Hash: tx.Hash(),
- Input: hexutil.Bytes(tx.Data()),
- Nonce: hexutil.Uint64(tx.Nonce()),
- To: tx.To(),
- Value: (*hexutil.Big)(tx.Value()),
- V: (*hexutil.Big)(v),
- R: (*hexutil.Big)(r),
- S: (*hexutil.Big)(s),
- }
- if blockHash != (common.Hash{}) {
- result.BlockHash = &blockHash
- result.BlockNumber = (*hexutil.Big)(new(big.Int).SetUint64(blockNumber))
- result.TransactionIndex = (*hexutil.Uint64)(&index)
- }
- if tx.Type() == types.AccessListTxType {
- al := tx.AccessList()
- result.Accesses = &al
- result.ChainID = (*hexutil.Big)(tx.ChainId())
- }
- return result
- }
- // newRPCPendingTransaction returns a pending transaction that will serialize to the RPC representation
- func newRPCPendingTransaction(tx *types.Transaction) *RPCTransaction {
- return newRPCTransaction(tx, common.Hash{}, 0, 0)
- }
- // newRPCTransactionFromBlockIndex returns a transaction that will serialize to the RPC representation.
- func newRPCTransactionFromBlockIndex(b *types.Block, index uint64) *RPCTransaction {
- txs := b.Transactions()
- if index >= uint64(len(txs)) {
- return nil
- }
- return newRPCTransaction(txs[index], b.Hash(), b.NumberU64(), index)
- }
- // newRPCRawTransactionFromBlockIndex returns the bytes of a transaction given a block and a transaction index.
- func newRPCRawTransactionFromBlockIndex(b *types.Block, index uint64) hexutil.Bytes {
- txs := b.Transactions()
- if index >= uint64(len(txs)) {
- return nil
- }
- blob, _ := txs[index].MarshalBinary()
- return blob
- }
- // newRPCTransactionFromBlockHash returns a transaction that will serialize to the RPC representation.
- func newRPCTransactionFromBlockHash(b *types.Block, hash common.Hash) *RPCTransaction {
- for idx, tx := range b.Transactions() {
- if tx.Hash() == hash {
- return newRPCTransactionFromBlockIndex(b, uint64(idx))
- }
- }
- return nil
- }
- // accessListResult returns an optional accesslist
- // Its the result of the `debug_createAccessList` RPC call.
- // It contains an error if the transaction itself failed.
- type accessListResult struct {
- Accesslist *types.AccessList `json:"accessList"`
- Error string `json:"error,omitempty"`
- GasUsed hexutil.Uint64 `json:"gasUsed"`
- }
- // CreateAccessList creates a EIP-2930 type AccessList for the given transaction.
- // Reexec and BlockNrOrHash can be specified to create the accessList on top of a certain state.
- func (s *PublicBlockChainAPI) CreateAccessList(ctx context.Context, args SendTxArgs, blockNrOrHash *rpc.BlockNumberOrHash) (*accessListResult, error) {
- bNrOrHash := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
- if blockNrOrHash != nil {
- bNrOrHash = *blockNrOrHash
- }
- acl, gasUsed, vmerr, err := AccessList(ctx, s.b, bNrOrHash, args)
- if err != nil {
- return nil, err
- }
- result := &accessListResult{Accesslist: &acl, GasUsed: hexutil.Uint64(gasUsed)}
- if vmerr != nil {
- result.Error = vmerr.Error()
- }
- return result, nil
- }
- // AccessList creates an access list for the given transaction.
- // If the accesslist creation fails an error is returned.
- // If the transaction itself fails, an vmErr is returned.
- func AccessList(ctx context.Context, b Backend, blockNrOrHash rpc.BlockNumberOrHash, args SendTxArgs) (acl types.AccessList, gasUsed uint64, vmErr error, err error) {
- // Retrieve the execution context
- db, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if db == nil || err != nil {
- return nil, 0, nil, err
- }
- // If the gas amount is not set, extract this as it will depend on access
- // lists and we'll need to reestimate every time
- nogas := args.Gas == nil
- // Ensure any missing fields are filled, extract the recipient and input data
- if err := args.setDefaults(ctx, b); err != nil {
- return nil, 0, nil, err
- }
- var to common.Address
- if args.To != nil {
- to = *args.To
- } else {
- to = crypto.CreateAddress(args.From, uint64(*args.Nonce))
- }
- var input []byte
- if args.Input != nil {
- input = *args.Input
- } else if args.Data != nil {
- input = *args.Data
- }
- // Retrieve the precompiles since they don't need to be added to the access list
- precompiles := vm.ActivePrecompiles(b.ChainConfig().Rules(header.Number))
- // Create an initial tracer
- prevTracer := vm.NewAccessListTracer(nil, args.From, to, precompiles)
- if args.AccessList != nil {
- prevTracer = vm.NewAccessListTracer(*args.AccessList, args.From, to, precompiles)
- }
- for {
- // Retrieve the current access list to expand
- accessList := prevTracer.AccessList()
- log.Trace("Creating access list", "input", accessList)
- // If no gas amount was specified, each unique access list needs it's own
- // gas calculation. This is quite expensive, but we need to be accurate
- // and it's convered by the sender only anyway.
- if nogas {
- args.Gas = nil
- if err := args.setDefaults(ctx, b); err != nil {
- return nil, 0, nil, err // shouldn't happen, just in case
- }
- }
- // Copy the original db so we don't modify it
- // statedb := db.Copy()
- statedb := db.(*state.StateDB).Copy()
- msg := types.NewMessage(args.From, args.To, uint64(*args.Nonce), args.Value.ToInt(), uint64(*args.Gas), args.GasPrice.ToInt(), input, accessList, false)
- // Apply the transaction with the access list tracer
- tracer := vm.NewAccessListTracer(accessList, args.From, to, precompiles)
- config := vm.Config{Tracer: tracer, Debug: true}
- vmenv, _, err := b.GetEVM(ctx, msg, statedb, header, &config)
- if err != nil {
- return nil, 0, nil, err
- }
- res, err := core.ApplyMessage(vmenv, msg, new(core.GasPool).AddGas(msg.Gas()))
- if err != nil {
- return nil, 0, nil, fmt.Errorf("failed to apply transaction: %v err: %v", args.toTransaction().Hash(), err)
- }
- if tracer.Equal(prevTracer) {
- return accessList, res.UsedGas, res.Err, nil
- }
- prevTracer = tracer
- }
- }
- // PublicTransactionPoolAPI exposes methods for the RPC interface
- type PublicTransactionPoolAPI struct {
- b Backend
- nonceLock *AddrLocker
- signer types.Signer
- }
- // NewPublicTransactionPoolAPI creates a new RPC service with methods specific for the transaction pool.
- func NewPublicTransactionPoolAPI(b Backend, nonceLock *AddrLocker) *PublicTransactionPoolAPI {
- // The signer used by the API should always be the 'latest' known one because we expect
- // signers to be backwards-compatible with old transactions.
- signer := types.LatestSigner(b.ChainConfig())
- return &PublicTransactionPoolAPI{b, nonceLock, signer}
- }
- // GetBlockTransactionCountByNumber returns the number of transactions in the block with the given block number.
- func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByNumber(ctx context.Context, blockNr rpc.BlockNumber) *hexutil.Uint {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- n := hexutil.Uint(len(block.Transactions()))
- return &n
- }
- return nil
- }
- // GetBlockTransactionCountByHash returns the number of transactions in the block with the given hash.
- func (s *PublicTransactionPoolAPI) GetBlockTransactionCountByHash(ctx context.Context, blockHash common.Hash) *hexutil.Uint {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- n := hexutil.Uint(len(block.Transactions()))
- return &n
- }
- return nil
- }
- // GetTransactionByBlockNumberAndIndex returns the transaction for the given block number and index.
- func (s *PublicTransactionPoolAPI) GetTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) *RPCTransaction {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- return newRPCTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetTransactionByBlockHashAndIndex returns the transaction for the given block hash and index.
- func (s *PublicTransactionPoolAPI) GetTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) *RPCTransaction {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- return newRPCTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetRawTransactionByBlockNumberAndIndex returns the bytes of the transaction for the given block number and index.
- func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockNumberAndIndex(ctx context.Context, blockNr rpc.BlockNumber, index hexutil.Uint) hexutil.Bytes {
- if block, _ := s.b.BlockByNumber(ctx, blockNr); block != nil {
- return newRPCRawTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetRawTransactionByBlockHashAndIndex returns the bytes of the transaction for the given block hash and index.
- func (s *PublicTransactionPoolAPI) GetRawTransactionByBlockHashAndIndex(ctx context.Context, blockHash common.Hash, index hexutil.Uint) hexutil.Bytes {
- if block, _ := s.b.BlockByHash(ctx, blockHash); block != nil {
- return newRPCRawTransactionFromBlockIndex(block, uint64(index))
- }
- return nil
- }
- // GetTransactionCount returns the number of transactions the given address has sent for the given block number
- func (s *PublicTransactionPoolAPI) GetTransactionCount(ctx context.Context, address common.Address, blockNrOrHash rpc.BlockNumberOrHash) (*hexutil.Uint64, error) {
- // Ask transaction pool for the nonce which includes pending transactions
- if blockNr, ok := blockNrOrHash.Number(); ok && blockNr == rpc.PendingBlockNumber {
- nonce, err := s.b.GetPoolNonce(ctx, address)
- if err != nil {
- return nil, err
- }
- return (*hexutil.Uint64)(&nonce), nil
- }
- // Resolve block number and use its state to ask for the nonce
- state, _, err := s.b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
- if state == nil || err != nil {
- return nil, err
- }
- nonce := state.GetNonce(address)
- return (*hexutil.Uint64)(&nonce), state.Error()
- }
- // Quorum
- type PrivacyMetadataWithMandatoryRecipients struct {
- *state.PrivacyMetadata
- MandatoryRecipients []string `json:"mandatoryFor,omitempty"`
- }
- func (s *PublicTransactionPoolAPI) GetContractPrivacyMetadata(ctx context.Context, address common.Address) (*PrivacyMetadataWithMandatoryRecipients, error) {
- state, _, err := s.b.StateAndHeaderByNumber(ctx, rpc.LatestBlockNumber)
- if state == nil || err != nil {
- return nil, err
- }
- var mandatoryRecipients []string
- privacyMetadata, err := state.GetPrivacyMetadata(address)
- if privacyMetadata == nil || err != nil {
- return nil, err
- }
- if privacyMetadata.PrivacyFlag == engine.PrivacyFlagMandatoryRecipients {
- mandatoryRecipients, err = private.P.GetMandatory(privacyMetadata.CreationTxHash)
- if len(mandatoryRecipients) == 0 || err != nil {
- return nil, err
- }
- }
- return &PrivacyMetadataWithMandatoryRecipients{privacyMetadata, mandatoryRecipients}, nil
- }
- // End Quorum
- // GetTransactionByHash returns the transaction for the given hash
- func (s *PublicTransactionPoolAPI) GetTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
- // Try to return an already finalized transaction
- tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- if tx != nil {
- return newRPCTransaction(tx, blockHash, blockNumber, index), nil
- }
- // No finalized transaction, try to retrieve it from the pool
- if tx := s.b.GetPoolTransaction(hash); tx != nil {
- return newRPCPendingTransaction(tx), nil
- }
- // Transaction unknown, return as such
- return nil, nil
- }
- // GetRawTransactionByHash returns the bytes of the transaction for the given hash.
- func (s *PublicTransactionPoolAPI) GetRawTransactionByHash(ctx context.Context, hash common.Hash) (hexutil.Bytes, error) {
- // Retrieve a finalized transaction, or a pooled otherwise
- tx, _, _, _, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- if tx == nil {
- if tx = s.b.GetPoolTransaction(hash); tx == nil {
- // Transaction not found anywhere, abort
- return nil, nil
- }
- }
- // Serialize to RLP and return
- return tx.MarshalBinary()
- }
- // GetTransactionReceipt returns the transaction receipt for the given transaction hash.
- func (s *PublicTransactionPoolAPI) GetTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
- tx, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, nil
- }
- receipts, err := s.b.GetReceipts(ctx, blockHash)
- if err != nil {
- return nil, err
- }
- if len(receipts) <= int(index) {
- return nil, nil
- }
- receipt := receipts[index]
- // Quorum: note that upstream code has been refactored into this method
- return getTransactionReceiptCommonCode(tx, blockHash, blockNumber, hash, index, receipt)
- }
- // Quorum
- // Common code extracted from GetTransactionReceipt() to enable reuse
- func getTransactionReceiptCommonCode(tx *types.Transaction, blockHash common.Hash, blockNumber uint64, hash common.Hash, index uint64, receipt *types.Receipt) (map[string]interface{}, error) {
- fields := map[string]interface{}{
- "blockHash": blockHash,
- "blockNumber": hexutil.Uint64(blockNumber),
- "transactionHash": hash,
- "transactionIndex": hexutil.Uint64(index),
- "from": tx.From(),
- "to": tx.To(),
- "gasUsed": hexutil.Uint64(receipt.GasUsed),
- "cumulativeGasUsed": hexutil.Uint64(receipt.CumulativeGasUsed),
- "contractAddress": nil,
- "logs": receipt.Logs,
- "logsBloom": receipt.Bloom,
- "type": hexutil.Uint(tx.Type()),
- // Quorum
- "isPrivacyMarkerTransaction": tx.IsPrivacyMarker(),
- }
- // Quorum
- if len(receipt.RevertReason) > 0 {
- fields["revertReason"] = hexutil.Encode(receipt.RevertReason)
- }
- // End Quorum
- // Assign receipt status or post state.
- if len(receipt.PostState) > 0 {
- fields["root"] = hexutil.Bytes(receipt.PostState)
- } else {
- fields["status"] = hexutil.Uint(receipt.Status)
- }
- if receipt.Logs == nil {
- fields["logs"] = [][]*types.Log{}
- }
- // If the ContractAddress is 20 0x0 bytes, assume it is not a contract creation
- if receipt.ContractAddress != (common.Address{}) {
- fields["contractAddress"] = receipt.ContractAddress
- }
- return fields, nil
- }
- // Quorum
- // GetPrivateTransactionByHash accepts the hash for a privacy marker transaction,
- // but returns the associated private transaction
- func (s *PublicTransactionPoolAPI) GetPrivateTransactionByHash(ctx context.Context, hash common.Hash) (*RPCTransaction, error) {
- if !private.IsQuorumPrivacyEnabled() {
- return nil, fmt.Errorf("PrivateTransactionManager is not enabled")
- }
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return nil, err
- }
- // first need the privacy marker transaction
- pmt, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- // now retrieve the private transaction
- if pmt != nil {
- tx, managedParties, _, err := private.FetchPrivateTransaction(pmt.Data())
- if err != nil {
- return nil, err
- }
- if tx != nil && !s.b.PSMR().NotIncludeAny(psm, managedParties...) {
- return newRPCTransaction(tx, blockHash, blockNumber, index), nil
- }
- }
- // Transaction unknown or not a participant in the private transaction, return as such
- return nil, nil
- }
- // Quorum
- // GetPrivateTransactionReceipt accepts the hash for a privacy marker transaction,
- // but returns the receipt of the associated private transaction
- func (s *PublicTransactionPoolAPI) GetPrivateTransactionReceipt(ctx context.Context, hash common.Hash) (map[string]interface{}, error) {
- // first need the privacy marker transaction
- pmt, blockHash, blockNumber, index, err := s.b.GetTransaction(ctx, hash)
- if err != nil {
- return nil, err
- }
- if pmt == nil {
- // Transaction unknown, return as such
- return nil, errors.New("privacy marker transaction not found")
- }
- // now retrieve the private transaction
- tx, _, _, err := private.FetchPrivateTransaction(pmt.Data())
- if err != nil {
- return nil, err
- }
- // Transaction not found, or not a participant in the private transaction, return as such
- if tx == nil {
- return nil, errors.New("private transaction not found for this participant")
- }
- // get receipt for the privacy marker transaction
- receipts, err := s.b.GetReceipts(ctx, blockHash)
- if err != nil {
- return nil, err
- }
- if len(receipts) <= int(index) {
- return nil, errors.New("could not find receipt for private transaction")
- }
- pmtReceipt := receipts[index]
- // now extract the receipt for the private transaction
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return nil, err
- }
- receipt := pmtReceipt.PSReceipts[psm.ID]
- if receipt == nil {
- return nil, errors.New("could not find receipt for private transaction")
- }
- return getTransactionReceiptCommonCode(tx, blockHash, blockNumber, hash, index, receipt)
- }
- // Quorum: if signing a private TX, set with tx.SetPrivate() before calling this method.
- // sign is a helper function that signs a transaction with the private key of the given address.
- func (s *PublicTransactionPoolAPI) sign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Quorum
- var chainID *big.Int
- if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) && !tx.IsPrivate() {
- chainID = config.ChainID
- }
- // /Quorum
- // Request the wallet to sign the transaction
- return wallet.SignTx(account, tx, chainID)
- }
- // SendTxArgs represents the arguments to sumbit a new transaction into the transaction pool.
- // Quorum: introducing additional arguments encapsulated in PrivateTxArgs struct
- // to support private transactions processing.
- type SendTxArgs struct {
- PrivateTxArgs // Quorum
- From common.Address `json:"from"`
- To *common.Address `json:"to"`
- Gas *hexutil.Uint64 `json:"gas"`
- GasPrice *hexutil.Big `json:"gasPrice"`
- Value *hexutil.Big `json:"value"`
- Nonce *hexutil.Uint64 `json:"nonce"`
- // We accept "data" and "input" for backwards-compatibility reasons. "input" is the
- // newer name and should be preferred by clients.
- Data *hexutil.Bytes `json:"data"`
- Input *hexutil.Bytes `json:"input"`
- // For non-legacy transactions
- AccessList *types.AccessList `json:"accessList,omitempty"`
- ChainID *hexutil.Big `json:"chainId,omitempty"`
- }
- func (s SendTxArgs) IsPrivate() bool {
- return s.PrivateFor != nil
- }
- // SendRawTxArgs represents the arguments to submit a new signed private transaction into the transaction pool.
- type SendRawTxArgs struct {
- PrivateTxArgs
- }
- // Additional arguments used in private transactions
- type PrivateTxArgs struct {
- // PrivateFrom is the public key of the sending party.
- // The public key must be available in the Private Transaction Manager (i.e.: Tessera) which is paired with this geth node.
- // Empty value means the Private Transaction Manager will use the first public key
- // in its list of available keys which it maintains.
- PrivateFrom string `json:"privateFrom"`
- // PrivateFor is the list of public keys which are available in the Private Transaction Managers in the network.
- // The transaction payload is only visible to those party to the transaction.
- PrivateFor []string `json:"privateFor"`
- PrivateTxType string `json:"restriction"`
- PrivacyFlag engine.PrivacyFlagType `json:"privacyFlag"`
- MandatoryRecipients []string `json:"mandatoryFor"`
- }
- func (args *PrivateTxArgs) SetDefaultPrivateFrom(ctx context.Context, b Backend) error {
- if args.PrivateFor != nil && len(args.PrivateFrom) == 0 && b.ChainConfig().IsMPS {
- psm, err := b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return err
- }
- args.PrivateFrom = psm.Addresses[0]
- }
- return nil
- }
- func (args *PrivateTxArgs) SetRawTransactionPrivateFrom(ctx context.Context, b Backend, tx *types.Transaction) error {
- if args.PrivateFor != nil && b.ChainConfig().IsMPS {
- hash := common.BytesToEncryptedPayloadHash(tx.Data())
- _, retrievedPrivateFrom, _, err := private.P.ReceiveRaw(hash)
- if err != nil {
- return err
- }
- if len(args.PrivateFrom) == 0 {
- args.PrivateFrom = retrievedPrivateFrom
- }
- if args.PrivateFrom != retrievedPrivateFrom {
- return fmt.Errorf("The PrivateFrom address retrieved from the privacy manager does not match private PrivateFrom (%s) specified in transaction arguments.", args.PrivateFrom)
- }
- psm, err := b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return err
- }
- if psm.NotIncludeAny(args.PrivateFrom) {
- return fmt.Errorf("The PrivateFrom address does not match the specified private state (%s)", psm.ID)
- }
- }
- return nil
- }
- // setDefaults fills in default values for unspecified tx fields.
- func (args *SendTxArgs) setDefaults(ctx context.Context, b Backend) error {
- if args.GasPrice == nil {
- price, err := b.SuggestPrice(ctx)
- if err != nil {
- return err
- }
- args.GasPrice = (*hexutil.Big)(price)
- }
- if args.Value == nil {
- args.Value = new(hexutil.Big)
- }
- if args.Nonce == nil {
- nonce, err := b.GetPoolNonce(ctx, args.From)
- if err != nil {
- return err
- }
- args.Nonce = (*hexutil.Uint64)(&nonce)
- }
- if args.Data != nil && args.Input != nil && !bytes.Equal(*args.Data, *args.Input) {
- return errors.New(`both "data" and "input" are set and not equal. Please use "input" to pass transaction call data`)
- }
- if args.To == nil {
- // Contract creation
- var input []byte
- if args.Data != nil {
- input = *args.Data
- } else if args.Input != nil {
- input = *args.Input
- }
- if len(input) == 0 {
- return errors.New(`contract creation without any data provided`)
- }
- }
- // Estimate the gas usage if necessary.
- if args.Gas == nil {
- // For backwards-compatibility reason, we try both input and data
- // but input is preferred.
- input := args.Input
- if input == nil {
- input = args.Data
- }
- callArgs := CallArgs{
- From: &args.From, // From shouldn't be nil
- To: args.To,
- GasPrice: args.GasPrice,
- Value: args.Value,
- Data: input,
- AccessList: args.AccessList,
- }
- pendingBlockNr := rpc.BlockNumberOrHashWithNumber(rpc.PendingBlockNumber)
- estimated, err := DoEstimateGas(ctx, b, callArgs, pendingBlockNr, b.RPCGasCap())
- if err != nil {
- return err
- }
- args.Gas = &estimated
- log.Trace("Estimate gas usage automatically", "gas", args.Gas)
- }
- if args.ChainID == nil {
- id := (*hexutil.Big)(b.ChainConfig().ChainID)
- args.ChainID = id
- }
- // Quorum
- if args.PrivateTxType == "" {
- args.PrivateTxType = "restricted"
- }
- return args.SetDefaultPrivateFrom(ctx, b)
- // End Quorum
- }
- // toTransaction converts the arguments to a transaction.
- // This assumes that setDefaults has been called.
- func (args *SendTxArgs) toTransaction() *types.Transaction {
- var input []byte
- if args.Input != nil {
- input = *args.Input
- } else if args.Data != nil {
- input = *args.Data
- }
- var data types.TxData
- if args.AccessList == nil {
- data = &types.LegacyTx{
- To: args.To,
- Nonce: uint64(*args.Nonce),
- Gas: uint64(*args.Gas),
- GasPrice: (*big.Int)(args.GasPrice),
- Value: (*big.Int)(args.Value),
- Data: input,
- }
- } else {
- data = &types.AccessListTx{
- To: args.To,
- ChainID: (*big.Int)(args.ChainID),
- Nonce: uint64(*args.Nonce),
- Gas: uint64(*args.Gas),
- GasPrice: (*big.Int)(args.GasPrice),
- Value: (*big.Int)(args.Value),
- Data: input,
- AccessList: *args.AccessList,
- }
- }
- return types.NewTx(data)
- }
- // SubmitTransaction is a helper function that submits tx to txPool and logs a message.
- func SubmitTransaction(ctx context.Context, b Backend, tx *types.Transaction, privateFrom string, isRaw bool) (common.Hash, error) {
- // If the transaction fee cap is already specified, ensure the
- // fee of the given transaction is _reasonable_.
- if err := checkTxFee(tx.GasPrice(), tx.Gas(), b.RPCTxFeeCap()); err != nil {
- return common.Hash{}, err
- }
- if !b.UnprotectedAllowed() && !tx.Protected() {
- // Ensure only eip155 signed transactions are submitted if EIP155Required is set.
- return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC")
- }
- // Print a log with full tx details for manual investigations and interventions
- // Quorum
- var signer types.Signer
- if tx.IsPrivate() {
- signer = types.QuorumPrivateTxSigner{}
- } else {
- signer = types.MakeSigner(b.ChainConfig(), b.CurrentBlock().Number())
- }
- from, err := types.Sender(signer, tx)
- if err != nil {
- return common.Hash{}, err
- }
- // Quorum
- // Need to do authorization check for Ethereum Account being used in signing.
- // We only care about private transactions (or the private transaction relating to a privacy marker)
- if token, ok := b.SupportsMultitenancy(ctx); ok {
- tx := tx
- // If we are sending a Privacy Marker Transaction, then get the private txn details
- if tx.IsPrivacyMarker() {
- tx, _, _, err = private.FetchPrivateTransaction(tx.Data())
- if err != nil {
- return common.Hash{}, err
- }
- }
- innerFrom, err := types.Sender(signer, tx)
- if err != nil {
- return common.Hash{}, err
- }
- if tx.IsPrivate() {
- psm, err := b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return common.Hash{}, err
- }
- eoaSecAttr := (&multitenancy.PrivateStateSecurityAttribute{}).WithPSI(psm.ID).WithSelfEOAIf(isRaw, innerFrom)
- psm, err = b.PSMR().ResolveForManagedParty(privateFrom)
- if err != nil {
- return common.Hash{}, err
- }
- privateFromSecAttr := (&multitenancy.PrivateStateSecurityAttribute{}).WithPSI(psm.ID).WithSelfEOAIf(isRaw, innerFrom)
- if isAuthorized, _ := multitenancy.IsAuthorized(token, eoaSecAttr, privateFromSecAttr); !isAuthorized {
- return common.Hash{}, multitenancy.ErrNotAuthorized
- }
- }
- }
- if !b.UnprotectedAllowed() && !tx.Protected() {
- // Ensure only eip155 signed transactions are submitted if EIP155Required is set.
- return common.Hash{}, errors.New("only replay-protected (EIP-155) transactions allowed over RPC")
- }
- if err := b.SendTx(ctx, tx); err != nil {
- return common.Hash{}, err
- }
- if tx.To() == nil {
- addr := crypto.CreateAddress(from, tx.Nonce())
- log.Info("Submitted contract creation", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "contract", addr.Hex(), "value", tx.Value())
- log.EmitCheckpoint(log.TxCreated, "tx", tx.Hash().Hex(), "to", addr.Hex())
- } else {
- log.Info("Submitted transaction", "hash", tx.Hash().Hex(), "from", from, "nonce", tx.Nonce(), "recipient", tx.To(), "value", tx.Value())
- log.EmitCheckpoint(log.TxCreated, "tx", tx.Hash().Hex(), "to", tx.To().Hex())
- }
- return tx.Hash(), nil
- }
- // runSimulation runs a simulation of the given transaction.
- // It returns the EVM instance upon completion
- func runSimulation(ctx context.Context, b Backend, from common.Address, tx *types.Transaction) (*vm.EVM, []byte, error) {
- defer func(start time.Time) {
- log.Debug("Simulated Execution EVM call finished", "runtime", time.Since(start))
- }(time.Now())
- // Set sender address or use a default if none specified
- addr := from
- if addr == (common.Address{}) {
- if wallets := b.AccountManager().Wallets(); len(wallets) > 0 {
- if accountList := wallets[0].Accounts(); len(accountList) > 0 {
- addr = accountList[0].Address
- }
- }
- }
- // Create new call message
- msg := types.NewMessage(addr, tx.To(), tx.Nonce(), tx.Value(), tx.Gas(), tx.GasPrice(), tx.Data(), tx.AccessList(), false)
- // Setup context with timeout as gas un-metered
- var cancel context.CancelFunc
- ctx, cancel = context.WithTimeout(ctx, time.Second*5)
- // Make sure the context is cancelled when the call has completed
- // this makes sure resources are cleaned up.
- defer func() { cancel() }()
- // Get a new instance of the EVM.
- blockNumber := b.CurrentBlock().Number().Uint64()
- stateAtBlock, header, err := b.StateAndHeaderByNumber(ctx, rpc.BlockNumber(blockNumber))
- if stateAtBlock == nil || err != nil {
- return nil, nil, err
- }
- evm, _, err := b.GetEVM(ctx, msg, stateAtBlock, header, &vm.Config{})
- if err != nil {
- return nil, nil, err
- }
- // Wait for the context to be done and cancel the evm. Even if the
- // EVM has finished, cancelling may be done (repeatedly)
- go func() {
- <-ctx.Done()
- evm.Cancel()
- }()
- var contractAddr common.Address
- // even the creation of a contract (init code) can invoke other contracts
- if tx.To() != nil {
- // removed contract availability checks as they are performed in checkAndHandlePrivateTransaction
- data, _, err := evm.Call(vm.AccountRef(addr), *tx.To(), tx.Data(), tx.Gas(), tx.Value())
- return evm, data, err
- } else {
- _, contractAddr, _, err = evm.Create(vm.AccountRef(addr), tx.Data(), tx.Gas(), tx.Value())
- //make sure that nonce is same in simulation as in actual block processing
- //simulation blockNumber will be behind block processing blockNumber by at least 1
- //only guaranteed to work for default config where EIP158=1
- if evm.ChainConfig().IsEIP158(big.NewInt(evm.Context.BlockNumber.Int64() + 1)) {
- evm.StateDB.SetNonce(contractAddr, 1)
- }
- }
- return evm, nil, err
- }
- // SendTransaction creates a transaction for the given argument, sign it and submit it to the
- // transaction pool.
- func (s *PublicTransactionPoolAPI) SendTransaction(ctx context.Context, args SendTxArgs) (common.Hash, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: args.From}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return common.Hash{}, err
- }
- if args.Nonce == nil {
- // Hold the addresse's mutex around signing to prevent concurrent assignment of
- // the same nonce to multiple accounts.
- s.nonceLock.LockAddr(args.From)
- defer s.nonceLock.UnlockAddr(args.From)
- }
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return common.Hash{}, err
- }
- _, replaceDataWithHash, data, err := checkAndHandlePrivateTransaction(ctx, s.b, args.toTransaction(), &args.PrivateTxArgs, args.From, NormalTransaction)
- if err != nil {
- return common.Hash{}, err
- }
- if replaceDataWithHash {
- // replace the original payload with encrypted payload hash
- args.Data = data.BytesTypeRef()
- }
- // /Quorum
- // Assemble the transaction and sign with the wallet
- tx := args.toTransaction()
- // Quorum
- if args.IsPrivate() {
- tx.SetPrivate()
- }
- var chainID *big.Int
- if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) && !tx.IsPrivate() {
- chainID = config.ChainID
- }
- // /Quorum
- signed, err := wallet.SignTx(account, tx, chainID)
- if err != nil {
- return common.Hash{}, err
- }
- // Quorum
- if signed.IsPrivate() && s.b.IsPrivacyMarkerTransactionCreationEnabled() {
- pmt, err := createPrivacyMarkerTransaction(s.b, signed, &args.PrivateTxArgs)
- if err != nil {
- log.Warn("Failed to create privacy marker transaction for private transaction", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- var pmtChainID *big.Int // PMT is public so will have different chainID used in signing compared to the internal tx
- if config := s.b.ChainConfig(); config.IsEIP155(s.b.CurrentBlock().Number()) {
- pmtChainID = config.ChainID
- }
- signed, err = wallet.SignTx(account, pmt, pmtChainID)
- if err != nil {
- log.Warn("Failed to sign privacy marker transaction for private transaction", "from", args.From, "to", args.To, "value", args.Value.ToInt(), "err", err)
- return common.Hash{}, err
- }
- }
- return SubmitTransaction(ctx, s.b, signed, args.PrivateFrom, false)
- }
- // FillTransaction fills the defaults (nonce, gas, gasPrice) on a given unsigned transaction,
- // and returns it to the caller for further processing (signing + broadcast)
- func (s *PublicTransactionPoolAPI) FillTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
- // Set some sanity defaults and terminate on failure
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Assemble the transaction and obtain rlp
- // Quorum
- isPrivate, replaceDataWithHash, hash, err := checkAndHandlePrivateTransaction(ctx, s.b, args.toTransaction(), &args.PrivateTxArgs, args.From, FillTransaction)
- if err != nil {
- return nil, err
- }
- if replaceDataWithHash {
- // replace the original payload with encrypted payload hash
- args.Data = hash.BytesTypeRef()
- }
- // /Quorum
- tx := args.toTransaction()
- // Quorum
- if isPrivate {
- tx.SetPrivate()
- }
- // /Quorum
- data, err := tx.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, tx}, nil
- }
- // SendRawTransaction will add the signed transaction to the transaction pool.
- // The sender is responsible for signing the transaction and using the correct nonce.
- func (s *PublicTransactionPoolAPI) SendRawTransaction(ctx context.Context, input hexutil.Bytes) (common.Hash, error) {
- tx := new(types.Transaction)
- if err := tx.UnmarshalBinary(input); err != nil {
- return common.Hash{}, err
- }
- return SubmitTransaction(ctx, s.b, tx, "", true)
- }
- // Quorum
- //
- // SendRawPrivateTransaction will add the signed transaction to the transaction pool.
- // The sender is responsible for signing the transaction and using the correct nonce.
- func (s *PublicTransactionPoolAPI) SendRawPrivateTransaction(ctx context.Context, encodedTx hexutil.Bytes, args SendRawTxArgs) (common.Hash, error) {
- tx := new(types.Transaction)
- if err := tx.UnmarshalBinary(encodedTx); err != nil {
- return common.Hash{}, err
- }
- // Quorum
- if err := args.SetRawTransactionPrivateFrom(ctx, s.b, tx); err != nil {
- return common.Hash{}, err
- }
- isPrivate, _, _, err := checkAndHandlePrivateTransaction(ctx, s.b, tx, &args.PrivateTxArgs, common.Address{}, RawTransaction)
- if err != nil {
- return common.Hash{}, err
- }
- if !isPrivate {
- return common.Hash{}, fmt.Errorf("transaction is not private")
- }
- return SubmitTransaction(ctx, s.b, tx, args.PrivateFrom, true)
- }
- // DistributePrivateTransaction will perform the simulation checks and send the private transactions data to the other
- // private participants
- // It then submits the entire private transaction to the attached PTM and sends it to other private participants,
- // return the PTM generated hash, intended to be used in the Input field of a Privacy Marker Transaction
- func (s *PublicTransactionPoolAPI) DistributePrivateTransaction(ctx context.Context, encodedTx hexutil.Bytes, args SendRawTxArgs) (string, error) {
- log.Info("distributing raw private tx")
- tx := new(types.Transaction)
- if err := rlp.DecodeBytes(encodedTx, tx); err != nil {
- return "", err
- }
- log.Debug("deserialised raw private tx", "hash", tx.Hash())
- // Quorum
- if err := args.SetRawTransactionPrivateFrom(ctx, s.b, tx); err != nil {
- return "", err
- }
- isPrivate, _, _, err := checkAndHandlePrivateTransaction(ctx, s.b, tx, &args.PrivateTxArgs, common.Address{}, RawTransaction)
- if err != nil {
- return "", err
- }
- if !isPrivate {
- return "", fmt.Errorf("transaction is not private")
- }
- serialisedTx, err := json.Marshal(tx)
- if err != nil {
- return "", err
- }
- _, _, txnHash, err := private.P.Send(serialisedTx, args.PrivateFrom, args.PrivateFor, &engine.ExtraMetadata{})
- if err != nil {
- return "", err
- }
- log.Debug("private transaction sent to PTM", "generated ptm-hash", txnHash)
- return txnHash.Hex(), nil
- }
- // /Quorum
- // Sign calculates an ECDSA signature for:
- // keccack256("\x19Ethereum Signed Message:\n" + len(message) + message).
- //
- // Note, the produced signature conforms to the secp256k1 curve R, S and V values,
- // where the V value will be 27 or 28 for legacy reasons.
- //
- // The account associated with addr must be unlocked.
- //
- // https://github.com/ethereum/wiki/wiki/JSON-RPC#eth_sign
- func (s *PublicTransactionPoolAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.Bytes, error) {
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: addr}
- wallet, err := s.b.AccountManager().Find(account)
- if err != nil {
- return nil, err
- }
- // Sign the requested hash with the wallet
- signature, err := wallet.SignText(account, data)
- if err == nil {
- signature[64] += 27 // Transform V from 0/1 to 27/28 according to the yellow paper
- }
- return signature, err
- }
- // SignTransactionResult represents a RLP encoded signed transaction.
- type SignTransactionResult struct {
- Raw hexutil.Bytes `json:"raw"`
- Tx *types.Transaction `json:"tx"`
- }
- // SignTransaction will sign the given transaction with the from account.
- // The node needs to have the private key of the account corresponding with
- // the given from address and it needs to be unlocked.
- func (s *PublicTransactionPoolAPI) SignTransaction(ctx context.Context, args SendTxArgs) (*SignTransactionResult, error) {
- if args.Gas == nil {
- return nil, fmt.Errorf("gas not specified")
- }
- if args.GasPrice == nil {
- return nil, fmt.Errorf("gasPrice not specified")
- }
- if args.Nonce == nil {
- return nil, fmt.Errorf("nonce not specified")
- }
- // Quorum
- // setDefaults calls DoEstimateGas in ethereum1.9.0, private transaction is not supported for that feature
- // set gas to constant if nil
- if args.IsPrivate() && args.Gas == nil {
- gas := (hexutil.Uint64)(90000)
- args.Gas = &gas
- }
- // End Quorum
- if err := args.setDefaults(ctx, s.b); err != nil {
- return nil, err
- }
- // Before actually sign the transaction, ensure the transaction fee is reasonable.
- if err := checkTxFee(args.GasPrice.ToInt(), uint64(*args.Gas), s.b.RPCTxFeeCap()); err != nil {
- return nil, err
- }
- // Quorum
- toSign := args.toTransaction()
- if args.IsPrivate() {
- toSign.SetPrivate()
- }
- // End Quorum
- tx, err := s.sign(args.From, toSign)
- if err != nil {
- return nil, err
- }
- data, err := tx.MarshalBinary()
- if err != nil {
- return nil, err
- }
- return &SignTransactionResult{data, tx}, nil
- }
- // PendingTransactions returns the transactions that are in the transaction pool
- // and have a from address that is one of the accounts this node manages.
- func (s *PublicTransactionPoolAPI) PendingTransactions() ([]*RPCTransaction, error) {
- pending, err := s.b.GetPoolTransactions()
- if err != nil {
- return nil, err
- }
- accounts := make(map[common.Address]struct{})
- for _, wallet := range s.b.AccountManager().Wallets() {
- for _, account := range wallet.Accounts() {
- accounts[account.Address] = struct{}{}
- }
- }
- transactions := make([]*RPCTransaction, 0, len(pending))
- for _, tx := range pending {
- from, _ := types.Sender(s.signer, tx)
- if _, exists := accounts[from]; exists {
- transactions = append(transactions, newRPCPendingTransaction(tx))
- }
- }
- return transactions, nil
- }
- // Resend accepts an existing transaction and a new gas price and limit. It will remove
- // the given transaction from the pool and reinsert it with the new gas price and limit.
- func (s *PublicTransactionPoolAPI) Resend(ctx context.Context, sendArgs SendTxArgs, gasPrice *hexutil.Big, gasLimit *hexutil.Uint64) (common.Hash, error) {
- if sendArgs.Nonce == nil {
- return common.Hash{}, fmt.Errorf("missing transaction nonce in transaction spec")
- }
- // setDefaults calls DoEstimateGas in ethereum1.9.0, private transaction is not supported for that feature
- // set gas to constant if nil
- if sendArgs.IsPrivate() && sendArgs.Gas == nil {
- gas := (hexutil.Uint64)(90000)
- sendArgs.Gas = &gas
- }
- if err := sendArgs.setDefaults(ctx, s.b); err != nil {
- return common.Hash{}, err
- }
- matchTx := sendArgs.toTransaction()
- // Before replacing the old transaction, ensure the _new_ transaction fee is reasonable.
- var price = matchTx.GasPrice()
- if gasPrice != nil {
- price = gasPrice.ToInt()
- }
- var gas = matchTx.Gas()
- if gasLimit != nil {
- gas = uint64(*gasLimit)
- }
- if err := checkTxFee(price, gas, s.b.RPCTxFeeCap()); err != nil {
- return common.Hash{}, err
- }
- // Iterate the pending list for replacement
- pending, err := s.b.GetPoolTransactions()
- if err != nil {
- return common.Hash{}, err
- }
- for _, p := range pending {
- wantSigHash := s.signer.Hash(matchTx)
- pFrom, err := types.Sender(s.signer, p)
- if err == nil && pFrom == sendArgs.From && s.signer.Hash(p) == wantSigHash {
- // Match. Re-sign and send the transaction.
- if gasPrice != nil && (*big.Int)(gasPrice).Sign() != 0 {
- sendArgs.GasPrice = gasPrice
- }
- if gasLimit != nil && *gasLimit != 0 {
- sendArgs.Gas = gasLimit
- }
- newTx := sendArgs.toTransaction()
- // set v param to 37 to indicate private tx before submitting to the signer.
- if sendArgs.IsPrivate() {
- newTx.SetPrivate()
- }
- signedTx, err := s.sign(sendArgs.From, newTx)
- if err != nil {
- return common.Hash{}, err
- }
- if err = s.b.SendTx(ctx, signedTx); err != nil {
- return common.Hash{}, err
- }
- return signedTx.Hash(), nil
- }
- }
- return common.Hash{}, fmt.Errorf("transaction %#x not found", matchTx.Hash())
- }
- // PublicDebugAPI is the collection of Ethereum APIs exposed over the public
- // debugging endpoint.
- type PublicDebugAPI struct {
- b Backend
- }
- // NewPublicDebugAPI creates a new API definition for the public debug methods
- // of the Ethereum service.
- func NewPublicDebugAPI(b Backend) *PublicDebugAPI {
- return &PublicDebugAPI{b: b}
- }
- // GetBlockRlp retrieves the RLP encoded for of a single block.
- func (api *PublicDebugAPI) GetBlockRlp(ctx context.Context, number uint64) (string, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return "", fmt.Errorf("block #%d not found", number)
- }
- encoded, err := rlp.EncodeToBytes(block)
- if err != nil {
- return "", err
- }
- return fmt.Sprintf("%x", encoded), nil
- }
- // TestSignCliqueBlock fetches the given block number, and attempts to sign it as a clique header with the
- // given address, returning the address of the recovered signature
- //
- // This is a temporary method to debug the externalsigner integration,
- // TODO: Remove this method when the integration is mature
- func (api *PublicDebugAPI) TestSignCliqueBlock(ctx context.Context, address common.Address, number uint64) (common.Address, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return common.Address{}, fmt.Errorf("block #%d not found", number)
- }
- header := block.Header()
- header.Extra = make([]byte, 32+65)
- encoded := clique.CliqueRLP(header)
- // Look up the wallet containing the requested signer
- account := accounts.Account{Address: address}
- wallet, err := api.b.AccountManager().Find(account)
- if err != nil {
- return common.Address{}, err
- }
- signature, err := wallet.SignData(account, accounts.MimetypeClique, encoded)
- if err != nil {
- return common.Address{}, err
- }
- sealHash := clique.SealHash(header).Bytes()
- log.Info("test signing of clique block",
- "Sealhash", fmt.Sprintf("%x", sealHash),
- "signature", fmt.Sprintf("%x", signature))
- pubkey, err := crypto.Ecrecover(sealHash, signature)
- if err != nil {
- return common.Address{}, err
- }
- var signer common.Address
- copy(signer[:], crypto.Keccak256(pubkey[1:])[12:])
- return signer, nil
- }
- // PrintBlock retrieves a block and returns its pretty printed form.
- func (api *PublicDebugAPI) PrintBlock(ctx context.Context, number uint64) (string, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return "", fmt.Errorf("block #%d not found", number)
- }
- return spew.Sdump(block), nil
- }
- // SeedHash retrieves the seed hash of a block.
- func (api *PublicDebugAPI) SeedHash(ctx context.Context, number uint64) (string, error) {
- block, _ := api.b.BlockByNumber(ctx, rpc.BlockNumber(number))
- if block == nil {
- return "", fmt.Errorf("block #%d not found", number)
- }
- return fmt.Sprintf("0x%x", ethash.SeedHash(number)), nil
- }
- // PrivateDebugAPI is the collection of Ethereum APIs exposed over the private
- // debugging endpoint.
- type PrivateDebugAPI struct {
- b Backend
- }
- // NewPrivateDebugAPI creates a new API definition for the private debug methods
- // of the Ethereum service.
- func NewPrivateDebugAPI(b Backend) *PrivateDebugAPI {
- return &PrivateDebugAPI{b: b}
- }
- // ChaindbProperty returns leveldb properties of the key-value database.
- func (api *PrivateDebugAPI) ChaindbProperty(property string) (string, error) {
- if property == "" {
- property = "leveldb.stats"
- } else if !strings.HasPrefix(property, "leveldb.") {
- property = "leveldb." + property
- }
- return api.b.ChainDb().Stat(property)
- }
- // ChaindbCompact flattens the entire key-value database into a single level,
- // removing all unused slots and merging all keys.
- func (api *PrivateDebugAPI) ChaindbCompact() error {
- for b := byte(0); b < 255; b++ {
- log.Info("Compacting chain database", "range", fmt.Sprintf("0x%0.2X-0x%0.2X", b, b+1))
- if err := api.b.ChainDb().Compact([]byte{b}, []byte{b + 1}); err != nil {
- log.Error("Database compaction failed", "err", err)
- return err
- }
- }
- return nil
- }
- // SetHead rewinds the head of the blockchain to a previous block.
- func (api *PrivateDebugAPI) SetHead(number hexutil.Uint64) {
- api.b.SetHead(uint64(number))
- }
- // PublicNetAPI offers network related RPC methods
- type PublicNetAPI struct {
- net *p2p.Server
- networkVersion uint64
- }
- // NewPublicNetAPI creates a new net API instance.
- func NewPublicNetAPI(net *p2p.Server, networkVersion uint64) *PublicNetAPI {
- return &PublicNetAPI{net, networkVersion}
- }
- // Listening returns an indication if the node is listening for network connections.
- func (s *PublicNetAPI) Listening() bool {
- return true // always listening
- }
- // PeerCount returns the number of connected peers
- func (s *PublicNetAPI) PeerCount() hexutil.Uint {
- return hexutil.Uint(s.net.PeerCount())
- }
- // Version returns the current ethereum protocol version.
- func (s *PublicNetAPI) Version() string {
- return fmt.Sprintf("%d", s.networkVersion)
- }
- // checkTxFee is an internal function used to check whether the fee of
- // the given transaction is _reasonable_(under the cap).
- func checkTxFee(gasPrice *big.Int, gas uint64, cap float64) error {
- // Short circuit if there is no cap for transaction fee at all.
- if cap == 0 {
- return nil
- }
- feeEth := new(big.Float).Quo(new(big.Float).SetInt(new(big.Int).Mul(gasPrice, new(big.Int).SetUint64(gas))), new(big.Float).SetInt(big.NewInt(params.Ether)))
- feeFloat, _ := feeEth.Float64()
- if feeFloat > cap {
- return fmt.Errorf("tx fee (%.2f ether) exceeds the configured cap (%.2f ether)", feeFloat, cap)
- }
- return nil
- }
- // toHexSlice creates a slice of hex-strings based on []byte.
- func toHexSlice(b [][]byte) []string {
- r := make([]string, len(b))
- for i := range b {
- r[i] = hexutil.Encode(b[i])
- }
- return r
- }
- // Quorum
- // Please note: This is a temporary integration to improve performance in high-latency
- // environments when sending many private transactions. It will be removed at a later
- // date when account management is handled outside Ethereum.
- type AsyncSendTxArgs struct {
- SendTxArgs
- CallbackUrl string `json:"callbackUrl"`
- }
- type AsyncResultSuccess struct {
- Id string `json:"id,omitempty"`
- TxHash common.Hash `json:"txHash"`
- }
- type AsyncResultFailure struct {
- Id string `json:"id,omitempty"`
- Error string `json:"error"`
- }
- type Async struct {
- sync.Mutex
- sem chan struct{}
- }
- func (s *PublicTransactionPoolAPI) send(ctx context.Context, asyncArgs AsyncSendTxArgs) {
- txHash, err := s.SendTransaction(ctx, asyncArgs.SendTxArgs)
- if asyncArgs.CallbackUrl != "" {
- //don't need to nil check this since id is required for every geth rpc call
- //even though this is stated in the specification as an "optional" parameter
- jsonId := ctx.Value("id").(*json.RawMessage)
- id := string(*jsonId)
- var resultResponse interface{}
- if err != nil {
- resultResponse = &AsyncResultFailure{Id: id, Error: err.Error()}
- } else {
- resultResponse = &AsyncResultSuccess{Id: id, TxHash: txHash}
- }
- buf := new(bytes.Buffer)
- err := json.NewEncoder(buf).Encode(resultResponse)
- if err != nil {
- log.Info("Error encoding callback JSON", "err", err.Error())
- return
- }
- _, err = http.Post(asyncArgs.CallbackUrl, "application/json", buf)
- if err != nil {
- log.Info("Error sending callback", "err", err.Error())
- return
- }
- }
- }
- func newAsync(n int) *Async {
- a := &Async{
- sem: make(chan struct{}, n),
- }
- return a
- }
- var async = newAsync(100)
- // SendTransactionAsync creates a transaction for the given argument, signs it, and
- // submits it to the transaction pool. This call returns immediately to allow sending
- // many private transactions/bursts of transactions without waiting for the recipient
- // parties to confirm receipt of the encrypted payloads. An optional callbackUrl may
- // be specified--when a transaction is submitted to the transaction pool, it will be
- // called with a POST request containing either {"error": "error message"} or
- // {"txHash": "0x..."}.
- //
- // Please note: This is a temporary integration to improve performance in high-latency
- // environments when sending many private transactions. It will be removed at a later
- // date when account management is handled outside Ethereum.
- func (s *PublicTransactionPoolAPI) SendTransactionAsync(ctx context.Context, args AsyncSendTxArgs) (common.Hash, error) {
- select {
- case async.sem <- struct{}{}:
- go func() {
- s.send(ctx, args)
- <-async.sem
- }()
- return common.Hash{}, nil
- default:
- return common.Hash{}, errors.New("too many concurrent requests")
- }
- }
- // GetQuorumPayload returns the contents of a private transaction
- func (s *PublicBlockChainAPI) GetQuorumPayload(ctx context.Context, digestHex string) (string, error) {
- if !private.IsQuorumPrivacyEnabled() {
- return "", fmt.Errorf("PrivateTransactionManager is not enabled")
- }
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return "", err
- }
- if len(digestHex) < 3 {
- return "", fmt.Errorf("Invalid digest hex")
- }
- if digestHex[:2] == "0x" {
- digestHex = digestHex[2:]
- }
- b, err := hex.DecodeString(digestHex)
- if err != nil {
- return "", err
- }
- if len(b) != common.EncryptedPayloadHashLength {
- return "", fmt.Errorf("Expected a Quorum digest of length 64, but got %d", len(b))
- }
- _, managedParties, data, _, err := private.P.Receive(common.BytesToEncryptedPayloadHash(b))
- if err != nil {
- return "", err
- }
- if s.b.PSMR().NotIncludeAny(psm, managedParties...) {
- return "0x", nil
- }
- return fmt.Sprintf("0x%x", data), nil
- }
- func (s *PublicBlockChainAPI) GetQuorumPayloadExtra(ctx context.Context, digestHex string) (*engine.QuorumPayloadExtra, error) {
- if !private.IsQuorumPrivacyEnabled() {
- return nil, fmt.Errorf("PrivateTransactionManager is not enabled")
- }
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return nil, err
- }
- if len(digestHex) < 3 {
- return nil, fmt.Errorf("Invalid digest hex")
- }
- if digestHex[:2] == "0x" {
- digestHex = digestHex[2:]
- }
- b, err := hex.DecodeString(digestHex)
- if err != nil {
- return nil, err
- }
- if len(b) != common.EncryptedPayloadHashLength {
- return nil, fmt.Errorf("Expected a Quorum digest of length 64, but got %d", len(b))
- }
- _, managedParties, data, extraMetaData, err := private.P.Receive(common.BytesToEncryptedPayloadHash(b))
- if err != nil {
- return nil, err
- }
- if s.b.PSMR().NotIncludeAny(psm, managedParties...) {
- return nil, nil
- }
- isSender := false
- if len(psm.Addresses) == 0 {
- isSender, _ = private.P.IsSender(common.BytesToEncryptedPayloadHash(b))
- } else {
- isSender = !psm.NotIncludeAny(extraMetaData.Sender)
- }
- return &engine.QuorumPayloadExtra{
- Payload: fmt.Sprintf("0x%x", data),
- ExtraMetaData: extraMetaData,
- IsSender: isSender,
- }, nil
- }
- // DecryptQuorumPayload returns the decrypted version of the input transaction
- func (s *PublicBlockChainAPI) DecryptQuorumPayload(ctx context.Context, payloadHex string) (*engine.QuorumPayloadExtra, error) {
- if !private.IsQuorumPrivacyEnabled() {
- return nil, fmt.Errorf("PrivateTransactionManager is not enabled")
- }
- psm, err := s.b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return nil, err
- }
- if len(payloadHex) < 3 {
- return nil, fmt.Errorf("Invalid payload hex")
- }
- if payloadHex[:2] == "0x" {
- payloadHex = payloadHex[2:]
- }
- b, err := hex.DecodeString(payloadHex)
- if err != nil {
- return nil, err
- }
- var payload common.DecryptRequest
- if err := json.Unmarshal(b, &payload); err != nil {
- return nil, err
- }
- // if we are MPS and the sender is not part of the resolved PSM - return empty
- if len(psm.Addresses) != 0 && psm.NotIncludeAny(base64.StdEncoding.EncodeToString(payload.SenderKey)) {
- return nil, nil
- }
- data, extraMetaData, err := private.P.DecryptPayload(payload)
- if err != nil {
- return nil, err
- }
- return &engine.QuorumPayloadExtra{
- Payload: fmt.Sprintf("0x%x", data),
- ExtraMetaData: extraMetaData,
- IsSender: true,
- }, nil
- }
- // Quorum
- // for raw private transaction, privateTxArgs.privateFrom will be updated with value from Tessera when payload is retrieved
- func checkAndHandlePrivateTransaction(ctx context.Context, b Backend, tx *types.Transaction, privateTxArgs *PrivateTxArgs, from common.Address, txnType TransactionType) (isPrivate bool, replaceDataWithHash bool, hash common.EncryptedPayloadHash, err error) {
- replaceDataWithHash = false
- isPrivate = privateTxArgs != nil && privateTxArgs.PrivateFor != nil
- if !isPrivate {
- return
- }
- if err = privateTxArgs.PrivacyFlag.Validate(); err != nil {
- return
- }
- if !b.ChainConfig().IsPrivacyEnhancementsEnabled(b.CurrentBlock().Number()) && privateTxArgs.PrivacyFlag.IsNotStandardPrivate() {
- err = fmt.Errorf("PrivacyEnhancements are disabled. Can only accept transactions with PrivacyFlag=0(StandardPrivate).")
- return
- }
- if engine.PrivacyFlagMandatoryRecipients == privateTxArgs.PrivacyFlag && len(privateTxArgs.MandatoryRecipients) == 0 {
- err = fmt.Errorf("missing mandatory recipients data. if no mandatory recipients required consider using PrivacyFlag=1(PartyProtection)")
- return
- }
- if engine.PrivacyFlagMandatoryRecipients != privateTxArgs.PrivacyFlag && len(privateTxArgs.MandatoryRecipients) > 0 {
- err = fmt.Errorf("privacy metadata invalid. mandatory recipients are only applicable for PrivacyFlag=2(MandatoryRecipients)")
- return
- }
- // validate that PrivateFrom is one of the addresses of the private state resolved from the user context
- if b.ChainConfig().IsMPS {
- var psm *mps.PrivateStateMetadata
- psm, err = b.PSMR().ResolveForUserContext(ctx)
- if err != nil {
- return
- }
- if psm.NotIncludeAny(privateTxArgs.PrivateFrom) {
- err = fmt.Errorf("The PrivateFrom (%s) address does not match the specified private state (%s) ", privateTxArgs.PrivateFrom, psm.ID)
- return
- }
- }
- if len(tx.Data()) > 0 {
- // check private contract exists on the node initiating the transaction
- if tx.To() != nil && privateTxArgs.PrivacyFlag.IsNotStandardPrivate() {
- state, _, lerr := b.StateAndHeaderByNumber(ctx, rpc.BlockNumber(b.CurrentBlock().Number().Uint64()))
- if lerr != nil && state == nil {
- err = fmt.Errorf("state not found")
- return
- }
- if state.GetCode(*tx.To()) == nil {
- err = fmt.Errorf("contract not found. cannot transact")
- return
- }
- }
- replaceDataWithHash = true
- hash, err = handlePrivateTransaction(ctx, b, tx, privateTxArgs, from, txnType)
- }
- return
- }
- // Quorum
- // If transaction is raw, the tx payload is indeed the hash of the encrypted payload.
- // Then the sender key will set to privateTxArgs.privateFrom.
- //
- // For private transaction, run a simulated execution in order to
- // 1. Find all affected private contract accounts then retrieve encrypted payload hashes of their creation txs
- // 2. Calculate Merkle Root as the result of the simulated execution
- // The above information along with private originating payload are sent to Transaction Manager
- // to obtain hash of the encrypted private payload
- func handlePrivateTransaction(ctx context.Context, b Backend, tx *types.Transaction, privateTxArgs *PrivateTxArgs, from common.Address, txnType TransactionType) (hash common.EncryptedPayloadHash, err error) {
- defer func(start time.Time) {
- log.Debug("Handle Private Transaction finished", "took", time.Since(start))
- }(time.Now())
- data := tx.Data()
- log.Debug("sending private tx", "txnType", txnType, "data", common.FormatTerminalString(data), "privatefrom", privateTxArgs.PrivateFrom, "privatefor", privateTxArgs.PrivateFor, "privacyFlag", privateTxArgs.PrivacyFlag, "mandatoryfor", privateTxArgs.MandatoryRecipients)
- switch txnType {
- case FillTransaction:
- hash, err = private.P.StoreRaw(data, privateTxArgs.PrivateFrom)
- case RawTransaction:
- hash, err = handleRawPrivateTransaction(ctx, b, tx, privateTxArgs, from)
- case NormalTransaction:
- hash, err = handleNormalPrivateTransaction(ctx, b, tx, data, privateTxArgs, from)
- }
- return
- }
- // Quorum
- func handleRawPrivateTransaction(ctx context.Context, b Backend, tx *types.Transaction, privateTxArgs *PrivateTxArgs, from common.Address) (hash common.EncryptedPayloadHash, err error) {
- data := tx.Data()
- hash = common.BytesToEncryptedPayloadHash(data)
- privatePayload, privateFrom, _, revErr := private.P.ReceiveRaw(hash)
- if revErr != nil {
- return common.EncryptedPayloadHash{}, revErr
- }
- log.Trace("received raw payload", "hash", hash, "privatepayload", common.FormatTerminalString(privatePayload), "privateFrom", privateFrom)
- privateTxArgs.PrivateFrom = privateFrom
- var privateTx *types.Transaction
- if tx.To() == nil {
- privateTx = types.NewContractCreation(tx.Nonce(), tx.Value(), tx.Gas(), tx.GasPrice(), privatePayload)
- } else {
- privateTx = types.NewTransaction(tx.Nonce(), *tx.To(), tx.Value(), tx.Gas(), tx.GasPrice(), privatePayload)
- }
- affectedCATxHashes, merkleRoot, err := simulateExecutionForPE(ctx, b, from, privateTx, privateTxArgs)
- log.Trace("after simulation", "affectedCATxHashes", affectedCATxHashes, "merkleRoot", merkleRoot, "privacyFlag", privateTxArgs.PrivacyFlag, "error", err)
- if err != nil {
- return
- }
- metadata := engine.ExtraMetadata{
- ACHashes: affectedCATxHashes,
- ACMerkleRoot: merkleRoot,
- PrivacyFlag: privateTxArgs.PrivacyFlag,
- MandatoryRecipients: privateTxArgs.MandatoryRecipients,
- }
- _, _, data, err = private.P.SendSignedTx(hash, privateTxArgs.PrivateFor, &metadata)
- if err != nil {
- return
- }
- log.Info("sent raw private signed tx",
- "data", common.FormatTerminalString(data),
- "hash", hash,
- "privatefrom", privateTxArgs.PrivateFrom,
- "privatefor", privateTxArgs.PrivateFor,
- "affectedCATxHashes", metadata.ACHashes,
- "merkleroot", metadata.ACHashes,
- "privacyflag", metadata.PrivacyFlag,
- "mandatoryrecipients", metadata.MandatoryRecipients)
- return
- }
- // Quorum
- func handleNormalPrivateTransaction(ctx context.Context, b Backend, tx *types.Transaction, data []byte, privateTxArgs *PrivateTxArgs, from common.Address) (hash common.EncryptedPayloadHash, err error) {
- affectedCATxHashes, merkleRoot, err := simulateExecutionForPE(ctx, b, from, tx, privateTxArgs)
- log.Trace("after simulation", "affectedCATxHashes", affectedCATxHashes, "merkleRoot", merkleRoot, "privacyFlag", privateTxArgs.PrivacyFlag, "error", err)
- if err != nil {
- return
- }
- metadata := engine.ExtraMetadata{
- ACHashes: affectedCATxHashes,
- ACMerkleRoot: merkleRoot,
- PrivacyFlag: privateTxArgs.PrivacyFlag,
- MandatoryRecipients: privateTxArgs.MandatoryRecipients,
- }
- _, _, hash, err = private.P.Send(data, privateTxArgs.PrivateFrom, privateTxArgs.PrivateFor, &metadata)
- if err != nil {
- return
- }
- log.Info("sent private signed tx",
- "data", common.FormatTerminalString(data),
- "hash", hash,
- "privatefrom", privateTxArgs.PrivateFrom,
- "privatefor", privateTxArgs.PrivateFor,
- "affectedCATxHashes", metadata.ACHashes,
- "merkleroot", metadata.ACHashes,
- "privacyflag", metadata.PrivacyFlag,
- "mandatoryrecipients", metadata.MandatoryRecipients)
- return
- }
- // (Quorum) createPrivacyMarkerTransaction creates a new privacy marker transaction (PMT) with the given signed privateTx.
- // The private tx is sent only to the privateFor recipients. The resulting PMT's 'to' is the privacy precompile address and its 'data' is the
- // privacy manager hash for the private tx.
- func createPrivacyMarkerTransaction(b Backend, privateTx *types.Transaction, privateTxArgs *PrivateTxArgs) (*types.Transaction, error) {
- log.Trace("creating privacy marker transaction", "from", privateTx.From(), "to", privateTx.To())
- data := new(bytes.Buffer)
- err := json.NewEncoder(data).Encode(privateTx)
- if err != nil {
- return nil, err
- }
- _, _, ptmHash, err := private.P.Send(data.Bytes(), privateTxArgs.PrivateFrom, privateTxArgs.PrivateFor, &engine.ExtraMetadata{})
- if err != nil {
- return nil, err
- }
- currentBlockHeight := b.CurrentHeader().Number
- istanbul := b.ChainConfig().IsIstanbul(currentBlockHeight)
- intrinsicGas, err := core.IntrinsicGas(ptmHash.Bytes(), privateTx.AccessList(), false, true, istanbul)
- if err != nil {
- return nil, err
- }
- pmt := types.NewTransaction(privateTx.Nonce(), common.QuorumPrivacyPrecompileContractAddress(), privateTx.Value(), intrinsicGas, privateTx.GasPrice(), ptmHash.Bytes())
- return pmt, nil
- }
- // Quorum
- // simulateExecutionForPE simulates execution of a private transaction for enhanced privacy
- //
- // Returns hashes of encrypted payload of creation transactions for all affected contract accounts
- // and the merkle root combining all affected contract accounts after the simulation
- func simulateExecutionForPE(ctx context.Context, b Backend, from common.Address, privateTx *types.Transaction, privateTxArgs *PrivateTxArgs) (common.EncryptedPayloadHashes, common.Hash, error) {
- // skip simulation if privacy enhancements are disabled
- if !b.ChainConfig().IsPrivacyEnhancementsEnabled(b.CurrentBlock().Number()) {
- return nil, common.Hash{}, nil
- }
- evm, data, err := runSimulation(ctx, b, from, privateTx)
- if evm == nil {
- log.Debug("TX Simulation setup failed", "error", err)
- return nil, common.Hash{}, err
- }
- if err != nil {
- if privateTxArgs.PrivacyFlag.IsStandardPrivate() {
- log.Debug("An error occurred during StandardPrivate transaction simulation. "+
- "Continuing to simulation checks.", "error", err)
- } else {
- log.Trace("Simulated execution", "error", err)
- if len(data) > 0 && errors.Is(err, vm.ErrExecutionReverted) {
- reason, errUnpack := abi.UnpackRevert(data)
- reasonError := errors.New("execution reverted")
- if errUnpack == nil {
- reasonError = fmt.Errorf("execution reverted: %v", reason)
- }
- err = &revertError{
- error: reasonError,
- reason: hexutil.Encode(data),
- }
- }
- return nil, common.Hash{}, err
- }
- }
- affectedContractsHashes := make(common.EncryptedPayloadHashes)
- var merkleRoot common.Hash
- addresses := evm.AffectedContracts()
- privacyFlag := privateTxArgs.PrivacyFlag
- log.Trace("after simulation run", "numberOfAffectedContracts", len(addresses), "privacyFlag", privacyFlag)
- for _, addr := range addresses {
- // GetPrivacyMetadata is invoked directly on the privateState (as the tx is private) and it returns:
- // 1. public contacts: privacyMetadata = nil, err = nil
- // 2. private contracts of type:
- // 2.1. StandardPrivate: privacyMetadata = nil, err = "The provided contract does not have privacy metadata"
- // 2.2. PartyProtection/PSV: privacyMetadata = <data>, err = nil
- privacyMetadata, err := evm.StateDB.GetPrivacyMetadata(addr)
- log.Debug("Found affected contract", "address", addr.Hex(), "privacyMetadata", privacyMetadata)
- //privacyMetadata not found=non-party, or another db error
- if err != nil && privacyFlag.IsNotStandardPrivate() {
- return nil, common.Hash{}, errors.New("PrivacyMetadata not found: " + err.Error())
- }
- // when we run simulation, it's possible that affected contracts may contain public ones
- // public contract will not have any privacyMetadata attached
- // standard private will be nil
- if privacyMetadata == nil {
- continue
- }
- //if affecteds are not all the same return an error
- if privacyFlag != privacyMetadata.PrivacyFlag {
- return nil, common.Hash{}, errors.New("sent privacy flag doesn't match all affected contract flags")
- }
- affectedContractsHashes.Add(privacyMetadata.CreationTxHash)
- }
- //only calculate the merkle root if all contracts are psv
- if privacyFlag.Has(engine.PrivacyFlagStateValidation) {
- merkleRoot, err = evm.CalculateMerkleRoot()
- if err != nil {
- return nil, common.Hash{}, err
- }
- }
- log.Trace("post-execution run", "merkleRoot", merkleRoot, "affectedhashes", affectedContractsHashes)
- return affectedContractsHashes, merkleRoot, nil
- }
- //End-Quorum
|