Merge pull request #61 from subspace/feat/improve-auto-utils

Improve auto utils

packages/auto-consensus/__test__/balances.test.ts

@@ -1,5 +1,5 @@
-import { address, balance, totalIssuance } from '@autonomys/auto-consensus'
-import { ActivateWalletInput, activateWallet, getMockWallet } from '@autonomys/auto-utils'
+import { balance, totalIssuance } from '@autonomys/auto-consensus'
+import { ActivateWalletInput, activateWallet, address, getMockWallet } from '@autonomys/auto-utils'
 import { setup } from './helpers'
 
 describe('Verify balances functions', () => {

packages/auto-consensus/__test__/helpers/staking.ts

@@ -1,4 +1,3 @@
-import type { ApiPromise } from '@polkadot/api'
 import { u8aToHex } from '@polkadot/util'
 import { operator, operators, RegisterOperatorInput } from '../../src/staking'
 

packages/auto-consensus/__test__/helpers/tx.ts

@@ -1,6 +1,5 @@
 import { Events, signAndSendTx as signAndSend } from '@autonomys/auto-consensus'
-import type { AddressOrPair, SubmittableExtrinsic } from '@polkadot/api/types'
-import type { ISubmittableResult } from '@polkadot/types/types'
+import type { AddressOrPair, ISubmittableResult, SubmittableExtrinsic } from '@autonomys/auto-utils'
 
 export const signAndSendTx = async (
   sender: AddressOrPair,

packages/auto-consensus/__test__/staking.test.ts

@@ -1,5 +1,4 @@
 import {
-  address,
   balance,
   deregisterOperator,
   events,
@@ -9,8 +8,13 @@ import {
   sudo,
   withdrawStake,
 } from '@autonomys/auto-consensus'
-import { ActivateWalletInput, activateWallet, getMockWallet } from '@autonomys/auto-utils'
-import { mnemonicGenerate } from '@polkadot/util-crypto'
+import {
+  ActivateWalletInput,
+  activateWallet,
+  address,
+  generateWallet,
+  getMockWallet,
+} from '@autonomys/auto-utils'
 import {
   setup,
   signAndSendTx,
@@ -26,10 +30,10 @@ describe('Verify staking functions', () => {
   if (isLocalhost) {
     describe('Test registerOperator()', () => {
       test('Check Alice can register random wallet as an operator', async () => {
-        const mnemonicOperator = mnemonicGenerate()
+        const { mnemonic } = generateWallet()
         const { accounts: operatorAccounts } = await activateWallet({
           ...TEST_NETWORK,
-          uri: mnemonicOperator,
+          mnemonic,
         } as ActivateWalletInput)
 
         const sender = alice.accounts[0]
@@ -87,10 +91,10 @@ describe('Verify staking functions', () => {
       }, 10000)
 
       test('Check Operator can addFunds after registration', async () => {
-        const mnemonicOperator = mnemonicGenerate()
+        const { mnemonic } = generateWallet()
         const { accounts: operatorAccounts } = await activateWallet({
           ...TEST_NETWORK,
-          uri: mnemonicOperator,
+          mnemonic,
         } as ActivateWalletInput)
 
         const sender = alice.accounts[0]
@@ -139,10 +143,10 @@ describe('Verify staking functions', () => {
 
     describe('Test deregisterOperator()', () => {
       test('Check Operator can deregisterOperator after registration', async () => {
-        const mnemonicOperator = mnemonicGenerate()
+        const { mnemonic } = generateWallet()
         const { accounts: operatorAccounts } = await activateWallet({
           ...TEST_NETWORK,
-          uri: mnemonicOperator,
+          mnemonic,
         } as ActivateWalletInput)
 
         const sender = alice.accounts[0]
@@ -181,7 +185,7 @@ describe('Verify staking functions', () => {
               api: alice.api,
               operatorId: findOperator.operatorId,
             }),
-            [events.operatorDeRegistered],
+            [events.operatorDeregistered],
           )
         }
       }, 60000)

packages/auto-consensus/__test__/transfer.test.ts

@@ -1,5 +1,5 @@
-import { address, balance, events, transfer } from '@autonomys/auto-consensus'
-import { getMockWallet } from '@autonomys/auto-utils'
+import { balance, events, transfer } from '@autonomys/auto-consensus'
+import { address, getMockWallet } from '@autonomys/auto-utils'
 import { setup, signAndSendTx } from './helpers'
 
 describe('Verify transfer functions', () => {

packages/auto-consensus/src/balances.ts

@@ -1,8 +1,7 @@
 // file: src/balances.ts
 
+import type { ApiPromise, BN } from '@autonomys/auto-utils'
 import { activate } from '@autonomys/auto-utils'
-import type { ApiPromise } from '@polkadot/api'
-import type { BN } from '@polkadot/util'
 
 type RawBalanceData = {
   free: BN

packages/auto-consensus/src/batch.ts

@@ -1,3 +1,3 @@
-import type { ApiPromise } from '@polkadot/api'
+import type { ApiPromise } from '@autonomys/auto-utils'
 
 export const batch = async (api: ApiPromise, txs: any[]) => await api.tx.utility.batch(txs)

packages/auto-consensus/src/index.ts

@@ -1,6 +1,5 @@
 // file: src/index.ts
 
-export * from './address'
 export * from './balances'
 export * from './batch'
 export * from './info'

packages/auto-consensus/src/remark.ts

@@ -1,4 +1,4 @@
-import type { ApiPromise } from '@polkadot/api'
+import type { ApiPromise } from '@autonomys/auto-utils'
 
 export const remark = async (api: ApiPromise, remark: string, withEvent?: boolean) =>
   !withEvent ? await api.tx.system.remark(remark) : await api.tx.system.remarkWithEvent(remark)

packages/auto-consensus/src/staking.ts

@@ -1,11 +1,9 @@
 // file: src/staking.ts
 
-import type { ApiPromise } from '@polkadot/api'
-import type { KeyringPair } from '@polkadot/keyring/types'
+import type { ApiPromise, KeyringPair } from '@autonomys/auto-utils'
+import { createAccountIdType, signingKey } from '@autonomys/auto-utils'
 import type { StorageKey } from '@polkadot/types'
-import { createType } from '@polkadot/types'
 import type { AnyTuple, Codec } from '@polkadot/types-codec/types'
-import { u8aToHex } from '@polkadot/util'
 
 type RawOperatorId = string[]
 type RawOperatorDetails = {
@@ -126,15 +124,14 @@ export const registerOperator = async (input: RegisterOperatorInput) => {
       nominationTax,
     } = input
 
-    const message = createType(api.registry, 'AccountId', senderAddress).toU8a()
-    const signingKey = u8aToHex(Operator.publicKey)
+    const message = createAccountIdType(api, senderAddress)
     const signature = Operator.sign(message)
 
     return await api.tx.domains.registerOperator(
       parseString(domainId),
       parseString(amountToStake),
       {
-        signingKey,
+        signingKey: signingKey(Operator.publicKey),
         minimumNominatorStake: parseString(minimumNominatorStake),
         nominationTax: parseString(nominationTax),
       },

packages/auto-consensus/src/transfer.ts

@@ -1,6 +1,6 @@
 // file: src/transfer.ts
 
-import type { ApiPromise } from '@polkadot/api'
+import type { ApiPromise } from '@autonomys/auto-utils'
 
 export type Amount = BigInt | number | string
 

packages/auto-consensus/src/utils/detectTxSuccess.ts

@@ -1,6 +1,6 @@
 // file: src/utils/detectTxSuccess.ts
 
-import type { EventRecord } from '@polkadot/types/interfaces'
+import type { EventRecord } from '@autonomys/auto-utils'
 import { expectSuccessfulTxEvent } from './events'
 
 export const detectTxSuccess = (events: EventRecord[]): boolean => {

packages/auto-consensus/src/utils/signAndSendTx.ts

@@ -1,7 +1,6 @@
 // file: src/utils/signAndSendTx.ts
 
-import type { AddressOrPair, SubmittableExtrinsic } from '@polkadot/api/types'
-import type { ISubmittableResult } from '@polkadot/types/types'
+import type { AddressOrPair, ISubmittableResult, SubmittableExtrinsic } from '@autonomys/auto-utils'
 import type { Events } from '../types/events'
 import type { EventsValidated, TransactionSignedAndSend } from '../types/transaction'
 import { detectTxSuccess } from './detectTxSuccess'

packages/auto-consensus/src/utils/sudo.ts

@@ -1,8 +1,11 @@
 // file: src/utils/sudo.ts
 
-import { ApiPromise } from '@polkadot/api'
-import type { AddressOrPair, SubmittableExtrinsic } from '@polkadot/api/types'
-import type { ISubmittableResult } from '@polkadot/types/types'
+import type {
+  AddressOrPair,
+  ApiPromise,
+  ISubmittableResult,
+  SubmittableExtrinsic,
+} from '@autonomys/auto-utils'
 import type { Events } from '../types/events'
 import { expectSuccessfulTxEvent } from './events'
 import { signAndSendTx } from './signAndSendTx'

packages/auto-consensus/src/utils/validateEvents.ts

@@ -1,6 +1,6 @@
 // file: src/utils/validateEvents.ts
 
-import type { EventRecord } from '@polkadot/types/interfaces'
+import type { EventRecord } from '@autonomys/auto-utils'
 import type { Events } from '../types/events'
 import type { EventsValidated } from '../types/transaction'
 import { expectSuccessfulTxEvent } from './events'

packages/auto-utils/__test__/wallet.test.ts

@@ -3,6 +3,7 @@ import {
   NetworkInput,
   WalletActivated,
   activateWallet,
+  address,
   mockWallets,
   networks,
   setupWallet,
@@ -30,22 +31,25 @@ describe('Verify wallet functions', () => {
     wallets = await mockWallets()
     aliceWallet = wallets[0].accounts[0]
     bobWallet = wallets[1].accounts[0]
-  })
+  }, 20000)
 
   describe('Test setupWallet()', () => {
     test('Check setupWallet return a pair with matching address and public key when provided with a mnemonic', async () => {
-      const pair = await setupWallet({ mnemonic: TEST_MNEMONIC })
-      expect(pair.address).toEqual(TEST_ADDRESS)
+      const wallet = setupWallet({ mnemonic: TEST_MNEMONIC })
+      expect(wallet.commonAddress).toEqual(TEST_ADDRESS)
+      expect(wallet.address).toEqual(address(TEST_ADDRESS))
     })
 
     test('Check setupWallet return a pair with matching private key when provided with Alice seed', async () => {
-      const pair = await setupWallet({ uri: ALICE_URI })
-      expect(pair.address).toEqual(aliceWallet.address)
+      const wallet = setupWallet({ uri: ALICE_URI })
+      expect(wallet.commonAddress).toEqual(aliceWallet.address)
+      expect(wallet.address).toEqual(address(aliceWallet.address))
     })
 
     test('Check setupWallet return a pair with matching private key when provided with Bob seed', async () => {
-      const pair = await setupWallet({ uri: BOB_URI })
-      expect(pair.address).toEqual(bobWallet.address)
+      const wallet = setupWallet({ uri: BOB_URI })
+      expect(wallet.commonAddress).toEqual(bobWallet.address)
+      expect(wallet.address).toEqual(address(bobWallet.address))
     })
   })
 

packages/auto-utils/src/address.ts

@@ -0,0 +1,9 @@
+// file: src/address.ts
+
+import { decodeAddress, encodeAddress } from '@polkadot/keyring'
+import { DEFAULT_SS58_FORMAT } from './constants/wallet'
+
+export const address = (address: string | Uint8Array): string =>
+  encodeAddress(address, DEFAULT_SS58_FORMAT)
+
+export const decode = (address: string): Uint8Array => decodeAddress(address)

packages/auto-utils/src/api.ts

@@ -1,50 +1,32 @@
-import { ApiPromise as PolkadotApiPromise, WsProvider } from '@polkadot/api'
+import { ApiPromise, WsProvider } from '@polkadot/api'
 import { getNetworkDomainRpcUrls, getNetworkRpcUrls } from './network'
-import type { ApiPromise } from './types/api'
 import type { DomainInput, NetworkInput } from './types/network'
 
-let provider: WsProvider | null = null
-let apiInstance: ApiPromise | null = null
-
-let domainProvider: WsProvider | null = null
-let apiDomainInstance: ApiPromise | null = null
-
 export const activate = async (input?: NetworkInput): Promise<ApiPromise> => {
   // Get the first rpc urls for the network
   const rpcUrl = getNetworkRpcUrls(input)
   // Create the provider
-  provider = new WsProvider(rpcUrl[0])
+  const provider = new WsProvider(rpcUrl[0])
   // Create the API instance
-  apiInstance = await PolkadotApiPromise.create({ provider })
+  const api = await ApiPromise.create({ provider })
+  await api.isReady
 
-  return apiInstance
+  return api
 }
 
 export const activateDomain = async (input: DomainInput): Promise<ApiPromise> => {
   // Get the first rpc urls for the network
   const rpcUrl = getNetworkDomainRpcUrls(input)
   // Create the provider
-  domainProvider = new WsProvider(rpcUrl[0])
+  const provider = new WsProvider(rpcUrl[0])
   // Create the API instance
-  apiDomainInstance = await PolkadotApiPromise.create({ provider: domainProvider })
-
-  return apiDomainInstance
-}
+  const api = await ApiPromise.create({ provider })
+  await api.isReady
 
-export const disconnect = async (): Promise<void> => {
-  // Disconnect the API instance and the provider if they exist
-  if (apiInstance) {
-    await apiInstance.disconnect()
-    apiInstance = null
-    provider = null
-  }
+  return api
 }
 
-export const disconnectDomain = async (): Promise<void> => {
-  // Disconnect the API instance and the provider if they exist
-  if (apiDomainInstance) {
-    await apiDomainInstance.disconnect()
-    apiDomainInstance = null
-    domainProvider = null
-  }
+export const disconnect = async (api: ApiPromise): Promise<void> => {
+  // Disconnect the API instance and the provider
+  await api.disconnect()
 }

packages/auto-utils/src/constants/wallet.ts

@@ -12,3 +12,5 @@ export const mockURIs = [
   '//Ivy',
   '//Jacob',
 ]
+
+export const DEFAULT_SS58_FORMAT = 2254

packages/auto-utils/src/index.ts

@@ -1,5 +1,6 @@
 // file: src/index.ts
 
+export * from './address'
 export * from './api'
 export * from './crypto'
 export * from './network'
@@ -10,3 +11,4 @@ export * from './wallet'
 
 export * from './constants'
 export * from './types'
+export * from './utils'

packages/auto-utils/src/types/event.ts

@@ -0,0 +1,3 @@
+import type { EventRecord } from '@polkadot/types/interfaces'
+
+export type { EventRecord }

packages/auto-utils/src/types/extrinsic.ts

@@ -0,0 +1,7 @@
+// file: src/types/extrinsic.ts
+
+import type { SubmittableExtrinsic, SubmittableModuleExtrinsics } from '@polkadot/api/types'
+import type { Hash } from '@polkadot/types/interfaces'
+import type { ISubmittableResult } from '@polkadot/types/types'
+
+export type { Hash, ISubmittableResult, SubmittableExtrinsic, SubmittableModuleExtrinsics }

packages/auto-utils/src/types/index.ts

@@ -1,3 +1,8 @@
-export * from './api'
+import type { BN } from '@polkadot/util'
+
+export * from './event'
+export * from './extrinsic'
 export * from './network'
 export * from './wallet'
+
+export type { BN }