Technical Details
This information is documented in case you want to develop your own general-purpose TinyChain client, or if you need to do an in-depth security or risk analysis.
TinyChain exposes a JSON API over HTTP, and treats a subset of JSON as a Turing-complete application language. For example, this is a function to convert meters into feet:
{"/state/scalar/op/get": ["meters", [
{"/state/scalar/ref/if": [
{"$meters/gte": 0},
{"$meters/mul": 3.28},
{"/error/bad_request": "Negative distance is not supported"}
]}
]]}
Obviously writing this by hand gets unwieldy very quickly, which is why the Python client is provided. Here's the same function defined using the Python client:
@tc.get_op
def to_feet(txn, meters: tc.Number) -> tc.Number:
return tc.If(
meters >= 0,
meters * 3.28,
tc.error.BadRequest("negative distance is not supported"))
The life of a replica R of a cluster C is:
- 1.Host loads cluster config
- 2.If any peer is hosting a cluster at the same path, a replication request is sent, and the state of R is updated to match the state of C; otherwise, R is assumed to be the latest state of C
- 3.R will handle transaction requests for C according to the flow below until its host is shut down or it attempts to commit a transaction and fails
- 4.If R attempts to commit a transaction and fails, it will stop accepting requests and attempt to re-join C by starting from step 1. above (assuming that automatic restarts are configured with systemd)
The flow of operations within a single transaction is:
- 1.A replica host R of cluster C with N total replicas receives a new transaction request T
- 2.R claims ownership of the transaction
- 3.For
PUTandDELETEoperations, the request T itself is replicated; for user-definedGETandPOSTrequests, write operations which are part of T are replicated to all other hosts in C - 4.Each dependent cluster Cx receives a request Tx, claims leadership of Tx, notifies the owner C of its participation, and replicates Tx to all hosts in Cx
- 5.If any host responds with error 409: conflict, the transaction is rolled back and error 409 is returned to the end-user
- 6.Otherwise, if at least (N / 2) + 1 hosts in each participating cluster respond with success, each cluster C removes the unsuccessful hosts from its replica set, commits the transaction, and responds to the end-user
- 7.Otherwise, the transaction is rolled back and an error is returned to the end-user
Important note: the TinyChain protocol does not support trustless replication. Do not allow untrusted replicas to join your cluster. A single malicious replica can significantly degrade performance, or even halt all updates entirely, by creating extra work to reach consensus; it can also report false information to your clients and the network as a whole.
TinyChain uses recursive JSON web tokens provided by the rjwt library. Each TinyChain host which handles part of a transaction must validate the auth token of the incoming request, sign it with its own private key, and forward it to any downstream dependencies. Note the unusual security consideration of a recursive token: a downstream dependency receives all of the upstream tokens, and therefore is authorized to take any action which an upstream dependency is authorized to take. For this reason, it's very important to use only a minimal scope to authenticate the end-user, and grant further scopes as narrowly as possible.
Example:
| [email protected] | retailer.com | factory.com | shipping.com | bank.com
|-----------------------|----------------------------|----------------------------------|------------------------------|----------
| Buy 1 widget for $20 -> Debit user's account $20 -------------------------------------------------------------------->
| | Make 1 widget -------------> Debit retailer's account $10 ----------------------------------->
| | | Ship 1 widget to user's address -> Debit retailer's account $5 ->
[email protected]initiates the transaction by sending a request toretailer.com, with an auth token signed byexample.comwhose scopes limit its use to the intended actionretailer.comclaims ownership of the transaction by creating a new, signed request token which includes the original tokenretailer.comsends a request tobank.comto debit $20 from the user's accountretailer.comsends a request tofactory.comto manufacture 1 widgetfactory.comsends a request tobank.comto debit $10 fromretailer.com's accountfactory.comsends a request toshipping.comto schedule a shipment to the user's address, and chargeretailer.comshipping.comsends a request tobank.comto debit $5 fromretailer.com's account
Requests at the same indentation level above are executed concurrently, after validating the incoming request token. Acceptance of a request with transaction ID X forbids acceptance of any other request with transaction ID X, unless they share the same owner.
Note that this is only the case in a mutation (a write transaction). A read-only transaction does not need to perform any explicit synchronization with the transaction owner, only to lock the given transaction ID.
The concurrency control flow of this sequence of operations, starting from transaction number (X - 1) is:
- 1.Client initiates transaction X
- 2.Service endpoint validates auth token
- 3.Service endpoint claims transaction X, becoming the transaction owner
- 4.Service endpoint executes requested operation
- 1.Dependency receives request
- 2.Dependency validates auth token
- 1.If the dependency is part of a different cluser than the transaction owner, it notifies the owner of its participation (this is necessary to synchronize dependencies further downstream)
- 3.Dependency executes requested operation and replies to the transaction owner
- 5.Transaction owner notifies dependencies of success, updating their latest committed transaction to X
- 6.Transaction owner updates its latest committed transaction to X
- 7.Transaction owner replies to the client
This functionality is implemented automatically for any service using the TinyChain host software.
Important note: this cross-service consensus algorithm trusts each service to a) recover from a crash without losing state, and b) communicate that it has committed a transaction honestly and correctly. In other words, it is not a new and trustless protocol, but a new formalization of an existing ad-hoc procedure. An application which requires completely trustless transactions, like a distributed cryptocurrency, should use a single replicated cluster.
If you need some technical details which are not listed on this page, you can check the internal documentation for TinyChain's host software at docs.rs/tinychain, or just Ask for help!
Last modified 3mo ago