SDK Reference
Group
Group allows you to create groups and add IP Assets to them.
Group
Methods
- register_group
- register_group_and_attach_license
- mint_and_register_ip_and_attach_license_and_add_to_group
- register_ip_and_attach_license_and_add_to_group
- register_group_and_attach_license_and_add_ips
- collect_and_distribute_group_royalties
register_group
Registers a Group IPA.
Method |
---|
register_group |
Parameters:
group_pool
: The address of the group pool.tx_options
: [Optional] The transaction options dictionary.
register_group_and_attach_license
Register a group IP with a group reward pool and attach license terms to the group IP.
Method |
---|
register_group_and_attach_license |
Parameters:
group_pool
: The address of the group pool.license_data
: License data object with terms and config.tx_options
: [Optional] The transaction options dictionary.
mint_and_register_ip_and_attach_license_and_add_to_group
Mint an NFT from a SPGNFT collection, register it with metadata as an IP, attach license terms to the registered IP, and add it to a group IP.
Method |
---|
mint_and_register_ip_and_attach_license_and_add_to_group |
Parameters:
group_id
: The ID of the group to add the IP to.spg_nft_contract
: The address of the SPG NFT contract.license_data
: List of license data objects with terms and config.max_allowed_reward_share
: Maximum allowed reward share percentage.ip_metadata
: [Optional] The metadata for the IP.recipient
: [Optional] The recipient of the NFT (defaults to caller).allow_duplicates
: [Optional] Whether to allow duplicate IPs.deadline
: [Optional] The deadline for the signature in milliseconds.tx_options
: [Optional] The transaction options dictionary.
register_ip_and_attach_license_and_add_to_group
Register an NFT as IP with metadata, attach license terms to the registered IP, and add it to a group IP.
Method |
---|
register_ip_and_attach_license_and_add_to_group |
Parameters:
group_id
: The ID of the group to add the IP to.nft_contract
: The address of the NFT contract.token_id
: The token ID of the NFT.license_data
: List of license data objects with terms and config.max_allowed_reward_share
: Maximum allowed reward share percentage.ip_metadata
: [Optional] The metadata for the IP.deadline
: [Optional] The deadline for the signature in milliseconds.tx_options
: [Optional] The transaction options dictionary.
register_group_and_attach_license_and_add_ips
Register a group IP with a group reward pool, attach license terms to the group IP, and add individual IPs to the group IP.
Method |
---|
register_group_and_attach_license_and_add_ips |
Parameters:
group_pool
: The address of the group pool.ip_ids
: List of IP IDs to add to the group.license_data
: License data object with terms and config.max_allowed_reward_share
: Maximum allowed reward share percentage.tx_options
: [Optional] The transaction options dictionary.
collect_and_distribute_group_royalties
Collect royalties for the entire group and distribute the rewards to each member IP’s royalty vault.
Method |
---|
collect_and_distribute_group_royalties |
Parameters:
group_ip_id
: The ID of the group IP.currency_tokens
: List of currency token addresses.member_ip_ids
: List of member IP IDs.tx_options
: [Optional] The transaction options dictionary.