feat(examples): add example scripts for address handling and Ethereum derivation

Author: jfrank-summit

examples/address.ts

@@ -0,0 +1,24 @@
+import { address, mockWallets } from '@autonomys/auto-utils'
+
+export const addressFunction = async () => {
+  const [alice, bob] = await mockWallets()
+  // Alice's Addresses
+  console.log('\x1b[33m%s\x1b[0m', 'Alice Raw Address:', alice.accounts[0].address)
+  const aliceAddress = address(alice.accounts[0].address)
+  console.log('\x1b[32m%s\x1b[0m', 'Alice Autonomys (6094) Address:', aliceAddress, '\n')
+
+  // Bob's Addresses
+  console.log('\x1b[33m%s\x1b[0m', 'Bob Raw Address:', bob.accounts[0].address)
+  const bobAddress = address(bob.accounts[0].address)
+  console.log('\x1b[32m%s\x1b[0m', 'Bob Autonomys (6094) Address:', bobAddress, '\n')
+}
+
+addressFunction()
+  .then(() => {
+    console.log('\x1b[34m%s\x1b[0m', 'Script executed successfully')
+    process.exit(0)
+  })
+  .catch((e) => {
+    console.error('\x1b[31m%s\x1b[0m', 'Error with script:', e)
+    process.exit(1)
+  })

examples/eth-derivation-demo.ts

@@ -0,0 +1,44 @@
+import { setupWallet } from '@autonomys/auto-utils'
+import { HDNodeWallet, Mnemonic, Wallet } from 'ethers'
+
+const MNEMONIC = 'test test test test test test test test test test test junk'
+
+const main = async (): Promise<void> => {
+  const master = setupWallet({ mnemonic: MNEMONIC, type: 'ethereum' })
+
+  const bip44Path = "m/44'/60'/0'/0/0"
+  const bip44 = setupWallet({
+    mnemonic: MNEMONIC,
+    type: 'ethereum',
+    derivationPath: bip44Path,
+  })
+
+  const ethersMnemonic = Mnemonic.fromPhrase(MNEMONIC)
+  const ethersWallet = Wallet.fromPhrase(MNEMONIC)
+  const ethersMaster = HDNodeWallet.fromMnemonic(ethersMnemonic, 'm')
+  const ethersBip44 = HDNodeWallet.fromMnemonic(ethersMnemonic, bip44Path)
+
+  console.log('Mnemonic:', MNEMONIC)
+  console.log('Master (m) address:', master.address)
+  console.log(`BIP44 (${bip44Path}) address:`, bip44.address)
+  console.log('Ethers Wallet address:', ethersWallet.address)
+  console.log('Ethers Master (m) address:', ethersMaster.address)
+  console.log(`Ethers BIP44 (${bip44Path}) address:`, ethersBip44.address)
+  console.log('Match?', master.address.toLowerCase() === bip44.address.toLowerCase())
+  console.log(
+    'Auto (m) === Ethers (m)?',
+    master.address.toLowerCase() === ethersMaster.address.toLowerCase(),
+  )
+  console.log(
+    `Auto BIP44 === Ethers BIP44?`,
+    bip44.address.toLowerCase() === ethersBip44.address.toLowerCase(),
+  )
+  console.log(
+    'Note: Current SDK behavior derives Ethereum from master key (m) unless a path is provided.',
+  )
+}
+
+main().catch((error) => {
+  console.error(error)
+  process.exit(1)
+})

examples/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "examples",
+  "version": "0.1",
+  "private": true,
+  "license": "MIT",
+  "packageManager": "[email protected]",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/autonomys/auto-sdk"
+  },
+  "author": {
+    "name": "Autonomys",
+    "url": "https://www.autonomys.net"
+  },
+  "scripts": {
+    "eth-derivation-demo": "npx ts-node ./eth-derivation-demo.ts",
+    "address": "npx ts-node ./address.ts"
+  },
+  "dependencies": {
+    "@autonomys/auto-utils": "workspace:*",
+    "ethers": "^6.13.5"
+  }
+}

package.json

@@ -5,7 +5,7 @@
   "license": "MIT",
   "workspaces": [
     "packages/**/*",
-    "examples/*",
+    "examples",
     "integration-tests"
   ],
   "scripts": {

yarn.lock

@@ -10339,13 +10339,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"commander@npm:^12.1.0":
-  version: 12.1.0
-  resolution: "commander@npm:12.1.0"
-  checksum: 10c0/6e1996680c083b3b897bfc1cfe1c58dfbcd9842fd43e1aaf8a795fbc237f65efcc860a3ef457b318e73f29a4f4a28f6403c3d653d021d960e4632dd45bde54a9
-  languageName: node
-  linkType: hard
-
 "commander@npm:^2.20.0":
   version: 2.20.3
   resolution: "commander@npm:2.20.3"
@@ -12547,6 +12540,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"examples@workspace:examples":
+  version: 0.0.0-use.local
+  resolution: "examples@workspace:examples"
+  dependencies:
+    "@autonomys/auto-utils": "workspace:*"
+    ethers: "npm:^6.13.5"
+  languageName: unknown
+  linkType: soft
+
 "execa@npm:5.0.0":
   version: 5.0.0
   resolution: "execa@npm:5.0.0"
@@ -17117,18 +17119,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"node@workspace:examples/node":
-  version: 0.0.0-use.local
-  resolution: "node@workspace:examples/node"
-  dependencies:
-    "@autonomys/auto-consensus": "workspace:*"
-    "@autonomys/auto-utils": "workspace:*"
-    commander: "npm:^12.1.0"
-    dotenv: "npm:^16.4.5"
-    ethers: "npm:^6.13.5"
-  languageName: unknown
-  linkType: soft
-
 "nopt@npm:^7.0.0, nopt@npm:^7.2.1":
   version: 7.2.1
   resolution: "nopt@npm:7.2.1"