@story-protocol/core-sdk 0.1.0-rc.1

package/dist/story-protocol-core-sdk.esm.js

@@ -0,0 +1,2073 @@
+import axios from 'axios';
+import * as dotenv from 'dotenv';
+import { constants, utils, Contract, ethers } from 'ethers';
+
+function _classCallCheck(instance, Constructor) {
+  if (!(instance instanceof Constructor)) {
+    throw new TypeError("Cannot call a class as a function");
+  }
+}
+
+function _toPrimitive(input, hint) {
+  if (typeof input !== "object" || input === null) return input;
+  var prim = input[Symbol.toPrimitive];
+  if (prim !== undefined) {
+    var res = prim.call(input, hint || "default");
+    if (typeof res !== "object") return res;
+    throw new TypeError("@@toPrimitive must return a primitive value.");
+  }
+  return (hint === "string" ? String : Number)(input);
+}
+
+function _toPropertyKey(arg) {
+  var key = _toPrimitive(arg, "string");
+  return typeof key === "symbol" ? key : String(key);
+}
+
+function _defineProperties(target, props) {
+  for (var i = 0; i < props.length; i++) {
+    var descriptor = props[i];
+    descriptor.enumerable = descriptor.enumerable || false;
+    descriptor.configurable = true;
+    if ("value" in descriptor) descriptor.writable = true;
+    Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor);
+  }
+}
+function _createClass(Constructor, protoProps, staticProps) {
+  if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+  if (staticProps) _defineProperties(Constructor, staticProps);
+  Object.defineProperty(Constructor, "prototype", {
+    writable: false
+  });
+  return Constructor;
+}
+
+function _defineProperty(obj, key, value) {
+  key = _toPropertyKey(key);
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
+
+/**
+ * @public
+ */
+var Environment = /*#__PURE__*/function (Environment) {
+  Environment["TEST"] = "TEST";
+  Environment["PROD"] = "PROD";
+  return Environment;
+}({});
+
+function _regeneratorRuntime() {
+  _regeneratorRuntime = function () {
+    return e;
+  };
+  var t,
+    e = {},
+    r = Object.prototype,
+    n = r.hasOwnProperty,
+    o = Object.defineProperty || function (t, e, r) {
+      t[e] = r.value;
+    },
+    i = "function" == typeof Symbol ? Symbol : {},
+    a = i.iterator || "@@iterator",
+    c = i.asyncIterator || "@@asyncIterator",
+    u = i.toStringTag || "@@toStringTag";
+  function define(t, e, r) {
+    return Object.defineProperty(t, e, {
+      value: r,
+      enumerable: !0,
+      configurable: !0,
+      writable: !0
+    }), t[e];
+  }
+  try {
+    define({}, "");
+  } catch (t) {
+    define = function (t, e, r) {
+      return t[e] = r;
+    };
+  }
+  function wrap(t, e, r, n) {
+    var i = e && e.prototype instanceof Generator ? e : Generator,
+      a = Object.create(i.prototype),
+      c = new Context(n || []);
+    return o(a, "_invoke", {
+      value: makeInvokeMethod(t, r, c)
+    }), a;
+  }
+  function tryCatch(t, e, r) {
+    try {
+      return {
+        type: "normal",
+        arg: t.call(e, r)
+      };
+    } catch (t) {
+      return {
+        type: "throw",
+        arg: t
+      };
+    }
+  }
+  e.wrap = wrap;
+  var h = "suspendedStart",
+    l = "suspendedYield",
+    f = "executing",
+    s = "completed",
+    y = {};
+  function Generator() {}
+  function GeneratorFunction() {}
+  function GeneratorFunctionPrototype() {}
+  var p = {};
+  define(p, a, function () {
+    return this;
+  });
+  var d = Object.getPrototypeOf,
+    v = d && d(d(values([])));
+  v && v !== r && n.call(v, a) && (p = v);
+  var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p);
+  function defineIteratorMethods(t) {
+    ["next", "throw", "return"].forEach(function (e) {
+      define(t, e, function (t) {
+        return this._invoke(e, t);
+      });
+    });
+  }
+  function AsyncIterator(t, e) {
+    function invoke(r, o, i, a) {
+      var c = tryCatch(t[r], t, o);
+      if ("throw" !== c.type) {
+        var u = c.arg,
+          h = u.value;
+        return h && "object" == typeof h && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) {
+          invoke("next", t, i, a);
+        }, function (t) {
+          invoke("throw", t, i, a);
+        }) : e.resolve(h).then(function (t) {
+          u.value = t, i(u);
+        }, function (t) {
+          return invoke("throw", t, i, a);
+        });
+      }
+      a(c.arg);
+    }
+    var r;
+    o(this, "_invoke", {
+      value: function (t, n) {
+        function callInvokeWithMethodAndArg() {
+          return new e(function (e, r) {
+            invoke(t, n, e, r);
+          });
+        }
+        return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg();
+      }
+    });
+  }
+  function makeInvokeMethod(e, r, n) {
+    var o = h;
+    return function (i, a) {
+      if (o === f) throw new Error("Generator is already running");
+      if (o === s) {
+        if ("throw" === i) throw a;
+        return {
+          value: t,
+          done: !0
+        };
+      }
+      for (n.method = i, n.arg = a;;) {
+        var c = n.delegate;
+        if (c) {
+          var u = maybeInvokeDelegate(c, n);
+          if (u) {
+            if (u === y) continue;
+            return u;
+          }
+        }
+        if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) {
+          if (o === h) throw o = s, n.arg;
+          n.dispatchException(n.arg);
+        } else "return" === n.method && n.abrupt("return", n.arg);
+        o = f;
+        var p = tryCatch(e, r, n);
+        if ("normal" === p.type) {
+          if (o = n.done ? s : l, p.arg === y) continue;
+          return {
+            value: p.arg,
+            done: n.done
+          };
+        }
+        "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg);
+      }
+    };
+  }
+  function maybeInvokeDelegate(e, r) {
+    var n = r.method,
+      o = e.iterator[n];
+    if (o === t) return r.delegate = null, "throw" === n && e.iterator.return && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y;
+    var i = tryCatch(o, e.iterator, r.arg);
+    if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y;
+    var a = i.arg;
+    return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y);
+  }
+  function pushTryEntry(t) {
+    var e = {
+      tryLoc: t[0]
+    };
+    1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e);
+  }
+  function resetTryEntry(t) {
+    var e = t.completion || {};
+    e.type = "normal", delete e.arg, t.completion = e;
+  }
+  function Context(t) {
+    this.tryEntries = [{
+      tryLoc: "root"
+    }], t.forEach(pushTryEntry, this), this.reset(!0);
+  }
+  function values(e) {
+    if (e || "" === e) {
+      var r = e[a];
+      if (r) return r.call(e);
+      if ("function" == typeof e.next) return e;
+      if (!isNaN(e.length)) {
+        var o = -1,
+          i = function next() {
+            for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next;
+            return next.value = t, next.done = !0, next;
+          };
+        return i.next = i;
+      }
+    }
+    throw new TypeError(typeof e + " is not iterable");
+  }
+  return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", {
+    value: GeneratorFunctionPrototype,
+    configurable: !0
+  }), o(GeneratorFunctionPrototype, "constructor", {
+    value: GeneratorFunction,
+    configurable: !0
+  }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) {
+    var e = "function" == typeof t && t.constructor;
+    return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name));
+  }, e.mark = function (t) {
+    return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t;
+  }, e.awrap = function (t) {
+    return {
+      __await: t
+    };
+  }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () {
+    return this;
+  }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) {
+    void 0 === i && (i = Promise);
+    var a = new AsyncIterator(wrap(t, r, n, o), i);
+    return e.isGeneratorFunction(r) ? a : a.next().then(function (t) {
+      return t.done ? t.value : a.next();
+    });
+  }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () {
+    return this;
+  }), define(g, "toString", function () {
+    return "[object Generator]";
+  }), e.keys = function (t) {
+    var e = Object(t),
+      r = [];
+    for (var n in e) r.push(n);
+    return r.reverse(), function next() {
+      for (; r.length;) {
+        var t = r.pop();
+        if (t in e) return next.value = t, next.done = !1, next;
+      }
+      return next.done = !0, next;
+    };
+  }, e.values = values, Context.prototype = {
+    constructor: Context,
+    reset: function (e) {
+      if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t);
+    },
+    stop: function () {
+      this.done = !0;
+      var t = this.tryEntries[0].completion;
+      if ("throw" === t.type) throw t.arg;
+      return this.rval;
+    },
+    dispatchException: function (e) {
+      if (this.done) throw e;
+      var r = this;
+      function handle(n, o) {
+        return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o;
+      }
+      for (var o = this.tryEntries.length - 1; o >= 0; --o) {
+        var i = this.tryEntries[o],
+          a = i.completion;
+        if ("root" === i.tryLoc) return handle("end");
+        if (i.tryLoc <= this.prev) {
+          var c = n.call(i, "catchLoc"),
+            u = n.call(i, "finallyLoc");
+          if (c && u) {
+            if (this.prev < i.catchLoc) return handle(i.catchLoc, !0);
+            if (this.prev < i.finallyLoc) return handle(i.finallyLoc);
+          } else if (c) {
+            if (this.prev < i.catchLoc) return handle(i.catchLoc, !0);
+          } else {
+            if (!u) throw new Error("try statement without catch or finally");
+            if (this.prev < i.finallyLoc) return handle(i.finallyLoc);
+          }
+        }
+      }
+    },
+    abrupt: function (t, e) {
+      for (var r = this.tryEntries.length - 1; r >= 0; --r) {
+        var o = this.tryEntries[r];
+        if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) {
+          var i = o;
+          break;
+        }
+      }
+      i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null);
+      var a = i ? i.completion : {};
+      return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a);
+    },
+    complete: function (t, e) {
+      if ("throw" === t.type) throw t.arg;
+      return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y;
+    },
+    finish: function (t) {
+      for (var e = this.tryEntries.length - 1; e >= 0; --e) {
+        var r = this.tryEntries[e];
+        if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y;
+      }
+    },
+    catch: function (t) {
+      for (var e = this.tryEntries.length - 1; e >= 0; --e) {
+        var r = this.tryEntries[e];
+        if (r.tryLoc === t) {
+          var n = r.completion;
+          if ("throw" === n.type) {
+            var o = n.arg;
+            resetTryEntry(r);
+          }
+          return o;
+        }
+      }
+      throw new Error("illegal catch attempt");
+    },
+    delegateYield: function (e, r, n) {
+      return this.delegate = {
+        iterator: values(e),
+        resultName: r,
+        nextLoc: n
+      }, "next" === this.method && (this.arg = t), y;
+    }
+  }, e;
+}
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+  try {
+    var info = gen[key](arg);
+    var value = info.value;
+  } catch (error) {
+    reject(error);
+    return;
+  }
+  if (info.done) {
+    resolve(value);
+  } else {
+    Promise.resolve(value).then(_next, _throw);
+  }
+}
+function _asyncToGenerator(fn) {
+  return function () {
+    var self = this,
+      args = arguments;
+    return new Promise(function (resolve, reject) {
+      var gen = fn.apply(self, args);
+      function _next(value) {
+        asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+      }
+      function _throw(err) {
+        asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+      }
+      _next(undefined);
+    });
+  };
+}
+
+function handleError(error, msg) {
+  if (error instanceof Error) {
+    throw new Error("".concat(msg, ": ").concat(error.message));
+  }
+  throw new Error("".concat(msg, ": Unknown error type"));
+}
+
+function isIntegerString(s) {
+  var num = Number(s);
+  return !isNaN(num) && parseInt(s, 10) === num;
+}
+
+/**
+ * FranchiseClient allows you to create, update, view, search franchises on
+ * Story Protocol.
+ */
+var FranchiseClient = /*#__PURE__*/function () {
+  function FranchiseClient(httpClient, franchiseRegistry, licenseModule) {
+    _classCallCheck(this, FranchiseClient);
+    this.httpClient = httpClient;
+    this.franchiseRegistry = franchiseRegistry;
+    this.licenseModule = licenseModule;
+  }
+
+  /**
+   * Get a franchise data based on the specified franchise id.
+   *
+   * @param request - the request object for getting the franchise
+   * @returns the response object that contains the fetched franchise object
+   */
+  _createClass(FranchiseClient, [{
+    key: "get",
+    value: function () {
+      var _get = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              if (isIntegerString(request.franchiseId)) {
+                _context.next = 3;
+                break;
+              }
+              throw new Error("Invalid franchise id. Must be an integer. But got: ".concat(request.franchiseId));
+            case 3:
+              _context.next = 5;
+              return this.httpClient.get("/franchise/".concat(request.franchiseId));
+            case 5:
+              response = _context.sent;
+              return _context.abrupt("return", response.data);
+            case 9:
+              _context.prev = 9;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to get franchise");
+            case 12:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 9]]);
+      }));
+      function get(_x) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+    /**
+     * List all franchises.
+     *
+     * @returns the response object that contains a list of franchises
+     */
+  }, {
+    key: "list",
+    value: function () {
+      var _list = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              _context2.next = 3;
+              return this.httpClient.get("/franchise");
+            case 3:
+              response = _context2.sent;
+              return _context2.abrupt("return", response.data);
+            case 7:
+              _context2.prev = 7;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to list franchises.");
+            case 10:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 7]]);
+      }));
+      function list() {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+    /**
+     * Create a franchise on Story Protocol based on the specified input franchise data.
+     *
+     * @param request - the request object that contains all data needed to create a franchise
+     * @returns the response object that contains results from the create franchise action
+     */
+  }, {
+    key: "create",
+    value: function () {
+      var _create = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(request) {
+        var tokenURI, response;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              // hardcoded the URI for now until the backend API for uploading franchise metadata is ready
+              tokenURI = "https://arweave.net/dnFJl1v8kgOx_6Z0gEsBce3D56cMP4-lxAcFqSsL0_w";
+              _context3.next = 4;
+              return this.franchiseRegistry.registerFranchise({
+                name: request.franchiseName,
+                symbol: request.franchiseSymbol,
+                description: request.franchiseDescription,
+                tokenURI: tokenURI
+              });
+            case 4:
+              response = _context3.sent;
+              return _context3.abrupt("return", {
+                txHash: response.hash
+              });
+            case 8:
+              _context3.prev = 8;
+              _context3.t0 = _context3["catch"](0);
+              handleError(_context3.t0, "Failed to create franchise");
+            case 11:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this, [[0, 8]]);
+      }));
+      function create(_x2) {
+        return _create.apply(this, arguments);
+      }
+      return create;
+    }()
+    /**
+     * Configure a franchise on Story Protocol.
+     *
+     * @param request - the request object that contains all data needed to configure a franchise
+     * @returns the response object that contains results from the configure franchise action
+     */
+  }, {
+    key: "configure",
+    value: function () {
+      var _configure = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              _context4.prev = 0;
+              _context4.next = 3;
+              return this.licenseModule.configureFranchiseLicensing(request.franchiseId, {
+                nonCommercialConfig: {
+                  canSublicense: true,
+                  franchiseRootLicenseId: 0
+                },
+                nonCommercialTerms: {
+                  processor: constants.AddressZero,
+                  data: []
+                },
+                commercialConfig: {
+                  canSublicense: false,
+                  franchiseRootLicenseId: 0
+                },
+                commercialTerms: {
+                  processor: constants.AddressZero,
+                  data: []
+                },
+                commercialLicenseUri: "aaaa",
+                rootIpAssetHasCommercialRights: false,
+                revoker: "0xF33f05489d9708C2CA97944F2007d4E741D4DEe7"
+              });
+            case 3:
+              response = _context4.sent;
+              return _context4.abrupt("return", {
+                txHash: response.hash
+              });
+            case 7:
+              _context4.prev = 7;
+              _context4.t0 = _context4["catch"](0);
+              handleError(_context4.t0, "Failed to configure franchise");
+            case 10:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this, [[0, 7]]);
+      }));
+      function configure(_x3) {
+        return _configure.apply(this, arguments);
+      }
+      return configure;
+    }()
+  }]);
+  return FranchiseClient;
+}();
+
+var _abi$4 = [{
+  inputs: [{
+    internalType: "uint256",
+    name: "franchiseId",
+    type: "uint256"
+  }, {
+    components: [{
+      components: [{
+        internalType: "bool",
+        name: "canSublicense",
+        type: "bool"
+      }, {
+        internalType: "uint256",
+        name: "franchiseRootLicenseId",
+        type: "uint256"
+      }],
+      internalType: "struct ILicensingModule.IpAssetConfig",
+      name: "nonCommercialConfig",
+      type: "tuple"
+    }, {
+      components: [{
+        internalType: "contract ITermsProcessor",
+        name: "processor",
+        type: "address"
+      }, {
+        internalType: "bytes",
+        name: "data",
+        type: "bytes"
+      }],
+      internalType: "struct IERC5218.TermsProcessorConfig",
+      name: "nonCommercialTerms",
+      type: "tuple"
+    }, {
+      components: [{
+        internalType: "bool",
+        name: "canSublicense",
+        type: "bool"
+      }, {
+        internalType: "uint256",
+        name: "franchiseRootLicenseId",
+        type: "uint256"
+      }],
+      internalType: "struct ILicensingModule.IpAssetConfig",
+      name: "commercialConfig",
+      type: "tuple"
+    }, {
+      components: [{
+        internalType: "contract ITermsProcessor",
+        name: "processor",
+        type: "address"
+      }, {
+        internalType: "bytes",
+        name: "data",
+        type: "bytes"
+      }],
+      internalType: "struct IERC5218.TermsProcessorConfig",
+      name: "commercialTerms",
+      type: "tuple"
+    }, {
+      internalType: "bool",
+      name: "rootIpAssetHasCommercialRights",
+      type: "bool"
+    }, {
+      internalType: "address",
+      name: "revoker",
+      type: "address"
+    }, {
+      internalType: "string",
+      name: "commercialLicenseUri",
+      type: "string"
+    }],
+    internalType: "struct ILicensingModule.FranchiseConfig",
+    name: "config",
+    type: "tuple"
+  }],
+  name: "configureFranchiseLicensing",
+  outputs: [],
+  stateMutability: "nonpayable",
+  type: "function"
+}];
+var LicensingModule__factory = /*#__PURE__*/function () {
+  function LicensingModule__factory() {
+    _classCallCheck(this, LicensingModule__factory);
+  }
+  _createClass(LicensingModule__factory, null, [{
+    key: "createInterface",
+    value: function createInterface() {
+      return new utils.Interface(_abi$4);
+    }
+  }, {
+    key: "connect",
+    value: function connect(address, signerOrProvider) {
+      return new Contract(address, _abi$4, signerOrProvider);
+    }
+  }]);
+  return LicensingModule__factory;
+}();
+_defineProperty(LicensingModule__factory, "abi", _abi$4);
+
+var _abi$3 = [{
+  inputs: [{
+    components: [{
+      internalType: "string",
+      name: "name",
+      type: "string"
+    }, {
+      internalType: "string",
+      name: "symbol",
+      type: "string"
+    }, {
+      internalType: "string",
+      name: "description",
+      type: "string"
+    }, {
+      internalType: "string",
+      name: "tokenURI",
+      type: "string"
+    }],
+    internalType: "struct FranchiseRegistry.FranchiseCreationParams",
+    name: "params",
+    type: "tuple"
+  }],
+  name: "registerFranchise",
+  outputs: [{
+    internalType: "uint256",
+    name: "",
+    type: "uint256"
+  }, {
+    internalType: "address",
+    name: "",
+    type: "address"
+  }],
+  stateMutability: "nonpayable",
+  type: "function"
+}, {
+  inputs: [{
+    internalType: "uint256",
+    name: "franchiseId",
+    type: "uint256"
+  }],
+  name: "ipAssetRegistryForId",
+  outputs: [{
+    internalType: "address",
+    name: "",
+    type: "address"
+  }],
+  stateMutability: "view",
+  type: "function"
+}];
+var FranchiseRegistry__factory = /*#__PURE__*/function () {
+  function FranchiseRegistry__factory() {
+    _classCallCheck(this, FranchiseRegistry__factory);
+  }
+  _createClass(FranchiseRegistry__factory, null, [{
+    key: "createInterface",
+    value: function createInterface() {
+      return new utils.Interface(_abi$3);
+    }
+  }, {
+    key: "connect",
+    value: function connect(address, signerOrProvider) {
+      return new Contract(address, _abi$3, signerOrProvider);
+    }
+  }]);
+  return FranchiseRegistry__factory;
+}();
+_defineProperty(FranchiseRegistry__factory, "abi", _abi$3);
+
+var _abi$2 = [{
+  inputs: [{
+    components: [{
+      internalType: "uint256",
+      name: "franchiseId",
+      type: "uint256"
+    }, {
+      internalType: "uint256",
+      name: "ipAssetId",
+      type: "uint256"
+    }, {
+      internalType: "address",
+      name: "collector",
+      type: "address"
+    }, {
+      internalType: "bytes",
+      name: "collectData",
+      type: "bytes"
+    }, {
+      internalType: "bytes",
+      name: "collectNFTInitData",
+      type: "bytes"
+    }, {
+      internalType: "bytes",
+      name: "collectNFTData",
+      type: "bytes"
+    }],
+    internalType: "struct CollectParams",
+    name: "collectParams",
+    type: "tuple"
+  }],
+  name: "collect",
+  outputs: [{
+    internalType: "address",
+    name: "collectNFT",
+    type: "address"
+  }, {
+    internalType: "uint256",
+    name: "collectNFTId",
+    type: "uint256"
+  }],
+  stateMutability: "nonpayable",
+  type: "function"
+}];
+var CollectModule__factory = /*#__PURE__*/function () {
+  function CollectModule__factory() {
+    _classCallCheck(this, CollectModule__factory);
+  }
+  _createClass(CollectModule__factory, null, [{
+    key: "createInterface",
+    value: function createInterface() {
+      return new utils.Interface(_abi$2);
+    }
+  }, {
+    key: "connect",
+    value: function connect(address, signerOrProvider) {
+      return new Contract(address, _abi$2, signerOrProvider);
+    }
+  }]);
+  return CollectModule__factory;
+}();
+_defineProperty(CollectModule__factory, "abi", _abi$2);
+
+var _abi$1 = [{
+  inputs: [{
+    internalType: "enum IPAsset",
+    name: "ipAssetType",
+    type: "uint8"
+  }, {
+    internalType: "string",
+    name: "name",
+    type: "string"
+  }, {
+    internalType: "string",
+    name: "_description",
+    type: "string"
+  }, {
+    internalType: "string",
+    name: "mediaUrl",
+    type: "string"
+  }, {
+    internalType: "address",
+    name: "to",
+    type: "address"
+  }, {
+    internalType: "uint256",
+    name: "parentIpAssetId",
+    type: "uint256"
+  }],
+  name: "createIPAsset",
+  outputs: [{
+    internalType: "uint256",
+    name: "",
+    type: "uint256"
+  }],
+  stateMutability: "nonpayable",
+  type: "function"
+}, {
+  inputs: [{
+    internalType: "uint256",
+    name: "_tokenId",
+    type: "uint256"
+  }, {
+    internalType: "uint256",
+    name: "_parentLicenseId",
+    type: "uint256"
+  }, {
+    internalType: "address",
+    name: "_licenseHolder",
+    type: "address"
+  }, {
+    internalType: "string",
+    name: "_uri",
+    type: "string"
+  }, {
+    internalType: "address",
+    name: "_revoker",
+    type: "address"
+  }, {
+    internalType: "bool",
+    name: "_commercial",
+    type: "bool"
+  }, {
+    internalType: "bool",
+    name: "_canSublicense",
+    type: "bool"
+  }, {
+    components: [{
+      internalType: "contract ITermsProcessor",
+      name: "processor",
+      type: "address"
+    }, {
+      internalType: "bytes",
+      name: "data",
+      type: "bytes"
+    }],
+    internalType: "struct IERC5218.TermsProcessorConfig",
+    name: "_terms",
+    type: "tuple"
+  }],
+  name: "createLicense",
+  outputs: [{
+    internalType: "uint256",
+    name: "",
+    type: "uint256"
+  }],
+  stateMutability: "nonpayable",
+  type: "function"
+}, {
+  inputs: [{
+    internalType: "uint256",
+    name: "_tokenId",
+    type: "uint256"
+  }, {
+    internalType: "bool",
+    name: "_commercial",
+    type: "bool"
+  }],
+  name: "getLicenseIdByTokenId",
+  outputs: [{
+    internalType: "uint256",
+    name: "",
+    type: "uint256"
+  }],
+  stateMutability: "view",
+  type: "function"
+}];
+var IpAssetRegistry__factory = /*#__PURE__*/function () {
+  function IpAssetRegistry__factory() {
+    _classCallCheck(this, IpAssetRegistry__factory);
+  }
+  _createClass(IpAssetRegistry__factory, null, [{
+    key: "createInterface",
+    value: function createInterface() {
+      return new utils.Interface(_abi$1);
+    }
+  }, {
+    key: "connect",
+    value: function connect(address, signerOrProvider) {
+      return new Contract(address, _abi$1, signerOrProvider);
+    }
+  }]);
+  return IpAssetRegistry__factory;
+}();
+_defineProperty(IpAssetRegistry__factory, "abi", _abi$1);
+
+var _abi = [{
+  inputs: [{
+    components: [{
+      internalType: "address",
+      name: "sourceContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "sourceId",
+      type: "uint256"
+    }, {
+      internalType: "address",
+      name: "destContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "destId",
+      type: "uint256"
+    }, {
+      internalType: "bytes32",
+      name: "relationshipId",
+      type: "bytes32"
+    }, {
+      internalType: "uint256",
+      name: "ttl",
+      type: "uint256"
+    }],
+    internalType: "struct IRelationshipModule.RelationshipParams",
+    name: "params",
+    type: "tuple"
+  }, {
+    internalType: "bytes",
+    name: "data",
+    type: "bytes"
+  }],
+  name: "relate",
+  outputs: [],
+  stateMutability: "nonpayable",
+  type: "function"
+}, {
+  inputs: [{
+    components: [{
+      internalType: "address",
+      name: "sourceContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "sourceId",
+      type: "uint256"
+    }, {
+      internalType: "address",
+      name: "destContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "destId",
+      type: "uint256"
+    }, {
+      internalType: "bytes32",
+      name: "relationshipId",
+      type: "bytes32"
+    }, {
+      internalType: "uint256",
+      name: "ttl",
+      type: "uint256"
+    }],
+    internalType: "struct IRelationshipModule.RelationshipParams",
+    name: "params",
+    type: "tuple"
+  }],
+  name: "unrelate",
+  outputs: [],
+  stateMutability: "nonpayable",
+  type: "function"
+}, {
+  inputs: [{
+    components: [{
+      internalType: "address",
+      name: "sourceContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "sourceId",
+      type: "uint256"
+    }, {
+      internalType: "address",
+      name: "destContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "destId",
+      type: "uint256"
+    }, {
+      internalType: "bytes32",
+      name: "relationshipId",
+      type: "bytes32"
+    }, {
+      internalType: "uint256",
+      name: "ttl",
+      type: "uint256"
+    }],
+    internalType: "struct IRelationshipModule.RelationshipParams",
+    name: "params",
+    type: "tuple"
+  }],
+  name: "isRelationshipExpired",
+  outputs: [{
+    internalType: "bool",
+    name: "",
+    type: "bool"
+  }],
+  stateMutability: "view",
+  type: "function"
+}, {
+  inputs: [{
+    components: [{
+      internalType: "address",
+      name: "sourceContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "sourceId",
+      type: "uint256"
+    }, {
+      internalType: "address",
+      name: "destContract",
+      type: "address"
+    }, {
+      internalType: "uint256",
+      name: "destId",
+      type: "uint256"
+    }, {
+      internalType: "bytes32",
+      name: "relationshipId",
+      type: "bytes32"
+    }, {
+      internalType: "uint256",
+      name: "ttl",
+      type: "uint256"
+    }],
+    internalType: "struct IRelationshipModule.RelationshipParams",
+    name: "params",
+    type: "tuple"
+  }],
+  name: "areTheyRelated",
+  outputs: [{
+    internalType: "bool",
+    name: "",
+    type: "bool"
+  }],
+  stateMutability: "view",
+  type: "function"
+}, {
+  inputs: [{
+    internalType: "string",
+    name: "name",
+    type: "string"
+  }],
+  name: "getRelationshipId",
+  outputs: [{
+    internalType: "bytes32",
+    name: "",
+    type: "bytes32"
+  }],
+  stateMutability: "pure",
+  type: "function"
+}];
+var RelationshipModule__factory = /*#__PURE__*/function () {
+  function RelationshipModule__factory() {
+    _classCallCheck(this, RelationshipModule__factory);
+  }
+  _createClass(RelationshipModule__factory, null, [{
+    key: "createInterface",
+    value: function createInterface() {
+      return new utils.Interface(_abi);
+    }
+  }, {
+    key: "connect",
+    value: function connect(address, signerOrProvider) {
+      return new Contract(address, _abi, signerOrProvider);
+    }
+  }]);
+  return RelationshipModule__factory;
+}();
+_defineProperty(RelationshipModule__factory, "abi", _abi);
+
+/**
+ * A class representing License operations.
+ *
+ * @public
+ */
+var LicenseClient = /*#__PURE__*/function () {
+  function LicenseClient(httpClient, signer, franchiseRegistry) {
+    _classCallCheck(this, LicenseClient);
+    this.httpClient = httpClient;
+    this.signer = signer;
+    this.franchiseRegistry = franchiseRegistry;
+  }
+
+  /**
+   * Get a license by its ID.
+   *
+   * @param licenseId - The ID of the license to retrieve.
+   * @returns A Promise that resolves to the GetLicenseResponse.
+   */
+  _createClass(LicenseClient, [{
+    key: "get",
+    value: function () {
+      var _get = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              if (isIntegerString(request.licenseId)) {
+                _context.next = 3;
+                break;
+              }
+              throw new Error("Invalid licenseId. Must be an integer. But got: ".concat(request.licenseId));
+            case 3:
+              _context.next = 5;
+              return this.httpClient.get("/license/".concat(request.licenseId));
+            case 5:
+              response = _context.sent;
+              return _context.abrupt("return", response.data);
+            case 9:
+              _context.prev = 9;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to get license");
+            case 12:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 9]]);
+      }));
+      function get(_x) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+    /**
+     * List all licenses.
+     *
+     * @returns A Promise that resolves to the ListLicenseResponse.
+     */
+  }, {
+    key: "list",
+    value: function () {
+      var _list = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              _context2.next = 3;
+              return this.httpClient.get("/license?franchiseId=".concat(request.franchiseId, "&ipAssetId=").concat(request.ipAssetId));
+            case 3:
+              response = _context2.sent;
+              return _context2.abrupt("return", response.data);
+            case 7:
+              _context2.prev = 7;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to get licenses");
+            case 10:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 7]]);
+      }));
+      function list(_x2) {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+    /**
+     * Create a license within the Story Protocol based on the specified input data.
+     *
+     * @param request - An object containing the necessary data to create a license.
+     * @returns A response object containing the result of the create license action, including the transaction hash.
+     */
+  }, {
+    key: "create",
+    value: function () {
+      var _create = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(request) {
+        var defaults, franchiseId, ipAssetId, licenseURI, options, walletAddress, ipAssetRegistryAddress, ipAssetRegistry, parentLicenseId, createResponse;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              defaults = {
+                _tokenId: 0,
+                // Assuming BigNumberish can be initialized with 0
+                _parentLicenseId: "0",
+                _licenseHolder: "0x8e3B91c90561523312f32B49DAAc4AD15293De7F",
+                // An empty string for a default holder address
+                _uri: "https://example.xyz",
+                // An empty string for a default URI
+                _revoker: "0x8e3B91c90561523312f32B49DAAc4AD15293De7F",
+                // An empty string for a default revoker address
+                _commercial: false,
+                // Default to non-commercial
+                _canSublicense: false,
+                // Default to not allowing sublicense
+                _terms: {
+                  processor: constants.AddressZero,
+                  data: []
+                },
+                overrides: {
+                  // Assuming overrides is an object with properties from and gasLimit
+                  // You may need to provide default values for its properties as well
+                }
+              };
+              franchiseId = request.franchiseId, ipAssetId = request.ipAssetId, licenseURI = request.licenseURI, options = request.options; // Get Wallet address from Signer
+              _context3.next = 5;
+              return this.signer.getAddress();
+            case 5:
+              walletAddress = _context3.sent;
+              _context3.next = 8;
+              return this.franchiseRegistry.ipAssetRegistryForId(franchiseId);
+            case 8:
+              ipAssetRegistryAddress = _context3.sent;
+              // Connect to  IPAssetRegistry Contract
+              ipAssetRegistry = IpAssetRegistry__factory.connect(ipAssetRegistryAddress, this.signer); // Get parent license Id
+              _context3.next = 12;
+              return ipAssetRegistry.getLicenseIdByTokenId(ipAssetId, (options === null || options === void 0 ? void 0 : options.isCommercial) || defaults._commercial);
+            case 12:
+              parentLicenseId = _context3.sent;
+              _context3.next = 15;
+              return ipAssetRegistry.createLicense(ipAssetId, parentLicenseId, walletAddress, licenseURI, (options === null || options === void 0 ? void 0 : options.revoker) || defaults._revoker, (options === null || options === void 0 ? void 0 : options.isCommercial) || defaults._commercial, (options === null || options === void 0 ? void 0 : options.isSublicensable) || defaults._canSublicense, (options === null || options === void 0 ? void 0 : options.terms) || defaults._terms);
+            case 15:
+              createResponse = _context3.sent;
+              return _context3.abrupt("return", {
+                txHash: createResponse.hash
+              });
+            case 19:
+              _context3.prev = 19;
+              _context3.t0 = _context3["catch"](0);
+              handleError(_context3.t0, "Failed to create license");
+            case 22:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this, [[0, 19]]);
+      }));
+      function create(_x3) {
+        return _create.apply(this, arguments);
+      }
+      return create;
+    }()
+  }]);
+  return LicenseClient;
+}();
+
+/**
+ * TransactionClient allows you to view and monitor transactions on
+ * Story Protocol.
+ */
+var TransactionClient = /*#__PURE__*/function () {
+  function TransactionClient(httpClient) {
+    _classCallCheck(this, TransactionClient);
+    this.httpClient = httpClient;
+  }
+
+  /**
+   * Get transaction data based on the specified transaction id.
+   *
+   * @param request - the request object for getting the transaction
+   * @returns the response object that contains the fetched transaction object
+   */
+  _createClass(TransactionClient, [{
+    key: "get",
+    value: function () {
+      var _get = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return this.httpClient.get("/transaction/".concat(request.txId));
+            case 3:
+              response = _context.sent;
+              return _context.abrupt("return", response.data);
+            case 7:
+              _context.prev = 7;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to get transaction");
+            case 10:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 7]]);
+      }));
+      function get(_x) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+    /**
+     * Get transaction data based on the specified transaction id.
+     *
+     * @param request - the request object for getting the transactions
+     * @returns the response object that contains the fetched transaction object
+     */
+  }, {
+    key: "list",
+    value: function () {
+      var _list = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              _context2.next = 3;
+              return this.httpClient.get("/transaction");
+            case 3:
+              response = _context2.sent;
+              return _context2.abrupt("return", response.data);
+            case 7:
+              _context2.prev = 7;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to get transactions");
+            case 10:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 7]]);
+      }));
+      function list() {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+  }]);
+  return TransactionClient;
+}();
+
+/**
+ * Client for managing relationships.
+ */
+var RelationshipClient = /*#__PURE__*/function () {
+  /**
+   * Creates a new RelationshipClient instance.
+   * @param relationshipModule - The relationship module to interact with.
+   * @param franchiseRegistry - The franchise registry to interact with.
+   */
+  function RelationshipClient(relationshipModule, franchiseRegistry) {
+    _classCallCheck(this, RelationshipClient);
+    this.relationshipModule = relationshipModule;
+    this.franchiseRegistry = franchiseRegistry;
+  }
+
+  /**
+   * Retrieves the registry addresses for source and destination franchises.
+   * @param sourceFranchiseId - The ID of the source franchise.
+   * @param destFranchiseId - The ID of the destination franchise.
+   * @returns An object containing the source and destination IP registry addresses.
+   */
+  _createClass(RelationshipClient, [{
+    key: "getRegistryAddresses",
+    value: function () {
+      var _getRegistryAddresses = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(sourceFranchiseId, destFranchiseId) {
+        var sourceIpRegistryAddress, destIpRegistryAddress;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return this.franchiseRegistry.ipAssetRegistryForId(sourceFranchiseId);
+            case 3:
+              sourceIpRegistryAddress = _context.sent;
+              _context.next = 6;
+              return this.franchiseRegistry.ipAssetRegistryForId(destFranchiseId);
+            case 6:
+              destIpRegistryAddress = _context.sent;
+              return _context.abrupt("return", {
+                sourceIpRegistryAddress: sourceIpRegistryAddress,
+                destIpRegistryAddress: destIpRegistryAddress
+              });
+            case 10:
+              _context.prev = 10;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to get registry addresses");
+            case 13:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 10]]);
+      }));
+      function getRegistryAddresses(_x, _x2) {
+        return _getRegistryAddresses.apply(this, arguments);
+      }
+      return getRegistryAddresses;
+    }()
+    /**
+     * Establishes a relationship between two IP assets.
+     * @param request - The request for establishing the relationship.
+     * @returns A promise that resolves to the response with the transaction hash.
+     */
+  }, {
+    key: "relate",
+    value: function () {
+      var _relate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(request) {
+        var sourceIPAsset, destIPAsset, mockRelationshipData, _yield$this$getRegist, sourceIpRegistryAddress, destIpRegistryAddress, relationshipId, params, response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              sourceIPAsset = request.sourceIPAsset, destIPAsset = request.destIPAsset;
+              mockRelationshipData = ethers.utils.formatBytes32String(""); // Get IPAssetRegistry Contract Address
+              _context2.next = 5;
+              return this.getRegistryAddresses(sourceIPAsset.franchiseId, destIPAsset.franchiseId);
+            case 5:
+              _yield$this$getRegist = _context2.sent;
+              sourceIpRegistryAddress = _yield$this$getRegist.sourceIpRegistryAddress;
+              destIpRegistryAddress = _yield$this$getRegist.destIpRegistryAddress;
+              _context2.next = 10;
+              return this.relationshipModule.getRelationshipId("APPEARS_IN");
+            case 10:
+              relationshipId = _context2.sent;
+              params = {
+                sourceContract: sourceIpRegistryAddress,
+                sourceId: sourceIPAsset.ipAssetId,
+                destContract: destIpRegistryAddress,
+                destId: destIPAsset.ipAssetId,
+                relationshipId: relationshipId,
+                ttl: "0"
+              };
+              _context2.next = 14;
+              return this.relationshipModule.relate(params, mockRelationshipData);
+            case 14:
+              response = _context2.sent;
+              return _context2.abrupt("return", {
+                txHash: response.hash
+              });
+            case 18:
+              _context2.prev = 18;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to create relationship");
+            case 21:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 18]]);
+      }));
+      function relate(_x3) {
+        return _relate.apply(this, arguments);
+      }
+      return relate;
+    }()
+    /**
+     * Removes a relationship between two IP assets.
+     * @param request - The request for removing the relationship.
+     * @returns A promise that resolves to the response with the transaction hash.
+     */
+  }, {
+    key: "unrelate",
+    value: function () {
+      var _unrelate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(request) {
+        var sourceIPAsset, destIPAsset, _yield$this$getRegist2, sourceIpRegistryAddress, destIpRegistryAddress, relationshipId, params, response;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              sourceIPAsset = request.sourceIPAsset, destIPAsset = request.destIPAsset; // Get IPAssetRegistry Contract Address
+              _context3.next = 4;
+              return this.getRegistryAddresses(sourceIPAsset.franchiseId, destIPAsset.franchiseId);
+            case 4:
+              _yield$this$getRegist2 = _context3.sent;
+              sourceIpRegistryAddress = _yield$this$getRegist2.sourceIpRegistryAddress;
+              destIpRegistryAddress = _yield$this$getRegist2.destIpRegistryAddress;
+              _context3.next = 9;
+              return this.relationshipModule.getRelationshipId("APPEARS_IN");
+            case 9:
+              relationshipId = _context3.sent;
+              params = {
+                sourceContract: sourceIpRegistryAddress,
+                sourceId: sourceIPAsset.ipAssetId,
+                destContract: destIpRegistryAddress,
+                destId: destIPAsset.ipAssetId,
+                relationshipId: relationshipId,
+                ttl: "0"
+              };
+              _context3.next = 13;
+              return this.relationshipModule.unrelate(params);
+            case 13:
+              response = _context3.sent;
+              return _context3.abrupt("return", {
+                txHash: response.hash
+              });
+            case 17:
+              _context3.prev = 17;
+              _context3.t0 = _context3["catch"](0);
+              handleError(_context3.t0, "Failed to unrelate relationship");
+            case 20:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this, [[0, 17]]);
+      }));
+      function unrelate(_x4) {
+        return _unrelate.apply(this, arguments);
+      }
+      return unrelate;
+    }()
+    /**
+     * Checks if a relationship has expired.
+     * @param request - The request for checking the relationship's expiration status.
+     * @returns A promise that resolves to the response indicating whether the relationship has expired.
+     */
+  }, {
+    key: "isRelationshipExpired",
+    value: function () {
+      var _isRelationshipExpired = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(request) {
+        var sourceIPAsset, destIPAsset, _yield$this$getRegist3, sourceIpRegistryAddress, destIpRegistryAddress, relationshipId, params, response;
+        return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              _context4.prev = 0;
+              sourceIPAsset = request.sourceIPAsset, destIPAsset = request.destIPAsset; // Get IPAssetRegistry Contract Address
+              _context4.next = 4;
+              return this.getRegistryAddresses(sourceIPAsset.franchiseId, destIPAsset.franchiseId);
+            case 4:
+              _yield$this$getRegist3 = _context4.sent;
+              sourceIpRegistryAddress = _yield$this$getRegist3.sourceIpRegistryAddress;
+              destIpRegistryAddress = _yield$this$getRegist3.destIpRegistryAddress;
+              _context4.next = 9;
+              return this.relationshipModule.getRelationshipId("APPEARS_IN");
+            case 9:
+              relationshipId = _context4.sent;
+              params = {
+                sourceContract: sourceIpRegistryAddress,
+                sourceId: sourceIPAsset.ipAssetId,
+                destContract: destIpRegistryAddress,
+                destId: destIPAsset.ipAssetId,
+                relationshipId: relationshipId,
+                ttl: "0"
+              };
+              _context4.next = 13;
+              return this.relationshipModule.isRelationshipExpired(params);
+            case 13:
+              response = _context4.sent;
+              return _context4.abrupt("return", {
+                result: response
+              });
+            case 17:
+              _context4.prev = 17;
+              _context4.t0 = _context4["catch"](0);
+              handleError(_context4.t0, "Failed to get isRelationshipExpired");
+            case 20:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this, [[0, 17]]);
+      }));
+      function isRelationshipExpired(_x5) {
+        return _isRelationshipExpired.apply(this, arguments);
+      }
+      return isRelationshipExpired;
+    }()
+    /**
+     * Checks if two IP assets are related.
+     * @param request - The request for checking the relationship between two IP assets.
+     * @returns A promise that resolves to the response indicating whether the IP assets are related.
+     */
+  }, {
+    key: "isRelated",
+    value: function () {
+      var _isRelated = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(request) {
+        var sourceIPAsset, destIPAsset, _yield$this$getRegist4, sourceIpRegistryAddress, destIpRegistryAddress, relationshipId, params, response;
+        return _regeneratorRuntime().wrap(function _callee5$(_context5) {
+          while (1) switch (_context5.prev = _context5.next) {
+            case 0:
+              _context5.prev = 0;
+              sourceIPAsset = request.sourceIPAsset, destIPAsset = request.destIPAsset; // Get IPAssetRegistry Contract Address
+              _context5.next = 4;
+              return this.getRegistryAddresses(sourceIPAsset.franchiseId, destIPAsset.franchiseId);
+            case 4:
+              _yield$this$getRegist4 = _context5.sent;
+              sourceIpRegistryAddress = _yield$this$getRegist4.sourceIpRegistryAddress;
+              destIpRegistryAddress = _yield$this$getRegist4.destIpRegistryAddress;
+              _context5.next = 9;
+              return this.relationshipModule.getRelationshipId("APPEARS_IN");
+            case 9:
+              relationshipId = _context5.sent;
+              params = {
+                sourceContract: sourceIpRegistryAddress,
+                sourceId: sourceIPAsset.ipAssetId,
+                destContract: destIpRegistryAddress,
+                destId: destIPAsset.ipAssetId,
+                relationshipId: relationshipId,
+                ttl: "0"
+              };
+              _context5.next = 13;
+              return this.relationshipModule.areTheyRelated(params);
+            case 13:
+              response = _context5.sent;
+              return _context5.abrupt("return", {
+                result: response
+              });
+            case 17:
+              _context5.prev = 17;
+              _context5.t0 = _context5["catch"](0);
+              handleError(_context5.t0, "Failed to get isRelated");
+            case 20:
+            case "end":
+              return _context5.stop();
+          }
+        }, _callee5, this, [[0, 17]]);
+      }));
+      function isRelated(_x6) {
+        return _isRelated.apply(this, arguments);
+      }
+      return isRelated;
+    }()
+  }]);
+  return RelationshipClient;
+}();
+
+/**
+ * IpAssetClient allows you to create, view, and list IP Assets on Story Protocol.
+ */
+var IpAssetClient = /*#__PURE__*/function () {
+  function IpAssetClient(httpClient, franchiseRegistry, signer) {
+    _classCallCheck(this, IpAssetClient);
+    this.httpClient = httpClient;
+    this.franchiseRegistry = franchiseRegistry;
+    this.signer = signer;
+  }
+
+  /**
+   * Get the ipAssetRegistry associated with a franchiseId.
+   *
+   * @returns the response object that contains the requested ipAssetRegistry.
+   */
+  _createClass(IpAssetClient, [{
+    key: "getRegistry",
+    value: function () {
+      var _getRegistry = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(franchiseId) {
+        var address, ipAssetRegistry;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return this.franchiseRegistry.ipAssetRegistryForId(franchiseId);
+            case 3:
+              address = _context.sent;
+              ipAssetRegistry = IpAssetRegistry__factory.connect(address, this.signer);
+              return _context.abrupt("return", ipAssetRegistry);
+            case 8:
+              _context.prev = 8;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to retrieve IP Asset Registry");
+            case 11:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 8]]);
+      }));
+      function getRegistry(_x) {
+        return _getRegistry.apply(this, arguments);
+      }
+      return getRegistry;
+    }()
+    /**
+     * Get an IP Asset based on the specified IP asset ID.
+     *
+     * @param request - the request object for getting an IP Asset.
+     * @returns the response object the contains the fetched IP Asset.
+     */
+  }, {
+    key: "get",
+    value: function () {
+      var _get = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              if (isIntegerString(request.ipAssetId)) {
+                _context2.next = 3;
+                break;
+              }
+              throw new Error("Invalid IP Asset id. Must be an integer. But get: ".concat(request.ipAssetId));
+            case 3:
+              _context2.next = 5;
+              return this.httpClient.get("/ipasset/".concat(request.ipAssetId, "?franchiseId=").concat(request.franchiseId));
+            case 5:
+              response = _context2.sent;
+              return _context2.abrupt("return", response.data);
+            case 9:
+              _context2.prev = 9;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to get IP Asset");
+            case 12:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 9]]);
+      }));
+      function get(_x2) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+    /**
+     * Create an IP Asset on Story Protocol based on the specified input asset data.
+     *
+     * @param request - the request object that contains all data needed to create an IP Asset.
+     * @returns the response object that contains results from the asset creation.
+     */
+  }, {
+    key: "create",
+    value: function () {
+      var _create = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(request) {
+        var franchiseId, ipAssetRegistry, response;
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              franchiseId = request.franchiseId;
+              if (isIntegerString(franchiseId)) {
+                _context3.next = 4;
+                break;
+              }
+              throw new Error("Invalid franchise ID for IP asset creation. Must be an integer, but got: ".concat(request.franchiseId));
+            case 4:
+              _context3.next = 6;
+              return this.getRegistry(franchiseId);
+            case 6:
+              ipAssetRegistry = _context3.sent;
+              _context3.next = 9;
+              return ipAssetRegistry.createIPAsset(request.ipAssetType, request.ipAssetName, request.description, request.mediaUrl, request.to, request.parentIpAssetId);
+            case 9:
+              response = _context3.sent;
+              return _context3.abrupt("return", {
+                txHash: response.hash
+              });
+            case 13:
+              _context3.prev = 13;
+              _context3.t0 = _context3["catch"](0);
+              handleError(_context3.t0, "Failed to create IP Asset");
+            case 16:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this, [[0, 13]]);
+      }));
+      function create(_x3) {
+        return _create.apply(this, arguments);
+      }
+      return create;
+    }()
+    /**
+     * List all IP assets.
+     *
+     * @returns the response object that contains results from listing query.
+     */
+  }, {
+    key: "list",
+    value: function () {
+      var _list = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              _context4.prev = 0;
+              _context4.next = 3;
+              return this.httpClient.get("/ipasset?franchiseId=".concat(request.franchiseId));
+            case 3:
+              response = _context4.sent;
+              return _context4.abrupt("return", response.data);
+            case 7:
+              _context4.prev = 7;
+              _context4.t0 = _context4["catch"](0);
+              handleError(_context4.t0, "Failed to list IP Asset.");
+            case 10:
+            case "end":
+              return _context4.stop();
+          }
+        }, _callee4, this, [[0, 7]]);
+      }));
+      function list(_x4) {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+  }]);
+  return IpAssetClient;
+}();
+
+/**
+ * Default timeout value for http clients.
+ */
+var HTTP_TIMEOUT = 1000;
+
+var CollectClient = /*#__PURE__*/function () {
+  function CollectClient(httpClient, signer, collectModule) {
+    _classCallCheck(this, CollectClient);
+    this.httpClient = httpClient;
+    this.signer = signer;
+    this.collectModuleContract = collectModule;
+  }
+
+  /**
+   * List all collected IP Assets.
+   *
+   * @returns A Promise that resolves to the ListLicenseResponse.
+   */
+  _createClass(CollectClient, [{
+    key: "list",
+    value: function () {
+      var _list = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.prev = 0;
+              _context.next = 3;
+              return this.httpClient.get("/collection?franchiseId=".concat(request.franchiseId));
+            case 3:
+              response = _context.sent;
+              return _context.abrupt("return", response.data);
+            case 7:
+              _context.prev = 7;
+              _context.t0 = _context["catch"](0);
+              handleError(_context.t0, "Failed to get collections");
+            case 10:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[0, 7]]);
+      }));
+      function list(_x) {
+        return _list.apply(this, arguments);
+      }
+      return list;
+    }()
+    /**
+     * Collect an IP Asset on Story Protocol based on the specified input collect data.
+     *
+     * @param request - the request object that contains all data needed to collect an IP Asset
+     * @returns the response object that contains results from the create franchise action
+     */
+  }, {
+    key: "collect",
+    value: function () {
+      var _collect = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(request) {
+        var response;
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.prev = 0;
+              _context2.next = 3;
+              return this.collectModuleContract.collect({
+                franchiseId: request.franchiseId,
+                ipAssetId: request.ipAssetId,
+                collector: request.collector,
+                collectData: "0x",
+                collectNFTInitData: "0x",
+                collectNFTData: "0x"
+              });
+            case 3:
+              response = _context2.sent;
+              return _context2.abrupt("return", {
+                txHash: response.hash
+              });
+            case 7:
+              _context2.prev = 7;
+              _context2.t0 = _context2["catch"](0);
+              handleError(_context2.t0, "Failed to collect IP Asset");
+            case 10:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[0, 7]]);
+      }));
+      function collect(_x2) {
+        return _collect.apply(this, arguments);
+      }
+      return collect;
+    }()
+  }]);
+  return CollectClient;
+}();
+
+dotenv.config();
+/**
+ * The StoryClient is the main entry point for the SDK.
+ */
+var StoryClient = /*#__PURE__*/function () {
+  /**
+   * @param config - the configuration for the SDK client
+   */
+  function StoryClient(config) {
+    _classCallCheck(this, StoryClient);
+    _defineProperty(this, "_franchise", null);
+    _defineProperty(this, "_relationship", null);
+    _defineProperty(this, "_ipAsset", null);
+    _defineProperty(this, "_license", null);
+    _defineProperty(this, "_transaction", null);
+    _defineProperty(this, "_collect", null);
+    if (config.environment !== Environment.TEST) {
+      throw new Error("Invalid Environment: Only TEST environment is supported");
+    }
+    this.config = config;
+    this.httpClient = axios.create({
+      baseURL: process.env.API_BASE_URL,
+      timeout: HTTP_TIMEOUT
+    });
+  }
+
+  /**
+   * Getter for the franchise client. The client is lazily created when
+   * this method is called.
+   *
+   * @returns the FranchiseClient instance
+   */
+  _createClass(StoryClient, [{
+    key: "franchise",
+    get: function get() {
+      if (this._franchise === null) {
+        var franchiseRegistry = FranchiseRegistry__factory.connect(process.env.FRANCHISE_REGISTRY_CONTRACT, this.config.signer);
+        var licenseModule = LicensingModule__factory.connect(process.env.LICENSING_MODULE_CONTRACT, this.config.signer);
+        this._franchise = new FranchiseClient(this.httpClient, franchiseRegistry, licenseModule);
+      }
+      return this._franchise;
+    }
+
+    /**
+     * Getter for the relationship client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the RelationshipClient instance
+     */
+  }, {
+    key: "relationship",
+    get: function get() {
+      if (this._relationship === null) {
+        var franchiseRegistry = FranchiseRegistry__factory.connect(process.env.FRANCHISE_REGISTRY_CONTRACT, this.config.signer);
+        var relationshipModule = RelationshipModule__factory.connect(process.env.RELATIONSHIP_MODULE_CONTRACT, this.config.signer);
+        this._relationship = new RelationshipClient(relationshipModule, franchiseRegistry);
+      }
+      return this._relationship;
+    }
+
+    /**
+     * Getter for the IP Asset client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the IpAssetClient instance
+     */
+  }, {
+    key: "ipAsset",
+    get: function get() {
+      if (this._ipAsset === null) {
+        var franchiseRegistry = FranchiseRegistry__factory.connect(process.env.FRANCHISE_REGISTRY_CONTRACT, this.config.signer);
+        this._ipAsset = new IpAssetClient(this.httpClient, franchiseRegistry, this.config.signer);
+      }
+      return this._ipAsset;
+    }
+
+    /**
+     * Getter for the license client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the FranchiseClient instance
+     */
+  }, {
+    key: "license",
+    get: function get() {
+      if (this._license === null) {
+        var franchiseRegistry = FranchiseRegistry__factory.connect(process.env.FRANCHISE_REGISTRY_CONTRACT, this.config.signer);
+        this._license = new LicenseClient(this.httpClient, this.config.signer, franchiseRegistry);
+      }
+      return this._license;
+    }
+
+    /**
+     * Getter for the transaction client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the TransactionClient instance
+     */
+  }, {
+    key: "transaction",
+    get: function get() {
+      if (this._transaction === null) {
+        this._transaction = new TransactionClient(this.httpClient);
+      }
+      return this._transaction;
+    }
+
+    /**
+     * Getter for the collect module client. The client is lazily created when
+     * this method is called.
+     *
+     * @returns the CollectClient instance
+     */
+  }, {
+    key: "collect",
+    get: function get() {
+      if (this._collect === null) {
+        var collectModule = CollectModule__factory.connect(process.env.COLLECT_MODULE_CONTRACT, this.config.signer);
+        this._collect = new CollectClient(this.httpClient, this.config.signer, collectModule);
+      }
+      return this._collect;
+    }
+  }]);
+  return StoryClient;
+}();
+
+export { Environment, StoryClient };