@midnight-ntwrk/wallet-sdk-address-format 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# Midnight Wallet SDK Address Format
+
+This package provides support for the Bech32m address format.

package/dist/index.cjs

@@ -0,0 +1,146 @@
+'use strict';
+
+var zswap = require('@midnight-ntwrk/zswap');
+var base = require('@scure/base');
+
+class MidnightBech32m {
+    type;
+    network;
+    data;
+    static prefix = 'mn';
+    static validateSegment(segmentName, segment) {
+        const result = /^[A-Za-z1-9-]+$/.test(segment);
+        if (!result) {
+            throw new Error(`Segment ${segmentName}: ${segment} contains disallowed characters. Allowed characters are only numbers, latin letters and a hyphen`);
+        }
+    }
+    static parse(bech32string) {
+        const bech32parsed = base.bech32m.decodeToBytes(bech32string);
+        const [prefix, type, network = null] = bech32parsed.prefix.split('_');
+        if (prefix != MidnightBech32m.prefix) {
+            throw new Error(`Expected prefix ${MidnightBech32m.prefix}`);
+        }
+        MidnightBech32m.validateSegment('type', type);
+        if (network != null) {
+            MidnightBech32m.validateSegment('network', network);
+        }
+        return new MidnightBech32m(type, network, Buffer.from(bech32parsed.bytes));
+    }
+    constructor(type, network, data) {
+        this.type = type;
+        this.network = network;
+        this.data = data;
+        MidnightBech32m.validateSegment('type', type);
+        if (network != null) {
+            MidnightBech32m.validateSegment('network', network);
+        }
+    }
+    asString() {
+        const networkSegment = this.network == null ? '' : `_${this.network}`;
+        return base.bech32m.encode(`${MidnightBech32m.prefix}_${this.type}${networkSegment}`, base.bech32m.toWords(this.data), false);
+    }
+}
+class Bech32mCodec {
+    type;
+    dataToBytes;
+    dataFromBytes;
+    constructor(type, dataToBytes, dataFromBytes) {
+        this.type = type;
+        this.dataToBytes = dataToBytes;
+        this.dataFromBytes = dataFromBytes;
+    }
+    encode(networkId, data) {
+        const context = Bech32mCodec.createContext(networkId);
+        return new MidnightBech32m(this.type, context.networkId, this.dataToBytes(data));
+    }
+    decode(networkId, repr) {
+        const context = Bech32mCodec.createContext(networkId);
+        if (repr.type != this.type) {
+            throw new Error(`Expected type ${this.type}, got ${repr.type}`);
+        }
+        if (context.networkId != repr.network) {
+            throw new Error(`Expected ${context.networkId ?? 'mainnet'} address, got ${repr.network ?? 'mainnet'} one`);
+        }
+        return this.dataFromBytes(repr.data);
+    }
+    static createContext(networkId) {
+        if (networkId === null) {
+            return { networkId: null };
+        }
+        else if (typeof networkId === 'string') {
+            return { networkId };
+        }
+        else {
+            return Bech32mCodec.createContextFromZswap(networkId);
+        }
+    }
+    static createContextFromZswap(networkId) {
+        switch (networkId) {
+            case zswap.NetworkId.DevNet:
+                return { networkId: 'dev' };
+            case zswap.NetworkId.MainNet:
+                return { networkId: null };
+            case zswap.NetworkId.TestNet:
+                return { networkId: 'test' };
+            case zswap.NetworkId.Undeployed:
+                return { networkId: 'undeployed' };
+            default:
+                return { networkId: null };
+        }
+    }
+}
+class ShieldedAddress {
+    coinPublicKey;
+    encryptionPublicKey;
+    static codec = new Bech32mCodec('shield-addr', (addr) => Buffer.concat([addr.coinPublicKey.data, addr.encryptionPublicKey.data]), (bytes) => {
+        const coinPublicKey = new ShieldedCoinPublicKey(bytes.subarray(0, ShieldedCoinPublicKey.key_length));
+        const encryptionPublicKey = new ShieldedEncryptionPublicKey(bytes.subarray(ShieldedCoinPublicKey.key_length));
+        return new ShieldedAddress(coinPublicKey, encryptionPublicKey);
+    });
+    constructor(coinPublicKey, encryptionPublicKey) {
+        this.coinPublicKey = coinPublicKey;
+        this.encryptionPublicKey = encryptionPublicKey;
+    }
+    coinPublicKeyString() {
+        return this.coinPublicKey.data.toString('hex');
+    }
+    encryptionPublicKeyString() {
+        return this.encryptionPublicKey.data.toString('hex');
+    }
+}
+class ShieldedEncryptionSecretKey {
+    zswap;
+    static codec = new Bech32mCodec('shield-esk', (esk) => Buffer.from(esk.zswap.yesIKnowTheSecurityImplicationsOfThis_serialize(zswap.NetworkId.Undeployed).subarray(1)), (repr) => new ShieldedEncryptionSecretKey(zswap.EncryptionSecretKey.deserialize(Buffer.concat([Buffer.of(0), repr]), zswap.NetworkId.Undeployed)));
+    // There are some bits in serialization of field elements and elliptic curve points, that are hard to replicate
+    // Thus using zswap implementation directly for serialization purposes
+    constructor(zswap) {
+        this.zswap = zswap;
+    }
+}
+class ShieldedCoinPublicKey {
+    data;
+    static key_length = 32;
+    static codec = new Bech32mCodec('shield-cpk', (cpk) => cpk.data, (repr) => new ShieldedCoinPublicKey(repr));
+    constructor(data) {
+        this.data = data;
+        if (data.length != ShieldedCoinPublicKey.key_length) {
+            throw new Error('Coin public key needs to be 32 bytes long');
+        }
+    }
+}
+class ShieldedEncryptionPublicKey {
+    data;
+    static key_length = 32;
+    static codec = new Bech32mCodec('shield-epk', (cpk) => cpk.data, (repr) => new ShieldedEncryptionPublicKey(repr));
+    constructor(data) {
+        this.data = data;
+    }
+}
+
+exports.Bech32mCodec = Bech32mCodec;
+exports.MidnightBech32m = MidnightBech32m;
+exports.ShieldedAddress = ShieldedAddress;
+exports.ShieldedCoinPublicKey = ShieldedCoinPublicKey;
+exports.ShieldedEncryptionPublicKey = ShieldedEncryptionPublicKey;
+exports.ShieldedEncryptionSecretKey = ShieldedEncryptionSecretKey;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":[null],"names":["bech32m","NetworkId","EncryptionSecretKey"],"mappings":";;;;;MAOa,eAAe,CAAA;AA2BR,IAAA,IAAA;AACA,IAAA,OAAA;AACA,IAAA,IAAA;AA5BX,IAAA,OAAgB,MAAM,GAAG,IAAI;AAEpC,IAAA,OAAO,eAAe,CAAC,WAAmB,EAAE,OAAe,EAAA;QACzD,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9C,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,WAAW,CAAK,EAAA,EAAA,OAAO,CAAkG,gGAAA,CAAA,CACrI;;;IAIL,OAAO,KAAK,CAAC,YAAoB,EAAA;QAC/B,MAAM,YAAY,GAAGA,YAAO,CAAC,aAAa,CAAC,YAAY,CAAC;AACxD,QAAA,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AACrE,QAAA,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,CAAA,gBAAA,EAAmB,eAAe,CAAC,MAAM,CAAE,CAAA,CAAC;;AAE9D,QAAA,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;AAC7C,QAAA,IAAI,OAAO,IAAI,IAAI,EAAE;AACnB,YAAA,eAAe,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC;;AAGrD,QAAA,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;;AAG5E,IAAA,WAAA,CACkB,IAAY,EACZ,OAAsB,EACtB,IAAY,EAAA;QAFZ,IAAI,CAAA,IAAA,GAAJ,IAAI;QACJ,IAAO,CAAA,OAAA,GAAP,OAAO;QACP,IAAI,CAAA,IAAA,GAAJ,IAAI;AAEpB,QAAA,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;AAC7C,QAAA,IAAI,OAAO,IAAI,IAAI,EAAE;AACnB,YAAA,eAAe,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC;;;IAIvD,QAAQ,GAAA;AACN,QAAA,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,GAAG,EAAE,GAAG,CAAA,CAAA,EAAI,IAAI,CAAC,OAAO,EAAE;QACrE,OAAOA,YAAO,CAAC,MAAM,CAAC,CAAA,EAAG,eAAe,CAAC,MAAM,CAAA,CAAA,EAAI,IAAI,CAAC,IAAI,CAAA,EAAG,cAAc,CAAA,CAAE,EAAEA,YAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;;;MAI1G,YAAY,CAAA;AAEL,IAAA,IAAA;AACA,IAAA,WAAA;AACA,IAAA,aAAA;AAHlB,IAAA,WAAA,CACkB,IAAY,EACZ,WAAgC,EAChC,aAAmC,EAAA;QAFnC,IAAI,CAAA,IAAA,GAAJ,IAAI;QACJ,IAAW,CAAA,WAAA,GAAX,WAAW;QACX,IAAa,CAAA,aAAA,GAAb,aAAa;;IAG/B,MAAM,CAAC,SAAoB,EAAE,IAAO,EAAA;QAClC,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC;AACrD,QAAA,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;;IAGlF,MAAM,CAAC,SAAoC,EAAE,IAAqB,EAAA;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC;QACrD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;AAC1B,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,cAAA,EAAiB,IAAI,CAAC,IAAI,CAAA,MAAA,EAAS,IAAI,CAAC,IAAI,CAAA,CAAE,CAAC;;QAEjE,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE;AACrC,YAAA,MAAM,IAAI,KAAK,CAAC,CAAY,SAAA,EAAA,OAAO,CAAC,SAAS,IAAI,SAAS,CAAA,cAAA,EAAiB,IAAI,CAAC,OAAO,IAAI,SAAS,CAAA,IAAA,CAAM,CAAC;;QAE7G,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;;IAGtC,OAAO,aAAa,CAAC,SAAoC,EAAA;AACvD,QAAA,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;;AACrB,aAAA,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACxC,OAAO,EAAE,SAAS,EAAE;;aACf;AACL,YAAA,OAAO,YAAY,CAAC,sBAAsB,CAAC,SAAS,CAAC;;;IAIzD,OAAO,sBAAsB,CAAC,SAAoB,EAAA;QAChD,QAAQ,SAAS;YACf,KAAKC,eAAS,CAAC,MAAM;AACnB,gBAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE;YAC7B,KAAKA,eAAS,CAAC,OAAO;AACpB,gBAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;YAC5B,KAAKA,eAAS,CAAC,OAAO;AACpB,gBAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE;YAC9B,KAAKA,eAAS,CAAC,UAAU;AACvB,gBAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE;AACpC,YAAA;AACE,gBAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;;;AAGjC;MAEY,eAAe,CAAA;AAYR,IAAA,aAAA;AACA,IAAA,mBAAA;AAZlB,IAAA,OAAO,KAAK,GAAG,IAAI,YAAY,CAC7B,aAAa,EACb,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,EACjF,CAAC,KAAK,KAAI;AACR,QAAA,MAAM,aAAa,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;AACpG,QAAA,MAAM,mBAAmB,GAAG,IAAI,2BAA2B,CAAC,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAC7G,QAAA,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,mBAAmB,CAAC;AAChE,KAAC,CACF;IAED,WACkB,CAAA,aAAoC,EACpC,mBAAgD,EAAA;QADhD,IAAa,CAAA,aAAA,GAAb,aAAa;QACb,IAAmB,CAAA,mBAAA,GAAnB,mBAAmB;;IAGrC,mBAAmB,GAAA;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;;IAGhD,yBAAyB,GAAA;QACvB,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;;;MAI3C,2BAA2B,CAAA;AAYV,IAAA,KAAA;AAX5B,IAAA,OAAO,KAAK,GAAG,IAAI,YAAY,CAC7B,YAAY,EACZ,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+CAA+C,CAACA,eAAS,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EACjH,CAAC,IAAI,KACH,IAAI,2BAA2B,CAC7BC,yBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAED,eAAS,CAAC,UAAU,CAAC,CAC3F,CACJ;;;AAID,IAAA,WAAA,CAA4B,KAA0B,EAAA;QAA1B,IAAK,CAAA,KAAA,GAAL,KAAK;;;MAGtB,qBAAqB,CAAA;AASJ,IAAA,IAAA;AAR5B,IAAA,OAAgB,UAAU,GAAG,EAAE;AAE/B,IAAA,OAAO,KAAK,GAAwC,IAAI,YAAY,CAClE,YAAY,EACZ,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EACjB,CAAC,IAAI,KAAK,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAC1C;AAED,IAAA,WAAA,CAA4B,IAAY,EAAA;QAAZ,IAAI,CAAA,IAAA,GAAJ,IAAI;QAC9B,IAAI,IAAI,CAAC,MAAM,IAAI,qBAAqB,CAAC,UAAU,EAAE;AACnD,YAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;;;;MAKrD,2BAA2B,CAAA;AASV,IAAA,IAAA;AAR5B,IAAA,OAAgB,UAAU,GAAG,EAAE;AAE/B,IAAA,OAAO,KAAK,GAA8C,IAAI,YAAY,CACxE,YAAY,EACZ,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EACjB,CAAC,IAAI,KAAK,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAChD;AAED,IAAA,WAAA,CAA4B,IAAY,EAAA;QAAZ,IAAI,CAAA,IAAA,GAAJ,IAAI;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+import { NetworkId, EncryptionSecretKey } from '@midnight-ntwrk/zswap';
+export type FormatContext = {
+    networkId: string | null;
+};
+export declare class MidnightBech32m {
+    readonly type: string;
+    readonly network: string | null;
+    readonly data: Buffer;
+    static readonly prefix = "mn";
+    static validateSegment(segmentName: string, segment: string): void;
+    static parse(bech32string: string): MidnightBech32m;
+    constructor(type: string, network: string | null, data: Buffer);
+    asString(): string;
+}
+export declare class Bech32mCodec<T> {
+    readonly type: string;
+    readonly dataToBytes: (data: T) => Buffer;
+    readonly dataFromBytes: (bytes: Buffer) => T;
+    constructor(type: string, dataToBytes: (data: T) => Buffer, dataFromBytes: (bytes: Buffer) => T);
+    encode(networkId: NetworkId, data: T): MidnightBech32m;
+    decode(networkId: NetworkId | string | null, repr: MidnightBech32m): T;
+    static createContext(networkId: NetworkId | string | null): FormatContext;
+    static createContextFromZswap(networkId: NetworkId): FormatContext;
+}
+export declare class ShieldedAddress {
+    readonly coinPublicKey: ShieldedCoinPublicKey;
+    readonly encryptionPublicKey: ShieldedEncryptionPublicKey;
+    static codec: Bech32mCodec<ShieldedAddress>;
+    constructor(coinPublicKey: ShieldedCoinPublicKey, encryptionPublicKey: ShieldedEncryptionPublicKey);
+    coinPublicKeyString(): string;
+    encryptionPublicKeyString(): string;
+}
+export declare class ShieldedEncryptionSecretKey {
+    readonly zswap: EncryptionSecretKey;
+    static codec: Bech32mCodec<ShieldedEncryptionSecretKey>;
+    constructor(zswap: EncryptionSecretKey);
+}
+export declare class ShieldedCoinPublicKey {
+    readonly data: Buffer;
+    static readonly key_length = 32;
+    static codec: Bech32mCodec<ShieldedCoinPublicKey>;
+    constructor(data: Buffer);
+}
+export declare class ShieldedEncryptionPublicKey {
+    readonly data: Buffer;
+    static readonly key_length = 32;
+    static codec: Bech32mCodec<ShieldedEncryptionPublicKey>;
+    constructor(data: Buffer);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAGvE,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,qBAAa,eAAe;aA2BR,IAAI,EAAE,MAAM;aACZ,OAAO,EAAE,MAAM,GAAG,IAAI;aACtB,IAAI,EAAE,MAAM;IA5B9B,gBAAuB,MAAM,QAAQ;IAErC,MAAM,CAAC,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IASlE,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,eAAe;gBAejC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,IAAI,EAAE,MAAM;IAQ9B,QAAQ,IAAI,MAAM;CAInB;AAED,qBAAa,YAAY,CAAC,CAAC;aAEP,IAAI,EAAE,MAAM;aACZ,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM;aAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC;gBAFnC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,EAChC,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC;IAGrD,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,eAAe;IAKtD,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,eAAe,GAAG,CAAC;IAWtE,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa;IAUzE,MAAM,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,GAAG,aAAa;CAcnE;AAED,qBAAa,eAAe;aAYR,aAAa,EAAE,qBAAqB;aACpC,mBAAmB,EAAE,2BAA2B;IAZlE,MAAM,CAAC,KAAK,gCAQV;gBAGgB,aAAa,EAAE,qBAAqB,EACpC,mBAAmB,EAAE,2BAA2B;IAGlE,mBAAmB,IAAI,MAAM;IAI7B,yBAAyB,IAAI,MAAM;CAGpC;AAED,qBAAa,2BAA2B;aAYV,KAAK,EAAE,mBAAmB;IAXtD,MAAM,CAAC,KAAK,4CAOV;gBAI0B,KAAK,EAAE,mBAAmB;CACvD;AAED,qBAAa,qBAAqB;aASJ,IAAI,EAAE,MAAM;IARxC,MAAM,CAAC,QAAQ,CAAC,UAAU,MAAM;IAEhC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,qBAAqB,CAAC,CAI/C;gBAE0B,IAAI,EAAE,MAAM;CAKzC;AAED,qBAAa,2BAA2B;aASV,IAAI,EAAE,MAAM;IARxC,MAAM,CAAC,QAAQ,CAAC,UAAU,MAAM;IAEhC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,2BAA2B,CAAC,CAIrD;gBAE0B,IAAI,EAAE,MAAM;CACzC"}

package/dist/index.mjs

@@ -0,0 +1,139 @@
+import { NetworkId, EncryptionSecretKey } from '@midnight-ntwrk/zswap';
+import { bech32m } from '@scure/base';
+
+class MidnightBech32m {
+    type;
+    network;
+    data;
+    static prefix = 'mn';
+    static validateSegment(segmentName, segment) {
+        const result = /^[A-Za-z1-9-]+$/.test(segment);
+        if (!result) {
+            throw new Error(`Segment ${segmentName}: ${segment} contains disallowed characters. Allowed characters are only numbers, latin letters and a hyphen`);
+        }
+    }
+    static parse(bech32string) {
+        const bech32parsed = bech32m.decodeToBytes(bech32string);
+        const [prefix, type, network = null] = bech32parsed.prefix.split('_');
+        if (prefix != MidnightBech32m.prefix) {
+            throw new Error(`Expected prefix ${MidnightBech32m.prefix}`);
+        }
+        MidnightBech32m.validateSegment('type', type);
+        if (network != null) {
+            MidnightBech32m.validateSegment('network', network);
+        }
+        return new MidnightBech32m(type, network, Buffer.from(bech32parsed.bytes));
+    }
+    constructor(type, network, data) {
+        this.type = type;
+        this.network = network;
+        this.data = data;
+        MidnightBech32m.validateSegment('type', type);
+        if (network != null) {
+            MidnightBech32m.validateSegment('network', network);
+        }
+    }
+    asString() {
+        const networkSegment = this.network == null ? '' : `_${this.network}`;
+        return bech32m.encode(`${MidnightBech32m.prefix}_${this.type}${networkSegment}`, bech32m.toWords(this.data), false);
+    }
+}
+class Bech32mCodec {
+    type;
+    dataToBytes;
+    dataFromBytes;
+    constructor(type, dataToBytes, dataFromBytes) {
+        this.type = type;
+        this.dataToBytes = dataToBytes;
+        this.dataFromBytes = dataFromBytes;
+    }
+    encode(networkId, data) {
+        const context = Bech32mCodec.createContext(networkId);
+        return new MidnightBech32m(this.type, context.networkId, this.dataToBytes(data));
+    }
+    decode(networkId, repr) {
+        const context = Bech32mCodec.createContext(networkId);
+        if (repr.type != this.type) {
+            throw new Error(`Expected type ${this.type}, got ${repr.type}`);
+        }
+        if (context.networkId != repr.network) {
+            throw new Error(`Expected ${context.networkId ?? 'mainnet'} address, got ${repr.network ?? 'mainnet'} one`);
+        }
+        return this.dataFromBytes(repr.data);
+    }
+    static createContext(networkId) {
+        if (networkId === null) {
+            return { networkId: null };
+        }
+        else if (typeof networkId === 'string') {
+            return { networkId };
+        }
+        else {
+            return Bech32mCodec.createContextFromZswap(networkId);
+        }
+    }
+    static createContextFromZswap(networkId) {
+        switch (networkId) {
+            case NetworkId.DevNet:
+                return { networkId: 'dev' };
+            case NetworkId.MainNet:
+                return { networkId: null };
+            case NetworkId.TestNet:
+                return { networkId: 'test' };
+            case NetworkId.Undeployed:
+                return { networkId: 'undeployed' };
+            default:
+                return { networkId: null };
+        }
+    }
+}
+class ShieldedAddress {
+    coinPublicKey;
+    encryptionPublicKey;
+    static codec = new Bech32mCodec('shield-addr', (addr) => Buffer.concat([addr.coinPublicKey.data, addr.encryptionPublicKey.data]), (bytes) => {
+        const coinPublicKey = new ShieldedCoinPublicKey(bytes.subarray(0, ShieldedCoinPublicKey.key_length));
+        const encryptionPublicKey = new ShieldedEncryptionPublicKey(bytes.subarray(ShieldedCoinPublicKey.key_length));
+        return new ShieldedAddress(coinPublicKey, encryptionPublicKey);
+    });
+    constructor(coinPublicKey, encryptionPublicKey) {
+        this.coinPublicKey = coinPublicKey;
+        this.encryptionPublicKey = encryptionPublicKey;
+    }
+    coinPublicKeyString() {
+        return this.coinPublicKey.data.toString('hex');
+    }
+    encryptionPublicKeyString() {
+        return this.encryptionPublicKey.data.toString('hex');
+    }
+}
+class ShieldedEncryptionSecretKey {
+    zswap;
+    static codec = new Bech32mCodec('shield-esk', (esk) => Buffer.from(esk.zswap.yesIKnowTheSecurityImplicationsOfThis_serialize(NetworkId.Undeployed).subarray(1)), (repr) => new ShieldedEncryptionSecretKey(EncryptionSecretKey.deserialize(Buffer.concat([Buffer.of(0), repr]), NetworkId.Undeployed)));
+    // There are some bits in serialization of field elements and elliptic curve points, that are hard to replicate
+    // Thus using zswap implementation directly for serialization purposes
+    constructor(zswap) {
+        this.zswap = zswap;
+    }
+}
+class ShieldedCoinPublicKey {
+    data;
+    static key_length = 32;
+    static codec = new Bech32mCodec('shield-cpk', (cpk) => cpk.data, (repr) => new ShieldedCoinPublicKey(repr));
+    constructor(data) {
+        this.data = data;
+        if (data.length != ShieldedCoinPublicKey.key_length) {
+            throw new Error('Coin public key needs to be 32 bytes long');
+        }
+    }
+}
+class ShieldedEncryptionPublicKey {
+    data;
+    static key_length = 32;
+    static codec = new Bech32mCodec('shield-epk', (cpk) => cpk.data, (repr) => new ShieldedEncryptionPublicKey(repr));
+    constructor(data) {
+        this.data = data;
+    }
+}
+
+export { Bech32mCodec, MidnightBech32m, ShieldedAddress, ShieldedCoinPublicKey, ShieldedEncryptionPublicKey, ShieldedEncryptionSecretKey };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;MAOa,eAAe,CAAA;AA2BR,IAAA,IAAA;AACA,IAAA,OAAA;AACA,IAAA,IAAA;AA5BX,IAAA,OAAgB,MAAM,GAAG,IAAI;AAEpC,IAAA,OAAO,eAAe,CAAC,WAAmB,EAAE,OAAe,EAAA;QACzD,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC;QAC9C,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CACb,CAAA,QAAA,EAAW,WAAW,CAAK,EAAA,EAAA,OAAO,CAAkG,gGAAA,CAAA,CACrI;;;IAIL,OAAO,KAAK,CAAC,YAAoB,EAAA;QAC/B,MAAM,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC;AACxD,QAAA,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC;AACrE,QAAA,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,CAAA,gBAAA,EAAmB,eAAe,CAAC,MAAM,CAAE,CAAA,CAAC;;AAE9D,QAAA,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;AAC7C,QAAA,IAAI,OAAO,IAAI,IAAI,EAAE;AACnB,YAAA,eAAe,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC;;AAGrD,QAAA,OAAO,IAAI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;;AAG5E,IAAA,WAAA,CACkB,IAAY,EACZ,OAAsB,EACtB,IAAY,EAAA;QAFZ,IAAI,CAAA,IAAA,GAAJ,IAAI;QACJ,IAAO,CAAA,OAAA,GAAP,OAAO;QACP,IAAI,CAAA,IAAA,GAAJ,IAAI;AAEpB,QAAA,eAAe,CAAC,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC;AAC7C,QAAA,IAAI,OAAO,IAAI,IAAI,EAAE;AACnB,YAAA,eAAe,CAAC,eAAe,CAAC,SAAS,EAAE,OAAO,CAAC;;;IAIvD,QAAQ,GAAA;AACN,QAAA,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,GAAG,EAAE,GAAG,CAAA,CAAA,EAAI,IAAI,CAAC,OAAO,EAAE;QACrE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAA,EAAG,eAAe,CAAC,MAAM,CAAA,CAAA,EAAI,IAAI,CAAC,IAAI,CAAA,EAAG,cAAc,CAAA,CAAE,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;;;MAI1G,YAAY,CAAA;AAEL,IAAA,IAAA;AACA,IAAA,WAAA;AACA,IAAA,aAAA;AAHlB,IAAA,WAAA,CACkB,IAAY,EACZ,WAAgC,EAChC,aAAmC,EAAA;QAFnC,IAAI,CAAA,IAAA,GAAJ,IAAI;QACJ,IAAW,CAAA,WAAA,GAAX,WAAW;QACX,IAAa,CAAA,aAAA,GAAb,aAAa;;IAG/B,MAAM,CAAC,SAAoB,EAAE,IAAO,EAAA;QAClC,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC;AACrD,QAAA,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;;IAGlF,MAAM,CAAC,SAAoC,EAAE,IAAqB,EAAA;QAChE,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC,SAAS,CAAC;QACrD,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;AAC1B,YAAA,MAAM,IAAI,KAAK,CAAC,CAAA,cAAA,EAAiB,IAAI,CAAC,IAAI,CAAA,MAAA,EAAS,IAAI,CAAC,IAAI,CAAA,CAAE,CAAC;;QAEjE,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE;AACrC,YAAA,MAAM,IAAI,KAAK,CAAC,CAAY,SAAA,EAAA,OAAO,CAAC,SAAS,IAAI,SAAS,CAAA,cAAA,EAAiB,IAAI,CAAC,OAAO,IAAI,SAAS,CAAA,IAAA,CAAM,CAAC;;QAE7G,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;;IAGtC,OAAO,aAAa,CAAC,SAAoC,EAAA;AACvD,QAAA,IAAI,SAAS,KAAK,IAAI,EAAE;AACtB,YAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;;AACrB,aAAA,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACxC,OAAO,EAAE,SAAS,EAAE;;aACf;AACL,YAAA,OAAO,YAAY,CAAC,sBAAsB,CAAC,SAAS,CAAC;;;IAIzD,OAAO,sBAAsB,CAAC,SAAoB,EAAA;QAChD,QAAQ,SAAS;YACf,KAAK,SAAS,CAAC,MAAM;AACnB,gBAAA,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE;YAC7B,KAAK,SAAS,CAAC,OAAO;AACpB,gBAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;YAC5B,KAAK,SAAS,CAAC,OAAO;AACpB,gBAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE;YAC9B,KAAK,SAAS,CAAC,UAAU;AACvB,gBAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE;AACpC,YAAA;AACE,gBAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE;;;AAGjC;MAEY,eAAe,CAAA;AAYR,IAAA,aAAA;AACA,IAAA,mBAAA;AAZlB,IAAA,OAAO,KAAK,GAAG,IAAI,YAAY,CAC7B,aAAa,EACb,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,EACjF,CAAC,KAAK,KAAI;AACR,QAAA,MAAM,aAAa,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;AACpG,QAAA,MAAM,mBAAmB,GAAG,IAAI,2BAA2B,CAAC,KAAK,CAAC,QAAQ,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAC7G,QAAA,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,mBAAmB,CAAC;AAChE,KAAC,CACF;IAED,WACkB,CAAA,aAAoC,EACpC,mBAAgD,EAAA;QADhD,IAAa,CAAA,aAAA,GAAb,aAAa;QACb,IAAmB,CAAA,mBAAA,GAAnB,mBAAmB;;IAGrC,mBAAmB,GAAA;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;;IAGhD,yBAAyB,GAAA;QACvB,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;;;MAI3C,2BAA2B,CAAA;AAYV,IAAA,KAAA;AAX5B,IAAA,OAAO,KAAK,GAAG,IAAI,YAAY,CAC7B,YAAY,EACZ,CAAC,GAAG,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,+CAA+C,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EACjH,CAAC,IAAI,KACH,IAAI,2BAA2B,CAC7B,mBAAmB,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,CAC3F,CACJ;;;AAID,IAAA,WAAA,CAA4B,KAA0B,EAAA;QAA1B,IAAK,CAAA,KAAA,GAAL,KAAK;;;MAGtB,qBAAqB,CAAA;AASJ,IAAA,IAAA;AAR5B,IAAA,OAAgB,UAAU,GAAG,EAAE;AAE/B,IAAA,OAAO,KAAK,GAAwC,IAAI,YAAY,CAClE,YAAY,EACZ,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EACjB,CAAC,IAAI,KAAK,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAC1C;AAED,IAAA,WAAA,CAA4B,IAAY,EAAA;QAAZ,IAAI,CAAA,IAAA,GAAJ,IAAI;QAC9B,IAAI,IAAI,CAAC,MAAM,IAAI,qBAAqB,CAAC,UAAU,EAAE;AACnD,YAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;;;;MAKrD,2BAA2B,CAAA;AASV,IAAA,IAAA;AAR5B,IAAA,OAAgB,UAAU,GAAG,EAAE;AAE/B,IAAA,OAAO,KAAK,GAA8C,IAAI,YAAY,CACxE,YAAY,EACZ,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EACjB,CAAC,IAAI,KAAK,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAChD;AAED,IAAA,WAAA,CAA4B,IAAY,EAAA;QAAZ,IAAI,CAAA,IAAA,GAAJ,IAAI;;;;;;"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@midnight-ntwrk/wallet-sdk-address-format",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "author": "IOHK",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midnight-ntwrk/artifacts.git"
+  },
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@scure/base": "^1.1.9"
+  },
+  "devDependencies": {
+    "@midnight-ntwrk/zswap": "^3.0.6",
+    "@types/node": "22.10.5"
+  },
+  "peerDependencies": {
+    "@midnight-ntwrk/zswap": "^3.0.6"
+  },
+  "scripts": {
+    "typecheck": "tsc -b ./tsconfig.json --noEmit",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
+    "lint": "eslint",
+    "dist:prebuild": "rollup -c ./rollup.config.mjs"
+  }
+}