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
More integration tests #302
Conversation
Added stealth address example, as per the unsystem wiki. Might be worth looking to whether we should add an API to make this easy for people as well. ping @caedesvvv , thoughts? |
I like this approach to adding examples, because it prevents example code from rotting. I'm not sure we should use brand names for filenames as it might be seen as an endorsement. The helloblock example is there to illustrate p2sh spending and darkwallet stealth address. Not sure the brainwallet one is necessary as we already have message signing and verification under unit tests. |
I agree on the branding not being great. But the purpose was for feature
|
helloblock.js -> p2sh.js |
What about the README/generic examples? On Sun, Oct 19, 2014 at 5:11 PM, Wei Lu notifications@github.com wrote:
|
Either readme.js stays as is or rename to basic.js. And perhaps instead of code examples on readme we can create the following links to code: How-To |
Confirm the only thing blocking this was the renames? |
that and if we want to get rid of brainwallet examples |
@weilu should be good to go now. |
@dcousens we might want to pin the links to examples to [sha of next release tag]~2 such that anyone with a release version of the code will have valid example references in the readme. |
The example links should remain valid unless someone updates the tests, no? Or did I miss what you were saying? |
@dcousens yes. The situation I'm trying avoid is when someone install bitcoinjs-lib using npm, then they navigate to the README in their node_modules, following one of the links which points to master for examples, but the examples has been updated since the version they have. If we do what I described above, they'd end up with links pinned to a sha instead of master. |
These are acting as basic integration tests, as well as simplified examples that are easy for users to look at.
I think combined with different efforts in #272, this will make it quicker to get started for users.