@story-protocol/core-sdk 1.0.0-rc.17 → 1.0.0-rc.18

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

@@ -478,9 +478,9 @@ function _asyncToGenerator(fn) {
   };
 }
 
-var storyTestChain = defineChain({
+var iliad = defineChain({
   id: 1513,
-  name: "story-testnet",
+  name: "iliad",
   nativeCurrency: {
     name: "IP",
     symbol: "IP",
@@ -510,7 +510,7 @@ function chainStringToViemChain(chainId) {
   switch (chainId) {
     case "1513":
     case "iliad":
-      return storyTestChain;
+      return iliad;
     default:
       throw new Error("chainId ".concat(chainId, " not supported"));
   }
@@ -9300,6 +9300,22 @@ var spgAbi = [{
   type: "error",
   inputs: [],
   name: "NotInitializing"
+}, {
+  type: "error",
+  inputs: [{
+    name: "tokenId",
+    internalType: "uint256",
+    type: "uint256"
+  }, {
+    name: "caller",
+    internalType: "address",
+    type: "address"
+  }, {
+    name: "actualTokenOwner",
+    internalType: "address",
+    type: "address"
+  }],
+  name: "SPG__CallerAndNotTokenOwner"
 }, {
   type: "error",
   inputs: [],
@@ -9613,7 +9629,7 @@ var spgAbi = [{
       internalType: "address",
       type: "address"
     }, {
-      name: "mintingFee",
+      name: "defaultMintingFee",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -9641,7 +9657,7 @@ var spgAbi = [{
       internalType: "uint32",
       type: "uint32"
     }, {
-      name: "commercialRevCelling",
+      name: "commercialRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -9661,7 +9677,7 @@ var spgAbi = [{
       internalType: "bool",
       type: "bool"
     }, {
-      name: "derivativeRevCelling",
+      name: "derivativeRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -9804,6 +9820,32 @@ var spgAbi = [{
     type: "uint256"
   }],
   stateMutability: "nonpayable"
+}, {
+  type: "function",
+  inputs: [{
+    name: "",
+    internalType: "address",
+    type: "address"
+  }, {
+    name: "",
+    internalType: "address",
+    type: "address"
+  }, {
+    name: "",
+    internalType: "uint256",
+    type: "uint256"
+  }, {
+    name: "",
+    internalType: "bytes",
+    type: "bytes"
+  }],
+  name: "onERC721Received",
+  outputs: [{
+    name: "",
+    internalType: "bytes4",
+    type: "bytes4"
+  }],
+  stateMutability: "nonpayable"
 }, {
   type: "function",
   inputs: [],
@@ -9906,7 +9948,7 @@ var spgAbi = [{
       internalType: "address",
       type: "address"
     }, {
-      name: "mintingFee",
+      name: "defaultMintingFee",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -9934,7 +9976,7 @@ var spgAbi = [{
       internalType: "uint32",
       type: "uint32"
     }, {
-      name: "commercialRevCelling",
+      name: "commercialRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -9954,7 +9996,7 @@ var spgAbi = [{
       internalType: "bool",
       type: "bool"
     }, {
-      name: "derivativeRevCelling",
+      name: "derivativeRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -10198,7 +10240,7 @@ var spgAbi = [{
       internalType: "address",
       type: "address"
     }, {
-      name: "mintingFee",
+      name: "defaultMintingFee",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -10226,7 +10268,7 @@ var spgAbi = [{
       internalType: "uint32",
       type: "uint32"
     }, {
-      name: "commercialRevCelling",
+      name: "commercialRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -10246,7 +10288,7 @@ var spgAbi = [{
       internalType: "bool",
       type: "bool"
     }, {
-      name: "derivativeRevCelling",
+      name: "derivativeRevCeiling",
       internalType: "uint256",
       type: "uint256"
     }, {
@@ -18910,11 +18952,7 @@ var IPAssetClient = /*#__PURE__*/function () {
               object = {
                 nftContract: getAddress$1(request.nftContract, "request.nftContract"),
                 recipient: request.recipient && getAddress$1(request.recipient, "request.recipient") || this.wallet.account.address,
-                terms: _objectSpread2(_objectSpread2({}, licenseTerm), {}, {
-                  mintingFee: BigInt(licenseTerm.defaultMintingFee),
-                  derivativeRevCelling: licenseTerm.commercialRevCeiling,
-                  commercialRevCelling: licenseTerm.commercialRevCeiling
-                }),
+                terms: licenseTerm,
                 ipMetadata: {
                   metadataURI: "",
                   metadataHash: zeroHash,
@@ -19063,11 +19101,7 @@ var IPAssetClient = /*#__PURE__*/function () {
               object = {
                 nftContract: getAddress$1(request.nftContract, "request.nftContract"),
                 tokenId: request.tokenId,
-                terms: _objectSpread2(_objectSpread2({}, licenseTerm), {}, {
-                  mintingFee: BigInt(licenseTerm.defaultMintingFee),
-                  derivativeRevCelling: licenseTerm.commercialRevCeiling,
-                  commercialRevCelling: licenseTerm.commercialRevCeiling
-                }),
+                terms: licenseTerm,
                 ipMetadata: {
                   metadataURI: "",
                   metadataHash: zeroHash,
@@ -19370,31 +19404,160 @@ var IPAssetClient = /*#__PURE__*/function () {
         return _registerDerivativeIp.apply(this, arguments);
       }
       return registerDerivativeIp;
+    }()
+    /**
+     * Mint an NFT from a collection and register it as a derivative IP without license tokens.
+     * @param request - The request object that contains all data needed to mint and register ip and make derivative.
+     *   @param request.nftContract The address of the NFT collection.
+     *   @param request.derivData The derivative data to be used for registerDerivative.
+     *   @param request.derivData.parentIpIds The IDs of the parent IPs to link the registered derivative IP.
+     *   @param request.derivData.licenseTermsIds The IDs of the license terms to be used for the linking.
+     *   @param request.derivData.licenseTemplate [Optional] The address of the license template to be used for the linking.
+     *   @param request.ipMetadata - [Optional] The desired ipMetadata for the newly registered IP.
+     *   @param request.ipMetadata.metadataURI [Optional] The URI of the ipMetadata for the IP.
+     *   @param request.ipMetadata.metadataHash [Optional] The ipMetadata for the IP.
+     *   @param request.ipMetadata.nftMetadataHash [Optional] The the ipMetadata for the IP NFT.
+     *   @param request.recipient [Optional] The address of the recipient of the minted NFT.
+     *   @param request.txOptions [Optional] The transaction options.
+     * @returns A Promise that resolves to an object containing the transaction hash and optional IP ID if waitForTxn is set to true.
+     * @emits IPRegistered (ipId, chainId, tokenContract, tokenId, name, uri, registrationDate)
+     */
+    )
+  }, {
+    key: "mintAndRegisterIpAndMakeDerivative",
+    value: (function () {
+      var _mintAndRegisterIpAndMakeDerivative = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(request) {
+        var _request$txOptions13, i, isAttachedLicenseTerms, object, _request$txOptions14, txHash, receipt, log;
+        return _regeneratorRuntime().wrap(function _callee7$(_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
+            case 0:
+              _context7.prev = 0;
+              if (!(request.derivData.parentIpIds.length !== request.derivData.licenseTermsIds.length)) {
+                _context7.next = 3;
+                break;
+              }
+              throw new Error("Parent IP IDs and License terms IDs must be provided in pairs.");
+            case 3:
+              i = 0;
+            case 4:
+              if (!(i < request.derivData.parentIpIds.length)) {
+                _context7.next = 13;
+                break;
+              }
+              _context7.next = 7;
+              return this.licenseRegistryReadOnlyClient.hasIpAttachedLicenseTerms({
+                ipId: getAddress$1(request.derivData.parentIpIds[i], "request.derivData.parentIpIds"),
+                licenseTemplate: request.derivData.licenseTemplate && getAddress$1(request.derivData.licenseTemplate, "request.derivData.licenseTemplate") || this.licenseTemplateClient.address,
+                licenseTermsId: BigInt(request.derivData.licenseTermsIds[i])
+              });
+            case 7:
+              isAttachedLicenseTerms = _context7.sent;
+              if (isAttachedLicenseTerms) {
+                _context7.next = 10;
+                break;
+              }
+              throw new Error("License terms id ".concat(request.derivData.licenseTermsIds[i], " must be attached to the parent ipId ").concat(request.derivData.parentIpIds[i], " before registering derivative."));
+            case 10:
+              i++;
+              _context7.next = 4;
+              break;
+            case 13:
+              object = _objectSpread2(_objectSpread2({}, request), {}, {
+                derivData: _objectSpread2(_objectSpread2({}, request.derivData), {}, {
+                  royaltyContext: zeroAddress,
+                  licenseTemplate: request.derivData.licenseTemplate || this.licenseTemplateClient.address,
+                  licenseTermsIds: request.derivData.licenseTermsIds.map(function (id) {
+                    return BigInt(id);
+                  })
+                }),
+                nftMetadata: request.nftMetadata || "",
+                ipMetadata: {
+                  metadataURI: "",
+                  metadataHash: zeroHash,
+                  nftMetadataHash: zeroHash
+                },
+                recipient: request.recipient && getAddress$1(request.recipient, "request.recipient") || this.wallet.account.address
+              });
+              if (request.ipMetadata && (request.ipMetadata.metadataHash !== zeroHash || request.ipMetadata.metadataURI !== "" || request.ipMetadata.nftMetadataHash !== zeroHash)) {
+                object.ipMetadata = {
+                  metadataURI: request.ipMetadata.metadataURI || object.ipMetadata.metadataURI,
+                  metadataHash: request.ipMetadata.metadataHash || object.ipMetadata.metadataHash,
+                  nftMetadataHash: request.ipMetadata.nftMetadataHash || object.ipMetadata.nftMetadataHash
+                };
+              }
+              if (!((_request$txOptions13 = request.txOptions) !== null && _request$txOptions13 !== void 0 && _request$txOptions13.encodedTxDataOnly)) {
+                _context7.next = 19;
+                break;
+              }
+              return _context7.abrupt("return", {
+                encodedTxData: this.spgClient.mintAndRegisterIpAndMakeDerivativeEncode(object)
+              });
+            case 19:
+              _context7.next = 21;
+              return this.spgClient.mintAndRegisterIpAndMakeDerivative(object);
+            case 21:
+              txHash = _context7.sent;
+              if (!((_request$txOptions14 = request.txOptions) !== null && _request$txOptions14 !== void 0 && _request$txOptions14.waitForTransaction)) {
+                _context7.next = 28;
+                break;
+              }
+              _context7.next = 25;
+              return this.rpcClient.waitForTransactionReceipt({
+                hash: txHash
+              });
+            case 25:
+              receipt = _context7.sent;
+              log = this.ipAssetRegistryClient.parseTxIpRegisteredEvent(receipt)[0];
+              return _context7.abrupt("return", {
+                txHash: txHash,
+                childIpId: log.ipId
+              });
+            case 28:
+              return _context7.abrupt("return", {
+                txHash: txHash
+              });
+            case 29:
+              _context7.next = 34;
+              break;
+            case 31:
+              _context7.prev = 31;
+              _context7.t0 = _context7["catch"](0);
+              handleError(_context7.t0, "Failed to mint and register IP and make derivative");
+            case 34:
+            case "end":
+              return _context7.stop();
+          }
+        }, _callee7, this, [[0, 31]]);
+      }));
+      function mintAndRegisterIpAndMakeDerivative(_x7) {
+        return _mintAndRegisterIpAndMakeDerivative.apply(this, arguments);
+      }
+      return mintAndRegisterIpAndMakeDerivative;
     }())
   }, {
     key: "getIpIdAddress",
     value: function () {
-      var _getIpIdAddress = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee7(nftContract, tokenId) {
+      var _getIpIdAddress = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee8(nftContract, tokenId) {
         var ipId;
-        return _regeneratorRuntime().wrap(function _callee7$(_context7) {
-          while (1) switch (_context7.prev = _context7.next) {
+        return _regeneratorRuntime().wrap(function _callee8$(_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
             case 0:
-              _context7.next = 2;
+              _context8.next = 2;
               return this.ipAssetRegistryClient.ipId({
                 chainId: chain[this.chainId],
                 tokenContract: getAddress$1(nftContract, "nftContract"),
                 tokenId: BigInt(tokenId)
               });
             case 2:
-              ipId = _context7.sent;
-              return _context7.abrupt("return", ipId);
+              ipId = _context8.sent;
+              return _context8.abrupt("return", ipId);
             case 4:
             case "end":
-              return _context7.stop();
+              return _context8.stop();
           }
-        }, _callee7, this);
+        }, _callee8, this);
       }));
-      function getIpIdAddress(_x7, _x8) {
+      function getIpIdAddress(_x8, _x9) {
         return _getIpIdAddress.apply(this, arguments);
       }
       return getIpIdAddress;
@@ -19402,23 +19565,23 @@ var IPAssetClient = /*#__PURE__*/function () {
   }, {
     key: "isRegistered",
     value: function () {
-      var _isRegistered = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee8(ipId) {
-        return _regeneratorRuntime().wrap(function _callee8$(_context8) {
-          while (1) switch (_context8.prev = _context8.next) {
+      var _isRegistered = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee9(ipId) {
+        return _regeneratorRuntime().wrap(function _callee9$(_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
             case 0:
-              _context8.next = 2;
+              _context9.next = 2;
               return this.ipAssetRegistryClient.isRegistered({
                 id: getAddress$1(ipId, "ipId")
               });
             case 2:
-              return _context8.abrupt("return", _context8.sent);
+              return _context9.abrupt("return", _context9.sent);
             case 3:
             case "end":
-              return _context8.stop();
+              return _context9.stop();
           }
-        }, _callee8, this);
+        }, _callee9, this);
       }));
-      function isRegistered(_x9) {
+      function isRegistered(_x10) {
         return _isRegistered.apply(this, arguments);
       }
       return isRegistered;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@story-protocol/core-sdk",
-  "version": "1.0.0-rc.17",
+  "version": "1.0.0-rc.18",
   "description": "Story Protocol Core SDK",
   "main": "dist/story-protocol-core-sdk.cjs.js",
   "module": "dist/story-protocol-core-sdk.esm.js",