@mysten/docs 0.1.75 → 0.1.77

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.
@@ -106,7 +106,7 @@
106
106
  - [Commands and Inputs Reference](./sui/transactions/reference.md): Complete reference for transaction commands and input types
107
107
  - [Building Offline](./sui/transactions/offline.md): Build transactions without a network connection
108
108
  - [Cryptography](./sui/cryptography.md): >- Sign and verify Sui transactions and messages with keypairs and external signers
109
- - [Key pairs](./sui/cryptography/keypairs.md): >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
109
+ - [Key pairs](./sui/cryptography/keypairs.md): >- Create Ed25519, Secp256k1, Secp256r1, and ML-DSA-65 keypairs and derive them from mnemonics and secret keys
110
110
  - [Signers](./sui/cryptography/signers.md): >- Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
111
111
  - [AWS KMS Signer](./sui/cryptography/signers/aws-kms.md): Sign Sui transactions with a key stored in AWS Key Management Service
112
112
  - [GCP KMS Signer](./sui/cryptography/signers/gcp-kms.md): Sign Sui transactions with a key stored in Google Cloud Key Management Service
@@ -110,4 +110,10 @@ Two further options change how the node runs the simulation:
110
110
  | Option | Effect |
111
111
  | ---------------- | ---------------------------------------------------------------------------------------------------------------------- |
112
112
  | `checksEnabled` | Set `false` to skip transaction validation, so non-public and non-entry functions can be inspected. Defaults to `true` |
113
- | `doGasSelection` | Overrides whether the server selects gas payment during the simulation |
113
+ | `doGasSelection` | gRPC and GraphQL only. Overrides whether the node selects real gas. Defaults to `true` only when gas payment is `[]` |
114
+
115
+ A transaction with no gas payment is simulated with a mocked gas coin, which also funds anything
116
+ drawn from `tx.gas`, so the result validates the transaction and estimates gas but is not a preview
117
+ of what the sender would spend. To simulate with the sender's real gas, set gas coins on the
118
+ transaction, or on gRPC and GraphQL set an empty gas payment and let the node select gas. The
119
+ result's `gasPaymentMocked` field reports which case ran.
@@ -11,13 +11,14 @@ implementation in detail.
11
11
  ## Signing schemes
12
12
 
13
13
  A signer always produces a signature under a signature scheme, which determines the curve and
14
- signature format. Sui supports three schemes, each with a corresponding `Keypair` class:
14
+ signature format. Sui supports four schemes, each with a corresponding `Keypair` class:
15
15
 
16
16
  | Scheme | Class | Import |
17
17
  | --------------- | ------------------ | -------------------------------- |
18
18
  | Ed25519 | `Ed25519Keypair` | `@mysten/sui/keypairs/ed25519` |
19
19
  | ECDSA Secp256k1 | `Secp256k1Keypair` | `@mysten/sui/keypairs/secp256k1` |
20
20
  | ECDSA Secp256r1 | `Secp256r1Keypair` | `@mysten/sui/keypairs/secp256r1` |
21
+ | ML-DSA-65 | `MLDSA65Keypair` | `@mysten/sui/keypairs/mldsa65` |
21
22
 
22
23
  For background on the schemes themselves, see the
23
24
  [Signatures](https://docs.sui.io/concepts/cryptography/transaction-auth/signatures) concept topic. A
@@ -31,11 +32,11 @@ so the rest of your code doesn't need to know where the key lives.
31
32
 
32
33
  Implementations provide three primitives:
33
34
 
34
- | Method | Description |
35
- | ---------------- | ------------------------------------------------------------------ |
36
- | `getPublicKey()` | Returns the `PublicKey` for deriving the address and verifying |
37
- | `getKeyScheme()` | Returns the signature scheme (`ED25519`, `Secp256k1`, `Secp256r1`) |
38
- | `sign(bytes)` | Signs raw bytes and returns the signature |
35
+ | Method | Description |
36
+ | ---------------- | ----------------------------------------------------------------------------- |
37
+ | `getPublicKey()` | Returns the `PublicKey` for deriving the address and verifying |
38
+ | `getKeyScheme()` | Returns the signature scheme (`ED25519`, `Secp256k1`, `Secp256r1`, `MLDSA65`) |
39
+ | `sign(bytes)` | Signs raw bytes and returns the signature |
39
40
 
40
41
  On top of those, `Signer` provides the methods you typically call:
41
42
 
@@ -1,6 +1,6 @@
1
1
  # Key pairs
2
2
 
3
- > >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
3
+ > >- Create Ed25519, Secp256k1, Secp256r1, and ML-DSA-65 keypairs and derive them from mnemonics and secret keys
4
4
 
5
5
  A `Keypair` holds a Sui private key in process and signs with it. It is the easiest
6
6
  [`Signer`](/sui/cryptography) to use. It is ideal for scripts, backends, and tests where you manage
@@ -15,6 +15,7 @@ Each signing scheme has a corresponding `Keypair` class:
15
15
  | Ed25519 | `Ed25519Keypair` | `@mysten/sui/keypairs/ed25519` |
16
16
  | ECDSA Secp256k1 | `Secp256k1Keypair` | `@mysten/sui/keypairs/secp256k1` |
17
17
  | ECDSA Secp256r1 | `Secp256r1Keypair` | `@mysten/sui/keypairs/secp256r1` |
18
+ | ML-DSA-65 | `MLDSA65Keypair` | `@mysten/sui/keypairs/mldsa65` |
18
19
 
19
20
  To use, import the key pair class your project uses from the `@mysten/sui/keypairs` folder. For
20
21
  example, to use the Ed25519 scheme, import the `Ed25519Keypair` class from
@@ -24,6 +25,17 @@ example, to use the Ed25519 scheme, import the `Ed25519Keypair` class from
24
25
 
25
26
  ```
26
27
 
28
+ ML-DSA-65 is the post-quantum scheme from FIPS 204. Its secret key is a 32-byte seed, so it imports
29
+ and exports like the other schemes, but its public keys (1952 bytes) and signatures (3309 bytes) are
30
+ much larger, and every signature is randomized. Deriving an ML-DSA-65 keypair from a mnemonic is not
31
+ supported yet, and the scheme is only accepted by networks where it has been enabled.
32
+
33
+ ```typescript
34
+
35
+ const keypair = MLDSA65Keypair.generate();
36
+ const restored = MLDSA65Keypair.fromSecretKey(keypair.getSecretKey());
37
+ ```
38
+
27
39
  ## Creating a key pair
28
40
 
29
41
  To create a random key pair (which identifies a Sui address), instantiate a new `Keypair` class. To
@@ -16,7 +16,7 @@
16
16
  - [Commands and Inputs Reference](./transactions/reference.md): Complete reference for transaction commands and input types
17
17
  - [Building Offline](./transactions/offline.md): Build transactions without a network connection
18
18
  - [Cryptography](./cryptography.md): >- Sign and verify Sui transactions and messages with keypairs and external signers
19
- - [Key pairs](./cryptography/keypairs.md): >- Create Ed25519, Secp256k1, and Secp256r1 keypairs and derive them from mnemonics and secret keys
19
+ - [Key pairs](./cryptography/keypairs.md): >- Create Ed25519, Secp256k1, Secp256r1, and ML-DSA-65 keypairs and derive them from mnemonics and secret keys
20
20
  - [Signers](./cryptography/signers.md): >- Signer implementations beyond keypairs — cloud KMS, Ledger, Web Crypto, passkeys, and multisig
21
21
  - [AWS KMS Signer](./cryptography/signers/aws-kms.md): Sign Sui transactions with a key stored in AWS Key Management Service
22
22
  - [GCP KMS Signer](./cryptography/signers/gcp-kms.md): Sign Sui transactions with a key stored in Google Cloud Key Management Service
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mysten/docs",
3
- "version": "0.1.75",
3
+ "version": "0.1.77",
4
4
  "description": "LLM-friendly documentation for the Sui TypeScript SDK ecosystem",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -28,27 +28,27 @@
28
28
  "next": "^16.3.6",
29
29
  "react": "^19.2.8",
30
30
  "react-dom": "^19.2.8",
31
+ "@mysten/aws-kms-signer": "0.3.31",
32
+ "@mysten/dapp-kit-core": "1.6.38",
33
+ "@mysten/dapp-kit-react": "2.1.40",
34
+ "@mysten/deepbook-v3": "2.7.0",
31
35
  "@mysten/bcs": "2.1.2",
32
- "@mysten/dapp-kit-core": "1.6.36",
33
- "@mysten/deepbook-v3": "2.6.7",
34
- "@mysten/enoki": "1.2.30",
35
- "@mysten/aws-kms-signer": "0.3.29",
36
- "@mysten/dapp-kit-react": "2.1.38",
37
- "@mysten/enoki-connect": "1.1.34",
38
- "@mysten/gcp-kms-signer": "0.2.32",
39
- "@mysten/kiosk": "1.4.18",
40
- "@mysten/ledger-signer": "0.2.32",
41
- "@mysten/payment-kit": "0.2.32",
42
- "@mysten/signers": "1.1.32",
43
- "@mysten/seal": "1.4.18",
44
- "@mysten/slush-wallet": "1.3.2",
45
- "@mysten/sui": "2.34.0",
46
- "@mysten/suins": "2.0.14",
47
- "@mysten/wallet-standard": "0.21.32",
36
+ "@mysten/gcp-kms-signer": "0.2.34",
37
+ "@mysten/enoki": "1.3.0",
38
+ "@mysten/enoki-connect": "1.1.36",
39
+ "@mysten/kiosk": "1.4.20",
40
+ "@mysten/ledger-signer": "0.2.34",
41
+ "@mysten/payment-kit": "0.2.34",
42
+ "@mysten/seal": "1.5.0",
43
+ "@mysten/signers": "1.1.34",
44
+ "@mysten/slush-wallet": "1.3.4",
45
+ "@mysten/sui": "2.36.0",
46
+ "@mysten/suins": "2.0.16",
48
47
  "@mysten/utils": "0.4.1",
49
- "@mysten/webcrypto-signer": "0.2.32",
50
- "@mysten/zksend": "1.2.35",
51
- "@mysten/walrus": "1.2.33"
48
+ "@mysten/wallet-standard": "0.21.34",
49
+ "@mysten/walrus": "1.2.35",
50
+ "@mysten/webcrypto-signer": "0.2.34",
51
+ "@mysten/zksend": "1.2.37"
52
52
  },
53
53
  "devDependencies": {
54
54
  "@tailwindcss/postcss": "^4.3.3",