Skip to content

Commit 597237a

Browse files
committed
clean-up docs
1 parent cb05930 commit 597237a

File tree

4 files changed

+22
-8
lines changed

4 files changed

+22
-8
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ The primary motivation for this work is to be able to model smart-contract inter
1919
- `Contract`: high-level, user-friendy Python API
2020

2121
## Build from source
22-
- You need `Rust`, `Python/Poetry`, and optionally `Make`.
23-
- Create a local Python virtual environment. With Poetry, run `poetry install`
24-
- Run `make build` or run `poetry run maturin develop`
22+
- You need `Rust` and `Python`, and optionally `Make`. We use `hatch` for Python project management, but it's not required
23+
- Create a local Python virtual environment. Within that environment install Python dependencies
24+
- Run `make build` or `hatch run maturin develop`
2525
- See `simular/` for the main python api
2626

2727
## Getting Started

docs/src/getstarted.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# Getting Started
22

3-
Simular can be installed via PyPi (LINK TO THE PYPI Page). It requires a Python version of `>=3.11`.
3+
Simular can be installed via [PyPi](https://pypi.org/project/simular-evm/). It requires a Python version of `>=3.11`.
44

55
**Install:**
66
```bash
77
pip install simular-evm
88
```
99
## Examples
10-
1110
Here are a few quick examples that demonstrate the API. You can find more details on the API in the **Reference Guide** section.
1211

1312
### Transfer Ether between accounts
@@ -108,4 +107,4 @@ assert counter.increment.transact(1, caller=bob)
108107
assert 1 == counter.number.call()
109108
```
110109

111-
See **Reference Guide** for more API details.
110+
See [Reference Guide](./reference/contract.md) for more API details.

docs/src/reference/contract.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ function hello(address caller) public returns (bool){}
77

88
function world(string name) view (string)
99
```
10-
Those methods will be automatically available in the instance of the Contract like this:
10+
they will be automatically available in the instance of the Contract like this:
1111

1212
```python
1313
# write call to the hello method
@@ -32,7 +32,13 @@ Each method name is an attribute on the instance of Contract. To invoke them, y
3232
.call(*args)
3333
```
3434

35-
Under the covers, Contract knows how to properly encode the call to the EVM, and likewise decode any return values.
35+
Under the covers, a Contract knows how to properly encode all interactions with the EVM, and likewise decode any return values.
36+
37+
- [Contract API](#contract-api)
38+
- [Constructor](#constructor)
39+
- [Methods](#methods)
40+
- [at](#at)
41+
- [deploy](#deploy)
3642

3743
## Constructor
3844
Create an instance of a Contract from an ABI.

docs/src/reference/utils.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Utilities defines several 'helper' functions to create contracts and accounts.
44

5+
- [Utility Functions](#utility-functions)
6+
- [Functions](#functions)
7+
- [generate\_random address](#generate_random-address)
8+
- [create\_account](#create_account)
9+
- [create\_many\_accounts](#create_many_accounts)
10+
- [contract\_from\_raw\_abi](#contract_from_raw_abi)
11+
- [contract\_from\_abi\_bytecode](#contract_from_abi_bytecode)
12+
- [contract\_from\_inline\_abi](#contract_from_inline_abi)
13+
514
## Functions
615

716
### generate_random address

0 commit comments

Comments
 (0)