Go Mobile support for DID Key #457

decentralgabe · 2023-08-29T20:31:56Z

No description provided.

codecov-commenter · 2023-08-30T18:34:23Z

Codecov Report

Merging #457 (fd002fd) into main (1b69542) will decrease coverage by 0.19%.
The diff coverage is 50.98%.

@@            Coverage Diff             @@
##             main     #457      +/-   ##
==========================================
- Coverage   57.42%   57.23%   -0.19%     
==========================================
  Files          67       67              
  Lines        7499     7494       -5     
==========================================
- Hits         4306     4289      -17     
- Misses       2456     2468      +12     
  Partials      737      737

Files Changed	Coverage Δ
did/util.go	`31.63% <0.00%> (-0.15%)`	⬇️
crypto/keys.go	`74.83% <42.11%> (-4.65%)`	⬇️
crypto/jwx/jwt.go	`54.63% <88.89%> (+1.84%)`	⬆️
crypto/jwx/jwk.go	`56.24% <100.00%> (ø)`
did/key/key.go	`70.52% <100.00%> (ø)`

decentralgabe · 2023-08-30T18:38:53Z

CodeQL will be broken until the authors update it to support go1.21, should not block merge

andresuribe87 · 2023-08-30T19:41:35Z

crypto/keys.go

+	ECDSAMarshalCompressed   = Option{Name: "ecdsa-compressed", Value: true}
+	ECDSAUnmarshalCompressed = Option{Name: "ecdsa-compressed", Value: true}


The value of both options is the same. Is that intentional?

yes, one used for marshaling one for unmarshaling

I could condense to a ECDSACompressed option

I generally discourage using an Option type which has a field named Name. It's bypasses the type system, and makes it easy to shoot yourself in the foot.

I would suggest using an enum es below:

const ( ECDSAMarshalCompressed int = iota ECDSAUnmarshalCompressed )

andresuribe87 · 2023-08-30T19:43:36Z

mobile/did_key.go

The methods in here aren't tested. I think we should have some sample code that exercises it. It can act as documentation as well on how it should be called.

agree will add tests

andresuribe87 · 2023-08-30T19:44:23Z

magefile.go

+
+// IOS Generates the iOS packages
+// Note: this command also installs "gomobile" if not present
+func IOS() error {


Should this target, as well as the Android target, be documented in a README?

yes good call

decentralgabe · 2023-08-31T13:38:09Z

tests added, comments made, bugs fixed. should be good to go

andresuribe87

Non-blocking comments.

andresuribe87 · 2023-08-31T16:29:33Z

mobile/README.md

+
+## Android
+
+```


I think it's important to cover:

Documentation on how to include this in an android/ios project, with a simple example.

CI that exercises actual Android/ios code so we can be confident this works.

Guidance to readers that tells them how to discover available functionality within the SDK.

Of course, that's a lot of scope for this PR, so tracking in separate issues is cool. But I think this is critically important.

will do a mix of now and new issues

andresuribe87 · 2023-08-31T16:34:05Z

mobile/did_key.go

+type GenerateDIDKeyResult struct {
+	DID string         `json:"did"`
+	JWK map[string]any `json:"jwk"`
+}


godocs for all fields here. This should be treated this as a public API

andresuribe87 · 2023-08-31T16:34:26Z

mobile/did_key.go

+}
+
+// GenerateDIDKey generates a new DID key and returns a JSON representation of GenerateDIDKeyResult
+func GenerateDIDKey(kt string) ([]byte, error) {


Can you include the possible kt values in the godoc?

I'll add that the values are the result of the GetSupportedDIDKeyTypes

andresuribe87 · 2023-08-31T16:34:37Z

mobile/did_key.go

+type CreateDIDKeyRequest struct {
+	KeyType      string         `json:"keyType"`
+	PublicKeyJWK map[string]any `json:"publicKeyJwk"`
+}


godocs for all types here.

andresuribe87 · 2023-08-31T16:36:37Z

mobile/did_key.go

+type CreateDIDKeyResult struct {
+	DID string `json:"did"`
+}


godocs, hopefully with an example. Something like

// DID that was created. E.g. `did:key:zHjkdjd...`

andresuribe87 · 2023-08-31T16:37:20Z

mobile/did_key.go

+}
+
+type Document struct {
+	DIDDocument map[string]any `json:"didDocument"`


You know what I want :)

andresuribe87 · 2023-08-31T16:37:52Z

mobile/did_key.go

+
+// CreateDIDKey creates a new DID key from an existing public key, accepting a JSON representation of CreateDIDKeyRequest
+// and returns a JSON representation of CreateDIDKeyResult which contains the DID of the newly created key as a string
+func CreateDIDKey(requestBytes []byte) ([]byte, error) {


Let's make it easy for clients to understand what they should put into requestBytes: can we type this?

I mention CreateDIDKeyRequest here - is there a way I can make it clearer?

It's tough to say, because I don't know how a mobile dev would interact with this. I'm of the opinion that a worthy goal is to have mobile devs not have to read any go code at all.

So I ask myself, as a mobile dev, do I know what I should put in here? I think the current answer is probably not. I would make a suggestion if I understood better how calling from Java/Kotlin, Swift would look like.

I think go docs are the best we can realistically do...if they don't read the API docs they'll always be lost

How about having the type of the parameter this function accepts be CreateDIDKeyRequest? According to the documentation, structs are allowed.

It feels like it's a bit easier to deal with a typed object in Kotlin / Swift.

I was hoping that documentation gets automatically translated into the artifact that's created (the AAR or the Obj-C lib), but it unfortunately doesn't look like that's the case. That's unfortunate :(
To mitigate, I would say adding an example in the target language that demonstrates how to call this function would be great.

will take this in a follow up - but after seeing what the feedback is from mobile devs

decentralgabe added 3 commits August 29, 2023 15:12

mobile

6adc743

mobile

cbf990d

move

02f1d5a

decentralgabe requested review from nitro-neal and andresuribe87 as code owners August 29, 2023 20:31

handle compressed keys properly

ad95bb9

decentralgabe added 3 commits August 30, 2023 11:46

Merge branch 'main' into mobile

b5de063

Merge branch 'main' into mobile

5dcc770

Merge branch 'main' into mobile

b67b4c4

andresuribe87 reviewed Aug 30, 2023

View reviewed changes

decentralgabe added 2 commits August 30, 2023 15:50

pr comments

54f5be8

add tests

7d94143

Merge branch 'main' into mobile

fd002fd

andresuribe87 approved these changes Aug 31, 2023

View reviewed changes

This was referenced Aug 31, 2023

Improve Go Mobile Docs #459

Open

Consider different Go Mobile interface #460

Open

comments and tests

8d1e16d

decentralgabe merged commit 7522c30 into main Aug 31, 2023
4 of 5 checks passed

decentralgabe deleted the mobile branch August 31, 2023 20:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Go Mobile support for DID Key #457

Go Mobile support for DID Key #457

decentralgabe commented Aug 29, 2023

codecov-commenter commented Aug 30, 2023 •

edited

decentralgabe commented Aug 30, 2023

andresuribe87 Aug 30, 2023

decentralgabe Aug 30, 2023

andresuribe87 Aug 30, 2023

decentralgabe Aug 31, 2023

andresuribe87 Aug 30, 2023

decentralgabe Aug 30, 2023

andresuribe87 Aug 30, 2023

decentralgabe Aug 30, 2023

decentralgabe commented Aug 31, 2023

andresuribe87 left a comment

andresuribe87 Aug 31, 2023

decentralgabe Aug 31, 2023

decentralgabe Aug 31, 2023

andresuribe87 Aug 31, 2023

andresuribe87 Aug 31, 2023

decentralgabe Aug 31, 2023

andresuribe87 Aug 31, 2023

andresuribe87 Aug 31, 2023

andresuribe87 Aug 31, 2023

andresuribe87 Aug 31, 2023

decentralgabe Aug 31, 2023

andresuribe87 Aug 31, 2023

decentralgabe Aug 31, 2023

andresuribe87 Aug 31, 2023

decentralgabe Aug 31, 2023 •

edited

		ECDSAMarshalCompressed = Option{Name: "ecdsa-compressed", Value: true}
		ECDSAUnmarshalCompressed = Option{Name: "ecdsa-compressed", Value: true}


		## Android

		```

Go Mobile support for DID Key #457

Go Mobile support for DID Key #457

Conversation

decentralgabe commented Aug 29, 2023

codecov-commenter commented Aug 30, 2023 • edited

Codecov Report

decentralgabe commented Aug 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

decentralgabe commented Aug 31, 2023

andresuribe87 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

decentralgabe Aug 31, 2023 • edited

Choose a reason for hiding this comment

codecov-commenter commented Aug 30, 2023 •

edited

decentralgabe Aug 31, 2023 •

edited