psibase 0.23.0

Library and command-line tool for interacting with psibase networks
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
#![allow(non_snake_case)]

use crate::{
    AccountNumber, Action, BlockHeader, BlockInfo, BlockNum, Checksum256, Claim, DbId, Hex,
    JointConsensus, MethodNumber, MicroSeconds, Pack, ToSchema, Unpack,
};
use serde::{Deserialize, Serialize};

pub type NativeTable = u16;
pub type NativeIndex = u8;

pub const STATUS_TABLE: NativeTable = 1;
pub const CODE_TABLE: NativeTable = 2;
pub const CODE_BY_HASH_TABLE: NativeTable = 3;
pub const DATABASE_STATUS_TABLE: NativeTable = 4;
pub const TRANSACTION_WASM_CONFIG_TABLE: NativeTable = 5;
pub const PROOF_WASM_CONFIG_TABLE: NativeTable = 6; // Also for first auth
pub const CONFIG_TABLE: NativeTable = 7;
pub const NOTIFY_TABLE: NativeTable = 8;
pub const BLOCK_DATA_TABLE: NativeTable = 9;
pub const CONSENSUS_CHANGE_TABLE: NativeTable = 10;
pub const SNAPSHOT_TABLE: NativeTable = 11;
pub const SCHEDULED_SNAPSHOT_TABLE: NativeTable = 12;
pub const LOG_TRUNCATE_TABLE: NativeTable = 13;
pub const SOCKET_TABLE: NativeTable = 14;
pub const RUN_TABLE: NativeTable = 15;
pub const ENV_TABLE: NativeTable = 16;
pub const HOST_CONFIG_TABLE: NativeTable = 17;
pub const PENDING_SHUTDOWN_TABLE: NativeTable = 18;

pub const NATIVE_TABLE_PRIMARY_INDEX: NativeIndex = 0;

pub fn status_key() -> (NativeTable, NativeIndex) {
    (STATUS_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct StatusRow {
    pub chainId: Checksum256,
    pub current: BlockHeader,
    pub head: Option<BlockInfo>,
    pub consensus: JointConsensus,
}

impl StatusRow {
    pub const DB: DbId = DbId::Native;

    pub fn key(&self) -> (NativeTable, NativeIndex) {
        status_key()
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct ConfigRow {
    pub maxKeySize: u32,
    pub maxValueSize: u32,
}

impl ConfigRow {
    pub const DB: DbId = DbId::Native;

    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (CONFIG_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct VMOptions {
    max_mutable_global_bytes: u32,
    max_pages: u32,
    max_table_elements: u32,
    max_stack_bytes: u32,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct WasmConfigRow {
    numExecutionMemories: u32,
    vmOptions: VMOptions,
}

impl WasmConfigRow {
    pub const DB: DbId = DbId::Native;
    pub fn key(table: NativeTable) -> (NativeTable, NativeIndex) {
        (table, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct CodeRow {
    pub codeNum: AccountNumber,
    pub flags: u64,

    pub codeHash: Checksum256,
    pub vmType: u8,
    pub vmVersion: u8,
}

impl CodeRow {
    pub const DB: DbId = DbId::Native;
    pub const IS_PRIVILEGED: u64 = 1u64 << 0;
    pub const IS_VERIFY: u64 = 1u64 << 1;
    pub const IS_REPLACEMENT: u64 = 1u64 << 32;
    pub fn key(&self) -> (NativeTable, NativeIndex, AccountNumber) {
        (CODE_TABLE, NATIVE_TABLE_PRIMARY_INDEX, self.codeNum)
    }
}

/// where code is actually stored, duplicate services are reused
#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct CodeByHashRow {
    pub codeHash: Checksum256,
    pub vmType: u8,
    pub vmVersion: u8,

    pub code: Hex<Vec<u8>>,
}

impl CodeByHashRow {
    pub const DB: DbId = DbId::Native;
    pub fn key(&self) -> (NativeTable, NativeIndex, Checksum256, u8, u8) {
        (
            CODE_BY_HASH_TABLE,
            NATIVE_TABLE_PRIMARY_INDEX,
            self.codeHash.clone(),
            self.vmType,
            self.vmVersion,
        )
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct DatabaseStatusRow {
    nextHistoryEventNumber: u64,
    nextUIEventNumber: u64,
    nextMerkleEventNumber: u64,

    blockMerkleEventNumber: u64,
}

impl DatabaseStatusRow {
    pub const DB: DbId = DbId::Native;
    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (DATABASE_STATUS_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct NotifyRow {
    type_: u32,
    actions: Vec<Action>,
}

impl NotifyRow {
    pub const DB: DbId = DbId::Native;
    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (NOTIFY_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct BlockDataRow {
    pub blockId: Checksum256,
    pub auxConsensusData: Option<Hex<Vec<u8>>>,
}

impl BlockDataRow {
    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex, Checksum256) {
        (
            BLOCK_DATA_TABLE,
            NATIVE_TABLE_PRIMARY_INDEX,
            self.blockId.clone(),
        )
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct ConsensusChangeRow {
    pub start: BlockNum,
    pub commit: BlockNum,
    pub end: BlockNum,
}

impl ConsensusChangeRow {
    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex, BlockNum) {
        (
            CONSENSUS_CHANGE_TABLE,
            NATIVE_TABLE_PRIMARY_INDEX,
            self.start,
        )
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct StateChecksum {
    pub serviceRoot: Checksum256,
    pub nativeRoot: Checksum256,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct StateSignature {
    pub account: AccountNumber,
    pub claim: Claim,
    pub rawData: Hex<Vec<u8>>,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct SnapshotStateItem {
    pub state: StateChecksum,
    pub signatures: Vec<StateSignature>,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct SnapshotRow {
    pub id: Checksum256,
    pub state: Option<SnapshotStateItem>,
    pub other: Vec<SnapshotStateItem>,
}

impl SnapshotRow {
    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex, Checksum256) {
        (SNAPSHOT_TABLE, NATIVE_TABLE_PRIMARY_INDEX, self.id.clone())
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct ScheduledSnapshotRow {
    pub blockNum: BlockNum,
}

impl ScheduledSnapshotRow {
    pub const DB: DbId = DbId::Native;
    pub fn key(&self) -> (NativeTable, NativeIndex, BlockNum) {
        (
            SCHEDULED_SNAPSHOT_TABLE,
            NATIVE_TABLE_PRIMARY_INDEX,
            self.blockNum,
        )
    }
}

// If this row is present it indicates the height the block log starts at.
#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct LogTruncateRow {
    pub start: BlockNum,
}

impl LogTruncateRow {
    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (LOG_TRUNCATE_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack", definition_will_not_change)]
pub struct IPV4Address {
    bytes: [u8; 4],
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack", definition_will_not_change)]
pub struct IPV6Address {
    bytes: [u8; 16],
    zone: u32,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub enum IPAddress {
    IPV4Address(IPV4Address),
    IPV6Address(IPV6Address),
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack", definition_will_not_change)]
pub struct IPV4Endpoint {
    address: IPV4Address,
    port: u16,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack", definition_will_not_change)]
pub struct IPV6Endpoint {
    address: IPV6Address,
    port: u16,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack", definition_will_not_change)]
pub struct LocalEndpoint {
    path: String,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub enum SocketEndpoint {
    IPV4Endpoint(IPV4Endpoint),
    IPV6Endpoint(IPV6Endpoint),
    LocalEndpoint(LocalEndpoint),
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct TLSInfo {}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct ProducerMultiCastSocketInfo {}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct HttpSocketInfo {
    endpoint: Option<SocketEndpoint>,
    tls: Option<TLSInfo>,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct HttpClientSocketInfo {
    endpoint: Option<SocketEndpoint>,
    tls: Option<TLSInfo>,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct WebSocketInfo {
    endpoint: Option<SocketEndpoint>,
    tls: Option<TLSInfo>,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub enum SocketInfo {
    ProducerMultiCastSocketInfo(ProducerMultiCastSocketInfo),
    HttpSocketInfo(HttpSocketInfo),
    HttpClientSocketInfo(HttpClientSocketInfo),
    WebSocketInfo(WebSocketInfo),
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct SocketRow {
    fd: i32,
    info: SocketInfo,
}

impl SocketRow {
    // Well-known fds
    pub const PRODUCER_MULTICAST: i32 = 0;

    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex, i32) {
        (SOCKET_TABLE, NATIVE_TABLE_PRIMARY_INDEX, self.fd)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
#[repr(transparent)]
pub struct RunMode(u8);

impl RunMode {
    pub const VERIFY: RunMode = RunMode(0);
    pub const SPECULATIVE: RunMode = RunMode(1);
    pub const RPC: RunMode = RunMode(2);
    pub const CALLBACK: RunMode = RunMode(3);
}

pub type RunToken = Vec<u8>;

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct BoundMethod {
    service: AccountNumber,
    method: MethodNumber,
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct RunRow {
    id: u64,
    mode: RunMode,
    maxTime: MicroSeconds,
    action: Action,
    continuation: BoundMethod,
}

impl RunRow {
    pub const DB: DbId = DbId::NativeSubjective;
    pub fn key(&self) -> (NativeTable, NativeIndex, u64) {
        (RUN_TABLE, NATIVE_TABLE_PRIMARY_INDEX, self.id)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct EnvRow {
    pub name: String,
    pub value: String,
}

impl EnvRow {
    pub const DB: DbId = DbId::NativeSession;
    pub fn key(&self) -> (NativeTable, NativeIndex, String) {
        (ENV_TABLE, NATIVE_TABLE_PRIMARY_INDEX, self.name.clone())
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct HostConfigRow {
    pub hostVersion: String,
    pub config: String,
}

impl HostConfigRow {
    pub const DB: DbId = DbId::NativeSession;
    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (HOST_CONFIG_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}

#[derive(Debug, Clone, Pack, Unpack, ToSchema, Serialize, Deserialize)]
#[fracpack(fracpack_mod = "fracpack")]
pub struct PendingShutdownRow {
    pub args: String,
}

impl PendingShutdownRow {
    pub const DB: DbId = DbId::NativeSession;
    pub fn key(&self) -> (NativeTable, NativeIndex) {
        (PENDING_SHUTDOWN_TABLE, NATIVE_TABLE_PRIMARY_INDEX)
    }
}