ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-06 17:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #10 from mDuo13/gh-pages

Browse Source 
sync up gh-pages on the master branch
This commit is contained in:
n0rmz
2014-07-10 18:10:49 -07:00
parent ac72e90e41 a353802356
commit a85b73cd38
4 changed files with 58 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -1 +1,2 @@
/node_modules/
*~

10
index.html
View File

@@ -24,7 +24,7 @@
<link href='https://fonts.googleapis.com/css?family=Open+Sans:600italic,400,700,300' rel='stylesheet' type='text/css'>
<link href='https://dev.ripple.com/css/main.css' rel='stylesheet'>
<link href='css/custom.css' rel='stylesheet'>
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,b){if(!b.__SV){var a,f,i,g;window.mixpanel=b;a=e.createElement("script");a.type="text/javascript";a.async=!0;a.src=("https:"===e.location.protocol?"https:":"http:")+'//cdn.mxpnl.com/libs/mixpanel-2.2.min.js';f=e.getElementsByTagName("script")[0];f.parentNode.insertBefore(a,f);b._i=[];b.init=function(a,e,d){function f(b,h){var a=h.split(".");2==a.length&&(b=b[a[0]],h=a[1]);b[h]=function(){b.push([h].concat(Array.prototype.slice.call(arguments,0)))}}var c=b;"undefined"!==
typeof d?c=b[d]=[]:d="mixpanel";c.people=c.people||[];c.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};c.people.toString=function(){return c.toString(1)+".people (stub)"};i="disable track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config people.set people.set_once people.increment people.append people.track_charge people.clear_charges people.delete_user".split(" ");for(g=0;g<i.length;g++)f(c,i[g]);
@@ -61,6 +61,11 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
$('.header-subnav').removeClass('active');
$('#subnav-rest').addClass('active');
document.title = "Ripple Dev Portal: Ripple-REST API";
} else if (GET_VARS.indexOf("p=gatewayd")>-1) {
var fdfile = "gatewayd.md";
$('.header-subnav').removeClass('active');
$('#subnav-gatewayd').addClass('active');
document.title = "Ripple Dev Portal: gatewayd";
} else {
var fdfile = "intro.md";
$('.header-subnav').removeClass('active');
@@ -84,7 +89,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
</head>
<body role='flatdoc' class='no-literate'>
<!--Draft warning would go here-->
<div style='background-color: #d55;position:fixed;top:0;right:150px; color:white;padding:1em;font-size:15pt;z-index:1000;'>Draft</div>
<div class='header'>
<div class='left'>
<h1>{<i class="icon-ripple-logo"></i>}</h1>
@@ -107,6 +112,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<li><a href='?p=introduction' id='subnav-intro'>Introduction</a></li>
<li><a href='?p=ripple-rest-api' id='subnav-rest'>Ripple-REST API</a></li>
<li><a href='?p=web-sockets-api' id='subnav-websocket'>WebSocket &amp; JSON-RPC APIs</a></li>
<li><a href='?p=gatewayd' id='subnav-websocket'>gatewayd</a></li>
</ul>
<div class='clearer'>&nbsp;</div>
</div>

12
intro.md
View File

@@ -4,7 +4,7 @@ Ripple is a decentralized, peer-to-peer network for moving value using cryptogra
# Ripple Client Applications #
The official web client for the Ripple Network is available at [https://ripple.com/client/](). In order to get an account on the network, you will have to find someone to give or sell you some amount of XRP in excess of the reserve requirement. In the future, official downloadable clients will also be available.
The official web client for the Ripple Network is available at [https://rippletrade.com/](). In order to get an account on the network, you will have to find someone to give or sell you some amount of XRP in excess of the reserve requirement. In the future, official downloadable clients will also be available.
# Ripple APIs #
@@ -16,9 +16,9 @@ If you are building your own client, you have several options of interfaces that
| Tool | Summary | Interface | Abstraction Level | Pros | Cons |
|------|---------|-----------------------|-------------------|------|------|
| [gatewayd](https://github.com/ripple/gatewayd) | Skeleton for implementing gateway functionality as a Node.js application | HTTP | Very high | ✓ Most functionality needed to operate a gateway is already implemented | ✗ Only intended for gateways <br> ✗ Requires Node.js |
| [Ripple-REST](?p=ripple-rest-api) | RESTful interface to `rippled` as a Node.js application | HTTP | High | ✓ Simple robust transaction submission <br> ✓ Broad HTTP-client support | ✗ Lacks access to a few features like viewing currency exchange offers <br> ✗ Requires Node.js |
| [ripple-lib](https://github.com/ripple/ripple-lib) | Reference implementation for accessing the WebSocket API | Javascript | Moderate | ✓ Simple robust transaction submission<span class='draft-comment'>(Confirm this)</span> <br> ✓ Good balance of simplicity and power | ✗ Javascript only (Clients for other languages are in progress) |
| [rippled WebSocket API](?p=web-sockets-api) | Powerful, asynchronous API built on the WebSocket protocol | [WebSocket](http://en.wikipedia.org/wiki/Websocket) | Low | ✓ Access to all Ripple functionality <br> ✓ Can be pushed ordered stream data | ✗ Fewer convenient abstractions <br> ✗ WebSocket clients are rare outside of Javascript |
| [rippled JSON-RPC API](?p=web-sockets-api) <!--note: that's not a typo, the websocket and json-rpc docs are on the same page--> | Powerful, synchronous API built on the [JSON-RPC convention](http://json-rpc.org/) | HTTP | Low | ✓ Access to almost all Ripple functionality <br> ✓ Broad HTTP-client support | ✗ Fewer convenient abstractions <br> ✗ Callbacks may arrive out of order <br> ✗ No incremental pathfinding |
| [gatewayd](https://github.com/ripple/gatewayd) | Skeleton for implementing gateway functionality as a Node.js application | HTTP interface | Very high abstraction | ✓ Most functionality needed to operate a gateway is already implemented | ✗ Only intended for gateways <br> ✗ Requires Node.js |
| [Ripple-REST](?p=ripple-rest-api) | RESTful interface to `rippled` as a Node.js application | HTTP interface | High abstraction | ✓ Simple robust transaction submission <br> ✓ Broad HTTP-client support | ✗ Lacks access to a few features like viewing currency exchange offers <br> ✗ Requires Node.js |
| [ripple-lib](https://github.com/ripple/ripple-lib) | Reference implementation for accessing the WebSocket API | Javascript library | Moderate abstraction | ✓ Simple robust transaction submission<br> ✓ Good balance of simplicity and power | ✗ Javascript only (Clients for other languages are in progress) |
| [rippled WebSocket API](?p=web-sockets-api) | Powerful, asynchronous API built on the WebSocket protocol | [WebSocket](http://en.wikipedia.org/wiki/Websocket) interface | Low abstraction | ✓ Access to all Ripple functionality <br> ✓ Can be pushed ordered stream data | ✗ Fewer convenient abstractions <br> ✗ WebSocket clients are rare outside of Javascript |
| [rippled JSON-RPC API](?p=web-sockets-api) <!--note: that's not a typo, the websocket and json-rpc docs are on the same page--> | Powerful, synchronous API built on the [JSON-RPC convention](http://json-rpc.org/) | HTTP interface | Low abstraction | ✓ Access to almost all Ripple functionality <br> ✓ Broad HTTP-client support | ✗ Fewer convenient abstractions <br> ✗ Callbacks may arrive out of order <br> ✗ No incremental pathfinding |

43
tx_format.md Normal file
View File

@@ -0,0 +1,43 @@
# Transaction Format #
## All Transactions
| Field | Type | Description |
|-------|------|-------------|
| Account | String | The unique address of the account that initiated the transaction |
| Fee | String | Amount of XRP in drops to be destroyed from the sendering account's balance as a fee for redistributing this transaction to the network. (See [Transaction Fees](https://ripple.com/wiki/Transaction_Fee) |
| Flags | Unsigned Integer | (Optional) Set of bit-flags for this transaction |
| LastLedgerSequence | Number | (Optional) Highest valid ledger number that a transaction can appear in. If this is specified, and the transaction is not included by the time the ledger reaches the specified ledger sequence number, then the transaction is considered to have failed and will no longer be valid. |
| Memos | Array | (Optional) Additional arbitrary information used to identify this transaction. <span class='draft-comment'>(The exact format and limitations of this field are subject to change.)</span> |
| PreviousTxnID | String | (Optional) Identifying hash value of the immediately-previous transaction. If provided, that transaction is canceled and this one replaces it. <span class='draft-comment'>(More clarification needed)</span> |
| Sequence | Unsigned Integer | The sequence number, relative to the initiating account, of this transaction. |
| SigningPubKey | String | (Omitted until signed) Hex representation of the public key that corresponds to the private key used to sign this transaction. |
| SourceTag | <span class='draft-comment'>Uint32?</span> | (Optional) <span class='draft-comment'> Allows the creator of transaction to identify the transaction. For payments, specify the DestinationTag for returning funds. (Need more clarification)</span> |
| TransactionType | String | The type of transaction. Valid types include: `Payment`, `OfferCreate`, `OfferCancel`, `TrustSet`, and `AccountSet`. |
| TxnSignature | String | (Omitted until signed) The signature that verifies this transaction as originating from the account it says it is from |
## Payments
| Field | Type | Description |
|-------|------|-------------|
| Amount | String (XRP)<br/>Object (Otherwise) | (Payment only) The amount of currency sent as part of this transaction. |
| Destination | String | (Payment only) The unique address of the account receiving the payment. |
| DestinationTag | Number<span class='draft-comment'>(UInt32?)</span> | (Optional) Arbitrary tag that identifies the reason for the payment to the destination. |
| InvoiceID | String | (Optional) Identifying hash value of another transaction that was an invoice/bill. If provided, mark this transaction as paying that invoice/bill. <span class='draft-comment'>(More clarification needed)</span> |
| Paths | Array | (Payment only) Array of arrays, specifying [payment paths](https://ripple.com/wiki/Payment_paths) for this transaction. |
| SendMax | String/Object | (Payment only) Highest amount of currency this transaction is allowed to cost; this is to compensate for [slippage](http://en.wikipedia.org/wiki/Slippage_%28finance%29). (See [Specifying Currency Amounts](#specifying-currency-amounts)) |
## AccountSet
| Field | Type | Description |
|-------|------|-------------|
| EmailHash
| WalletLocator
| WalletSize
| MessageKey
| Domain
| TransferRate
| SetFlag
| ClearFlag
| Signers