367c329b88
* whisper: fixes warnings from the code linter * whisper: more non-API-breaking changes The remaining lint errors are because of auto-generated files and one is because an exported function has a non- exported return type. Changing this would break the API, and will be part of another commit for easier reversal. * whisper: un-export NewSentMessage to please the linter This is an API change, which is why it's in its own commit. This change was initiated after the linter complained that the returned type wasn't exported. I chose to un-export the function instead of exporting the type, because that type is an implementation detail that I would like to change in the near future to make the code more readable and with an increased coverage. * whisper: update gencodec output after upgrading it to new lint standards
58 lines
1.9 KiB
Go
58 lines
1.9 KiB
Go
// Copyright 2016 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/>.
|
|
|
|
// Contains the Whisper protocol Topic element.
|
|
|
|
package whisperv6
|
|
|
|
import (
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
)
|
|
|
|
// TopicType represents a cryptographically secure, probabilistic partial
|
|
// classifications of a message, determined as the first (left) 4 bytes of the
|
|
// SHA3 hash of some arbitrary data given by the original author of the message.
|
|
type TopicType [TopicLength]byte
|
|
|
|
// BytesToTopic converts from the byte array representation of a topic
|
|
// into the TopicType type.
|
|
func BytesToTopic(b []byte) (t TopicType) {
|
|
sz := TopicLength
|
|
if x := len(b); x < TopicLength {
|
|
sz = x
|
|
}
|
|
for i := 0; i < sz; i++ {
|
|
t[i] = b[i]
|
|
}
|
|
return t
|
|
}
|
|
|
|
// String converts a topic byte array to a string representation.
|
|
func (t *TopicType) String() string {
|
|
return common.ToHex(t[:])
|
|
}
|
|
|
|
// MarshalText returns the hex representation of t.
|
|
func (t TopicType) MarshalText() ([]byte, error) {
|
|
return hexutil.Bytes(t[:]).MarshalText()
|
|
}
|
|
|
|
// UnmarshalText parses a hex representation to a topic.
|
|
func (t *TopicType) UnmarshalText(input []byte) error {
|
|
return hexutil.UnmarshalFixedText("Topic", input, t[:])
|
|
}
|