1
0
mirror of https://github.com/bigchaindb/site.git synced 2024-11-22 17:50:07 +01:00
site/_src/_guides/tutorial-piece-of-art.md

150 lines
8.7 KiB
Markdown
Raw Normal View History

2017-12-18 15:08:12 +01:00
---
layout: guide
2017-12-22 17:28:19 +01:00
title: "Tutorial: How to create a digital record of a piece of art"
tagline: Build a digital certificate of a famous painting that you own
2017-12-18 15:08:12 +01:00
header: header-car.jpg
order: 2
learn: >
- How BigchainDB can be used to record dynamic parameters of an asset
- How assets can be used on BigchainDB to represent real objects
- How to make a `CREATE` transaction to digitally register an asset on BigchainDB
- How asset to create `TRANSFER` transactions to change the ownership of an asset in BigchainDB
---
Hi there! Welcome to our first tutorial! For this tutorial, we assume that you are familiar with the BigchainDB primitives (assets, inputs, outputs, transactions etc.). If you are not, familiarize yourself with [Key concepts of BigchainDB](../key-concepts-of-bigchaindb/).
# About digital object
2017-12-22 17:28:19 +01:00
We are moving towards an era where every physical object has a digital representation in a database. This can be in the form of a certificate, a simple entry in a database or another form of digital footprint. In the past, this used to be the paper trail associated with the purchase of a car, a painting or any other type of asset. Today, digital is slowly replacing analog in most aspects of our life. Thanks to advances in cryptography, we are reaching a point where even ownership claims of a specific object don't need to be a signed paper certificate anymore. This allows digitization to move to a new level. BigchainDB as a solution is suited perfectly to act as a digital asset registration and tracking tool.
2017-12-18 15:08:12 +01:00
2017-12-22 17:28:19 +01:00
Using the example of the digital registration of a famous painting you own, in this tutorial you will learn how to register an asset on BigchainDB and how to digitally transfer the ownership of this asset to someone else. The example is for illustrative purposes. For a real life application, there would be additional components that would need to be included.
2017-12-18 15:08:12 +01:00
Let's get started!
{% include_relative _setup.md %}
# Create a key pair
2017-12-22 17:28:19 +01:00
Before starting, we need to create a user in BigchainDB. In BigchainDB, users are represented as a private and public key pair. In our case, a key pair for Alice will be created. Alice will be the owner of the painting, and she will be the only one able to make changes to the digital representation of the painting. Using her public key, anyone can also verify that Alice is the owner of the painting.
2017-12-18 15:08:12 +01:00
You can generate a key pair from a seed phrase using the BIP39 library, so you will just need to remember this particular seed phrase. The code below illustrates that.
```js
const alice = new BigchainDB.Ed25519Keypair(bip39.mnemonicToSeed('seedPhrase').slice(0,32))
```
# Digital registration of an asset on BigchainDB
2017-12-22 17:28:19 +01:00
Now, let's assume that Alice is extremely lucky and gets to acquire the famous painting "Las Meninas" by the Spanish painter Diego Velázquez at a fantastic price during an auction held by the Spanish museum "museo nacional del prado". Now, she wants to ensure that she can digitally certify that she is the owner of this painting. For this reason, she wants to register the painting as an asset on BigchainDB to have an immutable claim. This corresponds to a CREATE transaction in BigchainDB. Using her key pair, Alice can create an asset on BigchainDB. In our case, the asset will represent an object in real life, namely the painting "Las Meninas". This asset will live in BigchainDB forever and there is no possibility to delete.
2017-12-18 15:08:12 +01:00
2017-12-22 17:28:19 +01:00
The first step required is the definition of the asset field that represents the painting. This field contains the data about the asset that is immutable. It has a JSON format:
2017-12-18 15:08:12 +01:00
```js
const paint = {
name: 'Meninas',
author: 'Diego Rodríguez de Silva y Velázquez'
place: 'Madrid',
year: '1656'
}
```
2017-12-22 17:28:19 +01:00
As a next step, you need to generate a `CREATE` transaction to link the defined asset to the user Alice. There are three steps to post this transaction in BigchainDB. First you create it, then sign it and then send it. There are different methods for each step. Here, we are illustrating one of them:
2017-12-18 15:08:12 +01:00
```js
function createPaint() {
// Construct a transaction payload
const txCreateCar = BigchainDB.Transaction.makeCreateTransaction(
// Asset field
{
2017-12-22 17:28:19 +01:00
...painting,
2017-12-18 15:08:12 +01:00
},
// Metadata field, contains information about the transaction itself
// (can be `null` if not needed)
{
datetime: new Date().toString(),
location: 'Madrid',
value: {
value_eur: '2500000€',
value_btc: '220',
}
},
// Output. For this case we create a simple Ed25519 condition
[BigchainDB.Transaction.makeOutput(
BigchainDB.Transaction.makeEd25519Condition(alice.publicKey))],
// Issuers
alice.publicKey
)
2017-12-22 17:28:19 +01:00
// The owner of the painting signs the transaction
2017-12-18 15:08:12 +01:00
const txSigned = BigchainDB.Transaction.signTransaction(txCreateCar,
alice.privateKey)
// Send the transaction off to BigchainDB
conn.postTransaction(txSigned)
// Check the status of the transaction every 0.5 seconds.
.then(() => conn.pollStatusAndFetchTransaction(txSigned.id))
.then(res => {
document.body.innerHTML +='<h3>Transaction created</h3>';
document.body.innerHTML +=txSigned.id
2017-12-22 17:28:19 +01:00
// txSigned.id corresponds to the asset id of the painting
2017-12-18 15:08:12 +01:00
})
}
```
2017-12-22 17:28:19 +01:00
Now Alice has digitally registered her painting on BigchainDB. `txSigned.id` is an id that uniquely identifies your asset. Note that the metadata field is used to record values along with the transaction, as every transaction can have new metadata. This is a field that can be different in every transaction.
2017-12-18 15:08:12 +01:00
Once a transaction ends up in a decided-valid block, it's "etched into stone". There's no changing it, no deleting it. The asset is registered now and cannot be deleted. However, the usage of the metadata field allows you to do updates in the asset. For this, you can use `TRANSFER` transactions (with their arbitrary metadata) to store any type of information, including information that could be interpreted as changing an asset (if that's how you want it to be interpreted).
# Transfer an asset on BigchainDB
2017-12-22 17:28:19 +01:00
Now, let's assume Alice has sold her painting in a good deal to someone else. Since an update of the mileage of a car does not imply any change in the ownership, your transfer transaction will simply be a transfer transaction with the previous owner (Alice) as beneficiary, but with new metadata in the transaction. So, technically, Alice is transferring the car to herself and just adding additional, new information to that transaction.
2017-12-18 15:08:12 +01:00
Before creating the transfer transaction, you need to search for the last transaction with the asset id, as you will transfer this specific last transaction:
The `listTransactions` method of BigchainDB retrieves all of the create and transfer transactions with a specific asset id. Then, we check for the inputs that have not been spent yet. This indicates the last transaction. In this tutorial, we are just working with one input and one output for each transaction, so there should be just one input that has not been spent yet, namely the one belonging to the last transaction.
Based on that, we can now create the transfer transaction:
```js
function transferOnwership(txCreated, newOwner) {
// Update the paint with a new
// First, we query for the asset paint that we created
const createTranfer = BigchainDB.Transaction.
makeTransferTransaction(
txCreated, {
mileage: txCreated.metadata.mileage + mileageValue,
units: 'km'
}, [BigchainDB.Transaction.makeOutput(
BigchainDB.Transaction.makeEd25519Condition(
newOwner.publicKey))],
0
)
// Sign with the owner of the car as she was the creator of the car
const signedTransfer = BigchainDB.Transaction
.signTransaction(createTranfer, carOwner.privateKey)
conn.postTransaction(signedTransfer)
.then((signedTransfer) => conn
.pollStatusAndFetchTransaction(signedTransfer.id))
.then(res => {
document.body.innerHTML += '<h3>Transfer Transaction created</h3>'
document.body.innerHTML += res.id
})
}
```
Note again that in the output of this transfer transaction we have `newOwner.publicKey`. This shows that Alice is transferring the ownership of the Meninas to anybody else. Furthermore, the input being spent is 0, as there is just one input.
So, finally you sign the transaction and send it to BigchainDB. You have now updated your asset and it is now not anymore you who will be able to transfer again the paint.
That's it, we have created a paint asset.
Congratulations! You have successfully finished your first BigchainDB tutorial.