docs: add minor comments on exported functions

aeternity · Apr 30, 2019 · 8eb5d88 · 8eb5d88
1 parent 7852cf0
commit 8eb5d88
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/aeternity/hashing.go b/aeternity/hashing.go
@@ -157,6 +157,7 @@ func buildIDTag(IDTag uint8, encodedHash string) (v []uint8, err error) {
 	return
 }
 
+// DecodeRLPMessage transforms a plain stream of bytes into a structure of bytes that represents the object that was serialized
 func DecodeRLPMessage(rawBytes []byte) []interface{} {
 	res := []interface{}{}
 	rlp.DecodeBytes(rawBytes, &res)

diff --git a/aeternity/transactions.go b/aeternity/transactions.go
@@ -259,7 +259,6 @@ func NewNameClaimTx(accountID, name string, nameSalt utils.BigInt, fee utils.Big
 }
 
 // NameUpdateTx represents a transaction where one extends the lifetime of a reserved name on AENS
-
 type NameUpdateTx struct {
 	AccountID string
 	NameID    string
@@ -508,6 +507,7 @@ func (t *OracleQueryTx) RLP() (rlpRawMsg []byte, err error) {
 	return
 }
 
+// JSON representation of a Tx is useful for querying the node's debug endpoint
 func (t *OracleQueryTx) JSON() (string, error) {
 	responseTTLTypeStr := ttlTypeIntToStr(t.ResponseTTLType)
 	queryTTLTypeStr := ttlTypeIntToStr(t.QueryTTLType)