Skip to main content

Troubleshooting

The best source for sorting out problems is the IOTA Discord. Join the #iota-cloud-tools channel and ask your questions there. Additionally, the FAQ might have the answer to your problem. You can check if others are facing similar problems in the issues section in our repository.

Please make sure to have the latest version of the Integration Services installed and all other packages up to date.

Breaking Changes​

SSI-Bridge v0.1 -> v0.2​

With the release of the new version of the SSI-Bridge we upgrade to the latest identity.rs v0.6. The upgrade of the identity library brings many improvements, but there are also structural changes regarding how identities are stored in the tangle. This means you will not be able to read any identities created with the SSI-Bridge v0.1 using SSI-Bridge v0.2.

Create identity endpoint​

The latest update gives you the opportunity to create encryption keys for an identity and store the corresponding key within its document. That's why the response of the /api/v0.2/identities/create endpoint has been changed. In SSI-Bridge v0.1, the response has looked as follows:

{
  "doc": {
    "id": "did:iota:5tkMtbJYYs63etPWFh97gkM41qFdPMxY9ADLBfi6puSj",
    "authentication": [
      {
        "id": "did:iota:5tkMtbJYYs63etPWFh97gkM41qFdPMxY9ADLBfi6puSj#key",
        "controller": "did:iota:5tkMtbJYYs63etPWFh97gkM41qFdPMxY9ADLBfi6puSj",
        "type": "Ed25519VerificationKey2018",
        "publicKeyBase58": "H3NpEmBpHWXJXWVDao4zrnpP4X679qs9BhSxLfe3J2Hp"
      }
    ],
    "created": "2022-07-27T07:46:34Z",
    "updated": "2022-07-27T07:46:34Z",
    "proof": {
      "type": "JcsEd25519Signature2020",
      "verificationMethod": "#key",
      "signatureValue": "3Z9VX6mXByjxt7d2e45H1BxLmE1dB1n48wEiYe8q6TTuGoz8JX3jZn7jaYiQBnFybeD8iNBzaDaupCLxBuytXpLw"
    }
  },
  "key": {
    "type": "ed25519",
    "public": "H3NpEmBpHWXJXWVDao4zrnpP4X679qs9BhSxLfe3J2Hp",
    "secret": "2v8bgqPiR9U6SR9EZtjj5y4XXHDTQc5sHY45Kevupyz1",
    "encoding": "base58"
  }
}

For SSI-Bridge v0.2, the new response looks as follows:

{
  "id": "did:iota:AXGjMoXRDR36YrmnFyKwXtc3sj3q7FRkzqZwhn7i67a9",
  "keys": {
    "sign": {
      "public": "9M2itnCuw62vjrsiL7M4QLWa1B9C7BYb4sBSdumT2TKd",
      "private": "8sHKprAuiTQPE8heArxeGRQmmzyv3C1hhMGUf5QmPh2b",
      "type": "ed25519",
      "encoding": "base58"
    },
    "encrypt": {
      "public": "9M2itnCuw62vjrsiL7M4QLWa1B9C7BYb4sBSdumT2TKd",
      "private": "8sHKprAuiTQPE8heArxeGRQmmzyv3C1hhMGUf5QmPh2b",
      "type": "x25519",
      "encoding": "base58"
    }
  }
}

Notice that key was renamed as keys since we now have asymmetric encryption and a signature key. Instead of returning the whole document, only the created identity id is returned. You can still fetch the document using the /api/v0.2/verification/latest-document/<identity-id> endpoint. The secret key was renamed as private to be consistent with the new identity.rs framework. In addition, the data model of the identity document and verifiable credentials have been updated to the latest version. For authentication, consider using the key: keys.sign.private to sign the nonce. If you are using the @iota/is-client, this will be done automatically.