Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
Expand All @@ -56,7 +56,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
uses: github/codeql-action/autobuild@v3

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
Expand All @@ -70,4 +70,4 @@ jobs:
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v3
3 changes: 1 addition & 2 deletions packages/wallet-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
"eth",
"ethereum",
"wallet",
"walletlink",
"web3"
],
"type": "module",
Expand All @@ -24,7 +23,7 @@
"test": "vitest",
"test:coverage": "vitest --coverage",
"prebuild": "rm -rf ./dist && node -p \"'export const VERSION = \\'' + require('./package.json').version + '\\';\\nexport const NAME = \\'' + require('./package.json').name + '\\';'\" > src/sdk-info.ts",
"build": "node compile-assets.cjs && tsc -p ./tsconfig.build.json && tsc-alias && cp -a src/vendor-js dist && cp src/sign/walletlink/relay/connection/HeartbeatWorker.js dist/sign/walletlink/relay/connection/",
"build": "node compile-assets.cjs && tsc -p ./tsconfig.build.json && tsc-alias",
"dev": "yarn build && tsc --watch & nodemon --watch dist --delay 1 --exec tsc-alias",
"typecheck": "tsc --noEmit",
"lint": "biome lint .",
Expand Down
131 changes: 12 additions & 119 deletions packages/wallet-sdk/src/CoinbaseWalletProvider.test.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
import { CB_WALLET_RPC_URL } from ':core/constants.js';
import { standardErrorCodes } from ':core/error/constants.js';
import { standardErrors } from ':core/error/errors.js';
import { ProviderEventCallback, RequestArguments } from ':core/provider/interface.js';
import { RequestArguments } from ':core/provider/interface.js';
import { store } from ':store/store.js';
import { CoinbaseWalletProvider } from './CoinbaseWalletProvider.js';
import * as util from './sign/util.js';
import * as providerUtil from './util/provider.js';

function createProvider() {
Expand All @@ -18,28 +17,18 @@ const mockHandshake = vi.fn();
const mockRequest = vi.fn();
const mockCleanup = vi.fn();
const mockFetchRPCRequest = vi.fn();
const mockFetchSignerType = vi.spyOn(util, 'fetchSignerType');
const mockStoreSignerType = vi.spyOn(util, 'storeSignerType');
const mockLoadSignerType = vi.spyOn(util, 'loadSignerType');

let provider: CoinbaseWalletProvider;
let callback: ProviderEventCallback;

beforeEach(() => {
vi.resetAllMocks();
vi.spyOn(util, 'createSigner').mockImplementation((params) => {
callback = params.callback;
return {
accounts: ['0x123'],
chainId: 1,
handshake: mockHandshake,
request: mockRequest,
cleanup: mockCleanup,
};
});

vi.spyOn(providerUtil, 'fetchRPCRequest').mockImplementation(mockFetchRPCRequest);

provider = createProvider();
provider['signer'].request = mockRequest;
provider['signer'].handshake = mockHandshake;
provider['signer'].cleanup = mockCleanup;
});

describe('Event handling', () => {
Expand All @@ -58,8 +47,7 @@ describe('Event handling', () => {
const chainChangedListener = vi.fn();
provider.on('chainChanged', chainChangedListener);

await provider.request({ method: 'eth_requestAccounts' });
callback('chainChanged', '0x1');
provider['signer']?.['callback']?.('chainChanged', '0x1');

expect(chainChangedListener).toHaveBeenCalledWith('0x1');
});
Expand All @@ -68,8 +56,7 @@ describe('Event handling', () => {
const accountsChangedListener = vi.fn();
provider.on('accountsChanged', accountsChangedListener);

await provider.request({ method: 'eth_requestAccounts' });
callback('accountsChanged', ['0x123']);
provider['signer']?.['callback']?.('accountsChanged', ['0x123']);

expect(accountsChangedListener).toHaveBeenCalledWith(['0x123']);
});
Expand Down Expand Up @@ -103,123 +90,29 @@ describe('Request Handling', () => {
describe('Ephemeral methods', () => {
it('should post requests to wallet rpc url for wallet_getCallsStatus', async () => {
const args = { method: 'wallet_getCallsStatus' };
expect(provider['signer']).toBeNull();
await provider.request(args);
expect(mockFetchRPCRequest).toHaveBeenCalledWith(args, CB_WALLET_RPC_URL);
expect(provider['signer']).toBeNull();
});

it.each(['wallet_sendCalls', 'wallet_sign'])(
'should perform a successful request after handshake',
async (method) => {
const args = { method, params: ['0xdeadbeef'] };
expect(provider['signer']).toBeNull();
await provider.request(args);
expect(mockHandshake).toHaveBeenCalledWith({ method: 'handshake' });
expect(mockRequest).toHaveBeenCalledWith(args);
expect(mockCleanup).toHaveBeenCalled();
expect(provider['signer']).toBeNull();
}
);
});

describe('Signer configuration', () => {
it('should complete signerType selection correctly', async () => {
mockFetchSignerType.mockResolvedValue('scw');

const args = { method: 'eth_requestAccounts' };
await provider.request(args);
expect(mockHandshake).toHaveBeenCalledWith(args);
});

it('should support enable', async () => {
mockFetchSignerType.mockResolvedValue('scw');
vi.spyOn(console, 'warn').mockImplementation(() => {});

await provider.enable();
expect(mockHandshake).toHaveBeenCalledWith({ method: 'eth_requestAccounts' });
});

it('should pass handshake request args', async () => {
mockFetchSignerType.mockResolvedValue('scw');

const argsWithCustomParams = {
method: 'eth_requestAccounts',
params: [{ scwOnboardMode: 'create' }],
};
await provider.request(argsWithCustomParams);
expect(mockFetchSignerType).toHaveBeenCalledWith(
expect.objectContaining({
handshakeRequest: argsWithCustomParams,
})
);
});

it('should throw error if signer selection failed', async () => {
const error = new Error('Signer selection failed');
mockFetchSignerType.mockRejectedValue(error);

await expect(provider.request({ method: 'eth_requestAccounts' })).rejects.toMatchObject({
code: standardErrorCodes.rpc.internal,
message: error.message,
});
expect(mockHandshake).not.toHaveBeenCalled();
expect(mockStoreSignerType).not.toHaveBeenCalled();
});

it('should not store signer type unless handshake is successful', async () => {
const error = new Error('Handshake failed');
mockFetchSignerType.mockResolvedValue('scw');
mockHandshake.mockRejectedValue(error);

await expect(provider.request({ method: 'eth_requestAccounts' })).rejects.toMatchObject({
code: standardErrorCodes.rpc.internal,
message: error.message,
});
expect(mockHandshake).toHaveBeenCalled();
expect(mockStoreSignerType).not.toHaveBeenCalled();
});

it('should load signer from storage when available', async () => {
mockLoadSignerType.mockReturnValue('scw');
const providerLoadedFromStorage = createProvider();

await providerLoadedFromStorage.request({ method: 'eth_requestAccounts' });
expect(mockHandshake).not.toHaveBeenCalled();

const request = { method: 'personal_sign', params: ['0x123', '0xdeadbeef'] };
await providerLoadedFromStorage.request(request);
expect(mockRequest).toHaveBeenCalledWith(request);

await providerLoadedFromStorage.disconnect();
expect(mockCleanup).toHaveBeenCalled();
expect(provider['signer']).toBeNull();
});

it('should throw error if signer is not initialized', async () => {
await expect(provider.request({ method: 'personal_sign' })).rejects.toMatchObject({
code: standardErrorCodes.provider.unauthorized,
message: `Must call 'eth_requestAccounts' before other methods`,
describe('Auto sub account', () => {
it('call handshake without method when enableAutoSubAccounts is true', async () => {
vi.spyOn(store.subAccountsConfig, 'get').mockReturnValue({
enableAutoSubAccounts: true,
});
});

it('should set signer to null', async () => {
await provider.request({ method: 'eth_requestAccounts' });

await provider.disconnect();
expect(mockCleanup).toHaveBeenCalled();
expect(provider['signer']).toBeNull();
});

describe('Auto sub account', () => {
it('call handshake without method when enableAutoSubAccounts is true', async () => {
mockLoadSignerType.mockReturnValue('scw');
vi.spyOn(store.subAccountsConfig, 'get').mockReturnValue({
enableAutoSubAccounts: true,
});

await provider.request({ method: 'eth_requestAccounts' });
expect(mockHandshake).toHaveBeenCalledWith({ method: 'handshake' });
});
expect(mockHandshake).toHaveBeenCalledWith({ method: 'handshake' });
});
});
Loading