Skip to content
This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

add inline docs to many actor methods #258

Merged
merged 10 commits into from
Feb 21, 2023
Merged

add inline docs to many actor methods #258

merged 10 commits into from
Feb 21, 2023

Conversation

emmanuelm41
Copy link
Member

@emmanuelm41 emmanuelm41 commented Feb 21, 2023 •
edited by zboto bot
Loading

closes #252

馃敆 zboto Link

@emmanuelm41 emmanuelm41 marked this pull request as draft February 21, 2023 17:59
@github-actions
Copy link

Gas results 馃殌馃摑

Account actor

Function Gas
authenticate_message 25433722
universal_receiver_hook 5165801

Datacap actor

Function Gas
name 6190229
symbol 5936561
total_supply 7963426
balance 7110497
allowance 8172447
transfer 17819926
transfer_from 25470895
burn 11560354
burn_from 18455143
allowance 11457058
increase_allowance 14216919
decrease_allowance 14220116
revoke_allowance 12853367

Init actor

Function Gas
exec 19957037
exec4 7128661

Market actor

Function Gas
add_balance 8148160
withdraw_balance 10971033
get_balance 12304547
get_deal_data_commitment 11444020
get_deal_client 6793088
get_deal_provider 6789592
get_deal_label 11649527
get_deal_term 7359857
get_deal_total_price 8909679
get_deal_client_collateral 8717825
get_deal_provider_collateral 8724005
get_deal_verified 6702662
get_deal_activation 7404301
publish_storage_deals 3090103

Power actor

Function Gas
miner_count 5303381
network_raw_power 5743979
miner_raw_power 7249237
miner_consensus_count 5313929

Precompiles actor

Function Gas
resolve_address 2394838
lookup_delegated_address (empty response) 2312539
lookup_delegated_address (address found) 2399543
resolve_eth_address 2518834

Send actor

Function Gas
send 3516582

Verifreg actor

Function Gas
add_verified_client 13620726
get_claims 10437183
extend_claim_term 11758131
remove_expired_allocations 13388106
remove_expired_claims 11758131

@github-actions
Copy link

Gas results 馃殌馃摑

Account actor

Function Gas
authenticate_message 25432950
universal_receiver_hook 5165029

Datacap actor

Function Gas
name 6190229
symbol 5936561
total_supply 7963426
balance 7110497
allowance 8172447
transfer 17819926
transfer_from 25470895
burn 11560354
burn_from 18455143
allowance 11457058
increase_allowance 14216919
decrease_allowance 14220116
revoke_allowance 12853367

Init actor

Function Gas
exec 19957037
exec4 7128661

Market actor

Function Gas
add_balance 8148160
withdraw_balance 10971033
get_balance 12304547
get_deal_data_commitment 11444020
get_deal_client 6793088
get_deal_provider 6789592
get_deal_label 11649527
get_deal_term 7359857
get_deal_total_price 8909679
get_deal_client_collateral 8717825
get_deal_provider_collateral 8724005
get_deal_verified 6702662
get_deal_activation 7404301
publish_storage_deals 3090103

Power actor

Function Gas
miner_count 5303381
network_raw_power 5743979
miner_raw_power 7249237
miner_consensus_count 5313929

Precompiles actor

Function Gas
resolve_address 2394838
lookup_delegated_address (empty response) 2312539
lookup_delegated_address (address found) 2399543
resolve_eth_address 2518834

Send actor

Function Gas
send 3516582

Verifreg actor

Function Gas
add_verified_client 13620114
get_claims 10436571
extend_claim_term 11757519
remove_expired_allocations 13387494
remove_expired_claims 11757519

@github-actions
Copy link

Gas results 馃殌馃摑

Account actor

Function Gas
authenticate_message 25432470
universal_receiver_hook 5164549

Datacap actor

Function Gas
name 6190657
symbol 5936989
total_supply 7963854
balance 7110925
allowance 8172875
transfer 17820354
transfer_from 25471323
burn 11560782
burn_from 18455571
allowance 11457486
increase_allowance 14217347
decrease_allowance 14220544
revoke_allowance 12853795

Init actor

Function Gas
exec 19956961
exec4 7128585

Market actor

Function Gas
add_balance 8148160
withdraw_balance 10971033
get_balance 12304547
get_deal_data_commitment 11444020
get_deal_client 6793088
get_deal_provider 6789592
get_deal_label 11649527
get_deal_term 7359857
get_deal_total_price 8909679
get_deal_client_collateral 8717825
get_deal_provider_collateral 8724005
get_deal_verified 6702662
get_deal_activation 7404301
publish_storage_deals 3090103

Power actor

Function Gas
miner_count 5303141
network_raw_power 5743739
miner_raw_power 7248997
miner_consensus_count 5313689

Precompiles actor

Function Gas
resolve_address 2394838
lookup_delegated_address (empty response) 2312539
lookup_delegated_address (address found) 2399543
resolve_eth_address 2518834

Send actor

Function Gas
send 3516582

Verifreg actor

Function Gas
add_verified_client 13619606
get_claims 10436063
extend_claim_term 11757011
remove_expired_allocations 13386986
remove_expired_claims 11757011

@github-actions
Copy link

Gas results 馃殌馃摑

Account actor

Function Gas
authenticate_message 25432922
universal_receiver_hook 5165001

Datacap actor

Function Gas
name 6190469
symbol 5936801
total_supply 7963666
balance 7110737
allowance 8172687
transfer 17820166
transfer_from 25471135
burn 11560594
burn_from 18455383
allowance 11457298
increase_allowance 14217159
decrease_allowance 14220356
revoke_allowance 12853607

Init actor

Function Gas
exec 19956557
exec4 7128181

Market actor

Function Gas
add_balance 8148240
withdraw_balance 10971113
get_balance 12304627
get_deal_data_commitment 11444100
get_deal_client 6793168
get_deal_provider 6789672
get_deal_label 11649607
get_deal_term 7359937
get_deal_total_price 8909759
get_deal_client_collateral 8717905
get_deal_provider_collateral 8724085
get_deal_verified 6702742
get_deal_activation 7404381
publish_storage_deals 3090183

Power actor

Function Gas
miner_count 5303941
network_raw_power 5744539
miner_raw_power 7249797
miner_consensus_count 5314489

Precompiles actor

Function Gas
resolve_address 2395718
lookup_delegated_address (empty response) 2313419
lookup_delegated_address (address found) 2400423
resolve_eth_address 2519714

Send actor

Function Gas
send 3516422

Verifreg actor

Function Gas
add_verified_client 13619126
get_claims 10435583
extend_claim_term 11756531
remove_expired_allocations 13386506
remove_expired_claims 11756531

@emmanuelm41 emmanuelm41 marked this pull request as ready for review February 21, 2023 21:17
@emmanuelm41 emmanuelm41 merged commit 7ab519c into master Feb 21, 2023
@emmanuelm41 emmanuelm41 deleted the feat/docs branch February 21, 2023 21:17
longfeiWan9 pushed a commit to longfeiWan9/filecoin-solidity that referenced this pull request Mar 7, 2023
@emmanuelm41 @longfeiWan9
add inline docs to many actor methods (Zondax#258)
fa3aaf3 
* feat: add docs to many actor methods

* feat: add inline comments for verif reg and account types

* feat: add inline docs for Power actor

* feat: add inline docs for DataCap actor

* feat: add more inline comments to code

* feat: add more inline comments to code

* feat: add more inline comments to cbor libs

* feat: add more inline comments to cbor libs

* feat: add better inline comments on test contracts

* fix: compile libs correctly again
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve inline documentation
1 participant
@emmanuelm41