Improved seed backup page information.

wolfmcnally · wolfmcnally · commit 13706013ac2e · 2024-02-01T00:44:32.000-08:00
diff --git a/README.md b/README.md
@@ -47,6 +47,16 @@ _For related Threat Modeling, see the [Seed Tool Manual](https://github.com/Bloc
 
 [Join the Test Flight Open Beta](https://testflight.apple.com/join/0LIl6H1h)
 
+### 1.6 (76)
+
+* THIS IS A RELEASE CANDIDATE
+* Seed Detail > Authenticate > Backup > Backup as Gordian Envelope > Print
+    * The printed seed backup page "Derivations" section has been replaced with a display that varies depending on the "Primary Asset" app setting:
+        * Bitcoin: The associated output descriptor (if any) is shown.
+        * Ethereum: The ETH account ID is shown.
+        * Tezos: The Tezos address is shown.
+    * When any of the above are shown, a QR code containing the same information is also shown.
+
 ### 1.6 (75)
 
 * THIS IS A RELEASE CANDIDATE
@@ -232,7 +242,7 @@ See [Version History](VERSIONS.md) for previous builds.
 
 ## Origin, Authors, Copyright & Licenses
 
-Unless otherwise noted (either in this [/README.md](./README.md) or in the file's header comments) the contents of this repository are Copyright © 2020 by Blockchain Commons, LLC, and are [licensed](./LICENSE) under the [spdx:BSD-2-Clause Plus Patent License](https://spdx.org/licenses/BSD-2-Clause-Patent.html).
+Unless otherwise noted (either in this [/README.md](./README.md) or in the file's header comments) the contents of this repository are Copyright © 2024 by Blockchain Commons, LLC, and are [licensed](./LICENSE) under the [spdx:BSD-2-Clause Plus Patent License](https://spdx.org/licenses/BSD-2-Clause-Patent.html).
 
 In most cases, the authors, copyright, and license for each file reside in header comments in the source code. When it does not, we have attempted to attribute it accurately in the table below.
 
diff --git a/SeedTool/Markdown/license-and-disclaimer.md b/SeedTool/Markdown/license-and-disclaimer.md
@@ -4,7 +4,7 @@ Please read and accept the terms of our disclaimer:
 
 The use of Gordian Seed Tool is under the [BSD 2-Clause Plus Patent License](https://spdx.org/licenses/BSD-2-Clause-Patent.html). 
 
-Copyright © 2022 BlockchainCommons.
+Copyright © 2024 BlockchainCommons.
 All rights reserved.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/SeedTool/SeedToolApp.swift b/SeedTool/SeedToolApp.swift
@@ -28,14 +28,24 @@ let globalFormatContext = {
 // xcrun simctl openurl booted ur:seed/otadgdlfwfdwlphlfsghcphfcsaybekkkbaejkaosezofptplpayftemckpfaxihfpjziniaihttmhwnen
 // ```
 
+/// The global settings object.
+///
+/// Only use `globalSettings` if you must. Prefer:
+///
+///     @EnvironmentObject private var settings: Settings
+///
+let globalSettings = {
+    Settings(storage: UserDefaults.standard)
+}()
+
 @main
 struct SeedToolApp: App {
     @UIApplicationDelegateAdaptor private var appDelegate: AppDelegate
     @StateObject private var model: Model
     @StateObject private var settings: Settings
     
     init() {
-        let settings = Settings(storage: UserDefaults.standard)
+        let settings = globalSettings
         let model = Model(settings: settings)
         self._settings = StateObject(wrappedValue: settings)
         self._model = StateObject(wrappedValue: model)
diff --git a/SeedTool/Seeds/SeedBackupPage.swift b/SeedTool/Seeds/SeedBackupPage.swift
@@ -19,7 +19,7 @@ let seedDateFormatter: DateFormatter = {
 
 struct SeedBackupPage: View {
     let seed: ModelSeed
-    
+
     let titleFontSize = 16.0
     let textFontSize = 12.0
     let sectionSpacing = 12.0
@@ -83,14 +83,66 @@ struct SeedBackupPage: View {
         }
     }
     
+    @ViewBuilder
+    var btcDerivation: some View {
+        if let outputDescriptor = seed.outputDescriptor {
+            BackupPageSection(title: Text("Output Descriptor"), icon: Image.bitcoin) {
+                HStack {
+                    PrintingQRCodeView(message: outputDescriptor.sourceWithChecksum.utf8Data)
+                        .frame(height: 50)
+                    VStack(alignment: .leading) {
+                        Text(outputDescriptor.sourceWithChecksum)
+                            .appMonospaced(size: textFontSize)
+                    }
+                    Spacer()
+                }
+            }
+        }
+    }
+    
+    @ViewBuilder
+    var ethDerivation: some View {
+        BackupPageSection(title: Text("Ethereum Account"), icon: Image.ethereum) {
+            HStack {
+                PrintingQRCodeView(message: ethereumAccount.utf8Data)
+                    .frame(height: 50)
+                VStack(alignment: .leading) {
+                    Text(ethereumAccount)
+                        .appMonospaced(size: textFontSize)
+                }
+                Spacer()
+            }
+        }
+    }
+    
+    @ViewBuilder
+    var xtzDerivation: some View {
+        BackupPageSection(title: Text("Tezos Address"), icon: Image.tezos) {
+            HStack {
+                PrintingQRCodeView(message: tezosAddress.utf8Data)
+                    .frame(height: 50)
+                VStack(alignment: .leading) {
+                    Text(tezosAddress)
+                        .appMonospaced(size: textFontSize)
+                }
+                Spacer()
+            }
+        }
+    }
+    
+    @ViewBuilder
     var derivations: some View {
-        BackupPageSection(title: Text("Derivations"), icon: Image.key) {
-            VStack(alignment: .leading, spacing: 5) {
-                Text("Master Key Fingerprint: ").bold() + Text(masterKeyFingerprint.flanked("[", "]")).appMonospaced(size: textFontSize)
-                Text("Ethereum Account: ").bold() + Text(ethereumAccount).appMonospaced(size: textFontSize)
+        VStack(alignment: .leading, spacing: 5) {
+            switch globalSettings.primaryAsset {
+            case .btc:
+                btcDerivation
+            case .eth:
+                ethDerivation
+            case .xtz:
+                xtzDerivation
             }
-            .layoutPriority(1)
         }
+        .layoutPriority(1)
     }
     
     var masterKey: HDKey {
@@ -104,6 +156,10 @@ struct SeedBackupPage: View {
     var ethereumAccount: String {
         Ethereum.Address(hdKey: masterKey).description
     }
+    
+    var tezosAddress: String {
+        Tezos.Address(hdKey: masterKey)!.description
+    }
 }
 
 struct BackupPageLabel: View {
diff --git a/fastlane/Fastfile b/fastlane/Fastfile
@@ -20,12 +20,6 @@ platform :ios do
     capture_screenshots(workspace: "SeedTool.xcworkspace", scheme: "SeedToolUITests")
   end
 
-  lane :precheck_metadata do
-      precheck(
-          platform: "ios"
-      )
-  end
-
   lane :upload_metadata_and_screenshots do
     upload_to_app_store(skip_binary_upload: true, overwrite_screenshots: true)
   end
@@ -38,6 +32,15 @@ platform :ios do
     upload_to_app_store(skip_binary_upload: true, skip_metadata: true, overwrite_screenshots: true)
   end
 
+  #
+  # Do this *after* metadata upload but *before* submitting for review
+  #
+  lane :precheck_metadata do
+      precheck(
+          platform: "ios"
+      )
+  end
+
   lane :build do
     build_ios_app(
         scheme: "SeedTool",
diff --git a/fastlane/Preview.html b/fastlane/Preview.html
@@ -1,7 +1,8 @@
 <!DOCTYPE html>
 <html>
     <head>
-        <title>deliver - Gordian Seed Tool</title>
+        <title>deliver - Gordian Seed Tool
+</title>
         <meta http-equiv="content-type" content="text/html; charset=UTF-8">
         <style>
           .app-name {
@@ -147,30 +148,92 @@
       
         
           <div class="app-name">
-            en-US
+            en-US: Gordian Seed Tool
+
           </div>
         
 
         
+          <div class="app-subtitle">
+            Subtitle:  Cryptographic Seed Vault
+
+          </div>
+        
 
         <div class="app-urls">
           
           
             
             
+              <div class="app-url-descr">
+                support_url: <a target="_blank" class="app-url" href="https://github.com/BlockchainCommons/GordianSeedTool-iOS/issues
+">https://github.com/BlockchainCommons/GordianSeedTool-iOS/issues
+</a>
+              </div>
+            
           
             
             
+              <div class="app-url-descr">
+                marketing_url: <a target="_blank" class="app-url" href="https://github.com/blockchaincommons/GordianSeedTool-iOS
+">https://github.com/blockchaincommons/GordianSeedTool-iOS
+</a>
+              </div>
+            
           
         </div>
 
         
+          <div class="app-keyword">
+              <div class="cat-headline">Keywords</div>
+              <ul class="app-keyword-list">
+                
+                  <li>cryptography</li>
+                
+                  <li>cryptocurrency</li>
+                
+                  <li>bitcoin</li>
+                
+                  <li>private keys</li>
+                
+                  <li>seeds</li>
+                
+                  <li>blockchain</li>
+                
+                  <li>qr</li>
+                
+                  <li>wallet</li>
+                
+                  <li>security</li>
+                
+                  <li>psbt</li>
+                
+              </ul>
+          </div>
+        
 
         
+          <div class="app-description">
+               <div class="cat-headline">Description</div>
+               <div class="app-description-text">
+                  Gordian Seed Tool protects your cryptographic seeds while also making them available for easy use. Using Seed Tool, you can generate seeds and store them securely on your device. You can then derive and share multi-signature signing and verification keys from those seeds or use them to sign PSBTs. Sophisticated backup procedures include printed pages and Sharded Secret Key Reconstruction (SSKR) — which lets you split your seed into pieces and send them to trusted parties, who can send them back to you in an emergency for seed recovery. You can even use an entirely offline device (no internet access) to store your seeds and use QR codes to exchange accounts, descriptors, seeds, keys, or PSBTs with online devices running compatible wallet or signing software.<br /><br />The "seeds" generated and protected by Gordian Seed Tool are long strings of truly random numbers used in cryptography. As the name suggests, seeds are the starting point for other things such as cryptocurrency keys and addresses. To be secure, seeds need to be created and saved safely.<br /><br />NOTE: Gordian Seed Tool is not a cryptocurrency wallet. It does not store or transmit value in any cryptocurrency, but it can be used in conjunction with such tools.<br /><br />Gordian Seed Tool is open-source software from Blockchain Commons, a not-for-profit public-good organization. Find our repository on GitHub and check out the code for yourself!<br />
+               </div>
+          </div>
+        
 
         
+          <div class="app-changelog">
+              <div class="cat-headline">Changelog</div>
+              Improvements in 1.6<br /><br />UI Best Practices<br /><br />• BIP39/ByteWords Entry: Shows validity of individual words<br />• Hex Entry: More accessible entry cuts out spaces, other non-hex entries<br />• Seed Printing: Elides some info if necessary to print out a backup of a seed<br />• Fingerprint Info: Seed views now display master fingerprint & Lifehash<br /><br />Resilience Best Practices<br /><br />• Output Descriptor: Output Descriptor can be saved as seed metadata<br /><br />Other Chain Expansions<br /><br />• Tezos Support: Generates tz1 addresses & private keys<br />• Ethereum & Tezos Improvements: Better shows necessary data for chains<br /><br />Specification Updates<br /><br />• Envelope is now prime output type for seeds, SSKR, requests, responses<br />• Envelope attachments are supported<br />• Update to Envelope v2, based on IETF feedback<br />• Update to Account Descriptor v2, Output Descriptor v3, based on community feedback<br />• Update to IANA registered CBOR numbers (with backward compatibility as needed)<br /><br />General bug fixes and improvements.<br />
+          </div>
+        
 
         
+          <div class="app-changelog">
+              <div class="cat-headline">Promotional Text</div>
+              Securely generates, stores, imports, and exports cryptographic seeds (long random numbers) used in a variety of cryptographic and cryptocurrency applications.<br />
+          </div>
+        
 
         <div class="app-screenshots">
           <div class="cat-headline">Screenshots</div>
@@ -308,5 +371,61 @@ <h4>iPad Pro (12.9-inch) (3rd generation)</h4>
       
 
       
+        <div class="app-minor-information">
+          <div class="cat-headline">Review Information</div>
+          <dl class="app-minor-information">
+            
+                <dt class="app-minor-information-key">
+                  First name
+                </dt>
+                <dd class="app-minor-information-text">
+                  Wolf<br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Last name
+                </dt>
+                <dd class="app-minor-information-text">
+                  McNally<br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Phone number
+                </dt>
+                <dd class="app-minor-information-text">
+                  +1 626 488 7620<br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Email address
+                </dt>
+                <dd class="app-minor-information-text">
+                  wolf@wolfmcnally.com<br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Demo user
+                </dt>
+                <dd class="app-minor-information-text">
+                  <br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Demo password
+                </dt>
+                <dd class="app-minor-information-text">
+                  <br />
+                </dd>
+            
+                <dt class="app-minor-information-key">
+                  Notes
+                </dt>
+                <dd class="app-minor-information-text">
+                  Note: This is not a cryptocurrency wallet. It neither stores nor transmits value in any cryptocurrency.<br /><br />To test the app's scanning capabilities, you can find a PDF containing a "ur:crypto-seed" QR code attached, or at this URL: https://github.com/BlockchainCommons/GordianSeedTool-iOS/blob/master/Testing/DPAL%20Seed.pdf<br />
+                </dd>
+            
+          </dl>
+        </div>
+      
     </body>
 </html>
