Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix the usage description of block.difficulty and block._difficulty in v5 #2821

Closed
wants to merge 4 commits into from
Closed

Fix the usage description of block.difficulty and block._difficulty in v5 #2821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2cd9f1
Update the description of block.difficulty
a2468834 Mar 18, 2022
3311cca
Update the description of block.difficulty
a2468834 Mar 18, 2022
9e9ff7f
Fix wording
a2468834 Mar 18, 2022
c18219b
Fix wording
a2468834 Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/v5/api/providers/types/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,12 @@ The nonce used as part of the proof-of-work to mine this block.
This property is generally of little interest to developers.


#### *block* . **difficulty** => *number*
#### *block* . **difficulty** => *null*

Because the difficulty had reached the limit of IEEE754 numbers, this property is temporarily deprecated at v5. It will be available again at v6.


#### *block* . **_difficulty** => *[BigNumber](/v5/api/utils/bignumber/)*

The difficulty target required to be met by the miner of the block.

Expand Down
4 changes: 3 additions & 1 deletion docs/v5/api/providers/types/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@

<p>This property is generally of little interest to developers.</p>

</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">difficulty</span> <span class="arrow">&rArr;</span> <span class="returns">number</span><div class="anchors"></div></div><div class="body"><p>The difficulty target required to be met by the miner of the block.</p>
</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">difficulty</span> <span class="arrow">&rArr;</span> <span class="returns">null</span><div class="anchors"></div></div><div class="body"><p>Because the difficulty had reached the limit of IEEE754 numbers, this property is temporarily deprecated at v5. It will be available again at v6.</p>

</div></div><div class="property show-anchors"><div class="signature"><span class="path">block</span><span class="symbol">.</span><span class="method">_difficulty</span> <span class="arrow">&rArr;</span> <span class="returns"><a href="/v5/api/utils/bignumber/">BigNumber</a></span><div class="anchors"></div></div><div class="body"><p>The difficulty target required to be met by the miner of the block.</p>

<p>This property is generally of little interest to developers.</p>

Expand Down