Add keyless account support [AIP-61]

CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T
 - TypeTag parsing now support references, uppercase types, and more complete error handling
 - Allow simple string inputs as type arguments in move scripts
 - [`Fix`] Block APIs will now pull all associated transactions in the block, not just the first `100`
+- Adds Keyless Account support
 
 # 1.16.0 (2024-05-22)
 

examples/typescript/keyless.ts

@@ -0,0 +1,117 @@
+/* eslint-disable max-len */
+/* eslint-disable no-console */
+
+/**
+ * This example shows how to use the Keyless accounts on Aptos
+ */
+
+import { Account, AccountAddress, Aptos, AptosConfig, EphemeralKeyPair, Network } from "@aptos-labs/ts-sdk";
+import * as readlineSync from "readline-sync";
+
+const COIN_STORE = "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>";
+const ALICE_INITIAL_BALANCE = 100_000_000;
+const BOB_INITIAL_BALANCE = 100;
+const TRANSFER_AMOUNT = 10_000;
+
+/**
+ * Prints the balance of an account
+ * @param aptos
+ * @param name
+ * @param address
+ * @returns {Promise<*>}
+ *
+ */
+const balance = async (aptos: Aptos, name: string, address: AccountAddress) => {
+  type Coin = { coin: { value: string } };
+  const resource = await aptos.getAccountResource<Coin>({
+    accountAddress: address,
+    resourceType: COIN_STORE,
+  });
+  const amount = Number(resource.coin.value);
+
+  console.log(`${name}'s balance is: ${amount}`);
+  return amount;
+};
+
+const example = async () => {
+  // Setup the client
+  const config = new AptosConfig({ network: Network.DEVNET });
+  const aptos = new Aptos(config);
+
+  // Generate the ephemeral (temporary) key pair that will be used to sign transactions.
+  const aliceEphem = EphemeralKeyPair.generate();
+
+  console.log("\n=== Keyless Account Example ===\n");
+
+  const link = `https://accounts.google.com/o/oauth2/v2/auth/oauthchooseaccount?redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground&prompt=consent&response_type=code&client_id=407408718192.apps.googleusercontent.com&scope=openid&access_type=offline&service=lso&o2v=2&theme=glif&flowName=GeneralOAuthFlow&nonce=${aliceEphem.nonce}`;
+  console.log(`${link}\n`);
+
+  console.log("1. Open the link above");
+  console.log("2. Log in with your Google account");
+  console.log("3. Click 'Exchange authorization code for tokens");
+  console.log("4. Copy the 'id_token' - (toggling 'Wrap lines' option at the bottom makes this easier)\n");
+
+  function inputJwt(): string {
+    const jwt: string = readlineSync.question("Paste the JWT (id_token) token here and press enter: ", {
+      hideEchoBack: false,
+    });
+    return jwt;
+  }
+
+  const jwt = inputJwt();
+  // Derive the Keyless Account from the JWT and ephemeral key pair.
+  const alice = await aptos.deriveKeylessAccount({
+    jwt,
+    ephemeralKeyPair: aliceEphem,
+  });
+
+  console.log("=== Addresses ===\n");
+  console.log(`Alice's keyless account address is: ${alice.accountAddress}`);
+  console.log(`Alice's nonce is: ${aliceEphem.nonce}`);
+  console.log(`Alice's ephem pubkey is: ${aliceEphem.getPublicKey().toString()}`);
+
+  const bob = Account.generate();
+  console.log(`Bob's address is: ${bob.accountAddress}`);
+
+  // Fund the accounts
+  console.log("\n=== Funding accounts ===\n");
+
+  await aptos.fundAccount({
+    accountAddress: alice.accountAddress,
+    amount: ALICE_INITIAL_BALANCE,
+  });
+  await aptos.faucet.fundAccount({
+    accountAddress: bob.accountAddress,
+    amount: BOB_INITIAL_BALANCE,
+    options: { waitForIndexer: false },
+  });
+
+  // // Show the balances
+  console.log("\n=== Balances ===\n");
+  const aliceBalance = await balance(aptos, "Alice", alice.accountAddress);
+  const bobBalance = await balance(aptos, "Bob", bob.accountAddress);
+
+  // Transfer between users
+  const transaction = await aptos.transferCoinTransaction({
+    sender: alice.accountAddress,
+    recipient: bob.accountAddress,
+    amount: TRANSFER_AMOUNT,
+  });
+
+  const committedTxn = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
+
+  await aptos.waitForTransaction({ transactionHash: committedTxn.hash });
+  console.log(`Committed transaction: ${committedTxn.hash}`);
+
+  console.log("\n=== Balances after transfer ===\n");
+  const newAliceBalance = await balance(aptos, "Alice", alice.accountAddress);
+  const newBobBalance = await balance(aptos, "Bob", bob.accountAddress);
+
+  // Bob should have the transfer amount
+  if (TRANSFER_AMOUNT !== newBobBalance - bobBalance) throw new Error("Bob's balance after transfer is incorrect");
+
+  // Alice should have the remainder minus gas
+  if (TRANSFER_AMOUNT >= aliceBalance - newAliceBalance) throw new Error("Alice's balance after transfer is incorrect");
+};
+
+example();

examples/typescript/package.json

@@ -16,16 +16,20 @@
     "external_signing": "ts-node external_signing.ts",
     "your_coin": "ts-node your_coin.ts",
     "your_fungible_asset": "ts-node your_fungible_asset.ts",
+    "keyless": "ts-node keyless.ts",
+    "keyless_escrow": "ts-node keyless_escrow.ts",
     "test": "run-s simple_transfer multi_agent_transfer simple_sponsored_transaction transfer_coin custom_client publish_package_from_filepath external_signing sign_struct publish_package_from_filepath external_signing your_coin your_fungible_asset"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@noble/curves": "^1.4.0",
+    "@types/readline-sync": "^1.4.8",
     "dotenv": "^16.3.1",
     "npm-run-all": "latest",
-    "superagent": "^8.1.2",
-    "@noble/curves": "^1.4.0"
+    "readline-sync": "^1.4.10",
+    "superagent": "^8.1.2"
   },
   "peerDependencies": {
     "@aptos-labs/ts-sdk": "link:../.."