Create a simplified kepler API. #35

cobward · 2022-03-14T14:40:53Z

Based on the API described here.

Todo:

Currently creates a new orbit each time. Once the orbit URI work is complete we can deterministically generate the orbit id and therefore will be able to connect to the same orbit from different dapps without needing to store anything client-side.
~~Discuss and come up with appropriate types for the response from the orbit methods (or is the fetch Response type sufficient?)~~ ~~Sam agreed on slack that the fetch Response is appropriate, and I believe Kelsey and Charles previously agreed on this type too.~~ See new design in the proposal above.
Refactor the codebase so that this is the only way to use the sdk. This can be done once the orbit URI and capability changes are done.

cobward · 2022-03-14T14:48:45Z

When working on this I realised it would be really nice if we could delegate the "create" capability to the session key, as then the user would only need to sign one SIWE message. Is this something that will be possible with the new cap subsystem @chunningham ?

krhoda · 2022-03-14T15:08:26Z

Curious about the change in target for the tsconfig, why did that need to change?

Also, this patch to the package.json like this would get all dependencies and devDependencies sorted properly:

From a299cbcddf4e50f310ce861d42288c3ef42b2670 Mon Sep 17 00:00:00 2001
From: K Rhoda <kelsey.rhoda@spruceid.com>
Date: Mon, 14 Mar 2022 09:04:15 -0600
Subject: [PATCH] Adds patch for minimal sdk deps

---
 package.json | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/package.json b/package.json
index bc859a9..73c4139 100644
--- a/package.json
+++ b/package.json
@@ -19,29 +19,29 @@
     "transform": {}
   },
   "devDependencies": {
-    "@airgap/beacon-sdk": "^2.2.3",
-    "@spruceid/didkit-wasm": "0.1.9",
-    "@spruceid/zcap-providers": "^0.1.1",
-    "@taquito/signer": "^8.1.1",
-    "@types/jest": "^26.0.22",
     "@types/mime-types": "^2.1.1",
     "@types/node": "^16.11.6",
-    "ethers": "^5.5.1",
-    "fetch-blob": "^2.1.2",
     "jest": "^26.6.3",
     "jest-localstorage-mock": "^2.4.9",
     "mime-types": "^2.1.33",
-    "siwe": "^0.1.4",
     "ts-jest": "^26.5.4",
     "ts-node": "^10.4.0",
     "typescript": "^4.2.3",
     "walkdir": "^0.4.1"
   },
   "dependencies": {
+    "@airgap/beacon-sdk": "^2.2.3",
+    "@spruceid/didkit-wasm": "0.1.9",
+    "@spruceid/zcap-providers": "^0.1.1",
+    "@taquito/signer": "^8.1.1",
+    "@types/jest": "^26.0.22",
     "cids": "^1.1.6",
     "cross-fetch": "^3.1.4",
+    "ethers": "^5.5.1",
+    "fetch-blob": "^2.1.2",
     "form-data": "^4.0.0",
     "multihashing-async": "^2.1.2",
-    "rfc4648": "^1.5.0"
+    "rfc4648": "^1.5.0",
+    "siwe": "^0.1.4"
   }
 }
--
2.35.1

cobward · 2022-03-14T17:11:02Z

@krhoda thanks for the patch. I think I changed the target when I was testing the behaviour of something async, but there's no reason for it to be ES2017 -- I'll revert

chunningham · 2022-03-15T11:40:04Z

it makes sense, no semantic or logical reason the peer permission can't be delegated alongside read and write

cobward · 2022-03-31T11:52:34Z

it makes sense, no semantic or logical reason the peer permission can't be delegated alongside read and write

FYI - when trying to do this I couldn't work out how to construct the invocation to contain the generated peer ID. In the SIWE authn, the peer id is stored in the URI field, but I couldn't work out what the analogue for that is in the zcap authn.

chunningham · 2022-03-31T12:05:56Z

bit of misleading code there, that message is actually a delegation, so the URI is the delegate/peer. in the zcap delegation the equivalent is invoker (but might soon change to controller)

chunningham

Looks good to me, although I would recommend we don't restrict the mime types when putting, as I think there's no reason we should prevent users from uploading any type they want and it doesn't make it easier to use. I much enjoyed seeing how much cleaner index.ts and other stuff is though

package.json

src/kepler.ts

src/orbit.ts

src/kepler.ts

src/util.ts

src/index.test.ts

cobward · 2022-03-31T17:30:15Z

I would recommend we don't restrict the mime types when putting, as I think there's no reason we should prevent users from uploading any type they want and it doesn't make it easier to use.

Spoke about this in the Kepler meeting. To clarify, the put function doesn't restrict mime types, it just only knows how to construct blobs for certain types:

If you do orbit.put(key, value, { type: "text/<text-type>"}), then the sdk will store a new Blob([value], {type: 'text/<text-type>'}).
If you do orbit.put(key, value, { type: "application/json"}), then the sdk will store a new Blob([JSON.serialize(value)], {type: 'application/json'}.
If you do orbit.put(key, value), and value.constructor.name === 'Blob', then the sdk will just store that blob.
Otherwise the sdk will error as it does not understand how to store the value you have provided.

This gives us the flexibility to support other types directly in the future, but for now users would need to construct a Blob themselves if they want to store something that isn't text or json.

An alternative would be to remove the type property from the request options, and instead provide 3 put functions, (i.e. putText, putJson, putBlob). IMO this would make the code simpler and more obvious at the expense of a slightly broader API, so if there is an appetite for that I would happily switch.

Another alternative would be to again remove the type property from the request options, and instead try and guess what type the value is. The best we could do is:

store values of type string as text/plain.
store values with value.constructor.name === 'Blob' directly.
try to json-serialise anything else and store it as application/json.

I'm not a massive fan of this since json-serialisation fails silently, so a user might not know that some of the data is lost because it could not be parsed. But it would give us a simple api (everything is orbit.put(key, value).

Opinions? @wyc @skgbafa @chunningham

cobward · 2022-03-31T17:51:16Z

For @skgbafa and anyone else who wants to test this, this branch is currently dependent on the fat_packaged version of didkit, which can be built by running this script:
https://github.com/spruceid/didkit/blob/feat/fat_bundle/lib/web/fat_bundle.sh

chunningham

mis-read the put mime-type logic, LGTM

package.json

Also fixed a bug where File's couldn't be put directly.

Also rename S3 to KV.

When testing building a test dapp I found some improvements that could be made to reduce polyfilling.

cobward · 2022-04-06T11:55:47Z

After more testing and discussions with Simon, we decided the best option would be to vendor the didkit fat pkg here until we figure out and resolve the async import issue.

skgbafa

Overall the PR looks great! Love the tsdoc. Only reviewed code, did not execute functions.
Some small js/stucture feedback
- Do we see more changes possible for config stuff? If so, setting up a global config pattern could be good. Not worth doing if we don't see much change
  - invHeaderStr
  - "https://kepler.test.spruceid.xyz:443"
- Add a linter? Maybe later. For collaboration reasons.
- Add .nvmrc. For collaboration reasons.
Deploy the docs to gh pages? Add a small script to do so? Maybe done by a gh action as part of a release process?

Not running tests yet since that will need us to spin up a Kepler instance. Will set that up once we're at a stable point (probably after the HTTP API changes).

cobward · 2022-04-08T11:10:50Z

Linter and .nvmrc added. Will address the publishing of the docs in a future PR.

cobward requested review from skgbafa and chunningham March 14, 2022 14:40

cobward and others added 7 commits March 23, 2022 11:37

Create a simplified kepler API.

cdeb036

Revert target to es5.

dc1a2e5

Adds patch for minimal sdk deps

51c774d

Add functional tests.

02ac08b

Rebase fixed and tests expanded.

5491c89

Fix and improve tests.

67fecb8

Update API to latest proposal.

5eed781

cobward force-pushed the feat/minimal-sdk branch from f27238d to 5eed781 Compare March 29, 2022 10:36

cobward added 2 commits March 31, 2022 12:05

Only expose the minimal API.

eb73112

Add test to show 1-1 mapping between wallets and orbits.

24f13bd

cobward marked this pull request as ready for review March 31, 2022 11:20

cobward requested a review from sbihel March 31, 2022 11:52

chunningham requested changes Mar 31, 2022

View reviewed changes

chunningham approved these changes Apr 1, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

cobward added 4 commits April 5, 2022 14:52

Add typedocs.

e732a7a

Also fixed a bug where File's couldn't be put directly.

Remove unused code and dependencies.

11a97a8

Also rename S3 to KV.

Vendor didkit.

374e237

Update README and improve devex.

62a6809

When testing building a test dapp I found some improvements that could be made to reduce polyfilling.

skgbafa reviewed Apr 7, 2022

View reviewed changes

skgbafa approved these changes Apr 7, 2022

View reviewed changes

Add CI.

fbda949

Not running tests yet since that will need us to spin up a Kepler instance. Will set that up once we're at a stable point (probably after the HTTP API changes).

cobward force-pushed the feat/minimal-sdk branch 2 times, most recently from ac6c81c to a38c628 Compare April 8, 2022 11:07

Fix nvm gha step.

9316858

cobward force-pushed the feat/minimal-sdk branch from a38c628 to 9316858 Compare April 8, 2022 11:08

cobward merged commit 25f13e7 into main Apr 8, 2022

cobward deleted the feat/minimal-sdk branch April 8, 2022 11:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a simplified kepler API. #35

Create a simplified kepler API. #35

cobward commented Mar 14, 2022 •

edited

cobward commented Mar 14, 2022

krhoda commented Mar 14, 2022

cobward commented Mar 14, 2022

chunningham commented Mar 15, 2022

cobward commented Mar 31, 2022

chunningham commented Mar 31, 2022

chunningham left a comment

cobward commented Mar 31, 2022 •

edited

cobward commented Mar 31, 2022

chunningham left a comment

cobward commented Apr 6, 2022

skgbafa left a comment

cobward commented Apr 8, 2022

Create a simplified kepler API. #35

Create a simplified kepler API. #35

Conversation

cobward commented Mar 14, 2022 • edited

cobward commented Mar 14, 2022

krhoda commented Mar 14, 2022

cobward commented Mar 14, 2022

chunningham commented Mar 15, 2022

cobward commented Mar 31, 2022

chunningham commented Mar 31, 2022

chunningham left a comment

Choose a reason for hiding this comment

cobward commented Mar 31, 2022 • edited

cobward commented Mar 31, 2022

chunningham left a comment

Choose a reason for hiding this comment

cobward commented Apr 6, 2022

skgbafa left a comment

Choose a reason for hiding this comment

cobward commented Apr 8, 2022

cobward commented Mar 14, 2022 •

edited

cobward commented Mar 31, 2022 •

edited