Sui Integration Test (#79)

Author: swimricky

frontend/claim_sdk/claim.ts

@@ -73,6 +73,14 @@ export class ClaimInfo {
         }
         break
       }
+      case 'sui': {
+        identityStruct = {
+          sui: {
+            address: Buffer.from(removeLeading0x(this.identity), 'hex'),
+          },
+        }
+        break
+      }
       default: {
         // TODO: support the other ecosystems
         throw new Error(`unknown ecosystem type: ${this.ecosystem}`)

frontend/claim_sdk/ecosystems/signatures.test.ts

@@ -15,11 +15,14 @@ import {
   TestAptosWallet,
   TestCosmWasmWallet,
   TestEvmWallet,
+  TestSuiWallet,
 } from '../testWallets'
 import path from 'path'
 import { Address as InjectiveAddress } from '@injectivelabs/sdk-ts'
 import { airdrop } from '../solana'
 import { ed25519 } from '@noble/curves/ed25519'
+import { Ed25519PublicKey } from '@mysten/sui.js/keypairs/ed25519'
+import { blake2b } from '@noble/hashes/blake2b'
 
 describe('signature tests', () => {
   const solanaKeypair = anchor.web3.Keypair.generate()
@@ -116,7 +119,7 @@ describe('signature tests', () => {
 
   test('Aptos signature', async () => {
     const aptosPrivateKeyPath = path.resolve(
-      await __dirname,
+      __dirname,
       '../../integration/keys/aptos_private_key.json'
     )
 
@@ -141,4 +144,31 @@ describe('signature tests', () => {
 
     await provider.sendAndConfirm(txn, [solanaKeypair])
   }, 40000)
+
+  test('Sui signature', async () => {
+    const suiPrivateKeyPath = path.resolve(
+      __dirname,
+      '../../integration/keys/sui_private_key.json'
+    )
+    const testWallet = TestSuiWallet.fromKeyfile(suiPrivateKeyPath)
+    const payload = 'Test payload'
+    const signedMessage = await testWallet.signMessage(payload)
+    const pubkey = new Ed25519PublicKey(signedMessage.publicKey)
+
+    const verified = await pubkey.verify(
+      signedMessage.fullMessage,
+      signedMessage.signature
+    )
+    expect(verified).toBeTruthy()
+    let ix = Ed25519Program.createInstructionWithPublicKey({
+      publicKey: signedMessage.publicKey,
+      message: signedMessage.fullMessage,
+      signature: signedMessage.signature,
+    })
+
+    const txn = new Transaction()
+    txn.add(ix)
+
+    await provider.sendAndConfirm(txn, [solanaKeypair])
+  })
 })

frontend/claim_sdk/ecosystems/signatures.ts

@@ -12,8 +12,9 @@ import {
   getUncompressedPubkey,
 } from './cosmos'
 import { Hash } from '@keplr-wallet/crypto'
-import { HexString } from 'aptos'
 import { aptosGetFullMessage } from './aptos'
+import { splitSignatureAndPubkey, suiGetFullMessage } from './sui'
+import { blake2b } from '@noble/hashes/blake2b'
 
 export type SignedMessage = {
   publicKey: Uint8Array
@@ -87,3 +88,18 @@ export function aptosBuildSignedMessage(
     fullMessage: Buffer.from(aptosGetFullMessage(payload), 'utf-8'),
   }
 }
+
+export function suiBuildSignedMessage(
+  response: string,
+  payload: string
+): SignedMessage {
+  const [signature, publicKey] = splitSignatureAndPubkey(
+    Buffer.from(response, 'base64')
+  )
+  return {
+    publicKey,
+    signature,
+    recoveryId: undefined,
+    fullMessage: blake2b(suiGetFullMessage(payload), { dkLen: 32 }),
+  }
+}

frontend/claim_sdk/solana.ts

@@ -18,6 +18,7 @@ import { ClaimInfo, Ecosystem } from './claim'
 import { TOKEN_PROGRAM_ID, Token } from '@solana/spl-token'
 import { SignedMessage } from './ecosystems/signatures'
 import { extractChainId } from './ecosystems/cosmos'
+import { blake2b } from '@noble/hashes/blake2b'
 
 type bump = number
 // NOTE: This must be kept in sync with the on-chain program
@@ -265,9 +266,12 @@ export class TokenDispenserProvider {
 
     if (signedMessage) {
       switch (claimInfo.ecosystem) {
-        case 'evm': {
+        case 'evm':
+        case 'aptos':
+        case 'sui':
+        case 'injective': {
           return {
-            evm: {
+            [claimInfo.ecosystem]: {
               pubkey: Array.from(signedMessage.publicKey),
               verificationInstructionIndex: 0,
             },
@@ -284,14 +288,6 @@ export class TokenDispenserProvider {
             },
           }
         }
-        case 'injective': {
-          return {
-            injective: {
-              pubkey: Array.from(signedMessage.publicKey), //evm Pubkey
-              verificationInstructionIndex: 0,
-            },
-          }
-        }
         case 'discord': {
           return {
             discord: {
@@ -300,14 +296,6 @@ export class TokenDispenserProvider {
             },
           }
         }
-        case 'aptos': {
-          return {
-            aptos: {
-              pubkey: Array.from(signedMessage.publicKey), //ed25519 pubkey
-              verificationInstructionIndex: 0,
-            },
-          }
-        }
         //TODO: implement other ecosystems
         default: {
           throw new Error(`unknown ecosystem type: ${claimInfo.ecosystem}`)
@@ -343,6 +331,7 @@ export class TokenDispenserProvider {
           return undefined
         }
         case 'discord':
+        case 'sui':
         case 'aptos': {
           return Ed25519Program.createInstructionWithPublicKey({
             publicKey: signedMessage.publicKey,

frontend/claim_sdk/testWallets.ts

@@ -5,6 +5,7 @@ import {
   cosmwasmBuildSignedMessage,
   evmBuildSignedMessage,
   aptosBuildSignedMessage,
+  suiBuildSignedMessage,
 } from './ecosystems/signatures'
 import { ethers } from 'ethers'
 import fs from 'fs'
@@ -15,8 +16,9 @@ import { Keypair, PublicKey } from '@solana/web3.js'
 import { EthSecp256k1Wallet } from '@injectivelabs/sdk-ts/dist/cjs/core/accounts/signers/EthSecp256k1Wallet'
 import { OfflineAminoSigner } from '@injectivelabs/sdk-ts/dist/cjs/core/accounts/signers/types/amino-signer'
 import { hardDriveSignMessage, signDiscordMessage } from './ecosystems/solana'
-import { AptosAccount, HexString } from 'aptos'
+import { AptosAccount } from 'aptos'
 import { aptosGetFullMessage } from './ecosystems/aptos'
+import { Ed25519Keypair } from '@mysten/sui.js/keypairs/ed25519'
 
 const KEY_DIR = './integration/keys/'
 export const TEST_DISCORD_USERNAME =
@@ -39,42 +41,42 @@ export function loadAnchorWallet(): NodeWallet {
 export async function loadTestWallets(): Promise<
   Record<Ecosystem, TestWallet[]>
 > {
-  const evmWallet = TestEvmWallet.fromKeyfile(
-    path.resolve(KEY_DIR, 'evm_private_key.json')
-  )
+  const evmPrivateKeyPath = path.resolve(KEY_DIR, 'evm_private_key.json')
   const cosmosPrivateKeyPath = path.resolve(KEY_DIR, 'cosmos_private_key.json')
   const aptosPrivateKeyPath = path.resolve(KEY_DIR, 'aptos_private_key.json')
+  const suiPrivateKeyPath = path.resolve(KEY_DIR, 'sui_private_key.json')
+
   const dispenserGuardKeyPath = path.resolve(
     KEY_DIR,
     'dispenser_guard_private_key.json'
   )
   const solanaPrivateKeyPath = path.resolve(KEY_DIR, 'solana_private_key.json')
 
   const result: Record<Ecosystem, TestWallet[]> = {
-    evm: [],
-    cosmwasm: [],
+    discord: [],
     solana: [],
-    aptos: [],
+    evm: [],
     sui: [],
-    discord: [],
+    aptos: [],
+    cosmwasm: [],
     injective: [],
   }
-  result['evm'] = [evmWallet]
-
+  result['discord'] = [
+    DiscordTestWallet.fromKeyfile(TEST_DISCORD_USERNAME, dispenserGuardKeyPath),
+  ]
+  result['solana'] = [TestSolanaWallet.fromKeyfile(solanaPrivateKeyPath)]
+  result['evm'] = [TestEvmWallet.fromKeyfile(evmPrivateKeyPath)]
+  result['sui'] = [TestSuiWallet.fromKeyfile(suiPrivateKeyPath)]
+  result['aptos'] = [TestAptosWallet.fromKeyfile(aptosPrivateKeyPath)]
   result['cosmwasm'] = [
     await TestCosmWasmWallet.fromKeyFile(cosmosPrivateKeyPath),
     await TestCosmWasmWallet.fromKeyFile(cosmosPrivateKeyPath, 'osmo'),
     await TestCosmWasmWallet.fromKeyFile(cosmosPrivateKeyPath, 'neutron'),
   ]
-  result['aptos'] = [TestAptosWallet.fromKeyfile(aptosPrivateKeyPath)]
   result['injective'] = [
     await TestCosmWasmWallet.fromKeyFile(cosmosPrivateKeyPath, 'inj'),
   ]
 
-  result['discord'] = [
-    DiscordTestWallet.fromKeyfile(TEST_DISCORD_USERNAME, dispenserGuardKeyPath),
-  ]
-  result['solana'] = [TestSolanaWallet.fromKeyfile(solanaPrivateKeyPath)]
   return result
 }
 
@@ -212,18 +214,18 @@ export class TestSolanaWallet implements TestWallet {
 }
 
 export class TestAptosWallet implements TestWallet {
-  constructor(readonly wallet: AptosAccount, readonly addressStr: string) {}
+  constructor(readonly wallet: AptosAccount) {}
   static fromKeyfile(keyFile: string): TestAptosWallet {
     const jsonContent = fs.readFileSync(keyFile, 'utf8')
     const mnemonic = JSON.parse(jsonContent).mnemonic
     const aptosAccount = AptosAccount.fromDerivePath(
       "m/44'/637'/0'/0'/0'",
       mnemonic
     )
-    return new TestAptosWallet(aptosAccount, aptosAccount.authKey().hex())
+    return new TestAptosWallet(aptosAccount)
   }
   address(): string {
-    return this.addressStr
+    return this.wallet.authKey().hex()
   }
 
   async signMessage(payload: string): Promise<SignedMessage> {
@@ -236,3 +238,24 @@ export class TestAptosWallet implements TestWallet {
     )
   }
 }
+
+export class TestSuiWallet implements TestWallet {
+  constructor(readonly wallet: Ed25519Keypair) {}
+
+  static fromKeyfile(keyFile: string): TestSuiWallet {
+    const jsonContent = fs.readFileSync(keyFile, 'utf8')
+    const mnemonic = JSON.parse(jsonContent).mnemonic
+    return new TestSuiWallet(Ed25519Keypair.deriveKeypair(mnemonic))
+  }
+
+  address(): string {
+    return this.wallet.toSuiAddress()
+  }
+  async signMessage(payload: string): Promise<SignedMessage> {
+    const response = (
+      await this.wallet.signPersonalMessage(Buffer.from(payload))
+    ).signature
+
+    return suiBuildSignedMessage(response, payload)
+  }
+}

frontend/hooks/useSignMessage.tsx

@@ -13,6 +13,7 @@ import {
   evmBuildSignedMessage,
   cosmwasmBuildSignedMessage,
   aptosBuildSignedMessage,
+  suiBuildSignedMessage,
 } from 'claim_sdk/ecosystems/signatures'
 
 // SignMessageFn signs the message and returns it.
@@ -161,15 +162,7 @@ export function useSuiSignMessage(): SignMessageFn {
             message: Buffer.from(payload),
           })
         ).signature
-        const [signature, publicKey] = splitSignatureAndPubkey(
-          Buffer.from(response, 'base64')
-        )
-        return {
-          publicKey,
-          signature,
-          recoveryId: undefined,
-          fullMessage: suiGetFullMessage(payload),
-        }
+        return suiBuildSignedMessage(response, payload)
       } catch (e) {
         console.error(e)
       }

frontend/integration/integrationTest.test.ts

@@ -417,5 +417,49 @@ describe('integration test', () => {
         )
       ).toBeTruthy()
     }, 40000)
+
+    it('submits a sui claim', async () => {
+      const wallet = testWallets.sui[0]
+      const { claimInfo, proofOfInclusion } = (await mockFetchAmountAndProof(
+        'sui',
+        wallet.address()
+      ))!
+      const signedMessage = await wallet.signMessage(
+        tokenDispenserProvider.generateAuthorizationPayload()
+      )
+
+      await tokenDispenserProvider.submitClaims([
+        {
+          claimInfo,
+          proofOfInclusion,
+          signedMessage,
+        },
+      ])
+
+      expect(
+        await tokenDispenserProvider.isClaimAlreadySubmitted(claimInfo)
+      ).toBeTruthy()
+
+      const claimantFundPubkey =
+        await tokenDispenserProvider.getClaimantFundAddress()
+
+      const claimantFund = await mint.getAccountInfo(claimantFundPubkey)
+
+      expect(
+        claimantFund.amount.eq(
+          new anchor.BN(
+            3000000 +
+              6000000 +
+              6100000 +
+              6200000 +
+              7000000 +
+              5000000 +
+              1000000 +
+              2000000 +
+              4000000
+          )
+        )
+      ).toBeTruthy()
+    }, 40000)
   })
 })

frontend/integration/keys/sui_private_key.json

@@ -0,0 +1,3 @@
+{
+  "mnemonic": "pink west stock deputy exhibit opera rely zebra barrel pilot ritual library"
+}