Docs.

Common.h

@@ -8,6 +8,7 @@ namespace eth
 
 typedef uint8_t byte;
 typedef foreign<byte> Bytes;
+typedef foreign<byte const> ConstBytes;
 
 template <class _T> std::string toString(_T const& _t) { std::ostringstream o; o << _t; return o.str(); }
 

RLP.h

@@ -16,12 +16,28 @@ using bigint = boost::multiprecision::cpp_int;
 using uint = uint64_t;
 using sint = int64_t;
 
+/**
+ * @brief Recursive Linear-Packed data structure.
+ * @by Gav Wood, 2013
+ *
+ * Class for reading byte arrays of data in RLP format.
+ */
 class RLP
 {
 public:
+	/// Construct a null node.
 	RLP() {}
-	RLP(Bytes _d): m_data(_d) {}
 
+	/// Construct a node of value given in the bytes.
+	explicit RLP(ConstBytes _d): m_data(_d) {}
+
+	/// Construct a node to read RLP data in the bytes given.
+	RLP(byte const* _b, uint _s): m_data(ConstBytes(_b, _s)) {}
+
+	/// Construct a node to read RLP data in the string.
+	explicit RLP(std::string const& _s): m_data(ConstBytes((byte const*)_s.data(), _s.size())) {}
+
+	/// @returns true if the RLP is non-null.
 	explicit operator bool() const { return !isNull(); }
 
 	/// No value.
@@ -82,7 +98,7 @@ public:
 		if (!isList())
 			return ret;
 		uint64_t c = items();
-		Bytes d = payload();
+		ConstBytes d = payload();
 		for (uint64_t i = 0; i < c; ++i, d = d.cropped(RLP(d).size()))
 			ret.push_back(RLP(d));
 		return ret;
@@ -112,7 +128,7 @@ private:
 			return payload().data() - m_data.data() + items();
 		if (isList())
 		{
-			Bytes d = payload();
+			ConstBytes d = payload();
 			uint64_t c = items();
 			for (uint64_t i = 0; i < c; ++i, d = d.cropped(RLP(d).size())) {}
 			return d.data() - m_data.data();
@@ -134,14 +150,14 @@ private:
 		return ret;
 	}
 
-	Bytes payload() const
+	ConstBytes payload() const
 	{
 		assert(isString() || isList());
 		auto n = (m_data[0] & 0x3f);
 		return m_data.cropped(1 + (n < 0x38 ? 0 : (n - 0x37)));
 	}
 
-	Bytes m_data;
+	ConstBytes m_data;
 };
 
 }

main.cpp

@@ -4,43 +4,33 @@ using namespace eth;
 
 int main()
 {
-	{
+	// int of value 15
-		string t = "\x0f";
+	assert(toString(RLP("\x0f")) == "15");
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "15");
+
-	}
+	// 2-item list
-	{
+	assert(toString(RLP("\x43""dog")) == "\"dog\"");
-		string t = "\x43""dog";
+
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "\"dog\"");
+	// 3-character string
-	}
+	assert(toString(RLP("\x82\x0f\x43""dog")) == "[ 15, \"dog\" ]");
-	{
+
-		string t = "\x82\x0f\x43""dog";
+	// 1-byte (8-bit) int
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "[ 15, \"dog\" ]");
+	assert(toString(RLP("\x18\x45")) == "69");
-	}
+
-	{
+	// 2-byte (16-bit) int
-		string t = "\x18\x45";
+	assert(toString(RLP("\x19\x01\x01")) == "257");
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "69");
+
-	}
+	// 32-byte (256-bit) int
-	{
+	ostringstream o1;
-		string t = "\x19\x01\x01";
+	o1 << hex << RLP("\x37\x10\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f");
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "257");
+	assert(o1.str() == "100102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F");
-	}
+
-	{
+	// 33-byte (264-bit) int
-		string t = "\x37\x10\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f";
+	ostringstream o2;
-		ostringstream o;
+	o2 << hex << RLP("\x38\x21\x20\x10\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f");
-		o << hex << RLP(Bytes((byte*)t.data(), t.size()));
+	assert(o2.str() == "20100102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F");
-		assert(o.str() == "100102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F");
+
-	}
+	// 56-character string.
-	{
+	assert(toString(RLP("\x78\x38""Lorem ipsum dolor sit amet, consectetur adipisicing elit")) == "\"Lorem ipsum dolor sit amet, consectetur adipisicing elit\"");
-		// 33-byte int
-		string t = "\x38\x21\x20\x10\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f";
-		ostringstream o;
-		o << hex << RLP(Bytes((byte*)t.data(), t.size()));
-		assert(o.str() == "20100102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F");
-	}
-	{
-		string t = "\x78\x38""Lorem ipsum dolor sit amet, consectetur adipisicing elit";
-		assert(toString(RLP(Bytes((byte*)t.data(), t.size()))) == "\"Lorem ipsum dolor sit amet, consectetur adipisicing elit\"");
-	}
 	return 0;
 }