@solana/keys 2.0.0-experimental.eefafdf → 2.0.0-experimental.f07dced

package/README.md

@@ -24,6 +24,12 @@ This type represents a string that validates as a Solana address or public key.
 
 Whenever you need to validate an arbitrary string as a base58-encoded address, use the `assertIsBase58EncodedAddress()` function in this package.
 
+### `Ed25519Signature`
+
+This type represents a 64-byte Ed25519 signature of some data with a private key.
+
+Whenever you need to verify that a particular signature is, in fact, the one that would have been produced by signing some known bytes using the private key associated with some known public key, use the `verifySignature()` function in this package.
+
 ## Functions
 
 ### `assertIsBase58EncodedAddress()`
@@ -33,7 +39,7 @@ Client applications primarily deal with addresses and public keys in the form of
 From time to time you might acquire a string, that you expect to validate as an address, from an untrusted network API or user input. To assert that such an arbitrary string is a base58-encoded address, use the `assertIsBase58EncodedAddress` function.
 
 ```ts
-import { assertIsBase58EncodedAddress } from '@solana/web3.js`;
+import { assertIsBase58EncodedAddress } from '@solana/keys';
 
 // Imagine a function that fetches an account's balance when a user submits a form.
 function handleSubmit() {
@@ -50,3 +56,47 @@ function handleSubmit() {
     }
 }
 ```
+
+### `generateKeyPair()`
+
+Generates an Ed25519 public/private key pair for use with other methods in this package that accept `CryptoKey` objects.
+
+```ts
+import { generateKeyPair } from '@solana/keys';
+
+const { privateKey, publicKey } = await generateKeyPair();
+```
+
+### `getBase58EncodedAddressFromPublicKey()`
+
+Given a public `CryptoKey`, this method will return its associated `Base58EncodedAddress`.
+
+```ts
+import { getBase58EncodedAddressFromPublicKey } from '@solana/keys';
+
+const address = await getBase58EncodedAddressFromPublicKey(publicKey);
+```
+
+### `signBytes()`
+
+Given a private `CryptoKey` and a `Uint8Array` of bytes, this method will return the 64-byte Ed25519 signature of that data as a `Uint8Array`.
+
+```ts
+import { signBytes } from '@solana/keys';
+
+const data = new Uint8Array([1, 2, 3]);
+const signature = await signBytes(privateKey, data);
+```
+
+### `verifySignature()`
+
+Given a public `CryptoKey`, an `Ed25519Signature`, and a `Uint8Array` of bytes, this method will return `true` if the signature was produced by signing the bytes using the private key associated with the public key, and `false` otherwise.
+
+```ts
+import { verifySignature } from '@solana/keys';
+
+const data = new Uint8Array([1, 2, 3]);
+if (!(await verifySignature(publicKey, signature, data))) {
+    throw new Error('The data were *not* signed by the private key associated with `publicKey`');
+}
+```

package/dist/index.browser.cjs

@@ -1,12 +1,9 @@
 'use strict';
 
-var bs58 = require('bs58');
+var umiSerializers = require('@metaplex-foundation/umi-serializers');
 
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var bs58__default = /*#__PURE__*/_interopDefault(bs58);
-
-// src/base58.ts
+// ../build-scripts/env-shim.ts
+var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
   try {
     if (
@@ -16,7 +13,7 @@ function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
     ) {
       throw new Error("Expected input string to decode to a byte array of length 32.");
     }
-    const bytes = bs58__default.default.decode(putativeBase58EncodedAddress);
+    const bytes = umiSerializers.base58.serialize(putativeBase58EncodedAddress);
     const numBytes = bytes.byteLength;
     if (numBytes !== 32) {
       throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);
@@ -27,6 +24,13 @@ function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
     });
   }
 }
+function getBase58EncodedAddressCodec(config) {
+  return umiSerializers.string({
+    description: config?.description ?? (__DEV__ ? "A 32-byte account address" : ""),
+    encoding: umiSerializers.base58,
+    size: 32
+  });
+}
 function getBase58EncodedAddressComparator() {
   return new Intl.Collator("en", {
     caseFirst: "lower",
@@ -38,7 +42,110 @@ function getBase58EncodedAddressComparator() {
   }).compare;
 }
 
+// src/guard.ts
+function assertIsSecureContext() {
+  if (!globalThis.isSecureContext) {
+    throw new Error(
+      "Cryptographic operations are only allowed in secure browser contexts. Read more here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts"
+    );
+  }
+}
+var cachedEd25519Decision;
+async function isEd25519CurveSupported(subtle) {
+  if (cachedEd25519Decision === void 0) {
+    cachedEd25519Decision = new Promise((resolve) => {
+      subtle.generateKey(
+        "Ed25519",
+        /* extractable */
+        false,
+        ["sign", "verify"]
+      ).catch(() => {
+        resolve(cachedEd25519Decision = false);
+      }).then(() => {
+        resolve(cachedEd25519Decision = true);
+      });
+    });
+  }
+  if (typeof cachedEd25519Decision === "boolean") {
+    return cachedEd25519Decision;
+  } else {
+    return await cachedEd25519Decision;
+  }
+}
+async function assertKeyGenerationIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.generateKey !== "function") {
+    throw new Error("No key generation implementation could be found");
+  }
+  if (!await isEd25519CurveSupported(globalThis.crypto.subtle)) {
+    throw new Error(
+      "This runtime does not support the generation of Ed25519 key pairs.\n\nInstall and import `@solana/webcrypto-ed25519-polyfill` before generating keys in environments that do not support Ed25519.\n\nFor a list of runtimes that currently support Ed25519 operations, visit https://github.com/WICG/webcrypto-secure-curves/issues/20"
+    );
+  }
+}
+async function assertKeyExporterIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.exportKey !== "function") {
+    throw new Error("No key export implementation could be found");
+  }
+}
+async function assertSigningCapabilityIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.sign !== "function") {
+    throw new Error("No signing implementation could be found");
+  }
+}
+async function assertVerificationCapabilityIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.verify !== "function") {
+    throw new Error("No signature verification implementation could be found");
+  }
+}
+
+// src/key-pair.ts
+async function generateKeyPair() {
+  await assertKeyGenerationIsAvailable();
+  const keyPair = await crypto.subtle.generateKey(
+    /* algorithm */
+    "Ed25519",
+    // Native implementation status: https://github.com/WICG/webcrypto-secure-curves/issues/20
+    /* extractable */
+    false,
+    // Prevents the bytes of the private key from being visible to JS.
+    /* allowed uses */
+    ["sign", "verify"]
+  );
+  return keyPair;
+}
+
+// src/pubkey.ts
+async function getBase58EncodedAddressFromPublicKey(publicKey) {
+  await assertKeyExporterIsAvailable();
+  if (publicKey.type !== "public" || publicKey.algorithm.name !== "Ed25519") {
+    throw new Error("The `CryptoKey` must be an `Ed25519` public key");
+  }
+  const publicKeyBytes = await crypto.subtle.exportKey("raw", publicKey);
+  const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));
+  return base58EncodedAddress;
+}
+
+// src/signatures.ts
+async function signBytes(key, data) {
+  await assertSigningCapabilityIsAvailable();
+  const signedData = await crypto.subtle.sign("Ed25519", key, data);
+  return new Uint8Array(signedData);
+}
+async function verifySignature(key, signature, data) {
+  await assertVerificationCapabilityIsAvailable();
+  return await crypto.subtle.verify("Ed25519", key, signature, data);
+}
+
 exports.assertIsBase58EncodedAddress = assertIsBase58EncodedAddress;
+exports.generateKeyPair = generateKeyPair;
+exports.getBase58EncodedAddressCodec = getBase58EncodedAddressCodec;
 exports.getBase58EncodedAddressComparator = getBase58EncodedAddressComparator;
+exports.getBase58EncodedAddressFromPublicKey = getBase58EncodedAddressFromPublicKey;
+exports.signBytes = signBytes;
+exports.verifySignature = verifySignature;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.browser.cjs.map

package/dist/index.browser.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/base58.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAMV,SAAS,6BACZ,8BACiG;AACjG,MAAI;AAEA;AAAA;AAAA,MAEI,6BAA6B,SAAS;AAAA,MAEtC,6BAA6B,SAAS;AAAA,MACxC;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,KAAK,OAAO,4BAA4B;AACtD,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,UAAU;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAP;AACE,UAAM,IAAI,MAAM,KAAK,mEAAmE;AAAA,MACpF,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,oCAAsE;AAClF,SAAO,IAAI,KAAK,SAAS,MAAM;AAAA,IAC3B,WAAW;AAAA,IACX,mBAAmB;AAAA,IACnB,eAAe;AAAA,IACf,SAAS;AAAA,IACT,aAAa;AAAA,IACb,OAAO;AAAA,EACX,CAAC,EAAE;AACP","sourcesContent":["import bs58 from 'bs58';\n\nexport type Base58EncodedAddress<TAddress extends string = string> = TAddress & {\n    readonly __base58EncodedAddress: unique symbol;\n};\n\nexport function assertIsBase58EncodedAddress(\n    putativeBase58EncodedAddress: string\n): asserts putativeBase58EncodedAddress is Base58EncodedAddress<typeof putativeBase58EncodedAddress> {\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest address (32 bytes of zeroes)\n            putativeBase58EncodedAddress.length < 32 ||\n            // Highest address (32 bytes of 255)\n            putativeBase58EncodedAddress.length > 44\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 32.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = bs58.decode(putativeBase58EncodedAddress);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 32) {\n            throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeBase58EncodedAddress}\\` is not a base-58 encoded address`, {\n            cause: e,\n        });\n    }\n}\n\nexport function getBase58EncodedAddressComparator(): (x: string, y: string) => number {\n    return new Intl.Collator('en', {\n        caseFirst: 'lower',\n        ignorePunctuation: false,\n        localeMatcher: 'best fit',\n        numeric: false,\n        sensitivity: 'variant',\n        usage: 'sort',\n    }).compare;\n}\n"]}
+{"version":3,"sources":["../../build-scripts/env-shim.ts","../src/base58.ts","../src/guard.ts","../src/key-pair.ts","../src/pubkey.ts","../src/signatures.ts"],"names":[],"mappings":";AACO,IAAM,UAA2B,uBAAO,QAAgB,KAAU,EAAE,aAAa,eAAe;;;ACDvG,SAAS,QAAoB,cAAc;AAMpC,SAAS,6BACZ,8BACiG;AACjG,MAAI;AAEA;AAAA;AAAA,MAEI,6BAA6B,SAAS;AAAA,MAEtC,6BAA6B,SAAS;AAAA,MACxC;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,OAAO,UAAU,4BAA4B;AAC3D,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,UAAU;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAP;AACE,UAAM,IAAI,MAAM,KAAK,mEAAmE;AAAA,MACpF,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,6BACZ,QAGgC;AAChC,SAAO,OAAO;AAAA,IACV,aAAa,QAAQ,gBAAgB,UAAU,8BAA8B;AAAA,IAC7E,UAAU;AAAA,IACV,MAAM;AAAA,EACV,CAAC;AACL;AAEO,SAAS,oCAAsE;AAClF,SAAO,IAAI,KAAK,SAAS,MAAM;AAAA,IAC3B,WAAW;AAAA,IACX,mBAAmB;AAAA,IACnB,eAAe;AAAA,IACf,SAAS;AAAA,IACT,aAAa;AAAA,IACb,OAAO;AAAA,EACX,CAAC,EAAE;AACP;;;ACrDA,SAAS,wBAAwB;AAC7B,MAAmB,CAAC,WAAW,iBAAiB;AAE5C,UAAM,IAAI;AAAA,MACN;AAAA,IAEJ;AAAA,EACJ;AACJ;AAEA,IAAI;AACJ,eAAe,wBAAwB,QAAwC;AAC3E,MAAI,0BAA0B,QAAW;AACrC,4BAAwB,IAAI,QAAQ,aAAW;AAC3C,aACK;AAAA,QAAY;AAAA;AAAA,QAA6B;AAAA,QAAO,CAAC,QAAQ,QAAQ;AAAA,MAAC,EAClE,MAAM,MAAM;AACT,gBAAS,wBAAwB,KAAM;AAAA,MAC3C,CAAC,EACA,KAAK,MAAM;AACR,gBAAS,wBAAwB,IAAK;AAAA,MAC1C,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AACA,MAAI,OAAO,0BAA0B,WAAW;AAC5C,WAAO;AAAA,EACX,OAAO;AACH,WAAO,MAAM;AAAA,EACjB;AACJ;AAEA,eAAsB,iCAAiC;AACnD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,gBAAgB,YAAY;AAEzG,UAAM,IAAI,MAAM,iDAAiD;AAAA,EACrE;AACA,MAAI,CAAE,MAAM,wBAAwB,WAAW,OAAO,MAAM,GAAI;AAE5D,UAAM,IAAI;AAAA,MACN;AAAA,IAKJ;AAAA,EACJ;AACJ;AAEA,eAAsB,+BAA+B;AACjD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,cAAc,YAAY;AAEvG,UAAM,IAAI,MAAM,6CAA6C;AAAA,EACjE;AACJ;AAEA,eAAsB,qCAAqC;AACvD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,SAAS,YAAY;AAElG,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC9D;AACJ;AAEA,eAAsB,0CAA0C;AAC5D,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,WAAW,YAAY;AAEpG,UAAM,IAAI,MAAM,yDAAyD;AAAA,EAC7E;AACJ;;;ACrEA,eAAsB,kBAA0C;AAC5D,QAAM,+BAA+B;AACrC,QAAM,UAAU,MAAM,OAAO,OAAO;AAAA;AAAA,IAChB;AAAA;AAAA;AAAA,IACE;AAAA;AAAA;AAAA,IACC,CAAC,QAAQ,QAAQ;AAAA,EACxC;AACA,SAAO;AACX;;;ACPA,eAAsB,qCAAqC,WAAqD;AAC5G,QAAM,6BAA6B;AACnC,MAAI,UAAU,SAAS,YAAY,UAAU,UAAU,SAAS,WAAW;AAEvE,UAAM,IAAI,MAAM,iDAAiD;AAAA,EACrE;AACA,QAAM,iBAAiB,MAAM,OAAO,OAAO,UAAU,OAAO,SAAS;AACrE,QAAM,CAAC,oBAAoB,IAAI,6BAA6B,EAAE,YAAY,IAAI,WAAW,cAAc,CAAC;AACxG,SAAO;AACX;;;ACRA,eAAsB,UAAU,KAAgB,MAA6C;AACzF,QAAM,mCAAmC;AACzC,QAAM,aAAa,MAAM,OAAO,OAAO,KAAK,WAAW,KAAK,IAAI;AAChE,SAAO,IAAI,WAAW,UAAU;AACpC;AAEA,eAAsB,gBAAgB,KAAgB,WAA6B,MAAoC;AACnH,QAAM,wCAAwC;AAC9C,SAAO,MAAM,OAAO,OAAO,OAAO,WAAW,KAAK,WAAW,IAAI;AACrE","sourcesContent":["// Clever obfuscation to prevent the build system from inlining the value of `NODE_ENV`\nexport const __DEV__ = /* @__PURE__ */ (() => (process as any)['en' + 'v'].NODE_ENV === 'development')();\n","import { base58, Serializer, string } from '@metaplex-foundation/umi-serializers';\n\nexport type Base58EncodedAddress<TAddress extends string = string> = TAddress & {\n    readonly __base58EncodedAddress: unique symbol;\n};\n\nexport function assertIsBase58EncodedAddress(\n    putativeBase58EncodedAddress: string\n): asserts putativeBase58EncodedAddress is Base58EncodedAddress<typeof putativeBase58EncodedAddress> {\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest address (32 bytes of zeroes)\n            putativeBase58EncodedAddress.length < 32 ||\n            // Highest address (32 bytes of 255)\n            putativeBase58EncodedAddress.length > 44\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 32.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = base58.serialize(putativeBase58EncodedAddress);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 32) {\n            throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeBase58EncodedAddress}\\` is not a base-58 encoded address`, {\n            cause: e,\n        });\n    }\n}\n\nexport function getBase58EncodedAddressCodec(\n    config?: Readonly<{\n        description: string;\n    }>\n): Serializer<Base58EncodedAddress> {\n    return string({\n        description: config?.description ?? (__DEV__ ? 'A 32-byte account address' : ''),\n        encoding: base58,\n        size: 32,\n    }) as unknown as Serializer<Base58EncodedAddress>;\n}\n\nexport function getBase58EncodedAddressComparator(): (x: string, y: string) => number {\n    return new Intl.Collator('en', {\n        caseFirst: 'lower',\n        ignorePunctuation: false,\n        localeMatcher: 'best fit',\n        numeric: false,\n        sensitivity: 'variant',\n        usage: 'sort',\n    }).compare;\n}\n","function assertIsSecureContext() {\n    if (__BROWSER__ && !globalThis.isSecureContext) {\n        // TODO: Coded error.\n        throw new Error(\n            'Cryptographic operations are only allowed in secure browser contexts. Read more ' +\n                'here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts'\n        );\n    }\n}\n\nlet cachedEd25519Decision: PromiseLike<boolean> | boolean | undefined;\nasync function isEd25519CurveSupported(subtle: SubtleCrypto): Promise<boolean> {\n    if (cachedEd25519Decision === undefined) {\n        cachedEd25519Decision = new Promise(resolve => {\n            subtle\n                .generateKey('Ed25519', /* extractable */ false, ['sign', 'verify'])\n                .catch(() => {\n                    resolve((cachedEd25519Decision = false));\n                })\n                .then(() => {\n                    resolve((cachedEd25519Decision = true));\n                });\n        });\n    }\n    if (typeof cachedEd25519Decision === 'boolean') {\n        return cachedEd25519Decision;\n    } else {\n        return await cachedEd25519Decision;\n    }\n}\n\nexport async function assertKeyGenerationIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.generateKey !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No key generation implementation could be found');\n    }\n    if (!(await isEd25519CurveSupported(globalThis.crypto.subtle))) {\n        // TODO: Coded error.\n        throw new Error(\n            'This runtime does not support the generation of Ed25519 key pairs.\\n\\nInstall and ' +\n                'import `@solana/webcrypto-ed25519-polyfill` before generating keys in ' +\n                'environments that do not support Ed25519.\\n\\nFor a list of runtimes that ' +\n                'currently support Ed25519 operations, visit ' +\n                'https://github.com/WICG/webcrypto-secure-curves/issues/20'\n        );\n    }\n}\n\nexport async function assertKeyExporterIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.exportKey !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No key export implementation could be found');\n    }\n}\n\nexport async function assertSigningCapabilityIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.sign !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No signing implementation could be found');\n    }\n}\n\nexport async function assertVerificationCapabilityIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.verify !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No signature verification implementation could be found');\n    }\n}\n","import { assertKeyGenerationIsAvailable } from './guard';\n\nexport async function generateKeyPair(): Promise<CryptoKeyPair> {\n    await assertKeyGenerationIsAvailable();\n    const keyPair = await crypto.subtle.generateKey(\n        /* algorithm */ 'Ed25519', // Native implementation status: https://github.com/WICG/webcrypto-secure-curves/issues/20\n        /* extractable */ false, // Prevents the bytes of the private key from being visible to JS.\n        /* allowed uses */ ['sign', 'verify']\n    );\n    return keyPair as CryptoKeyPair;\n}\n","import { Base58EncodedAddress, getBase58EncodedAddressCodec } from './base58';\nimport { assertKeyExporterIsAvailable } from './guard';\n\nexport async function getBase58EncodedAddressFromPublicKey(publicKey: CryptoKey): Promise<Base58EncodedAddress> {\n    await assertKeyExporterIsAvailable();\n    if (publicKey.type !== 'public' || publicKey.algorithm.name !== 'Ed25519') {\n        // TODO: Coded error.\n        throw new Error('The `CryptoKey` must be an `Ed25519` public key');\n    }\n    const publicKeyBytes = await crypto.subtle.exportKey('raw', publicKey);\n    const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));\n    return base58EncodedAddress;\n}\n","import { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from './guard';\n\nexport type Ed25519Signature = Uint8Array & { readonly __ed25519Signature: unique symbol };\n\nexport async function signBytes(key: CryptoKey, data: Uint8Array): Promise<Ed25519Signature> {\n    await assertSigningCapabilityIsAvailable();\n    const signedData = await crypto.subtle.sign('Ed25519', key, data);\n    return new Uint8Array(signedData) as Ed25519Signature;\n}\n\nexport async function verifySignature(key: CryptoKey, signature: Ed25519Signature, data: Uint8Array): Promise<boolean> {\n    await assertVerificationCapabilityIsAvailable();\n    return await crypto.subtle.verify('Ed25519', key, signature, data);\n}\n"]}

package/dist/index.browser.js

@@ -1,6 +1,7 @@
-import bs58 from 'bs58';
+import { base58, string } from '@metaplex-foundation/umi-serializers';
 
-// src/base58.ts
+// ../build-scripts/env-shim.ts
+var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
 function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
   try {
     if (
@@ -10,7 +11,7 @@ function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
     ) {
       throw new Error("Expected input string to decode to a byte array of length 32.");
     }
-    const bytes = bs58.decode(putativeBase58EncodedAddress);
+    const bytes = base58.serialize(putativeBase58EncodedAddress);
     const numBytes = bytes.byteLength;
     if (numBytes !== 32) {
       throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);
@@ -21,6 +22,13 @@ function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
     });
   }
 }
+function getBase58EncodedAddressCodec(config) {
+  return string({
+    description: config?.description ?? (__DEV__ ? "A 32-byte account address" : ""),
+    encoding: base58,
+    size: 32
+  });
+}
 function getBase58EncodedAddressComparator() {
   return new Intl.Collator("en", {
     caseFirst: "lower",
@@ -32,6 +40,104 @@ function getBase58EncodedAddressComparator() {
   }).compare;
 }
 
-export { assertIsBase58EncodedAddress, getBase58EncodedAddressComparator };
+// src/guard.ts
+function assertIsSecureContext() {
+  if (!globalThis.isSecureContext) {
+    throw new Error(
+      "Cryptographic operations are only allowed in secure browser contexts. Read more here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts"
+    );
+  }
+}
+var cachedEd25519Decision;
+async function isEd25519CurveSupported(subtle) {
+  if (cachedEd25519Decision === void 0) {
+    cachedEd25519Decision = new Promise((resolve) => {
+      subtle.generateKey(
+        "Ed25519",
+        /* extractable */
+        false,
+        ["sign", "verify"]
+      ).catch(() => {
+        resolve(cachedEd25519Decision = false);
+      }).then(() => {
+        resolve(cachedEd25519Decision = true);
+      });
+    });
+  }
+  if (typeof cachedEd25519Decision === "boolean") {
+    return cachedEd25519Decision;
+  } else {
+    return await cachedEd25519Decision;
+  }
+}
+async function assertKeyGenerationIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.generateKey !== "function") {
+    throw new Error("No key generation implementation could be found");
+  }
+  if (!await isEd25519CurveSupported(globalThis.crypto.subtle)) {
+    throw new Error(
+      "This runtime does not support the generation of Ed25519 key pairs.\n\nInstall and import `@solana/webcrypto-ed25519-polyfill` before generating keys in environments that do not support Ed25519.\n\nFor a list of runtimes that currently support Ed25519 operations, visit https://github.com/WICG/webcrypto-secure-curves/issues/20"
+    );
+  }
+}
+async function assertKeyExporterIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.exportKey !== "function") {
+    throw new Error("No key export implementation could be found");
+  }
+}
+async function assertSigningCapabilityIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.sign !== "function") {
+    throw new Error("No signing implementation could be found");
+  }
+}
+async function assertVerificationCapabilityIsAvailable() {
+  assertIsSecureContext();
+  if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.verify !== "function") {
+    throw new Error("No signature verification implementation could be found");
+  }
+}
+
+// src/key-pair.ts
+async function generateKeyPair() {
+  await assertKeyGenerationIsAvailable();
+  const keyPair = await crypto.subtle.generateKey(
+    /* algorithm */
+    "Ed25519",
+    // Native implementation status: https://github.com/WICG/webcrypto-secure-curves/issues/20
+    /* extractable */
+    false,
+    // Prevents the bytes of the private key from being visible to JS.
+    /* allowed uses */
+    ["sign", "verify"]
+  );
+  return keyPair;
+}
+
+// src/pubkey.ts
+async function getBase58EncodedAddressFromPublicKey(publicKey) {
+  await assertKeyExporterIsAvailable();
+  if (publicKey.type !== "public" || publicKey.algorithm.name !== "Ed25519") {
+    throw new Error("The `CryptoKey` must be an `Ed25519` public key");
+  }
+  const publicKeyBytes = await crypto.subtle.exportKey("raw", publicKey);
+  const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));
+  return base58EncodedAddress;
+}
+
+// src/signatures.ts
+async function signBytes(key, data) {
+  await assertSigningCapabilityIsAvailable();
+  const signedData = await crypto.subtle.sign("Ed25519", key, data);
+  return new Uint8Array(signedData);
+}
+async function verifySignature(key, signature, data) {
+  await assertVerificationCapabilityIsAvailable();
+  return await crypto.subtle.verify("Ed25519", key, signature, data);
+}
+
+export { assertIsBase58EncodedAddress, generateKeyPair, getBase58EncodedAddressCodec, getBase58EncodedAddressComparator, getBase58EncodedAddressFromPublicKey, signBytes, verifySignature };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.browser.js.map

package/dist/index.browser.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/base58.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAMV,SAAS,6BACZ,8BACiG;AACjG,MAAI;AAEA;AAAA;AAAA,MAEI,6BAA6B,SAAS;AAAA,MAEtC,6BAA6B,SAAS;AAAA,MACxC;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,KAAK,OAAO,4BAA4B;AACtD,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,UAAU;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAP;AACE,UAAM,IAAI,MAAM,KAAK,mEAAmE;AAAA,MACpF,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,oCAAsE;AAClF,SAAO,IAAI,KAAK,SAAS,MAAM;AAAA,IAC3B,WAAW;AAAA,IACX,mBAAmB;AAAA,IACnB,eAAe;AAAA,IACf,SAAS;AAAA,IACT,aAAa;AAAA,IACb,OAAO;AAAA,EACX,CAAC,EAAE;AACP","sourcesContent":["import bs58 from 'bs58';\n\nexport type Base58EncodedAddress<TAddress extends string = string> = TAddress & {\n    readonly __base58EncodedAddress: unique symbol;\n};\n\nexport function assertIsBase58EncodedAddress(\n    putativeBase58EncodedAddress: string\n): asserts putativeBase58EncodedAddress is Base58EncodedAddress<typeof putativeBase58EncodedAddress> {\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest address (32 bytes of zeroes)\n            putativeBase58EncodedAddress.length < 32 ||\n            // Highest address (32 bytes of 255)\n            putativeBase58EncodedAddress.length > 44\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 32.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = bs58.decode(putativeBase58EncodedAddress);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 32) {\n            throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeBase58EncodedAddress}\\` is not a base-58 encoded address`, {\n            cause: e,\n        });\n    }\n}\n\nexport function getBase58EncodedAddressComparator(): (x: string, y: string) => number {\n    return new Intl.Collator('en', {\n        caseFirst: 'lower',\n        ignorePunctuation: false,\n        localeMatcher: 'best fit',\n        numeric: false,\n        sensitivity: 'variant',\n        usage: 'sort',\n    }).compare;\n}\n"]}
+{"version":3,"sources":["../../build-scripts/env-shim.ts","../src/base58.ts","../src/guard.ts","../src/key-pair.ts","../src/pubkey.ts","../src/signatures.ts"],"names":[],"mappings":";AACO,IAAM,UAA2B,uBAAO,QAAgB,KAAU,EAAE,aAAa,eAAe;;;ACDvG,SAAS,QAAoB,cAAc;AAMpC,SAAS,6BACZ,8BACiG;AACjG,MAAI;AAEA;AAAA;AAAA,MAEI,6BAA6B,SAAS;AAAA,MAEtC,6BAA6B,SAAS;AAAA,MACxC;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,OAAO,UAAU,4BAA4B;AAC3D,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,UAAU;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAP;AACE,UAAM,IAAI,MAAM,KAAK,mEAAmE;AAAA,MACpF,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,6BACZ,QAGgC;AAChC,SAAO,OAAO;AAAA,IACV,aAAa,QAAQ,gBAAgB,UAAU,8BAA8B;AAAA,IAC7E,UAAU;AAAA,IACV,MAAM;AAAA,EACV,CAAC;AACL;AAEO,SAAS,oCAAsE;AAClF,SAAO,IAAI,KAAK,SAAS,MAAM;AAAA,IAC3B,WAAW;AAAA,IACX,mBAAmB;AAAA,IACnB,eAAe;AAAA,IACf,SAAS;AAAA,IACT,aAAa;AAAA,IACb,OAAO;AAAA,EACX,CAAC,EAAE;AACP;;;ACrDA,SAAS,wBAAwB;AAC7B,MAAmB,CAAC,WAAW,iBAAiB;AAE5C,UAAM,IAAI;AAAA,MACN;AAAA,IAEJ;AAAA,EACJ;AACJ;AAEA,IAAI;AACJ,eAAe,wBAAwB,QAAwC;AAC3E,MAAI,0BAA0B,QAAW;AACrC,4BAAwB,IAAI,QAAQ,aAAW;AAC3C,aACK;AAAA,QAAY;AAAA;AAAA,QAA6B;AAAA,QAAO,CAAC,QAAQ,QAAQ;AAAA,MAAC,EAClE,MAAM,MAAM;AACT,gBAAS,wBAAwB,KAAM;AAAA,MAC3C,CAAC,EACA,KAAK,MAAM;AACR,gBAAS,wBAAwB,IAAK;AAAA,MAC1C,CAAC;AAAA,IACT,CAAC;AAAA,EACL;AACA,MAAI,OAAO,0BAA0B,WAAW;AAC5C,WAAO;AAAA,EACX,OAAO;AACH,WAAO,MAAM;AAAA,EACjB;AACJ;AAEA,eAAsB,iCAAiC;AACnD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,gBAAgB,YAAY;AAEzG,UAAM,IAAI,MAAM,iDAAiD;AAAA,EACrE;AACA,MAAI,CAAE,MAAM,wBAAwB,WAAW,OAAO,MAAM,GAAI;AAE5D,UAAM,IAAI;AAAA,MACN;AAAA,IAKJ;AAAA,EACJ;AACJ;AAEA,eAAsB,+BAA+B;AACjD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,cAAc,YAAY;AAEvG,UAAM,IAAI,MAAM,6CAA6C;AAAA,EACjE;AACJ;AAEA,eAAsB,qCAAqC;AACvD,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,SAAS,YAAY;AAElG,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC9D;AACJ;AAEA,eAAsB,0CAA0C;AAC5D,wBAAsB;AACtB,MAAI,OAAO,WAAW,WAAW,eAAe,OAAO,WAAW,OAAO,QAAQ,WAAW,YAAY;AAEpG,UAAM,IAAI,MAAM,yDAAyD;AAAA,EAC7E;AACJ;;;ACrEA,eAAsB,kBAA0C;AAC5D,QAAM,+BAA+B;AACrC,QAAM,UAAU,MAAM,OAAO,OAAO;AAAA;AAAA,IAChB;AAAA;AAAA;AAAA,IACE;AAAA;AAAA;AAAA,IACC,CAAC,QAAQ,QAAQ;AAAA,EACxC;AACA,SAAO;AACX;;;ACPA,eAAsB,qCAAqC,WAAqD;AAC5G,QAAM,6BAA6B;AACnC,MAAI,UAAU,SAAS,YAAY,UAAU,UAAU,SAAS,WAAW;AAEvE,UAAM,IAAI,MAAM,iDAAiD;AAAA,EACrE;AACA,QAAM,iBAAiB,MAAM,OAAO,OAAO,UAAU,OAAO,SAAS;AACrE,QAAM,CAAC,oBAAoB,IAAI,6BAA6B,EAAE,YAAY,IAAI,WAAW,cAAc,CAAC;AACxG,SAAO;AACX;;;ACRA,eAAsB,UAAU,KAAgB,MAA6C;AACzF,QAAM,mCAAmC;AACzC,QAAM,aAAa,MAAM,OAAO,OAAO,KAAK,WAAW,KAAK,IAAI;AAChE,SAAO,IAAI,WAAW,UAAU;AACpC;AAEA,eAAsB,gBAAgB,KAAgB,WAA6B,MAAoC;AACnH,QAAM,wCAAwC;AAC9C,SAAO,MAAM,OAAO,OAAO,OAAO,WAAW,KAAK,WAAW,IAAI;AACrE","sourcesContent":["// Clever obfuscation to prevent the build system from inlining the value of `NODE_ENV`\nexport const __DEV__ = /* @__PURE__ */ (() => (process as any)['en' + 'v'].NODE_ENV === 'development')();\n","import { base58, Serializer, string } from '@metaplex-foundation/umi-serializers';\n\nexport type Base58EncodedAddress<TAddress extends string = string> = TAddress & {\n    readonly __base58EncodedAddress: unique symbol;\n};\n\nexport function assertIsBase58EncodedAddress(\n    putativeBase58EncodedAddress: string\n): asserts putativeBase58EncodedAddress is Base58EncodedAddress<typeof putativeBase58EncodedAddress> {\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest address (32 bytes of zeroes)\n            putativeBase58EncodedAddress.length < 32 ||\n            // Highest address (32 bytes of 255)\n            putativeBase58EncodedAddress.length > 44\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 32.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = base58.serialize(putativeBase58EncodedAddress);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 32) {\n            throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeBase58EncodedAddress}\\` is not a base-58 encoded address`, {\n            cause: e,\n        });\n    }\n}\n\nexport function getBase58EncodedAddressCodec(\n    config?: Readonly<{\n        description: string;\n    }>\n): Serializer<Base58EncodedAddress> {\n    return string({\n        description: config?.description ?? (__DEV__ ? 'A 32-byte account address' : ''),\n        encoding: base58,\n        size: 32,\n    }) as unknown as Serializer<Base58EncodedAddress>;\n}\n\nexport function getBase58EncodedAddressComparator(): (x: string, y: string) => number {\n    return new Intl.Collator('en', {\n        caseFirst: 'lower',\n        ignorePunctuation: false,\n        localeMatcher: 'best fit',\n        numeric: false,\n        sensitivity: 'variant',\n        usage: 'sort',\n    }).compare;\n}\n","function assertIsSecureContext() {\n    if (__BROWSER__ && !globalThis.isSecureContext) {\n        // TODO: Coded error.\n        throw new Error(\n            'Cryptographic operations are only allowed in secure browser contexts. Read more ' +\n                'here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts'\n        );\n    }\n}\n\nlet cachedEd25519Decision: PromiseLike<boolean> | boolean | undefined;\nasync function isEd25519CurveSupported(subtle: SubtleCrypto): Promise<boolean> {\n    if (cachedEd25519Decision === undefined) {\n        cachedEd25519Decision = new Promise(resolve => {\n            subtle\n                .generateKey('Ed25519', /* extractable */ false, ['sign', 'verify'])\n                .catch(() => {\n                    resolve((cachedEd25519Decision = false));\n                })\n                .then(() => {\n                    resolve((cachedEd25519Decision = true));\n                });\n        });\n    }\n    if (typeof cachedEd25519Decision === 'boolean') {\n        return cachedEd25519Decision;\n    } else {\n        return await cachedEd25519Decision;\n    }\n}\n\nexport async function assertKeyGenerationIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.generateKey !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No key generation implementation could be found');\n    }\n    if (!(await isEd25519CurveSupported(globalThis.crypto.subtle))) {\n        // TODO: Coded error.\n        throw new Error(\n            'This runtime does not support the generation of Ed25519 key pairs.\\n\\nInstall and ' +\n                'import `@solana/webcrypto-ed25519-polyfill` before generating keys in ' +\n                'environments that do not support Ed25519.\\n\\nFor a list of runtimes that ' +\n                'currently support Ed25519 operations, visit ' +\n                'https://github.com/WICG/webcrypto-secure-curves/issues/20'\n        );\n    }\n}\n\nexport async function assertKeyExporterIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.exportKey !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No key export implementation could be found');\n    }\n}\n\nexport async function assertSigningCapabilityIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.sign !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No signing implementation could be found');\n    }\n}\n\nexport async function assertVerificationCapabilityIsAvailable() {\n    assertIsSecureContext();\n    if (typeof globalThis.crypto === 'undefined' || typeof globalThis.crypto.subtle?.verify !== 'function') {\n        // TODO: Coded error.\n        throw new Error('No signature verification implementation could be found');\n    }\n}\n","import { assertKeyGenerationIsAvailable } from './guard';\n\nexport async function generateKeyPair(): Promise<CryptoKeyPair> {\n    await assertKeyGenerationIsAvailable();\n    const keyPair = await crypto.subtle.generateKey(\n        /* algorithm */ 'Ed25519', // Native implementation status: https://github.com/WICG/webcrypto-secure-curves/issues/20\n        /* extractable */ false, // Prevents the bytes of the private key from being visible to JS.\n        /* allowed uses */ ['sign', 'verify']\n    );\n    return keyPair as CryptoKeyPair;\n}\n","import { Base58EncodedAddress, getBase58EncodedAddressCodec } from './base58';\nimport { assertKeyExporterIsAvailable } from './guard';\n\nexport async function getBase58EncodedAddressFromPublicKey(publicKey: CryptoKey): Promise<Base58EncodedAddress> {\n    await assertKeyExporterIsAvailable();\n    if (publicKey.type !== 'public' || publicKey.algorithm.name !== 'Ed25519') {\n        // TODO: Coded error.\n        throw new Error('The `CryptoKey` must be an `Ed25519` public key');\n    }\n    const publicKeyBytes = await crypto.subtle.exportKey('raw', publicKey);\n    const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));\n    return base58EncodedAddress;\n}\n","import { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from './guard';\n\nexport type Ed25519Signature = Uint8Array & { readonly __ed25519Signature: unique symbol };\n\nexport async function signBytes(key: CryptoKey, data: Uint8Array): Promise<Ed25519Signature> {\n    await assertSigningCapabilityIsAvailable();\n    const signedData = await crypto.subtle.sign('Ed25519', key, data);\n    return new Uint8Array(signedData) as Ed25519Signature;\n}\n\nexport async function verifySignature(key: CryptoKey, signature: Ed25519Signature, data: Uint8Array): Promise<boolean> {\n    await assertVerificationCapabilityIsAvailable();\n    return await crypto.subtle.verify('Ed25519', key, signature, data);\n}\n"]}