@libp2p/utils 5.3.2-3bc94b403 → 5.3.2-3d7a9da17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/{bloom-filter.d.ts → filters/bloom-filter.d.ts} +7 -6
- package/dist/src/filters/bloom-filter.d.ts.map +1 -0
- package/dist/src/{bloom-filter.js → filters/bloom-filter.js} +11 -11
- package/dist/src/filters/bloom-filter.js.map +1 -0
- package/dist/src/filters/bucket.d.ts +10 -0
- package/dist/src/filters/bucket.d.ts.map +1 -0
- package/dist/src/filters/bucket.js +53 -0
- package/dist/src/filters/bucket.js.map +1 -0
- package/dist/src/filters/cuckoo-filter.d.ts +41 -0
- package/dist/src/filters/cuckoo-filter.d.ts.map +1 -0
- package/dist/src/filters/cuckoo-filter.js +134 -0
- package/dist/src/filters/cuckoo-filter.js.map +1 -0
- package/dist/src/filters/fingerprint.d.ts +11 -0
- package/dist/src/filters/fingerprint.d.ts.map +1 -0
- package/dist/src/filters/fingerprint.js +34 -0
- package/dist/src/filters/fingerprint.js.map +1 -0
- package/dist/src/filters/hashes.d.ts +8 -0
- package/dist/src/filters/hashes.d.ts.map +1 -0
- package/dist/src/filters/hashes.js +29 -0
- package/dist/src/filters/hashes.js.map +1 -0
- package/dist/src/filters/index.d.ts +9 -0
- package/dist/src/filters/index.d.ts.map +1 -0
- package/dist/src/filters/index.js +4 -0
- package/dist/src/filters/index.js.map +1 -0
- package/dist/src/filters/scalable-cuckoo-filter.d.ts +24 -0
- package/dist/src/filters/scalable-cuckoo-filter.d.ts.map +1 -0
- package/dist/src/filters/scalable-cuckoo-filter.js +87 -0
- package/dist/src/filters/scalable-cuckoo-filter.js.map +1 -0
- package/dist/src/filters/utils.d.ts +2 -0
- package/dist/src/filters/utils.d.ts.map +1 -0
- package/dist/src/filters/utils.js +4 -0
- package/dist/src/filters/utils.js.map +1 -0
- package/package.json +10 -9
- package/src/{bloom-filter.ts → filters/bloom-filter.ts} +14 -13
- package/src/filters/bucket.ts +64 -0
- package/src/filters/cuckoo-filter.ts +197 -0
- package/src/filters/fingerprint.ts +44 -0
- package/src/filters/hashes.ts +38 -0
- package/src/filters/index.ts +9 -0
- package/src/filters/scalable-cuckoo-filter.ts +111 -0
- package/src/filters/utils.ts +3 -0
- package/dist/src/bloom-filter.d.ts.map +0 -1
- package/dist/src/bloom-filter.js.map +0 -1
|
@@ -1,14 +1,10 @@
|
|
|
1
|
+
import type { Filter } from './index.js';
|
|
1
2
|
export interface BloomFilterOptions {
|
|
2
3
|
seeds?: number[];
|
|
3
4
|
hashes?: number;
|
|
4
5
|
bits?: number;
|
|
5
6
|
}
|
|
6
|
-
export declare class BloomFilter {
|
|
7
|
-
/**
|
|
8
|
-
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
9
|
-
* specified item count and error rate.
|
|
10
|
-
*/
|
|
11
|
-
static create(itemcount: number, errorRate?: number): BloomFilter;
|
|
7
|
+
export declare class BloomFilter implements Filter {
|
|
12
8
|
readonly seeds: number[];
|
|
13
9
|
readonly bits: number;
|
|
14
10
|
buffer: Uint8Array;
|
|
@@ -30,4 +26,9 @@ export declare class BloomFilter {
|
|
|
30
26
|
setbit(bit: number): void;
|
|
31
27
|
getbit(bit: number): boolean;
|
|
32
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
31
|
+
* specified item count and error rate.
|
|
32
|
+
*/
|
|
33
|
+
export declare function createBloomFilter(itemcount: number, errorRate?: number): Filter;
|
|
33
34
|
//# sourceMappingURL=bloom-filter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bloom-filter.d.ts","sourceRoot":"","sources":["../../../src/filters/bloom-filter.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qBAAa,WAAY,YAAW,MAAM;IACxC,SAAgB,KAAK,EAAE,MAAM,EAAE,CAAA;IAC/B,SAAgB,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;gBAEZ,OAAO,GAAE,kBAAuB;IAW7C;;OAEG;IACH,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI;IAarC;;;;OAIG;IACH,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAmBxC;;OAEG;IACH,KAAK,IAAK,IAAI;IAId,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAa1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAW9B;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAE,SAAS,EAAE,MAAM,EAAE,SAAS,GAAE,MAAc,GAAG,MAAM,CAGvF"}
|
|
@@ -6,14 +6,6 @@ import { alloc } from 'uint8arrays/alloc';
|
|
|
6
6
|
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
|
|
7
7
|
const LN2_SQUARED = Math.LN2 * Math.LN2;
|
|
8
8
|
export class BloomFilter {
|
|
9
|
-
/**
|
|
10
|
-
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
11
|
-
* specified item count and error rate.
|
|
12
|
-
*/
|
|
13
|
-
static create(itemcount, errorRate = 0.005) {
|
|
14
|
-
const opts = optimize(itemcount, errorRate);
|
|
15
|
-
return new BloomFilter(opts);
|
|
16
|
-
}
|
|
17
9
|
seeds;
|
|
18
10
|
bits;
|
|
19
11
|
buffer;
|
|
@@ -87,9 +79,17 @@ export class BloomFilter {
|
|
|
87
79
|
return (bitfield & (0x1 << shift)) !== 0;
|
|
88
80
|
}
|
|
89
81
|
}
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
82
|
+
/**
|
|
83
|
+
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
84
|
+
* specified item count and error rate.
|
|
85
|
+
*/
|
|
86
|
+
export function createBloomFilter(itemcount, errorRate = 0.005) {
|
|
87
|
+
const opts = optimize(itemcount, errorRate);
|
|
88
|
+
return new BloomFilter(opts);
|
|
89
|
+
}
|
|
90
|
+
function optimize(itemCount, errorRate = 0.005) {
|
|
91
|
+
const bits = Math.round(-1 * itemCount * Math.log(errorRate) / LN2_SQUARED);
|
|
92
|
+
const hashes = Math.round((bits / itemCount) * Math.LN2);
|
|
93
93
|
return { bits, hashes };
|
|
94
94
|
}
|
|
95
95
|
function generateSeeds(count) {
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bloom-filter.js","sourceRoot":"","sources":["../../../src/filters/bloom-filter.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,GAAG,MAAM,yBAAyB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAG5E,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;AAQvC,MAAM,OAAO,WAAW;IACN,KAAK,CAAU;IACf,IAAI,CAAQ;IACrB,MAAM,CAAY;IAEzB,YAAa,UAA8B,EAAE;QAC3C,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAA;QACjD,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAA;IAC/C,CAAC;IAED;;OAEG;IACH,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAChD,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAE5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAClB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAChD,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAE9B,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,KAAK,GAAG,GAAG,CAAA;QACf,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,GAAG,EAAE,CAAA;YACL,KAAK,IAAI,CAAC,CAAA;QACZ,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC/B,QAAQ,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAA;IAC7B,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,KAAK,GAAG,GAAG,CAAA;QACf,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,GAAG,EAAE,CAAA;YACL,KAAK,IAAI,CAAC,CAAA;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACjC,OAAO,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAE,SAAiB,EAAE,YAAoB,KAAK;IAC7E,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;IAC3C,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;AAC9B,CAAC;AAED,SAAS,QAAQ,CAAE,SAAiB,EAAE,YAAoB,KAAK;IAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,CAAA;IAC3E,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;IAExD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AACzB,CAAC;AAED,SAAS,aAAa,CAAE,KAAa;IACnC,IAAI,GAAmB,CAAA;IACvB,IAAI,CAAS,CAAA;IACb,MAAM,KAAK,GAAG,EAAE,CAAA;IAEhB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,GAAG,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QACxC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;QAEjC,sDAAsD;QACtD,kCAAkC;QAClC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACvB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1B,CAAC,EAAE,CAAA;gBACH,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Fingerprint } from './fingerprint.js';
|
|
2
|
+
export declare class Bucket {
|
|
3
|
+
private readonly contents;
|
|
4
|
+
constructor(size: number);
|
|
5
|
+
has(fingerprint: Fingerprint): boolean;
|
|
6
|
+
add(fingerprint: Fingerprint): boolean;
|
|
7
|
+
swap(fingerprint: Fingerprint): Fingerprint | null;
|
|
8
|
+
remove(fingerprint: Fingerprint): boolean;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=bucket.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bucket.d.ts","sourceRoot":"","sources":["../../../src/filters/bucket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAG9C,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2B;gBAEvC,IAAI,EAAE,MAAM;IAIzB,GAAG,CAAE,WAAW,EAAE,WAAW,GAAG,OAAO;IAUvC,GAAG,CAAE,WAAW,EAAE,WAAW,GAAG,OAAO;IAevC,IAAI,CAAE,WAAW,EAAE,WAAW,GAAG,WAAW,GAAG,IAAI;IAYnD,MAAM,CAAE,WAAW,EAAE,WAAW,GAAG,OAAO;CAgB3C"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { Fingerprint } from './fingerprint.js';
|
|
2
|
+
import { getRandomInt } from './utils.js';
|
|
3
|
+
export class Bucket {
|
|
4
|
+
contents;
|
|
5
|
+
constructor(size) {
|
|
6
|
+
this.contents = new Array(size).fill(null);
|
|
7
|
+
}
|
|
8
|
+
has(fingerprint) {
|
|
9
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
10
|
+
throw new TypeError('Invalid Fingerprint');
|
|
11
|
+
}
|
|
12
|
+
return this.contents.some((fp) => {
|
|
13
|
+
return fingerprint.equals(fp);
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
add(fingerprint) {
|
|
17
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
18
|
+
throw new TypeError('Invalid Fingerprint');
|
|
19
|
+
}
|
|
20
|
+
for (let i = 0; i < this.contents.length; i++) {
|
|
21
|
+
if (this.contents[i] == null) {
|
|
22
|
+
this.contents[i] = fingerprint;
|
|
23
|
+
return true;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
return true;
|
|
27
|
+
}
|
|
28
|
+
swap(fingerprint) {
|
|
29
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
30
|
+
throw new TypeError('Invalid Fingerprint');
|
|
31
|
+
}
|
|
32
|
+
const i = getRandomInt(0, this.contents.length - 1);
|
|
33
|
+
const current = this.contents[i];
|
|
34
|
+
this.contents[i] = fingerprint;
|
|
35
|
+
return current;
|
|
36
|
+
}
|
|
37
|
+
remove(fingerprint) {
|
|
38
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
39
|
+
throw new TypeError('Invalid Fingerprint');
|
|
40
|
+
}
|
|
41
|
+
const found = this.contents.findIndex((fp) => {
|
|
42
|
+
return fingerprint.equals(fp);
|
|
43
|
+
});
|
|
44
|
+
if (found > -1) {
|
|
45
|
+
this.contents[found] = null;
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
else {
|
|
49
|
+
return false;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
//# sourceMappingURL=bucket.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bucket.js","sourceRoot":"","sources":["../../../src/filters/bucket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAEzC,MAAM,OAAO,MAAM;IACA,QAAQ,CAA2B;IAEpD,YAAa,IAAY;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5C,CAAC;IAED,GAAG,CAAE,WAAwB;QAC3B,IAAI,CAAC,CAAC,WAAW,YAAY,WAAW,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAA;QAC5C,CAAC;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;YAC/B,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,GAAG,CAAE,WAAwB;QAC3B,IAAI,CAAC,CAAC,WAAW,YAAY,WAAW,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAA;QAC5C,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;gBAC7B,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAAA;gBAC9B,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAE,WAAwB;QAC5B,IAAI,CAAC,CAAC,WAAW,YAAY,WAAW,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,CAAA;QAE9B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,CAAE,WAAwB;QAC9B,IAAI,CAAC,CAAC,WAAW,YAAY,WAAW,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE;YAC3C,OAAO,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAC/B,CAAC,CAAC,CAAA;QAEF,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YAC3B,OAAO,IAAI,CAAA;QACb,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAA;QACd,CAAC;IACH,CAAC;CACF"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { type Hash } from './hashes.js';
|
|
2
|
+
import type { Filter } from './index.js';
|
|
3
|
+
export interface CuckooFilterInit {
|
|
4
|
+
/**
|
|
5
|
+
* How many items the filter is expected to contain
|
|
6
|
+
*/
|
|
7
|
+
filterSize: number;
|
|
8
|
+
/**
|
|
9
|
+
* How many items to put in each bucket
|
|
10
|
+
*/
|
|
11
|
+
bucketSize?: number;
|
|
12
|
+
/**
|
|
13
|
+
* How many bytes the fingerprint is expected to be
|
|
14
|
+
*/
|
|
15
|
+
fingerprintSize?: number;
|
|
16
|
+
/**
|
|
17
|
+
* A non-cryptographic hash implementation
|
|
18
|
+
*/
|
|
19
|
+
hash?: Hash;
|
|
20
|
+
/**
|
|
21
|
+
* A number used to seed the hash
|
|
22
|
+
*/
|
|
23
|
+
seed?: number;
|
|
24
|
+
}
|
|
25
|
+
export declare class CuckooFilter implements Filter {
|
|
26
|
+
private readonly bucketSize;
|
|
27
|
+
private readonly filterSize;
|
|
28
|
+
private readonly fingerprintSize;
|
|
29
|
+
private readonly buckets;
|
|
30
|
+
count: number;
|
|
31
|
+
private readonly hash;
|
|
32
|
+
private readonly seed;
|
|
33
|
+
constructor(init: CuckooFilterInit);
|
|
34
|
+
add(item: Uint8Array | string): boolean;
|
|
35
|
+
has(item: Uint8Array | string): boolean;
|
|
36
|
+
remove(item: Uint8Array | string): boolean;
|
|
37
|
+
get reliable(): boolean;
|
|
38
|
+
}
|
|
39
|
+
export declare function optimize(maxItems: number, errorRate?: number): CuckooFilterInit;
|
|
40
|
+
export declare function createCuckooFilter(maxItems: number, errorRate?: number): Filter;
|
|
41
|
+
//# sourceMappingURL=cuckoo-filter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cuckoo-filter.d.ts","sourceRoot":"","sources":["../../../src/filters/cuckoo-filter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAS,KAAK,IAAI,EAAE,MAAM,aAAa,CAAA;AAE9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIxC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qBAAa,YAAa,YAAW,MAAM;IACzC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAC3B,KAAK,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;gBAEhB,IAAI,EAAE,gBAAgB;IAUnC,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAsDxC,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAkBxC,MAAM,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAwB3C,IAAI,QAAQ,IAAK,OAAO,CAEvB;CACF;AAsBD,wBAAgB,QAAQ,CAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAc,GAAG,gBAAgB,CAevF;AAED,wBAAgB,kBAAkB,CAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAc,GAAG,MAAM,CAGvF"}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
|
|
2
|
+
import { Bucket } from './bucket.js';
|
|
3
|
+
import { Fingerprint, MAX_FINGERPRINT_SIZE } from './fingerprint.js';
|
|
4
|
+
import { fnv1a } from './hashes.js';
|
|
5
|
+
import { getRandomInt } from './utils.js';
|
|
6
|
+
const maxCuckooCount = 500;
|
|
7
|
+
export class CuckooFilter {
|
|
8
|
+
bucketSize;
|
|
9
|
+
filterSize;
|
|
10
|
+
fingerprintSize;
|
|
11
|
+
buckets;
|
|
12
|
+
count;
|
|
13
|
+
hash;
|
|
14
|
+
seed;
|
|
15
|
+
constructor(init) {
|
|
16
|
+
this.filterSize = init.filterSize;
|
|
17
|
+
this.bucketSize = init.bucketSize ?? 4;
|
|
18
|
+
this.fingerprintSize = init.fingerprintSize ?? 2;
|
|
19
|
+
this.count = 0;
|
|
20
|
+
this.buckets = [];
|
|
21
|
+
this.hash = init.hash ?? fnv1a;
|
|
22
|
+
this.seed = init.seed ?? getRandomInt(0, Math.pow(2, 10));
|
|
23
|
+
}
|
|
24
|
+
add(item) {
|
|
25
|
+
if (typeof item === 'string') {
|
|
26
|
+
item = uint8ArrayFromString(item);
|
|
27
|
+
}
|
|
28
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize);
|
|
29
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize;
|
|
30
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize;
|
|
31
|
+
if (this.buckets[j] == null) {
|
|
32
|
+
this.buckets[j] = new Bucket(this.bucketSize);
|
|
33
|
+
}
|
|
34
|
+
if (this.buckets[k] == null) {
|
|
35
|
+
this.buckets[k] = new Bucket(this.bucketSize);
|
|
36
|
+
}
|
|
37
|
+
if (this.buckets[j].add(fingerprint) || this.buckets[k].add(fingerprint)) {
|
|
38
|
+
this.count++;
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
const rand = [j, k];
|
|
42
|
+
let i = rand[getRandomInt(0, rand.length - 1)];
|
|
43
|
+
if (this.buckets[i] == null) {
|
|
44
|
+
this.buckets[i] = new Bucket(this.bucketSize);
|
|
45
|
+
}
|
|
46
|
+
for (let n = 0; n < maxCuckooCount; n++) {
|
|
47
|
+
const swapped = this.buckets[i].swap(fingerprint);
|
|
48
|
+
if (swapped == null) {
|
|
49
|
+
continue;
|
|
50
|
+
}
|
|
51
|
+
i = (i ^ swapped.hash()) % this.filterSize;
|
|
52
|
+
if (this.buckets[i] == null) {
|
|
53
|
+
this.buckets[i] = new Bucket(this.bucketSize);
|
|
54
|
+
}
|
|
55
|
+
if (this.buckets[i].add(swapped)) {
|
|
56
|
+
this.count++;
|
|
57
|
+
return true;
|
|
58
|
+
}
|
|
59
|
+
else {
|
|
60
|
+
continue;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
return false;
|
|
64
|
+
}
|
|
65
|
+
has(item) {
|
|
66
|
+
if (typeof item === 'string') {
|
|
67
|
+
item = uint8ArrayFromString(item);
|
|
68
|
+
}
|
|
69
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize);
|
|
70
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize;
|
|
71
|
+
const inJ = this.buckets[j]?.has(fingerprint) ?? false;
|
|
72
|
+
if (inJ) {
|
|
73
|
+
return inJ;
|
|
74
|
+
}
|
|
75
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize;
|
|
76
|
+
return this.buckets[k]?.has(fingerprint) ?? false;
|
|
77
|
+
}
|
|
78
|
+
remove(item) {
|
|
79
|
+
if (typeof item === 'string') {
|
|
80
|
+
item = uint8ArrayFromString(item);
|
|
81
|
+
}
|
|
82
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize);
|
|
83
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize;
|
|
84
|
+
const inJ = this.buckets[j]?.remove(fingerprint) ?? false;
|
|
85
|
+
if (inJ) {
|
|
86
|
+
this.count--;
|
|
87
|
+
return inJ;
|
|
88
|
+
}
|
|
89
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize;
|
|
90
|
+
const inK = this.buckets[k]?.remove(fingerprint) ?? false;
|
|
91
|
+
if (inK) {
|
|
92
|
+
this.count--;
|
|
93
|
+
}
|
|
94
|
+
return inK;
|
|
95
|
+
}
|
|
96
|
+
get reliable() {
|
|
97
|
+
return Math.floor(100 * (this.count / this.filterSize)) <= 95;
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
// max load constants, defined in the cuckoo paper
|
|
101
|
+
const MAX_LOAD = {
|
|
102
|
+
1: 0.5,
|
|
103
|
+
2: 0.84,
|
|
104
|
+
4: 0.95,
|
|
105
|
+
8: 0.98
|
|
106
|
+
};
|
|
107
|
+
function calculateBucketSize(errorRate = 0.001) {
|
|
108
|
+
if (errorRate > 0.002) {
|
|
109
|
+
return 2;
|
|
110
|
+
}
|
|
111
|
+
if (errorRate > 0.00001) {
|
|
112
|
+
return 4;
|
|
113
|
+
}
|
|
114
|
+
return 8;
|
|
115
|
+
}
|
|
116
|
+
export function optimize(maxItems, errorRate = 0.001) {
|
|
117
|
+
// https://www.eecs.harvard.edu/~michaelm/postscripts/cuckoo-conext2014.pdf
|
|
118
|
+
// Section 5.1 Optimal Bucket Size
|
|
119
|
+
const bucketSize = calculateBucketSize(errorRate);
|
|
120
|
+
const load = MAX_LOAD[bucketSize];
|
|
121
|
+
// https://stackoverflow.com/questions/57555236/how-to-size-a-cuckoo-filter/57617208#57617208
|
|
122
|
+
const filterSize = Math.round(maxItems / load);
|
|
123
|
+
const fingerprintSize = Math.min(Math.ceil(Math.log(filterSize / bucketSize)) + 2, MAX_FINGERPRINT_SIZE);
|
|
124
|
+
return {
|
|
125
|
+
filterSize,
|
|
126
|
+
bucketSize,
|
|
127
|
+
fingerprintSize
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
export function createCuckooFilter(maxItems, errorRate = 0.005) {
|
|
131
|
+
const opts = optimize(maxItems, errorRate);
|
|
132
|
+
return new CuckooFilter(opts);
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=cuckoo-filter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cuckoo-filter.js","sourceRoot":"","sources":["../../../src/filters/cuckoo-filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AACpE,OAAO,EAAE,KAAK,EAAa,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAGzC,MAAM,cAAc,GAAG,GAAG,CAAA;AA6B1B,MAAM,OAAO,YAAY;IACN,UAAU,CAAQ;IAClB,UAAU,CAAQ;IAClB,eAAe,CAAQ;IACvB,OAAO,CAAU;IAC3B,KAAK,CAAQ;IACH,IAAI,CAAM;IACV,IAAI,CAAQ;IAE7B,YAAa,IAAsB;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAA;QACjC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,CAAC,CAAA;QAChD,IAAI,CAAC,KAAK,GAAG,CAAC,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,KAAK,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAA;QACrF,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAC3D,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAEpD,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YACzE,IAAI,CAAC,KAAK,EAAE,CAAA;YACZ,OAAO,IAAI,CAAA;QACb,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACnB,IAAI,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAA;QAE9C,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/C,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAEjD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,SAAQ;YACV,CAAC;YAED,CAAC,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;YAE1C,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;gBAC5B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAC/C,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACjC,IAAI,CAAC,KAAK,EAAE,CAAA;gBAEZ,OAAO,IAAI,CAAA;YACb,CAAC;iBAAM,CAAC;gBACN,SAAQ;YACV,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAA;QACrF,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,KAAK,CAAA;QAEtD,IAAI,GAAG,EAAE,CAAC;YACR,OAAO,GAAG,CAAA;QACZ,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAEpD,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,IAAI,KAAK,CAAA;IACnD,CAAC;IAED,MAAM,CAAE,IAAyB;QAC/B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAA;QACrF,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,KAAK,CAAA;QAEzD,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,KAAK,EAAE,CAAA;YACZ,OAAO,GAAG,CAAA;QACZ,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,KAAK,CAAA;QAEzD,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,KAAK,EAAE,CAAA;QACd,CAAC;QAED,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,EAAE,CAAA;IAC/D,CAAC;CACF;AAED,kDAAkD;AAClD,MAAM,QAAQ,GAAG;IACf,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;IACP,CAAC,EAAE,IAAI;CACR,CAAA;AAED,SAAS,mBAAmB,CAAE,YAAoB,KAAK;IACrD,IAAI,SAAS,GAAG,KAAK,EAAE,CAAC;QACtB,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,SAAS,GAAG,OAAO,EAAE,CAAC;QACxB,OAAO,CAAC,CAAA;IACV,CAAC;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAED,MAAM,UAAU,QAAQ,CAAE,QAAgB,EAAE,YAAoB,KAAK;IACnE,2EAA2E;IAC3E,kCAAkC;IAClC,MAAM,UAAU,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACjD,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAA;IAEjC,6FAA6F;IAC7F,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAA;IAC9C,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,oBAAoB,CAAC,CAAA;IAExG,OAAO;QACL,UAAU;QACV,UAAU;QACV,eAAe;KAChB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAE,QAAgB,EAAE,YAAoB,KAAK;IAC7E,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IAC1C,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,CAAA;AAC/B,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { Hash } from './hashes';
|
|
2
|
+
export declare const MAX_FINGERPRINT_SIZE = 64;
|
|
3
|
+
export declare class Fingerprint {
|
|
4
|
+
private readonly fp;
|
|
5
|
+
private readonly h;
|
|
6
|
+
private readonly seed;
|
|
7
|
+
constructor(buf: Uint8Array, hash: Hash, seed: number, fingerprintSize?: number);
|
|
8
|
+
hash(): number;
|
|
9
|
+
equals(other?: any): boolean;
|
|
10
|
+
}
|
|
11
|
+
//# sourceMappingURL=fingerprint.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fingerprint.d.ts","sourceRoot":"","sources":["../../../src/filters/fingerprint.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAEpC,eAAO,MAAM,oBAAoB,KAAK,CAAA;AAEtC,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAY;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAM;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;gBAEhB,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,GAAE,MAAU;IAqBnF,IAAI,IAAK,MAAM;IAIf,MAAM,CAAE,KAAK,CAAC,EAAE,GAAG,GAAG,OAAO;CAO9B"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { alloc as uint8ArrayAlloc } from 'uint8arrays/alloc';
|
|
2
|
+
import { equals as uint8ArrayEquals } from 'uint8arrays/equals';
|
|
3
|
+
export const MAX_FINGERPRINT_SIZE = 64;
|
|
4
|
+
export class Fingerprint {
|
|
5
|
+
fp;
|
|
6
|
+
h;
|
|
7
|
+
seed;
|
|
8
|
+
constructor(buf, hash, seed, fingerprintSize = 2) {
|
|
9
|
+
if (fingerprintSize > MAX_FINGERPRINT_SIZE) {
|
|
10
|
+
throw new TypeError('Invalid Fingerprint Size');
|
|
11
|
+
}
|
|
12
|
+
const fnv = hash.hashV(buf, seed);
|
|
13
|
+
const fp = uint8ArrayAlloc(fingerprintSize);
|
|
14
|
+
for (let i = 0; i < fp.length; i++) {
|
|
15
|
+
fp[i] = fnv[i];
|
|
16
|
+
}
|
|
17
|
+
if (fp.length === 0) {
|
|
18
|
+
fp[0] = 7;
|
|
19
|
+
}
|
|
20
|
+
this.fp = fp;
|
|
21
|
+
this.h = hash;
|
|
22
|
+
this.seed = seed;
|
|
23
|
+
}
|
|
24
|
+
hash() {
|
|
25
|
+
return this.h.hash(this.fp, this.seed);
|
|
26
|
+
}
|
|
27
|
+
equals(other) {
|
|
28
|
+
if (!(other?.fp instanceof Uint8Array)) {
|
|
29
|
+
return false;
|
|
30
|
+
}
|
|
31
|
+
return uint8ArrayEquals(this.fp, other.fp);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=fingerprint.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fingerprint.js","sourceRoot":"","sources":["../../../src/filters/fingerprint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAC5D,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAG/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAA;AAEtC,MAAM,OAAO,WAAW;IACL,EAAE,CAAY;IACd,CAAC,CAAM;IACP,IAAI,CAAQ;IAE7B,YAAa,GAAe,EAAE,IAAU,EAAE,IAAY,EAAE,kBAA0B,CAAC;QACjF,IAAI,eAAe,GAAG,oBAAoB,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,0BAA0B,CAAC,CAAA;QACjD,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QACjC,MAAM,EAAE,GAAG,eAAe,CAAC,eAAe,CAAC,CAAA;QAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpB,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACX,CAAC;QAED,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;QACZ,IAAI,CAAC,CAAC,GAAG,IAAI,CAAA;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IAClB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,CAAE,KAAW;QACjB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,YAAY,UAAU,CAAC,EAAE,CAAC;YACvC,OAAO,KAAK,CAAA;QACd,CAAC;QAED,OAAO,gBAAgB,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,CAAA;IAC5C,CAAC;CACF"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface Hash {
|
|
2
|
+
hash(input: Uint8Array, seed: number): number;
|
|
3
|
+
hashV(input: Uint8Array, seed: number): Uint8Array;
|
|
4
|
+
}
|
|
5
|
+
export declare const murmur3: Hash;
|
|
6
|
+
export declare const fnv1a: Hash;
|
|
7
|
+
export declare function numberToBuffer(num: bigint | number): Uint8Array;
|
|
8
|
+
//# sourceMappingURL=hashes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hashes.d.ts","sourceRoot":"","sources":["../../../src/filters/hashes.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7C,KAAK,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;CACnD;AAED,eAAO,MAAM,OAAO,EAAE,IAOrB,CAAA;AAED,eAAO,MAAM,KAAK,EAAE,IASnB,CAAA;AAED,wBAAgB,cAAc,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAQhE"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import fnv1aHash from '@sindresorhus/fnv1a';
|
|
2
|
+
import mur from 'murmurhash3js-revisited';
|
|
3
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
|
|
4
|
+
export const murmur3 = {
|
|
5
|
+
hash: (input, seed) => {
|
|
6
|
+
return mur.x86.hash32(input, seed);
|
|
7
|
+
},
|
|
8
|
+
hashV: (input, seed) => {
|
|
9
|
+
return numberToBuffer(murmur3.hash(input, seed));
|
|
10
|
+
}
|
|
11
|
+
};
|
|
12
|
+
export const fnv1a = {
|
|
13
|
+
hash: (input) => {
|
|
14
|
+
return Number(fnv1aHash(input, {
|
|
15
|
+
size: 32
|
|
16
|
+
}));
|
|
17
|
+
},
|
|
18
|
+
hashV: (input, seed) => {
|
|
19
|
+
return numberToBuffer(fnv1a.hash(input, seed));
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
export function numberToBuffer(num) {
|
|
23
|
+
let hex = num.toString(16);
|
|
24
|
+
if (hex.length % 2 === 1) {
|
|
25
|
+
hex = `0${hex}`;
|
|
26
|
+
}
|
|
27
|
+
return uint8ArrayFromString(hex, 'base16');
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=hashes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hashes.js","sourceRoot":"","sources":["../../../src/filters/hashes.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,qBAAqB,CAAA;AAC3C,OAAO,GAAG,MAAM,yBAAyB,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAO5E,MAAM,CAAC,MAAM,OAAO,GAAS;IAC3B,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QACpB,OAAO,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACpC,CAAC;IACD,KAAK,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QACrB,OAAO,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAClD,CAAC;CACF,CAAA;AAED,MAAM,CAAC,MAAM,KAAK,GAAS;IACzB,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;QACd,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE;YAC7B,IAAI,EAAE,EAAE;SACT,CAAC,CAAC,CAAA;IACL,CAAC;IACD,KAAK,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QACrB,OAAO,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAA;IAChD,CAAC;CACF,CAAA;AAED,MAAM,UAAU,cAAc,CAAE,GAAoB;IAClD,IAAI,GAAG,GAAG,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;IAE1B,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,GAAG,GAAG,IAAI,GAAG,EAAE,CAAA;IACjB,CAAC;IAED,OAAO,oBAAoB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;AAC5C,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export { BloomFilter, createBloomFilter, type BloomFilterOptions } from './bloom-filter.js';
|
|
2
|
+
export { CuckooFilter, createCuckooFilter, type CuckooFilterInit } from './cuckoo-filter.js';
|
|
3
|
+
export { ScalableCuckooFilter, createScalableCuckooFilter, type ScalableCuckooFilterInit } from './scalable-cuckoo-filter.js';
|
|
4
|
+
export interface Filter {
|
|
5
|
+
add(item: Uint8Array | string): void;
|
|
6
|
+
has(item: Uint8Array | string): boolean;
|
|
7
|
+
remove?(buf: Uint8Array | string): boolean;
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/filters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,KAAK,wBAAwB,EAAE,MAAM,6BAA6B,CAAA;AAE7H,MAAM,WAAW,MAAM;IACrB,GAAG,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAAA;IACpC,GAAG,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;IACvC,MAAM,CAAC,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO,CAAA;CAC3C"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { BloomFilter, createBloomFilter } from './bloom-filter.js';
|
|
2
|
+
export { CuckooFilter, createCuckooFilter } from './cuckoo-filter.js';
|
|
3
|
+
export { ScalableCuckooFilter, createScalableCuckooFilter } from './scalable-cuckoo-filter.js';
|
|
4
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/filters/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAA2B,MAAM,mBAAmB,CAAA;AAC3F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAyB,MAAM,oBAAoB,CAAA;AAC5F,OAAO,EAAE,oBAAoB,EAAE,0BAA0B,EAAiC,MAAM,6BAA6B,CAAA"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { type CuckooFilterInit } from './cuckoo-filter.js';
|
|
2
|
+
import type { Filter } from './index.js';
|
|
3
|
+
export interface ScalableCuckooFilterInit extends CuckooFilterInit {
|
|
4
|
+
/**
|
|
5
|
+
* A number to multiply maxItems by when adding new sub-filters
|
|
6
|
+
*/
|
|
7
|
+
scale?: number;
|
|
8
|
+
}
|
|
9
|
+
export declare class ScalableCuckooFilter implements Filter {
|
|
10
|
+
private readonly filterSize;
|
|
11
|
+
private readonly bucketSize;
|
|
12
|
+
private readonly fingerprintSize;
|
|
13
|
+
private readonly scale;
|
|
14
|
+
private readonly filterSeries;
|
|
15
|
+
private readonly hash;
|
|
16
|
+
private readonly seed;
|
|
17
|
+
constructor(init: ScalableCuckooFilterInit);
|
|
18
|
+
add(item: Uint8Array | string): boolean;
|
|
19
|
+
has(item: Uint8Array | string): boolean;
|
|
20
|
+
remove(item: Uint8Array | string): boolean;
|
|
21
|
+
get count(): number;
|
|
22
|
+
}
|
|
23
|
+
export declare function createScalableCuckooFilter(maxItems: number, errorRate?: number, options?: Pick<ScalableCuckooFilterInit, 'hash' | 'seed' | 'scale'>): Filter;
|
|
24
|
+
//# sourceMappingURL=scalable-cuckoo-filter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scalable-cuckoo-filter.d.ts","sourceRoot":"","sources":["../../../src/filters/scalable-cuckoo-filter.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAGlF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExC,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,qBAAa,oBAAqB,YAAW,MAAM;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAC7C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAM;IAC3B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAQ;gBAEhB,IAAI,EAAE,wBAAwB;IAkB3C,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IA8BxC,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAcxC,MAAM,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAc3C,IAAI,KAAK,IAAK,MAAM,CAInB;CACF;AAED,wBAAgB,0BAA0B,CAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAE,MAAc,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,MAAM,CAKpK"}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
|
|
2
|
+
import { CuckooFilter, optimize } from './cuckoo-filter.js';
|
|
3
|
+
import { fnv1a } from './hashes.js';
|
|
4
|
+
import { getRandomInt } from './utils.js';
|
|
5
|
+
export class ScalableCuckooFilter {
|
|
6
|
+
filterSize;
|
|
7
|
+
bucketSize;
|
|
8
|
+
fingerprintSize;
|
|
9
|
+
scale;
|
|
10
|
+
filterSeries;
|
|
11
|
+
hash;
|
|
12
|
+
seed;
|
|
13
|
+
constructor(init) {
|
|
14
|
+
this.bucketSize = init.bucketSize ?? 4;
|
|
15
|
+
this.filterSize = init.filterSize ?? (1 << 18) / this.bucketSize;
|
|
16
|
+
this.fingerprintSize = init.fingerprintSize ?? 2;
|
|
17
|
+
this.scale = init.scale ?? 2;
|
|
18
|
+
this.hash = init.hash ?? fnv1a;
|
|
19
|
+
this.seed = init.seed ?? getRandomInt(0, Math.pow(2, 10));
|
|
20
|
+
this.filterSeries = [
|
|
21
|
+
new CuckooFilter({
|
|
22
|
+
filterSize: this.filterSize,
|
|
23
|
+
bucketSize: this.bucketSize,
|
|
24
|
+
fingerprintSize: this.fingerprintSize,
|
|
25
|
+
hash: this.hash,
|
|
26
|
+
seed: this.seed
|
|
27
|
+
})
|
|
28
|
+
];
|
|
29
|
+
}
|
|
30
|
+
add(item) {
|
|
31
|
+
if (typeof item === 'string') {
|
|
32
|
+
item = uint8ArrayFromString(item);
|
|
33
|
+
}
|
|
34
|
+
if (this.has(item)) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
let current = this.filterSeries.find((cuckoo) => {
|
|
38
|
+
return cuckoo.reliable;
|
|
39
|
+
});
|
|
40
|
+
if (current == null) {
|
|
41
|
+
const curSize = this.filterSize * Math.pow(this.scale, this.filterSeries.length);
|
|
42
|
+
current = new CuckooFilter({
|
|
43
|
+
filterSize: curSize,
|
|
44
|
+
bucketSize: this.bucketSize,
|
|
45
|
+
fingerprintSize: this.fingerprintSize,
|
|
46
|
+
hash: this.hash,
|
|
47
|
+
seed: this.seed
|
|
48
|
+
});
|
|
49
|
+
this.filterSeries.push(current);
|
|
50
|
+
}
|
|
51
|
+
return current.add(item);
|
|
52
|
+
}
|
|
53
|
+
has(item) {
|
|
54
|
+
if (typeof item === 'string') {
|
|
55
|
+
item = uint8ArrayFromString(item);
|
|
56
|
+
}
|
|
57
|
+
for (let i = 0; i < this.filterSeries.length; i++) {
|
|
58
|
+
if (this.filterSeries[i].has(item)) {
|
|
59
|
+
return true;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
return false;
|
|
63
|
+
}
|
|
64
|
+
remove(item) {
|
|
65
|
+
if (typeof item === 'string') {
|
|
66
|
+
item = uint8ArrayFromString(item);
|
|
67
|
+
}
|
|
68
|
+
for (let i = 0; i < this.filterSeries.length; i++) {
|
|
69
|
+
if (this.filterSeries[i].remove(item)) {
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
return false;
|
|
74
|
+
}
|
|
75
|
+
get count() {
|
|
76
|
+
return this.filterSeries.reduce((acc, curr) => {
|
|
77
|
+
return acc + curr.count;
|
|
78
|
+
}, 0);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
export function createScalableCuckooFilter(maxItems, errorRate = 0.001, options) {
|
|
82
|
+
return new ScalableCuckooFilter({
|
|
83
|
+
...optimize(maxItems, errorRate),
|
|
84
|
+
...(options ?? {})
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
//# sourceMappingURL=scalable-cuckoo-filter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scalable-cuckoo-filter.js","sourceRoot":"","sources":["../../../src/filters/scalable-cuckoo-filter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAyB,MAAM,oBAAoB,CAAA;AAClF,OAAO,EAAE,KAAK,EAAa,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAUzC,MAAM,OAAO,oBAAoB;IACd,UAAU,CAAQ;IAClB,UAAU,CAAQ;IAClB,eAAe,CAAQ;IACvB,KAAK,CAAQ;IACb,YAAY,CAAgB;IAC5B,IAAI,CAAM;IACV,IAAI,CAAQ;IAE7B,YAAa,IAA8B;QACzC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAA;QACtC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAA;QAChE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,CAAC,CAAA;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;QAC5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,KAAK,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;QACzD,IAAI,CAAC,YAAY,GAAG;YAClB,IAAI,YAAY,CAAC;gBACf,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC;SACH,CAAA;IACH,CAAC;IAED,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,OAAO,IAAI,CAAA;QACb,CAAC;QAED,IAAI,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YAC9C,OAAO,MAAM,CAAC,QAAQ,CAAA;QACxB,CAAC,CAAC,CAAA;QAEF,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;YAEhF,OAAO,GAAG,IAAI,YAAY,CAAC;gBACzB,UAAU,EAAE,OAAO;gBACnB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC,CAAA;YAEF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACjC,CAAC;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;gBACnC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,CAAE,IAAyB;QAC/B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC5C,OAAO,GAAG,GAAG,IAAI,CAAC,KAAK,CAAA;QACzB,CAAC,EAAE,CAAC,CAAC,CAAA;IACP,CAAC;CACF;AAED,MAAM,UAAU,0BAA0B,CAAE,QAAgB,EAAE,YAAoB,KAAK,EAAE,OAAmE;IAC1J,OAAO,IAAI,oBAAoB,CAAC;QAC9B,GAAG,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;QAChC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;KACnB,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/filters/utils.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9D"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/filters/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY,CAAE,GAAW,EAAE,GAAW;IACpD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AACtD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libp2p/utils",
|
|
3
|
-
"version": "5.3.2-
|
|
3
|
+
"version": "5.3.2-3d7a9da17",
|
|
4
4
|
"description": "Package to aggregate shared logic and dependencies for the libp2p ecosystem",
|
|
5
5
|
"license": "Apache-2.0 OR MIT",
|
|
6
6
|
"homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/utils#readme",
|
|
@@ -56,14 +56,14 @@
|
|
|
56
56
|
"types": "./dist/src/array-equals.d.ts",
|
|
57
57
|
"import": "./dist/src/array-equals.js"
|
|
58
58
|
},
|
|
59
|
-
"./bloom-filter": {
|
|
60
|
-
"types": "./dist/src/bloom-filter.d.ts",
|
|
61
|
-
"import": "./dist/src/bloom-filter.js"
|
|
62
|
-
},
|
|
63
59
|
"./close-source": {
|
|
64
60
|
"types": "./dist/src/close-source.d.ts",
|
|
65
61
|
"import": "./dist/src/close-source.js"
|
|
66
62
|
},
|
|
63
|
+
"./filters": {
|
|
64
|
+
"types": "./dist/src/filters/index.d.ts",
|
|
65
|
+
"import": "./dist/src/filters/index.js"
|
|
66
|
+
},
|
|
67
67
|
"./ip-port-to-multiaddr": {
|
|
68
68
|
"types": "./dist/src/ip-port-to-multiaddr.d.ts",
|
|
69
69
|
"import": "./dist/src/ip-port-to-multiaddr.js"
|
|
@@ -132,11 +132,12 @@
|
|
|
132
132
|
},
|
|
133
133
|
"dependencies": {
|
|
134
134
|
"@chainsafe/is-ip": "^2.0.2",
|
|
135
|
-
"@libp2p/crypto": "4.1.0-
|
|
136
|
-
"@libp2p/interface": "1.3.0-
|
|
137
|
-
"@libp2p/logger": "4.0.11-
|
|
135
|
+
"@libp2p/crypto": "4.1.0-3d7a9da17",
|
|
136
|
+
"@libp2p/interface": "1.3.0-3d7a9da17",
|
|
137
|
+
"@libp2p/logger": "4.0.11-3d7a9da17",
|
|
138
138
|
"@multiformats/multiaddr": "^12.2.1",
|
|
139
139
|
"@multiformats/multiaddr-matcher": "^1.2.0",
|
|
140
|
+
"@sindresorhus/fnv1a": "^3.1.0",
|
|
140
141
|
"@types/murmurhash3js-revisited": "^3.0.3",
|
|
141
142
|
"delay": "^6.0.0",
|
|
142
143
|
"get-iterator": "^2.0.1",
|
|
@@ -152,7 +153,7 @@
|
|
|
152
153
|
"uint8arrays": "^5.0.3"
|
|
153
154
|
},
|
|
154
155
|
"devDependencies": {
|
|
155
|
-
"@libp2p/peer-id-factory": "4.1.0-
|
|
156
|
+
"@libp2p/peer-id-factory": "4.1.0-3d7a9da17",
|
|
156
157
|
"@types/netmask": "^2.0.5",
|
|
157
158
|
"aegir": "^42.2.5",
|
|
158
159
|
"delay": "^6.0.0",
|
|
@@ -4,6 +4,7 @@ import mur from 'murmurhash3js-revisited'
|
|
|
4
4
|
import { Uint8ArrayList } from 'uint8arraylist'
|
|
5
5
|
import { alloc } from 'uint8arrays/alloc'
|
|
6
6
|
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
7
|
+
import type { Filter } from './index.js'
|
|
7
8
|
|
|
8
9
|
const LN2_SQUARED = Math.LN2 * Math.LN2
|
|
9
10
|
|
|
@@ -13,16 +14,7 @@ export interface BloomFilterOptions {
|
|
|
13
14
|
bits?: number
|
|
14
15
|
}
|
|
15
16
|
|
|
16
|
-
export class BloomFilter {
|
|
17
|
-
/**
|
|
18
|
-
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
19
|
-
* specified item count and error rate.
|
|
20
|
-
*/
|
|
21
|
-
static create (itemcount: number, errorRate: number = 0.005): BloomFilter {
|
|
22
|
-
const opts = optimize(itemcount, errorRate)
|
|
23
|
-
return new BloomFilter(opts)
|
|
24
|
-
}
|
|
25
|
-
|
|
17
|
+
export class BloomFilter implements Filter {
|
|
26
18
|
public readonly seeds: number[]
|
|
27
19
|
public readonly bits: number
|
|
28
20
|
public buffer: Uint8Array
|
|
@@ -111,9 +103,18 @@ export class BloomFilter {
|
|
|
111
103
|
}
|
|
112
104
|
}
|
|
113
105
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
106
|
+
/**
|
|
107
|
+
* Create a `BloomFilter` with the smallest `bits` and `hashes` value for the
|
|
108
|
+
* specified item count and error rate.
|
|
109
|
+
*/
|
|
110
|
+
export function createBloomFilter (itemcount: number, errorRate: number = 0.005): Filter {
|
|
111
|
+
const opts = optimize(itemcount, errorRate)
|
|
112
|
+
return new BloomFilter(opts)
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
function optimize (itemCount: number, errorRate: number = 0.005): { bits: number, hashes: number } {
|
|
116
|
+
const bits = Math.round(-1 * itemCount * Math.log(errorRate) / LN2_SQUARED)
|
|
117
|
+
const hashes = Math.round((bits / itemCount) * Math.LN2)
|
|
117
118
|
|
|
118
119
|
return { bits, hashes }
|
|
119
120
|
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { Fingerprint } from './fingerprint.js'
|
|
2
|
+
import { getRandomInt } from './utils.js'
|
|
3
|
+
|
|
4
|
+
export class Bucket {
|
|
5
|
+
private readonly contents: Array<Fingerprint | null>
|
|
6
|
+
|
|
7
|
+
constructor (size: number) {
|
|
8
|
+
this.contents = new Array(size).fill(null)
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
has (fingerprint: Fingerprint): boolean {
|
|
12
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
13
|
+
throw new TypeError('Invalid Fingerprint')
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
return this.contents.some((fp) => {
|
|
17
|
+
return fingerprint.equals(fp)
|
|
18
|
+
})
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
add (fingerprint: Fingerprint): boolean {
|
|
22
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
23
|
+
throw new TypeError('Invalid Fingerprint')
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
for (let i = 0; i < this.contents.length; i++) {
|
|
27
|
+
if (this.contents[i] == null) {
|
|
28
|
+
this.contents[i] = fingerprint
|
|
29
|
+
return true
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
return true
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
swap (fingerprint: Fingerprint): Fingerprint | null {
|
|
37
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
38
|
+
throw new TypeError('Invalid Fingerprint')
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const i = getRandomInt(0, this.contents.length - 1)
|
|
42
|
+
const current = this.contents[i]
|
|
43
|
+
this.contents[i] = fingerprint
|
|
44
|
+
|
|
45
|
+
return current
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
remove (fingerprint: Fingerprint): boolean {
|
|
49
|
+
if (!(fingerprint instanceof Fingerprint)) {
|
|
50
|
+
throw new TypeError('Invalid Fingerprint')
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
const found = this.contents.findIndex((fp) => {
|
|
54
|
+
return fingerprint.equals(fp)
|
|
55
|
+
})
|
|
56
|
+
|
|
57
|
+
if (found > -1) {
|
|
58
|
+
this.contents[found] = null
|
|
59
|
+
return true
|
|
60
|
+
} else {
|
|
61
|
+
return false
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
2
|
+
import { Bucket } from './bucket.js'
|
|
3
|
+
import { Fingerprint, MAX_FINGERPRINT_SIZE } from './fingerprint.js'
|
|
4
|
+
import { fnv1a, type Hash } from './hashes.js'
|
|
5
|
+
import { getRandomInt } from './utils.js'
|
|
6
|
+
import type { Filter } from './index.js'
|
|
7
|
+
|
|
8
|
+
const maxCuckooCount = 500
|
|
9
|
+
|
|
10
|
+
export interface CuckooFilterInit {
|
|
11
|
+
/**
|
|
12
|
+
* How many items the filter is expected to contain
|
|
13
|
+
*/
|
|
14
|
+
filterSize: number
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* How many items to put in each bucket
|
|
18
|
+
*/
|
|
19
|
+
bucketSize?: number
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* How many bytes the fingerprint is expected to be
|
|
23
|
+
*/
|
|
24
|
+
fingerprintSize?: number
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* A non-cryptographic hash implementation
|
|
28
|
+
*/
|
|
29
|
+
hash?: Hash
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* A number used to seed the hash
|
|
33
|
+
*/
|
|
34
|
+
seed?: number
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export class CuckooFilter implements Filter {
|
|
38
|
+
private readonly bucketSize: number
|
|
39
|
+
private readonly filterSize: number
|
|
40
|
+
private readonly fingerprintSize: number
|
|
41
|
+
private readonly buckets: Bucket[]
|
|
42
|
+
public count: number
|
|
43
|
+
private readonly hash: Hash
|
|
44
|
+
private readonly seed: number
|
|
45
|
+
|
|
46
|
+
constructor (init: CuckooFilterInit) {
|
|
47
|
+
this.filterSize = init.filterSize
|
|
48
|
+
this.bucketSize = init.bucketSize ?? 4
|
|
49
|
+
this.fingerprintSize = init.fingerprintSize ?? 2
|
|
50
|
+
this.count = 0
|
|
51
|
+
this.buckets = []
|
|
52
|
+
this.hash = init.hash ?? fnv1a
|
|
53
|
+
this.seed = init.seed ?? getRandomInt(0, Math.pow(2, 10))
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
add (item: Uint8Array | string): boolean {
|
|
57
|
+
if (typeof item === 'string') {
|
|
58
|
+
item = uint8ArrayFromString(item)
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize)
|
|
62
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize
|
|
63
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize
|
|
64
|
+
|
|
65
|
+
if (this.buckets[j] == null) {
|
|
66
|
+
this.buckets[j] = new Bucket(this.bucketSize)
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (this.buckets[k] == null) {
|
|
70
|
+
this.buckets[k] = new Bucket(this.bucketSize)
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
if (this.buckets[j].add(fingerprint) || this.buckets[k].add(fingerprint)) {
|
|
74
|
+
this.count++
|
|
75
|
+
return true
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
const rand = [j, k]
|
|
79
|
+
let i = rand[getRandomInt(0, rand.length - 1)]
|
|
80
|
+
|
|
81
|
+
if (this.buckets[i] == null) {
|
|
82
|
+
this.buckets[i] = new Bucket(this.bucketSize)
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
for (let n = 0; n < maxCuckooCount; n++) {
|
|
86
|
+
const swapped = this.buckets[i].swap(fingerprint)
|
|
87
|
+
|
|
88
|
+
if (swapped == null) {
|
|
89
|
+
continue
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
i = (i ^ swapped.hash()) % this.filterSize
|
|
93
|
+
|
|
94
|
+
if (this.buckets[i] == null) {
|
|
95
|
+
this.buckets[i] = new Bucket(this.bucketSize)
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
if (this.buckets[i].add(swapped)) {
|
|
99
|
+
this.count++
|
|
100
|
+
|
|
101
|
+
return true
|
|
102
|
+
} else {
|
|
103
|
+
continue
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
return false
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
has (item: Uint8Array | string): boolean {
|
|
111
|
+
if (typeof item === 'string') {
|
|
112
|
+
item = uint8ArrayFromString(item)
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize)
|
|
116
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize
|
|
117
|
+
const inJ = this.buckets[j]?.has(fingerprint) ?? false
|
|
118
|
+
|
|
119
|
+
if (inJ) {
|
|
120
|
+
return inJ
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize
|
|
124
|
+
|
|
125
|
+
return this.buckets[k]?.has(fingerprint) ?? false
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
remove (item: Uint8Array | string): boolean {
|
|
129
|
+
if (typeof item === 'string') {
|
|
130
|
+
item = uint8ArrayFromString(item)
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
const fingerprint = new Fingerprint(item, this.hash, this.seed, this.fingerprintSize)
|
|
134
|
+
const j = this.hash.hash(item, this.seed) % this.filterSize
|
|
135
|
+
const inJ = this.buckets[j]?.remove(fingerprint) ?? false
|
|
136
|
+
|
|
137
|
+
if (inJ) {
|
|
138
|
+
this.count--
|
|
139
|
+
return inJ
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
const k = (j ^ fingerprint.hash()) % this.filterSize
|
|
143
|
+
const inK = this.buckets[k]?.remove(fingerprint) ?? false
|
|
144
|
+
|
|
145
|
+
if (inK) {
|
|
146
|
+
this.count--
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
return inK
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
get reliable (): boolean {
|
|
153
|
+
return Math.floor(100 * (this.count / this.filterSize)) <= 95
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
// max load constants, defined in the cuckoo paper
|
|
158
|
+
const MAX_LOAD = {
|
|
159
|
+
1: 0.5,
|
|
160
|
+
2: 0.84,
|
|
161
|
+
4: 0.95,
|
|
162
|
+
8: 0.98
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
function calculateBucketSize (errorRate: number = 0.001): 2 | 4 | 8 {
|
|
166
|
+
if (errorRate > 0.002) {
|
|
167
|
+
return 2
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
if (errorRate > 0.00001) {
|
|
171
|
+
return 4
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
return 8
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
export function optimize (maxItems: number, errorRate: number = 0.001): CuckooFilterInit {
|
|
178
|
+
// https://www.eecs.harvard.edu/~michaelm/postscripts/cuckoo-conext2014.pdf
|
|
179
|
+
// Section 5.1 Optimal Bucket Size
|
|
180
|
+
const bucketSize = calculateBucketSize(errorRate)
|
|
181
|
+
const load = MAX_LOAD[bucketSize]
|
|
182
|
+
|
|
183
|
+
// https://stackoverflow.com/questions/57555236/how-to-size-a-cuckoo-filter/57617208#57617208
|
|
184
|
+
const filterSize = Math.round(maxItems / load)
|
|
185
|
+
const fingerprintSize = Math.min(Math.ceil(Math.log(filterSize / bucketSize)) + 2, MAX_FINGERPRINT_SIZE)
|
|
186
|
+
|
|
187
|
+
return {
|
|
188
|
+
filterSize,
|
|
189
|
+
bucketSize,
|
|
190
|
+
fingerprintSize
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
export function createCuckooFilter (maxItems: number, errorRate: number = 0.005): Filter {
|
|
195
|
+
const opts = optimize(maxItems, errorRate)
|
|
196
|
+
return new CuckooFilter(opts)
|
|
197
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { alloc as uint8ArrayAlloc } from 'uint8arrays/alloc'
|
|
2
|
+
import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
|
|
3
|
+
import type { Hash } from './hashes'
|
|
4
|
+
|
|
5
|
+
export const MAX_FINGERPRINT_SIZE = 64
|
|
6
|
+
|
|
7
|
+
export class Fingerprint {
|
|
8
|
+
private readonly fp: Uint8Array
|
|
9
|
+
private readonly h: Hash
|
|
10
|
+
private readonly seed: number
|
|
11
|
+
|
|
12
|
+
constructor (buf: Uint8Array, hash: Hash, seed: number, fingerprintSize: number = 2) {
|
|
13
|
+
if (fingerprintSize > MAX_FINGERPRINT_SIZE) {
|
|
14
|
+
throw new TypeError('Invalid Fingerprint Size')
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const fnv = hash.hashV(buf, seed)
|
|
18
|
+
const fp = uint8ArrayAlloc(fingerprintSize)
|
|
19
|
+
|
|
20
|
+
for (let i = 0; i < fp.length; i++) {
|
|
21
|
+
fp[i] = fnv[i]
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
if (fp.length === 0) {
|
|
25
|
+
fp[0] = 7
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
this.fp = fp
|
|
29
|
+
this.h = hash
|
|
30
|
+
this.seed = seed
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
hash (): number {
|
|
34
|
+
return this.h.hash(this.fp, this.seed)
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
equals (other?: any): boolean {
|
|
38
|
+
if (!(other?.fp instanceof Uint8Array)) {
|
|
39
|
+
return false
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return uint8ArrayEquals(this.fp, other.fp)
|
|
43
|
+
}
|
|
44
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import fnv1aHash from '@sindresorhus/fnv1a'
|
|
2
|
+
import mur from 'murmurhash3js-revisited'
|
|
3
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
4
|
+
|
|
5
|
+
export interface Hash {
|
|
6
|
+
hash(input: Uint8Array, seed: number): number
|
|
7
|
+
hashV(input: Uint8Array, seed: number): Uint8Array
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export const murmur3: Hash = {
|
|
11
|
+
hash: (input, seed) => {
|
|
12
|
+
return mur.x86.hash32(input, seed)
|
|
13
|
+
},
|
|
14
|
+
hashV: (input, seed) => {
|
|
15
|
+
return numberToBuffer(murmur3.hash(input, seed))
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export const fnv1a: Hash = {
|
|
20
|
+
hash: (input) => {
|
|
21
|
+
return Number(fnv1aHash(input, {
|
|
22
|
+
size: 32
|
|
23
|
+
}))
|
|
24
|
+
},
|
|
25
|
+
hashV: (input, seed) => {
|
|
26
|
+
return numberToBuffer(fnv1a.hash(input, seed))
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export function numberToBuffer (num: bigint | number): Uint8Array {
|
|
31
|
+
let hex = num.toString(16)
|
|
32
|
+
|
|
33
|
+
if (hex.length % 2 === 1) {
|
|
34
|
+
hex = `0${hex}`
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
return uint8ArrayFromString(hex, 'base16')
|
|
38
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export { BloomFilter, createBloomFilter, type BloomFilterOptions } from './bloom-filter.js'
|
|
2
|
+
export { CuckooFilter, createCuckooFilter, type CuckooFilterInit } from './cuckoo-filter.js'
|
|
3
|
+
export { ScalableCuckooFilter, createScalableCuckooFilter, type ScalableCuckooFilterInit } from './scalable-cuckoo-filter.js'
|
|
4
|
+
|
|
5
|
+
export interface Filter {
|
|
6
|
+
add(item: Uint8Array | string): void
|
|
7
|
+
has(item: Uint8Array | string): boolean
|
|
8
|
+
remove?(buf: Uint8Array | string): boolean
|
|
9
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
|
|
2
|
+
import { CuckooFilter, optimize, type CuckooFilterInit } from './cuckoo-filter.js'
|
|
3
|
+
import { fnv1a, type Hash } from './hashes.js'
|
|
4
|
+
import { getRandomInt } from './utils.js'
|
|
5
|
+
import type { Filter } from './index.js'
|
|
6
|
+
|
|
7
|
+
export interface ScalableCuckooFilterInit extends CuckooFilterInit {
|
|
8
|
+
/**
|
|
9
|
+
* A number to multiply maxItems by when adding new sub-filters
|
|
10
|
+
*/
|
|
11
|
+
scale?: number
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
export class ScalableCuckooFilter implements Filter {
|
|
15
|
+
private readonly filterSize: number
|
|
16
|
+
private readonly bucketSize: number
|
|
17
|
+
private readonly fingerprintSize: number
|
|
18
|
+
private readonly scale: number
|
|
19
|
+
private readonly filterSeries: CuckooFilter[]
|
|
20
|
+
private readonly hash: Hash
|
|
21
|
+
private readonly seed: number
|
|
22
|
+
|
|
23
|
+
constructor (init: ScalableCuckooFilterInit) {
|
|
24
|
+
this.bucketSize = init.bucketSize ?? 4
|
|
25
|
+
this.filterSize = init.filterSize ?? (1 << 18) / this.bucketSize
|
|
26
|
+
this.fingerprintSize = init.fingerprintSize ?? 2
|
|
27
|
+
this.scale = init.scale ?? 2
|
|
28
|
+
this.hash = init.hash ?? fnv1a
|
|
29
|
+
this.seed = init.seed ?? getRandomInt(0, Math.pow(2, 10))
|
|
30
|
+
this.filterSeries = [
|
|
31
|
+
new CuckooFilter({
|
|
32
|
+
filterSize: this.filterSize,
|
|
33
|
+
bucketSize: this.bucketSize,
|
|
34
|
+
fingerprintSize: this.fingerprintSize,
|
|
35
|
+
hash: this.hash,
|
|
36
|
+
seed: this.seed
|
|
37
|
+
})
|
|
38
|
+
]
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
add (item: Uint8Array | string): boolean {
|
|
42
|
+
if (typeof item === 'string') {
|
|
43
|
+
item = uint8ArrayFromString(item)
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
if (this.has(item)) {
|
|
47
|
+
return true
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
let current = this.filterSeries.find((cuckoo) => {
|
|
51
|
+
return cuckoo.reliable
|
|
52
|
+
})
|
|
53
|
+
|
|
54
|
+
if (current == null) {
|
|
55
|
+
const curSize = this.filterSize * Math.pow(this.scale, this.filterSeries.length)
|
|
56
|
+
|
|
57
|
+
current = new CuckooFilter({
|
|
58
|
+
filterSize: curSize,
|
|
59
|
+
bucketSize: this.bucketSize,
|
|
60
|
+
fingerprintSize: this.fingerprintSize,
|
|
61
|
+
hash: this.hash,
|
|
62
|
+
seed: this.seed
|
|
63
|
+
})
|
|
64
|
+
|
|
65
|
+
this.filterSeries.push(current)
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
return current.add(item)
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
has (item: Uint8Array | string): boolean {
|
|
72
|
+
if (typeof item === 'string') {
|
|
73
|
+
item = uint8ArrayFromString(item)
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
for (let i = 0; i < this.filterSeries.length; i++) {
|
|
77
|
+
if (this.filterSeries[i].has(item)) {
|
|
78
|
+
return true
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return false
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
remove (item: Uint8Array | string): boolean {
|
|
86
|
+
if (typeof item === 'string') {
|
|
87
|
+
item = uint8ArrayFromString(item)
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
for (let i = 0; i < this.filterSeries.length; i++) {
|
|
91
|
+
if (this.filterSeries[i].remove(item)) {
|
|
92
|
+
return true
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
return false
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
get count (): number {
|
|
100
|
+
return this.filterSeries.reduce((acc, curr) => {
|
|
101
|
+
return acc + curr.count
|
|
102
|
+
}, 0)
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
export function createScalableCuckooFilter (maxItems: number, errorRate: number = 0.001, options?: Pick<ScalableCuckooFilterInit, 'hash' | 'seed' | 'scale'>): Filter {
|
|
107
|
+
return new ScalableCuckooFilter({
|
|
108
|
+
...optimize(maxItems, errorRate),
|
|
109
|
+
...(options ?? {})
|
|
110
|
+
})
|
|
111
|
+
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"bloom-filter.d.ts","sourceRoot":"","sources":["../../src/bloom-filter.ts"],"names":[],"mappings":"AASA,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,qBAAa,WAAW;IACtB;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAE,SAAS,EAAE,MAAM,EAAE,SAAS,GAAE,MAAc,GAAG,WAAW;IAKzE,SAAgB,KAAK,EAAE,MAAM,EAAE,CAAA;IAC/B,SAAgB,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,UAAU,CAAA;gBAEZ,OAAO,GAAE,kBAAuB;IAW7C;;OAEG;IACH,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI;IAarC;;;;OAIG;IACH,GAAG,CAAE,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,OAAO;IAmBxC;;OAEG;IACH,KAAK,IAAK,IAAI;IAId,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAa1B,MAAM,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO;CAW9B"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"bloom-filter.js","sourceRoot":"","sources":["../../src/bloom-filter.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,GAAG,MAAM,yBAAyB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AACzC,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAE5E,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;AAQvC,MAAM,OAAO,WAAW;IACtB;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAE,SAAiB,EAAE,YAAoB,KAAK;QACzD,MAAM,IAAI,GAAG,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;QAC3C,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAEe,KAAK,CAAU;IACf,IAAI,CAAQ;IACrB,MAAM,CAAY;IAEzB,YAAa,UAA8B,EAAE;QAC3C,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,CAAA;QACjD,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAA;IAC/C,CAAC;IAED;;OAEG;IACH,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAChD,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAE5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAClB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAE,IAAyB;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAChD,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAE5B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAE9B,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,KAAK,CAAA;YACd,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,KAAK,GAAG,GAAG,CAAA;QACf,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,GAAG,EAAE,CAAA;YACL,KAAK,IAAI,CAAC,CAAA;QACZ,CAAC;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC/B,QAAQ,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,CAAA;QAC1B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAA;IAC7B,CAAC;IAED,MAAM,CAAE,GAAW;QACjB,IAAI,GAAG,GAAG,CAAC,CAAA;QACX,IAAI,KAAK,GAAG,GAAG,CAAA;QACf,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;YACjB,GAAG,EAAE,CAAA;YACL,KAAK,IAAI,CAAC,CAAA;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACjC,OAAO,CAAC,QAAQ,GAAG,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;CACF;AAED,SAAS,QAAQ,CAAE,SAAiB,EAAE,YAAoB,KAAK;IAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC,CAAA;IAC3E,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAA;IAExD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AACzB,CAAC;AAED,SAAS,aAAa,CAAE,KAAa;IACnC,IAAI,GAAmB,CAAA;IACvB,IAAI,CAAS,CAAA;IACb,MAAM,KAAK,GAAG,EAAE,CAAA;IAEhB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/B,GAAG,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QACxC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;QAEjC,sDAAsD;QACtD,kCAAkC;QAClC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACvB,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC1B,CAAC,EAAE,CAAA;gBACH,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC"}
|