SDK Reference
Royalty
Royalty를 사용하면 Story 내에서 로열티 지불 및 청구를 관리할 수 있습니다.
로열티
메서드
- pay_royalty_on_behalf
- claimable_revenue
- claim_all_revenue
- get_royalty_vault_address
- transfer_to_vault
pay_royalty_on_behalf
함수 호출자가 지불자 IP Asset을 대신하여 수신자 IP 자산에 로열티를 지불할 수 있게 합니다.
메서드 |
---|
pay_royalty_on_behalf |
Parameters:
receiver_ip_id
: 로열티를 받는 ipId입니다.payer_ip_id
: 로열티를 지불하는 IP 자산의 ID입니다.token
: 로열티 지불에 사용할 토큰입니다.amount
: 지불할 금액입니다.tx_options
: [선택사항] 트랜잭션 옵션 딕셔너리입니다.
claimable_revenue
로열티 토큰 보유자가 청구할 수 있는 총 수익 토큰 양을 가져옵니다.
메서드 |
---|
claimable_revenue |
Parameters:
royalty_vault_ip_id
: 로열티 볼트의 id입니다.claimer
: 로열티 토큰 보유자의 주소입니다.token
: 청구할 수익 토큰입니다.
claim_all_revenue
자식 IP 자산 및/또는 자신의 IP 로열티 볼트에서 모든 수익을 청구합니다.
메서드 |
---|
claim_all_revenue |
Parameters:
ancestor_ip_id
: 수익이 청구되는 조상 IP의 주소입니다.claimer
: 통화(수익) 토큰의 청구자 주소입니다. 일반적으로 IP가 모든 로열티 토큰을 가지고 있다면 조상 IP의 ipId입니다. 그렇지 않다면, 이는 조상 IP 로열티 토큰을 보유하고 있는 주소가 됩니다.child_ip_ids
: 로열티가 파생되는 자식 IP들의 주소입니다.royalty_policies
: 로열티 정책의 주소로, royalty_policies[i]는 child_ip_ids[i]의 로열티 흐름을 관리합니다.currency_tokens
: 로열티가 청구될 통화 토큰의 주소입니다.claim_options
: [선택사항]claim_options['auto_transfer_all_claimed_tokens_from_ip']
: [선택사항] 활성화되면, 지갑이 IP를 소유하고 있을 때 청구자에게 청구된 모든 토큰이 지갑 주소로 전송됩니다. 지갑이 청구자이거나 청구자가 지갑이 소유한 IP가 아닌 경우, 토큰은 전송되지 않습니다. False로 설정하면 청구자로부터 청구된 토큰의 자동 전송이 비활성화됩니다.Default: True
get_royalty_vault_address
주어진 ipId의 로열티 볼트 프록시 주소를 가져옵니다ip_id
.
메서드 |
---|
get_royalty_vault_address |
Parameters:
ip_id
: 로열티 볼트와 연관된ipId
ipId입니다.
transfer_to_vault
볼트로 로열티 정책을 통해 청구 가능한 수익 토큰의 금액을 이전합니다.
메서드 |
---|
transfer_to_vault |
Parameters:
ip_id
: 로열티를 지불하는 IP 자산의 ID입니다.ancestor_ip_id
: 조상 IP 자산의 ID입니다.token
: 이전할 토큰 주소입니다.royalty_policy
: [선택사항] 사용할 로열티 정책 (“LAP” 또는 “LRP”)입니다.Default: “LAP”tx_options
: [선택사항] 트랜잭션 옵션 딕셔너리입니다.