Documents to the function (irishandler) #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
supragya
reviewed
Nov 29, 2020
| @@ -256,6 +256,7 @@ func (sc *SecretConnection) SetWriteDeadline(t time.Time) error { | |||
| return sc.conn.(net.Conn).SetWriteDeadline(t) | |||
| } | |||
|
|
|||
| // genEphKeys generates Ephemeral key-pair | |||
There was a problem hiding this comment.
This is a library imported from tendermint itself. No need to put commnts support here.
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -93,6 +98,10 @@ func RunDataConnect(peerAddr string, | |||
| } | |||
| } | |||
|
|
|||
| // dialPeer will check if the Peer has dialed succesfully or not, | |||
| // This function is used RunDataConnect, if there are errors | |||
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -103,6 +112,10 @@ func (h *TendermintHandler) dialPeer() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // acceptPeer will check the if the Peer has connected succesfully | |||
| // or not, this function is used in RunDataConnect, if there are | |||
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -120,6 +133,10 @@ func (h *TendermintHandler) acceptPeer() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // upgradeConnectionAndHandshake checks if there has been a secret | |||
There was a problem hiding this comment.
rephrase. It ESTABLISHES, not CHECKS
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -138,6 +155,12 @@ func (h *TendermintHandler) upgradeConnectionAndHandshake() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // handshake function follows the protocol set on amino spec, | |||
| // MarshalBinaryLengthPrefixed encodes the object according to the Amino spec | |||
There was a problem hiding this comment.
don't mention exact amino codec setup. We just need to know that how handshake happens
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -215,6 +240,13 @@ func (h *TendermintHandler) beginServicing() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // Datas are recived by TM Core | |||
| // sendRoutine sends PING and PONG message to TM Core | |||
| // case h.p2pConnection.pingTimer.C: Sends PING messages to TM Core | |||
There was a problem hiding this comment.
cases are bad in comments, not needed. Mention agenda, not code.
supragya
reviewed
Nov 29, 2020
| @@ -183,6 +206,8 @@ func (h *TendermintHandler) handshake() error { | |||
| return nil | |||
| } | |||
|
|
|||
| // forms a P2P connection with the registered node | |||
| // sends and recives routines accordingly | |||
There was a problem hiding this comment.
wrong... it "services" the TM core and not forms the connection...
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -643,6 +682,8 @@ func (c *P2PConnection) stopPongTimer() { | |||
| // ---------------------- SPAM FILTER INTERFACE -------------------------------- | |||
|
|
|||
| // RunSpamFilter serves as the entry point for a TM Core handler when serving as a spamfilter | |||
| // This function also acts as filter at the very begining of the TM Core, spam filter depends | |||
There was a problem hiding this comment.
wrong!. spamfilter is completely different mode. Number of spam filter is wrong. it is number of worker goroutines spawned
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -764,6 +809,8 @@ func (h *TendermintHandler) beginServicingSpamFilter(id int) { | |||
| } | |||
| } | |||
|
|
|||
| // thoroughMessageCheck is used in beginServicingSpamFilter. | |||
| // thoroughMessageCheck verify the Messages from the Marlin Relay | |||
There was a problem hiding this comment.
Can you tell, What would be the correct Statement here!
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -670,6 +711,10 @@ func RunSpamFilter(rpcAddr string, | |||
| handler.throughput.presentThroughput(5, handler.signalShutThroughput) | |||
| } | |||
|
|
|||
| // Spam Filter executions begins from beginServicingSpamFilter | |||
| // this function will check for all possible spam from TM Core. | |||
There was a problem hiding this comment.
not from TMCore. Spam is always checked at ingress point of marlin relay
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -853,6 +903,12 @@ func (h *TendermintHandler) getValidators(height int64) ([]Validator, bool) { | |||
| } | |||
| } | |||
|
|
|||
| // spamVerdictMessage used in beginServicingSpamFilter. This function | |||
| // is used to store Messages of Marlin and even return the Boolean value | |||
There was a problem hiding this comment.
store messages? it just gives out signal to either allow or deny messages
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -876,6 +932,7 @@ var isKeyFileUsed, memoized bool | |||
| var keyFileLocation string | |||
| var privateKey ed25519.PrivKeyEd25519 | |||
|
|
|||
| //Generates privatekey and publickey | |||
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -971,7 +1031,7 @@ func getPrivateKey() ed25519.PrivKeyEd25519 { | |||
|
|
|||
| // ---------------------- COMMON UTILITIES --------------------------------- | |||
|
|
|||
|
|
|||
| //Creates Tendermint Handler between Marlin Relay and TM Core | |||
There was a problem hiding this comment.
creates between relay and TM core? no really... it just creates a handler object
supragya
reviewed
Nov 29, 2020
chains/irisnet/handlerIrisnet.go
Outdated
| @@ -1028,7 +1089,8 @@ func (t *throughPutData) putInfo(direction string, key string, count uint32) { | |||
| } | |||
| t.mu.Unlock() | |||
| } | |||
|
|
|||
| // This function display the logs/stats of marlin to | |||
There was a problem hiding this comment.
not related to marlinTo and marlinFrom actually
supragya
reviewed
Nov 29, 2020
| @@ -120,6 +129,8 @@ type ConsensusMessage interface { | |||
| ValidateBasic() error | |||
| } | |||
|
|
|||
| // RegisterConsensusMessages registers the Consensus Messages | |||
There was a problem hiding this comment.
between tendermint and consensus layer? consensus layer is in tendermint
supragya
reviewed
Nov 29, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Still working on it, will commit as soon as wrote more about those.