github.com/p202io/bor@v0.1.4/accounts/abi/bind/backend.go (about)

     1  // Copyright 2015 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package bind
    18  
    19  import (
    20  	"context"
    21  	"errors"
    22  	"math/big"
    23  
    24  	"github.com/maticnetwork/bor"
    25  	"github.com/maticnetwork/bor/common"
    26  	"github.com/maticnetwork/bor/core/types"
    27  )
    28  
    29  var (
    30  	// ErrNoCode is returned by call and transact operations for which the requested
    31  	// recipient contract to operate on does not exist in the state db or does not
    32  	// have any code associated with it (i.e. suicided).
    33  	ErrNoCode = errors.New("no contract code at given address")
    34  
    35  	// This error is raised when attempting to perform a pending state action
    36  	// on a backend that doesn't implement PendingContractCaller.
    37  	ErrNoPendingState = errors.New("backend does not support pending state")
    38  
    39  	// This error is returned by WaitDeployed if contract creation leaves an
    40  	// empty contract behind.
    41  	ErrNoCodeAfterDeploy = errors.New("no contract code after deployment")
    42  )
    43  
    44  // ContractCaller defines the methods needed to allow operating with contract on a read
    45  // only basis.
    46  type ContractCaller interface {
    47  	// CodeAt returns the code of the given account. This is needed to differentiate
    48  	// between contract internal errors and the local chain being out of sync.
    49  	CodeAt(ctx context.Context, contract common.Address, blockNumber *big.Int) ([]byte, error)
    50  	// ContractCall executes an Ethereum contract call with the specified data as the
    51  	// input.
    52  	CallContract(ctx context.Context, call ethereum.CallMsg, blockNumber *big.Int) ([]byte, error)
    53  }
    54  
    55  // PendingContractCaller defines methods to perform contract calls on the pending state.
    56  // Call will try to discover this interface when access to the pending state is requested.
    57  // If the backend does not support the pending state, Call returns ErrNoPendingState.
    58  type PendingContractCaller interface {
    59  	// PendingCodeAt returns the code of the given account in the pending state.
    60  	PendingCodeAt(ctx context.Context, contract common.Address) ([]byte, error)
    61  	// PendingCallContract executes an Ethereum contract call against the pending state.
    62  	PendingCallContract(ctx context.Context, call ethereum.CallMsg) ([]byte, error)
    63  }
    64  
    65  // ContractTransactor defines the methods needed to allow operating with contract
    66  // on a write only basis. Beside the transacting method, the remainder are helpers
    67  // used when the user does not provide some needed values, but rather leaves it up
    68  // to the transactor to decide.
    69  type ContractTransactor interface {
    70  	// PendingCodeAt returns the code of the given account in the pending state.
    71  	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
    72  	// PendingNonceAt retrieves the current pending nonce associated with an account.
    73  	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
    74  	// SuggestGasPrice retrieves the currently suggested gas price to allow a timely
    75  	// execution of a transaction.
    76  	SuggestGasPrice(ctx context.Context) (*big.Int, error)
    77  	// EstimateGas tries to estimate the gas needed to execute a specific
    78  	// transaction based on the current pending state of the backend blockchain.
    79  	// There is no guarantee that this is the true gas limit requirement as other
    80  	// transactions may be added or removed by miners, but it should provide a basis
    81  	// for setting a reasonable default.
    82  	EstimateGas(ctx context.Context, call ethereum.CallMsg) (gas uint64, err error)
    83  	// SendTransaction injects the transaction into the pending pool for execution.
    84  	SendTransaction(ctx context.Context, tx *types.Transaction) error
    85  }
    86  
    87  // ContractFilterer defines the methods needed to access log events using one-off
    88  // queries or continuous event subscriptions.
    89  type ContractFilterer interface {
    90  	// FilterLogs executes a log filter operation, blocking during execution and
    91  	// returning all the results in one batch.
    92  	//
    93  	// TODO(karalabe): Deprecate when the subscription one can return past data too.
    94  	FilterLogs(ctx context.Context, query ethereum.FilterQuery) ([]types.Log, error)
    95  
    96  	// SubscribeFilterLogs creates a background log filtering operation, returning
    97  	// a subscription immediately, which can be used to stream the found events.
    98  	SubscribeFilterLogs(ctx context.Context, query ethereum.FilterQuery, ch chan<- types.Log) (ethereum.Subscription, error)
    99  }
   100  
   101  // DeployBackend wraps the operations needed by WaitMined and WaitDeployed.
   102  type DeployBackend interface {
   103  	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
   104  	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
   105  }
   106  
   107  // ContractBackend defines the methods needed to work with contracts on a read-write basis.
   108  type ContractBackend interface {
   109  	ContractCaller
   110  	ContractTransactor
   111  	ContractFilterer
   112  }