Skip to content

feat: add is_registered and get_balance public methods #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chao-peng-story wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add is_registered and get_balance public methods #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions src/story_protocol_python_sdk/resources/IPAsset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ def register(
"""
try:
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
return {"tx_hash": None, "ip_id": ip_id}

req_object: dict = {
Expand Down Expand Up @@ -316,7 +316,7 @@ def register_derivative(
:return dict: A dictionary with the transaction hash
"""
try:
if not self._is_registered(child_ip_id):
if not self.is_registered(child_ip_id):
raise ValueError(
f"The child IP with id {child_ip_id} is not registered."
)
Expand Down Expand Up @@ -378,7 +378,7 @@ def register_derivative_with_license_tokens(
validate_max_rts(max_rts)

# Validate child IP registration
if not self._is_registered(child_ip_id):
if not self.is_registered(child_ip_id):
raise ValueError(
f"The child IP with id {child_ip_id} is not registered."
)
Expand Down Expand Up @@ -757,7 +757,7 @@ def register_ip_and_attach_pil_terms(
"""
try:
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
raise ValueError(
f"The NFT with id {token_id} is already registered as IP."
)
Expand Down Expand Up @@ -872,7 +872,7 @@ def register_derivative_ip(
"""
try:
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
raise ValueError(
f"The NFT with id {token_id} is already registered as IP."
)
Expand Down Expand Up @@ -1061,7 +1061,7 @@ def register_ip_and_make_derivative_with_license_tokens(
"""
try:
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
raise ValueError(
f"The NFT with id {token_id} is already registered as IP."
)
Expand Down Expand Up @@ -1290,7 +1290,7 @@ def register_derivative_ip_and_attach_pil_terms_and_distribute_royalty_tokens(
try:
nft_contract = validate_address(nft_contract)
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
raise ValueError(
f"The NFT with id {token_id} is already registered as IP."
)
Expand Down Expand Up @@ -1397,7 +1397,7 @@ def register_ip_and_attach_pil_terms_and_distribute_royalty_tokens(
try:
nft_contract = validate_address(nft_contract)
ip_id = self._get_ip_id(nft_contract, token_id)
if self._is_registered(ip_id):
if self.is_registered(ip_id):
raise ValueError(
f"The NFT with id {token_id} is already registered as IP."
)
Expand Down Expand Up @@ -1500,7 +1500,7 @@ def register_pil_terms_and_attach(
:return RegisterPILTermsAndAttachResponse: Dictionary with the tx hash and license terms IDs.
"""
try:
if not self._is_registered(ip_id):
if not self.is_registered(ip_id):
raise ValueError(f"The IP with id {ip_id} is not registered.")
calculated_deadline = self.sign_util.get_deadline(deadline=deadline)
ip_account_impl_client = IPAccountImplClient(self.web3, ip_id)
Expand Down Expand Up @@ -2009,7 +2009,7 @@ def _validate_derivative_data(self, derivative_data: dict) -> dict:
for parent_id, terms_id in zip(
internal_data["parentIpIds"], internal_data["licenseTermsIds"]
):
if not self._is_registered(parent_id):
if not self.is_registered(parent_id):
raise ValueError(
f"The parent IP with id {parent_id} is not registered."
)
Expand Down Expand Up @@ -2134,13 +2134,21 @@ def _get_ip_id(self, token_contract: str, token_id: int) -> str:
self.chain_id, token_contract, token_id
)

def _is_registered(self, ip_id: str) -> bool:
def is_registered(self, ip_id: str) -> bool:
"""
Check if an IP is registered.

:param ip_id str: The IP ID to check.
:return bool: True if registered, False otherwise.
:raises ValueError: If the ip_id is empty or has invalid format.
"""
if not ip_id:
raise ValueError("is_registered: ip_id is required")

if not self.web3.is_address(ip_id):
raise ValueError(f"is_registered: invalid IP ID address format: {ip_id}")

ip_id = self.web3.to_checksum_address(ip_id)
return self.ip_asset_registry_client.isRegistered(ip_id)

def _parse_tx_ip_registered_event(self, tx_receipt: dict) -> list[RegisteredIP]:
Expand Down
23 changes: 20 additions & 3 deletions src/story_protocol_python_sdk/story_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,31 @@ def Group(self) -> Group:
self._group = Group(self.web3, self.account, self.chain_id)
return self._group

def get_balance(self, address: str) -> int:
"""
Get the native token (IP) balance of the specified address.

:param address str: The address to query the balance for.
:return int: The native token balance of the specified address in wei.
:raises ValueError: If the address is invalid.
"""
if not address:
raise ValueError("Address must be provided")

if not self.web3.is_address(address):
raise ValueError(f"Invalid address format: {address}")

checksum_address = self.web3.to_checksum_address(address)
return self.web3.eth.get_balance(checksum_address)

def get_wallet_balance(self) -> int:
"""
Get the WIP token balance of the current wallet.
Get the native token (IP) balance of the current wallet.

:return int: The WIP token balance of the current wallet.
:return int: The native token balance of the current wallet in wei.
:raises ValueError: If no account is found.
"""
if not self.account or not hasattr(self.account, "address"):
raise ValueError("No account found in wallet")

return self.web3.eth.get_balance(self.account.address)
return self.get_balance(self.account.address)
Loading