From 0a5e4e21558d3472511a284fb8c96d59f3869d4f Mon Sep 17 00:00:00 2001 From: wilsonianb Date: Thu, 6 Apr 2017 22:30:05 -0700 Subject: [PATCH] Update docs for escrow and paychan activation --- docs/index.md | 14 -------------- docs/src/prepareEscrowCancellation.md.ejs | 2 -- docs/src/prepareEscrowCreation.md.ejs | 2 -- docs/src/prepareEscrowExecution.md.ejs | 2 -- docs/src/preparePaymentChannelClaim.md.ejs | 2 -- docs/src/preparePaymentChannelCreate.md.ejs | 2 -- docs/src/preparePaymentChannelFund.md.ejs | 2 -- docs/src/transactions.md.ejs | 2 -- 8 files changed, 28 deletions(-) diff --git a/docs/index.md b/docs/index.md index dc3cb87e..e0d1fedf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -274,8 +274,6 @@ Type | Description [escrowCancellation](#escrow-cancellation) | An `escrowCancellation` transaction unlocks the funds in an escrow and sends them back to the creator of the escrow, but it will only work after the escrow expires. [escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, but it will only work if the cryptographic condition is provided. -The three "escrow" transaction types are not supported by the production Ripple peer-to-peer network at this time. They are available for testing purposes if you [configure RippleAPI](#boilerplate) to connect to the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) instead. - ## Transaction Flow Executing a transaction with `RippleAPI` requires the following four steps: @@ -3254,8 +3252,6 @@ return api.prepareSettings(address, settings) Prepare an escrow creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description @@ -3312,8 +3308,6 @@ return api.prepareEscrowCreation(address, escrowCreation).then(prepared => Prepare an escrow cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description @@ -3369,8 +3363,6 @@ return api.prepareEscrowCancellation(address, escrowCancellation).then(prepared Prepare an escrow execution transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description @@ -3428,8 +3420,6 @@ return api.prepareEscrowExecution(address, escrowExecution).then(prepared => Prepare a payment channel creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description @@ -3487,8 +3477,6 @@ return api.preparePaymentChannelCreate(address, paymentChannelCreate).then(prepa Prepare a payment channel claim transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description @@ -3543,8 +3531,6 @@ return api.preparePaymentChannelClaim(address, paymentChannelClaim).then(prepare Prepare a payment channel fund transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters Name | Type | Description diff --git a/docs/src/prepareEscrowCancellation.md.ejs b/docs/src/prepareEscrowCancellation.md.ejs index 66904b9f..d4305e76 100644 --- a/docs/src/prepareEscrowCancellation.md.ejs +++ b/docs/src/prepareEscrowCancellation.md.ejs @@ -4,8 +4,6 @@ Prepare an escrow cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-escrow-cancellation.json') %> diff --git a/docs/src/prepareEscrowCreation.md.ejs b/docs/src/prepareEscrowCreation.md.ejs index 3c206c33..cd4c72ea 100644 --- a/docs/src/prepareEscrowCreation.md.ejs +++ b/docs/src/prepareEscrowCreation.md.ejs @@ -4,8 +4,6 @@ Prepare an escrow creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-escrow-creation.json') %> diff --git a/docs/src/prepareEscrowExecution.md.ejs b/docs/src/prepareEscrowExecution.md.ejs index 6f0b0501..4e6d1aa3 100644 --- a/docs/src/prepareEscrowExecution.md.ejs +++ b/docs/src/prepareEscrowExecution.md.ejs @@ -4,8 +4,6 @@ Prepare an escrow execution transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Escrow is currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-escrow-execution.json') %> diff --git a/docs/src/preparePaymentChannelClaim.md.ejs b/docs/src/preparePaymentChannelClaim.md.ejs index 38b52e2e..7abf9313 100644 --- a/docs/src/preparePaymentChannelClaim.md.ejs +++ b/docs/src/preparePaymentChannelClaim.md.ejs @@ -4,8 +4,6 @@ Prepare a payment channel claim transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-payment-channel-claim.json') %> diff --git a/docs/src/preparePaymentChannelCreate.md.ejs b/docs/src/preparePaymentChannelCreate.md.ejs index fc060d7e..99db273b 100644 --- a/docs/src/preparePaymentChannelCreate.md.ejs +++ b/docs/src/preparePaymentChannelCreate.md.ejs @@ -4,8 +4,6 @@ Prepare a payment channel creation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-payment-channel-create.json') %> diff --git a/docs/src/preparePaymentChannelFund.md.ejs b/docs/src/preparePaymentChannelFund.md.ejs index fb0dc0c4..457bcc6c 100644 --- a/docs/src/preparePaymentChannelFund.md.ejs +++ b/docs/src/preparePaymentChannelFund.md.ejs @@ -4,8 +4,6 @@ Prepare a payment channel fund transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit). -**Caution:** Payment channels are currently available on the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) only. - ### Parameters <%- renderSchema('input/prepare-payment-channel-fund.json') %> diff --git a/docs/src/transactions.md.ejs b/docs/src/transactions.md.ejs index e5665e4a..edc0c1cb 100644 --- a/docs/src/transactions.md.ejs +++ b/docs/src/transactions.md.ejs @@ -15,8 +15,6 @@ Type | Description [escrowCancellation](#escrow-cancellation) | An `escrowCancellation` transaction unlocks the funds in an escrow and sends them back to the creator of the escrow, but it will only work after the escrow expires. [escrowExecution](#escrow-execution) | An `escrowExecution` transaction unlocks the funds in an escrow and sends them to the destination of the escrow, but it will only work if the cryptographic condition is provided. -The three "escrow" transaction types are not supported by the production Ripple peer-to-peer network at this time. They are available for testing purposes if you [configure RippleAPI](#boilerplate) to connect to the [Ripple Test Net](https://ripple.com/build/ripple-test-net/) instead. - ## Transaction Flow Executing a transaction with `RippleAPI` requires the following four steps: