Verify validator script (#768)
* cleanup pkg * first pass on validator verification * fixes for s3 clients * script fixes * cleanup * fix time calcs * fix pkg * reduce calls required * cleanup * drop oldest time delta * only stop after missing 10 that the control has * cleanup * more forgiving regex * remove useless try/catch * more verbose var names * exit on invalid latest checkpointpull/772/head
Mattie Conover
2 years ago
committed by
GitHub
parent
75b116cd56
commit
2769c4b357
@ -0,0 +1,304 @@ |
||||
import { GetObjectCommand, S3Client } from '@aws-sdk/client-s3'; |
||||
import yargs from 'yargs'; |
||||
|
||||
const MAX_MISSING_CHECKPOINTS = 10; |
||||
|
||||
interface Checkpoint { |
||||
checkpoint: { |
||||
outbox_domain: number; |
||||
root: string; |
||||
index: number; |
||||
}; |
||||
signature: { |
||||
r: string; |
||||
s: string; |
||||
v: number; |
||||
}; |
||||
} |
||||
|
||||
function isCheckpoint(obj: unknown): obj is Checkpoint { |
||||
const c = obj as Partial<Checkpoint>; |
||||
return ( |
||||
typeof obj == 'object' && |
||||
obj != null && |
||||
'checkpoint' in obj && |
||||
Number.isSafeInteger(c.checkpoint?.outbox_domain) && |
||||
Number.isSafeInteger(c.checkpoint?.index) && |
||||
isValidHashStr(c.checkpoint?.root ?? '') && |
||||
'signature' in obj && |
||||
isValidHashStr(c.signature?.r ?? '') && |
||||
isValidHashStr(c.signature?.s ?? '') && |
||||
Number.isSafeInteger(c.signature?.v) |
||||
); |
||||
} |
||||
|
||||
function isLatestCheckpoint(latest: unknown): latest is number { |
||||
if (typeof latest == 'number' && Number.isSafeInteger(latest) && latest > 0) { |
||||
return true; |
||||
} else { |
||||
console.log( |
||||
'Expected latest checkpoint to be a valid integer greater than 0', |
||||
latest, |
||||
); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
function isValidHashStr(s: string): boolean { |
||||
return !!s.match(/^0x[0-9a-f]{1,64}$/im); |
||||
} |
||||
|
||||
function getArgs() { |
||||
return yargs(process.argv.slice(2)) |
||||
.alias('a', 'address') |
||||
.describe('a', 'address of the validator to inspect') |
||||
.demandOption('a') |
||||
.string('a') |
||||
.alias('p', 'prospective') |
||||
.describe('p', 'S3 bucket of the prospective validator') |
||||
.demandOption('p') |
||||
.string('p') |
||||
.alias('c', 'control') |
||||
.describe('c', 'S3 bucket of the the known (control) validator') |
||||
.demandOption('c') |
||||
.string('c').argv; |
||||
} |
||||
|
||||
class S3Wrapper { |
||||
private readonly client: S3Client; |
||||
readonly region: string; |
||||
readonly bucket: string; |
||||
|
||||
constructor(bucketUrl: string) { |
||||
const match = bucketUrl.match( |
||||
/^(?:https?:\/\/)?(.*)\.s3\.(.*)\.amazonaws.com\/?$/, |
||||
); |
||||
if (!match) throw new Error('Could not parse bucket url'); |
||||
this.bucket = match[1]; |
||||
this.region = match[2]; |
||||
this.client = new S3Client({ region: this.region }); |
||||
} |
||||
|
||||
async getS3Obj<T = unknown>( |
||||
key: string, |
||||
): Promise<{ obj: T; modified: Date }> { |
||||
const response = await this.client.send( |
||||
new GetObjectCommand({ |
||||
Bucket: this.bucket, |
||||
Key: key, |
||||
}), |
||||
); |
||||
if (!response.Body) { |
||||
throw new Error('No data received'); |
||||
} |
||||
const bodyStream: NodeJS.ReadableStream = |
||||
'stream' in response.Body |
||||
? response.Body.stream() |
||||
: (response.Body as NodeJS.ReadableStream); |
||||
|
||||
const body: string = await streamToString(bodyStream); |
||||
return { |
||||
obj: JSON.parse(body), |
||||
modified: response.LastModified!, |
||||
}; |
||||
} |
||||
} |
||||
|
||||
async function main() { |
||||
const { |
||||
a: _validatorAddress, |
||||
p: prospectiveBucket, |
||||
c: controlBucket, |
||||
} = await getArgs(); |
||||
|
||||
const cClient = new S3Wrapper(controlBucket); |
||||
const pClient = new S3Wrapper(prospectiveBucket); |
||||
|
||||
const [{ obj: controlLatestCheckpoint }, { obj: prospectiveLastCheckpoint }] = |
||||
await Promise.all([ |
||||
cClient.getS3Obj<number>('checkpoint_latest_index.json').catch((err) => { |
||||
console.error( |
||||
"Failed to get control validator's latest checkpoint.", |
||||
err, |
||||
); |
||||
process.exit(1); |
||||
}), |
||||
pClient.getS3Obj<number>('checkpoint_latest_index.json').catch((err) => { |
||||
console.error( |
||||
"Failed to get prospective validator's latest checkpoint.", |
||||
err, |
||||
); |
||||
process.exit(1); |
||||
}), |
||||
]); |
||||
|
||||
if ( |
||||
!isLatestCheckpoint(controlLatestCheckpoint) || |
||||
!isLatestCheckpoint(prospectiveLastCheckpoint) |
||||
) |
||||
process.exit(1); |
||||
|
||||
console.log(`Latest Index`); |
||||
console.log(`control: ${controlLatestCheckpoint}`); |
||||
console.log(`prospective: ${prospectiveLastCheckpoint}\n`); |
||||
|
||||
let extraCheckpoints = []; |
||||
const missingCheckpoints = []; |
||||
let invalidCheckpoints = []; |
||||
const modTimeDeltasS = []; |
||||
const fullyCorrectCheckpoints = []; |
||||
let missingInARow = 0; |
||||
let lastNonMissingCheckpointIndex = Infinity; |
||||
for ( |
||||
let i = Math.max(controlLatestCheckpoint, prospectiveLastCheckpoint); |
||||
i >= 0; |
||||
--i |
||||
) { |
||||
if (missingInARow == MAX_MISSING_CHECKPOINTS) { |
||||
missingCheckpoints.length -= MAX_MISSING_CHECKPOINTS; |
||||
invalidCheckpoints = invalidCheckpoints.filter( |
||||
(j) => j < lastNonMissingCheckpointIndex, |
||||
); |
||||
extraCheckpoints = extraCheckpoints.filter( |
||||
(j) => j < lastNonMissingCheckpointIndex, |
||||
); |
||||
break; |
||||
} |
||||
|
||||
const key = `checkpoint_${i}.json`; |
||||
|
||||
let control: Checkpoint | null; |
||||
let controlLastMod: Date | null; |
||||
try { |
||||
const t = await cClient.getS3Obj(key); |
||||
if (isCheckpoint(t.obj)) { |
||||
if (t.obj.checkpoint.index != i) { |
||||
console.log(`${i}: Control index is invalid`, t); |
||||
process.exit(1); |
||||
} |
||||
[control, controlLastMod] = [t.obj, t.modified]; |
||||
} else { |
||||
console.log(`${i}: Invalid control checkpoint`, t); |
||||
process.exit(1); |
||||
} |
||||
} catch (err) { |
||||
control = controlLastMod = null; |
||||
} |
||||
|
||||
let prospective: Checkpoint; |
||||
let prospectiveLastMod: Date; |
||||
try { |
||||
const t = await pClient.getS3Obj(key); |
||||
if (isCheckpoint(t.obj)) { |
||||
[prospective, prospectiveLastMod] = [t.obj, t.modified]; |
||||
lastNonMissingCheckpointIndex = i; |
||||
} else { |
||||
console.log(`${i}: Invalid prospective checkpoint`, t.obj); |
||||
invalidCheckpoints.push(i); |
||||
continue; |
||||
} |
||||
if (!control) { |
||||
extraCheckpoints.push(i); |
||||
} |
||||
missingInARow = 0; |
||||
} catch (err) { |
||||
if (control) { |
||||
missingCheckpoints.push(i); |
||||
missingInARow++; |
||||
} |
||||
continue; |
||||
} |
||||
|
||||
console.assert( |
||||
prospective.checkpoint.index == i, |
||||
`${i}: checkpoint indexes do not match`, |
||||
); |
||||
|
||||
// TODO: verify signature
|
||||
|
||||
if (!control) { |
||||
continue; |
||||
} |
||||
|
||||
// compare against the control
|
||||
console.assert( |
||||
control.checkpoint.outbox_domain == prospective.checkpoint.outbox_domain, |
||||
`${i}: outbox_domains do not match`, |
||||
); |
||||
console.assert( |
||||
control.checkpoint.root == prospective.checkpoint.root, |
||||
`${i}: checkpoint roots do not match`, |
||||
); |
||||
|
||||
const diffS = |
||||
(prospectiveLastMod.valueOf() - controlLastMod!.valueOf()) / 1000; |
||||
if (Math.abs(diffS) > 10) { |
||||
console.log(`${i}: Modification times differ by ${diffS}s`); |
||||
} |
||||
modTimeDeltasS.push(diffS); |
||||
fullyCorrectCheckpoints.push(i); |
||||
} |
||||
|
||||
console.log( |
||||
`Fully correct checkpoints (${fullyCorrectCheckpoints.length}): ${fullyCorrectCheckpoints}\n`, |
||||
); |
||||
if (extraCheckpoints.length) |
||||
console.log( |
||||
`Extra checkpoints (${extraCheckpoints.length}): ${extraCheckpoints}\n`, |
||||
); |
||||
if (missingCheckpoints.length) |
||||
console.log( |
||||
`Missing checkpoints (${missingCheckpoints.length}): ${missingCheckpoints}\n`, |
||||
); |
||||
if (invalidCheckpoints.length) |
||||
console.log( |
||||
`Invalid checkpoints (${invalidCheckpoints.length}): ${invalidCheckpoints}\n`, |
||||
); |
||||
|
||||
if (modTimeDeltasS.length > 1) { |
||||
// Drop the time of the first one since it is probably way off
|
||||
modTimeDeltasS.length--; |
||||
console.log( |
||||
`Time deltas (∆ < 0 -> prospective came earlier than the control)`, |
||||
); |
||||
console.log(modTimeDeltasS); |
||||
console.log(`Median: ${median(modTimeDeltasS)}s`); |
||||
console.log(`Mean: ${mean(modTimeDeltasS)}s`); |
||||
console.log(`Stdev: ${stdDev(modTimeDeltasS)}s`); |
||||
} |
||||
} |
||||
|
||||
function median(a: number[]): number { |
||||
a = [...a]; // clone
|
||||
a.sort((a, b) => a - b); |
||||
if (a.length <= 0) { |
||||
return 0; |
||||
} else if (a.length % 2 == 0) { |
||||
return (a[a.length / 2] + a[a.length / 2 - 1]) / 2; |
||||
} else { |
||||
return a[(a.length - 1) / 2]; |
||||
} |
||||
} |
||||
|
||||
function mean(a: number[]): number { |
||||
return a.reduce((acc, i) => acc + i, 0) / a.length; |
||||
} |
||||
|
||||
function stdDev(a: number[]): number { |
||||
return Math.sqrt( |
||||
a.map((i) => i * i).reduce((acc, i) => acc + i, 0) / a.length, |
||||
); |
||||
} |
||||
|
||||
function streamToString(stream: NodeJS.ReadableStream): Promise<string> { |
||||
return new Promise((resolve, reject) => { |
||||
const chunks: string[] = []; |
||||
stream |
||||
.setEncoding('utf8') |
||||
.on('data', (chunk) => chunks.push(chunk)) |
||||
.on('error', (err) => reject(err)) |
||||
.on('end', () => resolve(String.prototype.concat(...chunks))); |
||||
}); |
||||
} |
||||
|
||||
main().catch(console.error); |
||||
Loading…
Reference in new issue