Skip to content

Commit

Permalink
Updated some of the flatworm docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ricmoo committed Aug 23, 2019
1 parent ebfca98 commit 81fd942
Show file tree
Hide file tree
Showing 4 changed files with 1,820 additions and 12 deletions.
33 changes: 29 additions & 4 deletions docs.wrm/api/providers/api-providers.wrm
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,43 @@ resiliance, security and increase the amount of required trust.
To mitigate these issues, it is recommended you use a
[Default Provider](get-default-provider).


_subsection: EtherscanProvider

Tra la la...
The **EtherscanProvider** is backed by a combination of the various
[Etherscan APIs](https://etherscan.io/apis).

_property: provider.getHistory(address) => Array<History>


_subsection: InfuraProvider

Tra la la...
The **InfuraProvider** is backed by the popular [INFURA](https://infura.io)
Ethereum service.

It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
G&ouml;rli and Kovan).


_subsection: NodesmithProvider

Tra la la...
The **NodesmithProvider** is backed by [Nodesmith](https://nodesmith.io).

It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
G&ouml;rli and Kovan), as well as the Ethereum-like network [Aion](https://aion.network).


_subsection: AlchemyProvider

Tra la la...
The **AlchemtProvider** is backed by [Alchemy](https://alchemyapi.io).

It supports Mainnet (homestead) and all common testnets (Ropsten, Rinkeby,
G&ouml;rli and Kovan).


_subsection: CloudfrontProvider

The CloudfrontProvider is backed by the
[Cloudflare Ethereum Gateway](https://developers.cloudflare.com/distributed-web/ethereum-gateway/).

It only supports Mainnet (homestead).
11 changes: 6 additions & 5 deletions docs.wrm/api/signer.wrm
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,24 @@ _section: Signers

Tra la la...

_subsection: Signer
_subsection: Signer @<signer>

_property: signer.connect(provider) => Signer
_property: signer.connect(provider) => [[signer]]
TODO

_heading: Blockchain Methods

_property: signer.getBalance([ blockTag = "latest" ]) => Promise(BigNumber)
_property: signer.getBalance([ blockTag = "latest" ]) => Promise<[[bignumber]]>
TODO

_property: signer.getTransactionCount([ blockTag = "latest" ]) => Promise(number)
_property: signer.getTransactionCount([ blockTag = "latest" ]) => Promise<number>
TODO


_subsection: Wallet inherits Signer

Wallet is...
The Wallet class inherits [[signer]] and can sign transactions and messages
using a private key as a standard Externally Owned Account (EOA).

_heading: Creating an Instance

Expand Down
6 changes: 3 additions & 3 deletions docs.wrm/api/utils/bignumber.wrm
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ the //bitcount// least significant bits set to zero.
_heading: Two's Compliment

[Two's Complicment](https://en.wikipedia.org/wiki/Two%27s_complement)
is a method used to encode and decode fixed-width values which can be
positive or negative, without requiring a separate sign bit. Most users
will not need to interact with these.
is an elegant method used to encode and decode fixed-width signed values
while efficiently preserving mathematic operations.
Most users will not need to interact with these.

_property: bignumber.fromTwos(bitwidth) => [[bignumber]]
Returns a BigNumber with the value of //bignumber// converted from twos-compliment with //bitwidth//.
Expand Down
Loading

0 comments on commit 81fd942

Please sign in to comment.