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

Fixing get_unspent_outputs documentation #3330

Merged
merged 1 commit into from May 19, 2020

Conversation

DavidBurkett
Copy link
Contributor

params[1] is the (optional) end_index. params[2] is the (required) max number of outputs to return. The documentation mixed up those 2.

Copy link
Member

@quentinlesceller quentinlesceller left a comment

Choose a reason for hiding this comment

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

Are you sure? Looking at the function below (line 500 wish) it is defined like this.

	fn get_unspent_outputs(
		&self,
		start_index: u64,
		end_index: Option<u64>,
		max: u64,
		include_proof: Option<bool>,
	) -> Result<OutputListing, ErrorKind>;

so the null is for the end_index.

@DavidBurkett
Copy link
Contributor Author

It was [1, 2, null, true] which corresponds to: [start_index: 1, end_index: 2, max: null, include_proof: true]

But I'm changing it to [1, null, 2, true] which is: [start_index: 1, end_index: null, max: 2, include_proof: true]

Copy link
Member

@quentinlesceller quentinlesceller left a comment

Choose a reason for hiding this comment

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

Sorry indeed, I wasn't very awake at that moment :)

@quentinlesceller quentinlesceller merged commit 952bdcc into mimblewimble:master May 19, 2020
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.

None yet

2 participants