Moved types files, added stubs for pack module

atbe · atbe · commit dae9a5e458de · 2021-10-19T13:24:37.000-07:00
diff --git a/main.py b/main.py
@@ -3,7 +3,7 @@
 import nftlabs.options
 from nftlabs import NftlabsSdk
 from pprint import pprint
-from nftlabs.modules.nft_types import MintArg
+from nftlabs.types.nft import MintArg
 from nftlabs.types import Role
 
 options = nftlabs.options.SdkOptions()
diff --git a/nftlabs/modules/__init__.py b/nftlabs/modules/__init__.py
@@ -1,8 +1,6 @@
 from .currency import *
-from .currency_types import *
 
 from .nft import *
 from .nft_types import *
 
 from .pack import *
-
diff --git a/nftlabs/modules/currency.py b/nftlabs/modules/currency.py
@@ -2,7 +2,7 @@
 from ..types import Role
 from ..abi.coin import Coin
 from .base import BaseModule
-from .currency_types import Currency, CurrencyValue
+from ..types.currency import Currency, CurrencyValue
 from ..abi.erc20 import ERC20
 from web3 import Web3
 from typing import List, Dict
diff --git a/nftlabs/modules/nft.py b/nftlabs/modules/nft.py
@@ -9,8 +9,8 @@
 from typing import Dict, List
 from ..abi.nft import NFT
 
-from ..types import NFT as NftType, Role
-from .nft_types import MintArg
+from ..types import Role
+from ..types.nft import MintArg, NftMetadata as NftType
 
 
 class NftModule(BaseModule):
diff --git a/nftlabs/modules/nft_types.py b/nftlabs/modules/nft_types.py
@@ -1,11 +1 @@
-from dataclasses import dataclass
-from typing import Optional
-
-
-@dataclass
-class MintArg:
-    name: str
-    description: str = ""
-    image_uri: str = ""
-    properties: Optional[dict] = None
 
diff --git a/nftlabs/modules/pack.py b/nftlabs/modules/pack.py
@@ -1,8 +1,10 @@
 from ..errors import NoSignerException
 from ..types import Role
+from ..types.pack import PackMetadata, PackNftMetadata, CreatePackArg, AssetAmountPair
+from ..types.nft import NftMetadata
+from ..types.currency import Currency, CurrencyValue
 from ..abi.pack import Pack
 from .base import BaseModule
-from .currency_types import Currency, CurrencyValue
 from ..abi.erc20 import ERC20
 from web3 import Web3
 from typing import List, Dict
@@ -17,6 +19,57 @@ def __init__(self, address: str, client: Web3):
         self.address = address
         self.__abi_module = Pack(client, address)
 
+    def get(self, pack_id: int) -> PackMetadata:
+        pass
+
+    def open(self, pack_id: int) -> List[NftMetadata]:
+        pass
+
+    def get_all(self) -> List[PackMetadata]:
+        pass
+
+    def get_nfts(self, pack_id: int) -> List[PackNftMetadata]:
+        pass
+
+    def balance_of(self, address: str, token_id: int) -> int:
+        pass
+
+    def balance(self, token_id) -> int:
+        pass
+
+    def is_approved(self, address: str, operator: str) -> bool:
+        pass
+
+    def set_approval(self, operator: str, approved: bool):
+        pass
+
+    def transfer(self, to_address: str, token_id: int, amount: int):
+        pass
+
+    def create(self, arg: CreatePackArg) -> PackMetadata:
+        pass
+
+    def transfer_from(self, from_address: str, to_address: str, args: AssetAmountPair):
+        pass
+
+    def transfer_batch_from(self, from_address: str, to_address: str, args: List[AssetAmountPair]):
+        pass
+
+    def get_link_balance(self) -> CurrencyValue:
+        pass
+
+    def deposit_link(self, amount: int):
+        pass
+
+    def withdraw_link(self, to_address: str, amount: int):
+        pass
+
+    def set_royalty_bps(self, amount: int):
+        pass
+
+    def set_restricted_transfer(self, restricted: bool = False):
+        pass
+
     def grant_role(self, role: Role, address: str):
         role_hash = role.get_hash()
         self.execute_tx(self.__abi_module.grant_role.build_transaction(
diff --git a/nftlabs/types/__init__.py b/nftlabs/types/__init__.py
@@ -1,3 +1 @@
-from .nft import *
-
-from .role import *
+from .role import *
diff --git a/nftlabs/types/currency/__init__.py b/nftlabs/types/currency/__init__.py
@@ -7,8 +7,8 @@ class Currency:
     symbol: str
     decimals: int
 
+
 @dataclasses.dataclass
 class CurrencyValue(Currency):
     value: str
     display_value: str
-
diff --git a/nftlabs/types/nft/__init__.py b/nftlabs/types/nft/__init__.py
@@ -4,9 +4,17 @@
 from dataclasses_json import dataclass_json
 
 
+@dataclass
+class MintArg:
+    name: str
+    description: str = ""
+    image_uri: str = ""
+    properties: Optional[dict] = None
+
+
 @dataclass_json
 @dataclass
-class NFT:
+class NftMetadata:
     name: str
     description: str
     image: str
diff --git a/nftlabs/types/pack/__init__.py b/nftlabs/types/pack/__init__.py
@@ -0,0 +1,35 @@
+from dataclasses import dataclass
+from datetime import datetime
+from ..nft import NftMetadata
+from typing import Union, List
+
+
+@dataclass
+class PackMetadata:
+    id: int
+    creator_address: str
+    current_supply: int
+    open_start: datetime
+    metadata: NftMetadata
+
+
+@dataclass
+class PackNftMetadata:
+    supply: int
+    metadata: NftMetadata
+
+
+@dataclass
+class AssetAmountPair:
+    token_id: int
+    amount: int
+
+
+@dataclass
+class CreatePackArg:
+    asset_contract_address: str
+    metadata: Union[str, dict]
+    assets: List[AssetAmountPair]
+    seconds_until_open_start: int
+    seconds_until_open_end: int
+    rewards_per_open: int
