docs: Merge pull request #3253 from input-output-hk/paolino/ADP-1596/…

…simple-metadata
cardano-foundation · May 11, 2022 · f6dd2eb · f6dd2eb
1 parent 29e49f7
commit f6dd2eb
Show file tree

Hide file tree

Showing 60 changed files with 132 additions and 71 deletions.
diff --git a/-/all.html b/-/all.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/-/tags.html b/-/tags.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/-/tasks.html b/-/tasks.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/api/edge/swagger.yaml b/api/edge/swagger.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.0.3
 info:
   title: Cardano Wallet Backend API
   version: v2022-04-27
@@ -1614,19 +1614,34 @@ x-transactionMetadata: &transactionMetadata
     metadata from chain, be aware that integers may exceed the
     javascript numeric range, and may need special "bigint" parsing.
 
-  type: object
-  nullable: true
-  additionalProperties:
-    $ref: "#/components/schemas/TransactionMetadataValue"
+  # with oneOf we get errors about the 2 schema being both valid
+  # anyOf seems broken trying to find properties
+  anyOf:
+    - type: object
+      title: full
+      nullable: true
+      additionalProperties:
+            $ref: "#/components/schemas/TransactionMetadataValue"
+      example:
+        0: { "string": "cardano" }
+        1: { "int": 14 }
+        2: { "bytes": "2512a00e9653fe49a44a5886202e24d77eeb998f" }
+        3: { "list": [ { "int": 14 }, { "int": 42 }, { "string": "1337" } ] }
+        4: { "map": [{ "k": { "string": "key" }, "v": { "string": "value" }}, { "k": { "int": 14 }, "v": { "int": 42 } }] }
+    - type: object
+      title: simple
+      nullable: true
+      additionalProperties:
+            $ref: "#/components/schemas/TransactionMetadataValueNoSchema"
+            example:
+              0: "cardano"
+              1: 14
+              3: [14, 42 , "1337" ]
+              4: {"key1": "value" , "key2": 42 }
+
   # Note: propertyNames pattern not supported in current OpenAPI version.
   # propertyNames:
   #   pattern: '^[0-9]+$'
-  example:
-    0: { "string": "cardano" }
-    1: { "int": 14 }
-    2: { "bytes": "2512a00e9653fe49a44a5886202e24d77eeb998f" }
-    3: { "list": [ { "int": 14 }, { "int": 42 }, { "string": "1337" } ] }
-    4: { "map": [{ "k": { "string": "key" }, "v": { "string": "value" }}, { "k": { "int": 14 }, "v": { "int": 42 } }] }
 
 x-transactionTTL: &transactionTTL
   description: |
@@ -3492,12 +3507,31 @@ components:
               type: array
               items:
                 type: object
+                nullable: true
                 properties:
                   k:
                     $ref: "#/components/schemas/TransactionMetadataValue"
                   v:
                     $ref: "#/components/schemas/TransactionMetadataValue"
 
+    TransactionMetadataValueNoSchema: &TransactionMetadataValueNoSchema
+      oneOf:
+        - title: String
+          type: string
+
+        - title: Int
+          type: integer
+
+        - title: List
+          type: array
+          items:
+            $ref: "#/components/schemas/TransactionMetadataValueNoSchema"
+
+        - title: Map
+          type: object
+          additionalProperties:
+              $ref: "#/components/schemas/TransactionMetadataValueNoSchema"
+
     ApiGetSettings: &ApiGetSettings
       type: object
       required:
@@ -3821,6 +3855,17 @@ x-parametersForceNtpCheck: &parametersForceNtpCheck
   schema:
     type: boolean
 
+x-parametersMetadataFormat: &parametersMetadataFormat
+  in: query
+  name: simple-metadata
+  schema:
+    type: boolean
+  allowEmptyValue: true
+  description: |
+    When present (or equal to true) in the query, the metadata format for the
+    transaction(s) in the output will be untyped plain json as specified in
+    [CIP 25](https://cips.cardano.org/cips/cip25/)
+
 x-parametersMinWithdrawal: &parametersMinWithdrawal
   in: query
   name: minWithdrawal
@@ -5939,6 +5984,7 @@ paths:
         - *parametersEndDate
         - *parametersSortOrder
         - *parametersMinWithdrawal
+        - *parametersMetadataFormat
       responses: *responsesListTransactions
 
   /wallets/{walletId}/transactions/{transactionId}:
@@ -5953,6 +5999,7 @@ paths:
       parameters:
         - *parametersWalletId
         - *parametersTransactionId
+        - *parametersMetadataFormat
       responses: *responsesGetTransaction
 
     delete:

diff --git a/archives.html b/archives.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr.html b/archives/jormungandr.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr/Docker-jormungandr.html b/archives/jormungandr/Docker-jormungandr.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/archives/jormungandr/cardano-wallet-jormungandr-manual.html b/archives/jormungandr/cardano-wallet-jormungandr-manual.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts.html b/concepts.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/address-derivation.html b/concepts/address-derivation.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/byron-address-format.html b/concepts/byron-address-format.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/coin-selection.html b/concepts/coin-selection.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/hierarchical-deterministic-wallets.html b/concepts/hierarchical-deterministic-wallets.html
@@ -35,7 +35,7 @@
 <script async id='MathJax-script' src='https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/master-key-generation.html b/concepts/master-key-generation.html
@@ -28,7 +28,7 @@
 <script src='https://cdnjs.cloudflare.com/ajax/libs/prism/1.26.0/plugins/autoloader/prism-autoloader.min.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/recovery-phrases.html b/concepts/recovery-phrases.html
@@ -29,7 +29,7 @@
 <script async id='MathJax-script' src='https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js'></script>
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/transaction-lifecycle.html b/concepts/transaction-lifecycle.html
@@ -47,7 +47,7 @@
 </script>
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/concepts/utxo.html b/concepts/utxo.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing.html b/contributing.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Hydra.html b/contributing/Hydra.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Logging-Guidelines.html b/contributing/Logging-Guidelines.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Nix.html b/contributing/Nix.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Notes-from-upgrading-GHC-version.html b/contributing/Notes-from-upgrading-GHC-version.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Release-Checklist.html b/contributing/Release-Checklist.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Swagger-Development.html b/contributing/Swagger-Development.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/contributing/Testing.html b/contributing/Testing.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>
@@ -2462,7 +2462,21 @@ <h4 id='environment-variables' class='mt-6 mb-2 text-2xl font-bold text-gray-700
     <p class='mb-3'>
       Only Error level logs are shown on stdout during test execution. To change this, set the <code class='py-0.5 px-1 rounded bg-gray-700 text-sm text-white'>*_MIN_SEVERITY</code> variables shown above.
     </p>
-  <h2 id='mock-servers' class='inline-block mt-6 mb-4 text-4xl font-bold text-gray-700 border-b-2'>Mock servers</h2>
+  <h4 id='common-failures-and-resolution' class='mt-6 mb-2 text-2xl font-bold text-gray-700'>Common Failures and Resolution</h4><h5 id='no-more-wallets' class='mt-6 mb-2 text-xl font-bold text-gray-700'>No More Wallets</h5>
+    <p class='mb-3'>
+      If your test fails with something like:
+    </p>
+  <div class='py-0.5 mb-3 text-sm'><pre><code class='language-none'>user error (No more faucet wallet available in MVar!)</code></pre></div>
+    <p class='mb-3'>
+      Generate more wallet mnemonics and populate the appropriate list in <code class='py-0.5 px-1 rounded bg-gray-700 text-sm text-white'>lib/core-integration/src/Test/Integration/Faucet.hs</code>.
+    </p>
+
+    <p class='mb-3'>
+      Generate new mnemonics with:
+    </p>
+  <div class='py-0.5 mb-3 text-sm'><pre><code class='language-none'>nix build .#cardano-wallet
+# Size may vary depending on which array you need to add to.
+./result/bin/cardano-wallet recovery-phrase generate --size 15</code></pre></div><h2 id='mock-servers' class='inline-block mt-6 mb-4 text-4xl font-bold text-gray-700 border-b-2'>Mock servers</h2>
     <p class='mb-3'>
       Use the <code class='py-0.5 px-1 rounded bg-gray-700 text-sm text-white'>cardano-wallet:mock-token-metadata-server</code> executable as a mock server for asset metadata. See the <code class='py-0.5 px-1 rounded bg-gray-700 text-sm text-white'>--help</code> output for full instructions.
     </p>

diff --git a/contributing/Updating-Dependencies.html b/contributing/Updating-Dependencies.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design.html b/design.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/Eras.html b/design/Eras.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>

diff --git a/design/Notes-about-BIP-44.html b/design/Notes-about-BIP-44.html
@@ -25,7 +25,7 @@
 
 
 
-  <link href='tailwind.css?instanceId=7a56775a-402d-40a9-991d-f192604327ee' rel='stylesheet' type='text/css' />
+  <link href='tailwind.css?instanceId=dac0c207-4f7c-457b-88d0-9137c09d83ff' rel='stylesheet' type='text/css' />
 
   <!-- Heist error element -->
   <style type='text/css'>