@ecency/hive-tx 7.1.0

package/dist/esm/helpers/memo.js

@@ -0,0 +1,128 @@
+import bs58 from 'bs58';
+import { ByteBuffer } from './ByteBuffer';
+import { Serializer } from './serializer';
+import { PrivateKey } from './PrivateKey';
+import * as Aes from './aes';
+import { PublicKey } from './PublicKey';
+import { Deserializer } from './deserializer';
+/**
+ * Encodes a memo using AES encryption for secure private messaging on Hive.
+ * Messages must start with '#' to be encrypted. Plain text messages are returned unchanged.
+ *
+ * @param privateKey - Sender's private memo key (string WIF format or PrivateKey instance)
+ * @param publicKey - Recipient's public memo key (string or PublicKey instance)
+ * @param memo - Message to encrypt (must start with '#' for encryption)
+ * @param testNonce - Optional nonce for testing (advanced usage)
+ * @returns Encrypted memo string prefixed with '#'
+ * @throws Error if encryption is not supported in current environment
+ */
+const encode = (privateKey, publicKey, memo, testNonce) => {
+    if (!memo.startsWith('#')) {
+        return memo;
+    }
+    memo = memo.substring(1);
+    checkEncryption();
+    privateKey = toPrivateObj(privateKey);
+    publicKey = toPublicObj(publicKey);
+    const mbuf = new ByteBuffer(ByteBuffer.DEFAULT_CAPACITY, ByteBuffer.LITTLE_ENDIAN);
+    mbuf.writeVString(memo);
+    const memoBuffer = new Uint8Array(mbuf.copy(0, mbuf.offset).toBuffer());
+    const { nonce, message, checksum } = Aes.encrypt(privateKey, publicKey, memoBuffer, testNonce);
+    const mbuf2 = new ByteBuffer(ByteBuffer.DEFAULT_CAPACITY, ByteBuffer.LITTLE_ENDIAN);
+    Serializer.Memo(mbuf2, {
+        check: checksum,
+        encrypted: message,
+        from: privateKey.createPublic(),
+        nonce,
+        to: publicKey
+    });
+    mbuf2.flip();
+    const data = new Uint8Array(mbuf2.toBuffer());
+    return '#' + bs58.encode(data);
+};
+/**
+ * Decrypts an encrypted memo using AES decryption.
+ * Messages must start with '#' to be decrypted. Plain text messages are returned unchanged.
+ *
+ * @param privateKey - Recipient's private memo key (string WIF format or PrivateKey instance)
+ * @param memo - Encrypted memo string (must start with '#' for decryption)
+ * @returns Decrypted memo content with '#' prefix
+ * @throws Error if decryption fails or encryption not supported in current environment
+ */
+const decode = (privateKey, memo) => {
+    if (!memo.startsWith('#')) {
+        return memo;
+    }
+    memo = memo.substring(1);
+    checkEncryption();
+    privateKey = toPrivateObj(privateKey);
+    // memo = bs58.decode(memo)
+    let memoBuffer = Deserializer.Memo(bs58.decode(memo));
+    const { from, to, nonce, check, encrypted } = memoBuffer;
+    const pubkey = privateKey.createPublic().toString();
+    const otherpub = pubkey === new PublicKey(from.key).toString() ? new PublicKey(to.key) : new PublicKey(from.key);
+    memoBuffer = Aes.decrypt(privateKey, otherpub, nonce, encrypted, check);
+    const mbuf = new ByteBuffer(ByteBuffer.DEFAULT_CAPACITY, ByteBuffer.LITTLE_ENDIAN);
+    mbuf.append(memoBuffer);
+    mbuf.flip();
+    return '#' + mbuf.readVString();
+};
+let encodeTest;
+const checkEncryption = () => {
+    if (encodeTest === undefined) {
+        let plaintext;
+        encodeTest = true; // prevent infinate looping
+        try {
+            const wif = '5JdeC9P7Pbd1uGdFVEsJ41EkEnADbbHGq6p1BwFxm6txNBsQnsw';
+            const pubkey = 'STM8m5UgaFAAYQRuaNejYdS8FVLVp9Ss3K1qAVk5de6F8s3HnVbvA';
+            const cyphertext = encode(wif, pubkey, '#memo爱');
+            plaintext = decode(wif, cyphertext);
+        }
+        finally {
+            encodeTest = plaintext === '#memo爱';
+        }
+    }
+    if (encodeTest === false) {
+        throw new Error('This environment does not support encryption.');
+    }
+};
+const toPrivateObj = (o) => {
+    if (typeof o === 'string') {
+        return PrivateKey.fromString(o);
+    }
+    else {
+        return o;
+    }
+};
+const toPublicObj = (o) => {
+    if (typeof o === 'string') {
+        return PublicKey.fromString(o);
+    }
+    else {
+        return o;
+    }
+};
+/**
+ * Memo utilities for encrypting and decrypting private messages between Hive users.
+ * Uses AES encryption with ECDH key exchange for secure communication.
+ *
+ * Messages must start with '#' to be encrypted/decrypted.
+ * Plain text messages (without '#') are returned unchanged.
+ *
+ * @example
+ * ```typescript
+ * import { Memo, PrivateKey, PublicKey } from 'hive-tx'
+ *
+ * // Encrypt a message
+ * const encrypted = Memo.encode(senderPrivateKey, recipientPublicKey, '#Hello World')
+ *
+ * // Decrypt a message
+ * const decrypted = Memo.decode(recipientPrivateKey, encrypted)
+ * console.log(decrypted) // '#Hello World'
+ * ```
+ */
+export const Memo = {
+    decode,
+    encode
+};
+//# sourceMappingURL=memo.js.map

package/dist/esm/helpers/memo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memo.js","sourceRoot":"","sources":["../../../src/helpers/memo.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAmB7C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,GAAG,CACb,UAA+B,EAC/B,SAA6B,EAC7B,IAAY,EACZ,SAAe,EACP,EAAE;IACV,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IACxB,eAAe,EAAE,CAAA;IACjB,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAA;IACrC,SAAS,GAAG,WAAW,CAAC,SAAS,CAAC,CAAA;IAClC,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IAClF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACvB,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;IACvE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;IAC9F,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IACnF,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,QAAQ;QACf,SAAS,EAAE,OAAO;QAClB,IAAI,EAAE,UAAU,CAAC,YAAY,EAAE;QAC/B,KAAK;QACL,EAAE,EAAE,SAAS;KACd,CAAC,CAAA;IACF,KAAK,CAAC,IAAI,EAAE,CAAA;IACZ,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7C,OAAO,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;AAChC,CAAC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,GAAG,CAAC,UAA+B,EAAE,IAAY,EAAU,EAAE;IACvE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAA;IACb,CAAC;IACD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IACxB,eAAe,EAAE,CAAA;IACjB,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAA;IACrC,2BAA2B;IAC3B,IAAI,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IACxD,MAAM,MAAM,GAAG,UAAU,CAAC,YAAY,EAAE,CAAC,QAAQ,EAAE,CAAA;IACnD,MAAM,QAAQ,GACZ,MAAM,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACjG,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;IACvE,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;IAClF,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IACvB,IAAI,CAAC,IAAI,EAAE,CAAA;IACX,OAAO,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;AACjC,CAAC,CAAA;AAED,IAAI,UAA+B,CAAA;AACnC,MAAM,eAAe,GAAG,GAAG,EAAE;IAC3B,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,IAAI,SAAS,CAAA;QACb,UAAU,GAAG,IAAI,CAAA,CAAC,2BAA2B;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,qDAAqD,CAAA;YACjE,MAAM,MAAM,GAAG,uDAAuD,CAAA;YACtE,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;YAChD,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QACrC,CAAC;gBAAS,CAAC;YACT,UAAU,GAAG,SAAS,KAAK,QAAQ,CAAA;QACrC,CAAC;IACH,CAAC;IACD,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IAClE,CAAC;AACH,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,CAAC,CAAsB,EAAc,EAAE;IAC1D,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IACjC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAA;IACV,CAAC;AACH,CAAC,CAAA;AACD,MAAM,WAAW,GAAG,CAAC,CAAqB,EAAa,EAAE;IACvD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;IAChC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAA;IACV,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,MAAM;IACN,MAAM;CACP,CAAA"}

package/dist/esm/helpers/serializer.d.ts

@@ -0,0 +1,14 @@
+import { PublicKey } from './PublicKey';
+import { Asset } from './Asset';
+import { ByteBuffer } from './ByteBuffer';
+export declare const Serializer: {
+    Asset: (buffer: ByteBuffer, data: string | Asset) => void;
+    Memo: (buffer: ByteBuffer, data: any) => void;
+    Price: (buffer: ByteBuffer, data: any) => void;
+    PublicKey: (buffer: ByteBuffer, data: string | PublicKey) => void;
+    String: (buffer: ByteBuffer, data: string) => void;
+    Transaction: (buffer: ByteBuffer, data: any) => void;
+    UInt16: (buffer: ByteBuffer, data: number) => void;
+    UInt32: (buffer: ByteBuffer, data: number) => void;
+};
+//# sourceMappingURL=serializer.d.ts.map

package/dist/esm/helpers/serializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../../../src/helpers/serializer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAkvBzC,eAAO,MAAM,UAAU;oBAhmBU,UAAU,QAAQ,MAAM,GAAG,KAAK;mBA8D/C,UAAU,QAAQ,GAAG;oBAArB,UAAU,QAAQ,GAAG;wBAhDF,UAAU,QAAQ,MAAM,GAAG,SAAS;qBAlGvC,UAAU,QAAQ,MAAM;0BAkJxC,UAAU,QAAQ,GAAG;qBA1HL,UAAU,QAAQ,MAAM;qBAIxB,UAAU,QAAQ,MAAM;CAkrBzD,CAAA"}