Implement SupportedAssetStore for bityProvider #5226

samholmes · 2024-08-30T01:01:26Z

CHANGELOG

Does this branch warrant an entry to the CHANGELOG?

Yes
No

Dependencies

none

Requirements

If you have made any visual changes to the GUI. Make sure you have:

Tested on iOS device
Tested on Android device
Tested on small-screen device (iPod Touch)
Tested on large-screen device (tablet)

Example JSON

Example is support store for bity.

{
  "*": {
    "AT": true,
    "BE": true,
    "BG": true,
    "CH": true,
    "CZ": true,
    "DK": true,
    "EE": true,
    "FI": true,
    "FR": true,
    "DE": true,
    "GR": true,
    "HU": true,
    "IE": true,
    "IT": true,
    "LV": true,
    "LT": true,
    "LU": true,
    "NL": true,
    "PL": true,
    "PT": true,
    "RO": true,
    "SK": true,
    "SI": true,
    "ES": true,
    "SE": true,
    "HR": true,
    "LI": true,
    "NO": true,
    "SM": true,
    "GB": true,
    "*": {
      "*": {
        "sepa": {
          "bitcoin:null": true,
          "ethereum:null": true,
          "ethereum:a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": true,
          "ethereum:dac17f958d2ee523a2206206994597c13d831ec7": true
        }
      }
    }
  },
  "sell": { "*": { "iso:CHF": { "sepa": true }, "iso:EUR": { "sepa": true } } }
}

To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1208002585478670

paullinator

Request architectural change per phone convo

samholmes · 2024-09-23T21:44:36Z

@paullinator Our phone conversation resulted in the task to come up with the proposal for the ProviderSupportStore interface. I followed up later that day with the following interface proposals:

Note: by using Map’s we can use keys like EdgeTokenId (which are not strictly a string type). This will require serialization to/from JSON for document storage on the info server.

Could you confirm that these proposals are approved to implement?

paullinator · 2024-10-28T03:42:59Z

src/util/cleaners.ts

@@ -26,3 +26,77 @@ export const asMaybeContractLocation = asMaybe(
    contractAddress: asString
  })
 )
+
+export const asObjectIn = <K extends string | number | symbol, T>(asKey: Cleaner<K>, asT: Cleaner<T>): Cleaner<{ [k in K]: T }> => {


asKey not used

paullinator · 2024-10-28T23:29:22Z

src/plugins/gui/providers/ProviderSupportStore.ts

+ * @param query A query string used to search for nested nodes (e.g. 'US:CA', 'US:*', '*', etc)
+ * @returns an array of nodes that match the query
+ */
+function queryNodes(nodes: InternalTree[], query: string): InternalTree[] {


Optional: This routine should have some unit tests. That would've made it easier to review as well.

paullinator · 2024-10-28T23:31:50Z

src/plugins/gui/providers/ProviderSupportStore.ts

+    }
+  }
+
+  for (const tree of nodes) {


tree should be node like the 1st for loop

paullinator · 2024-10-28T23:42:48Z

src/__tests__/utils/ProviderSupportStore.test.ts

+        'US:CA': true,
+        UK: true,
+        '*': {
+          'iso:USD': true,


Maybe the queryGroup separator shouldn't be : since that's used for fiat currencies

So long as we never have a "iso" entry, then "iso:USD" is treated the same as "isoUSD". The only difference is that you could query against "iso:*" or "iso". We could consider using another delimiter to group, but : matches the same character in JSON which makes it a nice grouping character. We could keep the group character as : and require that plugins use _ instead, so they'd add iso_USD.

paullinator · 2024-10-29T00:09:16Z

src/__tests__/utils/ProviderSupportStore.test.ts

+              'bitcoin:null': true
+            }
+          }
+        }


Need a test for conflicting values. ie

{ "*": { "US": true }, "buy": { "US": false }, "sell": { "US": false } }

or

{ "*": { "US": false, "US:": true } }

what should the API return in these cases. are we order dependent?

Better to just not allow false since only fromJson would allow that to happen, not the normal api. see comments below

The motivation to having false: ability to disable entries in the info server temporarily. But this is a moot case since there is no way to disable an entire object structure without removing it. So this "feature" is only applicable to leaf nodes. I no longer think the benefit for this feature is worth the tradeoff in ambiguity, so I'll remove false from the data type.

paullinator · 2024-10-29T00:58:33Z

src/plugins/gui/providers/ProviderSupportStore.ts

+// The JSON-serializable object structure for the provider support tree
+type ProviderSupportObject = {
+  [direction in DirectionKey]:
+    | boolean


should be | true since it can never really be false

paullinator · 2024-10-29T01:00:26Z

src/util/cleaners.ts

+  }
+}
+
+export const asObjectInOrBoolean = <K extends string | number | symbol, T>(asKey: Cleaner<K>, asT: Cleaner<T>) => asEither(asObjectIn(asKey, asT), asBoolean)


Really you want asObjectInOrTrue since you can't create a false entry using the API anyway

paullinator · 2024-10-29T01:08:46Z

src/plugins/gui/providers/ProviderSupportStore.ts

+      for (const fiatKey of fiatNode.keys()) {
+        if (fiatKey === '*') continue
+        // Add fiat to fiat map:
+        fiatProviderAssetMap.fiat[fiatKey] = true


The fiat values aren't filtered by the payment types

paullinator · 2024-10-29T01:17:55Z