TokenlyPublisherBridge

The “TokenlyPublisherBridge” server application allows Tokenly to publish media metadata to the Florincoin blockchain. This server application includes API endpoints to publish metadata, update/change metadata, removal of metadata from being listed in LibraryD, and the transfer of ownership from Tokenly and back to the original user.

Installation

Install Node.js then run the following commands to download and install the TokenlyPublisherBridge api.

$ git clone https://github.com/Tokenly/TokenlyPublisherBridge.git
$ cd TokenlyPublisherBridge
$ npm install

Usage

Running the Application

To run the TokenlyPublisherBridge application just run the following command and keep it running using something like screen.

$ node app.js

Calling the API endpoint

Each of the API endpoints require POST data. ALL API endpoints require an api-key. Please POST the following keys inside the body:

{"api-key": "j9189ijnf87yhja57287454fa659241454","artifact": OIP-041-Artifact # Thisiswhereyousubmitthemaindataoutlinedbelowtotheendpoints.}

Node.js Example:

varrequest=require('request');varbaseURL='https://api.alexandria.io/alexandria/v2/search';varoptions={method: 'POST',headers: {},url: baseURL,body: JSON.stringify({'api-key': 'j9189ijnf87yhja57287454fa659241454','artifact': {"oip-041": {"artifact": {"publisher": "FD6qwMcfpnsKmoL2kJSfp1czBMVicmkK1Q","timestamp": 1481419390,"type": "music","info": {"title": "Test","description": "Test","year": "2016","extraInfo": {}},"storage":{"network": "IPFS","location": "QmPukCZKeJD4KZFtstpvrguLaq94rsWfBxLU1QoZxvgRxA","files": [{"dname": "Skipping Stones","fame": "1 - Skipping Stones.mp3","fsize": 6515667,"type": "album track","duration": 1533.603293}]},"payment": {}}}}})};request(options,function(error,response,body){if(!error&&response.statusCode==200){// Handle response code}else{// Handle failure}});

API Endpoints

Add Media:

/add: Adds a piece of Tokenly music metadata to the Florincoin blockchain via a transaction message. This method required JSON to be pushed to it in the OIP-041 format:

{"oip-041":{"artifact":{"publisher":"$PublisherAddress","timestamp":1234567890,"type":"$ArtifactType","info":{"title":"$ArtifactTitle","description":"$ArtifactDescription","year":1234,"extraInfo":{"artist":"$Creator","company":"$Distributor","composers":["$Composer1","$Composer2"],"copyright":"","usageProhibitions":"","usageRights":"","tags":["$ArtifactTag1","$ArtifactTag2"]}},"storage":{"network":"IPFS","location":"$IPFSAddress","files":[{"disallowBuy":true,"dname":"$DisplayName","duration":123,"fname":"$FileName","fsize":123,"minPlay":"$minPlayPriceUSD","sugPlay":"$suggestedPlayPriceUSD","promo":"$CutForPromoterSales","retail":"$CutForPlatformSales","ptpFT":12,"ptpDT":34,"ptpDA":56,"type":"$MediaType","tokenlyID":"$SongTokenlyID"},{"dissallowPlay":true,"dname":"$DisplayName","duration":123,"fname":"$FileName","fsize":123,"minBuy":"$minBuyPriceUSD","sugBuy":"$suggestedBuyPriceUSD","promo":"$CutForPromoterSales","retail":"$CutForPlatformSales","type":"$MediaType","tokenlyID":"$SongTokenlyID"},{"dname":"$DisplayName","duration":123,"fname":"$FileName","fsize":123,"minPlay":"$minPlayPriceFiat","sugPlay":"$suggestedPlayPriceFiat","minBuy":"$minBuyPriceFiat","sugBuy":"$suggestedBuyPriceFiat","promo":"$CutForPromoterSales","retail":"$CutForPlatformSales","ptpFT":12,"ptpDT":34,"ptpDA":56,"type":"$MediaType","tokenlyID":"$SongTokenlyID"},{"dname":"Cover Art","fname":"$CoverArtFilename","fsize":123,"type":"coverArt","storage":{"network":"HTTP","location":"$ThumbnailURL"}}]},"payment":{"fiat":"$fiat_id","scale":"1000:1","sugTip":[123,123,123],"tokens":{"btc":"$BitcoinAddress","early":"","mtmcollector":"","mtmproducer":"","happybirthdayep":"","ltbcoin":""}}},"signature":"$IPFSAddress-$PublisherAddress-$timestamp"}}

After processing the /add API endpoint will return a response as follows:

{"success": true, # ThisvariableissetdependantoniftheAPIcallwassuccessfulornot."message": "tx1,tx2,tx3,tx4,tx5", # Thisvariablewillbefilledinonsuccess.Ifsuccessis false,`error`willbeusedinsteadof`message`.}

Edit Media:

/edit: The Edit Media endpoint accepts data in the OIP-041 Edit format (example below) along with data in the standard OIP-041 schema (same as /add but with an added txid field inside the data at oip-041.artifact.txid). It calculates what information is new and publish that to the Florincoin blockchain. Example OIP-041 Edit format:

{"success":true,"message":{"oip-041":{"edit":{"txid":"a449b0f6a601e503e7b4fdc0ada47f55a8b2f98feb2fdb044f7a92d971ff0456", # ThisistheTXIDfortheartifactweareeditting"timestamp":1481420001,"patch":{"add":[{"path":"/payment/tokens/mtcproducer","value":""}],"replace":[{"path":"/storage/files/3/fname","value":"birthdayepFirst.jpg"},{"path":"/storage/files/3/dname","value":"Cover Art 2"},{"path":"/info/title","value":"Happy Birthday"},{"path":"/timestamp","value":1481420001}],"remove":[{"path":"/payment/tokens/mtmproducer"},{"path":"/storage/files/0/sugBuy"}]}}}}}

After processing the /edit API endpoint will return a response as follows:

{"success": true, # ThisvariableissetdependantoniftheAPIcallwassuccessfulornot."message": "tx1,tx2,tx3,tx4,tx5", # Thisvariablewillbefilledinonsuccess.Ifsuccessis false,`error`willbeusedinsteadof`message`.}

Remove Media:

/remove: Deactivates an artifact in LibraryD. This will cause the artifact to stop showing up in the browser, however it does NOT remove the previously published data from the blockchain. Any information previously published will be accessable for as long as Florincoin exists. This endpoint accepts data in the following format:

{"txid": "XXXXXXXXX", # TheIDoftheartifacttobeunlisted."artifactTitle": "Happy Birthday EP", # Theartifacttitleisincludedasafurtherbackupmeasure.Itissuggestedthatinthefrontendtheuserisforcedtotypeintheartifacttitletounlist(SimilartoGithubrepositorydeletions)}

After processing the /remove API endpoint will return a response as follows:

{"success": true, # ThisvariableissetdependantoniftheAPIcallwassuccessfulornot."message": "txid"	# Thisvariablewillbefilledinonsuccess.Ifsuccessisfalse,`error`willbeusedinsteadof`message`.}

Transfer Ownership:

/changeOwner: Changes the ownership of an artifact from Tokenly to the individual user. Once the user transfers it away from Tokenly the metadata should be updated Browser-side. Updating further metadata clientside lowers the risk of a private key getting leaked. The changeOwner API accepts data in the following format:

{"txid": "XXXXXXXXX", # TheTXIDoftheartifacttobetransferred."newOwnerAddress": "FLuiVU5iDQ4a6ztcpBLwBNjBisyY2DvUTV", # TheFlorincoinaddressthattheartifactneedstobetransferred to.}

After processing the /changeOwner API endpoint will return a response as follows:

{"success": true, # ThisvariableissetdependantoniftheAPIcallwassuccessfulornot."message": "txid"	# Thisvariablewillbefilledinonsuccess.Ifsuccessisfalse,`error`willbeusedinsteadof`message`.}

Config

Info about the config file will be here.

License

This project will remain closed source until version 1.0 is completed. It will then be open sourced under the GNU GPL v3.0.