@solana/keys 2.0.0-experimental.de111d2 → 2.0.0-experimental.dfb72ea

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Solana Labs, Inc
+Copyright (c) 2023 Solana Labs, Inc
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -18,35 +18,121 @@ This package contains utilities for validating, generating, and manipulating add
 
 ## Types
 
-### `Base58EncodedAddress`
+### `Signature`
 
-This type represents a string that validates as a Solana address or public key. Functions that require well-formed addresses should specify their inputs in terms of this type.
+This type represents a 64-byte Ed25519 signature of some data with a private key, as a base58-encoded string.
 
-Whenever you need to validate an arbitrary string as a base58-encoded address, use the `assertIsBase58EncodedAddress()` function in this package.
+### `SignatureBytes`
 
-## Functions
+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.
 
-### `assertIsBase58EncodedAddress()`
+## Functions
 
-Client applications primarily deal with addresses and public keys in the form of base58-encoded strings. Addresses and public keys returned from the RPC API conform to the type `Base58EncodedAddress`. You can use a value of that type wherever a base58-encoded address or key is expected.
+### `assertIsSignature()`
 
-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.
+From time to time you might acquire a string that you expect to be a base58-encoded signature (eg. of a transaction) from an untrusted network API or user input. To assert that such an arbitrary string is in fact an Ed25519 signature, use the `assertIsSignature` function.
 
 ```ts
-import { assertIsBase58EncodedAddress } from '@solana/web3.js`;
+import { assertIsSignature } from '@solana/keys';
 
-// Imagine a function that fetches an account's balance when a user submits a form.
+// Imagine a function that asserts whether a user-supplied signature is valid or not.
 function handleSubmit() {
     // We know only that what the user typed conforms to the `string` type.
-    const address: string = accountAddressInput.value;
+    const signature: string = signatureInput.value;
     try {
         // If this type assertion function doesn't throw, then
-        // Typescript will upcast `address` to `Base58EncodedAddress`.
-        assertIsBase58EncodedAddress(address);
-        // At this point, `address` is a `Base58EncodedAddress` that can be used with the RPC.
-        const balanceInLamports = await rpc.getBalance(address).send();
+        // Typescript will upcast `signature` to `Signature`.
+        assertIsSignature(signature);
+        // At this point, `signature` is a `Signature` that can be used with the RPC.
+        const {
+            value: [status],
+        } = await rpc.getSignatureStatuses([signature]).send();
     } catch (e) {
-        // `address` turned out not to be a base58-encoded address
+        // `signature` turned out not to be a base58-encoded signature
     }
 }
 ```
+
+### `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();
+```
+
+### `createKeyPairFromBytes()`
+
+Given a 64-bytes `Uint8Array` secret key, creates an Ed25519 public/private key pair for use with other methods in this package that accept `CryptoKey` objects.
+
+```ts
+import fs from 'fs';
+import { createKeyPairFromBytes } from '@solana/keys';
+
+// Get bytes from local keypair file.
+const keypairFile = fs.readFileSync('~/.config/solana/id.json');
+const keypairBytes = new Uint8Array(JSON.parse(keypairFile.toString()));
+
+// Create a CryptoKeyPair from the bytes.
+const { privateKey, publicKey } = await createKeyPairFromBytes(keypairBytes);
+```
+
+### `isSignature()`
+
+This is a type guard that accepts a string as input. It will both return `true` if the string conforms to the `Signature` type and will refine the type for use in your program.
+
+```ts
+import { isSignature } from '@solana/keys';
+
+if (isSignature(signature)) {
+    // At this point, `signature` has been refined to a
+    // `Signature` that can be used with the RPC.
+    const {
+        value: [status],
+    } = await rpc.getSignatureStatuses([signature]).send();
+    setSignatureStatus(status);
+} else {
+    setError(`${signature} is not a transaction signature`);
+}
+```
+
+### `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);
+```
+
+### `signature()`
+
+This helper combines _asserting_ that a string is an Ed25519 signature with _coercing_ it to the `Signature` type. It's best used with untrusted input.
+
+```ts
+import { signature } from '@solana/keys';
+
+const signature = signature(userSuppliedSignature);
+const {
+    value: [status],
+} = await rpc.getSignatureStatuses([signature]).send();
+```
+
+### `verifySignature()`
+
+Given a public `CryptoKey`, some `SignatureBytes`, and a `Uint8Array` of data, this method will return `true` if the signature was produced by signing the data 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,44 +1,159 @@
 'use strict';
 
-var bs58 = require('bs58');
+var assertions = require('@solana/assertions');
+var errors = require('@solana/errors');
+var codecsStrings = require('@solana/codecs-strings');
 
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+// src/key-pair.ts
 
-var bs58__default = /*#__PURE__*/_interopDefault(bs58);
+// src/private-key.ts
+function addPkcs8Header(bytes) {
+  return new Uint8Array([
+    /**
+     * PKCS#8 header
+     */
+    48,
+    // ASN.1 sequence tag
+    46,
+    // Length of sequence (46 more bytes)
+    2,
+    // ASN.1 integer tag
+    1,
+    // Length of integer
+    0,
+    // Version number
+    48,
+    // ASN.1 sequence tag
+    5,
+    // Length of sequence
+    6,
+    // ASN.1 object identifier tag
+    3,
+    // Length of object identifier
+    // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112
+    43,
+    // iso(1) / identified-organization(3) (The first node is multiplied by the decimal 40 and the result is added to the value of the second node)
+    101,
+    // thawte(101)
+    // Ed25519 identifier
+    112,
+    // id-Ed25519(112)
+    /**
+     * Private key payload
+     */
+    4,
+    // ASN.1 octet string tag
+    34,
+    // String length (34 more bytes)
+    // Private key bytes as octet string
+    4,
+    // ASN.1 octet string tag
+    32,
+    // String length (32 bytes)
+    ...bytes
+  ]);
+}
+async function createPrivateKeyFromBytes(bytes, extractable) {
+  if (bytes.byteLength !== 32) {
+    throw new Error("Private key bytes must be of length 32");
+  }
+  const privateKeyBytesPkcs8 = addPkcs8Header(bytes);
+  return await crypto.subtle.importKey("pkcs8", privateKeyBytesPkcs8, "Ed25519", extractable ?? false, ["sign"]);
+}
 
-// src/base58.ts
-function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
+// src/key-pair.ts
+async function generateKeyPair() {
+  await assertions.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;
+}
+async function createKeyPairFromBytes(bytes, extractable) {
+  if (bytes.byteLength !== 64) {
+    throw new errors.SolanaError(errors.SOLANA_ERROR__INVALID_KEYPAIR_BYTES, { byteLength: bytes.byteLength });
+  }
+  const [publicKey, privateKey] = await Promise.all([
+    crypto.subtle.importKey(
+      "raw",
+      bytes.slice(32),
+      "Ed25519",
+      /* extractable */
+      true,
+      ["verify"]
+    ),
+    createPrivateKeyFromBytes(bytes.slice(0, 32), extractable)
+  ]);
+  return { privateKey, publicKey };
+}
+var base58Encoder;
+function assertIsSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = codecsStrings.getBase58Encoder();
   try {
     if (
-      // Lowest address (32 bytes of zeroes)
-      putativeBase58EncodedAddress.length < 32 || // Highest address (32 bytes of 255)
-      putativeBase58EncodedAddress.length > 44
+      // Lowest value (64 bytes of zeroes)
+      putativeSignature.length < 64 || // Highest value (64 bytes of 255)
+      putativeSignature.length > 88
     ) {
-      throw new Error("Expected input string to decode to a byte array of length 32.");
+      throw new Error("Expected input string to decode to a byte array of length 64.");
     }
-    const bytes = bs58__default.default.decode(putativeBase58EncodedAddress);
+    const bytes = base58Encoder.encode(putativeSignature);
     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}`);
+    if (numBytes !== 64) {
+      throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
     }
   } catch (e) {
-    throw new Error(`\`${putativeBase58EncodedAddress}\` is not a base-58 encoded address`, {
+    throw new Error(`\`${putativeSignature}\` is not a signature`, {
       cause: e
     });
   }
 }
-function getBase58EncodedAddressComparator() {
-  return new Intl.Collator("en", {
-    caseFirst: "lower",
-    ignorePunctuation: false,
-    localeMatcher: "best fit",
-    numeric: false,
-    sensitivity: "variant",
-    usage: "sort"
-  }).compare;
+function isSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = codecsStrings.getBase58Encoder();
+  if (
+    // Lowest value (64 bytes of zeroes)
+    putativeSignature.length < 64 || // Highest value (64 bytes of 255)
+    putativeSignature.length > 88
+  ) {
+    return false;
+  }
+  const bytes = base58Encoder.encode(putativeSignature);
+  const numBytes = bytes.byteLength;
+  if (numBytes !== 64) {
+    return false;
+  }
+  return true;
+}
+async function signBytes(key, data) {
+  await assertions.assertSigningCapabilityIsAvailable();
+  const signedData = await crypto.subtle.sign("Ed25519", key, data);
+  return new Uint8Array(signedData);
+}
+function signature(putativeSignature) {
+  assertIsSignature(putativeSignature);
+  return putativeSignature;
+}
+async function verifySignature(key, signature2, data) {
+  await assertions.assertVerificationCapabilityIsAvailable();
+  return await crypto.subtle.verify("Ed25519", key, signature2, data);
 }
 
-exports.assertIsBase58EncodedAddress = assertIsBase58EncodedAddress;
-exports.getBase58EncodedAddressComparator = getBase58EncodedAddressComparator;
+exports.assertIsSignature = assertIsSignature;
+exports.createKeyPairFromBytes = createKeyPairFromBytes;
+exports.createPrivateKeyFromBytes = createPrivateKeyFromBytes;
+exports.generateKeyPair = generateKeyPair;
+exports.isSignature = isSignature;
+exports.signBytes = signBytes;
+exports.signature = signature;
+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":["../src/key-pair.ts","../src/private-key.ts","../src/signatures.ts"],"names":["signature"],"mappings":";AAAA,SAAS,sCAAsC;AAC/C,SAAS,qCAAqC,mBAAmB;;;ACDjE,SAAS,eAAe,OAA+B;AAEnD,SAAO,IAAI,WAAW;AAAA;AAAA;AAAA;AAAA,IAIlB;AAAA;AAAA,IACA;AAAA;AAAA,IAEI;AAAA;AAAA,IACA;AAAA;AAAA,IACI;AAAA;AAAA,IAEJ;AAAA;AAAA,IACA;AAAA;AAAA,IACI;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAEQ;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAEA;AAAA;AAAA;AAAA;AAAA;AAAA,IAKhB;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAGI;AAAA;AAAA,IACA;AAAA;AAAA,IAEJ,GAAG;AAAA,EACP,CAAC;AACL;AAEA,eAAsB,0BAA0B,OAAmB,aAA2C;AAC1G,MAAI,MAAM,eAAe,IAAI;AAEzB,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC5D;AACA,QAAM,uBAAuB,eAAe,KAAK;AACjD,SAAO,MAAM,OAAO,OAAO,UAAU,SAAS,sBAAsB,WAAW,eAAe,OAAO,CAAC,MAAM,CAAC;AACjH;;;ADvCA,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;AAEA,eAAsB,uBAAuB,OAAmB,aAA+C;AAC3G,MAAI,MAAM,eAAe,IAAI;AACzB,UAAM,IAAI,YAAY,qCAAqC,EAAE,YAAY,MAAM,WAAW,CAAC;AAAA,EAC/F;AACA,QAAM,CAAC,WAAW,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA,IAC9C,OAAO,OAAO;AAAA,MAAU;AAAA,MAAO,MAAM,MAAM,EAAE;AAAA,MAAG;AAAA;AAAA,MAA6B;AAAA,MAAM,CAAC,QAAQ;AAAA,IAAC;AAAA,IAC7F,0BAA0B,MAAM,MAAM,GAAG,EAAE,GAAG,WAAW;AAAA,EAC7D,CAAC;AACD,SAAO,EAAE,YAAY,UAAU;AACnC;;;AExBA,SAAS,oCAAoC,+CAA+C;AAE5F,SAAS,wBAAwB;AAKjC,IAAI;AAEG,SAAS,kBAAkB,mBAAmE;AACjG,MAAI,CAAC;AAAe,oBAAgB,iBAAiB;AAErD,MAAI;AAEA;AAAA;AAAA,MAEI,kBAAkB,SAAS;AAAA,MAE3B,kBAAkB,SAAS;AAAA,MAC7B;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,cAAc,OAAO,iBAAiB;AACpD,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,QAAQ,EAAE;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAG;AACR,UAAM,IAAI,MAAM,KAAK,iBAAiB,yBAAyB;AAAA,MAC3D,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,YAAY,mBAA2D;AACnF,MAAI,CAAC;AAAe,oBAAgB,iBAAiB;AAGrD;AAAA;AAAA,IAEI,kBAAkB,SAAS;AAAA,IAE3B,kBAAkB,SAAS;AAAA,IAC7B;AACE,WAAO;AAAA,EACX;AAEA,QAAM,QAAQ,cAAc,OAAO,iBAAiB;AACpD,QAAM,WAAW,MAAM;AACvB,MAAI,aAAa,IAAI;AACjB,WAAO;AAAA,EACX;AACA,SAAO;AACX;AAEA,eAAsB,UAAU,KAAgB,MAA2C;AACvF,QAAM,mCAAmC;AACzC,QAAM,aAAa,MAAM,OAAO,OAAO,KAAK,WAAW,KAAK,IAAI;AAChE,SAAO,IAAI,WAAW,UAAU;AACpC;AAEO,SAAS,UAAU,mBAAsC;AAC5D,oBAAkB,iBAAiB;AACnC,SAAO;AACX;AAEA,eAAsB,gBAAgB,KAAgBA,YAA2B,MAAoC;AACjH,QAAM,wCAAwC;AAC9C,SAAO,MAAM,OAAO,OAAO,OAAO,WAAW,KAAKA,YAAW,IAAI;AACrE","sourcesContent":["import { assertKeyGenerationIsAvailable } from '@solana/assertions';\nimport { SOLANA_ERROR__INVALID_KEYPAIR_BYTES, SolanaError } from '@solana/errors';\n\nimport { createPrivateKeyFromBytes } from './private-key';\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\nexport async function createKeyPairFromBytes(bytes: Uint8Array, extractable?: boolean): Promise<CryptoKeyPair> {\n    if (bytes.byteLength !== 64) {\n        throw new SolanaError(SOLANA_ERROR__INVALID_KEYPAIR_BYTES, { byteLength: bytes.byteLength });\n    }\n    const [publicKey, privateKey] = await Promise.all([\n        crypto.subtle.importKey('raw', bytes.slice(32), 'Ed25519', /* extractable */ true, ['verify']),\n        createPrivateKeyFromBytes(bytes.slice(0, 32), extractable),\n    ]);\n    return { privateKey, publicKey } as CryptoKeyPair;\n}\n","function addPkcs8Header(bytes: Uint8Array): Uint8Array {\n    // prettier-ignore\n    return new Uint8Array([\n        /**\n         * PKCS#8 header\n         */\n        0x30, // ASN.1 sequence tag\n        0x2e, // Length of sequence (46 more bytes)\n\n            0x02, // ASN.1 integer tag\n            0x01, // Length of integer\n                0x00, // Version number\n\n            0x30, // ASN.1 sequence tag\n            0x05, // Length of sequence\n                0x06, // ASN.1 object identifier tag\n                0x03, // Length of object identifier\n                    // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112\n                        0x2b, // iso(1) / identified-organization(3) (The first node is multiplied by the decimal 40 and the result is added to the value of the second node)\n                        0x65, // thawte(101)\n                    // Ed25519 identifier\n                        0x70, // id-Ed25519(112)\n\n        /**\n         * Private key payload\n         */\n        0x04, // ASN.1 octet string tag\n        0x22, // String length (34 more bytes)\n\n            // Private key bytes as octet string\n            0x04, // ASN.1 octet string tag\n            0x20, // String length (32 bytes)\n\n        ...bytes\n    ]);\n}\n\nexport async function createPrivateKeyFromBytes(bytes: Uint8Array, extractable?: boolean): Promise<CryptoKey> {\n    if (bytes.byteLength !== 32) {\n        // TODO: Coded error.\n        throw new Error('Private key bytes must be of length 32');\n    }\n    const privateKeyBytesPkcs8 = addPkcs8Header(bytes);\n    return await crypto.subtle.importKey('pkcs8', privateKeyBytesPkcs8, 'Ed25519', extractable ?? false, ['sign']);\n}\n","import { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';\nimport { Encoder } from '@solana/codecs-core';\nimport { getBase58Encoder } from '@solana/codecs-strings';\n\nexport type Signature = string & { readonly __brand: unique symbol };\nexport type SignatureBytes = Uint8Array & { readonly __brand: unique symbol };\n\nlet base58Encoder: Encoder<string> | undefined;\n\nexport function assertIsSignature(putativeSignature: string): asserts putativeSignature is Signature {\n    if (!base58Encoder) base58Encoder = getBase58Encoder();\n\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest value (64 bytes of zeroes)\n            putativeSignature.length < 64 ||\n            // Highest value (64 bytes of 255)\n            putativeSignature.length > 88\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 64.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = base58Encoder.encode(putativeSignature);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 64) {\n            throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeSignature}\\` is not a signature`, {\n            cause: e,\n        });\n    }\n}\n\nexport function isSignature(putativeSignature: string): putativeSignature is Signature {\n    if (!base58Encoder) base58Encoder = getBase58Encoder();\n\n    // Fast-path; see if the input string is of an acceptable length.\n    if (\n        // Lowest value (64 bytes of zeroes)\n        putativeSignature.length < 64 ||\n        // Highest value (64 bytes of 255)\n        putativeSignature.length > 88\n    ) {\n        return false;\n    }\n    // Slow-path; actually attempt to decode the input string.\n    const bytes = base58Encoder.encode(putativeSignature);\n    const numBytes = bytes.byteLength;\n    if (numBytes !== 64) {\n        return false;\n    }\n    return true;\n}\n\nexport async function signBytes(key: CryptoKey, data: Uint8Array): Promise<SignatureBytes> {\n    await assertSigningCapabilityIsAvailable();\n    const signedData = await crypto.subtle.sign('Ed25519', key, data);\n    return new Uint8Array(signedData) as SignatureBytes;\n}\n\nexport function signature(putativeSignature: string): Signature {\n    assertIsSignature(putativeSignature);\n    return putativeSignature;\n}\n\nexport async function verifySignature(key: CryptoKey, signature: SignatureBytes, 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,37 +1,150 @@
-import bs58 from 'bs58';
+import { assertKeyGenerationIsAvailable, assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';
+import { SolanaError, SOLANA_ERROR__INVALID_KEYPAIR_BYTES } from '@solana/errors';
+import { getBase58Encoder } from '@solana/codecs-strings';
 
-// src/base58.ts
-function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
+// src/key-pair.ts
+
+// src/private-key.ts
+function addPkcs8Header(bytes) {
+  return new Uint8Array([
+    /**
+     * PKCS#8 header
+     */
+    48,
+    // ASN.1 sequence tag
+    46,
+    // Length of sequence (46 more bytes)
+    2,
+    // ASN.1 integer tag
+    1,
+    // Length of integer
+    0,
+    // Version number
+    48,
+    // ASN.1 sequence tag
+    5,
+    // Length of sequence
+    6,
+    // ASN.1 object identifier tag
+    3,
+    // Length of object identifier
+    // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112
+    43,
+    // iso(1) / identified-organization(3) (The first node is multiplied by the decimal 40 and the result is added to the value of the second node)
+    101,
+    // thawte(101)
+    // Ed25519 identifier
+    112,
+    // id-Ed25519(112)
+    /**
+     * Private key payload
+     */
+    4,
+    // ASN.1 octet string tag
+    34,
+    // String length (34 more bytes)
+    // Private key bytes as octet string
+    4,
+    // ASN.1 octet string tag
+    32,
+    // String length (32 bytes)
+    ...bytes
+  ]);
+}
+async function createPrivateKeyFromBytes(bytes, extractable) {
+  if (bytes.byteLength !== 32) {
+    throw new Error("Private key bytes must be of length 32");
+  }
+  const privateKeyBytesPkcs8 = addPkcs8Header(bytes);
+  return await crypto.subtle.importKey("pkcs8", privateKeyBytesPkcs8, "Ed25519", extractable ?? false, ["sign"]);
+}
+
+// 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;
+}
+async function createKeyPairFromBytes(bytes, extractable) {
+  if (bytes.byteLength !== 64) {
+    throw new SolanaError(SOLANA_ERROR__INVALID_KEYPAIR_BYTES, { byteLength: bytes.byteLength });
+  }
+  const [publicKey, privateKey] = await Promise.all([
+    crypto.subtle.importKey(
+      "raw",
+      bytes.slice(32),
+      "Ed25519",
+      /* extractable */
+      true,
+      ["verify"]
+    ),
+    createPrivateKeyFromBytes(bytes.slice(0, 32), extractable)
+  ]);
+  return { privateKey, publicKey };
+}
+var base58Encoder;
+function assertIsSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = getBase58Encoder();
   try {
     if (
-      // Lowest address (32 bytes of zeroes)
-      putativeBase58EncodedAddress.length < 32 || // Highest address (32 bytes of 255)
-      putativeBase58EncodedAddress.length > 44
+      // Lowest value (64 bytes of zeroes)
+      putativeSignature.length < 64 || // Highest value (64 bytes of 255)
+      putativeSignature.length > 88
     ) {
-      throw new Error("Expected input string to decode to a byte array of length 32.");
+      throw new Error("Expected input string to decode to a byte array of length 64.");
     }
-    const bytes = bs58.decode(putativeBase58EncodedAddress);
+    const bytes = base58Encoder.encode(putativeSignature);
     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}`);
+    if (numBytes !== 64) {
+      throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
     }
   } catch (e) {
-    throw new Error(`\`${putativeBase58EncodedAddress}\` is not a base-58 encoded address`, {
+    throw new Error(`\`${putativeSignature}\` is not a signature`, {
       cause: e
     });
   }
 }
-function getBase58EncodedAddressComparator() {
-  return new Intl.Collator("en", {
-    caseFirst: "lower",
-    ignorePunctuation: false,
-    localeMatcher: "best fit",
-    numeric: false,
-    sensitivity: "variant",
-    usage: "sort"
-  }).compare;
+function isSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = getBase58Encoder();
+  if (
+    // Lowest value (64 bytes of zeroes)
+    putativeSignature.length < 64 || // Highest value (64 bytes of 255)
+    putativeSignature.length > 88
+  ) {
+    return false;
+  }
+  const bytes = base58Encoder.encode(putativeSignature);
+  const numBytes = bytes.byteLength;
+  if (numBytes !== 64) {
+    return false;
+  }
+  return true;
+}
+async function signBytes(key, data) {
+  await assertSigningCapabilityIsAvailable();
+  const signedData = await crypto.subtle.sign("Ed25519", key, data);
+  return new Uint8Array(signedData);
+}
+function signature(putativeSignature) {
+  assertIsSignature(putativeSignature);
+  return putativeSignature;
+}
+async function verifySignature(key, signature2, data) {
+  await assertVerificationCapabilityIsAvailable();
+  return await crypto.subtle.verify("Ed25519", key, signature2, data);
 }
 
-export { assertIsBase58EncodedAddress, getBase58EncodedAddressComparator };
+export { assertIsSignature, createKeyPairFromBytes, createPrivateKeyFromBytes, generateKeyPair, isSignature, signBytes, signature, 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":["../src/key-pair.ts","../src/private-key.ts","../src/signatures.ts"],"names":["signature"],"mappings":";AAAA,SAAS,sCAAsC;AAC/C,SAAS,qCAAqC,mBAAmB;;;ACDjE,SAAS,eAAe,OAA+B;AAEnD,SAAO,IAAI,WAAW;AAAA;AAAA;AAAA;AAAA,IAIlB;AAAA;AAAA,IACA;AAAA;AAAA,IAEI;AAAA;AAAA,IACA;AAAA;AAAA,IACI;AAAA;AAAA,IAEJ;AAAA;AAAA,IACA;AAAA;AAAA,IACI;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAEQ;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAEA;AAAA;AAAA;AAAA;AAAA;AAAA,IAKhB;AAAA;AAAA,IACA;AAAA;AAAA;AAAA,IAGI;AAAA;AAAA,IACA;AAAA;AAAA,IAEJ,GAAG;AAAA,EACP,CAAC;AACL;AAEA,eAAsB,0BAA0B,OAAmB,aAA2C;AAC1G,MAAI,MAAM,eAAe,IAAI;AAEzB,UAAM,IAAI,MAAM,wCAAwC;AAAA,EAC5D;AACA,QAAM,uBAAuB,eAAe,KAAK;AACjD,SAAO,MAAM,OAAO,OAAO,UAAU,SAAS,sBAAsB,WAAW,eAAe,OAAO,CAAC,MAAM,CAAC;AACjH;;;ADvCA,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;AAEA,eAAsB,uBAAuB,OAAmB,aAA+C;AAC3G,MAAI,MAAM,eAAe,IAAI;AACzB,UAAM,IAAI,YAAY,qCAAqC,EAAE,YAAY,MAAM,WAAW,CAAC;AAAA,EAC/F;AACA,QAAM,CAAC,WAAW,UAAU,IAAI,MAAM,QAAQ,IAAI;AAAA,IAC9C,OAAO,OAAO;AAAA,MAAU;AAAA,MAAO,MAAM,MAAM,EAAE;AAAA,MAAG;AAAA;AAAA,MAA6B;AAAA,MAAM,CAAC,QAAQ;AAAA,IAAC;AAAA,IAC7F,0BAA0B,MAAM,MAAM,GAAG,EAAE,GAAG,WAAW;AAAA,EAC7D,CAAC;AACD,SAAO,EAAE,YAAY,UAAU;AACnC;;;AExBA,SAAS,oCAAoC,+CAA+C;AAE5F,SAAS,wBAAwB;AAKjC,IAAI;AAEG,SAAS,kBAAkB,mBAAmE;AACjG,MAAI,CAAC;AAAe,oBAAgB,iBAAiB;AAErD,MAAI;AAEA;AAAA;AAAA,MAEI,kBAAkB,SAAS;AAAA,MAE3B,kBAAkB,SAAS;AAAA,MAC7B;AACE,YAAM,IAAI,MAAM,+DAA+D;AAAA,IACnF;AAEA,UAAM,QAAQ,cAAc,OAAO,iBAAiB;AACpD,UAAM,WAAW,MAAM;AACvB,QAAI,aAAa,IAAI;AACjB,YAAM,IAAI,MAAM,gFAAgF,QAAQ,EAAE;AAAA,IAC9G;AAAA,EACJ,SAAS,GAAG;AACR,UAAM,IAAI,MAAM,KAAK,iBAAiB,yBAAyB;AAAA,MAC3D,OAAO;AAAA,IACX,CAAC;AAAA,EACL;AACJ;AAEO,SAAS,YAAY,mBAA2D;AACnF,MAAI,CAAC;AAAe,oBAAgB,iBAAiB;AAGrD;AAAA;AAAA,IAEI,kBAAkB,SAAS;AAAA,IAE3B,kBAAkB,SAAS;AAAA,IAC7B;AACE,WAAO;AAAA,EACX;AAEA,QAAM,QAAQ,cAAc,OAAO,iBAAiB;AACpD,QAAM,WAAW,MAAM;AACvB,MAAI,aAAa,IAAI;AACjB,WAAO;AAAA,EACX;AACA,SAAO;AACX;AAEA,eAAsB,UAAU,KAAgB,MAA2C;AACvF,QAAM,mCAAmC;AACzC,QAAM,aAAa,MAAM,OAAO,OAAO,KAAK,WAAW,KAAK,IAAI;AAChE,SAAO,IAAI,WAAW,UAAU;AACpC;AAEO,SAAS,UAAU,mBAAsC;AAC5D,oBAAkB,iBAAiB;AACnC,SAAO;AACX;AAEA,eAAsB,gBAAgB,KAAgBA,YAA2B,MAAoC;AACjH,QAAM,wCAAwC;AAC9C,SAAO,MAAM,OAAO,OAAO,OAAO,WAAW,KAAKA,YAAW,IAAI;AACrE","sourcesContent":["import { assertKeyGenerationIsAvailable } from '@solana/assertions';\nimport { SOLANA_ERROR__INVALID_KEYPAIR_BYTES, SolanaError } from '@solana/errors';\n\nimport { createPrivateKeyFromBytes } from './private-key';\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\nexport async function createKeyPairFromBytes(bytes: Uint8Array, extractable?: boolean): Promise<CryptoKeyPair> {\n    if (bytes.byteLength !== 64) {\n        throw new SolanaError(SOLANA_ERROR__INVALID_KEYPAIR_BYTES, { byteLength: bytes.byteLength });\n    }\n    const [publicKey, privateKey] = await Promise.all([\n        crypto.subtle.importKey('raw', bytes.slice(32), 'Ed25519', /* extractable */ true, ['verify']),\n        createPrivateKeyFromBytes(bytes.slice(0, 32), extractable),\n    ]);\n    return { privateKey, publicKey } as CryptoKeyPair;\n}\n","function addPkcs8Header(bytes: Uint8Array): Uint8Array {\n    // prettier-ignore\n    return new Uint8Array([\n        /**\n         * PKCS#8 header\n         */\n        0x30, // ASN.1 sequence tag\n        0x2e, // Length of sequence (46 more bytes)\n\n            0x02, // ASN.1 integer tag\n            0x01, // Length of integer\n                0x00, // Version number\n\n            0x30, // ASN.1 sequence tag\n            0x05, // Length of sequence\n                0x06, // ASN.1 object identifier tag\n                0x03, // Length of object identifier\n                    // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112\n                        0x2b, // iso(1) / identified-organization(3) (The first node is multiplied by the decimal 40 and the result is added to the value of the second node)\n                        0x65, // thawte(101)\n                    // Ed25519 identifier\n                        0x70, // id-Ed25519(112)\n\n        /**\n         * Private key payload\n         */\n        0x04, // ASN.1 octet string tag\n        0x22, // String length (34 more bytes)\n\n            // Private key bytes as octet string\n            0x04, // ASN.1 octet string tag\n            0x20, // String length (32 bytes)\n\n        ...bytes\n    ]);\n}\n\nexport async function createPrivateKeyFromBytes(bytes: Uint8Array, extractable?: boolean): Promise<CryptoKey> {\n    if (bytes.byteLength !== 32) {\n        // TODO: Coded error.\n        throw new Error('Private key bytes must be of length 32');\n    }\n    const privateKeyBytesPkcs8 = addPkcs8Header(bytes);\n    return await crypto.subtle.importKey('pkcs8', privateKeyBytesPkcs8, 'Ed25519', extractable ?? false, ['sign']);\n}\n","import { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';\nimport { Encoder } from '@solana/codecs-core';\nimport { getBase58Encoder } from '@solana/codecs-strings';\n\nexport type Signature = string & { readonly __brand: unique symbol };\nexport type SignatureBytes = Uint8Array & { readonly __brand: unique symbol };\n\nlet base58Encoder: Encoder<string> | undefined;\n\nexport function assertIsSignature(putativeSignature: string): asserts putativeSignature is Signature {\n    if (!base58Encoder) base58Encoder = getBase58Encoder();\n\n    try {\n        // Fast-path; see if the input string is of an acceptable length.\n        if (\n            // Lowest value (64 bytes of zeroes)\n            putativeSignature.length < 64 ||\n            // Highest value (64 bytes of 255)\n            putativeSignature.length > 88\n        ) {\n            throw new Error('Expected input string to decode to a byte array of length 64.');\n        }\n        // Slow-path; actually attempt to decode the input string.\n        const bytes = base58Encoder.encode(putativeSignature);\n        const numBytes = bytes.byteLength;\n        if (numBytes !== 64) {\n            throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);\n        }\n    } catch (e) {\n        throw new Error(`\\`${putativeSignature}\\` is not a signature`, {\n            cause: e,\n        });\n    }\n}\n\nexport function isSignature(putativeSignature: string): putativeSignature is Signature {\n    if (!base58Encoder) base58Encoder = getBase58Encoder();\n\n    // Fast-path; see if the input string is of an acceptable length.\n    if (\n        // Lowest value (64 bytes of zeroes)\n        putativeSignature.length < 64 ||\n        // Highest value (64 bytes of 255)\n        putativeSignature.length > 88\n    ) {\n        return false;\n    }\n    // Slow-path; actually attempt to decode the input string.\n    const bytes = base58Encoder.encode(putativeSignature);\n    const numBytes = bytes.byteLength;\n    if (numBytes !== 64) {\n        return false;\n    }\n    return true;\n}\n\nexport async function signBytes(key: CryptoKey, data: Uint8Array): Promise<SignatureBytes> {\n    await assertSigningCapabilityIsAvailable();\n    const signedData = await crypto.subtle.sign('Ed25519', key, data);\n    return new Uint8Array(signedData) as SignatureBytes;\n}\n\nexport function signature(putativeSignature: string): Signature {\n    assertIsSignature(putativeSignature);\n    return putativeSignature;\n}\n\nexport async function verifySignature(key: CryptoKey, signature: SignatureBytes, data: Uint8Array): Promise<boolean> {\n    await assertVerificationCapabilityIsAvailable();\n    return await crypto.subtle.verify('Ed25519', key, signature, data);\n}\n"]}