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.

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

chore!: documented all the builders. #39

Merged
merged 5 commits into from
Jan 24, 2025
Merged

chore!: documented all the builders. #39

merged 5 commits into from
Jan 24, 2025

Conversation

akorchyn
Copy link
Collaborator

@akorchyn akorchyn commented Jan 16, 2025

  • Documented all the builder methods across the entire library.
  • Added examples for all the top-level functions. (78 documentation examples in total)
  • A few small changes to improve API (sponsor_by_faucet doesn't need an extra argument, allowed to specify gas and deposit for init call during deploy, accept BlockReference as Into)
    @race-of-sloths

@akorchyn akorchyn marked this pull request as ready for review January 16, 2025 15:28
@race-of-sloths
Copy link

race-of-sloths commented Jan 16, 2025

@akorchyn Thank you for your contribution! Your pull request is now a part of the Race of Sloths!
Are you going to win race-of-sloths this month? If so, you should speed up! Run, Sloth, run!

Shows inviting banner with latest news.

Shows profile picture for the author of the PR

Current status: executed
Reviewer Score
@dj8yfo 13

Your contribution is much appreciated with a final score of 13!
You have received 160 (130 base + 15 weekly bonus + 10% lifetime bonus) Sloth points for this contribution

@dj8yfo received 25 Sloth Points for reviewing and scoring this pull request.

Another weekly streak completed, well done @akorchyn! To keep your weekly streak and get another bonus make pull request next week! Looking forward to see you in race-of-sloths

What is the Race of Sloths

Race of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow

For contributors:

  • Tag @race-of-sloths inside your pull requests
  • Wait for the maintainer to review and score your pull request
  • Check out your position in the Leaderboard
  • Keep weekly and monthly streaks to reach higher positions
  • Boast your contributions with a dynamic picture of your Profile

For maintainers:

  • Score pull requests that participate in the Race of Sloths and receive a reward
  • Engage contributors with fair scoring and fast responses so they keep their streaks
  • Promote the Race to the point where the Race starts promoting you
  • Grow the community of your contributors

Feel free to check our website for additional details!

Bot commands
  • For contributors
    • Include a PR: @race-of-sloths include to enter the Race with your PR
  • For maintainers:
    • Invite contributor @race-of-sloths invite to invite the contributor to participate in a race or include it, if it's already a runner.
    • Assign points: @race-of-sloths score [1/2/3/5/8/13] to award points based on your assessment.
    • Reject this PR: @race-of-sloths exclude to send this PR back to the drawing board.
    • Exclude repo: @race-of-sloths pause to stop bot activity in this repo until @race-of-sloths unpause command is called

Copy link
Collaborator

@dj8yfo dj8yfo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@race-of-sloths score 13

About the most important comments i can think of are the ones about missing
let result: near_primitives::views::FinalExecutionOutcomeView ,
because i guess in these cases an api user has to do one more step to ensure successful result of api calls than suggested in doc examples.

src/account/create.rs Outdated Show resolved Hide resolved
src/account/create.rs Outdated Show resolved Hide resolved
src/account/create.rs Outdated Show resolved Hide resolved
src/account/create.rs Outdated Show resolved Hide resolved
src/account/create.rs Outdated Show resolved Hide resolved
src/stake.rs Show resolved Hide resolved
src/stake.rs Show resolved Hide resolved
src/stake.rs Show resolved Hide resolved
src/stake.rs Show resolved Hide resolved
src/stake.rs Show resolved Hide resolved
@akorchyn akorchyn enabled auto-merge (squash) January 24, 2025 13:48
@akorchyn akorchyn merged commit 1df2fbd into main Jan 24, 2025
7 checks passed
@akorchyn akorchyn deleted the builder-docs branch January 24, 2025 13:51
@frol frol mentioned this pull request Jan 17, 2025
@akorchyn akorchyn linked an issue Jan 24, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
3 participants