refactor: internal version of transact

packages/sdk-js/src/DidHelpers/deactivateDid.spec.ts

@@ -13,11 +13,11 @@ import {
 } from '../../../../tests/testUtils/index.js'
 import { ConfigService } from '../index.js'
 import { deactivateDid } from './deactivateDid.js'
-import { transact } from './transact.js'
+import { transactInternal } from './transact.js'
 
 jest.mock('./transact.js')
 
-const mockedTransact = jest.mocked(transact)
+const mockedTransact = jest.mocked(transactInternal)
 const mockedApi = ApiMocks.createAugmentedApi()
 
 describe('deactivate', () => {
@@ -50,8 +50,8 @@ describe('deactivate', () => {
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -64,7 +64,11 @@ describe('deactivate', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: { method: 'delete', section: 'did' },
     })
   })

packages/sdk-js/src/DidHelpers/deactivateDid.ts

@@ -6,7 +6,7 @@
  */
 
 import type { SharedArguments, TransactionHandlers } from './interfaces.js'
-import { transact } from './transact.js'
+import { transactInternal } from './transact.js'
 
 /**
  * _Permanently_ deactivates the DID, removing all verification methods and services from its document.
@@ -18,9 +18,10 @@ import { transact } from './transact.js'
  */
 export function deactivateDid(options: SharedArguments): TransactionHandlers {
   const { api, didDocument } = options
-  return transact({
+  return transactInternal({
     ...options,
-    call: api.tx.did.delete(didDocument.service?.length ?? 0),
+    callFactory: async () =>
+      api.tx.did.delete(didDocument.service?.length ?? 0),
     expectedEvents: [{ section: 'did', method: 'DidDeleted' }],
   })
 }

packages/sdk-js/src/DidHelpers/service.spec.ts

@@ -12,12 +12,12 @@ import {
   createLocalDemoFullDidFromKeypair,
 } from '../../../../tests/testUtils/index.js'
 import { ConfigService } from '../index.js'
-import { transact } from './index.js'
 import { addService, removeService } from './service.js'
+import { transactInternal } from './transact.js'
 
 jest.mock('./transact.js')
 
-const mockedTransact = jest.mocked(transact)
+const mockedTransact = jest.mocked(transactInternal)
 const mockedApi = ApiMocks.createAugmentedApi()
 
 describe.each(['#my_service', 'did:kilt:4abctest#my_service'])(
@@ -57,8 +57,10 @@ describe.each(['#my_service', 'did:kilt:4abctest#my_service'])(
       })
 
       expect(mockedTransact).toHaveBeenLastCalledWith(
-        expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-          call: expect.any(Object),
+        expect.objectContaining<
+          Partial<Parameters<typeof transactInternal>[0]>
+        >({
+          callFactory: expect.any(Function),
           expectedEvents: expect.arrayContaining([
             {
               section: 'did',
@@ -71,7 +73,11 @@ describe.each(['#my_service', 'did:kilt:4abctest#my_service'])(
           signers: [keypair],
         })
       )
-      expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+      expect(
+        await mockedTransact.mock.lastCall?.[0]
+          .callFactory()
+          .then((f) => f.toHuman())
+      ).toMatchObject({
         method: {
           args: {
             service_endpoint: {
@@ -96,8 +102,10 @@ describe.each(['#my_service', 'did:kilt:4abctest#my_service'])(
       })
 
       expect(mockedTransact).toHaveBeenLastCalledWith(
-        expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-          call: expect.any(Object),
+        expect.objectContaining<
+          Partial<Parameters<typeof transactInternal>[0]>
+        >({
+          callFactory: expect.any(Function),
           expectedEvents: expect.arrayContaining([
             {
               section: 'did',
@@ -110,7 +118,11 @@ describe.each(['#my_service', 'did:kilt:4abctest#my_service'])(
           signers: [keypair],
         })
       )
-      expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+      expect(
+        await mockedTransact.mock.lastCall?.[0]
+          .callFactory()
+          .then((f) => f.toHuman())
+      ).toMatchObject({
         method: {
           args: {
             service_id: 'my_service',

packages/sdk-js/src/DidHelpers/service.ts

@@ -8,7 +8,7 @@
 import { serviceToChain, urlFragmentToChain } from '@kiltprotocol/did'
 import type { DidUrl, Service, UriFragment } from '@kiltprotocol/types'
 import { SharedArguments, TransactionHandlers } from './interfaces.js'
-import { transact } from './transact.js'
+import { transactInternal } from './transact.js'
 
 /**
  * Adds a service to the DID Document.
@@ -23,12 +23,10 @@ export function addService(
     service: Service<DidUrl | UriFragment>
   }
 ): TransactionHandlers {
-  const didServiceUpdateTx = options.api.tx.did.addServiceEndpoint(
-    serviceToChain(options.service)
-  )
-  return transact({
+  return transactInternal({
     ...options,
-    call: didServiceUpdateTx,
+    callFactory: async () =>
+      options.api.tx.did.addServiceEndpoint(serviceToChain(options.service)),
     expectedEvents: [{ section: 'did', method: 'DidUpdated' }],
   })
 }
@@ -46,12 +44,10 @@ export function removeService(
     id: DidUrl | UriFragment
   }
 ): TransactionHandlers {
-  const didServiceUpdateTx = options.api.tx.did.removeServiceEndpoint(
-    urlFragmentToChain(options.id)
-  )
-  return transact({
+  return transactInternal({
     ...options,
-    call: didServiceUpdateTx,
+    callFactory: async () =>
+      options.api.tx.did.removeServiceEndpoint(urlFragmentToChain(options.id)),
     expectedEvents: [{ section: 'did', method: 'DidUpdated' }],
   })
 }

packages/sdk-js/src/DidHelpers/transact.spec.ts

@@ -5,18 +5,19 @@
  * found in the LICENSE file in the root directory of this source tree.
  */
 
-import { SubmittableResult } from '@polkadot/api'
 import { authorizeTx, resolver } from '@kiltprotocol/did'
 import type { DidDocument, KiltKeyringPair } from '@kiltprotocol/types'
 import { Crypto } from '@kiltprotocol/utils'
-import { ConfigService } from '../index.js'
+import { SubmittableResult } from '@polkadot/api'
+
 import {
   ApiMocks,
   createLocalDemoFullDidFromKeypair,
 } from '../../../../tests/testUtils/index.js'
-import { transact } from './index.js'
-import { TransactionResult } from './interfaces.js'
 import { makeAttestationCreatedEvents } from '../../../../tests/testUtils/testData.js'
+import { ConfigService } from '../index.js'
+import { TransactionResult } from './interfaces.js'
+import { transact } from './transact.js'
 
 jest.mock('@kiltprotocol/did', () => {
   return {

packages/sdk-js/src/DidHelpers/transact.ts

@@ -18,12 +18,12 @@ import type { SharedArguments, TransactionHandlers } from './interfaces.js'
  * Instructs a transaction (state transition) as this DID (with this DID as the origin).
  *
  * @param options Any {@link SharedArguments} and additional parameters.
- * @param options.call The transaction / call to execute.
+ * @param options.callFactory Async callback producing the transaction / call to execute.
  * @returns A set of {@link TransactionHandlers}.
  */
-export function transact(
+export function transactInternal(
   options: SharedArguments & {
-    call: Extrinsic | SubmittableExtrinsic
+    callFactory: () => Promise<Extrinsic | SubmittableExtrinsic>
     expectedEvents?: Array<{ section: string; method: string }>
   }
 ): TransactionHandlers {
@@ -35,9 +35,16 @@ export function transact(
         }
       | undefined = {}
   ) => {
-    const { didDocument, signers, submitter, call, api, expectedEvents } =
-      options
+    const {
+      didDocument,
+      signers,
+      submitter,
+      callFactory,
+      api,
+      expectedEvents,
+    } = options
     const { didNonce, signSubmittable = true } = submitOptions
+    const call = await callFactory()
     const didSigners = await signersForDid(didDocument, ...signers)
 
     const submitterAccount = (
@@ -75,3 +82,19 @@ export function transact(
     getSubmittable,
   }
 }
+
+/**
+ * Instructs a transaction (state transition) as this DID (with this DID as the origin).
+ *
+ * @param options Any {@link SharedArguments} and additional parameters.
+ * @param options.call The transaction / call to execute.
+ * @returns A set of {@link TransactionHandlers}.
+ */
+export function transact(
+  options: SharedArguments & {
+    call: Extrinsic | SubmittableExtrinsic
+    expectedEvents?: Array<{ section: string; method: string }>
+  }
+): TransactionHandlers {
+  return transactInternal({ ...options, callFactory: async () => options.call })
+}

packages/sdk-js/src/DidHelpers/verificationMethod.spec.ts

@@ -12,15 +12,15 @@ import {
   createLocalDemoFullDidFromKeypair,
 } from '../../../../tests/testUtils/index.js'
 import { ConfigService } from '../index.js'
+import { transactInternal } from './transact.js'
 import {
   removeVerificationMethod,
   setVerificationMethod,
 } from './verificationMethod.js'
-import { transact } from './transact.js'
 
 jest.mock('./transact.js')
 
-const mockedTransact = jest.mocked(transact)
+const mockedTransact = jest.mocked(transactInternal)
 const mockedApi = ApiMocks.createAugmentedApi()
 
 let didDocument: DidDocument
@@ -55,8 +55,8 @@ describe('signing keys', () => {
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -69,7 +69,11 @@ describe('signing keys', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: {
         section: 'did',
         method: 'setAttestationKey',
@@ -90,8 +94,8 @@ describe('signing keys', () => {
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -104,7 +108,11 @@ describe('signing keys', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: {
         section: 'did',
         method: 'removeAttestationKey',
@@ -120,13 +128,13 @@ describe('key agreement keys', () => {
       api: mockedApi,
       submitter: keypair,
       signers: [keypair],
-      publicKey: { publicKey: keypair.publicKey, type: 'x25519' } as any,
+      publicKey: { publicKey: keypair.publicKey, type: 'x25519' },
       relationship: 'keyAgreement',
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -139,7 +147,11 @@ describe('key agreement keys', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: {
         section: 'utility',
         method: 'batchAll',
@@ -165,13 +177,13 @@ describe('key agreement keys', () => {
       api: mockedApi,
       submitter: keypair,
       signers: [keypair],
-      publicKey: { publicKey: keypair.publicKey, type: 'x25519' } as any,
+      publicKey: { publicKey: keypair.publicKey, type: 'x25519' },
       relationship: 'keyAgreement',
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -184,7 +196,11 @@ describe('key agreement keys', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: {
         section: 'utility',
         method: 'batchAll',
@@ -217,8 +233,8 @@ describe('key agreement keys', () => {
     })
 
     expect(mockedTransact).toHaveBeenLastCalledWith(
-      expect.objectContaining<Partial<Parameters<typeof transact>[0]>>({
-        call: expect.any(Object),
+      expect.objectContaining<Partial<Parameters<typeof transactInternal>[0]>>({
+        callFactory: expect.any(Function),
         expectedEvents: expect.arrayContaining([
           {
             section: 'did',
@@ -231,7 +247,11 @@ describe('key agreement keys', () => {
         signers: [keypair],
       })
     )
-    expect(mockedTransact.mock.lastCall?.[0].call.toHuman()).toMatchObject({
+    expect(
+      await mockedTransact.mock.lastCall?.[0]
+        .callFactory()
+        .then((f) => f.toHuman())
+    ).toMatchObject({
       method: {
         section: 'did',
         method: 'removeKeyAgreementKey',