Commit Graph

543 Commits

Author SHA1 Message Date
mDuo13
ad335133a2 [DOC] gws: first draft at actually defining a payment obj. 2014-10-17 20:04:53 -07:00
mDuo13
a5b9750006 [DOC] revisions after meeting 2014-10-17 13:08:53 -07:00
mDuo13
9da64424f6 [DOC] gateway_services slight updates 2014-10-16 00:29:40 -07:00
Rome Reginelli
290cf49df1 Merge pull request #80 from mDuo13/gh-pages
[DOC] finished Ripple-REST reformatting
2014-10-10 18:26:51 -07:00
mDuo13
467ad01556 [DOC] finished Ripple-REST reformatting 2014-10-10 18:25:15 -07:00
mDuo13
315352a1fc [DOC] fix syntax in gateway_services 2014-10-09 17:43:44 -07:00
mDuo13
5770e7d3e2 [DOC] more gateway services spec changes 2014-10-09 17:42:12 -07:00
mDuo13
1f2be06eef [DOC] gateway services revisions and more 2014-10-09 14:53:59 -07:00
Rome Reginelli
9c64b787ff Merge pull request #79 from ripple/gh-pages
Dev Portal from Staging to Master for 10/8 second push
v2014-10-08-2
2014-10-08 18:41:21 -07:00
Rome Reginelli
07fd5ce872 Merge pull request #78 from mDuo13/gh-pages
[DOC] tx_format - clarify partial payments ( DEV-55 )
2014-10-08 18:40:39 -07:00
mDuo13
af8f2ed50e [DOC] tx_format - clarify partial payments ( DEV-55 ) 2014-10-08 18:39:27 -07:00
mDuo13
6b75c9ee83 [DOC] more gateway_services details 2014-10-08 18:02:28 -07:00
mDuo13
0a8bdf387e [DOC] Gateway Services spec - incomplete draft 2014-10-08 18:01:21 -07:00
Rome Reginelli
092d715bfa Merge pull request #77 from ripple/gh-pages
Dev Portal from Staging to Master for 10/8 push
v2014-10-08
2014-10-08 15:15:56 -07:00
Rome Reginelli
63246c37c2 Merge pull request #76 from mDuo13/gh-pages
REST - clarifications on errors and memo unicode
2014-10-08 15:13:16 -07:00
mDuo13
e1fc112df1 [DOC] Added clarification on memos and UTF-8 2014-10-08 15:12:21 -07:00
mDuo13
eb33c7e446 [DOC] REST- slight clarification on error formatting 2014-10-08 14:50:16 -07:00
Rome Reginelli
5bca4a1319 Merge pull request #75 from mDuo13/gh-pages
Several important doc improvements including fee_mult_max
2014-10-08 13:19:12 -07:00
mDuo13
07a92022b3 [FIX] REST APItool links updated to reflect new REST docs 2014-10-08 13:17:12 -07:00
mDuo13
ec74ec90cb [DOC] REST memos, clarifications 2014-10-08 13:12:50 -07:00
mDuo13
2aa95a4023 [DOC] fee_mult_max documentation 2014-10-08 13:12:10 -07:00
mDuo13
fd0354f957 Merge branch 'master' of https://github.com/ripple/ripple-dev-portal into gh-pages 2014-10-08 12:02:22 -07:00
mDuo13
5e229a1138 [DOC] REST revisions for account settings; also some mild restructuring 2014-10-08 12:01:35 -07:00
mDuo13
723e70a5ea [MERGE] Merge branch 'gh-pages' of https://github.com/mDuo13/ripple-dev-portal into gh-pages 2014-10-06 17:16:25 -07:00
mDuo13
44c9340902 [DOC] rippled - first pass of fee_mult_max 2014-10-06 17:16:07 -07:00
mDuo13
e4374c3214 [MERGE] Merge branch 'gh-pages' of https://github.com/mDuo13/ripple-dev-portal into gh-pages 2014-10-04 10:07:16 -07:00
mDuo13
844640f141 [STYLE] wider tables, more text contrast, fix green buttons 2014-10-03 14:41:33 -07:00
Rome Reginelli
8fe388de6f Merge pull request #74 from ripple/gh-pages
Dev Portal from Staging to Master for 10/3 push
v2014-10-03
2014-10-03 13:55:45 -07:00
Rome Reginelli
7228faf419 Merge pull request #73 from mDuo13/gh-pages
Small revisions in tx_format and rest tool
2014-10-03 13:22:29 -07:00
mDuo13
dff1e04c18 [MERGE] Merge branch 'gh-pages' of https://github.com/mDuo13/ripple-dev-portal into gh-pages 2014-10-03 09:42:15 -07:00
mDuo13
c43c2f0915 [DOC] REST - started reformatting method ref 2014-10-03 09:41:40 -07:00
mDuo13
d99b264cff [FEATURE] REST API Tool: query p arams for Get Acct Balances 2014-10-03 09:41:06 -07:00
mDuo13
e6f753aa72 [TASK] REST API Tool - remove redundant test accts warning 2014-10-02 16:08:45 -07:00
mDuo13
b909e200fa [DOC] minor clarification on PreviousTxnID 2014-10-01 14:52:07 -07:00
mDuo13
10fa680688 [DOC] tx_format - alphabetized and clarified AccountTxnID, added Creating Accounts section. 2014-10-01 00:13:41 -07:00
mDuo13
b689061d89 [DOC] tx_format revisions as per pull request #72 2014-09-30 16:37:02 -07:00
Rome Reginelli
8303508670 Merge pull request #71 from mDuo13/gh-pages
Updates to tx_format
2014-09-29 16:27:42 -07:00
mDuo13
c7c7f30845 [DOC] tx_format revisions & related rippled submit/sign tweaks 2014-09-29 16:23:14 -07:00
Rome Reginelli
96164d68e2 Merge pull request #9 from ripple/master
Catching up to master
2014-09-29 11:11:28 -07:00
Rome Reginelli
3abd182ea8 Merge pull request #70 from sublimator/master
merging so credit is given where credit is due; I'll update/edit as necessary
2014-09-29 11:08:11 -07:00
Nicholas Dudfield
a4a9b734f8 Update SetRegularKey section
Change Internal Type to Account

An account is a 160 bit hash of a public key in compressed form (pub |
sha256 | ripemd160). The RegularKey field has the same json
representation as the Account fields, which are likewise hashes.
2014-09-26 18:53:53 +07:00
Nicholas Dudfield
39f4a1cb08 Update Paths section
SendMax implies source balance when no direct trustline to Destination
Paths MUST be set when cross-currency/cross-issue payments are made
Empty Paths may not be serialized (ripple-lib doesn't serialize them,
rippled errors)

Crash script for empty Paths:

```shell

export ALICE='rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn'
export BOB='rPMh7Pi9ct699iZUTWaytJUoHcJ7cgyziK'
export ROOT='rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh'

function close_ledger()
{
    ./build/rippled ledger_accept
}

function submit()
{
    ./build/rippled submit $1 "$2"
}

function json-rpc()
{
    curl -X POST -v http://127.0.0.1:5005 -d "$(cat <<RPC
    {
        "method" : "$1",
        "params"  : [$2]
    }
RPC
)" | python -c 'import sys,json; print
json.dumps(json.loads(sys.stdin.read()), indent=2)'
}

submit masterpassphrase "$(cat <<TXN
    {
        "TransactionType" : "Payment",
        "Account" : "$ROOT",
        "Destination" : "$BOB",
        "Amount" : "1000000000"
    }
TXN
)"

close_ledger

submit bob "$(cat <<TXN
    {
        "TransactionType" : "TrustSet",
        "Account" : "$BOB",
        "LimitAmount" : {"value" : "500", "currency" : "USD", "issuer" :
        "$ROOT"}
    }
TXN
)"

submit masterpassphrase "$(cat <<TXN
    {
        "Account" : "$ROOT"
       ,"TransactionType" : "Payment",
        "Destination" : "$BOB"
       ,"Amount" : {"value" : "1", "currency" : "USD", "issuer" :
       "$ROOT"}
       , "Paths" : []
    }
TXN
)"

    # {
    #    "result" : {

    #       "error" : "internal",
    #       "error_code" : 59,
    #       "error_message" : "Exception occurred during transaction",

    #       "request" : {
    #          "command" : "submit",
    #          "secret" : "masterpassphrase",
    #          "tx_json" : {
    #             "Account" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    #             "Amount" : {
    #                "currency" : "USD",
    #                "issuer" : "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    #                "value" : "500"
    #             },
    #             "Destination" : "rPMh7Pi9ct699iZUTWaytJUoHcJ7cgyziK",
    #             "Paths" : [],
    #             "TransactionType" : "Payment"
    #          }
    #       },
    #       "status" : "error"
    #    }
    # }

```
2014-09-26 18:47:00 +07:00
Nicholas Dudfield
7582184ea5 Update Memos section:
Include `Internal Type` in the table
List the `MemoData` and `MemoFormat` fields (TODO: descriptions)
Add example json, as the format is "weird"
Show that the fields are variable length, and the json for this type is
a hex string
Make it clear that the 1 kbyte limit applies to the field as serialized

For further reference:
https://gist.github.com/justmoon/9462822
https://wiki.ripple.com/Example_API_Transactions

TODO:
Check the semantics and/or usage guidelines behind MemoData/MemoType/MemoFormat
2014-09-26 18:15:42 +07:00
Nicholas Dudfield
4e6adb1f34 Clean trailing whitespace 2014-09-26 18:10:46 +07:00
Nicholas Dudfield
71932be386 PreviousTxnID -> AccountTxnID
PreviousTxnID (deprecated) mandates the PreviousTxnID field,
 present in the transaction to match that in the AccountRoot of
the initiating Account. Note that this field is update on EVERY
transaction affecting the account (eg. 1 drop inbound payments)

See: https://wiki.ripple.com/Transaction_Metadata#Threading

Relevant source from Transactor.cpp:211

    // Deprecated: Do not use
    if (mTxn.isFieldPresent (sfPreviousTxnID) &&
            (mTxnAccount->getFieldH256 (sfPreviousTxnID) !=
    mTxn.getFieldH256 (sfPreviousTxnID)))
        return tefWRONG_PRIOR;

    if (mTxn.isFieldPresent (sfAccountTxnID) &&
            (mTxnAccount->getFieldH256 (sfAccountTxnID) !=
            mTxn.getFieldH256 (sfAccountTxnID)))
        return tefWRONG_PRIOR;
2014-09-26 17:58:37 +07:00
Nicholas Dudfield
d79b84ed43 Fix some typos / grammatical errors 2014-09-26 17:51:41 +07:00
Rome Reginelli
1aebd976ea Merge pull request #69 from ripple/gh-pages
Staging to Master for 9/25 push
v2014-09-25
2014-09-25 18:00:07 -07:00
Rome Reginelli
2430809517 Merge pull request #68 from mDuo13/gh-pages
REST API tool improvements
2014-09-25 17:59:10 -07:00
mDuo13
daf5bca353 [FEATURE] REST API Tool breaks out editable components of URL only, move method to a button instead of a dropdown 2014-09-25 17:55:01 -07:00
mDuo13
bd99c824c7 [DOC] REST revisions - intro material and formatting 2014-09-24 18:18:44 -07:00