refactor!: update sdk surface (#893)

* docs: update outdated docstrings

* refactor!: drop export of signAndSubmitTx

* docs: provide link to JSON Pointer RFC

Author: rflechtner

packages/credentials/src/holder.ts

@@ -55,10 +55,10 @@ function pointerToAttributeName(
  * @param credential A Verifiable Credential containing a proof.
  * @param proofOptions Options for creating the derived proof.
  * @param proofOptions.disclose Allows selecting which claims/attributes in the credential should be disclosed, hiding others.
- * @param proofOptions.disclose.only An array of credentialPath expressions selecting attributes to be disclosed.
+ * @param proofOptions.disclose.only An array of {@link https://www.rfc-editor.org/info/rfc6901 JSON Pointer} expressions selecting attributes to be disclosed.
  * All other (non-mandatory) attributes that can be hidden will be hidden.
  * Takes precedence over `allBut`.
- * @param proofOptions.disclose.allBut An array of credentialPath expressions selecting attributes to be hidden.
+ * @param proofOptions.disclose.allBut An array of {@link https://www.rfc-editor.org/info/rfc6901 JSON Pointer} expressions selecting attributes to be hidden.
  * This means that all other properties are being revealed.
  * Selecting mandatory properties will result in an error.
  * It is ignored if `only` is set.
@@ -121,7 +121,7 @@ export async function deriveProof(
  * @param credentials Array of one or more Verifiable Credentials to be included in the presentation.
  * @param holder Interfaces for interacting with the holder identity for the purpose of generating a presentation proof.
  * @param holder.did The Decentralized Identifier (DID) of the holder.
- * @param holder.didDocument The DID Document of the holder. If omitted, the holder DID will be resolved internally to retrieve the document.
+ * @param holder.didDocument The DID Document of the holder.
  * @param holder.signers An array of signer interfaces, each allowing to request signatures made with a key associated with the holder DID Document.
  * The function will select the first signer that matches requirements around signature algorithm and relationship of the key to the DID as given by the DID Document.
  * @param presentationOptions Object holding optional arguments for scoping the presentation.

packages/credentials/src/issuer.ts

@@ -11,7 +11,8 @@ import { SDKErrors } from '@kiltprotocol/utils'
 import { KiltAttestationProofV1, KiltCredentialV1 } from './V1/index.js'
 import type { UnsignedVc, VerifiableCredential } from './V1/types.js'
 import type { CTypeLoader } from './ctype/index.js'
-import type { IssuerOptions } from './interfaces.js'
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { IssuerOptions, SubmitOverride } from './interfaces.js'
 
 export type { IssuerOptions }
 
@@ -91,15 +92,14 @@ export async function createCredential({
  *
  * @param credential A credential document as returned by {@link createCredential}.
  * @param issuer Interfaces for interacting with the issuer identity for the purpose of generating a proof.
- * @param issuer.did The Decentralized Identifier (DID) of the issuer.
- * @param issuer.didDocument The DID Document of the issuer. If omitted, the issuer DID will be resolved internally to retrieve the document.
+ * @param issuer.didDocument The DID Document of the issuer.
  * @param issuer.signers An array of signer interfaces, each allowing to request signatures made with a key associated with the issuer DID Document.
  * The function will select the first signer that matches requirements around signature algorithm and relationship of the key to the DID as given by the DID Document.
- * @param issuer.submitterAccount Some proof types require making transactions to effect state changes on the KILT blockchain.
+ * @param issuer.submitter Some proof types require making transactions to effect state changes on the KILT blockchain.
  * The blockchain account whose address is specified here will be used to cover all transaction fees and deposits due for this operation.
  * As transactions to the blockchain need to be signed, `signers` is expected to contain a signer interface where the `id` matches this address.
- * @param issuer.authorizeTx Optional. Allows customizing the way state changes on the KILT blockchain are authorized with a signature made with one of the issuer's DID keys.
- * @param issuer.submitTx Optional. Allows customizing the way transactions are signed by the submitter account and submitted to the KILT blockchain.
+ *
+ * Alternatively, you can pass a {@link SubmitOverride} callback that takes care of Did-authorizing and submitting the transaction.
  * If you are using a service that helps you submit and pay for transactions, this is your point of integration to it.
  * @param proofOptions Options that control proof generation.
  * @param proofOptions.proofType The type of proof to be created.

packages/sdk-js/src/index.ts

@@ -12,16 +12,10 @@
 import { Holder, Issuer, Verifier } from '@kiltprotocol/credentials'
 import { ConfigService } from '@kiltprotocol/config'
 import { Signers } from '@kiltprotocol/utils'
-import {
-  connect,
-  disconnect,
-  init,
-  Blockchain,
-} from '@kiltprotocol/chain-helpers'
+import { connect, disconnect, init } from '@kiltprotocol/chain-helpers'
 import { resolver as DidResolver } from '@kiltprotocol/did'
 import * as DidHelpers from './DidHelpers/index.js'
 
-const { signAndSubmitTx } = Blockchain // TODO: maybe we don't even need that if we have the identity class
 const { getSignersForKeypair, generateKeypair } = Signers
 
 export {
@@ -34,7 +28,6 @@ export {
   Issuer,
   getSignersForKeypair,
   generateKeypair,
-  signAndSubmitTx,
   ConfigService,
   DidHelpers,
 }