From efe215d930102e2194f1238300ac13055f304a0f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Kihlberg?= <bjorn.wilhelm.kihlberg@gmail.com>
Date: Thu, 14 Dec 2023 17:55:19 +0100
Subject: [PATCH] use type alias for contract source id

---
 packages/marlowe-object/src/index.ts          |  7 ++++-
 packages/marlowe-object/src/reference.ts      | 12 ++++++-
 .../rest/src/contract/endpoints/sources.ts    | 31 +++++++++++--------
 3 files changed, 35 insertions(+), 15 deletions(-)

diff --git a/packages/marlowe-object/src/index.ts b/packages/marlowe-object/src/index.ts
index 30045999..a2cc29f8 100644
--- a/packages/marlowe-object/src/index.ts
+++ b/packages/marlowe-object/src/index.ts
@@ -1,6 +1,11 @@
 export { Action, Deposit, Notify, Choice } from "./actions.js";
 export { ChoiceName, ChoiceId, Bound, ChosenNum } from "./choices.js";
-export { Reference, Label } from "./reference.js";
+export {
+  Reference,
+  Label,
+  ContractSourceId,
+  ContractSourceIdGuard,
+} from "./reference.js";
 export { Address, Role, Party } from "./participants.js";
 export { Payee, PayeeAccount, PayeeParty, AccountId } from "./payee.js";
 
diff --git a/packages/marlowe-object/src/reference.ts b/packages/marlowe-object/src/reference.ts
index 67204e52..ae9e7606 100644
--- a/packages/marlowe-object/src/reference.ts
+++ b/packages/marlowe-object/src/reference.ts
@@ -8,6 +8,14 @@ export type Label = string;
 
 export const LabelGuard: t.Type<Label> = t.string;
 
+/**
+ * A label for one of the {@link ObjectType}
+ * @category Object
+ */
+export type ContractSourceId = string;
+
+export const ContractSourceIdGuard: t.Type<ContractSourceId> = t.string;
+
 /**
  * A reference to an {@link ObjectType}.
  * @category Object
@@ -20,4 +28,6 @@ export interface Reference {
  * {@link !io-ts-usage | Dynamic type guard} for the {@link Reference | reference type}.
  * @category Object
  */
-export const ReferenceGuard: t.Type<Reference> = t.type({ ref: t.string });
+export const ReferenceGuard: t.Type<Reference> = t.type({
+  ref: ContractSourceIdGuard,
+});
diff --git a/packages/runtime/client/rest/src/contract/endpoints/sources.ts b/packages/runtime/client/rest/src/contract/endpoints/sources.ts
index 3d3f5890..a4bb3721 100644
--- a/packages/runtime/client/rest/src/contract/endpoints/sources.ts
+++ b/packages/runtime/client/rest/src/contract/endpoints/sources.ts
@@ -4,21 +4,26 @@ import * as E from "fp-ts/lib/Either.js";
 import { pipe } from "fp-ts/lib/function.js";
 import { formatValidationErrors } from "jsonbigint-io-ts-reporters";
 
-import { BuiltinByteString, Contract } from "@marlowe.io/language-core-v1";
-import { Bundle, Label } from "@marlowe.io/marlowe-object";
+import { Contract } from "@marlowe.io/language-core-v1";
+import {
+  Bundle,
+  Label,
+  ContractSourceId,
+  ContractSourceIdGuard,
+} from "@marlowe.io/marlowe-object";
 import { AxiosInstance } from "axios";
 
 export interface CreateContractSourcesResponse {
-  contractSourceId: BuiltinByteString;
+  contractSourceId: ContractSourceId;
   intermediateIds: {
-    [key: Label]: BuiltinByteString;
+    [key: Label]: ContractSourceId;
   };
 }
 
 const CreateContractSourcesResponseGuard: t.Type<CreateContractSourcesResponse> =
   t.type({
-    contractSourceId: G.BuiltinByteString,
-    intermediateIds: t.record(t.string, G.BuiltinByteString),
+    contractSourceId: ContractSourceIdGuard,
+    intermediateIds: t.record(t.string, ContractSourceIdGuard),
   });
 
 export const createContractSources = (axiosInstance: AxiosInstance) => {
@@ -42,7 +47,7 @@ export const createContractSources = (axiosInstance: AxiosInstance) => {
 };
 
 export interface GetContractBySourceIdRequest {
-  contractSourceId: BuiltinByteString;
+  contractSourceId: ContractSourceId;
   expand?: boolean;
 }
 
@@ -73,15 +78,15 @@ export const getContractSourceById =
   };
 
 export interface GetContractSourceAdjacencyRequest {
-  contractSourceId: BuiltinByteString;
+  contractSourceId: ContractSourceId;
 }
 
 export interface GetContractSourceAdjacencyResponse {
-  results: BuiltinByteString[];
+  results: ContractSourceId[];
 }
 
 const GetContractSourceAdjacencyResponseGuard: t.Type<GetContractSourceAdjacencyResponse> =
-  t.type({ results: t.array(G.BuiltinByteString) });
+  t.type({ results: t.array(ContractSourceIdGuard) });
 
 export const getContractSourceAdjacency =
   (axiosInstance: AxiosInstance) =>
@@ -103,15 +108,15 @@ export const getContractSourceAdjacency =
   };
 
 export interface GetContractSourceClosureRequest {
-  contractSourceId: BuiltinByteString;
+  contractSourceId: ContractSourceId;
 }
 
 export interface GetContractSourceClosureResponse {
-  results: BuiltinByteString[];
+  results: ContractSourceId[];
 }
 
 const GetContractSourceClosureResponseGuard: t.Type<GetContractSourceClosureResponse> =
-  t.type({ results: t.array(G.BuiltinByteString) });
+  t.type({ results: t.array(ContractSourceIdGuard) });
 
 export const getContractSourceClosure =
   (axiosInstance: AxiosInstance) =>