diff --git a/docs/classes/Wallet.html b/docs/classes/Wallet.html index 550cfd97b7..ed7b845c28 100644 --- a/docs/classes/Wallet.html +++ b/docs/classes/Wallet.html @@ -18,7 +18,7 @@

Class Wallet

A wallet can be derived from either a seed, mnemonic, or entropy (array of random numbers). It provides functionality to sign/verify transactions offline.

-

Example

// Derive a wallet from a bip39 Mnemonic
const wallet = Wallet.fromMnemonic(
  'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'
)
console.log(wallet)
// Wallet {
// publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',
// privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',
// classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',
// seed: undefined
// }.

// Derive a wallet from a base58 encoded seed.
const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
console.log(seedWallet)
// Wallet {
// publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
// privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
// classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
// seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
// }.

// Sign a JSON Transaction
 const signed = seedWallet.signTransaction({
     TransactionType: 'Payment',
     Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
     ...........
}).

console.log(signed)
// '1200007321......B01BE1DFF3'.
console.log(decode(signed))
// {
//   TransactionType: 'Payment',
//   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
//   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
//   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
//   ...........
// }
+
Example

// Derive a wallet from a base58 encoded seed.
const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
console.log(seedWallet)
// Wallet {
// publicKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
// privateKey: '00445D0A16DD05EFAF6D5AF45E6B8A6DE4170D93C0627021A0B8E705786CBCCFF7',
// classicAddress: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo',
// seed: 'ssZkdwURFMBXenJPbrpE14b6noJSu'
// }.

// Sign a JSON Transaction
 const signed = seedWallet.signTransaction({
     TransactionType: 'Payment',
     Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
     ...........
}).

console.log(signed)
// '1200007321......B01BE1DFF3'.
console.log(decode(signed))
// {
//   TransactionType: 'Payment',
//   SigningPubKey: '02FE9932A9C4AA2AC9F0ED0F2B89302DE7C2C95F91D782DA3CF06E64E1C1216449',
//   TxnSignature: '3045022100AAD......5B631ABD21171B61B07D304',
//   Account: 'rG88FVLjvYiQaGftSa1cKuE2qNx7aK5ivo'
//   ...........
// }
 

 
 

@@ -26,7 +26,7 @@ 
Hierarchy

 
    
 
  • Wallet

+
  • Defined in packages/xrpl/src/Wallet/index.ts:83
    • 
 
    
 
    
 
    
@@ -96,29 +96,29 @@ 
    Optional seedReturns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:107
    • 
 
    
 
    Properties
    
 
    
 
    Readonly classicAddress
    
 
    classicAddress: string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:86
    • 
 
    
 
    Readonly privateKey
    
 
    privateKey: string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:85
    • 
 
    
 
    Readonly publicKey
    
 
    publicKey: string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:84
    • 
 
    
 
    Optional Readonly seed
    
 
    seed?: string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:87
    • 
 
    
 
    Static fromSecret
    
 
    fromSecret: ((seed: string, opts?: { algorithm?: ECDSA; masterAddress?: string }) => Wallet) = Wallet.fromSeed
    
@@ -155,7 +155,7 @@ 
    Optional masterAddress
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:163
    • 
 
    
 
    Accessors
    
 
    
@@ -169,7 +169,7 @@ 
    Returns
    The wallet's classic address.
    
 
 
    Returns string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:94
    • 
 
    
 
    Methods
    
 
    
@@ -199,7 +199,7 @@ 
    tx: 
 
    Returns void
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:405
    • 
 
    
 
    getXAddress
    
 
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:389
    • 
 
    
 
    sign
    
 
      
@@ -258,7 +258,7 @@ 
      hash: 
 
      tx_blob: string
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:311
    • 
 
    
 
    verifyTransaction
    
 
      
@@ -277,7 +277,7 @@ 
      signedTransaction: string
    
 
    Returns boolean
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:372
    • 
 
    
 
    Static Private deriveWallet
    
 
      
@@ -309,7 +309,7 @@ 
      Optional masterAddress
    
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:287
    • 
 
    
 
    Static fromEntropy
    
 
      
@@ -341,7 +341,7 @@ 
      Optional masterAddress
    
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:174
    • 
 
    
 
    Static fromMnemonic
    
 
      
@@ -349,6 +349,11 @@ 
      Static 
 
      Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).
      
 
+
      Deprecated
      since version 2.6.1.
+Will be deleted in version 3.0.0.
+This representation is currently deprecated in rippled.
+You should use another method to represent your keys such as a seed or public/private keypair.
      
+
 
      Returns
      A Wallet derived from a mnemonic.
      
 
 
      Throws
      ValidationError if unable to derive private key from mnemonic input.
      
@@ -386,7 +391,7 @@ 
      Optional mnemonicEncoding
 
    
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:210
    • 
 
    
 
    Static Private fromRFC1751Mnemonic
    
 
      
@@ -418,7 +423,7 @@ 
      Optional masterAddress
    
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:259
    • 
 
    
 
    Static fromSeed
    
 
      
@@ -450,7 +455,7 @@ 
      Optional masterAddress
    
 
    Returns Wallet
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:143
    • 
 
    
 
    Static generate
    
 
    
+
  • Defined in packages/xrpl/src/Wallet/index.ts:129
    • 
 
    
 
    
 
    
diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md
index 1bf160a6ec..87903cb1c5 100644
--- a/packages/xrpl/HISTORY.md
+++ b/packages/xrpl/HISTORY.md
@@ -10,6 +10,10 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 
 ### Changed
 
+### Deprecated
+Wallet.fromMmnemonic()
+
+
 ## 2.6.0 (2022-11-21)
 
 ### Fixed
diff --git a/packages/xrpl/src/Wallet/index.ts b/packages/xrpl/src/Wallet/index.ts
index 48a6646946..3ec76ecefa 100644
--- a/packages/xrpl/src/Wallet/index.ts
+++ b/packages/xrpl/src/Wallet/index.ts
@@ -48,17 +48,6 @@ function hexFromBuffer(buffer: Buffer): string {
  *
  * @example
  * ```typescript
- * // Derive a wallet from a bip39 Mnemonic
- * const wallet = Wallet.fromMnemonic(
- *   'jewel insect retreat jump claim horse second chef west gossip bone frown exotic embark laundry'
- * )
- * console.log(wallet)
- * // Wallet {
- * // publicKey: '02348F89E9A6A3615BA317F8474A3F51D66221562D3CA32BFA8D21348FF67012B2',
- * // privateKey: '00A8F2E77FC0E05890C1B5088AFE0ECF9D96466A4419B897B1AB383E336E1735A2',
- * // classicAddress: 'rwZiksrExmVkR64pf87Jor4cYbmff47SUm',
- * // seed: undefined
- * // }.
  *
  * // Derive a wallet from a base58 encoded seed.
  * const seedWallet = Wallet.fromSeed('ssZkdwURFMBXenJPbrpE14b6noJSu')
@@ -201,6 +190,11 @@ class Wallet {
   /**
    * Derives a wallet from a bip39 or RFC1751 mnemonic (Defaults to bip39).
    *
+   * @deprecated since version 2.6.1.
+   * Will be deleted in version 3.0.0.
+   * This representation is currently deprecated in rippled.
+   * You should use another method to represent your keys such as a seed or public/private keypair.
+   *
    * @param mnemonic - A string consisting of words (whitespace delimited) used to derive a wallet.
    * @param opts - (Optional) Options to derive a Wallet.
    * @param opts.masterAddress - Include if a Wallet uses a Regular Key Pair. It must be the master address of the account.