ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-28 00:38:55 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
045891cc15
corda/docs/source/api-rpc.rst
Joel Dudley f0138dfe17 Tutorial refresh for v1.0 and moving of code into separate files. (#1758) 
* Moves code sections in tutorials to code files.

* Removes wallet references.

* Updates repo layout doc.

* Removes remaining cordapp-tutorial references, replaced with cordapp-example.

* Fixes broken link.

* Misc docs fixes.

* Refreshes the ServiceHub and rpc ops api pages.

* Updates the cheat sheet.

* Updates cookbooks.

* Refreshes the running-a-notary tutorial.

* Updates flow-testing tutorial

* Updates tear-offs tutorial.

* Refreshes integration-testing tutorial.

* Updates to contract tutorial and accompanying code to bring inline with V1 release.

* Refreshes contract-upgrade tutorial.

* Fixed broken code sample in "writing a contract" and updated contracts dsl.

* Added contract ref to java code. Fixed broken rst markup.

* Updates transaction-building tutorial.

* Updates the client-rpc and flow-state-machines tutorials.

* Updates the oracles tutorial.

* Amended country in X500 names from "UK" to "GB"

* Update FlowCookbook.kt

* Amended cheatsheet. Minor update on contract upgrades tutoraial.

* Added `extraCordappPackagesToScan` to node driver.

* Changes to match new function signature.

* Update to reflect change in location of cash contract name.
2017-10-02 10:11:33 +01:00

1.3 KiB
Raw Blame History

API: RPC operations

The node's owner interacts with the node solely via remote procedure calls (RPC). The node's owner does not have access to the node's ServiceHub.

The key RPC operations exposed by the node are:

  • CordaRPCOps.vaultQueryBy
    • Extract states from the node's vault based on a query criteria
  • CordaRPCOps.vaultTrackBy
    • As above, but also returns an observable of future states matching the query
  • CordaRPCOps.networkMapFeed
    • A list of network nodes, and an observable of changes to the network map
  • CordaRPCOps.registeredFlows
    • See a list of registered flows on the node
  • CordaRPCOps.startFlowDynamic
    • Start one of the node's registered flows
  • CordaRPCOps.startTrackedFlowDynamic
    • As above, but also returns a progress handle for the flow
  • CordaRPCOps.nodeInfo
    • Returns information about the node
  • CordaRPCOps.currentNodeTime
    • Returns the current time according to the node's clock
  • CordaRPCOps.partyFromKey/CordaRPCOps.wellKnownPartyFromX500Name
    • Retrieves a party on the network based on a public key or X500 name
  • CordaRPCOps.uploadAttachment/CordaRPCOps.openAttachment/CordaRPCOps.attachmentExists
    • Uploads, opens and checks for the existence of attachments