From ff3c6d66f1d1fd5cc7983086587328884945b40a Mon Sep 17 00:00:00 2001 From: John Oshalusi Date: Tue, 11 Mar 2025 00:24:07 +0100 Subject: [PATCH] feat: discover shared wallet by metadata label --- .../BlockfrostSharedWalletProvider.ts | 57 ++++++ .../src/SharedWalletProvider/index.ts | 1 + .../src/SharedWalletProvider/types.ts | 32 ++++ packages/cardano-services-client/src/index.ts | 1 + .../BlockfrostSharedWallet.test.ts | 175 ++++++++++++++++++ packages/core/src/const.ts | 2 + packages/core/src/index.ts | 1 + packages/key-management/src/types.ts | 6 +- yarn-project.nix | 4 +- 9 files changed, 275 insertions(+), 4 deletions(-) create mode 100644 packages/cardano-services-client/src/SharedWalletProvider/BlockfrostSharedWalletProvider.ts create mode 100644 packages/cardano-services-client/src/SharedWalletProvider/index.ts create mode 100644 packages/cardano-services-client/src/SharedWalletProvider/types.ts create mode 100644 packages/cardano-services-client/test/SharedWalletProvider/BlockfrostSharedWallet.test.ts create mode 100644 packages/core/src/const.ts diff --git a/packages/cardano-services-client/src/SharedWalletProvider/BlockfrostSharedWalletProvider.ts b/packages/cardano-services-client/src/SharedWalletProvider/BlockfrostSharedWalletProvider.ts new file mode 100644 index 00000000000..bb0a8b7cc18 --- /dev/null +++ b/packages/cardano-services-client/src/SharedWalletProvider/BlockfrostSharedWalletProvider.ts @@ -0,0 +1,57 @@ +import * as Crypto from '@cardano-sdk/crypto'; +import { BlockfrostClient, BlockfrostProvider, fetchSequentially } from '../blockfrost'; +import { Cardano, MULTISIG_CIP_ID, Serialization } from '@cardano-sdk/core'; +import { Logger } from 'ts-log'; +import { MultiSigRegistration, MultiSigTransaction, SharedWalletProvider } from './types'; +import type { Responses } from '@blockfrost/blockfrost-js'; + +const MULTI_SIG_LABEL = MULTISIG_CIP_ID; + +const isMultiSigRegistration = (metadata: unknown): metadata is MultiSigRegistration => + !!metadata && typeof metadata === 'object' && 'participants' in metadata; + +export class BlockfrostSharedWalletProvider extends BlockfrostProvider implements SharedWalletProvider { + constructor(client: BlockfrostClient, logger: Logger) { + super(client, logger); + } + + private async getNativeScripts(txId: Cardano.TransactionId): Promise { + const response = await this.request(`txs/${txId}/cbor`); + const transaction = Serialization.Transaction.fromCbor(Serialization.TxCBOR(response.cbor)).toCore(); + return transaction.auxiliaryData?.scripts ?? []; + } + + async discoverWallets(pubKey: Crypto.Ed25519KeyHashHex): Promise { + const batchSize = 100; + + const multiSigTransactions = await fetchSequentially( + { + haveEnoughItems: (wallets, _) => wallets.length < batchSize, + paginationOptions: { count: batchSize }, + request: (paginationQueryString) => + this.request( + `metadata/txs/labels/${MULTI_SIG_LABEL}?${paginationQueryString}` + ), + responseTranslator: (wallets) => + wallets + .filter((wallet) => { + const metadata = wallet.json_metadata; + return isMultiSigRegistration(metadata) && metadata?.participants?.[pubKey]; + }) + .map((wallet) => ({ + metadata: wallet.json_metadata as unknown as MultiSigRegistration, + nativeScripts: [], + txId: Cardano.TransactionId(wallet.tx_hash) + })) + }, + [] + ); + + return await Promise.all( + multiSigTransactions.map(async (wallet) => ({ + ...wallet, + nativeScripts: await this.getNativeScripts(wallet.txId) + })) + ); + } +} diff --git a/packages/cardano-services-client/src/SharedWalletProvider/index.ts b/packages/cardano-services-client/src/SharedWalletProvider/index.ts new file mode 100644 index 00000000000..ad2bf7b69a6 --- /dev/null +++ b/packages/cardano-services-client/src/SharedWalletProvider/index.ts @@ -0,0 +1 @@ +export * from './BlockfrostSharedWalletProvider'; diff --git a/packages/cardano-services-client/src/SharedWalletProvider/types.ts b/packages/cardano-services-client/src/SharedWalletProvider/types.ts new file mode 100644 index 00000000000..c9425ef97cd --- /dev/null +++ b/packages/cardano-services-client/src/SharedWalletProvider/types.ts @@ -0,0 +1,32 @@ +import { Cardano } from '@cardano-sdk/core'; +import { Ed25519KeyHashHex } from '@cardano-sdk/crypto'; + +type ScriptType = number; + +interface MultiSigParticipant { + name: string; + description?: string; + icon?: string; +} + +interface MultiSigParticipants { + [key: Ed25519KeyHashHex]: MultiSigParticipant; +} + +export interface MultiSigRegistration { + types: ScriptType[]; + name?: string; + description?: string; + icon?: string; + participants?: MultiSigParticipants; +} + +export interface MultiSigTransaction { + txId: Cardano.TransactionId; + metadata: MultiSigRegistration; + nativeScripts?: Cardano.Script[]; +} + +export interface SharedWalletProvider { + discoverWallets: (pubKey: Ed25519KeyHashHex) => Promise; +} diff --git a/packages/cardano-services-client/src/index.ts b/packages/cardano-services-client/src/index.ts index 453d84b9845..e74995435b8 100644 --- a/packages/cardano-services-client/src/index.ts +++ b/packages/cardano-services-client/src/index.ts @@ -10,6 +10,7 @@ export * from './RewardAccountInfoProvider'; export * from './NetworkInfoProvider'; export * from './RewardsProvider'; export * from './HandleProvider'; +export * from './SharedWalletProvider'; export * from './version'; export * from './WebSocket'; export { diff --git a/packages/cardano-services-client/test/SharedWalletProvider/BlockfrostSharedWallet.test.ts b/packages/cardano-services-client/test/SharedWalletProvider/BlockfrostSharedWallet.test.ts new file mode 100644 index 00000000000..952cf3634f6 --- /dev/null +++ b/packages/cardano-services-client/test/SharedWalletProvider/BlockfrostSharedWallet.test.ts @@ -0,0 +1,175 @@ +import * as Crypto from '@cardano-sdk/crypto'; +import { BlockfrostClient, BlockfrostSharedWalletProvider } from '../../src'; +import { logger } from '@cardano-sdk/util-dev'; + +const mockedResponses = [ + { + json_metadata: { + description: 'd mb-s+lnx+tmt02', + name: 'mb-s+lnx+tmt02', + participants: {}, + types: ['payment', 'stake'] + }, + tx_hash: 'c59b418d946b08554d8be35994420d0e9ba5b01a3cafb9979496f55b2fd9fda6' + }, + { + json_metadata: { + description: 'This is really a test wallet, I think with mb-s', + name: 'Another test ms wallet', + participants: {}, + types: ['payment', 'stake'] + }, + tx_hash: '6c1a7652b189aaa3efe39e66c0ef8c894c6f6f8e37fceb58dc41064ac628a569' + }, + { + json_metadata: { + description: 'A Multi-Sig test wallet', + name: 'MS Test', + participants: { + '35769ace6c241e0afe467b0a3577af9adea271fc971ba7770ac88712': { + name: 'Wallet 1' + }, + '962746268ee907e18c895c9943c6684b01fa7a4956b0fe0fa76cfa6f': { + name: 'Wallet 2' + }, + c87b02ef2bed963db3892031ce9387b7d65a83008bad072ddb7409d6: { + name: 'Wallet 1' + }, + ebf94d78fb1b185f5b0136260d9192e1270c8303bba5155e773de3fb: { + name: 'Wallet 2' + } + }, + types: ['payment', 'stake'] + }, + tx_hash: '37bbd91b177e0716d5943fb3de8649c9dcabc844553e7656744ffca1c11efddc' + }, + { + json_metadata: { + description: 'A simple Multi-Sig wallet with 3/3 signatures needed.', + name: 'MS Test 3/3', + participants: { + '7429c675051bb444a78d0850be2c45a48f8ed3d4ecdb6f059ed19873': { + name: 'Wallet 3' + }, + '35769ace6c241e0afe467b0a3577af9adea271fc971ba7770ac88712': { + name: 'Wallet 1' + }, + '15254521db8f70ac44aa585475361727e918465425d9fb53f0d754e3': { + name: 'Wallet 3' + }, + '962746268ee907e18c895c9943c6684b01fa7a4956b0fe0fa76cfa6f': { + name: 'Wallet 2' + }, + c87b02ef2bed963db3892031ce9387b7d65a83008bad072ddb7409d6: { + name: 'Wallet 1' + }, + ebf94d78fb1b185f5b0136260d9192e1270c8303bba5155e773de3fb: { + name: 'Wallet 2' + } + }, + types: ['payment', 'stake'] + }, + tx_hash: '42c2eed5fabb3500b7b66e84c73d78633df567803f4a8afd38d485f71a7fcf84' + }, + { + json_metadata: { + description: 'A simple Multi-Sig wallet with 3/3 signatures needed', + name: 'MS 3/3', + participants: {}, + types: ['payment', 'stake'] + }, + tx_hash: 'e51c93492c04fc6b8d475c5bbbac483961d1d2ebf592d019619cd199f17ed6f5' + }, + { + json_metadata: { + description: 'dsfdsfdsf', + name: 'MS Test', + participants: { + '35769ace6c241e0afe467b0a3577af9adea271fc971ba7770ac88712': { + name: 'sdfdsf' + }, + '962746268ee907e18c895c9943c6684b01fa7a4956b0fe0fa76cfa6f': { + name: 'sdfsdf' + }, + c87b02ef2bed963db3892031ce9387b7d65a83008bad072ddb7409d6: { + name: 'sdfdsf' + }, + ebf94d78fb1b185f5b0136260d9192e1270c8303bba5155e773de3fb: { + name: 'sdfsdf' + } + }, + types: ['payment', 'stake'] + }, + tx_hash: '0c746630f885213618db4af244a8d257e8c03a4041a0fcbece10abe0a6526f5d' + }, + { + json_metadata: { + description: 'L + T + K', + name: 'HW MS Test', + participants: { + '7fb20197bb7e2c3b44539fb9784e70db308640c86a1ef45db711cd28': { + name: 'Keystone' + }, + '9d237cfa3da50b71859ac7045e4d296252c85f7d72d4c5c889a8c22e': { + name: 'Keystone' + }, + a4fb72bcb24a91cb1add70d3158704a4cf14a7909fbbe4edac39efb1: { + name: 'Ledger' + }, + ad773cd4bdb0f775c53d34c48e70bd46f1856e21c8103f8d292fcc7a: { + name: 'Ledger' + }, + afb321dabccdf5ea26ce4ac9c0cd5aaae6cb47a61e12cd8c8b3f41a0: { + name: 'Trezor' + }, + cc9adac917b5a7e191982f1bb979507349e5ae59df8d015a2842f4bd: { + name: 'Trezor' + } + }, + types: ['payment', 'stake'] + }, + tx_hash: 'a160d298a6e49e6b39b33cde296baf171b2ad31c4520cbbc2086d99d3d64bc91' + } +]; + +const nativeScriptResponse = { + cbor: '84a70081825820765bf5499431711696c37ce98cf5b40b94e592ae497c7e1acadf44e97db540de0001818258390029fb060929ae397acd22105b8d512cafbe14beb372b7940734c8e0a049ffdf3c964ec375208a6b46cc6075ad36beb80bcce21663021d78da1a004caf43021a0002d611031a04850a6905a1581de049ffdf3c964ec375208a6b46cc6075ad36beb80bcce21663021d78da1a0005ee750758200e0397a8285695c5f5a581b4cfca2896ecdcab79e1723b36ba0b3904cc8ad04f0800a100828258202ebc0ea3cd6546b9e1c82c8f14a9d59e1f21a8483453e2bce5e1aa9fb5cd37bb5840cefb6d1f99e7ef1d72f2a67779764832949d10b1f62e08602b8bba50da703fe36c91f192e2fd60d709fc027b964979ac6197da708091b591c75e5e21b770b500825820520b5cd3b967df70972451885c54de299738ead98113080130848b39cea2854e5840f092b42091f16082a34789c45471ab1f60ee175fe752ce29f7c42edea6c04151c8c47bf684f53bdefd765de0f2dba9fc1f8e914f29b97c8fae6cc7727465c006f582a119073ea46b6465736372697074696f6e7064206d622d732b6c6e782b746d743032646e616d656e6d622d732b6c6e782b746d7430326c7061727469636970616e7473a065747970657382677061796d656e74657374616b65828202838200581ce3ad78d912029930ec11394610bdd4dd12bc64effb61e2258ab059338200581c8a7c43db68954f99e8afa35130ac65576776eb6500d2c616cb6d1d408200581c83dec074a40f7d6b7cfd902243ec4b902d17960a69a66acd8bd35ce08202838200581c96f941682e4b1873dc45ef6930378915ae637c5be5d6c1fd1f9491e68200581c734a5efd35afe4de6a9bf2ca4c4bfe2a22b370a0acbddd9c3dfbfa6b8200581cd8747c9c7d51385172474bfea67ecdb27eaf9bb5be216118b407775b' +}; + +describe('BlockfrostSharedWallet', () => { + let request: jest.Mock; + let provider: BlockfrostSharedWalletProvider; + + beforeEach(async () => { + request = jest.fn(); + const client = { request } as unknown as BlockfrostClient; + provider = new BlockfrostSharedWalletProvider(client, logger); + }); + + describe('discoverWallets', () => { + it('should return an empty array if no wallets are found', () => { + request.mockResolvedValueOnce(mockedResponses); + return expect( + provider.discoverWallets(Crypto.Ed25519KeyHashHex('0a0ba36b07e61f4b566a99521be1f8b2fdb1ce47246894807b63712b')) + ).resolves.toEqual([]); + }); + + it('should return all wallets for a given public key', async () => { + request.mockResolvedValueOnce(mockedResponses); + + request + .mockResolvedValueOnce(nativeScriptResponse) + .mockResolvedValueOnce(nativeScriptResponse) + .mockResolvedValueOnce(nativeScriptResponse); + + const pubKey = '962746268ee907e18c895c9943c6684b01fa7a4956b0fe0fa76cfa6f'; + const wallets = await provider.discoverWallets(Crypto.Ed25519KeyHashHex(pubKey)); + + expect(wallets.length).toEqual(3); + for (const wallet of wallets) { + expect(wallet.metadata.participants).toHaveProperty(pubKey); + expect(wallet.nativeScripts).toHaveLength(2); + } + }); + }); +}); diff --git a/packages/core/src/const.ts b/packages/core/src/const.ts new file mode 100644 index 00000000000..85e75c1e79e --- /dev/null +++ b/packages/core/src/const.ts @@ -0,0 +1,2 @@ +export const MULTISIG_CIP_ID = 1854; +export const HD_WALLET_CIP_ID = 1852; diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts index 9a5b7a0dffe..de285033a49 100644 --- a/packages/core/src/index.ts +++ b/packages/core/src/index.ts @@ -4,4 +4,5 @@ export * as Serialization from './Serialization'; export * from './Provider'; export * from './util'; export * from './errors'; +export * from './const'; export * from './CardanoNode'; diff --git a/packages/key-management/src/types.ts b/packages/key-management/src/types.ts index 29200902d84..c12531eca42 100644 --- a/packages/key-management/src/types.ts +++ b/packages/key-management/src/types.ts @@ -1,5 +1,5 @@ +import { Cardano, HD_WALLET_CIP_ID, HandleResolution, MULTISIG_CIP_ID, Serialization } from '@cardano-sdk/core'; import type * as Crypto from '@cardano-sdk/crypto'; -import type { Cardano, HandleResolution, Serialization } from '@cardano-sdk/core'; import type { Cip30DataSignature } from '@cardano-sdk/dapp-connector'; import type { Cip30SignDataRequest, Cip8SignDataContext } from './cip8'; import type { HexBlob, OpaqueString, Shutdown } from '@cardano-sdk/util'; @@ -40,8 +40,8 @@ export enum KeyRole { } export enum KeyPurpose { - STANDARD = 1852, - MULTI_SIG = 1854 + STANDARD = HD_WALLET_CIP_ID, + MULTI_SIG = MULTISIG_CIP_ID } export interface AccountKeyDerivationPath { role: KeyRole; diff --git a/yarn-project.nix b/yarn-project.nix index 7b93fa06ec4..aa17c2bffdd 100644 --- a/yarn-project.nix +++ b/yarn-project.nix @@ -441,7 +441,7 @@ cacheEntries = { "@emurgo/cip14-js@npm:3.0.1" = { filename = "@emurgo-cip14-js-npm-3.0.1-6011030ea2-9eaf312410.zip"; sha512 = "9eaf3124108e8c252a745de9ef1f334ab26a32271077b00fe0ea2a06e40838dd435165dac523ebd4d851ae7a94d8c56766dabc372aabffedd36551c798c607c5"; }; "@endemolshinegroup/cosmiconfig-typescript-loader@npm:3.0.2" = { filename = "@endemolshinegroup-cosmiconfig-typescript-loader-npm-3.0.2-97436e68fc-7fe0198622.zip"; sha512 = "7fe0198622b1063c40572034df7e8ba867865a1b4815afe230795929abcf785758b34d7806a8e2100ba8ab4e92c5a1c3e11a980c466c4406df6e7ec6e50df8b6"; }; "@es-joy/jsdoccomment@npm:0.10.8" = { filename = "@es-joy-jsdoccomment-npm-0.10.8-d03c65b162-3e144ef393.zip"; sha512 = "3e144ef393459a541b64f6c9c8e62fb6d9b47e1a2c626410487ede12c472064f6ce6e0911df60b42ccf126d5a66102707eef59ca14767cb7aeb5e608b227558d"; }; -"@esbuild/linux-x64@npm:0.21.5" = { filename = "@esbuild-linux-x64-npm-0.21.5-88079726c4-8.zip"; sha512 = "91c202dca064909b2c56522f98e3a3b24bc5d43405506b4e67923ecb5d0cc2b78dcee8d815f705d71395402f8532670a391777a3cf6a08894049e453becf07a0"; }; +"@esbuild/darwin-arm64@npm:0.21.5" = { filename = "@esbuild-darwin-arm64-npm-0.21.5-62349c1520-8.zip"; sha512 = "50d5d633be3d0fe0fce54c4740171ae6d2e8f5220280a6f6996f234c718de25535e50a31cee1745b5b80f2cc9e336c42c7fc2b49f3ea38b5f3ff5d8c97ef4123"; }; "@eslint/eslintrc@npm:0.4.3" = { filename = "@eslint-eslintrc-npm-0.4.3-ee1bbcab87-03a7704150.zip"; sha512 = "03a7704150b868c318aab6a94d87a33d30dc2ec579d27374575014f06237ba1370ae11178db772f985ef680d469dc237e7b16a1c5d8edaaeb8c3733e7a95a6d3"; }; "@ethereumjs/common@npm:4.4.0" = { filename = "@ethereumjs-common-npm-4.4.0-ee991f5124-6b8cbfcfb5.zip"; sha512 = "6b8cbfcfb5bdde839545c89dce3665706733260e26455d0eb3bcbc3c09e371ae629d51032b95d86f2aeeb15325244a6622171f9005165266fefd923eaa99f1c5"; }; "@ethereumjs/rlp@npm:5.0.2" = { filename = "@ethereumjs-rlp-npm-5.0.2-72fb389b37-b569061ddb.zip"; sha512 = "b569061ddb1f4cf56a82f7a677c735ba37f9e94e2bbaf567404beb9e2da7aa1f595e72fc12a17c61f7aec67fd5448443efe542967c685a2fe0ffc435793dcbab"; }; @@ -1461,6 +1461,8 @@ cacheEntries = { "fs.realpath@npm:1.0.0" = { filename = "fs.realpath-npm-1.0.0-c8f05d8126-99ddea01a7.zip"; sha512 = "99ddea01a7e75aa276c250a04eedeffe5662bce66c65c07164ad6264f9de18fb21be9433ead460e54cff20e31721c811f4fb5d70591799df5f85dce6d6746fd0"; }; "fsevents@npm:2.3.2" = { filename = "fsevents-npm-2.3.2-a881d6ac9f-97ade64e75.zip"; sha512 = "97ade64e75091afee5265e6956cb72ba34db7819b4c3e94c431d4be2b19b8bb7a2d4116da417950c3425f17c8fe693d25e20212cac583ac1521ad066b77ae31f"; }; "fsevents@npm:2.3.3" = { filename = "fsevents-npm-2.3.3-ce9fb0ffae-11e6ea6fea.zip"; sha512 = "11e6ea6fea15e42461fc55b4b0e4a0a3c654faa567f1877dbd353f39156f69def97a69936d1746619d656c4b93de2238bf731f6085a03a50cabf287c9d024317"; }; +"fsevents@patch:fsevents@npm%3A2.3.2#~builtin::version=2.3.2&hash=18f3a7" = { filename = "fsevents-patch-3340e2eb10-8.zip"; sha512 = "edbd0fd80be379c14409605f77e52fdc78a119e17f875e8b90a220c3e5b29e54a1477c21d91fd30b957ea4866406dc3ff87b61432d2840ff8866b309e5866140"; }; +"fsevents@patch:fsevents@npm%3A2.3.3#~builtin::version=2.3.3&hash=18f3a7" = { filename = "fsevents-patch-7934e3c202-8.zip"; sha512 = "4639e24e2774cbd3669bd08521e0eeeb9d05bbabffdfdee418cc75a237660bc2fb30520a266ad5379199e2d657f430dd4236ad3642674ef32f20cc7258506725"; }; "ftp@npm:0.3.10" = { filename = "ftp-npm-0.3.10-348fb9ac23-ddd313c1d4.zip"; sha512 = "ddd313c1d44eb7429f3a7d77a0155dc8fe86a4c64dca58f395632333ce4b4e74c61413c6e0ef66ea3f3d32d905952fbb6d028c7117d522f793eb1fa282e17357"; }; "function-bind@npm:1.1.1" = { filename = "function-bind-npm-1.1.1-b56b322ae9-b32fbaebb3.zip"; sha512 = "b32fbaebb3f8ec4969f033073b43f5c8befbb58f1a79e12f1d7490358150359ebd92f49e72ff0144f65f2c48ea2a605bff2d07965f548f6474fd8efd95bf361a"; }; "function.prototype.name@npm:1.1.5" = { filename = "function.prototype.name-npm-1.1.5-e776a642bb-acd21d733a.zip"; sha512 = "acd21d733a9b649c2c442f067567743214af5fa248dbeee69d8278ce7df3329ea5abac572be9f7470b4ec1cd4d8f1040e3c5caccf98ebf2bf861a0deab735c27"; };