Commit Graph

1760 Commits

Author SHA1 Message Date
Clinton Alexander
0a29ba4594 Added installation instructions for the demo web UI 2016-07-18 14:39:22 +01:00
Mike Hearn
1715941dce Regen docsite 2016-07-14 10:55:35 +02:00
Ross Nicoll
c32af56b41 Rebuild commercial paper contracts using clauses 2016-07-13 16:55:18 +01:00
Clinton Alexander
bfeea97013 Added documentation for the web demo. 2016-07-13 16:43:13 +01:00
Ross Nicoll
27241fb10a Rebuild documentation 2016-07-12 17:52:52 +01:00
Ross Nicoll
1943b3633f Add documentation on contract clauses 2016-07-12 17:47:51 +01:00
Ross Nicoll
e09710e421 Update contract tutorial example to match JavaCommercialPaper 2016-07-12 14:48:50 +01:00
Ross Nicoll
bb294da857 Minor: Correct class name in tutorial
Correct a reference to "Cash" in the tutorial, is actually "CommercialPaper"
2016-07-12 11:55:52 +01:00
Mike Hearn
0a2f313d40 Minor: run IntelliJ 'code cleanup' 2016-07-11 18:15:28 +02:00
Andras Slemmer
d0903ae265 docs: Rename test tutorial subtitle 2016-07-11 14:25:27 +01:00
Andras Slemmer
dae39bbfc1 docs: Add tutorial on the test DSL 2016-07-11 14:25:27 +01:00
Andras Slemmer
8ca73e51d4 docs: Add build_docs.sh 2016-07-11 12:17:18 +01:00
Mike Hearn
ad3e9be1c8 Add a version number to gradle and allow "gradle install" to install the core module to the local Maven repository. 2016-07-07 13:59:55 +01:00
Mike Hearn
4356cef1cd Regen docsite 2016-06-30 14:49:28 +02:00
Ross Nicoll
2121824662 Rename com.r3cord.contracts.cash package to ...asset 2016-06-30 13:31:59 +01:00
Mike Hearn
63cc3a04ce Review feedback 2016-06-30 12:59:19 +02:00
Andrius Dagys
b30e431766 Update release notes regarding use of TransactionBuilder 2016-06-30 11:46:26 +01:00
Mike Hearn
55675ef799 Refresh docs for M1 release. 2016-06-30 12:23:27 +02:00
rick.parker
5271882dcd Event scheduling and docs for event scheduling 2016-06-30 08:51:52 +01:00
Mike Hearn
cb90a8c09b Add a policy about compiler warnings. 2016-06-27 15:41:18 +02:00
Andrius Dagys
e5e5383e71 Minor formatting and typo fixes 2016-06-22 14:36:01 +01:00
Andrius Dagys
9f1a4e9254 Update docs relating to the multiple notary support work 2016-06-22 13:18:00 +01:00
Andras Slemmer
a8ce69ccb9 docs: add release note on curve switch 2016-06-16 17:03:44 +01:00
Ross Nicoll
ad72f3e48f Add issuer to cash amounts
Add issuer of a cash when referring to amounts of cash (except for the very few cases where
the issuer is not important, such as when referring to aggregated totals across a set of
issuers). Replaces CommonCashState with TokenDefinition, as a more accurate reflection of
what the class represents.
2016-06-16 15:05:49 +01:00
Mike Hearn
aa0a68ba36 Merged in rnicoll-docs-rebuild (pull request #153)
Rebuild documentation
2016-06-16 13:14:50 +02:00
rick.parker
72842eaaf4 Code style changes for properties 2016-06-16 09:43:33 +01:00
Ross Nicoll
2fed96cad0 Rebuild documentation 2016-06-15 17:10:43 +01:00
Ross Nicoll
76a5328e4b Replace TokenDefinition with Issued 2016-06-13 17:39:42 +01:00
Ross Nicoll
a96a05d857 Add note about party type being likely to change 2016-06-13 17:38:18 +01:00
Ross Nicoll
92b25af092 Clarified contents of WireTransaction 2016-06-13 17:38:18 +01:00
Ross Nicoll
14463266db Add definition of state interfaces 2016-06-13 17:38:18 +01:00
Ross Nicoll
4b39ab0357 Clear up wording around how the FungibleAsset superclass is used
Clear up wording around how the FungibleAsset superclass is used, and in particular
that it contains contract code, but provides an interface that should be extended by
subclass state objects.
2016-06-13 17:38:18 +01:00
Ross Nicoll
8d1ac66787 Remove Business Calendar header 2016-06-13 17:38:18 +01:00
Ross Nicoll
874892df93 Move fungible definition up the document 2016-06-13 17:38:18 +01:00
Ross Nicoll
fc3bc163aa Tweak wording (state -> states) 2016-06-13 17:38:18 +01:00
Ross Nicoll
9cdcaaa606 Add documentation of transaction data types 2016-06-13 17:38:18 +01:00
Clinton Alexander
146f274dd0 Demo now requires the setup steps if the configuration is not default. Documentation updated to reflect these changes. 2016-06-08 16:31:58 +01:00
Clinton Alexander
782d50958d IRS demo endpoints are now parameterised for the Trade and Demo modes. Documentation fixes. 2016-06-08 16:30:40 +01:00
Clinton Alexander
0c94637685 Documentation now has separate Windows instructions for running the demos. 2016-06-08 16:30:40 +01:00
Clinton Alexander
fad45eaa91 Updated documentation for the IRS demo. 2016-06-08 16:29:21 +01:00
Ross Nicoll
f4f0e160d2 Genericise Cash contract to support non-Currency things
Split the verification and commands for the Cash contract into a new AbstractCashLike
class, and make Cash a concrete implementation of that class, specialised for dealing
with Currency as the underlying token.
2016-06-07 13:49:26 +01:00
Ross Nicoll
d7b367965f Genericise Amount class
Make the Amount class generic so it doesn't have to represent a quantity of a
currency, but can handle other things such as assets as well, or extended detail
(for example a currency-issuer tuple).
2016-06-01 11:58:13 +01:00
Ross Nicoll
fc62010da6 Move cash contract into its own package 2016-05-31 17:07:36 +01:00
Mike Hearn
bb8944ab17 Docsite: more info on how to cut a release.
In future this will get more complicated as we make the code know its own version, etc. But for now it'll do.
2016-05-25 11:52:16 +02:00
Mike Hearn
4065cb25c0 Regen docsite 2016-05-24 13:48:53 +02:00
Mike Hearn
eabffb7fda Docsite: fix minor issues in the running-the-demos page 2016-05-24 13:48:35 +02:00
Mike Hearn
b6c3359cde Docs: regen docsite 2016-05-24 13:27:23 +02:00
Mike Hearn
68824e9d7e Docsite: added a release notes page 2016-05-24 13:27:16 +02:00
Mike Hearn
1e9f97f890 Docs: regen docsite for new where to start page. 2016-05-23 18:54:38 +02:00
Mike Hearn
1877491a9a Merged in full-scenario-tutorial-doc (pull request #105)
Docs: add a doc that describes how to link the other tutorials together into a demo.
2016-05-23 18:54:09 +02:00
Mike Hearn
8488e4d3ff Regen docsite 2016-05-23 18:05:37 +02:00
Mike Hearn
fffeb4caa9 Docs: fix a typo that caused a parse failure. 2016-05-23 18:03:31 +02:00
Matthew Nesbit
a7c0296f6b Rename node.core to node.internal from Rick's suggestion not to use core outside of the core package. 2016-05-20 16:43:01 +01:00
Matthew Nesbit
f6f56797ce Refactor code into clear core, contracts and node namespaces. Move services into clear implementation and api sides. Push unit tests down to lowest level of dependency hierarchy possible. 2016-05-20 16:42:59 +01:00
Mike Hearn
6c31420d23 Minor: typo fix in running-the-demos.rst doc. 2016-05-19 12:38:00 +02:00
Mike Hearn
073f4a8e7e Merged in docs-setup (pull request #103)
Improve Set Up documentation
2016-05-19 12:22:24 +02:00
Mike Hearn
5e70646bd2 Refactor the trader demo and add comments to make it easier to customise. 2016-05-18 19:10:49 +02:00
Mike Hearn
6f1e2047dd Docs: add a doc that describes how to link the other tutorials together into a demo. 2016-05-18 19:05:33 +02:00
Wawrzyniec Niewodniczanski
ed3b33af19 Cosmetic change
- missing word
- wrong URL
2016-05-18 18:00:38 +01:00
Wawrzyniec Niewodniczanski
6896af25b2 Merge branch 'setup-docs-changes' of bitbucket.org:R3-CEV/r3prototyping into docs-setup 2016-05-18 10:44:11 +01:00
Wawrzyniec Niewodniczanski
e5ef9b28b7 Improve Set Up documentation
- there seems to be some changes to IntelliJ
- some further clarification
2016-05-18 10:39:47 +01:00
Mike Hearn
06cf7a21be Docs: misc markup fixes and adjust an out of date paragraph about oracles. 2016-05-17 19:40:53 +02:00
Mike Hearn
e1f899647a Modify the trader demo so it doesn't need a shell script to start it anymore. Now all configuration is in the driver program. 2016-05-17 18:13:24 +02:00
Matthew Nesbit
4fd32c3455 Merge remote-tracking branch 'remotes/origin/master' into mnesbit-cor-174-reorganise-for-bank-developers 2016-05-16 15:27:44 +01:00
Mike Hearn
e38b101970 Merged in release-process-docs (pull request #88)
Add a page that briefly describes the proposed release process.
2016-05-16 15:55:31 +02:00
Matthew Nesbit
c30564d813 Remove my original project structure proposal, because it doesn't the actual state of refactoring. 2016-05-16 14:51:38 +01:00
Matthew Nesbit
058ac986bd Move contracts base files to namespace to make api aspect clearer in includes.
Move Party to core.crypto as Party is closely aligned with the signing and used in code areas unrelated to the contract code.
2016-05-14 13:47:07 +01:00
Matthew Nesbit
8beaf08239 Convert proposed structure into a doc source file and include in index 2016-05-14 09:33:52 +01:00
Andrius Dagys
7d0ce00978 Minor changes to the Notary doc 2016-05-13 16:17:50 +01:00
Andrius Dagys
0da604e33b Added another chapter on implementation and usage.
Modified TODO comment.
2016-05-13 16:17:50 +01:00
Andrius Dagys
e77d3a40bd Added docs for the Notary 2016-05-13 16:17:50 +01:00
Mike Hearn
d52855bfa2 Regen API docs with new Dokka 2016-05-13 12:55:04 +02:00
Mike Hearn
61605b18e3 Add a page that briefly describes the proposed release process. 2016-05-10 18:44:41 +02:00
Ross Nicoll
9ecf430dde Update documentation to match PartyAndReference naming 2016-05-09 17:55:53 +01:00
Mike Hearn
7499f7cf1f Regen docsite 2016-05-09 18:13:23 +02:00
Richard G Brown
97cb8defd3 Minor edits to data model page and additional section on rationale for UTXO model (including some content from Mike) 2016-05-09 18:12:13 +02:00
Richard G Brown
50e16fb241 Copyright year removed and owner changed from R3 to DLG 2016-05-09 18:08:41 +02:00
Ross Nicoll
20c6be193a Move tutorial.rst to tutorial_contract.rst
Move tutorial.rst to tutorial_contract.rst and rebuild docs
2016-05-09 10:20:40 +01:00
Ross Nicoll
d1bf1b3f92 Update code style documentation
* Remove out of date instruction to put license text in each file.
* Add note that where parameters overflow first line, they should be one-per-line
* Add note on how TODO comments should be structured
2016-05-06 14:59:40 +01:00
Mike Hearn
5eaf86a4b1 Docs: (Re)push auto generated API docs 2016-04-29 18:46:25 +02:00
Mike Hearn
5a3c6e7fed Regen docsite 2016-04-29 18:46:24 +02:00
Mike Hearn
b120ce9fe1 Docs: extend section of contracts tutorial on grouping 2016-04-29 18:46:24 +02:00
Ross Nicoll
17015846d6 Complete sentence on why nodes are not removed from network map automatically 2016-04-29 16:23:16 +01:00
Ross Nicoll
31da33425e Rebuild user documentation 2016-04-28 17:44:33 +01:00
Ross Nicoll
c13b5f247e Add tutorial on building documentation 2016-04-28 17:44:33 +01:00
Ross Nicoll
f0a9c5f7b2 Document network map service 2016-04-28 17:44:32 +01:00
Mike Hearn
8d7b3f4b24 Add a brief mention of AffinityExecutor to the threading section of the code style page. 2016-04-26 12:11:40 +02:00
Mike Hearn
45e89fe4ad Docsite: add info on how to run the IRS demo and rename the demos section 2016-04-18 19:44:21 +02:00
Mike Hearn
d08f7905df Regen docsite and link IRS page into it (was previously invisible) 2016-04-18 19:25:41 +02:00
Richard Green
e1bcfd197b Documentation regen 2016-04-13 10:29:54 +01:00
Richard Green
700a39e5c9 First IRS documentation 2016-04-12 11:26:22 +01:00
Andrius Dagys
3674a547d5 Minor: Fix typos in documentation 2016-04-04 13:48:13 +01:00
Mike Hearn
8305304b95 Regen docsite 2016-03-21 16:54:20 +00:00
Vibhu Mohindra
5fa1634175 Fixed incorrect git repository URL. 2016-03-18 15:46:54 +00:00
Mike Hearn
473e4e527e Regen docs 2016-03-15 17:13:01 +01:00
Mike Hearn
bc5f29c5ee Regen docsite 2016-03-14 16:57:36 +01:00
Mike Hearn
07f925a9f7 Docs: remove roadmap, add a new doc page on oracles. 2016-03-11 13:42:11 +01:00
Mike Hearn
dd6208ef25 Docs: fix font size issue that's visible now I got myself a bigger monitor and changed the default font size in my browser 2016-03-11 13:41:42 +01:00
Mike Hearn
a03352e6cd Export JMX statistics via JSON REST endpoints using Jolokia. 2016-03-09 15:53:32 +01:00
Mike Hearn
975d569e55 Merged irs-oracle into master 2016-03-09 14:38:39 +01:00
Mike Hearn
f9bf50e822 Docs: add robots.txt to keep my ex-employers from stalking me ;) 2016-03-08 18:35:33 +01:00
Mike Hearn
3db5b234d1 Docs: add link from docsite to api docs 2016-03-08 18:32:13 +01:00
Mike Hearn
0476de6560 Regen docsite and include Dokka API docs for the first time 2016-03-08 18:30:52 +01:00
Mike Hearn
29e58ce3db Allow upload of interest rate fixes to the oracle over HTTP. 2016-03-08 17:31:35 +01:00
Mike Hearn
2b4a1eedc3 Generalise support for file uploads over HTTP to allow reuse of the upload servlet. 2016-03-08 17:29:56 +01:00
Mike Hearn
2dcd9c223a Regen docsite 2016-03-04 16:16:03 +01:00
Mike Hearn
4fd4a348cb Add a section to the docsite about node administration, cover attachment upload/download. 2016-03-04 16:15:32 +01:00
Mike Hearn
a40886b63d Mention attachments in the data model docsite page. 2016-03-02 17:44:14 +01:00
Mike Hearn
dfc15a6bab Regen docsite 2016-02-25 13:29:28 +01:00
Mike Hearn
478b6c5fba Trader demo: use a start script instead of Gradle, which simplifies setup.
It also stops Gradle messing with the console output.
2016-02-24 12:58:37 +01:00
Mike Hearn
c3f86f6557 Integrate a simple progress tracking system into the protocol framework.
The progress tracker API lets you model a tree of steps, along the same structure as protocols and subprotocols. Each step has an (optionally changing) label, and thus progress trackers can be arranged in a tree. Updates to the progress at each level flow up the tree via an RxJava observable (I guess we will use this more in future).

A simple console renderer is provided that uses ANSI escapes and Emoji to show animated progress through a protocol.

The trader demo is enhanced to use this framework, when run outside of Gradle.
2016-02-24 12:58:37 +01:00
Mike Hearn
027068b998 Minor: version -> "latest" in docsite 2016-02-18 17:55:11 +01:00
Mike Hearn
d420b1e785 Minor: widen the doc area in the docsite by 200px, stops code overflowing and results in more space for text. 2016-02-18 17:54:41 +01:00
Mike Hearn
ba62330a6e Minor: fix a small bug in the tutorial.rst doc file 2016-02-18 17:47:20 +01:00
Mike Hearn
02f5dc5948 Update the protocol framework documentation 2016-02-18 17:47:05 +01:00
Mike Hearn
9f4897f7c4 Simplifies two-party trade protocol to return SignedTransaction instead of a pair of other forms. 2016-02-12 15:49:18 +01:00
Mike Hearn
6deef5b598 Minor: rename SignedWireTransaction to just SignedTransaction 2016-02-12 15:47:23 +01:00
Mike Hearn
d98a3871da Refactor the 2-party trading protocol
- Fix a security bug/TODO by having seller send back the signatures rather than a full blown transaction (which would allow a malicious seller to try and confuse the buyer by sending back a completely different TX to the one he proposed)
- Introduce an UntrustworthyData<T> wrapper as an (inefficient) form of taint tracking, to make it harder to forget that data has come from an untrustworthy source and may be malicious.
- Split the giant {Buyer, Seller}.call() methods into a set of smaller methods that make it easier to unit test various kinds of failure/skip bits in tests that aren't needed.
2016-02-10 17:59:28 +01:00
Mike Hearn
b023e570fc Docs: update contracts tutorial to talk about generation instead of crafting 2016-02-10 16:29:44 +01:00
Mike Hearn
ac56ea2495 Regen docsite 2016-02-05 15:54:38 +01:00
Mike Hearn
f705eee312 Use buyer/seller instead of alpha/beta and allow nodes to both be named localhost. Update docs. 2016-02-05 15:48:58 +01:00
Mike Hearn
9a818247bb Re-gen docsite 2016-02-03 16:57:01 +01:00
Mike Hearn
c2a10e8fae Add a page to the docsite about the trading demo. 2016-02-03 16:57:01 +01:00
Richard Green
410aeea1d2 Minor doc change 2016-02-03 10:21:20 +00:00
Mike Hearn
52d30b4870 Regen docsite. 2016-01-27 15:07:46 +00:00
Mike Hearn
c16abb2825 Add a coding style guide. 2016-01-27 15:07:46 +00:00
Mike Hearn
d9c6df51f4 Update docs for new simpler protocol framework API. 2016-01-13 13:54:10 +01:00
Mike Hearn
81812d2f2d Kotlin 1.0.0-beta-4584 (docs) 2015-12-24 17:22:00 +00:00
Mike Hearn
049f0aa3b3 Rename PartialTransaction -> TransactionBuilder. The term "partial transaction" should be reserved to mean a transaction that is lacking some signatures as it's in the process of being built up by multiple parties. 2015-12-22 15:28:38 +00:00
Mike Hearn
89b1a5648b Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00
Mike Hearn
c217702606 Merged tx-simplifications into master 2015-12-22 15:07:51 +00:00
Mike Hearn
ef12d474d5 Refresh 'overview' page with info about the latest data model. 2015-12-22 15:03:25 +00:00
Frederic_Dalibard
ba99bfde7c Minor:
- changed Kotlin version
- changed "playground.git" into "r3repository.git"
2015-12-21 22:16:19 +01:00
Mike Hearn
e3cfe0ae49 Docs: fix a few typos and rewrap a few code samples in the state machines article. 2015-12-15 15:52:07 +01:00
Mike Hearn
bf647f6c15 Docs: regen all docs 2015-12-15 14:27:06 +01:00
Mike Hearn
c4549a5ecb Docs: regen HTML 2015-12-15 13:16:20 +01:00
Mike Hearn
06ee9db3f6 Minor: provide a random63BitValue() function and use it instead of the previously duplicated code. Update docs. 2015-12-15 13:16:13 +01:00
Mike Hearn
62f7237364 Docs: regen HTML 2015-12-14 18:22:54 +01:00
Mike Hearn
4198de7ff0 Messaging: add docs on the messaging and protocol state machine systems. 2015-12-14 18:22:21 +01:00
Mike Hearn
b915a30dee Docs: mention what to do if IntelliJ complains about lack of a jdk 2015-12-08 16:47:45 +01:00
Mike Hearn
f7e04e1078 Docs: Mention the crowdfunding in the "in the box" page, regen html 2015-12-07 20:55:03 +01:00
Mike Hearn
e5a36580da Visualiser: reorganise, make it easier to invoke, document it. 2015-12-03 12:00:49 +00:00
Mike Hearn
31ca78533b Docs: regen HTML 2015-12-02 09:50:31 +00:00
Mike Hearn
2f7da660c2 Fill out roadmap doc page and state the core hypothesis that the prototype is exploring on the welcome page. 2015-12-01 14:05:08 +00:00
Mike Hearn
c4d383bf67 Docs: rename institution to party 2015-11-30 17:07:09 +00:00
Mike Hearn
8ea4ac8b15 Rename 'playground' to 'R3 Prototyping' 2015-11-30 17:00:25 +00:00
Mike Hearn
b8a50a65cf Merge branch 'finish-timestamping'
# Conflicts:
#	docs/build/html/searchindex.js
#	src/core/serialization/Kryo.kt
2015-11-30 16:35:10 +00:00
Mike Hearn
09ed50d1ab Docs: address review comments from Richard. 2015-11-30 16:26:09 +00:00
Mike Hearn
42eed3e0a3 Flesh out timestamping logic and fix various serialisation related bugs that it exposes. Timestamps are optional, so update the CommercialPaper contract and tutorial to reflect that. 2015-11-27 18:33:17 +01:00
Mike Hearn
57118d46a8 Docs: Regen HTML 2015-11-27 16:23:32 +01:00
Mike Hearn
e9c60c2722 Docs: finish off the tutorial by adding a section on crafting functions. 2015-11-27 16:23:19 +01:00
Mike Hearn
58ce060211 Regen the HTML 2015-11-25 19:04:35 +01:00
Mike Hearn
b4a3008302 Docs: tutorial typo fixes 2015-11-25 19:04:28 +01:00
Mike Hearn
b6b50f0e7b Docs: tutorial doesn't actually show you how to do a hello world contract, CP is enough 2015-11-25 18:51:37 +01:00
Mike Hearn
2f1a91c101 Docs: regenerate the HTML 2015-11-25 18:49:58 +01:00
Mike Hearn
1ce9bdeba0 Docs: add unit testing to the tutorial 2015-11-25 18:49:44 +01:00
Mike Hearn
ecf70efd2e Update tutorial to reflect code changes in CommercialPaper.kt 2015-11-25 18:17:51 +01:00
Mike Hearn
86a523dd59 Apply review changes suggested by Richard 2015-11-25 18:05:10 +01:00
Mike Hearn
766040da57 Documentation HTML build 2015-11-25 18:01:38 +01:00
Mike Hearn
3dd10714df Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine.
Actual generated HTML will follow in the next commit.
2015-11-25 18:01:37 +01:00