PRCYCoin  2.0.0.7rc1
P2P Digital Currency
compressor.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2014 The Bitcoin developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_COMPRESSOR_H
7 #define BITCOIN_COMPRESSOR_H
8 
10 #include "script/script.h"
11 #include "serialize.h"
12 
13 class CKeyID;
14 class CPubKey;
15 class CScriptID;
16 
29 {
30 private:
37  static const unsigned int nSpecialScripts = 6;
38 
40 
41 protected:
49  bool IsToKeyID(CKeyID& hash) const;
50  bool IsToScriptID(CScriptID& hash) const;
51  bool IsToPubKey(CPubKey& pubkey) const;
52 
53  bool Compress(std::vector<unsigned char>& out) const;
54  unsigned int GetSpecialSize(unsigned int nSize) const;
55  bool Decompress(unsigned int nSize, const std::vector<unsigned char>& out);
56 
57 public:
58  CScriptCompressor(CScript& scriptIn) : script(scriptIn) {}
59 
60  unsigned int GetSerializeSize(int nType, int nVersion) const
61  {
62  std::vector<unsigned char> compr;
63  if (Compress(compr))
64  return compr.size();
65  unsigned int nSize = script.size() + nSpecialScripts;
66  return script.size() + VARINT(nSize).GetSerializeSize(nType, nVersion);
67  }
68 
69  template <typename Stream>
70  void Serialize(Stream& s, int nType, int nVersion) const
71  {
72  std::vector<unsigned char> compr;
73  if (Compress(compr)) {
74  s << CFlatData(compr);
75  return;
76  }
77  unsigned int nSize = script.size() + nSpecialScripts;
78  s << VARINT(nSize);
79  s << CFlatData(script);
80  }
81 
82  template <typename Stream>
83  void Unserialize(Stream& s, int nType, int nVersion)
84  {
85  unsigned int nSize = 0;
86  s >> VARINT(nSize);
87  if (nSize < nSpecialScripts) {
88  std::vector<unsigned char> vch(GetSpecialSize(nSize), 0x00);
89  s >> REF(CFlatData(vch));
90  Decompress(nSize, vch);
91  return;
92  }
93  nSize -= nSpecialScripts;
94  if (nSize > MAX_SCRIPT_SIZE) {
95  s >> REF(CFlatData(script)); // Overly long script, replace with a short invalid one
96  script << OP_RETURN;
97  s.ignore(nSize);
98  } else {
99  script.resize(nSize);
100  s >> REF(CFlatData(script));
101  }
102  }
103 };
104 
107 {
108 private:
110 
111 public:
112  static uint64_t CompressAmount(uint64_t nAmount);
113  static uint64_t DecompressAmount(uint64_t nAmount);
114 
115  CTxOutCompressor(CTxOut& txoutIn) : txout(txoutIn) {}
116 
118 
119  template <typename Stream, typename Operation>
120  inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
121  {
122  if (!ser_action.ForRead()) {
123  uint64_t nVal = CompressAmount(txout.nValue);
124  READWRITE(VARINT(nVal));
125  } else {
126  uint64_t nVal = 0;
127  READWRITE(VARINT(nVal));
128  txout.nValue = DecompressAmount(nVal);
129  }
131  READWRITE(cscript);
132  }
133 };
134 
135 #endif // BITCOIN_COMPRESSOR_H
CScriptCompressor::IsToKeyID
bool IsToKeyID(CKeyID &hash) const
These check for scripts for which a special case with a shorter encoding is defined.
Definition: compressor.cpp:12
CScriptCompressor::GetSpecialSize
unsigned int GetSpecialSize(unsigned int nSize) const
Definition: compressor.cpp:74
CTxOutCompressor::txout
CTxOut & txout
Definition: compressor.h:109
transaction.h
CScriptCompressor::IsToPubKey
bool IsToPubKey(CPubKey &pubkey) const
Definition: compressor.cpp:30
CTxOutCompressor::CTxOutCompressor
CTxOutCompressor(CTxOut &txoutIn)
Definition: compressor.h:115
CTxOutCompressor::CompressAmount
static uint64_t CompressAmount(uint64_t nAmount)
Definition: compressor.cpp:137
CKeyID
A reference to a CKey: the Hash160 of its serialized public key.
Definition: pubkey.h:29
CTxOut::nValue
CAmount nValue
Definition: transaction.h:167
CScriptCompressor::CScriptCompressor
CScriptCompressor(CScript &scriptIn)
Definition: compressor.h:58
OP_RETURN
@ OP_RETURN
Definition: script.h:76
CTxOut
An output of a transaction.
Definition: transaction.h:164
CScriptCompressor::IsToScriptID
bool IsToScriptID(CScriptID &hash) const
Definition: compressor.cpp:21
VARINT
#define VARINT(obj)
Definition: serialize.h:366
CTxOut::scriptPubKey
CScript scriptPubKey
Definition: transaction.h:168
CFlatData
Wrapper for serializing arrays and POD.
Definition: serialize.h:372
CScriptCompressor::GetSerializeSize
unsigned int GetSerializeSize(int nType, int nVersion) const
Definition: compressor.h:60
CScript
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:363
CTxOutCompressor
wrapper for CTxOut that provides a more compact serialization
Definition: compressor.h:106
CScriptCompressor::Compress
bool Compress(std::vector< unsigned char > &out) const
Definition: compressor.cpp:43
CTxOutCompressor::ADD_SERIALIZE_METHODS
ADD_SERIALIZE_METHODS
Definition: compressor.h:117
prevector::resize
void resize(size_type new_size)
Definition: prevector.h:316
CPubKey
An encapsulated public key.
Definition: pubkey.h:37
READWRITE
#define READWRITE(obj)
Definition: serialize.h:164
CScriptCompressor
Compact serializer for scripts.
Definition: compressor.h:28
CScriptCompressor::Unserialize
void Unserialize(Stream &s, int nType, int nVersion)
Definition: compressor.h:83
CScriptCompressor::Decompress
bool Decompress(unsigned int nSize, const std::vector< unsigned char > &out)
Definition: compressor.cpp:83
prevector::size
size_type size() const
Definition: prevector.h:282
CScriptCompressor::nSpecialScripts
static const unsigned int nSpecialScripts
make this static for now (there are only 6 special scripts defined) this can potentially be extended ...
Definition: compressor.h:37
serialize.h
script.h
CScriptCompressor::script
CScript & script
Definition: compressor.h:39
REF
T & REF(const T &val)
Used to bypass the rule against non-const reference to temporary where it makes sense with wrappers s...
Definition: serialize.h:34
CScriptID
A reference to a CScript: the Hash160 of its serialization (see script.h)
Definition: standard.h:20
CScriptCompressor::Serialize
void Serialize(Stream &s, int nType, int nVersion) const
Definition: compressor.h:70
CTxOutCompressor::SerializationOp
void SerializationOp(Stream &s, Operation ser_action, int nType, int nVersion)
Definition: compressor.h:120
CTxOutCompressor::DecompressAmount
static uint64_t DecompressAmount(uint64_t nAmount)
Definition: compressor.cpp:156