@biglup/cometa 1.0.0 → 1.0.2

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <a href="https://www.meteor.com" target="_blank">
+  <a href="" target="_blank">
     <img align="center" width="300" src="assets/cometa_js.png">
   </a>
 </div>
@@ -8,34 +8,51 @@
 
 <div align="center">
 
-[![Static Badge](https://img.shields.io/badge/Metric-Val-06f50?logoColor=ffffff)]()
-[![Static Badge](https://img.shields.io/badge/Metric-Val-06f50?logoColor=ffffff)]()
-[![Static Badge](https://img.shields.io/badge/Metric-Val-06f50?logoColor=ffffff)]()
-[![Static Badge](https://img.shields.io/badge/Metric-Val-06f50?logoColor=ffffff)]()
-[![Static Badge](https://img.shields.io/badge/Metric-Val-06f50?logoColor=ffffff)]()
+![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)
+![Post-Integration](https://github.com/Biglup/cometa.js/actions/workflows/unit-test.yml/badge.svg)
+![node-current](https://img.shields.io/node/v/@biglup/cometa)
+[![Documentation Status](https://app.readthedocs.org/projects/cometajs/badge/?version=latest)](https://cometajs.readthedocs.io/en/latest/?badge=latest)
+[![Twitter Follow](https://img.shields.io/twitter/follow/BiglupLabs?style=social)](https://x.com/BiglupLabs)
 
 </div>
 
 <hr>
 
-Cometa .JS is ....
+Cometa.js is a lightweight, high-performance JavaScript library binding for the [libcardano-c](https://github.com/Biglup/cardano-c) Library, designed to simplify blockchain development on Cardano.
 
+It embeds the WASM module directly into a single JavaScript file, ensuring a minimal footprint, fast performance, and effortless setup without requiring special server configurations.
+
+Built on the foundation of [libcardano-c](https://github.com/Biglup/cardano-c), Cometa.js inherits its commercial-grade quality, rigorous testing, and adherence to strict standards. It is ideal for developing reliable and secure solutions for mission-critical blockchain applications.
 <hr>
 
-- [Official Website]()
-- [Installation]()
-- [Documentation]()
+- [Official Website](https://cometa.dev/)
+- [Installation](#installation)
+- [Documentation](https://cometajs.readthedocs.io/en/latest/?badge=latest)
 
 <hr>
 
-### **TBD**
+### **Installation**
 
-<hr>
+To install Cometa.js on your project, use the following command:
 
-### **TBD**
+```bash
+yarn add @biglup/cometa
+```
 
 <hr>
 
-### **TBD**
+### **Building and Testing**
+
+To build and run the tests, use the following commands:
+
+```bash
+yarn install
+yarn build
+yarn test
+```
 
 <hr>
+
+### **License**
+
+Cometa.js is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more information.

package/dist/cjs/index.d.mts

@@ -1,4 +1,8 @@
 declare const getLibCardanoCVersion: () => string;
+declare const hexToUint8Array: (hexString: string) => Uint8Array;
+declare const uint8ArrayToHex: (byteArray: Uint8Array) => string;
+declare const utf8ToUint8Array: (str: string) => Uint8Array;
+declare const uint8ArrayToUtf8: (uint8Array: Uint8Array) => string;
 
 declare const ready: () => Promise<void>;
 declare const getModule: () => any;
@@ -122,6 +126,30 @@ declare class CborWriter {
     getRefCount(): number;
 }
 
+declare class Base58 {
+    private constructor();
+    static encode(data: Uint8Array): string;
+    static decode(encodedString: string): Uint8Array;
+    static encodeFromHex(hexString: string): string;
+    static decodeFromHex(base58String: string): string;
+    private static getEncodedLength;
+    private static getDecodedLength;
+}
+
+type Bech32DecodeResult = {
+    hrp: string;
+    data: Uint8Array;
+    hex: string;
+};
+declare class Bech32 {
+    private constructor();
+    static encode(hrp: string, data: Uint8Array): string;
+    static encodeFromHex(hrp: string, data: string): string;
+    static decode(encodedString: string): Bech32DecodeResult;
+    private static getEncodedLength;
+    private static getDecodedLength;
+}
+
 declare const finalizationRegistry: FinalizationRegistry<{
     ptr: any;
     freeFunc: any;
@@ -138,4 +166,100 @@ declare class ProtocolVersion {
     setMinor(minor: number): void;
 }
 
-export { CborMajorType, CborReader, CborReaderState, CborSimpleValue, CborTag, CborWriter, ProtocolVersion, finalizationRegistry, getLibCardanoCVersion, getModule, isReady, ready };
+declare class Crc32 {
+    private constructor();
+    static compute(data: Uint8Array): number;
+    static computeFromHex(hexString: string): number;
+    static computeFromUtf8(data: string): number;
+}
+
+declare class Pbkdf2HmacSha512 {
+    private constructor();
+    static compute(password: Uint8Array, salt: Uint8Array, iterations: number, derivedKeyLength: number): Uint8Array;
+}
+
+declare class Emip003 {
+    static encrypt(data: Uint8Array, passphrase: Uint8Array): Uint8Array;
+    static decrypt(encryptedData: Uint8Array, passphrase: Uint8Array): Uint8Array;
+}
+
+declare class Blake2b {
+    private constructor();
+    static computeHash(data: Uint8Array, hashLength: number): Uint8Array;
+}
+
+declare class Ed25519Signature {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Ed25519Signature;
+    static fromHex(hex: string): Ed25519Signature;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Ed25519PublicKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Ed25519PublicKey;
+    static fromHex(hex: string): Ed25519PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    verify(signature: Ed25519Signature, message: Uint8Array): boolean;
+    toHash(): Uint8Array;
+    toHashHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Bip32PublicKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Bip32PublicKey;
+    static fromHex(hex: string): Bip32PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    derive(indices: number[]): Bip32PublicKey;
+    toEd25519Key(): Ed25519PublicKey;
+    toHash(): Uint8Array;
+    toHashHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Ed25519PrivateKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromNormalBytes(data: Uint8Array): Ed25519PrivateKey;
+    static fromExtendedBytes(data: Uint8Array): Ed25519PrivateKey;
+    static fromNormalHex(hex: string): Ed25519PrivateKey;
+    static fromExtendedHex(hex: string): Ed25519PrivateKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    sign(message: Uint8Array): Ed25519Signature;
+    getPublicKey(): Ed25519PublicKey;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Bip32PrivateKey {
+    ptr: number;
+    private constructor();
+    static fromBip39Entropy(password: Uint8Array, entropy: Uint8Array): Bip32PrivateKey;
+    static fromBytes(data: Uint8Array): Bip32PrivateKey;
+    static fromHex(hex: string): Bip32PrivateKey;
+    derive(indices: number[]): Bip32PrivateKey;
+    getPublicKey(): Bip32PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    toEd25519Key(): Ed25519PrivateKey;
+    refCount(): number;
+    private getBytesSize;
+}
+
+export { Base58, Bech32, type Bech32DecodeResult, Bip32PrivateKey, Bip32PublicKey, Blake2b, CborMajorType, CborReader, CborReaderState, CborSimpleValue, CborTag, CborWriter, Crc32, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, Emip003, Pbkdf2HmacSha512, ProtocolVersion, finalizationRegistry, getLibCardanoCVersion, getModule, hexToUint8Array, isReady, ready, uint8ArrayToHex, uint8ArrayToUtf8, utf8ToUint8Array };

package/dist/cjs/index.d.ts

@@ -1,4 +1,8 @@
 declare const getLibCardanoCVersion: () => string;
+declare const hexToUint8Array: (hexString: string) => Uint8Array;
+declare const uint8ArrayToHex: (byteArray: Uint8Array) => string;
+declare const utf8ToUint8Array: (str: string) => Uint8Array;
+declare const uint8ArrayToUtf8: (uint8Array: Uint8Array) => string;
 
 declare const ready: () => Promise<void>;
 declare const getModule: () => any;
@@ -122,6 +126,30 @@ declare class CborWriter {
     getRefCount(): number;
 }
 
+declare class Base58 {
+    private constructor();
+    static encode(data: Uint8Array): string;
+    static decode(encodedString: string): Uint8Array;
+    static encodeFromHex(hexString: string): string;
+    static decodeFromHex(base58String: string): string;
+    private static getEncodedLength;
+    private static getDecodedLength;
+}
+
+type Bech32DecodeResult = {
+    hrp: string;
+    data: Uint8Array;
+    hex: string;
+};
+declare class Bech32 {
+    private constructor();
+    static encode(hrp: string, data: Uint8Array): string;
+    static encodeFromHex(hrp: string, data: string): string;
+    static decode(encodedString: string): Bech32DecodeResult;
+    private static getEncodedLength;
+    private static getDecodedLength;
+}
+
 declare const finalizationRegistry: FinalizationRegistry<{
     ptr: any;
     freeFunc: any;
@@ -138,4 +166,100 @@ declare class ProtocolVersion {
     setMinor(minor: number): void;
 }
 
-export { CborMajorType, CborReader, CborReaderState, CborSimpleValue, CborTag, CborWriter, ProtocolVersion, finalizationRegistry, getLibCardanoCVersion, getModule, isReady, ready };
+declare class Crc32 {
+    private constructor();
+    static compute(data: Uint8Array): number;
+    static computeFromHex(hexString: string): number;
+    static computeFromUtf8(data: string): number;
+}
+
+declare class Pbkdf2HmacSha512 {
+    private constructor();
+    static compute(password: Uint8Array, salt: Uint8Array, iterations: number, derivedKeyLength: number): Uint8Array;
+}
+
+declare class Emip003 {
+    static encrypt(data: Uint8Array, passphrase: Uint8Array): Uint8Array;
+    static decrypt(encryptedData: Uint8Array, passphrase: Uint8Array): Uint8Array;
+}
+
+declare class Blake2b {
+    private constructor();
+    static computeHash(data: Uint8Array, hashLength: number): Uint8Array;
+}
+
+declare class Ed25519Signature {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Ed25519Signature;
+    static fromHex(hex: string): Ed25519Signature;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Ed25519PublicKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Ed25519PublicKey;
+    static fromHex(hex: string): Ed25519PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    verify(signature: Ed25519Signature, message: Uint8Array): boolean;
+    toHash(): Uint8Array;
+    toHashHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Bip32PublicKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromBytes(data: Uint8Array): Bip32PublicKey;
+    static fromHex(hex: string): Bip32PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    derive(indices: number[]): Bip32PublicKey;
+    toEd25519Key(): Ed25519PublicKey;
+    toHash(): Uint8Array;
+    toHashHex(): string;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Ed25519PrivateKey {
+    ptr: number;
+    constructor(ptr: number);
+    static fromNormalBytes(data: Uint8Array): Ed25519PrivateKey;
+    static fromExtendedBytes(data: Uint8Array): Ed25519PrivateKey;
+    static fromNormalHex(hex: string): Ed25519PrivateKey;
+    static fromExtendedHex(hex: string): Ed25519PrivateKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    sign(message: Uint8Array): Ed25519Signature;
+    getPublicKey(): Ed25519PublicKey;
+    refCount(): number;
+    private getBytesSize;
+    private getHexSize;
+}
+
+declare class Bip32PrivateKey {
+    ptr: number;
+    private constructor();
+    static fromBip39Entropy(password: Uint8Array, entropy: Uint8Array): Bip32PrivateKey;
+    static fromBytes(data: Uint8Array): Bip32PrivateKey;
+    static fromHex(hex: string): Bip32PrivateKey;
+    derive(indices: number[]): Bip32PrivateKey;
+    getPublicKey(): Bip32PublicKey;
+    toBytes(): Uint8Array;
+    toHex(): string;
+    toEd25519Key(): Ed25519PrivateKey;
+    refCount(): number;
+    private getBytesSize;
+}
+
+export { Base58, Bech32, type Bech32DecodeResult, Bip32PrivateKey, Bip32PublicKey, Blake2b, CborMajorType, CborReader, CborReaderState, CborSimpleValue, CborTag, CborWriter, Crc32, Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature, Emip003, Pbkdf2HmacSha512, ProtocolVersion, finalizationRegistry, getLibCardanoCVersion, getModule, hexToUint8Array, isReady, ready, uint8ArrayToHex, uint8ArrayToUtf8, utf8ToUint8Array };