@maci-protocol/domainobjs 0.0.0-ci.1e276ed

package/build/ts/privateKey.d.ts

@@ -0,0 +1,56 @@
+import { type PrivKey as RawPrivKey } from "@maci-protocol/crypto";
+import type { IJsonPrivateKey } from "./types";
+export declare const SERIALIZED_PRIV_KEY_PREFIX = "macisk.";
+/**
+ * @notice PrivKey is a TS Class representing a MACI PrivateKey
+ * which is a seed to be used to generate a public key (point on the curve)
+ * This is a MACI private key, which is not to be
+ * confused with an Ethereum private key.
+ * A serialized MACI private key is prefixed by 'macisk.'
+ */
+export declare class PrivKey {
+    rawPrivKey: RawPrivKey;
+    /**
+     * Generate a new Private key object
+     * @param rawPrivKey the raw private key (a bigint)
+     */
+    constructor(rawPrivKey: RawPrivKey);
+    /**
+     * Create a copy of this Private key
+     * @returns a copy of the Private key
+     */
+    copy: () => PrivKey;
+    /**
+     * Return this Private key as a circuit input
+     * @returns the Private key as a circuit input
+     */
+    asCircuitInputs: () => string;
+    /**
+     * Serialize the private key
+     * @returns the serialized private key
+     */
+    serialize: () => string;
+    /**
+     * Deserialize the private key
+     * @param s the serialized private key
+     * @returns the deserialized private key
+     */
+    static deserialize: (s: string) => PrivKey;
+    /**
+     * Check if the serialized private key is valid
+     * @param s the serialized private key
+     * @returns whether it is a valid serialized private key
+     */
+    static isValidSerializedPrivKey: (s: string) => boolean;
+    /**
+     * Serialize this object
+     */
+    toJSON(): IJsonPrivateKey;
+    /**
+     * Deserialize this object from a JSON object
+     * @param json - the json object
+     * @returns the deserialized object as a PrivKey instance
+     */
+    static fromJSON(json: IJsonPrivateKey): PrivKey;
+}
+//# sourceMappingURL=privateKey.d.ts.map

package/build/ts/privateKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"privateKey.d.ts","sourceRoot":"","sources":["../../ts/privateKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,OAAO,IAAI,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAE5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE/C,eAAO,MAAM,0BAA0B,YAAY,CAAC;AAEpD;;;;;;GAMG;AACH,qBAAa,OAAO;IAClB,UAAU,EAAE,UAAU,CAAC;IAEvB;;;OAGG;gBACS,UAAU,EAAE,UAAU;IAIlC;;;OAGG;IACH,IAAI,QAAO,OAAO,CAAoD;IAEtE;;;OAGG;IACH,eAAe,QAAO,MAAM,CAAwD;IAEpF;;;OAGG;IACH,SAAS,QAAO,MAAM,CAOpB;IAEF;;;;OAIG;IACH,MAAM,CAAC,WAAW,GAAI,GAAG,MAAM,KAAG,OAAO,CAGvC;IAEF;;;;OAIG;IACH,MAAM,CAAC,wBAAwB,GAAI,GAAG,MAAM,KAAG,OAAO,CAKpD;IAEF;;OAEG;IACH,MAAM,IAAI,eAAe;IAMzB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO;CAGhD"}

package/build/ts/privateKey.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrivKey = exports.SERIALIZED_PRIV_KEY_PREFIX = void 0;
+const crypto_1 = require("@maci-protocol/crypto");
+exports.SERIALIZED_PRIV_KEY_PREFIX = "macisk.";
+/**
+ * @notice PrivKey is a TS Class representing a MACI PrivateKey
+ * which is a seed to be used to generate a public key (point on the curve)
+ * This is a MACI private key, which is not to be
+ * confused with an Ethereum private key.
+ * A serialized MACI private key is prefixed by 'macisk.'
+ */
+class PrivKey {
+    /**
+     * Generate a new Private key object
+     * @param rawPrivKey the raw private key (a bigint)
+     */
+    constructor(rawPrivKey) {
+        /**
+         * Create a copy of this Private key
+         * @returns a copy of the Private key
+         */
+        this.copy = () => new PrivKey(BigInt(this.rawPrivKey.toString()));
+        /**
+         * Return this Private key as a circuit input
+         * @returns the Private key as a circuit input
+         */
+        this.asCircuitInputs = () => (0, crypto_1.formatPrivKeyForBabyJub)(this.rawPrivKey).toString();
+        /**
+         * Serialize the private key
+         * @returns the serialized private key
+         */
+        this.serialize = () => {
+            let x = this.rawPrivKey.toString(16);
+            if (x.length % 2 !== 0) {
+                x = `0${x}`;
+            }
+            return `${exports.SERIALIZED_PRIV_KEY_PREFIX}${x.padStart(64, "0")}`;
+        };
+        this.rawPrivKey = rawPrivKey;
+    }
+    /**
+     * Serialize this object
+     */
+    toJSON() {
+        return {
+            privKey: this.serialize(),
+        };
+    }
+    /**
+     * Deserialize this object from a JSON object
+     * @param json - the json object
+     * @returns the deserialized object as a PrivKey instance
+     */
+    static fromJSON(json) {
+        return PrivKey.deserialize(json.privKey);
+    }
+}
+exports.PrivKey = PrivKey;
+/**
+ * Deserialize the private key
+ * @param s the serialized private key
+ * @returns the deserialized private key
+ */
+PrivKey.deserialize = (s) => {
+    const x = s.slice(exports.SERIALIZED_PRIV_KEY_PREFIX.length);
+    return new PrivKey(BigInt(`0x${x}`));
+};
+/**
+ * Check if the serialized private key is valid
+ * @param s the serialized private key
+ * @returns whether it is a valid serialized private key
+ */
+PrivKey.isValidSerializedPrivKey = (s) => {
+    const correctPrefix = s.startsWith(exports.SERIALIZED_PRIV_KEY_PREFIX);
+    const x = s.slice(exports.SERIALIZED_PRIV_KEY_PREFIX.length);
+    return correctPrefix && x.length === 64;
+};
+//# sourceMappingURL=privateKey.js.map

package/build/ts/privateKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"privateKey.js","sourceRoot":"","sources":["../../ts/privateKey.ts"],"names":[],"mappings":";;;AAAA,kDAA4F;AAI/E,QAAA,0BAA0B,GAAG,SAAS,CAAC;AAEpD;;;;;;GAMG;AACH,MAAa,OAAO;IAGlB;;;OAGG;IACH,YAAY,UAAsB;QAIlC;;;WAGG;QACH,SAAI,GAAG,GAAY,EAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAEtE;;;WAGG;QACH,oBAAe,GAAG,GAAW,EAAE,CAAC,IAAA,gCAAuB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEpF;;;WAGG;QACH,cAAS,GAAG,GAAW,EAAE;YACvB,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvB,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;YACd,CAAC;YAED,OAAO,GAAG,kCAA0B,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC;QAC/D,CAAC,CAAC;QA1BA,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAiDD;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS,EAAE;SAC1B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAqB;QACnC,OAAO,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;;AA1EH,0BA2EC;AAvCC;;;;GAIG;AACI,mBAAW,GAAG,CAAC,CAAS,EAAW,EAAE;IAC1C,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,MAAM,CAAC,CAAC;IACrD,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;AACvC,CAAC,AAHiB,CAGhB;AAEF;;;;GAIG;AACI,gCAAwB,GAAG,CAAC,CAAS,EAAW,EAAE;IACvD,MAAM,aAAa,GAAG,CAAC,CAAC,UAAU,CAAC,kCAA0B,CAAC,CAAC;IAC/D,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,kCAA0B,CAAC,MAAM,CAAC,CAAC;IAErD,OAAO,aAAa,IAAI,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC;AAC1C,CAAC,AAL8B,CAK7B"}

package/build/ts/publicKey.d.ts

@@ -0,0 +1,89 @@
+import { type PubKey as RawPubKey } from "@maci-protocol/crypto";
+import type { IJsonPublicKey, IG1ContractParams } from "./types";
+export declare const SERIALIZED_PUB_KEY_PREFIX = "macipk.";
+/**
+ * @notice A class representing a public key
+ * This is a MACI public key, which is not to be
+ * confused with an Ethereum public key.
+ * A serialized MACI public key is prefixed by 'macipk.'
+ * A raw MACI public key can be thought as a pair of
+ * BigIntegers (x, y) representing a point on the baby jubjub curve
+ */
+export declare class PubKey {
+    rawPubKey: RawPubKey;
+    /**
+     * Create a new instance of a public key
+     * @dev You might want to allow an invalid raw key,
+     * as when decrypting invalid messages, the public key data
+     * will be random, and likely not be a point on the curve.
+     * However we need to match keys to the circuit which does
+     * not perform such checks
+     * @param rawPubKey the raw public key
+     * @param allowInvalid whether to allow invalid public keys
+     */
+    constructor(rawPubKey: RawPubKey, allowInvalid?: boolean);
+    /**
+     * Create a copy of the public key
+     * @returns a copy of the public key
+     */
+    copy: () => PubKey;
+    /**
+     * Return this public key as smart contract parameters
+     * @returns the public key as smart contract parameters
+     */
+    asContractParam: () => IG1ContractParams;
+    /**
+     * Return this public key as circuit inputs
+     * @returns an array of strings
+     */
+    asCircuitInputs: () => string[];
+    /**
+     * Return this public key as an array of bigints
+     * @returns the public key as an array of bigints
+     */
+    asArray: () => bigint[];
+    /**
+     * Generate a serialized public key from this public key object
+     * @returns the string representation of a serialized public key
+     */
+    serialize: () => string;
+    /**
+     * Hash the two baby jubjub coordinates
+     * @returns the hash of this public key
+     */
+    hash: () => bigint;
+    /**
+     * Check whether this public key equals to another public key
+     * @param p the public key to compare with
+     * @returns whether they match
+     */
+    equals: (p: PubKey) => boolean;
+    /**
+     * Deserialize a serialized public key
+     * @param s the serialized public key
+     * @returns the deserialized public key
+     */
+    static deserialize: (s: string) => PubKey;
+    /**
+     * Check whether a serialized public key is serialized correctly
+     * @param s the serialized public key
+     * @returns whether the serialized public key is valid
+     */
+    static isValidSerializedPubKey: (s: string) => boolean;
+    /**
+     * Serialize this object
+     */
+    toJSON(): IJsonPublicKey;
+    /**
+     * Deserialize a JSON object into a PubKey instance
+     * @param json - the json object
+     * @returns PubKey
+     */
+    static fromJSON(json: IJsonPublicKey): PubKey;
+    /**
+     * Generate a default pad key
+     * @returns a default pad key
+     */
+    static genPadKey(): PubKey;
+}
+//# sourceMappingURL=publicKey.d.ts.map

package/build/ts/publicKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicKey.d.ts","sourceRoot":"","sources":["../../ts/publicKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoD,KAAK,MAAM,IAAI,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAInH,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEjE,eAAO,MAAM,yBAAyB,YAAY,CAAC;AAEnD;;;;;;;GAOG;AACH,qBAAa,MAAM;IACjB,SAAS,EAAE,SAAS,CAAC;IAErB;;;;;;;;;OASG;gBACS,SAAS,EAAE,SAAS,EAAE,YAAY,UAAQ;IAOtD;;;OAGG;IACH,IAAI,QAAO,MAAM,CAA6F;IAE9G;;;OAGG;IACH,eAAe,QAAO,iBAAiB,CAOrC;IAEF;;;OAGG;IACH,eAAe,QAAO,MAAM,EAAE,CAA4C;IAE1E;;;OAGG;IACH,OAAO,QAAO,MAAM,EAAE,CAA2C;IAEjE;;;OAGG;IACH,SAAS,QAAO,MAAM,CAQpB;IAEF;;;OAGG;IACH,IAAI,QAAO,MAAM,CAAwD;IAEzE;;;;OAIG;IACH,MAAM,GAAI,GAAG,MAAM,KAAG,OAAO,CAAiF;IAE9G;;;;OAIG;IACH,MAAM,CAAC,WAAW,GAAI,GAAG,MAAM,KAAG,MAAM,CAGtC;IAEF;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,GAAI,GAAG,MAAM,KAAG,OAAO,CASnD;IAEF;;OAEG;IACH,MAAM,IAAI,cAAc;IAMxB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM;IAI7C;;;OAGG;IACH,MAAM,CAAC,SAAS,IAAI,MAAM;CAY3B"}

package/build/ts/publicKey.js

@@ -0,0 +1,141 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubKey = exports.SERIALIZED_PUB_KEY_PREFIX = void 0;
+const crypto_1 = require("@maci-protocol/crypto");
+const assert_1 = __importDefault(require("assert"));
+exports.SERIALIZED_PUB_KEY_PREFIX = "macipk.";
+/**
+ * @notice A class representing a public key
+ * This is a MACI public key, which is not to be
+ * confused with an Ethereum public key.
+ * A serialized MACI public key is prefixed by 'macipk.'
+ * A raw MACI public key can be thought as a pair of
+ * BigIntegers (x, y) representing a point on the baby jubjub curve
+ */
+class PubKey {
+    /**
+     * Create a new instance of a public key
+     * @dev You might want to allow an invalid raw key,
+     * as when decrypting invalid messages, the public key data
+     * will be random, and likely not be a point on the curve.
+     * However we need to match keys to the circuit which does
+     * not perform such checks
+     * @param rawPubKey the raw public key
+     * @param allowInvalid whether to allow invalid public keys
+     */
+    constructor(rawPubKey, allowInvalid = false) {
+        /**
+         * Create a copy of the public key
+         * @returns a copy of the public key
+         */
+        this.copy = () => new PubKey([BigInt(this.rawPubKey[0].toString()), BigInt(this.rawPubKey[1].toString())]);
+        /**
+         * Return this public key as smart contract parameters
+         * @returns the public key as smart contract parameters
+         */
+        this.asContractParam = () => {
+            const [x, y] = this.rawPubKey;
+            return {
+                x: x.toString(),
+                y: y.toString(),
+            };
+        };
+        /**
+         * Return this public key as circuit inputs
+         * @returns an array of strings
+         */
+        this.asCircuitInputs = () => this.rawPubKey.map((x) => x.toString());
+        /**
+         * Return this public key as an array of bigints
+         * @returns the public key as an array of bigints
+         */
+        this.asArray = () => [this.rawPubKey[0], this.rawPubKey[1]];
+        /**
+         * Generate a serialized public key from this public key object
+         * @returns the string representation of a serialized public key
+         */
+        this.serialize = () => {
+            const packed = (0, crypto_1.packPubKey)(this.rawPubKey).toString(16);
+            if (packed.length % 2 !== 0) {
+                return `${exports.SERIALIZED_PUB_KEY_PREFIX}0${packed}`;
+            }
+            return `${exports.SERIALIZED_PUB_KEY_PREFIX}${packed}`;
+        };
+        /**
+         * Hash the two baby jubjub coordinates
+         * @returns the hash of this public key
+         */
+        this.hash = () => (0, crypto_1.hashLeftRight)(this.rawPubKey[0], this.rawPubKey[1]);
+        /**
+         * Check whether this public key equals to another public key
+         * @param p the public key to compare with
+         * @returns whether they match
+         */
+        this.equals = (p) => this.rawPubKey[0] === p.rawPubKey[0] && this.rawPubKey[1] === p.rawPubKey[1];
+        if (!allowInvalid) {
+            (0, assert_1.default)((0, crypto_1.inCurve)(rawPubKey), "PubKey not on curve");
+        }
+        this.rawPubKey = rawPubKey;
+    }
+    /**
+     * Serialize this object
+     */
+    toJSON() {
+        return {
+            pubKey: this.serialize(),
+        };
+    }
+    /**
+     * Deserialize a JSON object into a PubKey instance
+     * @param json - the json object
+     * @returns PubKey
+     */
+    static fromJSON(json) {
+        return PubKey.deserialize(json.pubKey);
+    }
+    /**
+     * Generate a default pad key
+     * @returns a default pad key
+     */
+    static genPadKey() {
+        // This public key is the first Pedersen base
+        // point from iden3's circomlib implementation of the Pedersen hash.
+        // Since it is generated using a hash-to-curve function, we are
+        // confident that no-one knows the private key associated with this
+        // public key. See:
+        // https://github.com/iden3/circomlib/blob/d5ed1c3ce4ca137a6b3ca48bec4ac12c1b38957a/src/pedersen_printbases.js
+        return new PubKey([
+            BigInt("10457101036533406547632367118273992217979173478358440826365724437999023779287"),
+            BigInt("19824078218392094440610104313265183977899662750282163392862422243483260492317"),
+        ]);
+    }
+}
+exports.PubKey = PubKey;
+/**
+ * Deserialize a serialized public key
+ * @param s the serialized public key
+ * @returns the deserialized public key
+ */
+PubKey.deserialize = (s) => {
+    const len = exports.SERIALIZED_PUB_KEY_PREFIX.length;
+    return new PubKey((0, crypto_1.unpackPubKey)(BigInt(`0x${s.slice(len).toString()}`)));
+};
+/**
+ * Check whether a serialized public key is serialized correctly
+ * @param s the serialized public key
+ * @returns whether the serialized public key is valid
+ */
+PubKey.isValidSerializedPubKey = (s) => {
+    const correctPrefix = s.startsWith(exports.SERIALIZED_PUB_KEY_PREFIX);
+    try {
+        PubKey.deserialize(s);
+        return correctPrefix;
+    }
+    catch {
+        return false;
+    }
+};
+//# sourceMappingURL=publicKey.js.map

package/build/ts/publicKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publicKey.js","sourceRoot":"","sources":["../../ts/publicKey.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAmH;AAEnH,oDAA4B;AAIf,QAAA,yBAAyB,GAAG,SAAS,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAa,MAAM;IAGjB;;;;;;;;;OASG;IACH,YAAY,SAAoB,EAAE,YAAY,GAAG,KAAK;QAOtD;;;WAGG;QACH,SAAI,GAAG,GAAW,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9G;;;WAGG;QACH,oBAAe,GAAG,GAAsB,EAAE;YACxC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YAE9B,OAAO;gBACL,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACf,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;aAChB,CAAC;QACJ,CAAC,CAAC;QAEF;;;WAGG;QACH,oBAAe,GAAG,GAAa,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE1E;;;WAGG;QACH,YAAO,GAAG,GAAa,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAEjE;;;WAGG;QACH,cAAS,GAAG,GAAW,EAAE;YACvB,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAEvD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,OAAO,GAAG,iCAAyB,IAAI,MAAM,EAAE,CAAC;YAClD,CAAC;YAED,OAAO,GAAG,iCAAyB,GAAG,MAAM,EAAE,CAAC;QACjD,CAAC,CAAC;QAEF;;;WAGG;QACH,SAAI,GAAG,GAAW,EAAE,CAAC,IAAA,sBAAa,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzE;;;;WAIG;QACH,WAAM,GAAG,CAAC,CAAS,EAAW,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QA9D5G,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,IAAA,gBAAM,EAAC,IAAA,gBAAO,EAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAsFD;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE;SACzB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAoB;QAClC,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,SAAS;QACd,6CAA6C;QAC7C,oEAAoE;QACpE,+DAA+D;QAC/D,mEAAmE;QACnE,mBAAmB;QACnB,8GAA8G;QAC9G,OAAO,IAAI,MAAM,CAAC;YAChB,MAAM,CAAC,+EAA+E,CAAC;YACvF,MAAM,CAAC,+EAA+E,CAAC;SACxF,CAAC,CAAC;IACL,CAAC;;AAzIH,wBA0IC;AA5DC;;;;GAIG;AACI,kBAAW,GAAG,CAAC,CAAS,EAAU,EAAE;IACzC,MAAM,GAAG,GAAG,iCAAyB,CAAC,MAAM,CAAC;IAC7C,OAAO,IAAI,MAAM,CAAC,IAAA,qBAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC,AAHiB,CAGhB;AAEF;;;;GAIG;AACI,8BAAuB,GAAG,CAAC,CAAS,EAAW,EAAE;IACtD,MAAM,aAAa,GAAG,CAAC,CAAC,UAAU,CAAC,iCAAyB,CAAC,CAAC;IAE9D,IAAI,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;QACtB,OAAO,aAAa,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,AAT6B,CAS5B"}

package/build/ts/stateLeaf.d.ts

@@ -0,0 +1,83 @@
+import type { IJsonStateLeaf, IStateLeaf, IStateLeafContractParams } from "./types";
+import { PubKey } from "./publicKey";
+/**
+ * @notice A leaf in the state tree, which maps
+ * public keys to voice credit balances
+ */
+export declare class StateLeaf implements IStateLeaf {
+    pubKey: PubKey;
+    voiceCreditBalance: bigint;
+    timestamp: bigint;
+    /**
+     * Create a new instance of a state leaf
+     * @param pubKey the public key of the user signin up
+     * @param voiceCreditBalance the voice credit balance of the user
+     * @param timestamp the timestamp of when the user signed-up
+     */
+    constructor(pubKey: PubKey, voiceCreditBalance: bigint, timestamp: bigint);
+    /**
+     * Crate a deep copy of the object
+     * @returns a copy of the state leaf
+     */
+    copy(): StateLeaf;
+    /**
+     * Generate a blank state leaf
+     * @returns a blank state leaf
+     */
+    static genBlankLeaf(): StateLeaf;
+    /**
+     * Generate a random leaf (random salt and random key pair)
+     * @returns a random state leaf
+     */
+    static genRandomLeaf(): StateLeaf;
+    /**
+     * Return this state leaf as an array of bigints
+     * @returns the state leaf as an array of bigints
+     */
+    private asArray;
+    /**
+     * Return this state leaf as an array of bigints
+     * @returns the state leaf as an array of bigints
+     */
+    asCircuitInputs: () => bigint[];
+    /**
+     * Hash this state leaf (first convert as array)
+     * @returns the has of the state leaf elements
+     */
+    hash: () => bigint;
+    /**
+     * Return this state leaf as a contract param
+     * @returns the state leaf as a contract param (object)
+     */
+    asContractParam(): IStateLeafContractParams;
+    /**
+     * Check if two state leaves are equal
+     * @param s the state leaf to compare with
+     * @returns whether they are equal or not
+     */
+    equals(s: StateLeaf): boolean;
+    /**
+     * Serialize the state leaf
+     * @notice serialize the public key
+     * @notice convert the voice credit balance and timestamp to a hex string
+     * @returns
+     */
+    serialize: () => string;
+    /**
+     * Deserialize the state leaf
+     * @param serialized the serialized state leaf
+     * @returns a deserialized state leaf
+     */
+    static deserialize: (serialized: string) => StateLeaf;
+    /**
+     * Serialize to a JSON object
+     */
+    toJSON(): IJsonStateLeaf;
+    /**
+     * Deserialize into a StateLeaf instance
+     * @param json - the json representation
+     * @returns the deserialized object as a StateLeaf instance
+     */
+    static fromJSON(json: IJsonStateLeaf): StateLeaf;
+}
+//# sourceMappingURL=stateLeaf.d.ts.map

package/build/ts/stateLeaf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateLeaf.d.ts","sourceRoot":"","sources":["../../ts/stateLeaf.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAGpF,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;GAGG;AACH,qBAAa,SAAU,YAAW,UAAU;IAC1C,MAAM,EAAE,MAAM,CAAC;IAEf,kBAAkB,EAAE,MAAM,CAAC;IAE3B,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAMzE;;;OAGG;IACH,IAAI,IAAI,SAAS;IAQjB;;;OAGG;IACH,MAAM,CAAC,YAAY,IAAI,SAAS;IAmBhC;;;OAGG;IACH,MAAM,CAAC,aAAa,IAAI,SAAS;IAKjC;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAuF;IAEtG;;;OAGG;IACH,eAAe,QAAO,MAAM,EAAE,CAAmB;IAEjD;;;OAGG;IACH,IAAI,QAAO,MAAM,CAA0B;IAE3C;;;OAGG;IACH,eAAe,IAAI,wBAAwB;IAQ3C;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAM7B;;;;;OAKG;IACH,SAAS,QAAO,MAAM,CAIpB;IAEF;;;;OAIG;IACH,MAAM,CAAC,WAAW,GAAI,YAAY,MAAM,KAAG,SAAS,CAKlD;IAEF;;OAEG;IACH,MAAM,IAAI,cAAc;IAQxB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;CAGjD"}

package/build/ts/stateLeaf.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateLeaf = void 0;
+const crypto_1 = require("@maci-protocol/crypto");
+const keyPair_1 = require("./keyPair");
+const publicKey_1 = require("./publicKey");
+/**
+ * @notice A leaf in the state tree, which maps
+ * public keys to voice credit balances
+ */
+class StateLeaf {
+    /**
+     * Create a new instance of a state leaf
+     * @param pubKey the public key of the user signin up
+     * @param voiceCreditBalance the voice credit balance of the user
+     * @param timestamp the timestamp of when the user signed-up
+     */
+    constructor(pubKey, voiceCreditBalance, timestamp) {
+        /**
+         * Return this state leaf as an array of bigints
+         * @returns the state leaf as an array of bigints
+         */
+        this.asArray = () => [...this.pubKey.asArray(), this.voiceCreditBalance, this.timestamp];
+        /**
+         * Return this state leaf as an array of bigints
+         * @returns the state leaf as an array of bigints
+         */
+        this.asCircuitInputs = () => this.asArray();
+        /**
+         * Hash this state leaf (first convert as array)
+         * @returns the has of the state leaf elements
+         */
+        this.hash = () => (0, crypto_1.hash4)(this.asArray());
+        /**
+         * Serialize the state leaf
+         * @notice serialize the public key
+         * @notice convert the voice credit balance and timestamp to a hex string
+         * @returns
+         */
+        this.serialize = () => {
+            const j = [this.pubKey.serialize(), this.voiceCreditBalance.toString(16), this.timestamp.toString(16)];
+            return Buffer.from(JSON.stringify(j, null, 0), "utf8").toString("base64url");
+        };
+        this.pubKey = pubKey;
+        this.voiceCreditBalance = voiceCreditBalance;
+        this.timestamp = timestamp;
+    }
+    /**
+     * Crate a deep copy of the object
+     * @returns a copy of the state leaf
+     */
+    copy() {
+        return new StateLeaf(this.pubKey.copy(), BigInt(this.voiceCreditBalance.toString()), BigInt(this.timestamp.toString()));
+    }
+    /**
+     * Generate a blank state leaf
+     * @returns a blank state leaf
+     */
+    static genBlankLeaf() {
+        // The public key for a blank state leaf is the first Pedersen base
+        // point from iden3's circomlib implementation of the Pedersen hash.
+        // Since it is generated using a hash-to-curve function, we are
+        // confident that no-one knows the private key associated with this
+        // public key. See:
+        // https://github.com/iden3/circomlib/blob/d5ed1c3ce4ca137a6b3ca48bec4ac12c1b38957a/src/pedersen_printbases.js
+        // Its hash should equal
+        // 6769006970205099520508948723718471724660867171122235270773600567925038008762.
+        return new StateLeaf(new publicKey_1.PubKey([
+            BigInt("10457101036533406547632367118273992217979173478358440826365724437999023779287"),
+            BigInt("19824078218392094440610104313265183977899662750282163392862422243483260492317"),
+        ]), BigInt(0), BigInt(0));
+    }
+    /**
+     * Generate a random leaf (random salt and random key pair)
+     * @returns a random state leaf
+     */
+    static genRandomLeaf() {
+        const keypair = new keyPair_1.Keypair();
+        return new StateLeaf(keypair.pubKey, (0, crypto_1.genRandomSalt)(), BigInt(0));
+    }
+    /**
+     * Return this state leaf as a contract param
+     * @returns the state leaf as a contract param (object)
+     */
+    asContractParam() {
+        return {
+            pubKey: this.pubKey.asContractParam(),
+            voiceCreditBalance: this.voiceCreditBalance.toString(),
+            timestamp: this.timestamp.toString(),
+        };
+    }
+    /**
+     * Check if two state leaves are equal
+     * @param s the state leaf to compare with
+     * @returns whether they are equal or not
+     */
+    equals(s) {
+        return (this.pubKey.equals(s.pubKey) && this.voiceCreditBalance === s.voiceCreditBalance && this.timestamp === s.timestamp);
+    }
+    /**
+     * Serialize to a JSON object
+     */
+    toJSON() {
+        return {
+            pubKey: this.pubKey.serialize(),
+            voiceCreditBalance: this.voiceCreditBalance.toString(),
+            timestamp: this.timestamp.toString(),
+        };
+    }
+    /**
+     * Deserialize into a StateLeaf instance
+     * @param json - the json representation
+     * @returns the deserialized object as a StateLeaf instance
+     */
+    static fromJSON(json) {
+        return new StateLeaf(publicKey_1.PubKey.deserialize(json.pubKey), BigInt(json.voiceCreditBalance), BigInt(json.timestamp));
+    }
+}
+exports.StateLeaf = StateLeaf;
+/**
+ * Deserialize the state leaf
+ * @param serialized the serialized state leaf
+ * @returns a deserialized state leaf
+ */
+StateLeaf.deserialize = (serialized) => {
+    const base64 = serialized.replace(/-/g, "+").replace(/_/g, "/");
+    const json = JSON.parse(Buffer.from(base64, "base64").toString("utf8"));
+    return new StateLeaf(publicKey_1.PubKey.deserialize(json[0]), BigInt(`0x${json[1]}`), BigInt(`0x${json[2]}`));
+};
+//# sourceMappingURL=stateLeaf.js.map

package/build/ts/stateLeaf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stateLeaf.js","sourceRoot":"","sources":["../../ts/stateLeaf.ts"],"names":[],"mappings":";;;AAAA,kDAA6D;AAI7D,uCAAoC;AACpC,2CAAqC;AAErC;;;GAGG;AACH,MAAa,SAAS;IAOpB;;;;;OAKG;IACH,YAAY,MAAc,EAAE,kBAA0B,EAAE,SAAiB;QAkDzE;;;WAGG;QACK,YAAO,GAAG,GAAa,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtG;;;WAGG;QACH,oBAAe,GAAG,GAAa,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QAEjD;;;WAGG;QACH,SAAI,GAAG,GAAW,EAAE,CAAC,IAAA,cAAK,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAyB3C;;;;;WAKG;QACH,cAAS,GAAG,GAAW,EAAE;YACvB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAEvG,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC/E,CAAC,CAAC;QApGA,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,OAAO,IAAI,SAAS,CAClB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,EAClB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,EAC1C,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAClC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,YAAY;QACjB,mEAAmE;QACnE,oEAAoE;QACpE,+DAA+D;QAC/D,mEAAmE;QACnE,mBAAmB;QACnB,8GAA8G;QAC9G,wBAAwB;QACxB,gFAAgF;QAChF,OAAO,IAAI,SAAS,CAClB,IAAI,kBAAM,CAAC;YACT,MAAM,CAAC,+EAA+E,CAAC;YACvF,MAAM,CAAC,+EAA+E,CAAC;SACxF,CAAC,EACF,MAAM,CAAC,CAAC,CAAC,EACT,MAAM,CAAC,CAAC,CAAC,CACV,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,aAAa;QAClB,MAAM,OAAO,GAAG,IAAI,iBAAO,EAAE,CAAC;QAC9B,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,IAAA,sBAAa,GAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC;IAoBD;;;OAGG;IACH,eAAe;QACb,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE;YACrC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE;YACtD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;SACrC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAY;QACjB,OAAO,CACL,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,kBAAkB,KAAK,CAAC,CAAC,kBAAkB,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,CAAC,SAAS,CACnH,CAAC;IACJ,CAAC;IA0BD;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YAC/B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE;YACtD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE;SACrC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAoB;QAClC,OAAO,IAAI,SAAS,CAAC,kBAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACjH,CAAC;;AAlJH,8BAmJC;AA/BC;;;;GAIG;AACI,qBAAW,GAAG,CAAC,UAAkB,EAAa,EAAE;IACrD,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAA6B,CAAC;IAEpG,OAAO,IAAI,SAAS,CAAC,kBAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACpG,CAAC,AALiB,CAKhB"}