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
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@snapshot-labs/snapshot.js",
"version": "0.14.12",
"version": "0.14.13",
"repository": "snapshot-labs/snapshot.js",
"license": "MIT",
"main": "dist/snapshot.cjs.js",
Expand Down
24 changes: 16 additions & 8 deletions src/verify/starknet.spec.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { test, expect, describe } from 'vitest';
import starknetMessage from '../../test/fixtures/starknet/message-alias.json';
import starknetMessageRsv from '../../test/fixtures/starknet/message-alias-rsv.json';
import starknetMessageMultisigner from '../../test/fixtures/starknet/message-alias-multisigner.json';
import starknetMessageBraavos from '../../test/fixtures/starknet/message-alias-braavos.json';
import starknetMessageArgentXGuardian from '../../test/fixtures/starknet/message-alias-argent-x-guardian.json';
import starknetMessageArgentXStandard from '../../test/fixtures/starknet/message-alias-argent-x-standard.json';
import starknetMessageArgentXMultisig from '../../test/fixtures/starknet/message-alias-argent-x-multisig.json';
import verify, { getHash } from './starknet';
import { validateAndParseAddress } from 'starknet';
import { clone } from '../utils';
Expand All @@ -25,10 +27,16 @@ describe('verify/starknet', () => {

describe('verify()', () => {
describe.each([
['2 items', starknetMessage, false],
['3 items', starknetMessageRsv, false],
['multiple signers', starknetMessageMultisigner, true]
])('with a %s signature', (title, message, multisign) => {
['2 items (legacy)', starknetMessage, false],
['Braavos', starknetMessageBraavos, false],
['Argent X standard account', starknetMessageArgentXStandard],
[
'Argent X account with guardian/Argent X Mobile/Argent Web',
starknetMessageArgentXGuardian,
true
],
['Argent X multisig account', starknetMessageArgentXMultisig, true]
])('with a %s signature', (_, message, multisign = false) => {
test('should return true if the signature is valid', () => {
expect(
verify(message.address, message.sig, message.data, 'SN_MAIN')
Expand Down Expand Up @@ -102,10 +110,10 @@ describe('verify/starknet', () => {
).resolves.toBe(false);
});

test('should throw an error on wrong signature length', () => {
test('should return false when the signature is not valid', () => {
expect(
verify(starknetMessage.address, ['1'], starknetMessage.data, 'SN_MAIN')
).rejects.toThrowError('Invalid signature format');
).resolves.toBe(false);
});
});
});
81 changes: 7 additions & 74 deletions src/verify/starknet.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { Contract, RpcProvider, typedData, constants } from 'starknet';
import { BigNumber } from '@ethersproject/bignumber';
import { RpcProvider, typedData, constants, TypedData } from 'starknet';
import networks from '../networks.json';
import type { SignaturePayload } from '.';
import type { ProviderOptions } from '../utils/provider';
import type { SignaturePayload } from '.';

export type NetworkType = 'SN_MAIN' | 'SN_SEPOLIA';

Expand All @@ -11,35 +10,6 @@ const RPC_URLS: Record<NetworkType, string> = {
SN_SEPOLIA: networks[constants.StarknetChainId.SN_SEPOLIA]?.rpc?.[0]
};

const ABI = [
{
name: 'argent::common::account::IAccount',
type: 'interface',
items: [
{
name: 'is_valid_signature',
type: 'function',
inputs: [
{
name: 'hash',
type: 'core::felt252'
},
{
name: 'signature',
type: 'core::array::Array::<core::felt252>'
}
],
outputs: [
{
type: 'core::felt252'
}
],
state_mutability: 'view'
}
]
}
];

function getProvider(network: NetworkType, options: ProviderOptions) {
if (!RPC_URLS[network]) throw new Error('Invalid network');

Expand All @@ -62,38 +32,6 @@ export function getHash(data: SignaturePayload, address: string): string {
);
}

/**
* Processes a StarkNet signature array and returns the appropriate signature format
* for contract verification.
* Returns the r ands values for each signature in the array.
*
* Handles the following cases:
* - 2-item array: Standard signature, returns as-is.
* - 3-item array: Some wallets (e.g., Braavos) may return a 3-item array; returns the last two items.
* - Multi-signer array: For multisig accounts, the array may contain multiple signatures;
* this function extracts the relevant signature pairs.
*
* @param {string[]} sig - The signature array to process. Must have at least 2 items.
* @returns {string[]} The processed signature array suitable for contract verification.
* @throws {Error} If the signature array has fewer than 2 items.
*/
function getSignatureArray(sig: string[]): string[] {
if (sig.length < 2) {
throw new Error('Invalid signature format');
}

if (sig.length <= 3) {
return sig.slice(-2);
}

const results: string[] = [];
for (let i = 1; i < sig.length; i += 4) {
results.push(sig[i + 2], sig[i + 3]);
}

return results;
}

export default async function verify(
address: string,
sig: string[],
Expand All @@ -102,18 +40,13 @@ export default async function verify(
options: ProviderOptions = {}
): Promise<boolean> {
try {
const contractAccount = new Contract(
ABI,
address,
getProvider(network, options)
);
const provider = getProvider(network, options);

const result = await contractAccount.is_valid_signature(
getHash(data, address),
getSignatureArray(sig)
);
// Check if the contract is deployed
// Will throw on non-deployed contract
await provider.getClassAt(address);

return BigNumber.from(result).eq(BigNumber.from('370462705988'));
return provider.verifyMessageInStarknet(data as TypedData, sig, address);
} catch (e: any) {
if (e.message.includes('Contract not found')) {
throw new Error('Contract not deployed');
Expand Down
36 changes: 36 additions & 0 deletions test/fixtures/starknet/message-alias-argent-x-multisig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"address": "0x05977ec151436a7290854c6c83448636339462a5bd9340b295eaf44e3a3bfa20",
"sig": [
"0x4dde5f40c8177543399c05703c990da27a6ab2408bddba2ac7813949e98476",
"0x3d0a7c26c632b9f487defaa20d9548c7f3741f9f9451f8b3c5365563b18a568",
"0x77b86678813dae3c95eb323d148c0f1ef53fd6c7aa06d49d41d99aea3713f27",
"0x42d67ca394167c85130ab3926b5f1602c0524a7fdbaef363d2b8fe7fd622ae5",
"0x39cff221f4d26c04afc8c6616be3a908aee3a97d0c59a51c80b77edb29bdc71",
"0x4805ddc85b7b9996a17ec97ee85874af17aa5e12be540454e189558aac53c53"
],
"data": {
"domain": {
"name": "sx-starknet",
"version": "0.1.0",
"chainId": "0x534e5f4d41494e"
},
"types": {
"StarkNetDomain": [
{ "name": "name", "type": "felt" },
{ "name": "version", "type": "felt" },
{ "name": "chainId", "type": "felt" }
],
"SetAlias": [
{ "name": "from", "type": "felt" },
{ "name": "alias", "type": "felt" },
{ "name": "timestamp", "type": "felt" }
]
},
"message": {
"alias": "0x32FAB6De2e099496665D63508b0b8F5A5CA0546b",
"from": "0x05977ec151436a7290854c6c83448636339462a5bd9340b295eaf44e3a3bfa20",
"timestamp": 1758049155
},
"primaryType": "SetAlias"
}
}
35 changes: 35 additions & 0 deletions test/fixtures/starknet/message-alias-argent-x-standard.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"address": "0x02a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0",
"sig": [
"0x1",
"0x0",
"0x63ff788b6ee579bf9e5d62a6d6d7afc55b97738b1acc66a8b0aa90cc667846c",
"0x6b3f165e57e468bc4717d959da94cd87eb45b69e6ad52560f30e074ab5f4527",
"0x502b5a9defdf465a45079fca7f1b279699e93ce457c4333feb23e95769f1e2a"
],
"data": {
"domain": {
"name": "sx-starknet",
"version": "0.1.0",
"chainId": "0x534e5f4d41494e"
},
"types": {
"StarkNetDomain": [
{ "name": "name", "type": "felt" },
{ "name": "version", "type": "felt" },
{ "name": "chainId", "type": "felt" }
],
"SetAlias": [
{ "name": "from", "type": "felt" },
{ "name": "alias", "type": "felt" },
{ "name": "timestamp", "type": "felt" }
]
},
"message": {
"alias": "0xe424921CEa28a0852B81757542E1Ff0aA87806EE",
"from": "0x02a0a8f3b6097e7a6bd7649deb30715323072a159c0e6b71b689bd245c146cc0",
"timestamp": 1758049460
},
"primaryType": "SetAlias"
}
}