Merge pull request #166 from rolsonquadras/update-TODO

docs: Add github issues to TODOs

cmd/wallet-sdk-gomobile/credential/memstorage.go

@@ -27,7 +27,8 @@ type DB struct {
 
 // NewInMemoryDB returns a new in-memory credential DB.
 // It uses a network-based JSON-LD document loader.
-// TODO: Support custom document loaders so that contexts can be preloaded.
+// TODO: https://github.com/trustbloc/wallet-sdk/issues/160 Support custom document
+// loaders so that contexts can be preloaded.
 func NewInMemoryDB() *DB {
 	return &DB{
 		goAPIProvider:  goapimemstorage.NewProvider(),

demo/app/README.md

@@ -1,6 +1,9 @@
 # Demo/Reference App
 
-TODO: Add introduction
+The TrustBloc Demo app demonstrates the wallet-sdk API usage. At a high level, the app uses the following APIs.
+- Create a Decentralized Identifier (DID) API
+- OpenID4CI Issuance APIs
+- OpenID4VP Presentation APIs 
 
 ## Getting Started
 

pkg/common/jwt_signer.go

@@ -69,7 +69,7 @@ func getSignAlgorithmForVerificationMethod(vm *models.VerificationMethod) (strin
 	}
 
 	if vm.Type == JSONWebKey2020 && vm.Key.JSONWebKey != nil {
-		// TODO: handle more key types
+		// TODO: https://github.com/trustbloc/wallet-sdk/issues/161 handle more key types
 		if vm.Key.JSONWebKey.Crv == "Ed25519" {
 			return EdDSA, nil
 		}

pkg/credentialquery/credentialquery.go

@@ -76,7 +76,7 @@ func (c *Instance) Query(
 		}
 	}
 
-	// TODO: remove this code after to re enable Schema check.
+	// TODO: https://github.com/trustbloc/wallet-sdk/issues/165 remove this code after to re enable Schema check.
 	for i := range query.InputDescriptors {
 		query.InputDescriptors[i].Schema = nil
 	}

pkg/did/creator/creator.go

@@ -137,7 +137,8 @@ func (d *Creator) createDIDIonLongFormDoc(createDIDOpts *api.CreateDIDOpts) (*di
 		err              error
 	)
 
-	// TODO: refactor so more code is shared between handlers for different did methods
+	// TODO: https://github.com/trustbloc/wallet-sdk/issues/162 refactor so more code is
+	// shared between handlers for different did methods
 	if d.keyReader == nil { // Generate a key and set the verification type on behalf of the caller.
 		keyID, key, err = d.keyWriter.Create(arieskms.ED25519Type)
 		if err != nil {

pkg/internal/issuermetadata/issuermetadata.go

@@ -21,8 +21,7 @@ import (
 func Get(issuerURI string) (*issuer.Metadata, error) {
 	metadataEndpoint := issuerURI + "/.well-known/openid-configuration"
 
-	// TODO: Implement trusted list type of mechanism? The gosec warning (correctly) warns about using a variable URL.
-	response, err := http.Get(metadataEndpoint) //nolint: noctx,gosec // TODO: To be re-evaluated later
+	response, err := http.Get(metadataEndpoint) //nolint: noctx,gosec
 	if err != nil {
 		return nil, err
 	}

pkg/localkms/localkms.go

@@ -53,7 +53,8 @@ func NewLocalKMS(cfg *Config) (*LocalKMS, error) {
 // Create creates a keyset of the given keyType and then writes it to storage.
 // The keyID and raw public key bytes of the newly generated keyset are returned.
 func (k *LocalKMS) Create(keyType arieskms.KeyType) (string, []byte, error) {
-	// TODO: for keys that support afgo JWK, return afgo JWK
+	// TODO: https://github.com/trustbloc/wallet-sdk/issues/164 for keys that
+	// support afgo JWK, return afgo JWK
 	return k.ariesLocalKMS.CreateAndExportPubKeyBytes(keyType)
 }
 

pkg/openid4ci/clientconfig.go

@@ -26,7 +26,7 @@ func (d *didResolverWrapper) Resolve(did string, _ ...vdr.DIDMethodOption) (*did
 }
 
 // ClientConfig contains the various required parameters for an OpenID4CI Interaction.
-// TODO: refactor to instead require a key ID and a signer.
+// TODO: https://github.com/trustbloc/wallet-sdk/issues/163 refactor to instead require a key ID and a signer.
 type ClientConfig struct {
 	UserDID        string
 	ClientID       string

pkg/openid4ci/openid4ci.go

@@ -181,8 +181,7 @@ func (i *Interaction) ResolveDisplay(preferredLocale string) (*credentialschema.
 }
 
 func (i *Interaction) getTokenResponse(tokenEndpointURL string, params url.Values) (*tokenResponse, error) {
-	// TODO: Implement trusted list type of mechanism? The gosec warning (correctly) warns about using a variable URL.
-	response, err := http.Post(tokenEndpointURL, //nolint: noctx,gosec // TODO: To be re-evaluated later
+	response, err := http.Post(tokenEndpointURL, //nolint: noctx,gosec
 		"application/x-www-form-urlencoded", strings.NewReader(params.Encode()))
 	if err != nil {
 		return nil, err
@@ -223,7 +222,7 @@ func (i *Interaction) getCredentialResponse(credentialType, credentialEndpoint,
 		Format: "jwt_vc",
 		DID:    i.userDID,
 		Proof: proof{
-			ProofType: "jwt", // TODO: support other proof types
+			ProofType: "jwt", // TODO: https://github.com/trustbloc/wallet-sdk/issues/159 support other proof types
 			JWT:       jwt,
 		},
 	}
@@ -233,7 +232,7 @@ func (i *Interaction) getCredentialResponse(credentialType, credentialEndpoint,
 		return nil, err
 	}
 
-	request, err := http.NewRequest(http.MethodPost, //nolint: noctx // TODO: To be re-evaluated later
+	request, err := http.NewRequest(http.MethodPost, //nolint: noctx
 		credentialEndpoint, bytes.NewReader(credentialReqBytes))
 	if err != nil {
 		return nil, err

pkg/openid4vp/openid4vp.go

@@ -191,8 +191,8 @@ func createAuthorizedResponse(
 	did := kidParts[0]
 	presentationSubmission := presentation.CustomFields["presentation_submission"]
 
-	// TODO The following code adds jwt format along with nestedPath for vc. Remove these
-	// changes once AFG PEx has this support.
+	// TODO https://github.com/trustbloc/wallet-sdk/issues/158 The following code adds jwt format
+	// along with nestedPath for vc. Remove these changes once AFG PEx has this support.
 	presSubBytes, err := json.Marshal(presentationSubmission)
 	if err != nil {
 		return nil, fmt.Errorf("marshal pb error: %w", err)