@solana/keys 2.0.0-experimental.fc4e943 → 2.0.0-experimental.fcff844

package/README.md

@@ -18,7 +18,11 @@ This package contains utilities for validating, generating, and manipulating add
 
 ## Types
 
-### `Ed25519Signature`
+### `Signature`
+
+This type represents a 64-byte Ed25519 signature of some data with a private key, as a base58-encoded string.
+
+### `SignatureBytes`
 
 This type represents a 64-byte Ed25519 signature of some data with a private key.
 
@@ -26,6 +30,31 @@ Whenever you need to verify that a particular signature is, in fact, the one tha
 
 ## Functions
 
+### `assertIsSignature()`
+
+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 { assertIsSignature } from '@solana/keys';
+
+// 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 signature: string = signatureInput.value;
+    try {
+        // If this type assertion function doesn't throw, then
+        // 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) {
+        // `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.
@@ -36,6 +65,25 @@ import { generateKeyPair } from '@solana/keys';
 const { privateKey, publicKey } = await generateKeyPair();
 ```
 
+### `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`.
@@ -47,9 +95,22 @@ 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`, 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.
+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';

package/dist/index.browser.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var assertions = require('@solana/assertions');
+var codecsStrings = require('@solana/codecs-strings');
 
 // src/key-pair.ts
 async function generateKeyPair() {
@@ -17,18 +18,119 @@ async function generateKeyPair() {
   );
   return keyPair;
 }
+
+// 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"]);
+}
+var base58Encoder;
+function assertIsSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = codecsStrings.getBase58Encoder();
+  try {
+    if (
+      // 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 64.");
+    }
+    const bytes = base58Encoder.encode(putativeSignature);
+    const numBytes = bytes.byteLength;
+    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(`\`${putativeSignature}\` is not a signature`, {
+      cause: e
+    });
+  }
+}
+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);
 }
-async function verifySignature(key, signature, data) {
+function signature(putativeSignature) {
+  assertIsSignature(putativeSignature);
+  return putativeSignature;
+}
+async function verifySignature(key, signature2, data) {
   await assertions.assertVerificationCapabilityIsAvailable();
-  return await crypto.subtle.verify("Ed25519", key, signature, data);
+  return await crypto.subtle.verify("Ed25519", key, signature2, data);
 }
 
+exports.assertIsSignature = assertIsSignature;
+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/key-pair.ts","../src/signatures.ts"],"names":[],"mappings":";AAAA,SAAS,sCAAsC;AAE/C,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;;;ACVA,SAAS,oCAAoC,+CAA+C;AAI5F,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":["import { assertKeyGenerationIsAvailable } from '@solana/assertions';\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 { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';\n\nexport type Ed25519Signature = Uint8Array & { readonly __brand: 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"]}
+{"version":3,"sources":["../src/key-pair.ts","../src/private-key.ts","../src/signatures.ts"],"names":["signature"],"mappings":";AAAA,SAAS,sCAAsC;AAE/C,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;;;ACVA,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;;;AC5CA,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';\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","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,4 +1,5 @@
 import { assertKeyGenerationIsAvailable, assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';
+import { getBase58Encoder } from '@solana/codecs-strings';
 
 // src/key-pair.ts
 async function generateKeyPair() {
@@ -15,16 +16,115 @@ async function generateKeyPair() {
   );
   return keyPair;
 }
+
+// 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"]);
+}
+var base58Encoder;
+function assertIsSignature(putativeSignature) {
+  if (!base58Encoder)
+    base58Encoder = getBase58Encoder();
+  try {
+    if (
+      // 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 64.");
+    }
+    const bytes = base58Encoder.encode(putativeSignature);
+    const numBytes = bytes.byteLength;
+    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(`\`${putativeSignature}\` is not a signature`, {
+      cause: e
+    });
+  }
+}
+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);
 }
-async function verifySignature(key, signature, data) {
+function signature(putativeSignature) {
+  assertIsSignature(putativeSignature);
+  return putativeSignature;
+}
+async function verifySignature(key, signature2, data) {
   await assertVerificationCapabilityIsAvailable();
-  return await crypto.subtle.verify("Ed25519", key, signature, data);
+  return await crypto.subtle.verify("Ed25519", key, signature2, data);
 }
 
-export { generateKeyPair, signBytes, verifySignature };
+export { assertIsSignature, 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/key-pair.ts","../src/signatures.ts"],"names":[],"mappings":";AAAA,SAAS,sCAAsC;AAE/C,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;;;ACVA,SAAS,oCAAoC,+CAA+C;AAI5F,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":["import { assertKeyGenerationIsAvailable } from '@solana/assertions';\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 { assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';\n\nexport type Ed25519Signature = Uint8Array & { readonly __brand: 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"]}
+{"version":3,"sources":["../src/key-pair.ts","../src/private-key.ts","../src/signatures.ts"],"names":["signature"],"mappings":";AAAA,SAAS,sCAAsC;AAE/C,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;;;ACVA,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;;;AC5CA,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';\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","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.development.js

@@ -33,8 +33,9 @@ this.globalThis.solanaWeb3 = (function (exports) {
     }
   }
   async function assertKeyGenerationIsAvailable() {
+    var _a;
     assertIsSecureContext();
-    if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.generateKey !== "function") {
+    if (typeof globalThis.crypto === "undefined" || typeof ((_a = globalThis.crypto.subtle) == null ? void 0 : _a.generateKey) !== "function") {
       throw new Error("No key generation implementation could be found");
     }
     if (!await isEd25519CurveSupported(globalThis.crypto.subtle)) {
@@ -44,14 +45,16 @@ this.globalThis.solanaWeb3 = (function (exports) {
     }
   }
   async function assertSigningCapabilityIsAvailable() {
+    var _a;
     assertIsSecureContext();
-    if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.sign !== "function") {
+    if (typeof globalThis.crypto === "undefined" || typeof ((_a = globalThis.crypto.subtle) == null ? void 0 : _a.sign) !== "function") {
       throw new Error("No signing implementation could be found");
     }
   }
   async function assertVerificationCapabilityIsAvailable() {
+    var _a;
     assertIsSecureContext();
-    if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.verify !== "function") {
+    if (typeof globalThis.crypto === "undefined" || typeof ((_a = globalThis.crypto.subtle) == null ? void 0 : _a.verify) !== "function") {
       throw new Error("No signature verification implementation could be found");
     }
   }
@@ -72,19 +75,184 @@ this.globalThis.solanaWeb3 = (function (exports) {
     return keyPair;
   }
 
+  // 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 != null ? extractable : false, ["sign"]);
+  }
+
+  // ../codecs-core/dist/index.browser.js
+  function getEncodedSize(value, encoder) {
+    return "fixedSize" in encoder ? encoder.fixedSize : encoder.getSizeFromValue(value);
+  }
+  function createEncoder(encoder) {
+    return Object.freeze({
+      ...encoder,
+      encode: (value) => {
+        const bytes = new Uint8Array(getEncodedSize(value, encoder));
+        encoder.write(value, bytes, 0);
+        return bytes;
+      }
+    });
+  }
+
+  // ../codecs-strings/dist/index.browser.js
+  function assertValidBaseString(alphabet4, testValue, givenValue = testValue) {
+    if (!testValue.match(new RegExp(`^[${alphabet4}]*$`))) {
+      throw new Error(`Expected a string of base ${alphabet4.length}, got [${givenValue}].`);
+    }
+  }
+  var getBaseXEncoder = (alphabet4) => {
+    return createEncoder({
+      getSizeFromValue: (value) => {
+        const [leadingZeroes, tailChars] = partitionLeadingZeroes(value, alphabet4[0]);
+        if (tailChars === "")
+          return value.length;
+        const base10Number = getBigIntFromBaseX(tailChars, alphabet4);
+        return leadingZeroes.length + Math.ceil(base10Number.toString(16).length / 2);
+      },
+      write(value, bytes, offset) {
+        assertValidBaseString(alphabet4, value);
+        if (value === "")
+          return offset;
+        const [leadingZeroes, tailChars] = partitionLeadingZeroes(value, alphabet4[0]);
+        if (tailChars === "") {
+          bytes.set(new Uint8Array(leadingZeroes.length).fill(0), offset);
+          return offset + leadingZeroes.length;
+        }
+        let base10Number = getBigIntFromBaseX(tailChars, alphabet4);
+        const tailBytes = [];
+        while (base10Number > 0n) {
+          tailBytes.unshift(Number(base10Number % 256n));
+          base10Number /= 256n;
+        }
+        const bytesToAdd = [...Array(leadingZeroes.length).fill(0), ...tailBytes];
+        bytes.set(bytesToAdd, offset);
+        return offset + bytesToAdd.length;
+      }
+    });
+  };
+  function partitionLeadingZeroes(value, zeroCharacter) {
+    const leadingZeroIndex = [...value].findIndex((c) => c !== zeroCharacter);
+    return leadingZeroIndex === -1 ? [value, ""] : [value.slice(0, leadingZeroIndex), value.slice(leadingZeroIndex)];
+  }
+  function getBigIntFromBaseX(value, alphabet4) {
+    const base = BigInt(alphabet4.length);
+    return [...value].reduce((sum, char) => sum * base + BigInt(alphabet4.indexOf(char)), 0n);
+  }
+  var alphabet2 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+  var getBase58Encoder = () => getBaseXEncoder(alphabet2);
+
   // src/signatures.ts
+  var base58Encoder;
+  function assertIsSignature(putativeSignature) {
+    if (!base58Encoder)
+      base58Encoder = getBase58Encoder();
+    try {
+      if (
+        // 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 64.");
+      }
+      const bytes = base58Encoder.encode(putativeSignature);
+      const numBytes = bytes.byteLength;
+      if (numBytes !== 64) {
+        throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
+      }
+    } catch (e2) {
+      throw new Error(`\`${putativeSignature}\` is not a signature`, {
+        cause: e2
+      });
+    }
+  }
+  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);
   }
-  async function verifySignature(key, signature, data) {
+  function signature(putativeSignature) {
+    assertIsSignature(putativeSignature);
+    return putativeSignature;
+  }
+  async function verifySignature(key, signature2, data) {
     await assertVerificationCapabilityIsAvailable();
-    return await crypto.subtle.verify("Ed25519", key, signature, data);
+    return await crypto.subtle.verify("Ed25519", key, signature2, data);
   }
 
+  exports.assertIsSignature = assertIsSignature;
+  exports.createPrivateKeyFromBytes = createPrivateKeyFromBytes;
   exports.generateKeyPair = generateKeyPair;
+  exports.isSignature = isSignature;
   exports.signBytes = signBytes;
+  exports.signature = signature;
   exports.verifySignature = verifySignature;
 
   return exports;