Skip to content

Commit 07f056f

Browse files
acknessackness
committed
[Docs] Add docs and some examples
1 parent aaef13e commit 07f056f

23 files changed

+1366
-0
lines changed

‎.gitignore

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
30+
# PyInstaller
31+
# Usually these files are written by a python script from a template
32+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33+
*.manifest
34+
*.spec
35+
36+
# Installer logs
37+
pip-log.txt
38+
pip-delete-this-directory.txt
39+
40+
# Unit test / coverage reports
41+
htmlcov/
42+
.tox/
43+
.nox/
44+
.coverage
45+
.coverage.*
46+
.cache
47+
nosetests.xml
48+
coverage.xml
49+
*.cover
50+
*.py,cover
51+
.hypothesis/
52+
.pytest_cache/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
target/
76+
77+
# Jupyter Notebook
78+
.ipynb_checkpoints
79+
80+
# IPython
81+
profile_default/
82+
ipython_config.py
83+
84+
# pyenv
85+
.python-version
86+
87+
# pipenv
88+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91+
# install all needed dependencies.
92+
#Pipfile.lock
93+
94+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95+
__pypackages__/
96+
97+
# Celery stuff
98+
celerybeat-schedule
99+
celerybeat.pid
100+
101+
# SageMath parsed files
102+
*.sage.py
103+
104+
# Environments
105+
.env
106+
.venv
107+
env/
108+
venv/
109+
ENV/
110+
env.bak/
111+
venv.bak/
112+
113+
# Spyder project settings
114+
.spyderproject
115+
.spyproject
116+
117+
# Rope project settings
118+
.ropeproject
119+
120+
# mkdocs documentation
121+
/site
122+
123+
# mypy
124+
.mypy_cache/
125+
.dmypy.json
126+
dmypy.json
127+
128+
# Pyre type checker
129+
.pyre/
130+
131+
.idea/
132+
.xml
133+
examples/test*
134+
aptc/test*

‎aptc/__init__.py

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
from .configs import DEV_APTOS_NODE_URL_LIST, DEV_FAUCET_URL_LIST, APTOS_NODE_URL_LIST
2+
from .libs.const import *
3+
from .libs import HttpxProvider, HttpxAsyncProvider, APTClient
4+
from .sdk_impl import *
5+
6+
__all__ = [
7+
# libs
8+
'HttpxProvider', 'HttpxAsyncProvider', 'APTClient',
9+
# const
10+
'DEV_FAUCET_URL_LIST', 'DEV_APTOS_NODE_URL_LIST', 'APTOS_NODE_URL_LIST',
11+
"APT_COIN_TYPE", "APT_COIN_STORE", "COIN_STORE_TYPE_TAG", "OCTA", "APT",
12+
# SDK
13+
'Account', 'AccountAddress', 'Serializer', 'Deserializer',
14+
'PrivateKey', 'PublicKey', 'Signature'
15+
]

‎aptc/configs.py

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
DEV_APTOS_NODE_URL_LIST = [
2+
"https://fullnode.devnet.aptoslabs.com/v1"
3+
]
4+
5+
DEV_FAUCET_URL_LIST = [
6+
"https://faucet.devnet.aptoslabs.com"
7+
]
8+
9+
APTOS_NODE_URL_LIST = [
10+
"https://fullnode.mainnet.aptoslabs.com/v1",
11+
]
12+

‎aptc/libs/__init__.py

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
from .client import APTClient
2+
from .providers import HttpxProvider, HttpxAsyncProvider
3+
from .const import *
4+
5+
__all__ = [
6+
"HttpxProvider", "HttpxAsyncProvider", "APTClient",
7+
"APT_COIN_TYPE", "APT_COIN_STORE", "COIN_STORE_TYPE_TAG", "OCTA", "APT",
8+
]

‎aptc/libs/_types.py

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
from typing import Union, Optional
2+
3+
from ..sdk_impl import AccountAddress
4+
5+
Address = Union[str, AccountAddress]
6+
TXHash = Union[str, AccountAddress]
7+
IntNumber = Union[int, str]
8+
OptionalIntNumber = Optional[IntNumber]
9+

‎aptc/libs/apis.py

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
class APTAccountAPI:
2+
# common api
3+
GET_ACCOUNT = "accounts/{address}"
4+
GET_ACCOUNT_RESOURCES = "accounts/{address}/resources"
5+
GET_ACCOUNT_RESOURCE = "accounts/{address}/resource/{resource_type}"
6+
GET_ACCOUNT_MODULES = "accounts/{address}/modules"
7+
GET_ACCOUNT_MODULE = "accounts/{address}/modules/{module_name}"
8+
9+
# specific api
10+
GET_ACCOUNT_BALANCE = "accounts/{address}/resource/0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>"
11+
12+
13+
class APTBlockAPI:
14+
GET_BLOCK_BY_HEIGHT = "blocks/by_height/{block_height}"
15+
GET_BLOCK_BY_VERSION = "blocks/by_version/{version}"
16+
17+
18+
class APTEventAPI:
19+
GET_EVENT_BY_CREATION_NUMBER = "accounts/{address}/events/{creation_number}"
20+
GET_EVENT_BY_EVENT_HANDLE = "accounts/{address}/events/{event_handle}/{field_name}"
21+
22+
23+
class APTGeneralAPI:
24+
SHOW_OPENAPI_EXPLORER = "spec"
25+
CHECK_NODE_HEALTH = '-/healthy'
26+
GET_LEDGER_INFO = ""
27+
28+
29+
class APTTablesAPI:
30+
GET_TABLE_ITEM = "tables/{table_handle}/item"
31+
32+
33+
class APTTransactionsAPI:
34+
GET_TRANSACTIONS = "transactions" # GET
35+
SUBMIT_TRANSACTION = "transactions" # POST
36+
GET_TRANSACTION_BY_HASH = "transactions/by_hash/{txn_hash}"
37+
GET_TRANSACTION_BY_VERSION = "transactions/by_version/{txn_version}"
38+
GET_ACCOUNT_TRANSACTIONS = "accounts/{address}/transactions"
39+
SUBMIT_BATCH_TRANSACTIONS = "transactions/batch" # POST
40+
SIMULATE_TRANSACTION = "transactions/simulate" # POST
41+
ENCODE_SUBMISSION = "transactions/encode_submission" # POST
42+
ESTIMATE_GAS_PRICE = "estimate_gas_price"

‎aptc/libs/client.py

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
from typing import Dict
2+
3+
from httpx import Response
4+
5+
from ._types import Address, TXHash, IntNumber
6+
from .apis import APTTransactionsAPI, APTAccountAPI, APTGeneralAPI, APTBlockAPI, APTEventAPI, APTTablesAPI
7+
from .errors import ParamsError, RPCRequestError
8+
from .providers import BaseProvider
9+
10+
11+
class APTClient:
12+
def __init__(self, provider: BaseProvider):
13+
self.provider = provider
14+
15+
# account
16+
def get_account(self, address: Address):
17+
return self.provider.get(APTAccountAPI.GET_ACCOUNT.format(address=address))
18+
19+
def get_account_resource(self, address: Address, resource_type: str):
20+
return self.provider.get(
21+
APTAccountAPI.GET_ACCOUNT_RESOURCE.format(address=address, resource_type=resource_type))
22+
23+
def get_account_resources(self, address: Address):
24+
return self.provider.get(APTAccountAPI.GET_ACCOUNT_RESOURCES.format(address=address))
25+
26+
def get_account_modules(self, address: Address):
27+
return self.provider.get(APTAccountAPI.GET_ACCOUNT_MODULES.format(address=address))
28+
29+
def get_account_module(self, address: Address, module_name: str):
30+
return self.provider.get(APTAccountAPI.GET_ACCOUNT_MODULE.format(address=address, module_name=module_name))
31+
32+
# useful account related method
33+
def get_account_balance(self, address: Address):
34+
# return self.get_account_resource(address, APT_COIN_STORE)['data']['coin']['value']
35+
return self.provider.get(APTAccountAPI.GET_ACCOUNT_BALANCE.format(address=address))['data']['coin']['value']
36+
37+
def get_account_sequence_number(self, address: Address):
38+
return self.get_account(address)['sequence_number']
39+
40+
def get_account_nonce(self, address: Address):
41+
return self.get_account_sequence_number(address)
42+
43+
# block
44+
def get_block_by_height(self, block_height: IntNumber):
45+
return self.provider.get(APTBlockAPI.GET_BLOCK_BY_HEIGHT.format(block_height=str(block_height)))
46+
47+
def get_block_by_version(self, version: IntNumber):
48+
return self.provider.get(APTBlockAPI.GET_BLOCK_BY_VERSION.format(version=str(version)))
49+
50+
# event
51+
def get_event_by_creation_number(self, address: Address, creation_number: int):
52+
return self.provider.get(
53+
APTEventAPI.GET_EVENT_BY_CREATION_NUMBER.format(address=address, creation_number=str(creation_number)))
54+
55+
def get_event_by_event_handle(self, address: Address, event_handle: str):
56+
return self.provider.get(
57+
APTEventAPI.GET_EVENT_BY_EVENT_HANDLE.format(address=address, event_handle=event_handle))
58+
59+
# general
60+
def show_openapi_explorer(self):
61+
url = self.provider.patch_url([self.provider.base_url, APTGeneralAPI.SHOW_OPENAPI_EXPLORER])
62+
return self.provider.client.get(url)
63+
64+
def check_node_health(self):
65+
return self.provider.get(APTGeneralAPI.CHECK_NODE_HEALTH)
66+
67+
check_health = check_node_health
68+
69+
def get_ledger_info(self):
70+
return self.provider.get(APTGeneralAPI.GET_LEDGER_INFO)
71+
72+
# tables
73+
def get_table_item(self, table_handle: str):
74+
return self.provider.post(APTTablesAPI.GET_TABLE_ITEM.format(table_handle=table_handle))
75+
76+
# transactions
77+
def get_transactions(self):
78+
return self.provider.get(APTTransactionsAPI.GET_TRANSACTIONS)
79+
80+
def get_transaction_by_hash(self, txn_hash: TXHash):
81+
return self.provider.get(APTTransactionsAPI.GET_TRANSACTION_BY_HASH.format(txn_hash=txn_hash))
82+
83+
get_txn_by_hash = get_transaction_by_hash
84+
85+
def get_transaction_by_version(self, txn_version: IntNumber):
86+
return self.provider.get(APTTransactionsAPI.GET_TRANSACTION_BY_VERSION.format(txn_version=str(txn_version)))
87+
88+
def get_account_transactions(self, address):
89+
return self.provider.get(APTTransactionsAPI.GET_ACCOUNT_TRANSACTIONS.format(address=address))
90+
91+
def submit_transaction(self, txn_dict: Dict):
92+
return self.provider.post(APTTransactionsAPI.SUBMIT_TRANSACTION, params_dict=txn_dict)
93+
94+
submit = submit_transaction
95+
96+
def submit_batch_transactions(self, batch_txn_dict: Dict):
97+
return self.provider.post(APTTransactionsAPI.SUBMIT_BATCH_TRANSACTIONS, params_dict=batch_txn_dict)
98+
99+
submit_batch = submit_batch_transactions
100+
101+
def simulate_transaction(
102+
self, txn_dict, estimate_gas_unit_price: str = "false",
103+
estimate_max_gas_amount: str = "false",
104+
estimate_prioritized_gas_unit_price: str = "false"
105+
):
106+
j = self.provider.post(
107+
f'{APTTransactionsAPI.SIMULATE_TRANSACTION}'
108+
f'?estimate_gas_unit_price={estimate_gas_unit_price}'
109+
f'&estimate_max_gas_amount={estimate_max_gas_amount}'
110+
f'&estimate_prioritized_gas_unit_price={estimate_prioritized_gas_unit_price}',
111+
txn_dict
112+
)
113+
return self._handle_simulate_error(j)
114+
115+
simulate = simulate_transaction
116+
117+
def encode_submission(self, txn_dict: Dict):
118+
j = self.provider.post(APTTransactionsAPI.ENCODE_SUBMISSION, params_dict=txn_dict)
119+
return bytes.fromhex(j[2:])
120+
121+
encode = encode_submission
122+
123+
@staticmethod
124+
def _handle_simulate_error(j: Response):
125+
if isinstance(j, list):
126+
j = j[0]
127+
else:
128+
raise ParamsError(f"Check Txn dict Params. RPC Response: {j}")
129+
130+
if j['success']:
131+
return j
132+
else:
133+
raise RPCRequestError(f"RPC Error: {j['vm_status']}")

‎aptc/libs/const.py

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
OCTA = 1
2+
APT = 100_000_000 * OCTA
3+
4+
APT_COIN_TYPE = "0x1::aptos_coin::AptosCoin"
5+
COIN_STORE_TYPE_TAG = "0x1::coin::CoinStore<{type}>"
6+
APT_COIN_STORE = COIN_STORE_TYPE_TAG.format(type=APT_COIN_TYPE)

‎aptc/libs/errors.py

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
class RPCRequestError(Exception):
2+
pass
3+
4+
5+
class ParamsError(Exception):
6+
pass

‎aptc/libs/providers/__init__.py

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
from ._base import BaseProvider
2+
from .async_http import HttpxAsyncProvider
3+
from .http import HttpxProvider

0 commit comments

Comments
 (0)