Turbo degeneracy

batch.yaml

@@ -45,6 +45,13 @@ etching:
     offset:
       start: 1000
       end: 9000
+  # future runes protocol changes may be opt-in. this may be for a variety of
+  # reasons, including that they make light client validation harder, or simply
+  # because they are too degenerate.
+  #
+  # setting `turbo` to `true` opts in to these future protocol changes,
+  # whatever they may be.
+  turbo: true
 
 # inscriptions to inscribe
 inscriptions:

crates/ordinals/src/etching.rs

@@ -8,6 +8,7 @@ pub struct Etching {
   pub spacers: Option<u32>,
   pub symbol: Option<char>,
   pub terms: Option<Terms>,
+  pub turbo: bool,
 }
 
 impl Etching {

crates/ordinals/src/runestone.rs

@@ -83,6 +83,7 @@ impl Runestone {
           Tag::OffsetEnd.take(&mut fields, |[end_offset]| u64::try_from(end_offset).ok()),
         ),
       }),
+      turbo: Flag::Turbo.take(&mut flags),
     });
 
     let mint = Tag::Mint.take(&mut fields, |[block, tx]| {
@@ -136,6 +137,10 @@ impl Runestone {
         Flag::Terms.set(&mut flags);
       }
 
+      if etching.turbo {
+        Flag::Turbo.set(&mut flags);
+      }
+
       Tag::Flags.encode([flags], &mut payload);
 
       Tag::Rune.encode_option(etching.rune.map(|rune| rune.0), &mut payload);
@@ -1074,7 +1079,7 @@ mod tests {
     assert_eq!(
       decipher(&[
         Tag::Flags.into(),
-        Flag::Etching.mask() | Flag::Terms.mask(),
+        Flag::Etching.mask() | Flag::Terms.mask() | Flag::Turbo.mask(),
         Tag::Rune.into(),
         4,
         Tag::Divisibility.into(),
@@ -1110,17 +1115,18 @@ mod tests {
           output: 0,
         }],
         etching: Some(Etching {
+          divisibility: Some(1),
+          premine: Some(8),
           rune: Some(Rune(4)),
+          spacers: Some(5),
+          symbol: Some('a'),
           terms: Some(Terms {
             cap: Some(9),
             offset: (None, Some(2)),
             amount: Some(3),
             height: (None, None),
           }),
-          premine: Some(8),
-          divisibility: Some(1),
-          symbol: Some('a'),
-          spacers: Some(5),
+          turbo: true,
         }),
         pointer: Some(0),
         mint: Some(RuneId::new(1, 1).unwrap()),
@@ -1433,6 +1439,7 @@ mod tests {
           offset: (Some(u32::MAX.into()), Some(u32::MAX.into())),
           height: (Some(u32::MAX.into()), Some(u32::MAX.into())),
         }),
+        turbo: true,
         premine: Some(u64::MAX.into()),
         rune: Some(Rune(u128::MAX)),
         symbol: Some('\u{10FFFF}'),
@@ -1704,13 +1711,14 @@ mod tests {
             amount: Some(14),
             offset: (Some(15), Some(16)),
           }),
+          turbo: true,
         }),
         mint: Some(RuneId::new(17, 18).unwrap()),
         pointer: Some(0),
       },
       &[
         Tag::Flags.into(),
-        Flag::Etching.mask() | Flag::Terms.mask(),
+        Flag::Etching.mask() | Flag::Terms.mask() | Flag::Turbo.mask(),
         Tag::Rune.into(),
         9,
         Tag::Divisibility.into(),
@@ -1754,12 +1762,13 @@ mod tests {
     case(
       Runestone {
         etching: Some(Etching {
-          premine: None,
           divisibility: None,
-          terms: None,
-          symbol: None,
+          premine: None,
           rune: Some(Rune(3)),
           spacers: None,
+          symbol: None,
+          terms: None,
+          turbo: false,
         }),
         ..default()
       },
@@ -1769,12 +1778,13 @@ mod tests {
     case(
       Runestone {
         etching: Some(Etching {
-          premine: None,
           divisibility: None,
-          terms: None,
-          symbol: None,
+          premine: None,
           rune: None,
           spacers: None,
+          symbol: None,
+          terms: None,
+          turbo: false,
         }),
         ..default()
       },

crates/ordinals/src/runestone/flag.rs

@@ -1,6 +1,7 @@
 pub(super) enum Flag {
   Etching = 0,
   Terms = 1,
+  Turbo = 2,
   #[allow(unused)]
   Cenotaph = 127,
 }

src/index.rs

@@ -48,7 +48,7 @@ mod updater;
 #[cfg(test)]
 pub(crate) mod testing;
 
-const SCHEMA_VERSION: u64 = 24;
+const SCHEMA_VERSION: u64 = 25;
 
 define_multimap_table! { SATPOINT_TO_SEQUENCE_NUMBER, &SatPointValue, u32 }
 define_multimap_table! { SAT_TO_SEQUENCE_NUMBER, u64, u32 }
@@ -386,6 +386,7 @@ impl Index {
               spaced_rune: SpacedRune { rune, spacers: 128 },
               symbol: Some('\u{29C9}'),
               timestamp: 0,
+              turbo: true,
             }
             .store(),
           )?;

src/index/entry.rs

@@ -53,6 +53,7 @@ pub struct RuneEntry {
   pub symbol: Option<char>,
   pub terms: Option<Terms>,
   pub timestamp: u64,
+  pub turbo: bool,
 }
 
 impl RuneEntry {
@@ -153,6 +154,7 @@ pub(super) type RuneEntryValue = (
   Option<char>,            // symbol
   Option<TermsEntryValue>, // terms
   u64,                     // timestamp
+  bool,                    // turbo
 );
 
 impl Default for RuneEntry {
@@ -169,6 +171,7 @@ impl Default for RuneEntry {
       symbol: None,
       terms: None,
       timestamp: 0,
+      turbo: false,
     }
   }
 }
@@ -189,6 +192,7 @@ impl Entry for RuneEntry {
       symbol,
       terms,
       timestamp,
+      turbo,
     ): RuneEntryValue,
   ) -> Self {
     Self {
@@ -220,6 +224,7 @@ impl Entry for RuneEntry {
         offset,
       }),
       timestamp,
+      turbo,
     }
   }
 
@@ -255,6 +260,7 @@ impl Entry for RuneEntry {
          }| (cap, height, amount, offset),
       ),
       self.timestamp,
+      self.turbo,
     )
   }
 }
@@ -572,6 +578,7 @@ mod tests {
       },
       symbol: Some('a'),
       timestamp: 10,
+      turbo: true,
     };
 
     let value = (
@@ -589,6 +596,7 @@ mod tests {
       Some('a'),
       Some((Some(1), (Some(2), Some(3)), Some(4), (Some(5), Some(6)))),
       10,
+      true,
     );
 
     assert_eq!(entry.store(), value);

src/index/updater/rune_updater.rs

@@ -243,6 +243,7 @@ impl<'a, 'tx, 'client> RuneUpdater<'a, 'tx, 'client> {
         spaced_rune: SpacedRune { rune, spacers: 0 },
         symbol: None,
         timestamp: self.block_time.into(),
+        turbo: false,
       },
       Artifact::Runestone(Runestone { etching, .. }) => {
         let Etching {
@@ -251,6 +252,7 @@ impl<'a, 'tx, 'client> RuneUpdater<'a, 'tx, 'client> {
           premine,
           spacers,
           symbol,
+          turbo,
           ..
         } = etching.unwrap();
 
@@ -269,6 +271,7 @@ impl<'a, 'tx, 'client> RuneUpdater<'a, 'tx, 'client> {
           },
           symbol,
           timestamp: self.block_time.into(),
+          turbo,
         }
       }
     };

src/runes.rs

@@ -843,6 +843,7 @@ mod tests {
           divisibility: Some(1),
           symbol: Some('$'),
           spacers: Some(1),
+          turbo: true,
         }),
         pointer: Some(10),
         ..default()
@@ -868,6 +869,7 @@ mod tests {
           },
           symbol: None,
           timestamp: id.block,
+          turbo: false,
         },
       )],
       [],
@@ -5486,6 +5488,7 @@ mod tests {
               offset: (None, None),
             }),
             timestamp: 0,
+            turbo: true,
           },
         )],
         [],

src/subcommand/runes.rs

@@ -20,6 +20,7 @@ pub struct RuneInfo {
   pub symbol: Option<char>,
   pub terms: Option<Terms>,
   pub timestamp: DateTime<Utc>,
+  pub turbo: bool,
   pub tx: u32,
 }
 
@@ -52,6 +53,7 @@ pub(crate) fn run(settings: Settings) -> SubcommandResult {
             symbol,
             terms,
             timestamp,
+            turbo,
           },
         )| {
           (
@@ -70,6 +72,7 @@ pub(crate) fn run(settings: Settings) -> SubcommandResult {
               symbol,
               terms,
               timestamp: crate::timestamp(timestamp),
+              turbo,
               tx: id.tx,
             },
           )

src/subcommand/server.rs

@@ -2715,6 +2715,7 @@ mod tests {
           rune: Some(rune),
           symbol: Some('%'),
           premine: Some(u128::MAX),
+          turbo: true,
           ..default()
         }),
         ..default()
@@ -2742,6 +2743,7 @@ mod tests {
           premine: u128::MAX,
           symbol: Some('%'),
           timestamp: id.block,
+          turbo: true,
           ..default()
         }
       )]
@@ -2782,6 +2784,8 @@ mod tests {
   <dd>0</dd>
   <dt>symbol</dt>
   <dd>%</dd>
+  <dt>turbo</dt>
+  <dd>true</dd>
   <dt>etching</dt>
   <dd><a class=monospace href=/tx/{txid}>{txid}</a></dd>
   <dt>parent</dt>

src/templates/rune.rs

@@ -42,6 +42,7 @@ mod tests {
           },
           symbol: Some('%'),
           timestamp: 0,
+          turbo: true,
         },
         id: RuneId { block: 10, tx: 9 },
         mintable: true,
@@ -92,6 +93,8 @@ mod tests {
   <dd>9</dd>
   <dt>symbol</dt>
   <dd>%</dd>
+  <dt>turbo</dt>
+  <dd>true</dd>
   <dt>etching</dt>
   <dd><a class=monospace href=/tx/0{64}>0{64}</a></dd>
   <dt>parent</dt>
@@ -120,6 +123,7 @@ mod tests {
           },
           symbol: Some('%'),
           timestamp: 0,
+          turbo: false,
         },
         id: RuneId { block: 10, tx: 9 },
         mintable: false,
@@ -134,6 +138,40 @@ mod tests {
     );
   }
 
+  #[test]
+  fn display_no_turbo() {
+    assert_regex_match!(
+      RuneHtml {
+        entry: RuneEntry {
+          block: 0,
+          burned: 123456789123456789,
+          terms: None,
+          divisibility: 9,
+          etching: Txid::all_zeros(),
+          mints: 0,
+          number: 25,
+          premine: 0,
+          spaced_rune: SpacedRune {
+            rune: Rune(u128::MAX),
+            spacers: 1
+          },
+          symbol: Some('%'),
+          timestamp: 0,
+          turbo: false,
+        },
+        id: RuneId { block: 10, tx: 9 },
+        mintable: false,
+        parent: None,
+      },
+      "<h1>B•CGDENLQRQWDSLRUGSNLBTMFIJAV</h1>
+<dl>.*
+  <dt>turbo</dt>
+  <dd>false</dd>
+.*</dl>
+"
+    );
+  }
+
   #[test]
   fn display_empty_mint() {
     assert_regex_match!(
@@ -158,6 +196,7 @@ mod tests {
           },
           symbol: Some('%'),
           timestamp: 0,
+          turbo: false,
         },
         id: RuneId { block: 10, tx: 9 },
         mintable: false,

src/wallet/batch/etching.rs

@@ -8,5 +8,6 @@ pub struct Etching {
   pub rune: SpacedRune,
   pub supply: Decimal,
   pub symbol: char,
-  pub terms: Option<Terms>,
+  pub terms: Option<batch::Terms>,
+  pub turbo: bool,
 }