Royalty

from web3 import Web3

# In this case, lets say there is a root IPA 'A' and a derivative IPA 'B'.
# Someone wants to pay 'B' for whatever reason (they bought it, they want to tip it, etc).
# Since the payer is not an IP Asset (rather an external user), the `payer_ip_id` can
# be a zero address. And the receiver is, well, the receiver's ipId which is B.
#
# It's important to note that both 'B' and its parent 'A' will be able
# to claim revenue from this based on the negotiated license terms
pay_royalty = story_client.Royalty.pay_royalty_on_behalf(
    receiver_ip_id="0x0b825D9E5FA196e6B563C0a446e8D9885057f9B1",  # B's ipId
    payer_ip_id="0x0000000000000000000000000000000000000000",  # zero address
    token="0x1514000000000000000000000000000000000000",  # $WIP
    amount=Web3.to_wei(2, 'ether'),  # 2 $WIP
    tx_options={"wait_for_transaction": True}
)
print(f"Paid royalty at transaction hash {pay_royalty['tx_hash']}")

# In this case, lets say there is a root IPA 'A' and a derivative IPA 'B'.
# 'B' earns revenue off-chain, but must pay 'A' based on their negotiated license terms.
# So 'B' pays 'A' what they are due
pay_royalty = story_client.Royalty.pay_royalty_on_behalf(
    receiver_ip_id="0x6B86B39F03558A8a4E9252d73F2bDeBfBedf5b68",  # A's ipId
    payer_ip_id="0x0b825D9E5FA196e6B563C0a446e8D9885057f9B1",  # B's ipId
    token="0x1514000000000000000000000000000000000000",  # $WIP
    amount=Web3.to_wei(2, 'ether'),  # 2 $WIP
    tx_options={"wait_for_transaction": True}
)
print(f"Paid royalty at transaction hash {pay_royalty['tx_hash']}")

claimable = story_client.Royalty.claimable_revenue(
    royalty_vault_ip_id="0x089d75C9b7E441dA3115AF93FF9A855BDdbfe384",
    claimer="0x089d75C9b7E441dA3115AF93FF9A855BDdbfe384",
    token="0x1514000000000000000000000000000000000000"  # $WIP
)
print(f"Claimable revenue: {claimable}")

claim_revenue = story_client.Royalty.claim_all_revenue(
    # IP Asset 1's (parent) ipId
    ancestor_ip_id="0x089d75C9b7E441dA3115AF93FF9A855BDdbfe384",
    # whoever owns the royalty tokens associated with IP Royalty Vault 1
    # (most likely the associated ipId, which is IP Asset 1's ipId)
    claimer="0x089d75C9b7E441dA3115AF93FF9A855BDdbfe384",
    currency_tokens=["0x1514000000000000000000000000000000000000"],  # $WIP
    # IP Asset 2's (child) ipId
    child_ip_ids=["0xDa03c4B278AD44f5a669e9b73580F91AeDE0E3B2"],
    # testnet address of RoyaltyPolicyLAP
    royalty_policies=["0xBe54FB168b3c982b7AaE60dB6CF75Bd8447b390E"],
    claim_options={
      'auto_transfer_all_claimed_tokens_from_ip': True
    }
)

print(f"Claimed revenue: {claim_revenue['claimed_tokens']}")

vault_address = story_client.Royalty.get_royalty_vault_address("0x089d75C9b7E441dA3115AF93FF9A855BDdbfe384")
print(f"Royalty vault address: {vault_address}")

transfer_result = story_client.Royalty.transfer_to_vault(
    ip_id="0x0b825D9E5FA196e6B563C0a446e8D9885057f9B1",
    ancestor_ip_id="0x6B86B39F03558A8a4E9252d73F2bDeBfBedf5b68",
    royalty_policy="LAP",
    token="0x1514000000000000000000000000000000000000",  # $WIP
)
print(f"Transferred to vault at transaction hash {transfer_result['tx_hash']}")