Skip to content

fix: handle Coinbase webhook post-verification crashes gracefully #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GsCommand merged 1 commit into from
May 23, 2026
Merged

fix: handle Coinbase webhook post-verification crashes gracefully #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 22 additions & 7 deletions api/examples/coinbase-webhook.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,16 @@ const seenReceipts = new Map();


function normalizeReceipt(event, signerId) {
const eventId = event?.id || event?.event_id || 'unknown';
const eventType = event?.type || 'coinbase.unknown';
if (!event || typeof event !== 'object' || Array.isArray(event)) {
throw new Error('unsupported_event_shape');
}

const eventId = event.id || event.event_id;
const eventType = event.type;
if (!eventId || typeof eventId !== 'string' || !eventType || typeof eventType !== 'string') {
throw new Error('unsupported_event_shape');
}

const txHash = event?.data?.transactionHash || event?.transactionHash || null;
return {
receipt_id: `rcpt:coinbase_cdp:${eventId}`,
Expand Down Expand Up @@ -77,18 +85,25 @@ module.exports = async function handler(req, res) {

const eventId = verified.event?.id || verified.event?.event_id;
if (!eventId) {
return res.status(400).json({ ok: false, status: 'malformed_payload' });
return res.status(400).json({ ok: false, status: 'normalization_failed' });
}

if (seenReceipts.has(eventId)) {
return res.status(200).json({ ok: true, status: 'WEBHOOK_VERIFIED_AND_SIGNED', duplicate: true, receipt: seenReceipts.get(eventId) });
}

const unsignedReceipt = normalizeReceipt(verified.event, signingCfg.signerId);
const receipt = await signReceipt(unsignedReceipt, signingCfg);
try {
const unsignedReceipt = normalizeReceipt(verified.event, signingCfg.signerId);
const receipt = await signReceipt(unsignedReceipt, signingCfg);

seenReceipts.set(eventId, receipt);
return res.status(200).json({ ok: true, status: 'WEBHOOK_VERIFIED_AND_SIGNED', duplicate: false, receipt });
seenReceipts.set(eventId, receipt);
return res.status(200).json({ ok: true, status: 'WEBHOOK_VERIFIED_AND_SIGNED', duplicate: false, receipt });
} catch (error) {
if (error && error.message === 'unsupported_event_shape') {
return res.status(400).json({ ok: false, status: 'normalization_failed' });
}
return res.status(503).json({ ok: false, status: 'signing_unavailable' });
}
};

module.exports._internal = {
Expand Down
36 changes: 36 additions & 0 deletions tests/api-coinbase-webhook.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,42 @@ test('missing signing env returns 503 after valid HMAC', async () => {
assert.equal(res.body.status, 'signing_unavailable');
});


test('invalid base64 signing key after valid HMAC returns 503', async () => {
process.env.COINBASE_WEBHOOK_SECRET = 'test_secret';
process.env.RECEIPT_SIGNER_ID = 'runtime.commandlayer.eth';
process.env.RECEIPT_SIGNING_KID = 'test-kid-bad';
process.env.RECEIPT_SIGNING_PRIVATE_KEY_PEM_B64 = Buffer.from('not a pem', 'utf8').toString('base64');

const rawBody = JSON.stringify({ id: 'evt_bad_key', type: 'wallet.transaction' });
const timestamp = Math.floor(Date.now() / 1000);
const headers = { 'content-type': 'application/json' };
const sig = signHook({ secret: process.env.COINBASE_WEBHOOK_SECRET, timestamp, headers, rawBody });

const res = makeRes();
await handler({ method: 'POST', headers: { ...headers, 'x-hook0-signature': sig }, body: rawBody }, res);
assert.equal(res.statusCode, 503);
assert.equal(res.body.status, 'signing_unavailable');
});

test('malformed event shape after valid HMAC returns 400 normalization_failed', async () => {
process.env.COINBASE_WEBHOOK_SECRET = 'test_secret';
process.env.CL_RECEIPT_SIGNER_ID = 'runtime.commandlayer.eth';
process.env.CL_RECEIPT_SIGNING_KID = 'test-kid-shape';
const { privateKey } = crypto.generateKeyPairSync('ed25519');
process.env.CL_RECEIPT_SIGNING_PRIVATE_KEY_PEM = privateKey.export({ type: 'pkcs8', format: 'pem' });

const rawBody = JSON.stringify({ id: 'evt_bad_shape' });
const timestamp = Math.floor(Date.now() / 1000);
const headers = { 'content-type': 'application/json' };
const sig = signHook({ secret: process.env.COINBASE_WEBHOOK_SECRET, timestamp, headers, rawBody });

const res = makeRes();
await handler({ method: 'POST', headers: { ...headers, 'x-hook0-signature': sig }, body: rawBody }, res);
assert.equal(res.statusCode, 400);
assert.equal(res.body.status, 'normalization_failed');
});

test('valid payload returns signed receipt and duplicate returns same receipt', async () => {
process.env.COINBASE_WEBHOOK_SECRET = 'test_secret';
process.env.CL_RECEIPT_SIGNER_ID = 'runtime.commandlayer.eth';
Expand Down
Loading