Electroneum
tx_extra.h
Go to the documentation of this file.
1 // Copyrights(c) 2017-2021, The Electroneum Project
2 // Copyrights(c) 2014-2019, The Monero Project
3 //
4 // All rights reserved.
5 //
6 // Redistribution and use in source and binary forms, with or without modification, are
7 // permitted provided that the following conditions are met:
8 //
9 // 1. Redistributions of source code must retain the above copyright notice, this list of
10 // conditions and the following disclaimer.
11 //
12 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
13 // of conditions and the following disclaimer in the documentation and/or other
14 // materials provided with the distribution.
15 //
16 // 3. Neither the name of the copyright holder nor the names of its contributors may be
17 // used to endorse or promote products derived from this software without specific
18 // prior written permission.
19 //
20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
21 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
28 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
31 
32 #pragma once
33 
34 
35 #define TX_EXTRA_PADDING_MAX_COUNT 255
36 #define TX_EXTRA_NONCE_MAX_COUNT 255
37 
38 #define TX_EXTRA_TAG_PADDING 0x00
39 #define TX_EXTRA_TAG_PUBKEY 0x01
40 #define TX_EXTRA_NONCE 0x02
41 #define TX_EXTRA_MERGE_MINING_TAG 0x03
42 #define TX_EXTRA_TAG_ADDITIONAL_PUBKEYS 0x04
43 #define TX_EXTRA_TAG_BRIDGE_SOURCE_ADDRESS 0x05
44 #define TX_EXTRA_TAG_BRIDGE_SMARTCHAIN_ADDRESS 0x06
45 #define TX_EXTRA_MYSTERIOUS_MINERGATE_TAG 0xDE
46 
47 #define TX_EXTRA_NONCE_PAYMENT_ID 0x00
48 #define TX_EXTRA_NONCE_ENCRYPTED_PAYMENT_ID 0x01
49 
50 namespace cryptonote
51 {
53  {
54  size_t size;
55 
56  // load
57  template <template <bool> class Archive>
58  bool do_serialize(Archive<false>& ar)
59  {
60  // size - 1 - because of variant tag
61  for (size = 1; size <= TX_EXTRA_PADDING_MAX_COUNT; ++size)
62  {
63  std::ios_base::iostate state = ar.stream().rdstate();
64  bool eof = EOF == ar.stream().peek();
65  ar.stream().clear(state);
66 
67  if (eof)
68  break;
69 
70  uint8_t zero;
71  if (!::do_serialize(ar, zero))
72  return false;
73 
74  if (0 != zero)
75  return false;
76  }
77 
79  }
80 
81  // store
82  template <template <bool> class Archive>
83  bool do_serialize(Archive<true>& ar)
84  {
86  return false;
87 
88  // i = 1 - because of variant tag
89  for (size_t i = 1; i < size; ++i)
90  {
91  uint8_t zero = 0;
92  if (!::do_serialize(ar, zero))
93  return false;
94  }
95  return true;
96  }
97  };
98 
100  {
102 
104  FIELD(pub_key)
105  END_SERIALIZE()
106  };
107 
109  {
111 
113  FIELD(nonce)
114  if(TX_EXTRA_NONCE_MAX_COUNT < nonce.size()) return false;
115  END_SERIALIZE()
116  };
117 
119  {
121  {
123 
124  serialize_helper(tx_extra_merge_mining_tag& mm_tag_) : mm_tag(mm_tag_)
125  {
126  }
127 
129  VARINT_FIELD_N("depth", mm_tag.depth)
130  FIELD_N("merkle_root", mm_tag.merkle_root)
131  END_SERIALIZE()
132  };
133 
134  size_t depth;
135  crypto::hash merkle_root;
136 
137  // load
138  template <template <bool> class Archive>
139  bool do_serialize(Archive<false>& ar)
140  {
141  std::string field;
142  if(!::do_serialize(ar, field))
143  return false;
144 
145  std::istringstream iss(field);
146  binary_archive<false> iar(iss);
147  serialize_helper helper(*this);
149  }
150 
151  // store
152  template <template <bool> class Archive>
153  bool do_serialize(Archive<true>& ar)
154  {
155  std::ostringstream oss;
156  binary_archive<true> oar(oss);
157  serialize_helper helper(*this);
158  if(!::do_serialize(oar, helper))
159  return false;
160 
161  std::string field = oss.str();
163  }
164  };
165 
166  // per-output additional tx pubkey for multi-destination transfers involving at least one subaddress
168  {
169  std::vector<crypto::public_key> data;
170 
172  FIELD(data)
173  END_SERIALIZE()
174  };
175 
177  {
179 
181  FIELD(data)
182  END_SERIALIZE()
183  };
184 
186  {
188 
190  FIELD(data)
191  END_SERIALIZE()
192  };
193 
195  {
197 
199  FIELD(data)
200  END_SERIALIZE()
201  };
202 
203  // tx_extra_field format, except tx_extra_padding and tx_extra_pub_key:
204  // varint tag;
205  // varint size;
206  // varint data[];
208 }
209 
#define TX_EXTRA_MYSTERIOUS_MINERGATE_TAG
Definition: tx_extra.h:45
#define TX_EXTRA_TAG_BRIDGE_SOURCE_ADDRESS
Definition: tx_extra.h:43
std::vector< crypto::public_key > data
Definition: tx_extra.h:169
#define VARINT_FIELD_N(t, f)
tags (as t) and serializes the varint f
::std::string string
Definition: gtest-port.h:1097
crypto::public_key pub_key
Definition: tx_extra.h:101
boost::variant< tx_extra_padding, tx_extra_pub_key, tx_extra_nonce, tx_extra_merge_mining_tag, tx_extra_additional_pub_keys, tx_extra_bridge_source_address, tx_extra_bridge_smartchain_address, tx_extra_mysterious_minergate > tx_extra_field
Definition: tx_extra.h:207
#define TX_EXTRA_PADDING_MAX_COUNT
Definition: tx_extra.h:35
crypto namespace.
Definition: crypto.cpp:58
unsigned char uint8_t
Definition: stdint.h:124
#define END_SERIALIZE()
self-explanatory
bool do_serialize(Archive< false > &ar)
Definition: tx_extra.h:58
Holds cryptonote related classes and helpers.
Definition: ban.cpp:40
#define TX_EXTRA_NONCE_MAX_COUNT
Definition: tx_extra.h:36
void serialize(Archive &a, unsigned_tx_set &x, const boost::serialization::version_type ver)
#define TX_EXTRA_MERGE_MINING_TAG
Definition: tx_extra.h:41
bool do_serialize(Archive< true > &ar)
Definition: tx_extra.h:153
#define TX_EXTRA_TAG_PADDING
Definition: tx_extra.h:38
#define false
Definition: stdbool.h:38
POD_CLASS public_key
Definition: crypto.h:76
#define TX_EXTRA_TAG_PUBKEY
Definition: tx_extra.h:39
#define TX_EXTRA_TAG_ADDITIONAL_PUBKEYS
Definition: tx_extra.h:42
void do_serialize(boost::mpl::false_, Archive &a, epee::net_utils::network_address &na)
#define TX_EXTRA_NONCE
Definition: tx_extra.h:40
bool do_serialize(Archive< true > &ar)
Definition: tx_extra.h:83
serialize_helper(tx_extra_merge_mining_tag &mm_tag_)
Definition: tx_extra.h:124
Definition: blake256.h:37
VARIANT_TAG(binary_archive, cryptonote::tx_extra_padding, TX_EXTRA_TAG_PADDING)
#define BEGIN_SERIALIZE()
Begins the environment of the DSL for describing how to serialize an of an archive type...
POD_CLASS hash
Definition: hash.h:50
#define TX_EXTRA_TAG_BRIDGE_SMARTCHAIN_ADDRESS
Definition: tx_extra.h:44
else if(0==res)
#define FIELD(f)
tags the field with the variable name and then serializes it
#define FIELD_N(t, f)
serializes a field f tagged t
key zero()
Definition: rctOps.h:70