Skip to content

Commit

Permalink
Update code examples in README.
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
jasny committed Mar 28, 2022
1 parent dd54b7a commit 36e29d8
Showing 1 changed file with 35 additions and 31 deletions.
66 changes: 35 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,141 +5,145 @@ Python client library for interacting with LTO Network
## Accounts

### Create an account
The chain_id is 'L' for the MainNet and 'T' TestNet
The chain_id is 'L' for the mainnet and 'T' testnet

```python
from lto.accounts.account_factory import AccountFactory
from lto.accounts.ed25519 import AccountFactory

account = AccountFactory(chain_id).create()
```
### Create an account from seed

```python
from lto.accounts.account_factory import AccountFactory
from lto.accounts.ed25519 import AccountFactory

account = AccountFactory(chain_id).create_from_seed(seed)
```

### Create an account from public key

```python
from lto.accounts.account_factory import AccountFactory
from lto.accounts.ed25519 import AccountFactory

account = AccountFactory(chain_id).create_from_public_key(public_key)
```

### Create an account from private key

```python
from lto.accounts.account_factory import AccountFactory
from lto.accounts.ed25519 import AccountFactory

account = AccountFactory(chain_id).create_from_private_key(private_key)
```

## Executing Transactions:
First a transaction needs to be created:
### Ex Transfer Transaction
```
## Executing Transactions

### Create transaction
First a transaction needs to be created.

```python
from src.LTO.Transactions.Transfer import Transfer
transaction = Transfer(recipient, amount)
```
The Transaction needs then to be signed. <br/>
In order to sign a transaction an account is needed (check at the beginning of the page the steps to create an account).

### Ex of signinig a transaction
```
The Transaction needs then to be signed. In order to sign a transaction an account is needed.

### Sign transaction

```python
transaction.sign_with(account)
```
For last the transaction needs to be broadcasted to the node. <br/>
In order to do so we need to connect to the node using the PublicNode class.
### Broadcast transaction

```
For last the transaction needs to be broadcasted to the node. In order to do so we need to connect to the node using the PublicNode class.

```python
from src.LTO.PublicNode import PublicNode
node = PublicNode(url)
```
The url refers to the node, there are many nodes available, here there are two examples, one for the MainNet and one for the TestNet <br/>
The url refers to the node, there are many nodes available, here there are two examples, one for the mainnet and one for the testnet

https://nodes.lto.network <br/>
https://testnet.lto.network
* https://nodes.lto.network
* https://testnet.lto.network

### Ex of broadcasting a transaction
```
```python
transaction.broadcast_to(node)
```

## Transactions

### Transfer Transaction

```python
from src.lto.transactions.transfer import Transfer
from lto.transactions import Transfer

transaction = Transfer(recipient, amount)
```

### Mass Transfer Transaction

```python
from src.lto.transactions.mass_transfer import MassTransfer
from lto.transactions import MassTransfer

transaction = MassTransfer(transfers)
```
### Anchor Transaction

```python
import Anchor
from lto.transactions import Anchor

transaction = Anchor(anchor)
```
### Lease Transaction

```python
from src.lto.transactions.lease import Lease
from lto.transactions import Lease

transaction = Lease(recipient, amount)
```
### Cancel Lease Transaction

```python
from src.lto.transactions.cancel_lease import CancelLease
from lto.transactions import CancelLease

transaction = CancelLease(lease_id)
```

### SetScript Transaction

```python
from src.lto.transactions.set_script import SetScript
from lto.transactions import SetScript

transaction = SetScript(script)
```

### Sponsorship transaction

```python
from src.lto.transactions.sponsorship import Sponsorship
from lto.transactions import Sponsorship

transaction = Sponsorship(recipient)
```

### Cancel Sponsorship transaction

```python
from src.lto.transactions.cancel_sponsorship import CancelSponsorship
from lto.transactions import CancelSponsorship

transaction = CancelSponsorship(recipient)
```

### Association transaction

```python
from src.lto.transactions.association import Association
from lto.transactions import Association

transaction = Association(recipient, association_type, anchor)
```
### Revoke Association transaction

```python
from src.lto.transactions.revoke_association import RevokeAssociation
from lto.transactions import RevokeAssociation

transaction = RevokeAssociation(recipient, association_type, anchor)
```

0 comments on commit 36e29d8

Please sign in to comment.