fix: change AddressData to midgardAddress from ledger-deposit branch

Author: Cauterization

demo/midgard-node/pnpm-lock.yaml

@@ -8,7 +8,12 @@ import {
 import { StateQueueTx } from "@/transactions/index.js";
 import * as SDK from "@al-ft/midgard-sdk";
 import { NodeSdk } from "@effect/opentelemetry";
-import { fromHex, getAddressDetails, toHex, CML } from "@lucid-evolution/lucid";
+import {
+  fromHex,
+  getAddressDetails,
+  toHex,
+  CML,
+} from "@lucid-evolution/lucid";
 import { PrometheusExporter } from "@opentelemetry/exporter-prometheus";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
@@ -23,7 +28,7 @@ import {
   Queue,
   Ref,
   Schedule,
-  Schema as S
+  Schema as S,
 } from "effect";
 import {
   AddressHistoryDB,
@@ -66,7 +71,6 @@ import {
   txQueueProcessorFiber,
 } from "@/fibers/index.js";
 import { RequestError } from "@effect/platform/HttpServerError";
-import { isNotNull } from "effect/Predicate";
 
 const TX_ENDPOINT: string = "tx";
 const ADDRESS_HISTORY_ENDPOINT: string = "txs";
@@ -104,10 +108,12 @@ const parseRequestBody = <A, I>(
     const result = S.decodeUnknownEither(schema)(body);
     if (result._tag === "Left") {
       yield* Effect.logInfo(`Invalid request body: ${result.left}`);
-      return yield* Effect.fail(new RequestBodyParseError({
-        message: "Invalid request body",
-        cause: result.left,
-      }));
+      return yield* Effect.fail(
+        new RequestBodyParseError({
+          message: "Invalid request body",
+          cause: result.left,
+        }),
+      );
     }
     return result.right;
   });
@@ -120,10 +126,7 @@ const handleRequestBodyParseFailure = (
   Effect.gen(function* () {
     const msg = `${method} /${endpoint} - ${error.message}: ${error.cause}`;
     yield* Effect.logInfo(msg);
-    return yield* HttpServerResponse.json(
-      { error: msg },
-      { status: 400 },
-    );
+    return yield* HttpServerResponse.json({ error: msg }, { status: 400 });
   });
 
 const failWith500Helper = (
@@ -635,7 +638,7 @@ const postTxOrderHandler = Effect.gen(function* () {
       { status: 400 },
     );
   }
-  const refundAddressData = yield* SDK.addressDataFromBech32(refund_address);
+  const refundAddress = yield* SDK.midgardAddressFromBech32(refund_address);
 
   yield* lucid.switchToOperatorsMainWallet;
 
@@ -645,7 +648,7 @@ const postTxOrderHandler = Effect.gen(function* () {
     txOrderScriptAddress: txOrderAuthValidator.spendScriptAddress,
     mintingPolicy: txOrderAuthValidator.mintScript,
     policyId: txOrderAuthValidator.policyId,
-    refundAddress: refundAddressData,
+    refundAddress: refundAddress,
     refundDatum: refund_datum,
     midgardTxBody: "",
     midgardTxWits: "",
@@ -664,7 +667,7 @@ const postTxOrderHandler = Effect.gen(function* () {
   });
 }).pipe(
   Effect.catchTag("RequestBodyParseError", (e) =>
-    handleRequestBodyParseFailure("POST", TX_ORDER_ENDPOINT, e)
+    handleRequestBodyParseFailure("POST", TX_ORDER_ENDPOINT, e),
   ),
   Effect.catchTag("HttpBodyError", (e) =>
     failWith500("POST", TX_ORDER_ENDPOINT, e),
@@ -711,7 +714,7 @@ const postDepositHandler = Effect.gen(function* () {
       { status: 400 },
     );
   }
-  const l2DatumValue = datum ?? null
+  const l2DatumValue = datum ?? null;
 
   yield* lucid.switchToOperatorsMainWallet;
 
@@ -741,7 +744,7 @@ const postDepositHandler = Effect.gen(function* () {
   });
 }).pipe(
   Effect.catchTag("RequestBodyParseError", (e) =>
-    handleRequestBodyParseFailure("POST", DEPOSIT_ENDPOINT, e)
+    handleRequestBodyParseFailure("POST", DEPOSIT_ENDPOINT, e),
   ),
   Effect.catchTag("HttpBodyError", (e) =>
     failWith500("POST", DEPOSIT_ENDPOINT, e),
@@ -798,7 +801,9 @@ const postWithdrawalHandler = Effect.gen(function* () {
     ["", new Map([["", BigInt(withdrawal_body.l2_value)]])],
   ]);
 
-  const l1AddressData = yield* SDK.addressDataFromBech32(withdrawal_body.l1_address);
+  const l1Address = yield* SDK.midgardAddressFromBech32(
+    withdrawal_body.l1_address,
+  );
 
   const l1Datum: SDK.CardanoDatum =
     withdrawal_body.l1_datum === "NoDatum"
@@ -812,31 +817,28 @@ const postWithdrawalHandler = Effect.gen(function* () {
             }),
         });
 
-  const refundAddressData = yield* SDK.addressDataFromBech32(refund_address);
+  const refundAddress = yield* SDK.midgardAddressFromBech32(refund_address);
 
   yield* lucid.switchToOperatorsMainWallet;
 
-  const signedTx = yield* SDK.unsignedWithdrawalTxProgram(
-    lucid.api,
-    {
-      withdrawalScriptAddress: withdrawalAuthValidator.spendScriptAddress,
-      mintingPolicy: withdrawalAuthValidator.mintScript,
-      policyId: withdrawalAuthValidator.policyId,
-      withdrawalBody: {
-        l2_outref: {
-          txHash: { hash: withdrawal_body.l2_outref.txHash.hash },
-          outputIndex: BigInt(withdrawal_body.l2_outref.outputIndex),
-        },
-        l2_owner: withdrawal_body.l2_owner,
-        l2_value: { inner: l2ValueInner },
-        l1_address: l1AddressData,
-        l1_datum: l1Datum,
+  const signedTx = yield* SDK.unsignedWithdrawalTxProgram(lucid.api, {
+    withdrawalScriptAddress: withdrawalAuthValidator.spendScriptAddress,
+    mintingPolicy: withdrawalAuthValidator.mintScript,
+    policyId: withdrawalAuthValidator.policyId,
+    withdrawalBody: {
+      l2_outref: {
+        txHash: { hash: withdrawal_body.l2_outref.txHash.hash },
+        outputIndex: BigInt(withdrawal_body.l2_outref.outputIndex),
       },
-      withdrawalSignature: withdrawalSignatureMap,
-      refundAddress: refundAddressData,
-      refundDatum: refund_datum,
+      l2_owner: withdrawal_body.l2_owner,
+      l2_value: { inner: l2ValueInner },
+      l1_address: l1Address,
+      l1_datum: l1Datum,
     },
-  );
+    withdrawalSignature: withdrawalSignatureMap,
+    refundAddress: refundAddress,
+    refundDatum: refund_datum,
+  });
 
   yield* Effect.logInfo(`Submitting withdrawal order tx...`);
   const txHash = yield* handleSignSubmit(lucid.api, signedTx);
@@ -846,7 +848,7 @@ const postWithdrawalHandler = Effect.gen(function* () {
   });
 }).pipe(
   Effect.catchTag("RequestBodyParseError", (e) =>
-    handleRequestBodyParseFailure("POST", WITHDRAWAL_ENDPOINT, e)
+    handleRequestBodyParseFailure("POST", WITHDRAWAL_ENDPOINT, e),
   ),
   Effect.catchTag("HttpBodyError", (e) =>
     failWith500("POST", WITHDRAWAL_ENDPOINT, e),

demo/midgard-node/src/commands/listen.ts

@@ -86,7 +86,7 @@ const submitGenesisTxOrders: Effect.Effect<
   yield* lucid.switchToOperatorsMainWallet;
 
   const l2Address = config.GENESIS_UTXOS[0].address;
-  const l2AddressData = yield* SDK.addressDataFromBech32(l2Address);
+  const l2AddressData = yield* SDK.midgardAddressFromBech32(l2Address);
   const inclusionTime = Date.now();
 
   const txBuilder = lucid.api

demo/midgard-node/src/genesis.ts

@@ -1,4 +1,10 @@
-import { Data, getAddressDetails } from "@lucid-evolution/lucid";
+import {
+  AddressDetails,
+  credentialToAddress,
+  Data,
+  getAddressDetails,
+  Network,
+} from "@lucid-evolution/lucid";
 import { Data as EffectData } from "effect";
 import { Effect } from "effect";
 import {
@@ -193,6 +199,66 @@ export const bufferToHex = (buf: Buffer): string => {
   }
 };
 
+/**
+ * Assumes the given Bech32 string is that of a Cardano address (TODO).
+ */
+export const midgardAddressFromBech32 = (
+  bechStr: string,
+): Effect.Effect<MidgardAddress, Bech32DeserializationError> =>
+  Effect.gen(function* () {
+    const addressDetails: AddressDetails = yield* Effect.try({
+      try: () => getAddressDetails(bechStr),
+      catch: (e) =>
+        new Bech32DeserializationError({
+          message: `Failed to break down ${bechStr} to its details.`,
+          cause: e,
+        }),
+    });
+    const cred = addressDetails.paymentCredential;
+    if (cred === undefined) {
+      return yield* new Bech32DeserializationError({
+        message: `Failed extracting the payment credential from ${bechStr}.`,
+        cause: "Unknown cause.",
+      });
+    } else {
+      if (cred.type === "Key") {
+        const midgardAddress: MidgardAddress = {
+          PublicKeyCredential: [cred.hash],
+        };
+        return midgardAddress;
+      } else {
+        const midgardAddress: MidgardAddress = {
+          ScriptCredential: [cred.hash],
+        };
+        return midgardAddress;
+      }
+    }
+  });
+
+/**
+ * Taking Cardano `Network` as the first argument is temporary (TODO).
+ */
+export const midgardAddressToBech32 = (
+  network: Network,
+  addr: MidgardAddress,
+): string => {
+  if ("PublicKeyCredential" in addr) {
+    const [pubKeyHex] = addr.PublicKeyCredential;
+    const cred: Credential = {
+      type: "Key",
+      hash: pubKeyHex,
+    };
+    return credentialToAddress(network, cred);
+  } else {
+    const [scriptHashHex] = addr.ScriptCredential;
+    const cred: Credential = {
+      type: "Script",
+      hash: scriptHashHex,
+    };
+    return credentialToAddress(network, cred);
+  }
+};
+
 export const H32Schema = Data.Bytes({ minLength: 32, maxLength: 32 });
 export type H32 = Data.Static<typeof H32Schema>;
 export const H32 = H32Schema as unknown as H32;
@@ -265,43 +331,9 @@ export const AddressSchema = Data.Object({
 export type AddressData = Data.Static<typeof AddressSchema>;
 export const AddressData = AddressSchema as unknown as AddressData;
 
-export const addressDataFromBech32 = (
-  address: string,
-): Effect.Effect<AddressData, Bech32DeserializationError> =>
-  Effect.gen(function* () {
-    const { paymentCredential, stakeCredential } = getAddressDetails(address);
-    if (!paymentCredential)
-      return yield* Effect.fail(
-        new Bech32DeserializationError({
-          message: "Failed to parse address data",
-          cause: "Payment key credential is undefined",
-        }),
-      );
-    return {
-      paymentCredential:
-        paymentCredential.type === "Key"
-          ? {
-              PublicKeyCredential: [paymentCredential.hash],
-            }
-          : {
-              ScriptCredential: [paymentCredential.hash],
-            },
-      stakeCredential:
-        stakeCredential && stakeCredential.hash
-          ? {
-              Inline: [
-                stakeCredential.type === "Key"
-                  ? {
-                      PublicKeyCredential: [stakeCredential.hash],
-                    }
-                  : {
-                      ScriptCredential: [stakeCredential.hash],
-                    },
-              ],
-            }
-          : null,
-    };
-  });
+export const MidgardAddressSchema = CredentialSchema;
+export type MidgardAddress = CredentialD;
+export const MidgardAddress = MidgardAddressSchema as unknown as MidgardAddress;
 
 export type GenericErrorFields = {
   readonly message: string;

demo/midgard-sdk/src/common.ts

@@ -3,6 +3,8 @@ import {
   AddressSchema,
   H32Schema,
   MerkleRootSchema,
+  MidgardAddress,
+  MidgardAddressSchema,
   OutputReferenceSchema,
   POSIXTimeSchema,
   PubKeyHashSchema,
@@ -136,7 +138,7 @@ export const WithdrawalBodySchema = Data.Object({
   l2_outref: OutputReferenceSchema,
   l2_owner: Data.Bytes({ minLength: 28, maxLength: 28 }),
   l2_value: ValueSchema,
-  l1_address: AddressSchema,
+  l1_address: MidgardAddressSchema,
   l1_datum: CardanoDatumSchema,
 });
 export type WithdrawalBody = Data.Static<typeof WithdrawalBodySchema>;

demo/midgard-sdk/src/ledger-state.ts

@@ -17,20 +17,20 @@ import {
   getStateToken,
   isEventUTxOInclusionTimeInBounds,
   makeReturn,
+  MidgardAddress,
+  MidgardAddressSchema,
   OutputReference,
   UnauthenticUtxoError,
   utxosAtByNFTPolicyId,
 } from "@/common.js";
 import {
-  AddressData,
-  AddressSchema,
   POSIXTime,
   POSIXTimeSchema,
   HashingError,
   LucidError,
   hashHexWithBlake2b256,
 } from "@/common.js";
-import { MidgardTxCompact, TxOrderEventSchema } from "@/ledger-state.js";
+import { TxOrderEventSchema } from "@/ledger-state.js";
 import {
   buildUserEventMintTransaction,
   UserEventMintRedeemer,
@@ -42,7 +42,7 @@ export type TxOrderParams = {
   txOrderScriptAddress: string;
   mintingPolicy: Script;
   policyId: string;
-  refundAddress: AddressData;
+  refundAddress: MidgardAddress;
   refundDatum: string;
   midgardTxBody: string;
   midgardTxWits: string;
@@ -52,7 +52,7 @@ export type TxOrderParams = {
 export const TxOrderDatumSchema = Data.Object({
   event: TxOrderEventSchema,
   inclusionTime: POSIXTimeSchema,
-  refundAddress: AddressSchema,
+  refundAddress: MidgardAddressSchema,
   refundDatum: Data.Nullable(Data.Bytes()),
 });
 export type TxOrderDatum = Data.Static<typeof TxOrderDatumSchema>;

demo/midgard-sdk/src/user-events/tx-order.ts

@@ -1,9 +1,9 @@
 import {
-  AddressData,
-  AddressSchema,
   GenericErrorFields,
   HashingError,
   LucidError,
+  MidgardAddress,
+  MidgardAddressSchema,
   POSIXTimeSchema,
   hashHexWithBlake2b256,
   makeReturn,
@@ -36,14 +36,14 @@ export type WithdrawalOrderParams = {
   policyId: string;
   withdrawalBody: WithdrawalBody;
   withdrawalSignature: WithdrawalSignature;
-  refundAddress: AddressData;
+  refundAddress: MidgardAddress;
   refundDatum: Data;
 };
 
 export const WithdrawalOrderDatumSchema = Data.Object({
   event: WithdrawalEventSchema,
   inclusionTime: POSIXTimeSchema,
-  refundAddress: AddressSchema,
+  refundAddress: MidgardAddressSchema,
   refundDatum: Data.Any(),
 });
 export type WithdrawalOrderDatum = Data.Static<