Updated all refs to the IPDB Transaction Spec & its URL

This commit is contained in:
Troy McConaghy 2018-01-10 14:40:34 +01:00
parent 739ca36c2c
commit c0b32213e4
12 changed files with 27 additions and 33 deletions

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://the-ipdb-transaction-spec.readthedocs.io/en/latest/ownership.html>`_. 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>`_.

View File

@ -15,8 +15,8 @@ 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 For details, see the section about conditions
`the documentation about conditions in the IPDB Transaction Spec <https://the-ipdb-transaction-spec.readthedocs.io/en/latest/transaction-components/conditions.html>`_. in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
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://the-ipdb-transaction-spec.readthedocs.io/en/latest/ownership.html>`_. 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>`_.

View File

@ -30,14 +30,14 @@ 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 documentation about conditions in the IPDB Transaction Spec](https://the-ipdb-transaction-spec.readthedocs.io/en/latest/transaction-components/conditions.html). the section about conditions in the [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec).
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://the-ipdb-transaction-spec.readthedocs.io/en/latest/ownership.html). See the note about "owners" in the [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec).
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 +87,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 documents the conditions for a transaction to be valid](https://the-ipdb-transaction-spec.readthedocs.io/en/latest/transaction-validation.html). The [IPDB Transaction Spec](https://github.com/ipdb/ipdb-tx-spec) documents the conditions for a transaction to be valid.
## Example Transactions ## Example Transactions

View File

@ -1,9 +1,8 @@
Cryptography Cryptography
============ ============
See `the IPDB Transaction Spec See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_,
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_, especially the sections about:
especially the pages about:
- Cryptographic Hashes - Cryptographic Hashes
- Cryptographic Keys & Signatures - Cryptographic Keys & Signatures

View File

@ -1,6 +1,5 @@
JSON Serialization JSON Serialization
================== ==================
See the page about JSON Serialization & Deserialization See the section about JSON Serialization & Deserialization
in `the IPDB Transaction Spec in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_.

View File

@ -1,5 +1,4 @@
The Asset Model The Asset Model
=============== ===============
See `the IPDB Transaction Spec See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_.

View File

@ -32,8 +32,8 @@ To compute it, 1) construct an :term:`associative array` ``d`` containing
``block.timestamp``, ``block.transactions``, ``block.node_pubkey``, ``block.timestamp``, ``block.transactions``, ``block.node_pubkey``,
``block.voters``, and their values. 2) compute ``id = hash_of_aa(d)``. ``block.voters``, and their values. 2) compute ``id = hash_of_aa(d)``.
There's pseudocode for the ``hash_of_aa()`` function There's pseudocode for the ``hash_of_aa()`` function
in the `IPDB Transaction Spec page about cryptographic hashes in the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/common-operations/crypto-hashes.html#computing-the-hash-of-an-associative-array>`_. section about cryptographic hashes.
The result (``id``) is a string: the block ID. The result (``id``) is a string: the block ID.
An example is ``"b60adf655932bf47ef58c0bfb2dd276d4795b94346b36cbb477e10d7eb02cea8"`` An example is ``"b60adf655932bf47ef58c0bfb2dd276d4795b94346b36cbb477e10d7eb02cea8"``
@ -56,8 +56,8 @@ A list of the :ref:`transactions <The Transaction Model>` included in the block.
The public key of the node that created the block. The public key of the node that created the block.
It's a string. It's a string.
See the `IPDB Transaction Spec page about cryptographic keys & signatures See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/common-operations/crypto-keys-and-sigs.html>`_. section about cryptographic keys & signatures.
**block.voters** **block.voters**
@ -82,8 +82,8 @@ To compute that:
where ``private_key`` is the node's private key where ``private_key`` is the node's private key
(i.e. ``node_pubkey`` and ``private_key`` are a key pair). There's pseudocode (i.e. ``node_pubkey`` and ``private_key`` are a key pair). There's pseudocode
for the ``sig_of_aa()`` function for the ``sig_of_aa()`` function
on `the IPDB Transaction Spec page about cryptographic keys and signatures on the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/common-operations/crypto-keys-and-sigs.html#computing-the-signature-of-an-associative-array>`_. section about cryptographic keys and signatures.
.. note:: .. note::

View File

@ -1,5 +1,4 @@
Conditions Conditions
========== ==========
See `the IPDB Transaction Spec See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_.

View File

@ -1,5 +1,4 @@
Inputs and Outputs Inputs and Outputs
================== ==================
See `the IPDB Transaction Spec See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_.

View File

@ -1,8 +1,7 @@
The Transaction Model The Transaction Model
===================== =====================
See `the IPDB Transaction Spec See the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/>`_.
The Transaction Schema The Transaction Schema
@ -11,7 +10,8 @@ The Transaction Schema
BigchainDB checks all transactions (JSON documents) BigchainDB checks all transactions (JSON documents)
against a formal schema defined against a formal schema defined
in some `JSON Schema <http://json-schema.org/>`_ files. in some `JSON Schema <http://json-schema.org/>`_ files.
Those files are part of the IPDB Transaction Spec. Those files are part of the
`IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_.
Their official source is the ``tx_schema/`` directory Their official source is the ``tx_schema/`` directory
in the `ipdb/ipdb-tx-spec repository on GitHub in the `ipdb/ipdb-tx-spec repository on GitHub
<https://github.com/ipdb/ipdb-tx-spec>`_, <https://github.com/ipdb/ipdb-tx-spec>`_,

View File

@ -35,8 +35,8 @@ The JSON Keys in a Vote
The public key of the node which cast this vote. The public key of the node which cast this vote.
It's a string. It's a string.
For more information about public keys, For more information about public keys,
see the `IPDB Transaction Spec page about cryptographic keys and signatures see the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/common-operations/crypto-keys-and-sigs.html>`_. section about cryptographic keys and signatures.
**vote.voting_for_block** **vote.voting_for_block**
@ -92,9 +92,8 @@ To compute that:
#. Compute ``signature = sig_of_aa(d, private_key)``, where ``private_key`` #. Compute ``signature = sig_of_aa(d, private_key)``, where ``private_key``
is the node's private key (i.e. ``node_pubkey`` and ``private_key`` are a key pair). is the node's private key (i.e. ``node_pubkey`` and ``private_key`` are a key pair).
There's pseudocode for the ``sig_of_aa()`` function There's pseudocode for the ``sig_of_aa()`` function
on `the IPDB Transaction Spec page about cryptographic keys and signatures on the `IPDB Transaction Spec <https://github.com/ipdb/ipdb-tx-spec>`_
<https://the-ipdb-transaction-spec.readthedocs.io/en/latest/common-operations/crypto-keys-and-sigs.html#computing-the-signature-of-an-associative-array>`_. section about cryptographic keys and signatures.
The Vote Schema The Vote Schema
--------------- ---------------