TrackBack IPFS Service (MVP)

IPFS connector for Decentralised Identifiers Storage.

API end points (MVP Release)

• MVP hosted base URL :- https://ipfs-connector.trackback.dev/
• IPFS Bootstrap node path with CID :- https://ipfs.trackback.dev:8080/ipfs/Qma3fM3VBKPXt7peEeJCAG25s7QMUwvLvGDwFikonZbPff
• TrackBack Agent connects to the service https://ipfs-connector.trackback.dev/

Service Status

Request

curl --location --request GET '/api/0.1/status'

Response

{
    "ping": "pong"
}

NOTICE!

• This is a minimum viable product and required significant improvments to use in production.
• This release only to test data interopability using decentralised identifiers and verifiable credentials.
• Production ready version will be released Q2 | 2022

IPFS Status

Request

curl --location --request GET '/api/0.1/ipfs/status'

Response

{
    "identity": {
        "id": "12D3KooWJ9nDxkXwaX3M9Sopgu2TSgTzxf9jYieWc7JSasgnmFgC",
        "publicKey": "CAESIHvWuvs+2OSpPGrDAIuRQ1OJf4y+irCRtuKggfae75zp",
        "addresses": [
            "/ip4/127.0.0.1/tcp/4001/p2p/12D3KooWJ9nDxkXwaX3M9Sopgu2TSgTzxf9jYieWc7JSasgnmFgC",
            "/ip4/172.31.23.244/tcp/4001/p2p/12D3KooWJ9nDxkXwaX3M9Sopgu2TSgTzxf9jYieWc7JSasgnmFgC",
            "/ip6/::1/tcp/4001/p2p/12D3KooWJ9nDxkXwaX3M9Sopgu2TSgTzxf9jYieWc7JSasgnmFgC"
        ],
        "agentVersion": "go-ipfs/0.9.1/",
        "protocolVersion": "ipfs/0.1.0",
        "protocols": [
            "/ipfs/bitswap",
            "/ipfs/bitswap/1.0.0",
            "/ipfs/bitswap/1.1.0",
            "/ipfs/bitswap/1.2.0",
            "/ipfs/id/1.0.0",
            "/ipfs/id/push/1.0.0",
            "/ipfs/lan/kad/1.0.0",
            "/ipfs/ping/1.0.0",
            "/libp2p/autonat/1.0.0",
            "/libp2p/circuit/relay/0.1.0",
            "/p2p/id/delta/1.0.0",
            "/x/"
        ]
    }
}

Add content

Request

curl --location --request POST 'http://127.0.0.1:3000/api/0.1/ipfs/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "didURI": "did:trackback.dev:0x2a674c8ef2bc79f13faf22d4165ac99efc2cabe6e3194c0a58336fed7c56b1b3",
    "didDocument": {
  "@context": [
    "https://www.w3.org/ns/did/v1",
    "https://w3id.org/security/suites/ed2551s9-2020/v1"
  ],
  "id": "did:trackback.dev:0x2a674c8ef2bc79f13faf22d4165ac99efc2cabe6e3194c0a58336fed7c56b1b3",
  "assertionMethod": [
    {
      "id": "did:trackback.dev:dia-0x12345678999",
      "type": "Ed25519VerificationKey2020", 
      "controller": "did:trackback.dev:dia-0x1234567890",
      "publicKeyMultibase": "AAAAC3NzaCfbdgdsssssss1lZDI1NTE5AAAAIIFraDC1HgOAg22wwwyaRuFvCTcL+N3yeBH/tN+zUI"
    }
  ]
},
"proof": "0x12fag",
"senderTimeStamp": "2021-09-19T00:00:00.046Z",
"publicKey": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILgl183qensmRV8tKBqM/E2GSEuQGLV883tAecMhuNUu gayan@tb-gayan"
}'

Response

{
    "cid": "QmcNYMJBhvbrH8oTo5QGNUFA5rhKpBVXHBpfiecxso7D8P",
    "didURI": "did:trackback.dev:0x2a674c8ef2bc79f13faf22d4165ac99efc2cabe6e3194c0a58336fed7c56b1b3"
}

Get content

• Pass the CID or didRef Request

curl --location --request GET 'http://127.0.0.1:3000/api/0.1/ipfs/get?CID=QmcNYMJBhvbrH8oTo5QGNUFA5rhKpBVXHBpfiecxso7D8P' \
--data-raw ''

Response

{
    "CID": "QmcNYMJBhvbrH8oTo5QGNUFA5rhKpBVXHBpfiecxso7D8P",
    "content": {
        "@context": [
            "https://www.w3.org/ns/did/v1",
            "https://w3id.org/security/suites/ed2551s9-2020/v1"
        ],
        "id": "did:trackback.dev:0x2a674c8ef2bc79f13faf22d4165ac99efc2cabe6e3194c0a58336fed7c56b1b3",
        "assertionMethod": [
            {
                "id": "did:trackback.dev:dia-0x12345678999",
                "type": "Ed25519VerificationKey2020",
                "controller": "did:trackback.dev:dia-0x1234567890",
                "publicKeyMultibase": "AAAAC3NzaCfbdgdsssssss1lZDI1NTE5AAAAIIFraDC1HgOAg22wwwyaRuFvCTcL+N3yeBH/tN+zUI"
            }
        ]
    }
}

Local setup

Run Locally

nvm use 14
yarn && yarn start

Run in debug mode

nodemon ./bin/www