Problem: There are old links to the IPDB tx spec (#2290)

Solution: Replace those links with appropriate links to the BigchainDB Transactions Specs
This commit is contained in:
Troy McConaghy 2018-05-24 01:36:43 +02:00 committed by vrde
parent dfa4b70f23
commit acc2710d7b
12 changed files with 39 additions and 19 deletions

View File

@ -16,7 +16,7 @@ You can certainly do that!
- There are docs for the JavaScript driver under ``bigchaindb/js-bigchaindb-driver`` in the ``bigchaindb/js-bigchaindb-driver`` repo. - There are docs for the JavaScript driver under ``bigchaindb/js-bigchaindb-driver`` in the ``bigchaindb/js-bigchaindb-driver`` repo.
- The source code for the BigchainDB website is in a private repo, but we can give you access if you ask. - The source code for the BigchainDB website is in a private repo, but we can give you access if you ask.
The IPDB Transaction Spec currently lives in the ``ipdb/ipdb-tx-spec`` repo, but we'll probably move it. The [BigchainDB Transactions Specs](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/) (one for each spec version) are in the ``bigchaindb/BEPs`` repo.
You can write the docs using Markdown (MD) or RestructuredText (RST). Sphinx can understand both. RST is more powerful. You can write the docs using Markdown (MD) or RestructuredText (RST). Sphinx can understand both. RST is more powerful.

View File

@ -13,4 +13,4 @@ BigchainDB can store data of any kind (within reason), but it's designed to be p
.. note:: .. note::
We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the note about "owners" in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `BigchainDB Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_.

View File

@ -15,8 +15,9 @@ To spend/transfer an unspent output, a user (or group of users) must fulfill the
- "…three of these four people must sign." - "…three of these four people must sign."
- "…either Bob must sign, or both Tom and Sylvia must sign." - "…either Bob must sign, or both Tom and Sylvia must sign."
For details, see the section about conditions For details, see the section titled **Transaction Components: Conditions**
in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. in the relevant
`BigchainDB Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_.
Once an output has been spent, it can't be spent again: *nobody* has permission to do that. That is, BigchainDB doesn't permit anyone to "double spend" an output. Once an output has been spent, it can't be spent again: *nobody* has permission to do that. That is, BigchainDB doesn't permit anyone to "double spend" an output.

View File

@ -15,4 +15,4 @@ Crypto-conditions can be quite complex. They can't include loops or recursion an
.. note:: .. note::
We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the note about "owners" in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. We used the word "owners" somewhat loosely above. A more accurate word might be fulfillers, signers, controllers, or transfer-enablers. See the section titled **A Note about Owners** in the relevant `BigchainDB Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_.

View File

@ -30,14 +30,17 @@ Each output also has an associated condition: the condition that must be met
BigchainDB supports a variety of conditions, BigchainDB supports a variety of conditions,
a subset of the [Interledger Protocol (ILP)](https://interledger.org/) a subset of the [Interledger Protocol (ILP)](https://interledger.org/)
crypto-conditions. For details, see crypto-conditions. For details, see
the section about conditions in the [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec). the section titled **Transaction Components: Conditions**
in the relevant
[BigchainDB Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/).
Each output also has a list of all the public keys associated Each output also has a list of all the public keys associated
with the conditions on that output. with the conditions on that output.
Loosely speaking, that list might be interpreted as the list of "owners." Loosely speaking, that list might be interpreted as the list of "owners."
A more accurate word might be fulfillers, signers, controllers, A more accurate word might be fulfillers, signers, controllers,
or transfer-enablers. or transfer-enablers.
See the note about "owners" in the [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec). See the section titled **A Note about Owners**
in the relevant [BigchainDB Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/).
A CREATE transaction must be signed by all the owners. A CREATE transaction must be signed by all the owners.
(If you're looking for that signature, (If you're looking for that signature,
@ -87,7 +90,7 @@ things. We documented those things in a post on *The BigchainDB Blog*:
["What is a Valid Transaction in BigchainDB?"](https://blog.bigchaindb.com/what-is-a-valid-transaction-in-bigchaindb-9a1a075a9598) ["What is a Valid Transaction in BigchainDB?"](https://blog.bigchaindb.com/what-is-a-valid-transaction-in-bigchaindb-9a1a075a9598)
(Note: That post was about BigchainDB Server v1.0.0.) (Note: That post was about BigchainDB Server v1.0.0.)
The [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec) documents the conditions for a transaction to be valid. Each [BigchainDB Transactions Spec](https://github.com/bigchaindb/BEPs/tree/master/tx-specs/) documents the conditions for a transaction (of that version) to be valid.
## Example Transactions ## Example Transactions

View File

@ -1,8 +1,8 @@
Cryptography Cryptography
============ ============
See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_, Use the following link to find the BigchainDB Transactions Spec (or Specs) that are relevant to you:
especially the sections about:
- Cryptographic Hashes `BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
- Cryptographic Keys & Signatures
Then see the sections titled **Cryptographic Hashes** and **Cryptographic Keys and Signatures**.

View File

@ -1,5 +1,8 @@
JSON Serialization JSON Serialization
================== ==================
See the section about JSON Serialization & Deserialization Use the following link to find the BigchainDB Transactions Spec (or Specs) that are relevant to you:
in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
`BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
Then see the section titled **JSON Serialization and Deserialization**.

View File

@ -1,4 +1,8 @@
The Asset Model The Asset Model
=============== ===============
See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. Use the following link to find the BigchainDB Transactions Spec (or Specs) that are relevant to you:
`BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
Then see the section titled **Transaction Components: Asset**.

View File

@ -1,4 +1,8 @@
Conditions Conditions
========== ==========
See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. Use the following link to find the BigchainDB Transactions Spec (or Specs) that are relevant to you:
`BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
Then see the section titled **Transaction Components: Conditions**.

View File

@ -1,4 +1,8 @@
Inputs and Outputs Inputs and Outputs
================== ==================
See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. Use the following link to find the BigchainDB Transactions Spec (or Specs) that are relevant to you:
`BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
Then see the sections titled **Transaction Components: Inputs** and **Transaction Components: Outputs**.

View File

@ -3,4 +3,4 @@
The Transaction Model The Transaction Model
===================== =====================
See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_. See the `BigchainDB Transactions Specs <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_.

View File

@ -134,7 +134,8 @@ Transactions
.. note:: .. note::
The posted transaction should be valid. The posted transaction should be valid.
The `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_ The relevant
`BigchainDB Transactions Spec <https://github.com/bigchaindb/BEPs/tree/master/tx-specs/>`_
explains how to build a valid transaction explains how to build a valid transaction
and how to check if a transaction is valid. and how to check if a transaction is valid.
One would normally use a driver such as the `BigchainDB Python Driver One would normally use a driver such as the `BigchainDB Python Driver