Skip to content
This repository has been archived by the owner on Dec 14, 2022. It is now read-only.

Commit

Permalink
docs: package documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Moustikitos committed Jun 6, 2022
1 parent 0348355 commit 522184e
Show file tree
Hide file tree
Showing 3 changed files with 598 additions and 598 deletions.
76 changes: 38 additions & 38 deletions docs/ark/builders/builders.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
<a id="dposlib.ark.builders"></a>

# dposlib.ark.builders

[`dposlib.ark.builders`](builders.md#dposlib.ark.builders) package
provides[`dposlib.ark.tx.Transaction`](../tx.md#dposlib.ark.tx.Transaction)
class and its associated builders. Builders are automatically set into
`dposlib.core` package according to network.

```python
>>> import dposlib
>>> from dposlib import rest
>>> rest.use("dark")
True
>>> tx = dposlib.core.transfer(
... 1,
... "D7seWn8JLVwX4nHd9hh2Lf7gvZNiRJ7qLk",
... u"simple message with sparkle \u2728",
... version=2
... )
>>> tx.finalize("first secret", "second secret")
>>> broadcastTransactions(tx).get("data", {}).get("broadcast", [])
[u'041ad1e3dd06d29ef59b2c7e19fea4ced0e7fcf9fdc22edcf26e5cc016e10f38']
```

__Available builders according to network__


blockchain|builders
-|-
`*`|transfer, registerSecondSecret, registerSecondPublicKey,
|registerAsDelegate, upVote, downVote, registerMultiSignature, registerIpfs
|delegateResignation, htlcSecret, htlcLock, htlcClaim, htlcRefund,
|switchVote
`ark`, `dark`|entityRegister, entityUpdate, entityResign
`sxp`, `tsxp`|burn
`nos`, `dnos`|TODO

<a id="dposlib.ark.builders"></a>

# dposlib.ark.builders

[`dposlib.ark.builders`](builders.md#dposlib.ark.builders) package
provides[`dposlib.ark.tx.Transaction`](../tx.md#dposlib.ark.tx.Transaction)
class and its associated builders. Builders are automatically set into
`dposlib.core` package according to network.

```python
>>> import dposlib
>>> from dposlib import rest
>>> rest.use("dark")
True
>>> tx = dposlib.core.transfer(
... 1,
... "D7seWn8JLVwX4nHd9hh2Lf7gvZNiRJ7qLk",
... u"simple message with sparkle \u2728",
... version=2
... )
>>> tx.finalize("first secret", "second secret")
>>> broadcastTransactions(tx).get("data", {}).get("broadcast", [])
[u'041ad1e3dd06d29ef59b2c7e19fea4ced0e7fcf9fdc22edcf26e5cc016e10f38']
```

__Available builders according to network__


blockchain|builders
-|-
`*`|transfer, registerSecondSecret, registerSecondPublicKey,
|registerAsDelegate, upVote, downVote, registerMultiSignature, registerIpfs
|delegateResignation, htlcSecret, htlcLock, htlcClaim, htlcRefund,
|switchVote
`ark`, `dark`|entityRegister, entityUpdate, entityResign
`sxp`, `tsxp`|burn
`nos`, `dnos`|TODO

0 comments on commit 522184e

Please sign in to comment.