feat: add stuff for Apex (#51)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: mvadari

APEX.md

@@ -0,0 +1,59 @@
+# Apex Workshop Notes
+
+## Getting Started
+
+1. Install Rust (https://rust-lang.org/tools/install)
+1. Install Docker (https://docs.docker.com/engine/install)
+1. Clone the repo at https://github.com/ripple/craft
+1. Type `craft` to start the CLI and install dependencies
+
+## Running an Example
+
+We will be walking through the `kyc` example. This example will only allow the escrow to be finished if the destination has created a "Terms and Conditions" example to itself.
+
+### Build the example
+
+```sh
+% craft
+> What would you like to do? Build WASM module
+Configuring WASM build settings...
+> Select WASM project: kyc
+> Select build mode: Release (optimized, no debug info)
+> Select optimization level: Aggressive (-Oz: optimize aggressively for size)
+Building WASM module...
+Running cargo build...
+args: ["build", "--target", "wasm32-unknown-unknown", "--release"]
+
+    Finished `release` profile [optimized] target(s) in 0.03s
+
+
+Build completed successfully!
+
+WASM file location:
+/Users/mvadari/Documents/craft/projects/kyc/target/wasm32-unknown-unknown/release/kyc.wasm
+Size: 1198 bytes
+WASM Fingerprint: w7HwHG281DxCQf43VyE7tx1CFheTop12cM # note, this might be wrong
+> Would you like to export the WASM as hex (copied to clipboard)? No
+Optimizing WASM module...
+Optimization complete!
+> What would you like to do next? Exit
+```
+
+### Run the example
+
+In a separate Terminal window:
+
+```sh
+# open Docker Desktop
+docker pull rippleci/rippled:smart_escrow
+docker run --rm -p 5005:5005 -p 6006:6006 --volume "/$(pwd)/reference/rippled_cfg/":"/opt/etc/ripple/" --platform linux/amd64 rippleci/rippled:smart_escrow "-a"
+```
+
+In your main Terminal window:
+
+```sh
+# run scripts
+node reference/js/deploy_sample_standalone.js kyc
+# Record the Origin, Destination, and Destination Secret from the output above
+node reference/js/finish_escrow_kyc.js [DestinationAccount] [DestinationSecret] [OriginAccount] [EscrowSequence]
+```

projects/kyc/src/lib.rs

@@ -1,17 +1,29 @@
 #![no_std]
 
-use xrpl_std::get_current_escrow_account_id;
+use xrpl_std::get_current_escrow_destination;
+use xrpl_std::host::trace::{DataRepr, trace_data, trace_num};
 use xrpl_std::keylet::credential_keylet;
 
 #[unsafe(no_mangle)]
 pub extern "C" fn finish() -> bool {
-    let account = match get_current_escrow_account_id() {
+    let account = match get_current_escrow_destination() {
         Some(v) => v,
         None => return false,
     };
+
+    // "termsandconditions" in hex
     let cred_type: &[u8] = b"termsandconditions";
-    match credential_keylet(&account, &account, &cred_type) {
-        Some(_v) => return true,
+    let cred_keylet = match credential_keylet(&account, &account, &cred_type) {
+        Some(v) => v,
         None => return false,
     };
+    let _ = trace_data("cred_keylet", &cred_keylet, DataRepr::AsHex);
+
+    let slot =
+        unsafe { xrpl_std::host::cache_ledger_obj(cred_keylet.as_ptr(), cred_keylet.len(), 0) };
+    if slot < 0 {
+        let _ = trace_num("CACHE ERROR", i64::from(slot));
+        return false;
+    };
+    return true;
 }

reference/js/deploy_sample_standalone.js

@@ -89,14 +89,16 @@ async function deploy() {
     wallet2 = xrpl.Wallet.generate()
   }
 
+  const finish = getFinishFunctionFromFile(process.argv[2])
+
   await fundWallet(wallet)
   await fundWallet(wallet2)
 
   console.log(`\nFunded accounts:`)
-  console.log(`Account 1 - Address: ${wallet.address}`)
-  console.log(`Account 1 - Secret: ${wallet.seed}`)
-  console.log(`Account 2 - Address: ${wallet2.address}`)
-  console.log(`Account 2 - Secret: ${wallet2.seed}\n`)
+  console.log(`Account 1 (Origin) - Address: ${wallet.address}`)
+  console.log(`Account 1 (Origin) - Secret: ${wallet.seed}`)
+  console.log(`Account 2 (Destination) - Address: ${wallet2.address}`)
+  console.log(`Account 2 (Destination) - Secret: ${wallet2.seed}\n`)
 
   const close_time = (
     await client.request({
@@ -105,15 +107,12 @@ async function deploy() {
     })
   ).result.ledger.close_time
 
-  const finish = getFinishFunctionFromFile(process.argv[2])
-  console.log(finish)
-
   const response1 = await submit({
     TransactionType: 'EscrowCreate',
     Account: wallet.address,
     Amount: "100000",
     Destination: wallet2.address,
-    CancelAfter: close_time + 200,
+    CancelAfter: close_time + 2000,
     FinishAfter: close_time + 5,
     FinishFunction: finish,
     Data: xrpl.xrpToDrops(70),

reference/js/finish_escrow_kyc.js

@@ -0,0 +1,121 @@
+const xrpl = require("xrpl")
+
+if (process.argv.length != 6) {
+  console.error(
+    'Usage: ' +
+      process.argv[0] +
+      ' ' +
+      process.argv[1] +
+      ' <Account> <AccountSecret> <Owner> <OfferSequence>',
+  )
+  process.exit(1)
+}
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+const url = "ws://127.0.0.1:6006"
+const client = new xrpl.Client(url)
+
+const [, , account, accountSecret, owner, offerSequence] = process.argv
+
+async function submit(tx, wallet, debug = true) {
+  const result = await client.submitAndWait(tx, {autofill: true, wallet})
+  console.log("SUBMITTED " + tx.TransactionType)
+  if (debug)
+    console.log(result.result ?? result)
+  else
+    console.log("Result code: " + result.result?.meta?.TransactionResult)
+  return result
+}
+
+async function finishEscrow() {
+  let interval
+  try {
+    await client.connect()
+    console.log(`Connected to ${url}`)
+    await client.request({command: 'ledger_accept'})
+    
+    interval = setInterval(() => {if (client.isConnected()) client.request({command: 'ledger_accept'})},1000)
+
+    const wallet = xrpl.Wallet.fromSeed(accountSecret)
+    
+    // Verify the account matches the wallet
+    if (wallet.address !== account) {
+      console.error("Error: Provided account doesn't match the wallet derived from the secret")
+      process.exit(1)
+    }
+
+    console.log("\nTransaction Details:")
+    console.log(`Account (Finishing Escrow): ${account}`)
+    console.log(`Owner (Created Escrow): ${owner}`)
+    console.log(`Offer Sequence: ${offerSequence}\n`)
+
+    await sleep(2000)
+
+    const txFail = {
+      TransactionType: 'EscrowFinish',
+      Account: account,
+      Owner: owner,
+      OfferSequence: parseInt(offerSequence),
+      ComputationAllowance: 1000000,
+    }
+
+    console.log("Submitting EscrowFinish transaction... (this should fail)")
+    const responseFail = await submit(txFail, wallet)
+    
+    if (responseFail.result.meta.TransactionResult === "tesSUCCESS") {
+      console.log("\nEscrow finished successfully!")
+    } else {
+      console.error("\nFailed to finish escrow:", responseFail.result.meta.TransactionResult)
+    }
+
+    await sleep(2000)
+
+    const credTx = {
+      TransactionType: 'CredentialCreate',
+      Account: account,
+      Subject: account,
+      CredentialType: xrpl.convertStringToHex('termsandconditions'),
+      URI: xrpl.convertStringToHex("https://example.com/terms"),
+    }
+
+    console.log("Submitting CredentialCreate transaction...")
+    const credResponse = await submit(credTx, wallet)
+    
+    if (credResponse.result.meta.TransactionResult === "tesSUCCESS") {
+      console.log("Credential created successfully!")
+    } else {
+      console.error("\nFailed to create credential:", credResponse.result.meta.TransactionResult)
+    }
+
+    await sleep(2000)
+
+    const tx = {
+      TransactionType: 'EscrowFinish',
+      Account: account,
+      Owner: owner,
+      OfferSequence: parseInt(offerSequence),
+      ComputationAllowance: 1000000,
+    }
+
+    console.log("Submitting EscrowFinish transaction...")
+    const response = await submit(tx, wallet)
+    
+    if (response.result.meta.TransactionResult === "tesSUCCESS") {
+      console.log("\nEscrow finished successfully!")
+    } else {
+      console.error("\nFailed to finish escrow:", response.result.meta.TransactionResult)
+    }
+
+  } catch (error) {
+    console.error("Error:", error.message)
+  } finally {
+    await client.disconnect()
+    clearInterval(interval)
+    console.log("Disconnected")
+  }
+}
+
+finishEscrow() 

…nce/rippled-cfg/smart-escrow-rippled.cfg reference/rippled_cfg/rippled.cfgreference/rippled-cfg/smart-escrow-rippled.cfg renamed to reference/rippled_cfg/rippled.cfg reference/rippled-cfg/smart-escrow-rippled.cfg renamed to reference/rippled_cfg/rippled.cfg

@@ -72,9 +72,6 @@ pool.ntp.org
 [ips]
 r.ripple.com 51235
 
-[validators_file]
-validators.txt
-
 [rpc_startup]
 { "command": "log_level", "severity": "info" }
 
@@ -110,8 +107,6 @@ validators.txt
 63456
 
 [features]
-# EscrowExtensions
-SmartEscrow
 # Devnet amendments as of June 28th, 2023
 NegativeUNL
 fixRemoveNFTokenAutoTrustLine
@@ -173,34 +168,47 @@ AMM
 Clawback
 fixReducedOffersV1
 fixNFTokenRemint
-# 2.0.0-b4 Amendments
+# 2.0.0 Amendments
 XChainBridge
 DID
-# 2.2.0-b3 Amendments
+# 2.2.0 Amendments
 fixNFTokenReserve
 fixInnerObjTemplate
 fixAMMOverflowOffer
 PriceOracle
 fixEmptyDID
 fixXChainRewardRounding
 fixPreviousTxnID
+fixAMMv1_1
 # 2.3.0 Amendments
-# fixAMMv1_1
-# fixAMMv1_2
-# AMMClawback
-# InvariantsV1_1
-# Credentials
-# NFTokenMintOffer
-# MPTokensV1
-# fixNFTokenPageLinks
-# fixInnerObjTemplate2
-# fixEnforceNFTokenTrustline
-# fixReducedOffersV2
-# DeepFreeze
-# PermissionedDomains
+AMMClawback
+Credentials
+NFTokenMintOffer
+MPTokensV1
+fixAMMv1_2
+fixNFTokenPageLinks
+fixInnerObjTemplate2
+fixEnforceNFTokenTrustline
+fixReducedOffersV2
+# 2.4.0 Amendments
+DeepFreeze
+DynamicNFT
+PermissionedDomains
+fixFrozenLPTokenTransfer
+fixInvalidTxFlags
+# 2.5.0 Amendments
+fixEnforceNFTokenTrustlineV2
+fixAMMv1_3
+PermissionDelegation
+Batch
+TokenEscrow
+PermissionedDEX
+SingleAssetVault
+fixPayChanCancelAfter
+
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]
-reference_fee = 200           # 200 drops
-account_reserve = 20000000   # 20 XRP
-owner_reserve = 5000000      # 5 XRP
+reference_fee = 10           # 10 drops
+account_reserve = 1000000   # 1 XRP
+owner_reserve = 200000      # 0.2 XRP

reference/rippled-cfg/validators.txt reference/rippled_cfg/validators.txtreference/rippled-cfg/validators.txt renamed to reference/rippled_cfg/validators.txt

@@ -1,6 +1,6 @@
-use crate::core::amount::xrp_amount::XrpAmount;
 use crate::core::amount::Amount;
 use crate::core::amount::Amount::Xrp;
+use crate::core::amount::xrp_amount::XrpAmount;
 use crate::core::field_codes::{
     SF_ACCOUNT, SF_ACCOUNT_TXN_ID, SF_CONDITION, SF_FEE, SF_FLAGS, SF_FULFILLMENT, SF_HASH,
     SF_LAST_LEDGER_SEQUENCE, SF_NETWORK_ID, SF_OFFER_SEQUENCE, SF_OWNER, SF_SEQUENCE,