From 77a93cd4357ee0b81fc9d2084bad53e990097a23 Mon Sep 17 00:00:00 2001 From: Paul Noel Date: Fri, 21 Mar 2025 15:15:55 -0500 Subject: [PATCH] watcher: solana shim support --- package-lock.json | 8 +- watcher/package.json | 1 + watcher/src/watchers/NTTSolanaWatcher.ts | 14 +- watcher/src/watchers/SolanaWatcher.ts | 137 ++++++++++++++---- .../watchers/__tests__/SolanaWatcher.test.ts | 24 +++ 5 files changed, 152 insertions(+), 32 deletions(-) diff --git a/package-lock.json b/package-lock.json index 5225d312..e3ed2d48 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11462,9 +11462,10 @@ } }, "node_modules/binary-layout": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/binary-layout/-/binary-layout-1.0.3.tgz", - "integrity": "sha512-kpXCSOko4wbQaQswZk4IPcjVZwN77TKZgjMacdoX54EvUHAn/CzJclCt25SUmpXfzFrGovoq3LkPJkMy10bZxQ==" + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/binary-layout/-/binary-layout-1.2.0.tgz", + "integrity": "sha512-K3EHOEEjDLDm3BdT6MXMu/8JQZx7wWMwPlV28ULxHIyW9RFqEp6sQB4Q22bt3u2EBP95H0mWNH6oDz7Cs8iPoA==", + "license": "Apache-2.0" }, "node_modules/bindings": { "version": "1.5.0", @@ -22523,6 +22524,7 @@ "algosdk": "^2.4.0", "anchor-0.29.0": "npm:@coral-xyz/anchor@^0.29.0", "aptos": "^1.4.0", + "binary-layout": "^1.2.0", "bs58": "^5.0.0", "dotenv": "^16.0.3", "firebase-admin": "^11.4.0", diff --git a/watcher/package.json b/watcher/package.json index 4002f168..b4ed455a 100644 --- a/watcher/package.json +++ b/watcher/package.json @@ -45,6 +45,7 @@ "algosdk": "^2.4.0", "anchor-0.29.0": "npm:@coral-xyz/anchor@^0.29.0", "aptos": "^1.4.0", + "binary-layout": "^1.2.0", "bs58": "^5.0.0", "dotenv": "^16.0.3", "firebase-admin": "^11.4.0", diff --git a/watcher/src/watchers/NTTSolanaWatcher.ts b/watcher/src/watchers/NTTSolanaWatcher.ts index 78db93a0..7ed32497 100644 --- a/watcher/src/watchers/NTTSolanaWatcher.ts +++ b/watcher/src/watchers/NTTSolanaWatcher.ts @@ -107,7 +107,11 @@ export class NTTSolanaWatcher extends SolanaWatcher { wallet, AnchorProvider.defaultOptions() ); - this.program = new Program(NTT_IDL as any, new PublicKey(this.programId), this.provider); + this.program = new Program( + NTT_IDL as any, + new PublicKey(this.coreBridgeProgramId), + this.provider + ); this.nttBorsh = new BorshCoder(NTT_IDL as any); this.pg = knex({ @@ -227,7 +231,9 @@ export class NTTSolanaWatcher extends SolanaWatcher { tokenAmount: nttManagerMessage.payload.trimmedAmount.normalize(NTT_DECIMALS), transferSentTxhash: '', transferBlockHeight: 0n, - nttTransferKey: `${this.programId}/${nttManagerMessage.payload.recipientAddress.toString( + nttTransferKey: `${ + this.coreBridgeProgramId + }/${nttManagerMessage.payload.recipientAddress.toString( 'hex' )}/${nttManagerMessage.id.toString('hex')}`, vaaId: '', @@ -413,7 +419,7 @@ export class NTTSolanaWatcher extends SolanaWatcher { transferSentTxhash: '', transferBlockHeight: 0n, nttTransferKey: `${ - this.programId + this.coreBridgeProgramId }/${recipient}/${transceiverMessage.ntt_managerPayload.id.toString('hex')}`, vaaId: `${parsedVaa.emitterChain}/${parsedVaa.emitterAddress.toString('hex')}/${ parsedVaa.sequence @@ -468,7 +474,7 @@ export class NTTSolanaWatcher extends SolanaWatcher { transceiverMessage.ntt_managerPayload.payload.trimmedAmount.normalize(NTT_DECIMALS), transferSentTxhash: transaction.transaction.signatures[0], transferBlockHeight: BigInt(transaction.slot), - nttTransferKey: `${this.programId}/${recipient}/${seq}`, + nttTransferKey: `${this.coreBridgeProgramId}/${recipient}/${seq}`, vaaId: vaaId, digest: getNttManagerMessageDigest( chainToChainId(this.chain), diff --git a/watcher/src/watchers/SolanaWatcher.ts b/watcher/src/watchers/SolanaWatcher.ts index cd49f1ee..defd5ffa 100644 --- a/watcher/src/watchers/SolanaWatcher.ts +++ b/watcher/src/watchers/SolanaWatcher.ts @@ -18,16 +18,36 @@ import { universalAddress_stripped, } from '@wormhole-foundation/wormhole-monitor-common'; import { Watcher } from './Watcher'; -import { Network, contracts } from '@wormhole-foundation/sdk-base'; +import { Network, contracts, encoding } from '@wormhole-foundation/sdk-base'; import { deserializePostMessage } from '@wormhole-foundation/sdk-solana-core'; import { getAllKeys } from '../utils/solana'; +import { UniversalAddress } from '@wormhole-foundation/sdk-definitions'; +import { DeriveType, deserialize, Layout } from 'binary-layout'; const COMMITMENT: Commitment = 'finalized'; const GET_SIGNATURES_LIMIT = 1000; +const ShimContracts: { [key in Network]: string } = { + Mainnet: '', + Testnet: 'EtZMZM22ViKMo4r5y4Anovs3wKQ2owUmDpjygnMMcdEX', + Devnet: '', +}; + +const POST_MESSAGE_INSTRUCTION_ID = 0x01; +const shimMessageEventDiscriminator = 'e445a52e51cb9a1d441b8f004d4c8970'; + +const shimMessageEventLayout = [ + { name: 'discriminator', binary: 'bytes', size: 16 }, + { name: 'emitterAddress', binary: 'bytes', size: 32 }, + { name: 'sequence', binary: 'uint', size: 8, endianness: 'little' }, + { name: 'timestamp', binary: 'uint', size: 4, endianness: 'little' }, +] as const satisfies Layout; +export type ShimMessageEvent = DeriveType; + export class SolanaWatcher extends Watcher { readonly rpc: string; - readonly programId: string; + readonly coreBridgeProgramId: string; + readonly shimProgramId: string; // this is set as a class field so we can modify it in tests getSignaturesLimit = GET_SIGNATURES_LIMIT; // The Solana watcher uses the `getSignaturesForAddress` RPC endpoint to fetch all transactions @@ -39,10 +59,23 @@ export class SolanaWatcher extends Watcher { connection: Connection | undefined; - constructor(network: Network, mode: Mode = 'vaa') { + constructor(network: Network, mode: Mode = 'vaa', rpc?: string) { super(network, 'Solana', mode); - this.rpc = RPCS_BY_CHAIN[this.network].Solana!; - this.programId = contracts.coreBridge(this.network, 'Solana'); + // only allow rpc to be set for 'Testnet' and mode 'vaa' + // This allows the use of the explorer RPC for testnet testing. + if (rpc && network !== 'Testnet') { + throw new Error('RPC can only be set for Testnet'); + } + if (rpc && mode !== 'vaa') { + throw new Error('RPC can only be set for mode vaa'); + } + if (rpc && network === 'Testnet') { + this.rpc = rpc; + } else { + this.rpc = RPCS_BY_CHAIN[network].Solana!; + } + this.coreBridgeProgramId = contracts.coreBridge(this.network, 'Solana'); + this.shimProgramId = ShimContracts[this.network]; } getConnection(): Connection { @@ -121,11 +154,14 @@ export class SolanaWatcher extends Watcher { let currSignature: string | undefined = fromSignature; while (numSignatures === this.getSignaturesLimit) { const signatures: ConfirmedSignatureInfo[] = - await this.getConnection().getSignaturesForAddress(new PublicKey(this.programId), { - before: currSignature, - until: toSignature, - limit: this.getSignaturesLimit, - }); + await this.getConnection().getSignaturesForAddress( + new PublicKey(this.coreBridgeProgramId), + { + before: currSignature, + until: toSignature, + limit: this.getSignaturesLimit, + } + ); this.logger.info(`processing ${signatures.length} transactions`); @@ -161,17 +197,27 @@ export class SolanaWatcher extends Watcher { } const accountKeys = await getAllKeys(this.getConnection(), res); - const programIdIndex = accountKeys.findIndex((i) => i.toBase58() === this.programId); + const coreBridgeProgramIdIndex = accountKeys.findIndex( + (i) => i.toBase58() === this.coreBridgeProgramId + ); + const shimProgramIdIndex = accountKeys.findIndex( + (i) => i.toBase58() === this.shimProgramId + ); const message: VersionedMessage = res.transaction.message; - const instructions = message.compiledInstructions; + const outerInstructions = message.compiledInstructions; const innerInstructions = res.meta?.innerInstructions?.flatMap((i) => i.instructions.map(normalizeCompileInstruction) ) || []; - const whInstructions = innerInstructions - .concat(instructions) - .filter((i) => i.programIdIndex === programIdIndex); + // Need to look for Wormhole instructions and shim instructions + const allInstructions = innerInstructions + .concat(outerInstructions) + .filter( + (i) => + i.programIdIndex === coreBridgeProgramIdIndex || + i.programIdIndex === shimProgramIdIndex + ); const blockKey = makeBlockKey( res.slot.toString(), @@ -179,22 +225,44 @@ export class SolanaWatcher extends Watcher { ); const vaaKeys: string[] = []; - for (const instruction of whInstructions) { - // skip if not postMessage instruction + for (const instruction of allInstructions) { + // The only instructions that get this far are either coreBridge or shim instructions const instructionId = instruction.data; - if (instructionId[0] !== 0x08 && instructionId[0] !== 0x01) continue; - const accountId = accountKeys[instruction.accountKeyIndexes[1]]; + let emitterAddress: UniversalAddress; + let sequence: bigint; - const acctInfo = await this.getConnection().getAccountInfo(accountId, COMMITMENT); - if (!acctInfo?.data) throw new Error('No data found in message account'); - const { emitterAddress, sequence } = deserializePostMessage( - new Uint8Array(acctInfo.data) - ); + // We don't look for PostMessageUnreliable instructions since they aren't reobservable. + if ( + instruction.programIdIndex === coreBridgeProgramIdIndex && + instructionId[0] === POST_MESSAGE_INSTRUCTION_ID + ) { + // Got post message instruction + const accountId = accountKeys[instruction.accountKeyIndexes[1]]; + + const acctInfo = await this.getConnection().getAccountInfo(accountId, COMMITMENT); + if (!acctInfo?.data) throw new Error('No data found in message account'); + const deserializedMsg = deserializePostMessage(new Uint8Array(acctInfo.data)); + emitterAddress = deserializedMsg.emitterAddress; + sequence = deserializedMsg.sequence; + } else if (instruction.programIdIndex === shimProgramIdIndex) { + // Got shim instruction + const parsedMsg = this.parseShimMessage(instruction.data); + if (!parsedMsg) { + // Failed to parse shim message + // This is not a fatal error, just skip it. + continue; + } + emitterAddress = parsedMsg.emitterAddress; + sequence = parsedMsg.sequence; + } else { + // Not a coreBridge post message or shim instruction + continue; + } vaaKeys.push( makeVaaKey( - res.transaction.signatures[0], + res.transaction.signatures[0], // This is the tx hash this.chain, universalAddress_stripped(emitterAddress), sequence.toString() @@ -217,6 +285,25 @@ export class SolanaWatcher extends Watcher { return { vaasByBlock: { [lastBlockKey]: [], ...vaasByBlock } }; } + parseShimMessage(data: Uint8Array): { + emitterAddress: UniversalAddress; + sequence: bigint; + } | null { + // First step is to convert the data into a hex string + const hexData = encoding.hex.encode(data); + + // Next, we need to look for the discriminator that we care about. + if (hexData.startsWith(shimMessageEventDiscriminator)) { + // Use the binary layout to deserialize the data + const decoded = deserialize(shimMessageEventLayout, data); + const emitterAddress = new UniversalAddress(decoded.emitterAddress); + const sequence = decoded.sequence; + + return { emitterAddress, sequence }; + } + return null; + } + isValidVaaKey(key: string) { try { const [txHash, vaaKey] = key.split(':'); diff --git a/watcher/src/watchers/__tests__/SolanaWatcher.test.ts b/watcher/src/watchers/__tests__/SolanaWatcher.test.ts index e8e2d83f..06b9c726 100644 --- a/watcher/src/watchers/__tests__/SolanaWatcher.test.ts +++ b/watcher/src/watchers/__tests__/SolanaWatcher.test.ts @@ -115,3 +115,27 @@ test('getMessagesForBlocks - handle failed transactions', async () => { .join(',') ).toBe('4,3,2,1,0'); }); + +test.only('getMessagesForBlocks - shim 1', async () => { + const watcher = new SolanaWatcher('Testnet', 'vaa', 'https://explorer-api.devnet.solana.com'); + const { vaasByBlock: messages } = await watcher.getMessagesForBlocks(356345331, 356345332); + expect(Object.keys(messages).length).toBe(1); + expect(Object.values(messages).length).toBe(1); + expect(messages).toMatchObject({ + '356345332/2025-01-24T16:42:31.000Z': [ + '3auPns1kSD2R4GvWfutCQqKTmPfdmSr9yKgUsc3t19bhmVWq6UKtafboCBhrczTehYTbzN5XZh2apLaugg2h8da2:1/83718b7ec89617b7040685e01bdcca03214022980daae91340e0c3f840c005ef/0', + ], + }); +}); + +test.only('getMessagesForBlocks - shim 2', async () => { + const watcher = new SolanaWatcher('Testnet', 'vaa', 'https://explorer-api.devnet.solana.com'); + const { vaasByBlock: messages } = await watcher.getMessagesForBlocks(357272507, 357272508); + expect(Object.keys(messages).length).toBe(1); + expect(Object.values(messages).length).toBe(1); + expect(messages).toMatchObject({ + '357272508/2025-01-28T20:11:01.000Z': [ + 'b8fyUcMJgA5P6SS92HMRtxwFpihhAGe9PdcFVbYeVHRAHnr5vyJNbWJHeJ7ko23c8rg2KQ8oPVxdZbDh6V4Jv9t:1/83718b7ec89617b7040685e01bdcca03214022980daae91340e0c3f840c005ef/4', + ], + }); +});