@solana/keys 2.0.0-experimental.71b920d → 2.0.0-experimental.71dcc4e

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2018 Solana Labs, Inc
1
+ Copyright (c) 2023 Solana Labs, Inc
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining
4
4
  a copy of this software and associated documentation files (the
package/README.md CHANGED
@@ -18,13 +18,11 @@ This package contains utilities for validating, generating, and manipulating add
18
18
 
19
19
  ## Types
20
20
 
21
- ### `Base58EncodedAddress`
21
+ ### `Signature`
22
22
 
23
- 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.
23
+ This type represents a 64-byte Ed25519 signature of some data with a private key, as a base58-encoded string.
24
24
 
25
- Whenever you need to validate an arbitrary string as a base58-encoded address, use the `assertIsBase58EncodedAddress()` function in this package.
26
-
27
- ### `Ed25519Signature`
25
+ ### `SignatureBytes`
28
26
 
29
27
  This type represents a 64-byte Ed25519 signature of some data with a private key.
30
28
 
@@ -32,27 +30,27 @@ Whenever you need to verify that a particular signature is, in fact, the one tha
32
30
 
33
31
  ## Functions
34
32
 
35
- ### `assertIsBase58EncodedAddress()`
36
-
37
- 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.
33
+ ### `assertIsSignature()`
38
34
 
39
- 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.
35
+ 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.
40
36
 
41
37
  ```ts
42
- import { assertIsBase58EncodedAddress } from '@solana/keys';
38
+ import { assertIsSignature } from '@solana/keys';
43
39
 
44
- // Imagine a function that fetches an account's balance when a user submits a form.
40
+ // Imagine a function that asserts whether a user-supplied signature is valid or not.
45
41
  function handleSubmit() {
46
42
  // We know only that what the user typed conforms to the `string` type.
47
- const address: string = accountAddressInput.value;
43
+ const signature: string = signatureInput.value;
48
44
  try {
49
45
  // If this type assertion function doesn't throw, then
50
- // Typescript will upcast `address` to `Base58EncodedAddress`.
51
- assertIsBase58EncodedAddress(address);
52
- // At this point, `address` is a `Base58EncodedAddress` that can be used with the RPC.
53
- const balanceInLamports = await rpc.getBalance(address).send();
46
+ // Typescript will upcast `signature` to `Signature`.
47
+ assertIsSignature(signature);
48
+ // At this point, `signature` is a `Signature` that can be used with the RPC.
49
+ const {
50
+ value: [status],
51
+ } = await rpc.getSignatureStatuses([signature]).send();
54
52
  } catch (e) {
55
- // `address` turned out not to be a base58-encoded address
53
+ // `signature` turned out not to be a base58-encoded signature
56
54
  }
57
55
  }
58
56
  ```
@@ -67,14 +65,23 @@ import { generateKeyPair } from '@solana/keys';
67
65
  const { privateKey, publicKey } = await generateKeyPair();
68
66
  ```
69
67
 
70
- ### `getBase58EncodedAddressFromPublicKey()`
68
+ ### `isSignature()`
71
69
 
72
- Given a public `CryptoKey`, this method will return its associated `Base58EncodedAddress`.
70
+ 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.
73
71
 
74
72
  ```ts
75
- import { getBase58EncodedAddressFromPublicKey } from '@solana/keys';
76
-
77
- const address = await getBase58EncodedAddressFromPublicKey(publicKey);
73
+ import { isSignature } from '@solana/keys';
74
+
75
+ if (isSignature(signature)) {
76
+ // At this point, `signature` has been refined to a
77
+ // `Signature` that can be used with the RPC.
78
+ const {
79
+ value: [status],
80
+ } = await rpc.getSignatureStatuses([signature]).send();
81
+ setSignatureStatus(status);
82
+ } else {
83
+ setError(`${signature} is not a transaction signature`);
84
+ }
78
85
  ```
79
86
 
80
87
  ### `signBytes()`
@@ -88,9 +95,22 @@ const data = new Uint8Array([1, 2, 3]);
88
95
  const signature = await signBytes(privateKey, data);
89
96
  ```
90
97
 
98
+ ### `signature()`
99
+
100
+ 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.
101
+
102
+ ```ts
103
+ import { signature } from '@solana/keys';
104
+
105
+ const signature = signature(userSuppliedSignature);
106
+ const {
107
+ value: [status],
108
+ } = await rpc.getSignatureStatuses([signature]).send();
109
+ ```
110
+
91
111
  ### `verifySignature()`
92
112
 
93
- 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.
113
+ 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.
94
114
 
95
115
  ```ts
96
116
  import { verifySignature } from '@solana/keys';
@@ -1,110 +1,11 @@
1
1
  'use strict';
2
2
 
3
- var umiSerializers = require('@metaplex-foundation/umi-serializers');
4
-
5
- // ../build-scripts/env-shim.ts
6
- var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
7
- function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
8
- try {
9
- if (
10
- // Lowest address (32 bytes of zeroes)
11
- putativeBase58EncodedAddress.length < 32 || // Highest address (32 bytes of 255)
12
- putativeBase58EncodedAddress.length > 44
13
- ) {
14
- throw new Error("Expected input string to decode to a byte array of length 32.");
15
- }
16
- const bytes = umiSerializers.base58.serialize(putativeBase58EncodedAddress);
17
- const numBytes = bytes.byteLength;
18
- if (numBytes !== 32) {
19
- throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);
20
- }
21
- } catch (e) {
22
- throw new Error(`\`${putativeBase58EncodedAddress}\` is not a base-58 encoded address`, {
23
- cause: e
24
- });
25
- }
26
- }
27
- function getBase58EncodedAddressCodec(config) {
28
- return umiSerializers.string({
29
- description: config?.description ?? (__DEV__ ? "A 32-byte account address" : ""),
30
- encoding: umiSerializers.base58,
31
- size: 32
32
- });
33
- }
34
- function getBase58EncodedAddressComparator() {
35
- return new Intl.Collator("en", {
36
- caseFirst: "lower",
37
- ignorePunctuation: false,
38
- localeMatcher: "best fit",
39
- numeric: false,
40
- sensitivity: "variant",
41
- usage: "sort"
42
- }).compare;
43
- }
44
-
45
- // src/guard.ts
46
- function assertIsSecureContext() {
47
- if (!globalThis.isSecureContext) {
48
- throw new Error(
49
- "Cryptographic operations are only allowed in secure browser contexts. Read more here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts"
50
- );
51
- }
52
- }
53
- var cachedEd25519Decision;
54
- async function isEd25519CurveSupported(subtle) {
55
- if (cachedEd25519Decision === void 0) {
56
- cachedEd25519Decision = new Promise((resolve) => {
57
- subtle.generateKey(
58
- "Ed25519",
59
- /* extractable */
60
- false,
61
- ["sign", "verify"]
62
- ).catch(() => {
63
- resolve(cachedEd25519Decision = false);
64
- }).then(() => {
65
- resolve(cachedEd25519Decision = true);
66
- });
67
- });
68
- }
69
- if (typeof cachedEd25519Decision === "boolean") {
70
- return cachedEd25519Decision;
71
- } else {
72
- return await cachedEd25519Decision;
73
- }
74
- }
75
- async function assertKeyGenerationIsAvailable() {
76
- assertIsSecureContext();
77
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.generateKey !== "function") {
78
- throw new Error("No key generation implementation could be found");
79
- }
80
- if (!await isEd25519CurveSupported(globalThis.crypto.subtle)) {
81
- throw new Error(
82
- "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"
83
- );
84
- }
85
- }
86
- async function assertKeyExporterIsAvailable() {
87
- assertIsSecureContext();
88
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.exportKey !== "function") {
89
- throw new Error("No key export implementation could be found");
90
- }
91
- }
92
- async function assertSigningCapabilityIsAvailable() {
93
- assertIsSecureContext();
94
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.sign !== "function") {
95
- throw new Error("No signing implementation could be found");
96
- }
97
- }
98
- async function assertVerificationCapabilityIsAvailable() {
99
- assertIsSecureContext();
100
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.verify !== "function") {
101
- throw new Error("No signature verification implementation could be found");
102
- }
103
- }
3
+ var assertions = require('@solana/assertions');
4
+ var codecsStrings = require('@solana/codecs-strings');
104
5
 
105
6
  // src/key-pair.ts
106
7
  async function generateKeyPair() {
107
- await assertKeyGenerationIsAvailable();
8
+ await assertions.assertKeyGenerationIsAvailable();
108
9
  const keyPair = await crypto.subtle.generateKey(
109
10
  /* algorithm */
110
11
  "Ed25519",
@@ -118,34 +19,120 @@ async function generateKeyPair() {
118
19
  return keyPair;
119
20
  }
120
21
 
121
- // src/pubkey.ts
122
- async function getBase58EncodedAddressFromPublicKey(publicKey) {
123
- await assertKeyExporterIsAvailable();
124
- if (publicKey.type !== "public" || publicKey.algorithm.name !== "Ed25519") {
125
- throw new Error("The `CryptoKey` must be an `Ed25519` public key");
22
+ // src/private-key.ts
23
+ function addPkcs8Header(bytes) {
24
+ return new Uint8Array([
25
+ /**
26
+ * PKCS#8 header
27
+ */
28
+ 48,
29
+ // ASN.1 sequence tag
30
+ 46,
31
+ // Length of sequence (46 more bytes)
32
+ 2,
33
+ // ASN.1 integer tag
34
+ 1,
35
+ // Length of integer
36
+ 0,
37
+ // Version number
38
+ 48,
39
+ // ASN.1 sequence tag
40
+ 5,
41
+ // Length of sequence
42
+ 6,
43
+ // ASN.1 object identifier tag
44
+ 3,
45
+ // Length of object identifier
46
+ // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112
47
+ 43,
48
+ // 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)
49
+ 101,
50
+ // thawte(101)
51
+ // Ed25519 identifier
52
+ 112,
53
+ // id-Ed25519(112)
54
+ /**
55
+ * Private key payload
56
+ */
57
+ 4,
58
+ // ASN.1 octet string tag
59
+ 34,
60
+ // String length (34 more bytes)
61
+ // Private key bytes as octet string
62
+ 4,
63
+ // ASN.1 octet string tag
64
+ 32,
65
+ // String length (32 bytes)
66
+ ...bytes
67
+ ]);
68
+ }
69
+ async function createPrivateKeyFromBytes(bytes, extractable) {
70
+ if (bytes.byteLength !== 32) {
71
+ throw new Error("Private key bytes must be of length 32");
126
72
  }
127
- const publicKeyBytes = await crypto.subtle.exportKey("raw", publicKey);
128
- const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));
129
- return base58EncodedAddress;
73
+ const privateKeyBytesPkcs8 = addPkcs8Header(bytes);
74
+ return await crypto.subtle.importKey("pkcs8", privateKeyBytesPkcs8, "Ed25519", extractable ?? false, ["sign"]);
75
+ }
76
+ var base58Encoder;
77
+ function assertIsSignature(putativeSignature) {
78
+ if (!base58Encoder)
79
+ base58Encoder = codecsStrings.getBase58Encoder();
80
+ try {
81
+ if (
82
+ // Lowest value (64 bytes of zeroes)
83
+ putativeSignature.length < 64 || // Highest value (64 bytes of 255)
84
+ putativeSignature.length > 88
85
+ ) {
86
+ throw new Error("Expected input string to decode to a byte array of length 64.");
87
+ }
88
+ const bytes = base58Encoder.encode(putativeSignature);
89
+ const numBytes = bytes.byteLength;
90
+ if (numBytes !== 64) {
91
+ throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
92
+ }
93
+ } catch (e) {
94
+ throw new Error(`\`${putativeSignature}\` is not a signature`, {
95
+ cause: e
96
+ });
97
+ }
98
+ }
99
+ function isSignature(putativeSignature) {
100
+ if (!base58Encoder)
101
+ base58Encoder = codecsStrings.getBase58Encoder();
102
+ if (
103
+ // Lowest value (64 bytes of zeroes)
104
+ putativeSignature.length < 64 || // Highest value (64 bytes of 255)
105
+ putativeSignature.length > 88
106
+ ) {
107
+ return false;
108
+ }
109
+ const bytes = base58Encoder.encode(putativeSignature);
110
+ const numBytes = bytes.byteLength;
111
+ if (numBytes !== 64) {
112
+ return false;
113
+ }
114
+ return true;
130
115
  }
131
-
132
- // src/signatures.ts
133
116
  async function signBytes(key, data) {
134
- await assertSigningCapabilityIsAvailable();
117
+ await assertions.assertSigningCapabilityIsAvailable();
135
118
  const signedData = await crypto.subtle.sign("Ed25519", key, data);
136
119
  return new Uint8Array(signedData);
137
120
  }
138
- async function verifySignature(key, signature, data) {
139
- await assertVerificationCapabilityIsAvailable();
140
- return await crypto.subtle.verify("Ed25519", key, signature, data);
121
+ function signature(putativeSignature) {
122
+ assertIsSignature(putativeSignature);
123
+ return putativeSignature;
124
+ }
125
+ async function verifySignature(key, signature2, data) {
126
+ await assertions.assertVerificationCapabilityIsAvailable();
127
+ return await crypto.subtle.verify("Ed25519", key, signature2, data);
141
128
  }
142
129
 
143
- exports.assertIsBase58EncodedAddress = assertIsBase58EncodedAddress;
130
+ exports.assertIsSignature = assertIsSignature;
131
+ exports.createPrivateKeyFromBytes = createPrivateKeyFromBytes;
144
132
  exports.generateKeyPair = generateKeyPair;
145
- exports.getBase58EncodedAddressCodec = getBase58EncodedAddressCodec;
146
- exports.getBase58EncodedAddressComparator = getBase58EncodedAddressComparator;
147
- exports.getBase58EncodedAddressFromPublicKey = getBase58EncodedAddressFromPublicKey;
133
+ exports.isSignature = isSignature;
148
134
  exports.signBytes = signBytes;
135
+ exports.signature = signature;
149
136
  exports.verifySignature = verifySignature;
150
137
  //# sourceMappingURL=out.js.map
151
138
  //# sourceMappingURL=index.browser.cjs.map
@@ -1 +1 @@
1
- {"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"]}
1
+ {"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"]}
@@ -1,104 +1,5 @@
1
- import { base58, string } from '@metaplex-foundation/umi-serializers';
2
-
3
- // ../build-scripts/env-shim.ts
4
- var __DEV__ = /* @__PURE__ */ (() => process["env"].NODE_ENV === "development")();
5
- function assertIsBase58EncodedAddress(putativeBase58EncodedAddress) {
6
- try {
7
- if (
8
- // Lowest address (32 bytes of zeroes)
9
- putativeBase58EncodedAddress.length < 32 || // Highest address (32 bytes of 255)
10
- putativeBase58EncodedAddress.length > 44
11
- ) {
12
- throw new Error("Expected input string to decode to a byte array of length 32.");
13
- }
14
- const bytes = base58.serialize(putativeBase58EncodedAddress);
15
- const numBytes = bytes.byteLength;
16
- if (numBytes !== 32) {
17
- throw new Error(`Expected input string to decode to a byte array of length 32. Actual length: ${numBytes}`);
18
- }
19
- } catch (e) {
20
- throw new Error(`\`${putativeBase58EncodedAddress}\` is not a base-58 encoded address`, {
21
- cause: e
22
- });
23
- }
24
- }
25
- function getBase58EncodedAddressCodec(config) {
26
- return string({
27
- description: config?.description ?? (__DEV__ ? "A 32-byte account address" : ""),
28
- encoding: base58,
29
- size: 32
30
- });
31
- }
32
- function getBase58EncodedAddressComparator() {
33
- return new Intl.Collator("en", {
34
- caseFirst: "lower",
35
- ignorePunctuation: false,
36
- localeMatcher: "best fit",
37
- numeric: false,
38
- sensitivity: "variant",
39
- usage: "sort"
40
- }).compare;
41
- }
42
-
43
- // src/guard.ts
44
- function assertIsSecureContext() {
45
- if (!globalThis.isSecureContext) {
46
- throw new Error(
47
- "Cryptographic operations are only allowed in secure browser contexts. Read more here: https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts"
48
- );
49
- }
50
- }
51
- var cachedEd25519Decision;
52
- async function isEd25519CurveSupported(subtle) {
53
- if (cachedEd25519Decision === void 0) {
54
- cachedEd25519Decision = new Promise((resolve) => {
55
- subtle.generateKey(
56
- "Ed25519",
57
- /* extractable */
58
- false,
59
- ["sign", "verify"]
60
- ).catch(() => {
61
- resolve(cachedEd25519Decision = false);
62
- }).then(() => {
63
- resolve(cachedEd25519Decision = true);
64
- });
65
- });
66
- }
67
- if (typeof cachedEd25519Decision === "boolean") {
68
- return cachedEd25519Decision;
69
- } else {
70
- return await cachedEd25519Decision;
71
- }
72
- }
73
- async function assertKeyGenerationIsAvailable() {
74
- assertIsSecureContext();
75
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.generateKey !== "function") {
76
- throw new Error("No key generation implementation could be found");
77
- }
78
- if (!await isEd25519CurveSupported(globalThis.crypto.subtle)) {
79
- throw new Error(
80
- "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"
81
- );
82
- }
83
- }
84
- async function assertKeyExporterIsAvailable() {
85
- assertIsSecureContext();
86
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.exportKey !== "function") {
87
- throw new Error("No key export implementation could be found");
88
- }
89
- }
90
- async function assertSigningCapabilityIsAvailable() {
91
- assertIsSecureContext();
92
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.sign !== "function") {
93
- throw new Error("No signing implementation could be found");
94
- }
95
- }
96
- async function assertVerificationCapabilityIsAvailable() {
97
- assertIsSecureContext();
98
- if (typeof globalThis.crypto === "undefined" || typeof globalThis.crypto.subtle?.verify !== "function") {
99
- throw new Error("No signature verification implementation could be found");
100
- }
101
- }
1
+ import { assertKeyGenerationIsAvailable, assertSigningCapabilityIsAvailable, assertVerificationCapabilityIsAvailable } from '@solana/assertions';
2
+ import { getBase58Encoder } from '@solana/codecs-strings';
102
3
 
103
4
  // src/key-pair.ts
104
5
  async function generateKeyPair() {
@@ -116,28 +17,114 @@ async function generateKeyPair() {
116
17
  return keyPair;
117
18
  }
118
19
 
119
- // src/pubkey.ts
120
- async function getBase58EncodedAddressFromPublicKey(publicKey) {
121
- await assertKeyExporterIsAvailable();
122
- if (publicKey.type !== "public" || publicKey.algorithm.name !== "Ed25519") {
123
- throw new Error("The `CryptoKey` must be an `Ed25519` public key");
20
+ // src/private-key.ts
21
+ function addPkcs8Header(bytes) {
22
+ return new Uint8Array([
23
+ /**
24
+ * PKCS#8 header
25
+ */
26
+ 48,
27
+ // ASN.1 sequence tag
28
+ 46,
29
+ // Length of sequence (46 more bytes)
30
+ 2,
31
+ // ASN.1 integer tag
32
+ 1,
33
+ // Length of integer
34
+ 0,
35
+ // Version number
36
+ 48,
37
+ // ASN.1 sequence tag
38
+ 5,
39
+ // Length of sequence
40
+ 6,
41
+ // ASN.1 object identifier tag
42
+ 3,
43
+ // Length of object identifier
44
+ // Edwards curve algorithms identifier https://oid-rep.orange-labs.fr/get/1.3.101.112
45
+ 43,
46
+ // 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)
47
+ 101,
48
+ // thawte(101)
49
+ // Ed25519 identifier
50
+ 112,
51
+ // id-Ed25519(112)
52
+ /**
53
+ * Private key payload
54
+ */
55
+ 4,
56
+ // ASN.1 octet string tag
57
+ 34,
58
+ // String length (34 more bytes)
59
+ // Private key bytes as octet string
60
+ 4,
61
+ // ASN.1 octet string tag
62
+ 32,
63
+ // String length (32 bytes)
64
+ ...bytes
65
+ ]);
66
+ }
67
+ async function createPrivateKeyFromBytes(bytes, extractable) {
68
+ if (bytes.byteLength !== 32) {
69
+ throw new Error("Private key bytes must be of length 32");
124
70
  }
125
- const publicKeyBytes = await crypto.subtle.exportKey("raw", publicKey);
126
- const [base58EncodedAddress] = getBase58EncodedAddressCodec().deserialize(new Uint8Array(publicKeyBytes));
127
- return base58EncodedAddress;
71
+ const privateKeyBytesPkcs8 = addPkcs8Header(bytes);
72
+ return await crypto.subtle.importKey("pkcs8", privateKeyBytesPkcs8, "Ed25519", extractable ?? false, ["sign"]);
73
+ }
74
+ var base58Encoder;
75
+ function assertIsSignature(putativeSignature) {
76
+ if (!base58Encoder)
77
+ base58Encoder = getBase58Encoder();
78
+ try {
79
+ if (
80
+ // Lowest value (64 bytes of zeroes)
81
+ putativeSignature.length < 64 || // Highest value (64 bytes of 255)
82
+ putativeSignature.length > 88
83
+ ) {
84
+ throw new Error("Expected input string to decode to a byte array of length 64.");
85
+ }
86
+ const bytes = base58Encoder.encode(putativeSignature);
87
+ const numBytes = bytes.byteLength;
88
+ if (numBytes !== 64) {
89
+ throw new Error(`Expected input string to decode to a byte array of length 64. Actual length: ${numBytes}`);
90
+ }
91
+ } catch (e) {
92
+ throw new Error(`\`${putativeSignature}\` is not a signature`, {
93
+ cause: e
94
+ });
95
+ }
96
+ }
97
+ function isSignature(putativeSignature) {
98
+ if (!base58Encoder)
99
+ base58Encoder = getBase58Encoder();
100
+ if (
101
+ // Lowest value (64 bytes of zeroes)
102
+ putativeSignature.length < 64 || // Highest value (64 bytes of 255)
103
+ putativeSignature.length > 88
104
+ ) {
105
+ return false;
106
+ }
107
+ const bytes = base58Encoder.encode(putativeSignature);
108
+ const numBytes = bytes.byteLength;
109
+ if (numBytes !== 64) {
110
+ return false;
111
+ }
112
+ return true;
128
113
  }
129
-
130
- // src/signatures.ts
131
114
  async function signBytes(key, data) {
132
115
  await assertSigningCapabilityIsAvailable();
133
116
  const signedData = await crypto.subtle.sign("Ed25519", key, data);
134
117
  return new Uint8Array(signedData);
135
118
  }
136
- async function verifySignature(key, signature, data) {
119
+ function signature(putativeSignature) {
120
+ assertIsSignature(putativeSignature);
121
+ return putativeSignature;
122
+ }
123
+ async function verifySignature(key, signature2, data) {
137
124
  await assertVerificationCapabilityIsAvailable();
138
- return await crypto.subtle.verify("Ed25519", key, signature, data);
125
+ return await crypto.subtle.verify("Ed25519", key, signature2, data);
139
126
  }
140
127
 
141
- export { assertIsBase58EncodedAddress, generateKeyPair, getBase58EncodedAddressCodec, getBase58EncodedAddressComparator, getBase58EncodedAddressFromPublicKey, signBytes, verifySignature };
128
+ export { assertIsSignature, createPrivateKeyFromBytes, generateKeyPair, isSignature, signBytes, signature, verifySignature };
142
129
  //# sourceMappingURL=out.js.map
143
130
  //# sourceMappingURL=index.browser.js.map