soroban-sdk 25.3.1

Soroban SDK.
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
//! SpecShakingMarker is an internal trait used to ensure that contract type specs
//! are included in the WASM binary when types are used at contract boundaries.
//!
//! The trait is called at three external boundary points:
//! 1. Contract function input parameters
//! 2. Contract function return values
//! 3. Event publishing
//!
//! Types that are only used internally (storage, cross-contract calls) do not
//! need their specs included, so the trait is NOT called from general TryFromVal
//! conversions.
//!
//! The trait has a default no-op implementation. Types generated by contracttype,
//! contractevent, and contracterror macros implement this trait to include their
//! spec XDR in the WASM's contractspecv0 section.

/// Trait for types that may include their spec in the WASM binary.
///
/// This trait is used internally by the SDK to ensure contract type specs
/// are included when types are used at external boundaries (function params,
/// return values, events).
///
/// Types with `#[contracttype]`, `#[contractevent]`, or `#[contracterror]`
/// will have implementations that include their spec. All other types have
/// a no-op implementation.
#[doc(hidden)]
pub trait SpecShakingMarker {
    /// Include this type's spec in the WASM binary.
    ///
    /// For primitive types and built-in SDK types, this is a no-op.
    /// For user-defined contract types, this ensures the spec XDR is
    /// included in the contractspecv0 section.
    #[inline(always)]
    fn spec_shaking_marker() {}
}

// Primitive type implementations (no-op)
impl SpecShakingMarker for () {}
impl SpecShakingMarker for bool {}
impl SpecShakingMarker for u32 {}
impl SpecShakingMarker for i32 {}
impl SpecShakingMarker for u64 {}
impl SpecShakingMarker for i64 {}
impl SpecShakingMarker for u128 {}
impl SpecShakingMarker for i128 {}

// Reference implementations
impl<T: SpecShakingMarker> SpecShakingMarker for &T {
    #[inline(always)]
    fn spec_shaking_marker() {
        T::spec_shaking_marker();
    }
}

impl<T: SpecShakingMarker> SpecShakingMarker for &mut T {
    #[inline(always)]
    fn spec_shaking_marker() {
        T::spec_shaking_marker();
    }
}

// Option implementation - includes inner type's spec
impl<T: SpecShakingMarker> SpecShakingMarker for Option<T> {
    #[inline(always)]
    fn spec_shaking_marker() {
        T::spec_shaking_marker();
    }
}

// Result implementation - includes both types' specs
impl<T: SpecShakingMarker, E: SpecShakingMarker> SpecShakingMarker for Result<T, E> {
    #[inline(always)]
    fn spec_shaking_marker() {
        T::spec_shaking_marker();
        E::spec_shaking_marker();
    }
}

// Tuple implementations
impl<T0: SpecShakingMarker> SpecShakingMarker for (T0,) {
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
    }
}

impl<T0: SpecShakingMarker, T1: SpecShakingMarker> SpecShakingMarker for (T0, T1) {
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
    }
}

impl<T0: SpecShakingMarker, T1: SpecShakingMarker, T2: SpecShakingMarker> SpecShakingMarker
    for (T0, T1, T2)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
        T8: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7, T8)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
        T8::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
        T8: SpecShakingMarker,
        T9: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
        T8::spec_shaking_marker();
        T9::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
        T8: SpecShakingMarker,
        T9: SpecShakingMarker,
        T10: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
        T8::spec_shaking_marker();
        T9::spec_shaking_marker();
        T10::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
        T8: SpecShakingMarker,
        T9: SpecShakingMarker,
        T10: SpecShakingMarker,
        T11: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
        T8::spec_shaking_marker();
        T9::spec_shaking_marker();
        T10::spec_shaking_marker();
        T11::spec_shaking_marker();
    }
}

impl<
        T0: SpecShakingMarker,
        T1: SpecShakingMarker,
        T2: SpecShakingMarker,
        T3: SpecShakingMarker,
        T4: SpecShakingMarker,
        T5: SpecShakingMarker,
        T6: SpecShakingMarker,
        T7: SpecShakingMarker,
        T8: SpecShakingMarker,
        T9: SpecShakingMarker,
        T10: SpecShakingMarker,
        T11: SpecShakingMarker,
        T12: SpecShakingMarker,
    > SpecShakingMarker for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)
{
    #[inline(always)]
    fn spec_shaking_marker() {
        T0::spec_shaking_marker();
        T1::spec_shaking_marker();
        T2::spec_shaking_marker();
        T3::spec_shaking_marker();
        T4::spec_shaking_marker();
        T5::spec_shaking_marker();
        T6::spec_shaking_marker();
        T7::spec_shaking_marker();
        T8::spec_shaking_marker();
        T9::spec_shaking_marker();
        T10::spec_shaking_marker();
        T11::spec_shaking_marker();
        T12::spec_shaking_marker();
    }
}

// SDK type implementations (no-op for built-in types, propagate for containers)
// These are imported via crate:: to avoid circular dependencies

impl SpecShakingMarker for crate::Address {}
impl SpecShakingMarker for crate::Bytes {}
impl<const N: usize> SpecShakingMarker for crate::BytesN<N> {}
impl SpecShakingMarker for crate::String {}
impl SpecShakingMarker for crate::Symbol {}
impl SpecShakingMarker for crate::U256 {}
impl SpecShakingMarker for crate::I256 {}
impl SpecShakingMarker for crate::Timepoint {}
impl SpecShakingMarker for crate::Duration {}
impl SpecShakingMarker for crate::Val {}
impl SpecShakingMarker for crate::Error {}

// Container types - propagate to inner types
impl<T: SpecShakingMarker> SpecShakingMarker for crate::Vec<T> {
    #[inline(always)]
    fn spec_shaking_marker() {
        T::spec_shaking_marker();
    }
}

impl<K: SpecShakingMarker, V: SpecShakingMarker> SpecShakingMarker for crate::Map<K, V> {
    #[inline(always)]
    fn spec_shaking_marker() {
        K::spec_shaking_marker();
        V::spec_shaking_marker();
    }
}

// Additional SDK types
impl SpecShakingMarker for crate::MuxedAddress {}
impl<const N: usize> SpecShakingMarker for crate::crypto::Hash<N> {}
impl SpecShakingMarker for crate::crypto::bls12_381::G1Affine {}
impl SpecShakingMarker for crate::crypto::bls12_381::G2Affine {}
impl SpecShakingMarker for crate::crypto::bls12_381::Fp {}
impl SpecShakingMarker for crate::crypto::bls12_381::Fp2 {}
impl SpecShakingMarker for crate::crypto::bls12_381::Fr {}
impl SpecShakingMarker for crate::crypto::bn254::Bn254G1Affine {}
impl SpecShakingMarker for crate::crypto::bn254::Bn254G2Affine {}
impl SpecShakingMarker for crate::crypto::bn254::Bn254Fp {}
impl SpecShakingMarker for crate::crypto::bn254::Fr {}

// Auth types - these have export=false but are legitimately used at external
// boundaries (as inputs to __check_auth in custom account contracts).
// They don't emit specs themselves because they're internal SDK types.
impl SpecShakingMarker for crate::auth::Context {}
impl SpecShakingMarker for crate::auth::ContractContext {}
impl SpecShakingMarker for crate::auth::CreateContractHostFnContext {}
impl SpecShakingMarker for crate::auth::CreateContractWithConstructorHostFnContext {}
impl SpecShakingMarker for crate::auth::ContractExecutable {}
impl SpecShakingMarker for crate::auth::InvokerContractAuthEntry {}
impl SpecShakingMarker for crate::auth::SubContractInvocation {}