@quentinadam/base58check 0.1.3

package/README.md

@@ -0,0 +1,24 @@
+# @quentinadam/base58check
+
+[![JSR][jsr-image]][jsr-url] [![NPM][npm-image]][npm-url] [![CI][ci-image]][ci-url]
+
+A simple library to encode and decode base58check strings.
+
+Optionnaly supports specifying the alphabet to use.
+
+## Usage
+
+```ts
+import * as base58check from '@quentinadam/base58check';
+
+base58check.encode(new Uint8Array([72, 101, 108, 108, 111])); // returns 'vSxRbq6XzDhP'
+
+base58check.decode('vSxRbq6XzDhP'); // returns Uint8Array([72, 101, 108, 108, 111])
+```
+
+[ci-image]: https://img.shields.io/github/actions/workflow/status/quentinadam/deno-base58check/ci.yml?branch=main&logo=github&style=flat-square
+[ci-url]: https://github.com/quentinadam/deno-base58check/actions/workflows/ci.yml
+[npm-image]: https://img.shields.io/npm/v/@quentinadam/base58check.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@quentinadam/base58check
+[jsr-image]: https://jsr.io/badges/@quentinadam/base58check?style=flat-square
+[jsr-url]: https://jsr.io/@quentinadam/base58check

package/dist/base58check.d.ts

@@ -0,0 +1,26 @@
+/** Options for {@linkcode encode} and {@linkcode decode}. */
+export interface Options {
+    /**
+     * The alphabet to use.
+     * The alphabet must be a string of 58 unique characters.
+     *
+     * @default {'123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'}
+     */
+    alphabet?: string;
+}
+/**
+ * Encodes a Uint8Array buffer into a base58check string.
+ *
+ * @param buffer The buffer to encode.
+ * @param options The options to use for encoding.
+ * @returns The base58check encoded string.
+ */
+export declare function encode(buffer: Uint8Array, options?: Options): string;
+/**
+ * Decodes a base58check encoded string into a Uint8Array buffer.
+ *
+ * @param string The base58check encoded string.
+ * @param options The options to use for decoding.
+ * @returns The decoded buffer.
+ */
+export declare function decode(string: string, options?: Options): Uint8Array;

package/dist/base58check.js

@@ -0,0 +1,33 @@
+import assert from '@quentinadam/assert';
+import * as base58 from '@quentinadam/base58';
+import sha256 from '@quentinadam/hash/sha256';
+import * as Uint8ArrayExtension from '@quentinadam/uint8array-extension';
+function computeChecksum(buffer) {
+    return sha256(sha256(buffer)).slice(0, 4);
+}
+/**
+ * Encodes a Uint8Array buffer into a base58check string.
+ *
+ * @param buffer The buffer to encode.
+ * @param options The options to use for encoding.
+ * @returns The base58check encoded string.
+ */
+export function encode(buffer, options) {
+    return base58.encode(Uint8ArrayExtension.concat([buffer, computeChecksum(buffer)]), options);
+}
+/**
+ * Decodes a base58check encoded string into a Uint8Array buffer.
+ *
+ * @param string The base58check encoded string.
+ * @param options The options to use for decoding.
+ * @returns The decoded buffer.
+ */
+export function decode(string, options) {
+    const { buffer, checkSum } = (() => {
+        const buffer = base58.decode(string, options);
+        assert(buffer.length >= 4);
+        return { buffer: buffer.slice(0, -4), checkSum: buffer.slice(-4) };
+    })();
+    assert(Uint8ArrayExtension.equals(computeChecksum(buffer), checkSum));
+    return buffer;
+}

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@quentinadam/base58check",
+  "version": "0.1.3",
+  "description": "A simple library to encode and decode base58check strings",
+  "license": "MIT",
+  "author": "Quentin Adam",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quentinadam/deno-base58check.git"
+  },
+  "type": "module",
+  "exports": "./dist/base58check.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@quentinadam/assert": "^0.1.10",
+    "@quentinadam/base58": "^0.1.5",
+    "@quentinadam/hash": "^0.1.1",
+    "@quentinadam/uint8array-extension": "^0.1.5"
+  }
+}