Group

​

GroupClient

​

메서드

• registerGroup
• mintAndRegisterIpAndAttachLicenseAndAddToGroup
• registerIpAndAttachLicenseAndAddToGroup
• registerGroupAndAttachLicense
• registerGroupAndAttachLicenseAndAddIps
• collectAndDistributeGroupRoyalties

​

registerGroup

그룹 IPA를 등록합니다.

Parameters:

• request.groupPool: 그룹 내 IP 풀 간의 로열티 분배 방식을 지정하는 주소.
• request.txOptions: [선택사항] 트랜잭션 options.

export type RegisterGroupResponse = {
  txHash?: string;
  encodedTxData?: EncodedTxData;
  groupId?: Address;
};

​

mintAndRegisterIpAndAttachLicenseAndAddToGroup

SPGNFT 컬렉션에서 NFT를 발행하고, 메타데이터와 함께 IP로 등록하고, 등록된 IP에 라이센스 조건을 첨부하고, 그룹 IP에 추가합니다.

Parameters:

• request.nftContract: NFT 컬렉션의 주소.
• request.groupId: 새로 등록된 IP를 추가할 그룹 IP의 ID.
• request.licenseTermsId: 새 IP에 첨부될 등록된 라이센스 조건의 ID.
• request.recipient: [선택사항] 발행된 NFT의 수신자 주소, 기본값은 귀하의 지갑 주소입니다.
• request.licenseTemplate: [선택사항] 새 그룹 IP에 첨부될 라이센스 템플릿의 주소, 기본값은 Programmable IP License입니다.
• request.deadline: [선택사항] 서명의 유효 기간(밀리초), 기본값은 1000ms입니다.
• request.ipMetadata: [선택사항] 새로 발행된 NFT와 새로 등록된 IP에 대한 원하는 메타데이터.
  • request.ipMetadata.ipMetadataURI [선택사항] IP의 메타데이터 URI.
  • request.ipMetadata.ipMetadataHash [선택사항] IP의 메타데이터 해시.
  • request.ipMetadata.nftMetadataURI [선택사항] NFT의 메타데이터 URI.
  • request.ipMetadata.nftMetadataHash [선택사항] IP NFT의 메타데이터 해시.
• request.txOptions: [선택사항] 트랜잭션 options.

export type MintAndRegisterIpAndAttachLicenseAndAddToGroupResponse = {
  txHash?: string;
  encodedTxData?: EncodedTxData;
  ipId?: Address;
  tokenId?: bigint;
};

​

registerIpAndAttachLicenseAndAddToGroup

NFT를 메타데이터와 함께 IP로 등록하고, 등록된 IP에 라이센스 조건을 첨부하고, 그룹 IP에 추가합니다.

Parameters:

• request.spgNftContract: NFT 컬렉션의 주소.
• request.tokenId: NFT의 ID.
• request.groupId: 새로 등록된 IP를 추가할 그룹 IP의 ID.
• request.licenseTermsId: 새 IP에 첨부될 등록된 라이센스 조건의 ID.
• request.licenseTemplate: [선택사항] 새 그룹 IP에 첨부될 라이센스 템플릿의 주소, 기본값은 Programmable IP License입니다.
• request.deadline: [선택사항] 서명의 유효 기간(밀리초), 기본값은 1000ms입니다.
• request.ipMetadata: [선택사항] 새로 발행된 NFT와 새로 등록된 IP에 대한 원하는 메타데이터.
  • request.ipMetadata.ipMetadataURI [선택사항] IP의 메타데이터 URI.
  • request.ipMetadata.ipMetadataHash [선택사항] IP의 메타데이터 해시.
  • request.ipMetadata.nftMetadataURI [선택사항] NFT의 메타데이터 URI.
  • request.ipMetadata.nftMetadataHash [선택사항] IP NFT의 메타데이터 해시.
• request.txOptions: [선택사항] 트랜잭션 options.

export type RegisterIpAndAttachLicenseAndAddToGroupResponse = {
  txHash?: string;
  encodedTxData?: EncodedTxData;
  ipId?: Address;
  tokenId?: bigint;
};

​

registerGroupAndAttachLicense

그룹 보상 풀과 함께 그룹 IP를 등록하고 그룹 IP에 라이센스 조건을 첨부합니다.

Parameters:

• request.groupPool: 그룹 내 IP 풀 간의 로열티 분배 방식을 지정하는 주소.
• request.licenseTermsId: 새 그룹 IP에 첨부될 등록된 라이센스 조건의 ID.
• request.licenseTemplate: [선택사항] 새 그룹 IP에 첨부될 라이센스 템플릿의 주소, 기본값은 Programmable IP License입니다.
• request.txOptions: [선택사항] 트랜잭션 options.

export type RegisterGroupAndAttachLicenseResponse = {
  txHash?: string;
  encodedTxData?: EncodedTxData;
  groupId?: Address;
};

​

registerGroupAndAttachLicenseAndAddIps

그룹 보상 풀과 함께 그룹 IP를 등록하고, 그룹 IP에 라이센스 조건을 첨부하고, 개별 IP들을 그룹 IP에 추가합니다.

Parameters:

• request.ipIds: 그룹에 추가될 IP들의 IP ID.
• request.groupPool: 그룹 내 IP 풀 간의 로열티 분배 방식을 지정하는 주소입니다.
• request.maxAllowedRevShare: 각 멤버 IP에 할당될 수 있는 최대 보상 공유 비율입니다.
• request.licenseData: 새 그룹 IP에 첨부될 라이선스와 그 구성의 데이터입니다.
  • request.licenseData.licenseTermsId: 새 그룹 IP에 첨부될 등록된 라이선스 조건의 ID입니다.
  • request.licenseData.licensingConfig: [선택사항] 다음을 참조하세요 LicensingConfig type. 제공되지 않으면 here에 표시된 것으로 기본 설정됩니다.
  • request.licenseData.licenseTemplate: [선택사항] 새 그룹 IP에 첨부될 라이선스 템플릿의 주소입니다. 기본값은 Programmable IP License입니다.
• request.txOptions: [선택사항] 트랜잭션 options입니다.

const response =
  await client.groupClient.registerGroupAndAttachLicenseAndAddIps({
    groupPool: "0xf96f2c30b41Cb6e0290de43C8528ae83d4f33F89", // EvenSplitGroupPool from https://docs.story.foundation/docs/deployed-smart-contracts
    maxAllowedRewardShare: 5,
    ipIds: ["0x01"],
    licenseData: {
      licenseTermsId: "5",
    },
    txOptions: { waitForTransaction: true },
  });

​

collectAndDistributeGroupRoyalties

전체 그룹의 로열티를 수집하고 각 멤버 IP의 로열티 금고에 보상을 분배합니다.

Parameters:

• request.groupIpId: 그룹의 IP ID입니다.
• request.currencyTokens: 청구할 통화(수익) 토큰의 주소들입니다.
• request.memberIpIds: 보상을 분배할 멤버 IP들의 ID입니다.
• request.txOptions: [선택사항] 트랜잭션 options입니다.

import { WIP_TOKEN_ADDRESS } from "@story-protocol/core-sdk";

const response = await client.groupClient.collectAndDistributeGroupRoyalties({
  groupIpId: "0x01",
  currencyTokens: [WIP_TOKEN_ADDRESS],
  memberIpIds: ["0x02"],
  txOptions: { waitForTransaction: true },
});