XDCx

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 3, 2024 License: GPL-3.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ProtocolName       = "XDCx"
	ProtocolVersion    = uint64(1)
	ProtocolVersionStr = "1.0"

	MaximumTxMatchSize = 1000
)
View Source
const (
	LimitThresholdOrderNonceInQueue = 100
)

Variables

View Source
var (
	ErrNonceTooHigh = errors.New("nonce too high")
	ErrNonceTooLow  = errors.New("nonce too low")
)
View Source
var (
	ErrNoTopics          = errors.New("missing topic(s)")
	ErrOrderNonceTooLow  = errors.New("OrderNonce too low")
	ErrOrderNonceTooHigh = errors.New("OrderNonce too high")
)

List of errors

View Source
var DefaultConfig = Config{
	DataDir: "",
}

DefaultConfig represents (shocker!) the default configuration.

Functions

func DoSettleBalance

func DoSettleBalance(coinbase common.Address, takerOrder, makerOrder *tradingstate.OrderItem, settleBalance *tradingstate.SettleBalance, statedb *state.StateDB) error

func GetTokenAbi

func GetTokenAbi() (*abi.ABI, error)

GetTokenAbi return token abi

func GetTradeQuantity

func GetTradeQuantity(takerSide string, takerFeeRate *big.Int, takerBalance *big.Int, makerPrice *big.Int, makerFeeRate *big.Int, makerBalance *big.Int, baseTokenDecimal *big.Int, quantityToTrade *big.Int) (*big.Int, bool)

func NewLDBEngine

func NewLDBEngine(cfg *Config) *XDCxDAO.BatchDatabase

func NewMongoDBEngine

func NewMongoDBEngine(cfg *Config) *XDCxDAO.MongoDatabase

func RunContract

func RunContract(chain consensus.ChainContext, statedb *state.StateDB, contractAddr common.Address, abi *abi.ABI, method string, args ...interface{}) (interface{}, error)

RunContract run smart contract

Types

type Config

type Config struct {
	DataDir        string `toml:",omitempty"`
	DBEngine       string `toml:",omitempty"`
	DBName         string `toml:",omitempty"`
	ConnectionUrl  string `toml:",omitempty"`
	ReplicaSetName string `toml:",omitempty"`
}

type PublicXDCXAPI

type PublicXDCXAPI struct {
	// contains filtered or unexported fields
}

PublicXDCXAPI provides the XDCX RPC service that can be use publicly without security implications.

func NewPublicXDCXAPI

func NewPublicXDCXAPI(t *XDCX) *PublicXDCXAPI

NewPublicXDCXAPI create a new RPC XDCX service.

func (*PublicXDCXAPI) Version

func (api *PublicXDCXAPI) Version(ctx context.Context) string

Version returns the XDCX sub-protocol version.

type XDCX

type XDCX struct {
	Triegc     *prque.Prque          // Priority queue mapping block numbers to tries to gc
	StateCache tradingstate.Database // State database to reuse between imports (contains state cache)    *XDCx_state.TradingStateDB
	// contains filtered or unexported fields
}

func New

func New(cfg *Config) *XDCX

func (*XDCX) APIs

func (XDCx *XDCX) APIs() []rpc.API

APIs returns the RPC descriptors the XDCX implementation offers

func (*XDCX) ApplyOrder

func (XDCx *XDCX) ApplyOrder(header *types.Header, coinbase common.Address, chain consensus.ChainContext, statedb *state.StateDB, tradingStateDB *tradingstate.TradingStateDB, orderBook common.Hash, order *tradingstate.OrderItem) ([]map[string]string, []*tradingstate.OrderItem, error)

func (*XDCX) CommitOrder

func (XDCx *XDCX) CommitOrder(header *types.Header, coinbase common.Address, chain consensus.ChainContext, statedb *state.StateDB, tradingStateDB *tradingstate.TradingStateDB, orderBook common.Hash, order *tradingstate.OrderItem) ([]map[string]string, []*tradingstate.OrderItem, error)

func (*XDCX) ConvertXDCToToken

func (XDCx *XDCX) ConvertXDCToToken(chain consensus.ChainContext, statedb *state.StateDB, tradingStateDb *tradingstate.TradingStateDB, token common.Address, quantity *big.Int) (*big.Int, *big.Int, error)

return tokenQuantity (after convert from XDC to token), tokenPriceInXDC, error

func (*XDCX) GetAveragePriceLastEpoch

func (XDCx *XDCX) GetAveragePriceLastEpoch(chain consensus.ChainContext, statedb *state.StateDB, tradingStateDb *tradingstate.TradingStateDB, baseToken common.Address, quoteToken common.Address) (*big.Int, error)

return average price of the given pair in the last epoch

func (*XDCX) GetEmptyTradingState

func (XDCX *XDCX) GetEmptyTradingState() (*tradingstate.TradingStateDB, error)

func (*XDCX) GetLevelDB

func (XDCx *XDCX) GetLevelDB() XDCxDAO.XDCXDAO

func (*XDCX) GetMongoDB

func (XDCx *XDCX) GetMongoDB() XDCxDAO.XDCXDAO

func (*XDCX) GetStateCache

func (XDCx *XDCX) GetStateCache() tradingstate.Database

func (*XDCX) GetTokenDecimal

func (XDCx *XDCX) GetTokenDecimal(chain consensus.ChainContext, statedb *state.StateDB, tokenAddr common.Address) (*big.Int, error)

func (*XDCX) GetTradingState

func (XDCx *XDCX) GetTradingState(block *types.Block, author common.Address) (*tradingstate.TradingStateDB, error)

func (*XDCX) GetTradingStateRoot

func (XDCx *XDCX) GetTradingStateRoot(block *types.Block, author common.Address) (common.Hash, error)

func (*XDCX) GetTriegc

func (XDCx *XDCX) GetTriegc() *prque.Prque

func (*XDCX) HasTradingState

func (XDCx *XDCX) HasTradingState(block *types.Block, author common.Address) bool

func (*XDCX) IsSDKNode

func (XDCx *XDCX) IsSDKNode() bool

func (*XDCX) LogEpochPrice

func (XDCx *XDCX) LogEpochPrice(epochNumber uint64, epochPriceResult map[common.Hash]*big.Int) error

put average price of epoch to mongodb for tracking liquidation trades epochPriceResult: a map of epoch average price, key is orderbook hash , value is epoch average price orderbook hash genereted from baseToken, quoteToken at XDPoSChain/XDCx/tradingstate/common.go:214

func (*XDCX) Overflow

func (XDCx *XDCX) Overflow() bool

Overflow returns an indication if the message queue is full.

func (*XDCX) ProcessCancelOrder

func (XDCx *XDCX) ProcessCancelOrder(header *types.Header, tradingStateDB *tradingstate.TradingStateDB, statedb *state.StateDB, chain consensus.ChainContext, coinbase common.Address, orderBook common.Hash, order *tradingstate.OrderItem) (error, bool)

func (*XDCX) ProcessOrderPending

func (XDCx *XDCX) ProcessOrderPending(header *types.Header, coinbase common.Address, chain consensus.ChainContext, pending map[common.Address]types.OrderTransactions, statedb *state.StateDB, XDCXstatedb *tradingstate.TradingStateDB) ([]tradingstate.TxDataMatch, map[common.Hash]tradingstate.MatchingResult)

func (*XDCX) Protocols

func (XDCx *XDCX) Protocols() []p2p.Protocol

func (*XDCX) RollbackReorgTxMatch

func (XDCx *XDCX) RollbackReorgTxMatch(txhash common.Hash) error

func (*XDCX) SaveData

func (XDCx *XDCX) SaveData()

func (*XDCX) SetTokenDecimal

func (XDCx *XDCX) SetTokenDecimal(token common.Address, decimal *big.Int)

FIXME: using in unit tests only

func (*XDCX) Start

func (XDCx *XDCX) Start(server *p2p.Server) error

func (*XDCX) Stop

func (XDCx *XDCX) Stop() error

func (*XDCX) SyncDataToSDKNode

func (XDCx *XDCX) SyncDataToSDKNode(takerOrderInTx *tradingstate.OrderItem, txHash common.Hash, txMatchTime time.Time, statedb *state.StateDB, trades []map[string]string, rejectedOrders []*tradingstate.OrderItem, dirtyOrderCount *uint64) error

there are 3 tasks need to complete to update data in SDK nodes after matching

  1. txMatchData.Order: order has been processed. This order should be put to `orders` collection with status sdktypes.OrderStatusOpen
  2. txMatchData.Trades: includes information of matched orders. a. PutObject them to `trades` collection b. Update status of regrading orders to sdktypes.OrderStatusFilled

func (*XDCX) UpdateMediumPriceBeforeEpoch

func (XDCx *XDCX) UpdateMediumPriceBeforeEpoch(epochNumber uint64, tradingStateDB *tradingstate.TradingStateDB, statedb *state.StateDB) error

func (*XDCX) UpdateOrderCache

func (XDCx *XDCX) UpdateOrderCache(baseToken, quoteToken common.Address, orderHash common.Hash, txhash common.Hash, lastState tradingstate.OrderHistoryItem)

func (*XDCX) Version

func (XDCx *XDCX) Version() uint64

Version returns the XDCX sub-protocols version number.

Directories

Path Synopsis
Package state provides a caching layer atop the Ethereum state trie.
Package state provides a caching layer atop the Ethereum state trie.

Jump to

Keyboard shortcuts

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