tw_chain 1.1.3

AIBlock Chain is a distributed blockchain store with a 2-way entry data structure.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

/*------- TRANSACTION CONSTANTS -------*/
pub const TX_PREPEND: u8 = b'g';
pub const ITEM_DEFAULT_DRS_TX_HASH: &str = "default_genesis_hash";
pub const MAX_METADATA_BYTES: usize = 800;
pub const TX_HASH_LENGTH: usize = 32;

/*------- ADDRESS CONSTANTS -------*/
pub const V0_ADDRESS_LENGTH: usize = 16;
pub const STANDARD_ADDRESS_LENGTH: usize = 64;
// Prepending character for a P2SH address
pub const P2SH_PREPEND: u8 = b'H';

/*------- NETWORK CONSTANTS --------*/
// Current network version: Always bump immediately after a version is deployed.
pub const NETWORK_VERSION: u32 = 6;
pub const NETWORK_VERSION_SERIALIZED: &[u8] = b"6";
// Network version 0
pub const NETWORK_VERSION_V0: u64 = 0;
// Network version to support temporary address structure on wallet
// TODO: Deprecate after addresses retire
pub const NETWORK_VERSION_TEMP: u64 = 99999;

/*------- VALUE HANDLING CONSTANTS --------*/
// Number of decimal places to divide to in display
pub const D_DISPLAY_PLACES_U64: u64 = 72072000;
pub const D_DISPLAY_PLACES: f64 = 72072000.0;
// Number of possible tokens in existence (5 billion)
pub const TOTAL_TOKENS: u64 = D_DISPLAY_PLACES_U64 * 5000000000;

/*------- ASSET CONSTANTS -------*/
// The value to sign/verify for item-based payments
pub const ITEM_ACCEPT_VAL: &str = "PAYMENT_ACCEPT";

/*------- BLOCK CONSTANTS --------*/
// Maximum number of bytes that a block can contain
pub const MAX_BLOCK_SIZE: usize = 1000;

/*------- SCRIPT CONSTANTS -------*/
// Maximum number of bytes pushable to the stack
pub const MAX_SCRIPT_ITEM_SIZE: u16 = 520;
// Maximum number of non-push operations per script
pub const MAX_OPS_PER_SCRIPT: u8 = 201;
// Maximum number of public keys per multisig
pub const MAX_PUB_KEYS_PER_MULTISIG: u8 = 20;
// Maximum script length in bytes
pub const MAX_SCRIPT_SIZE: u16 = 10000;
// Maximum number of values on script interpreter stack
pub const MAX_STACK_SIZE: u16 = 1000;

/*------- NUMBERS -------*/
pub const ZERO: usize = 0;
pub const ONE: usize = 1;
pub const TWO: usize = 2;
pub const THREE: usize = 3;
pub const FOUR: usize = 4;
pub const FIVE: usize = 5;
pub const SIX: usize = 6;
pub const SEVEN: usize = 7;
pub const EIGHT: usize = 8;
pub const NINE: usize = 9;
pub const TEN: usize = 10;
pub const ELEVEN: usize = 11;
pub const TWELVE: usize = 12;
pub const THIRTEEN: usize = 13;
pub const FOURTEEN: usize = 14;
pub const FIFTEEN: usize = 15;
pub const SIXTEEN: usize = 16;

/*------- TRACE MESSAGES -------*/

// flow control
pub const OPNOP: &str = "OP_NOP";
pub const OPIF: &str = "OP_IF";
pub const OPNOTIF: &str = "OP_NOTIF";
pub const OPELSE: &str = "OP_ELSE";
pub const OPENDIF: &str = "OP_ENDIF";
pub const OPVERIFY: &str = "OP_VERIFY";
pub const OPBURN: &str = "OP_BURN";

pub const OPNOP_DESC: &str = "Does nothing";
pub const OPIF_DESC: &str =
    "Checks if the top item on the stack is not ZERO and executes the next block of instructions";
pub const OPNOTIF_DESC: &str =
    "Checks if the top item on the stack is ZERO and executes the next block of instructions";
pub const OPELSE_DESC: &str =
    "Executes the next block of instructions if the previous OP_IF or OP_NOTIF was not executed";
pub const OPENDIF_DESC: &str = "Ends an OP_IF or OP_NOTIF block";
pub const OPVERIFY_DESC: &str =
    "Removes the top item from the stack and ends execution with an error if it is ZERO";
pub const OPBURN_DESC: &str = "Ends execution with an error";

// stack
pub const OPTOALTSTACK: &str = "OP_TOALTSTACK";
pub const OPFROMALTSTACK: &str = "OP_FROMALTSTACK";
pub const OP2DROP: &str = "OP_2DROP";
pub const OP2DUP: &str = "OP_2DUP";
pub const OP3DUP: &str = "OP_3DUP";
pub const OP2OVER: &str = "OP_2OVER";
pub const OP2ROT: &str = "OP_2ROT";
pub const OP2SWAP: &str = "OP_2SWAP";
pub const OPIFDUP: &str = "OP_IFDUP";
pub const OPDEPTH: &str = "OP_DEPTH";
pub const OPDROP: &str = "OP_DROP";
pub const OPDUP: &str = "OP_DUP";
pub const OPNIP: &str = "OP_NIP";
pub const OPOVER: &str = "OP_OVER";
pub const OPPICK: &str = "OP_PICK";
pub const OPROLL: &str = "OP_ROLL";
pub const OPROT: &str = "OP_ROT";
pub const OPSWAP: &str = "OP_SWAP";
pub const OPTUCK: &str = "OP_TUCK";

pub const OPTOALTSTACK_DESC: &str =
    "Moves the top item from the main stack to the top of the alt stack";
pub const OPFROMALTSTACK_DESC: &str =
    "Moves the top item from the alt stack to the top of the main stack";
pub const OP2DROP_DESC: &str = "Removes the top two items from the stack";
pub const OP2DUP_DESC: &str = "Duplicates the top two items on the stack";
pub const OP3DUP_DESC: &str = "Duplicates the top three items on the stack";
pub const OP2OVER_DESC: &str = "Copies the second-to-top pair of items to the top of the stack";
pub const OP2ROT_DESC: &str = "Moves the third-to-top pair of items to the top of the stack";
pub const OP2SWAP_DESC: &str = "Swaps the top two pairs of items on the stack";
pub const OPIFDUP_DESC: &str = "Duplicates the top item on the stack if it is not ZERO";
pub const OPDEPTH_DESC: &str = "Pushes the stack size onto the stack";
pub const OPDROP_DESC: &str = "Removes the top item from the stack";
pub const OPDUP_DESC: &str = "Duplicates the top item on the stack";
pub const OPNIP_DESC: &str = "Removes the second-to-top item from the stack";
pub const OPOVER_DESC: &str = "Copies the second-to-top item to the top of the stack";
pub const OPPICK_DESC: &str =
    "Copies the nth-to-top item to the top of the stack, where n is the top item on the stack";
pub const OPROLL_DESC: &str =
    "Moves the nth-to-top item to the top of the stack, where n is the top item on the stack";
pub const OPROT_DESC: &str = "Moves the third-to-top item to the top of the stack";
pub const OPSWAP_DESC: &str = "Swaps the top two items on the stack";
pub const OPTUCK_DESC: &str = "Copies the top item behind the second-to-top item on the stack";

// splice
pub const OPCAT: &str = "OP_CAT";
pub const OPSUBSTR: &str = "OP_SUBSTR";
pub const OPLEFT: &str = "OP_LEFT";
pub const OPRIGHT: &str = "OP_RIGHT";
pub const OPSIZE: &str = "OP_SIZE";

pub const OPCAT_DESC: &str = "Concatenates the two strings on top of the stack";
pub const OPSUBSTR_DESC: &str = "Extracts a substring from the third-to-top item on the stack";
pub const OPLEFT_DESC: &str = "Extracts a left substring from the second-to-top item on the stack";
pub const OPRIGHT_DESC: &str =
    "Extracts a right substring from the second-to-top item on the stack";
pub const OPSIZE_DESC: &str = "Computes the size in bytes of the string on top of the stack";

// bitwise logic
pub const OPINVERT: &str = "OP_INVERT";
pub const OPAND: &str = "OP_AND";
pub const OPOR: &str = "OP_OR";
pub const OPXOR: &str = "OP_XOR";
pub const OPEQUAL: &str = "OP_EQUAL";
pub const OPEQUALVERIFY: &str = "OP_EQUALVERIFY";

pub const OPINVERT_DESC: &str = "Computes bitwise NOT of the number on top of the stack";
pub const OPAND_DESC: &str = "Computes bitwise AND between the two numbers on top of the stack";
pub const OPOR_DESC: &str = "Computes bitwise OR between the two numbers on top of the stack";
pub const OPXOR_DESC: &str = "Computes bitwise XOR between the two numbers on top of the stack";
pub const OPEQUAL_DESC: &str =
    "Substitutes the top two items on the stack with ONE if they are equal, with ZERO otherwise";
pub const OPEQUALVERIFY_DESC: &str = "Computes OP_EQUAL and OP_VERIFY in sequence";

// arithmetic
pub const OP1ADD: &str = "OP_1ADD";
pub const OP1SUB: &str = "OP_1SUB";
pub const OP2MUL: &str = "OP_2MUL";
pub const OP2DIV: &str = "OP_2DIV";
pub const OPNOT: &str = "OP_NOT";
pub const OP0NOTEQUAL: &str = "OP_0NOTEQUAL";
pub const OPADD: &str = "OP_ADD";
pub const OPSUB: &str = "OP_SUB";
pub const OPMUL: &str = "OP_MUL";
pub const OPDIV: &str = "OP_DIV";
pub const OPMOD: &str = "OP_MOD";
pub const OPLSHIFT: &str = "OP_LSHIFT";
pub const OPRSHIFT: &str = "OP_RSHIFT";
pub const OPBOOLAND: &str = "OP_BOOLAND";
pub const OPBOOLOR: &str = "OP_BOOLOR";
pub const OPNUMEQUAL: &str = "OP_NUMEQUAL";
pub const OPNUMEQUALVERIFY: &str = "OP_NUMEQUALVERIFY";
pub const OPNUMNOTEQUAL: &str = "OP_NUMNOTEQUAL";
pub const OPLESSTHAN: &str = "OP_LESSTHAN";
pub const OPGREATERTHAN: &str = "OP_GREATERTHAN";
pub const OPLESSTHANOREQUAL: &str = "OP_LESSTHANOREQUAL";
pub const OPGREATERTHANOREQUAL: &str = "OP_GREATERTHANOREQUAL";
pub const OPMIN: &str = "OP_MIN";
pub const OPMAX: &str = "OP_MAX";
pub const OPWITHIN: &str = "OP_WITHIN";

pub const OP1ADD_DESC: &str = "Adds ONE to the number on top of the stack";
pub const OP1SUB_DESC: &str = "Subtracts ONE from the number on top of the stack";
pub const OP2MUL_DESC: &str = "Multiplies by TWO the number on top of the stack";
pub const OP2DIV_DESC: &str = "Divides by TWO the number on top of the stack";
pub const OPNOT_DESC: &str =
    "Substitutes the number on top of the stack with ONE if it is equal to ZERO, with ZERO otherwise";
pub const OP0NOTEQUAL_DESC: &str =
    "Substitutes the number on top of the stack with ONE if it is not equal to ZERO, with ZERO otherwise";
pub const OPADD_DESC: &str = "Adds the two numbers on top of the stack";
pub const OPSUB_DESC: &str =
    "Subtracts the number on top of the stack from the second-to-top number on the stack";
pub const OPMUL_DESC: &str =
    "Multiplies the second-to-top number by the number on top of the stack";
pub const OPDIV_DESC: &str = "Divides the second-to-top number by the number on top of the stack";
pub const OPMOD_DESC: &str =
    "Computes the remainder of the division of the second-to-top number by the number on top of the stack";
pub const OPLSHIFT_DESC: &str =
    "Computes the left shift of the second-to-top number by the number on top of the stack";
pub const OPRSHIFT_DESC: &str =
    "Computes the right shift of the second-to-top number by the number on top of the stack";
pub const OPBOOLAND_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if they are both non-zero, with ZERO otherwise";
pub const OPBOOLOR_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if they are not both ZERO, with ZERO otherwise";
pub const OPNUMEQUAL_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if they are equal, with ZERO otherwise";
pub const OPNUMEQUALVERIFY_DESC: &str = "Computes OP_NUMEQUAL and OP_VERIFY in sequence";
pub const OPNUMNOTEQUAL_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if they are not equal, with ZERO otherwise";
pub const OPLESSTHAN_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if the second-to-top is less than the top item, with ZERO otherwise";
pub const OPGREATERTHAN_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if the second-to-top is greater than the top item, with ZERO otherwise";
pub const OPLESSTHANOREQUAL_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if the second-to-top is less than or equal to the top item, with ZERO otherwise";
pub const OPGREATERTHANOREQUAL_DESC: &str = "Substitutes the two numbers on top of the stack with ONE if the second-to-top is greater than or equal to the top item, with ZERO otherwise";
pub const OPMIN_DESC: &str =
    "Substitutes the two numbers on top of the stack with the minimum between the two";
pub const OPMAX_DESC: &str =
    "Substitutes the two numbers on top of the stack with the maximum between the two";
pub const OPWITHIN_DESC: &str = "Substitutes the three numbers on top of the the stack with ONE if the third-to-top is greater or equal to the second-to-top and less than the top item, with ZERO otherwise";

// crypto
pub const OPSHA3: &str = "OP_SHA3";
pub const OPHASH256: &str = "OP_HASH256";
pub const OPHASH256V0: &str = "OP_HASH256_V0";
pub const OPHASH256TEMP: &str = "OP_HASH256_TEMP";
pub const OPCHECKSIG: &str = "OP_CHECKSIG";
pub const OPCHECKSIGVERIFY: &str = "OP_CHECKSIGVERIFY";
pub const OPCHECKMULTISIG: &str = "OP_CHECKMULTISIG";
pub const OPCHECKMULTISIGVERIFY: &str = "OP_CHECKMULTISIGVERIFY";

pub const OPSHA3_DESC: &str = "Hashes the top item on the stack using SHA3-256";
pub const OPHASH256_DESC: &str =
    "Creates standard address from public key and pushes it onto the stack";
pub const OPHASH256V0_DESC: &str =
    "Creates v0 address from public key and pushes it onto the stack";
pub const OPHASH256TEMP_DESC: &str =
    "Creates temporary address from public key and pushes it onto the stack";
pub const OPCHECKSIG_DESC: &str =
    "Pushes ONE onto the stack if the signature is valid, ZERO otherwise";
pub const OPCHECKSIGVERIFY_DESC: &str = "Runs OP_CHECKSIG and OP_VERIFY in sequence";
pub const OPCHECKMULTISIG_DESC: &str =
    "Pushes ONE onto the stack if the m-of-n multi-signature is valid, ZERO otherwise";
pub const OPCHECKMULTISIGVERIFY_DESC: &str = "Runs OP_CHECKMULTISIG and OP_VERIFY in sequence";

/*------- ERROR MESSAGES -------*/
// opcodes
pub const ERROR_EMPTY_CONDITION: &str = "Condition stack is empty";
pub const ERROR_VERIFY: &str = "The top item on the stack is ZERO";
pub const ERROR_BURN: &str = "OP_BURN executed";
pub const ERROR_NUM_ITEMS: &str = "Not enough items on the stack";
pub const ERROR_ITEM_TYPE: &str = "Item type is not correct";
pub const ERROR_ITEM_INDEX: &str = "Index is out of bound";
pub const ERROR_ITEM_SIZE: &str = "Item size exceeds MAX_SCRIPT_ITEM_SIZE-byte limit";
pub const ERROR_NOT_EQUAL_ITEMS: &str = "The two top items are not equal";
pub const ERROR_OVERFLOW: &str = "Attempt to overflow";
pub const ERROR_DIV_ZERO: &str = "Attempt to divide by ZERO";
pub const ERROR_INVALID_SIGNATURE: &str = "Signature is not valid";
pub const ERROR_INVALID_MULTISIGNATURE: &str = "Multi-signature is not valid";
pub const ERROR_NUM_PUBKEYS: &str = "Number of public keys provided is not correct";
pub const ERROR_NUM_SIGNATURES: &str = "Number of signatures provided is not correct";
// script
pub const ERROR_MAX_SCRIPT_SIZE: &str = "Script size exceeds MAX_SCRIPT_SIZE-byte limit";
pub const ERROR_MAX_STACK_SIZE: &str = "Stack size exceeds MAX_STACK_SIZE limit";
pub const ERROR_MAX_OPS_SCRIPT: &str =
    "Number of opcodes in script exceeds MAX_OPS_PER_SCRIPT limit";