fanxiong

package module
v0.0.0-...-119215d Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2019 License: GPL-3.0 Imports: 5 Imported by: 0

README

GM-Chain

这是国美开发部署的一份区块链应用项目，一期应用在延保业务之上，用以简化产品供应商、销售渠道、承保公司、维修商、以及用户之间的工作流程，实现数据安全、可信、高效协同。

Official golang implementation of the GM-Fun Chain protocol.

Automated builds are available for stable releases and the unstable master branch. Binary archives will be published on official website soon..

Building the source

For prerequisites and detailed build instructions please read the Installation Instructions

Building mit requires both a Go (version 1.9 or later) and a C compiler. You can install them using your favourite package manager. https://golang.org/doc/install

Once the dependencies are installed, run

cd gm-chain
make mit

or, to build the full suite of utilities:

make all

Running Mit

Going through all the possible command line flags is out of scope here,but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own gm-chain instance.

Full node on the main gm-chain network

By far the most common scenario is people wanting to simply interact with the gm-chain network: create accounts; transfer funds; deploy and interact with contracts. For this particular use-case the user doesn't care about years-old historical data, so we can full-sync quickly to the current state of the network. To do so:

$ mit console
Running a miner

Currently our main network is based on POW+POS.

This command will:

  • Start mit in full sync mode (default), causing it to download more data in exchange for avoiding processing the entire history of the gm-chain network, which is very CPU intensive.
  • Start up Mit's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Mit's own management APIs. This too is optional and if you leave it out you can always attach to an already running gm-chain instance with mit attach.

Running mit testnet

Going through all the possible command line flags is out of scope here , but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own gm-chain instance.

Full node on the gm-chain testnet

By far the most common scenario is people wanting to simply interact with the gm-chain network: create accounts; transfer funds; deploy and interact with contracts. For this particular use-case the user doesn't care about years-old historical data, so we can fast-sync quickly to the current state of the network. To do so:

$ mit console

This command will:

  • Start mit in fast sync mode (default, can be changed with the --syncmode flag), causing it to download more data in exchange for avoiding processing the entire history of the gm-chain network, which is very CPU intensive.
  • Start up Mit's built-in interactive JavaScript console, (via the trailing console subcommand) through which you can invoke all official web3 methods as well as Mit's own management APIs. This too is optional and if you leave it out you can always attach to an already running gm-chain instance with mit attach.

Full node on the gm-chain test network

Transitioning towards developers, if you'd like to play around with creating gm-chain time contracts, you almost certainly would like to do that without any real money involved until you get the hang of the entire system.

$ mit --testnet console

Specifying the --testnet flag however will reconfigure your gm-chain instance a bit:

  • Instead of using the default data directory (~/.fanxiong on Linux for example), gm-chain will nest itself one level deeper into a testnet subfolder (~/.fanxiong/testnet on Linux). Note, on OSX and Linux this also means that attaching to a running testnet node requires the use of a custom endpoint since mit attach will try to attach to a production node endpoint by default. E.g. mit attach <datadir>/testnet/mit.ipc. Windows users are not affected by this.

Note: Now we have provided the testnet for you. The mainnet will be launched in the near future. Please make sure that you always using two separate accounts for play-money and real-money respectively.

Starting up your member nodes

With the bootnode operational and externally reachable (you can try telnet <ip> <port> to ensure it's indeed reachable), start every subsequent gm-chain node pointed to the bootnode for peer discovery via the --bootnodes flag.

$ mit --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above>

Note: Since your network will be completely cut off from the main and test networks, you'll also need to configure a miner to process transactions and create new blocks for you.

Running a miner

Currently our testnest is based on POA(Proof-of-Authority). So the miners can only mining after getting permission from us.

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to gm-chain, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base.

to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

License

未一(北京)科技有限公司授权国美金控使用

The gm-chain library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The gm-chain binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.

Documentation

Overview

Package fanxiong defines interfaces for interacting with M.I.T chain.

Index

Constants

This section is empty.

Variables

View Source 
var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

Functions

This section is empty.

Types

type CallMsg 

type CallMsg struct {
	From     common.Address  // the sender of the 'transaction'
	To       *common.Address // the destination contract (nil for contract creation)
	Gas      uint64          // if 0, the call executes with near-infinite gas
	GasPrice *big.Int        // wei <-> gas exchange ratio
	Value    *big.Int        // amount of wei sent along with the call
	Data     []byte          // input data, usually an ABI-encoded contract method invocation
}

CallMsg contains parameters for contract calls.

type ChainReader 

type ChainReader interface {
	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
	TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
	TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

	// This method subscribes to notifications about changes of the head block of
	// the canonical chain.
	SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)
}

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader 

type ChainStateReader interface {
	BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
}

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader 

type ChainSyncReader interface {
	SyncProgress(ctx context.Context) (*SyncProgress, error)
}

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller 

type ContractCaller interface {
	CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)
}

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type FilterQuery 

type FilterQuery struct {
	FromBlock *big.Int         // beginning of the queried range, nil means genesis block
	ToBlock   *big.Int         // end of the range, nil means latest block
	Addresses []common.Address // restricts matches to events created by specific contracts

	// The Topic list restricts matches to particular event topics. Each event has a list
	// of topics. Topics matches a prefix of that list. An empty element slice matches any
	// topic. Non-empty elements represent an alternative that matches any of the
	// contained topics.
	//
	// Examples:
	// {} or nil          matches any topic list
	// {{A}}              matches topic A in first position
	// {{}, {B}}          matches any topic in first position, B in second position
	// {{A}}, {B}}        matches topic A in first position, B in second position
	// {{A, B}}, {C, D}}  matches topic (A OR B) in first position, (C OR D) in second position
	Topics [][]common.Hash
}

FilterQuery contains options for contract log filtering.

type GasEstimator 

type GasEstimator interface {
	EstimateGas(ctx context.Context, call CallMsg) (uint64, error)
}

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer 

type GasPricer interface {
	SuggestGasPrice(ctx context.Context) (*big.Int, error)
}

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type LogFilterer 

type LogFilterer interface {
	FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
	SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)
}

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller 

type PendingContractCaller interface {
	PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)
}

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer 

type PendingStateEventer interface {
	SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)
}

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader 

type PendingStateReader interface {
	PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error)
	PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
	PendingTransactionCount(ctx context.Context) (uint, error)
}

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription 

type Subscription interface {
	// Unsubscribe cancels the sending of events to the data channel
	// and closes the error channel.
	Unsubscribe()
	// Err returns the subscription error channel. The error channel receives
	// a value if there is an issue with the subscription (e.g. the network connection
	// delivering the events has been closed). Only one value will ever be sent.
	// The error channel is closed by Unsubscribe.
	Err() <-chan error
}

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress 

type SyncProgress struct {
	StartingBlock uint64 // Block number where sync began
	CurrentBlock  uint64 // Current block number where sync is at
	HighestBlock  uint64 // Highest alleged block number in the chain
	PulledStates  uint64 // Number of state trie entries already downloaded
	KnownStates   uint64 // Total number of state trie entries known about
}

SyncProgress gives progress indications when the node is synchronising with the gm-chain network.

type TransactionReader 

type TransactionReader interface {
	// TransactionByHash checks the pool of pending transactions in addition to the
	// blockchain. The isPending return value indicates whether the transaction has been
	// mined yet. Note that the transaction may not be part of the canonical chain even if
	// it's not pending.
	TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
	// TransactionReceipt returns the receipt of a mined transaction. Note that the
	// transaction may not be included in the current canonical chain even if a receipt
	// exists.
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
}

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender 

type TransactionSender interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.

Source Files

View all Source files

Directories

Path Synopsis
Package accounts implements high level gm-chain account management.
 Package accounts implements high level gm-chain account management.
abi
Package abi implements the gm-chain ABI (Application Binary Interface).
 Package abi implements the gm-chain ABI (Application Binary Interface).
abi/bind
Package bind generates gm-chain contract Go bindings.
 Package bind generates gm-chain contract Go bindings.
abi/bind/backends
keystore
Package keystore implements encrypted storage of secp256k1 private keys.
 Package keystore implements encrypted storage of secp256k1 private keys.
usbwallet
Package usbwallet implements support for USB hardware wallets.
 Package usbwallet implements support for USB hardware wallets.
usbwallet/internal/trezor
Package trezor contains the wire protocol wrapper in Go.
 Package trezor contains the wire protocol wrapper in Go.
Package bmt provides a binary merkle tree implementation
 Package bmt provides a binary merkle tree implementation
cmd
abigen
bootnode
bootnode runs a bootstrap node for the gm-chain Discovery Protocol.
 bootnode runs a bootstrap node for the gm-chain Discovery Protocol.
clef
signer is a utility that can be used so sign transactions and arbitrary data.
 signer is a utility that can be used so sign transactions and arbitrary data.
createpx509
faucet
faucet is a Ether faucet backed by a light client.
 faucet is a Ether faucet backed by a light client.
internal/browser
Package browser provides utilities for interacting with users' browsers.
 Package browser provides utilities for interacting with users' browsers.
mit
mit is the official command-line client for Mit.
 mit is the official command-line client for Mit.
mit509
readx509
rlpdump
rlpdump is a pretty-printer for RLP data.
 rlpdump is a pretty-printer for RLP data.
swarm
Command bzzhash computes a swarm tree hash.
 Command bzzhash computes a swarm tree hash.
utils
Package utils contains internal helper functions for gm-chain commands.
 Package utils contains internal helper functions for gm-chain commands.
wnode
x509cert
Package common contains various helper functions.
 Package common contains various helper functions.
bitutil
Package bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
compiler
Package compiler wraps the Solidity compiler executable (solc).
 Package compiler wraps the Solidity compiler executable (solc).
fdlimit
hexutil
Package hexutil implements hex encoding with 0x prefix.
 Package hexutil implements hex encoding with 0x prefix.
math
Package math provides integer math utilities.
 Package math provides integer math utilities.
mclock
package mclock is a wrapper for a monotonic clock source
 package mclock is a wrapper for a monotonic clock source
number
Package consensus implements different gm-chain consensus engines.
 Package consensus implements different gm-chain consensus engines.
clique
Package clique implements the proof-of-authority consensus engine.
 Package clique implements the proof-of-authority consensus engine.
misc
mithash
Package mithash implements the mithash proof-of-work consensus engine.
 Package mithash implements the mithash proof-of-work consensus engine.
contracts
chequebook
Package chequebook package wraps the 'chequebook' gm-chain smart contract.
 Package chequebook package wraps the 'chequebook' gm-chain smart contract.
chequebook/contract
ens
ens/contract
Package core implements the gm-chain consensus protocol.
 Package core implements the gm-chain consensus protocol.
asm
Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
 Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
bloombits
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
state
Package state provides a caching layer atop the gm-chain state trie.
 Package state provides a caching layer atop the gm-chain state trie.
types
Package types contains data types related to gm-chain consensus.
 Package types contains data types related to gm-chain consensus.
vm
Package vm implements the gm-chain Virtual Machine.
 Package vm implements the gm-chain Virtual Machine.
vm/runtime
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.
bn256
Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
 Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
bn256/cloudflare
Package bn256 implements a particular bilinear group at the 128-bit security level.
 Package bn256 implements a particular bilinear group at the 128-bit security level.
bn256/google
Package bn256 implements a particular bilinear group at the 128-bit security level.
 Package bn256 implements a particular bilinear group at the 128-bit security level.
ecies
randentropy
secp256k1
Package secp256k1 wraps the bitcoin secp256k1 C library.
 Package secp256k1 wraps the bitcoin secp256k1 C library.
sha3
Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
 Package sha3 implements the SHA-3 fixed-output-length hash functions and the SHAKE variable-output-length hash functions defined by FIPS-202.
Package event deals with subscriptions to real-time events.
 Package event deals with subscriptions to real-time events.
filter
Package filter implements event filters.
 Package filter implements event filters.
internal
build
cmdtest
debug
Package debug interfaces Go runtime debugging facilities.
 Package debug interfaces Go runtime debugging facilities.
guide
Package guide is a small test suite to ensure snippets in the dev guide work.
 Package guide is a small test suite to ensure snippets in the dev guide work.
jsre
Package jsre provides execution environment for JavaScript.
 Package jsre provides execution environment for JavaScript.
jsre/deps
Package deps contains the console JavaScript dependencies Go embedded.
 Package deps contains the console JavaScript dependencies Go embedded.
mitapi
Package mitapi implements the general gm-chain API functions.
 Package mitapi implements the general gm-chain API functions.
web3ext
package web3ext contains mit specific web3.js extensions.
 package web3ext contains mit specific web3.js extensions.
les
Package les implements the Light gm-chain Subprotocol.
 Package les implements the Light gm-chain Subprotocol.
flowcontrol
Package flowcontrol implements a client side flow control mechanism
 Package flowcontrol implements a client side flow control mechanism
Package light implements on-demand retrieval capable state and chain objects for the gm-chain Light Client.
 Package light implements on-demand retrieval capable state and chain objects for the gm-chain Light Client.
log
Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
 Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
term
Go port of Coda Hale's Metrics library
 Go port of Coda Hale's Metrics library
exp
Hook go-metrics into expvar on any /debug/metrics request, load all vars from the registry into expvar, and execute regular expvar handler
 Hook go-metrics into expvar on any /debug/metrics request, load all vars from the registry into expvar, and execute regular expvar handler
influxdb
librato
Package miner implements gm-chain block creation and mining.
 Package miner implements gm-chain block creation and mining.
mit
Package eth implements the gm-chain protocol.
 Package eth implements the gm-chain protocol.
downloader
Package downloader contains the manual full chain synchronisation.
 Package downloader contains the manual full chain synchronisation.
fetcher
Package fetcher contains the block announcement based synchronisation.
 Package fetcher contains the block announcement based synchronisation.
filters
Package filters implements an fanxiong filtering system for block, transactions and log events.
 Package filters implements an fanxiong filtering system for block, transactions and log events.
gasprice
tracers
Package tracers is a collection of JavaScript transaction tracers.
 Package tracers is a collection of JavaScript transaction tracers.
tracers/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
Package mitclient provides a client for the Mit RPC API.
 Package mitclient provides a client for the Mit RPC API.
Package mitstats implements the network stats reporting service.
 Package mitstats implements the network stats reporting service.
createCert
rootCert
Package mit contains the simplified mobile APIs to gm-chain.
 Package mit contains the simplified mobile APIs to gm-chain.
Package node sets up multi-protocol Mit nodes.
 Package node sets up multi-protocol Mit nodes.
p2p
Package p2p implements the gm-chain p2p network protocols.
 Package p2p implements the gm-chain p2p network protocols.
discover
Package discover implements the Node Discovery Protocol.
 Package discover implements the Node Discovery Protocol.
discv5
Package discv5 implements the RLPx v5 Topic Discovery Protocol.
 Package discv5 implements the RLPx v5 Topic Discovery Protocol.
enr
Package enr implements gm-chain Node Records as defined in EIP-778.
 Package enr implements gm-chain Node Records as defined in EIP-778.
nat
Package nat provides access to common network port mapping protocols.
 Package nat provides access to common network port mapping protocols.
netutil
Package netutil contains extensions to the net package.
 Package netutil contains extensions to the net package.
protocols
Package protocols is an extension to p2p.
 Package protocols is an extension to p2p.
simulations
Package simulations simulates p2p networks.
 Package simulations simulates p2p networks.
simulations/adapters
simulations/examples
testing
Package rlp implements the RLP serialization format.
 Package rlp implements the RLP serialization format.
Package rpc provides access to the exported methods of an object across a network or other I/O connection.
 Package rpc provides access to the exported methods of an object across a network or other I/O connection.
signer
core
rules
rules/deps
Package deps contains the console JavaScript dependencies Go embedded.
 Package deps contains the console JavaScript dependencies Go embedded.
storage
api
api/client
api/http
Show nicely (but simple) formatted HTML error pages (or respond with JSON if the appropriate `Accept` header is set)) for the http package.
 Show nicely (but simple) formatted HTML error pages (or respond with JSON if the appropriate `Accept` header is set)) for the http package.
fuse
metrics
network
network/kademlia
services/swap
services/swap/swap
storage
testutil
Package tests implements execution of gm-chain JSON tests.
 Package tests implements execution of gm-chain JSON tests.
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.
whisper
mailserver
shhclient
whisperv5
Package whisperv5 implements the Whisper protocol (version 5).
 Package whisperv5 implements the Whisper protocol (version 5).
whisperv6

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.