🪝 Hooks

1. Licensing Hooks: 라이선스 토큰을 발행하기 전에 사용자 정의 로직을 추가할 수 있게 해줍니다(및 파생물 등록). 예를 들어, 동적 가격 요청, 발행 가능한 라이선스 토큰 수 제한, 화이트리스트 등이 있습니다. Licensing Hooks는 언제든지 licensing config에서 추가/수정할 수 있습니다.
2. Commercializer Checker Hooks: Licensing Hooks와 유사하지만, 직접적으로 라이선스 조건의 일부이며 변경되지 않습니다. 또한 사용자 정의 발행 수수료를 반환할 수도 없습니다.

​

Licensing Hooks

/// @notice This function is called when the LicensingModule mints license tokens.
/// @dev The hook can be used to implement various checks and determine the minting price.
/// The hook should revert if the minting is not allowed.
/// @param caller The address of the caller who calling the mintLicenseTokens() function.
/// @param licensorIpId The ID of licensor IP from which issue the license tokens.
/// @param licenseTemplate The address of the license template.
/// @param licenseTermsId The ID of the license terms within the license template,
/// which is used to mint license tokens.
/// @param amount The amount of license tokens to mint.
/// @param receiver The address of the receiver who receive the license tokens.
/// @param hookData The data to be used by the licensing hook.
/// @return totalMintingFee The total minting fee to be paid when minting amount of license tokens.
function beforeMintLicenseTokens(
  address caller,
  address licensorIpId,
  address licenseTemplate,
  uint256 licenseTermsId,
  uint256 amount,
  address receiver,
  bytes calldata hookData
) external returns (uint256 totalMintingFee);

​

사용 가능한 Hooks

​

Hooks 구현하기

import { LicensingConfig } from '@story-protocol/core-sdk';

const licensingConfig: LicensingConfig = {
    isSet: true,
    mintingFee: 0n,
    // address of TotalLicenseTokenLimitHook
    // from https://docs.datafdn.org/developers/deployed-smart-contracts
    licensingHook: '0xaBAD364Bfa41230272b08f171E0Ca939bD600478',
    hookData: zeroAddress,
    commercialRevShare: 0,
    disabled: false,
    expectMinimumGroupRewardShare: 0,
    expectGroupRewardPool: zeroAddress,
}

const response = await client.ipAsset.registerIpAsset({
    nft: {
        type: 'mint',
        spgNftContract: '0xc32A8a0FF3beDDDa58393d022aF433e78739FAbc', // public spg contract for ease-of-use
    },
    licenseTermsData: [
        {
            terms: { defaultMintingFee: 0, commercialUse: true, ... }, // dummy license terms
            // set the licensing config here
            licensingConfig: licensingConfig
        },
    ],
    ipMetadata: {
        ipMetadataURI: 'test-uri',
        ipMetadataHash: toHex('test-metadata-hash', { size: 32 }),
        nftMetadataHash: toHex('test-nft-metadata-hash', { size: 32 }),
        nftMetadataURI: 'test-nft-uri',
    }
})

console.log(`Token ID: ${response.tokenId}, IPA ID: ${response.ipId}, License Terms ID: ${response.licenseTermsIds}`);

const hookResponse = await client.license.setMaxLicenseTokens({
  ipId: response.ipId,
  licenseTermsId: response.licenseTermsIds![0],
  maxLicenseTokens: 1000,
});

console.log(`Max license tokens set at transaction hash ${hookResponse.txHash}`);

​

새로운 Licensing Hook 생성

1. Hook 개발: 이 템플릿 저장소를 포크하여 개발을 부트스트랩할 수 있습니다. 우리 Aeneid 프로토콜에 대한 테스트와 함께 예시 hook가 포함되어 있지만, 사용은 선택 사항입니다.
   LicenseCallerWhitelistHook.sol hook를 개발하는 데 사용된 예시로 license-caller-whitelist-hook을 참조하세요.
2. Registered Modules 저장소 포크: registered-modules 저장소를 자신의 GitHub 계정으로 포크하세요.
3. Module 목록 업데이트: registered-modules 저장소에서 hook-modules.json 파일에 hook의 세부 정보를 추가하세요. aeneid 및 mainnet 모두에 hook를 배포 및 블록 익스플로러에서 검증해야 합니다. 다음 JSON 구조를 준수하는지 확인하세요:
   {
     "name": "YourModuleName",
     "aeneid": {
       "address": "YourModuleAddress",
       "blockExplorerLink": "YourModuleBlockExplorerLink"
     },
     "mainnet": {
       "address": "YourModuleAddress",
       "blockExplorerLink": "YourModuleBlockExplorerLink"
     }
   }
   
   YourModuleName, YourModuleAddress, YourModuleBlockExplorerLink를 각각 hook의 이름, 주소, 블록 익스플로러 페이지 링크로 바꾸세요. 예시:
   {
     "name": "LicenseCallerWhitelistHook",
     "aeneid": {
       "address": "0x37be56d9fb06d885cda3cb010096c94c28b4d658",
       "blockExplorerLink": "https://aeneid.datanetscan.io/address/0x37be56d9fb06d885cda3cb010096c94c28b4d658?tab=contract"
     },
     "mainnet": {
       "address": "0x6d9d51a444c8318e8840e75dab7ed81b5a714610",
       "blockExplorerLink": "https://www.datanetscan.io/address/0x6d9d51a444c8318e8840e75dab7ed81b5a714610?tab=contract"
     }
   }
   
4. Pull Request (PR) 생성: hook를 추가한 후, 이 저장소에 대해 pull request를 생성하세요. PR 설명에 다음 정보를 추가하세요(값은 본인의 것으로 바꾸세요):
   ## Register my module
   
   - Module type: `hook`
   - Module name: `LicenseCallerWhitelistHook`
   - Aeneid Module address: `0x37be56d9fb06d885cda3cb010096c94c28b4d658`
   - Mainnet Module address: `0x6d9d51a444c8318e8840e75dab7ed81b5a714610`
   - My module is immutable: yes
   - My module is using an upgradeable proxy: no
   - My module has been verified on the block explorer (required): yes
   - Summary of my module: Hook for allowing a licensor to gate which addresses can mint a license. The licensor can add/remove an address at any time.
   - GitHub repository with source code and tests: https://github.com/jacob-tucker/license-caller-whitelist-hook
   
5. 검증 대기: PR이 제출되면 검토됩니다. 보안 감사가 수행 및 완료되고 모듈이 프로토콜에 화이트리스트로 등록되면, PR이 병합됩니다. 이 시점에서 모듈은 공식적으로 등록되고 DATA Foundation 커뮤니티에서 사용하기에 안전한 것으로 인정됩니다.

​

Commercializer Checker Hooks