Parity for ION Tools #318

decentralgabe · 2023-03-23T00:54:27Z

full parity with https://github.com/decentralized-identity/ion-tools

codecov-commenter · 2023-03-23T03:45:49Z

Codecov Report

Merging #318 (3da705c) into main (721d0e4) will decrease coverage by 0.44%.
The diff coverage is 52.89%.

@@            Coverage Diff             @@
##             main     #318      +/-   ##
==========================================
- Coverage   57.46%   57.02%   -0.44%     
==========================================
  Files          50       51       +1     
  Lines        5867     6110     +243     
==========================================
+ Hits         3371     3484     +113     
- Misses       1869     1970     +101     
- Partials      627      656      +29

Impacted Files	Coverage Δ
crypto/jwk.go	`42.78% <0.00%> (-1.51%)`	⬇️
did/ion/model.go	`62.96% <20.00%> (-25.27%)`	⬇️
did/ion/did.go	`42.31% <43.75%> (-3.69%)`	⬇️
did/resolver.go	`60.98% <46.15%> (-6.88%)`	⬇️
did/ion/operations.go	`48.74% <48.74%> (ø)`
did/web.go	`70.34% <57.14%> (+2.54%)`	⬆️
did/ion/request.go	`62.15% <76.19%> (+1.09%)`	⬆️

michaelneale · 2023-03-23T22:45:07Z

very nice

andresuribe87 · 2023-03-24T13:29:48Z

did/ion/did.go

+}
+
+// GetShortFormDIDFromLongFormDID returns the short form DID from a long form DID
+func GetShortFormDIDFromLongFormDID(longFormDID string) (string, error) {


Suggested change

func GetShortFormDIDFromLongFormDID(longFormDID string) (string, error) {

func LongToShortFormDID(longFormDID string) (string, error) {

andresuribe87 · 2023-03-24T13:31:38Z

did/ion/did.go

+	return strings.Join([]string{"did", did.IONMethod.String(), hash}, ":"), nil
+}
+
+// GetShortFormDIDFromLongFormDID returns the short form DID from a long form DID


A unit test for this would be nice.

andresuribe87 · 2023-03-24T13:34:14Z

did/ion/operations.go

+}
+
+type Resolver struct {
+	baseURL string


Would suggest typing this, as you're already parsing it.

Suggested change

baseURL string

baseURL url.URL

andresuribe87 · 2023-03-24T13:35:07Z

did/ion/operations.go

+// and similarly for submitting anchor operations to the ION node...
+//
+//	https://ion.tbd.network/operations
+func NewIONResolver(baseURL string) (*Resolver, error) {


I think it's important to force HTTPS for the URL.

andresuribe87 · 2023-03-24T13:43:28Z

did/ion/operations.go

+	if i.baseURL == "" {
+		return nil, errors.New("resolver URL is empty")
+	}
+	resp, err := http.Get(strings.Join([]string{i.baseURL, "identifiers", id}, "/"))


We should expose a way for SDK users to provide their own http.Client and the context.Context they want to use for the request. The first allows for users to do their own telemetry and metric measurements. The second allows for termination signal and user configured deadlines.

See https://github.com/TBD54566975/ssi-service/blob/4936f10da0bae4b1606f5b2362c32bb6eb02e170/pkg/service/did/resolve/universal.go#L28 for how you could do both.

good idea - done

andresuribe87 · 2023-03-24T14:14:03Z

did/ion/operations.go

+	if err != nil {
+		return errors.Wrapf(err, "marshaling anchor operation %+v", op)
+	}
+	resp, err := http.Post(strings.Join([]string{i.baseURL, "operations"}, "/"), "application/json", bytes.NewReader(jsonOpBytes))


Same comments as previously noted.

andresuribe87 · 2023-03-24T14:15:09Z

did/ion/operations.go

+
+// Anchor submits an anchor operation to the ION node by appending the operations path to the base URL
+// and making a POST request
+func (i Resolver) Anchor(op AnchorOperation) error {


A top level package example on how to use this package would be awesome. Something super simple like: here's how you create an ION did:

NewIONDID() Anchor()

andresuribe87 · 2023-03-24T14:18:10Z

did/resolver.go

+// ParseDIDResolution attempts to parse a DID Resolution Result or a DID Document
+func ParseDIDResolution(resolvedDID []byte) (*DIDResolutionResult, error) {
+	// first try to parse as a DID Resolution Result
+	var result DIDResolutionResult


Note that DIDResolutionResult does not have json tags in the struct. I had to add them in https://github.com/TBD54566975/ssi-service/blob/4936f10da0bae4b1606f5b2362c32bb6eb02e170/pkg/service/did/resolve/universal.go#L55

andresuribe87 · 2023-03-24T14:18:26Z

did/resolver.go

@@ -64,3 +65,23 @@ func GetMethodForDID(did string) (Method, error) {
 	}
 	return Method(split[1]), nil
 }
+
+// ParseDIDResolution attempts to parse a DID Resolution Result or a DID Document
+func ParseDIDResolution(resolvedDID []byte) (*DIDResolutionResult, error) {


Mind adding a test for this function?

andresuribe87 · 2023-03-24T14:20:11Z

did/web.go

+	didWeb := DIDWeb(did)
+	doc, err := didWeb.Resolve()
+	if err != nil {
+		return nil, errors.Wrapf(err, "could not resolve did:web DID: %s", did)


Suggested change

return nil, errors.Wrapf(err, "could not resolve did:web DID: %s", did)

return nil, errors.Wrapf(err, "resolving did:web DID: %s", did)

decentralgabe · 2023-03-24T17:46:49Z

thanks for the thorough review @andresuribe87 ; should have addressed all

andresuribe87 · 2023-03-27T17:40:02Z

did/model.go

 // TODO(gabe) enforce validation of DID syntax https://www.w3.org/TR/did-core/#did-syntax
-type DIDDocument struct {
+type Document struct {


This will break backwards compatibility on ssi-service. Was this change intentional?

yeah i think it's a simpler name given the package is did I can do the uptake - that ok?

gabe added 2 commits March 22, 2023 16:29

simple resolver

2e089dc

temp

565d882

decentralgabe requested review from nitro-neal and andresuribe87 as code owners March 23, 2023 00:54

decentralgabe and others added 6 commits March 22, 2023 17:54

Merge branch 'main' into parity-for-ion-tools-in-go-ose-529

ad9581c

update

7ba200d

merge

c48e555

add back

8ed5723

rebase

c10406d

bad refactors

54ee3eb

decentralgabe marked this pull request as draft March 23, 2023 03:45

gabe and others added 6 commits March 23, 2023 13:20

recover op

074e2eb

deactivate request

d3ef617

tests

abe2f16

tests

3bac364

lint

fbfa275

Merge branch 'main' into parity-for-ion-tools-in-go-ose-529

3da705c

decentralgabe marked this pull request as ready for review March 23, 2023 22:30

decentralgabe changed the title ~~Parity for ion tools in go ose 529~~ Parity for ION Tools Mar 23, 2023

andresuribe87 reviewed Mar 24, 2023

View reviewed changes

gabe added 2 commits March 24, 2023 10:39

pr comments

18cb40b

add package doc

3ae1c91

This was referenced Mar 24, 2023

ION Reads & Writes TBD54566975/ssi-service#340

Closed

did:ion support #30

Closed

andresuribe87 approved these changes Mar 27, 2023

View reviewed changes

Merge branch 'main' into parity-for-ion-tools-in-go-ose-529

cde9f55

decentralgabe added this to the BTC Miami milestone Mar 27, 2023

decentralgabe merged commit a55dfe2 into main Mar 27, 2023

decentralgabe deleted the parity-for-ion-tools-in-go-ose-529 branch March 27, 2023 19:09

decentralgabe self-assigned this Mar 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Parity for ION Tools #318

Parity for ION Tools #318

decentralgabe commented Mar 23, 2023 •

edited

Loading

codecov-commenter commented Mar 23, 2023 •

edited

Loading

michaelneale commented Mar 23, 2023

andresuribe87 Mar 24, 2023

andresuribe87 Mar 24, 2023

andresuribe87 Mar 24, 2023

andresuribe87 Mar 24, 2023

andresuribe87 Mar 24, 2023

decentralgabe Mar 24, 2023

andresuribe87 Mar 24, 2023

andresuribe87 Mar 24, 2023

decentralgabe Mar 24, 2023

andresuribe87 Mar 24, 2023

decentralgabe Mar 24, 2023

andresuribe87 Mar 24, 2023

decentralgabe Mar 24, 2023

andresuribe87 Mar 24, 2023

decentralgabe commented Mar 24, 2023

andresuribe87 Mar 27, 2023

decentralgabe Mar 27, 2023

	func GetShortFormDIDFromLongFormDID(longFormDID string) (string, error) {
	func LongToShortFormDID(longFormDID string) (string, error) {

	return nil, errors.Wrapf(err, "could not resolve did:web DID: %s", did)
	return nil, errors.Wrapf(err, "resolving did:web DID: %s", did)

Parity for ION Tools #318

Parity for ION Tools #318

Conversation

decentralgabe commented Mar 23, 2023 • edited Loading

codecov-commenter commented Mar 23, 2023 • edited Loading

Codecov Report

michaelneale commented Mar 23, 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

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 Mar 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

decentralgabe commented Mar 23, 2023 •

edited

Loading

codecov-commenter commented Mar 23, 2023 •

edited

Loading