fix: add generic principal helper

hirosystems · Nov 2, 2023 · 25176ce · 25176ce
1 parent 47f138a
commit 25176ce
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/packages/transactions/src/cl.ts b/packages/transactions/src/cl.ts
@@ -59,6 +59,23 @@ export const int = intCV;
  * @see {@link serialize}, {@link deserialize}
  */
 export const uint = uintCV;
+
+/**
+ * `Cl.principal` — Creates a Clarity principal type, represented as a JS object
+ * @param address - A Stacks address (optionally with a contract name in the string)
+ *
+ * @example
+ * ```
+ * import { Cl } from '@stacks/transactions';
+ * Cl.principal('ST000000000000000000002AMW42H');
+ * Cl.principal('ST000000000000000000002AMW42H.asset');
+ * ```
+ * @see {@link serialize}, {@link deserialize}
+ */
+export function principal(address: string) {
+  const [addr, name] = address.split('.');
+  return name ? contractPrincipalCV(addr, name) : standardPrincipalCV(addr);
+}
 /**
  * `Cl.contractPrincipal` — Creates a Clarity contract `principal` type, represented as a JS object
  *