On-Chain IP

IPClient

The IPClient provides functionality for managing intellectual property (IP) assets. The IPClient simplifies the management of IP assets, making it easier to create, retrieve, and list them as needed.

Methods

• registerNFT

• registerDerivatives

registerNFT

Register an NFT as an Intellectual Property Asset

Method	Type
registerNFT	(request: IRegisterNFT) => Promise<{result, transactionResponse}>

• Parameters:

Name	Type	Description
licensors	[address, address, address]	A list of up to three wallet address representing licensors for the IP collection. Pass zero address (0x0000000000000000000000000000) for empty address
tokenContract	address	The contract address of the NFT.
tokenID	number	The token id of the NFT

• Returns:

Name	Type	Description
transactionResponse	Object	Contains details of the transaction, including the transactionHash, logs, and other relevant information.
result	Object	Object containing the contract address and IP id of the newly created collection.

• response.transactionResponse.transactionHash - The transaction hash.

• response.result.id - The IP id of the newly registered Ip Asset.

registerDerivatives

Register derivatives of an Ip Asset

Method	Type
registerDerivatives	(request: IRegisterDerivates) => Promise<registerDerivativeResponse>

• Parameters:

Name	Type	Description
tokenContract	address	The contract address of the NFT.
tokenID	number	The token id of the NFT
parentIP	address	The identifier for the parent intellectual property (IP) in the request

• Returns:

Name	Type	Description
transactionResponse	Object	Contains details of the transaction, including the transactionHash, logs, and other relevant information.
result	Object	Object containing the contract address and IP id of the newly created collection.

• response.result.ipID - The IP ID of the newly registered IP Asset.