transferchain/transferchain-s4 repository overview

docker run --name transferchain-s4 \
  -v ./env/s4.mapstructure:/etc/transferchain/s4.yaml \
  -v ./test/data/transferchain:/var/data/transferchain \
  -v ./test/log/transferchain:/var/log/transferchain \
  -e LOG_PATH=/var/log/transferchain \
  -e PORT=8080 \
  -e WITHOUT_LISTEN=true \
  -p "8080:8080" \
  transferchain/transferchain-s4:latest

behaviour: "standard" # or log-collect

# TransferChain authentication and authorization information.
account:
    api:
        token:
        secret:
        url: https://connect.transferchain.io
        proxy: # this option is optional
          type: "http" # http|socks5|socks5h
          host:
          port:
    identifier: 0
    mnemonics:
    ns:
    uuid:

# TransferChain file operation's (storage upload, download, delete) Server URL.
fileoperation:
    host: https://file-operation.transferchain.io
    fingerprint:
    insecure: false
    downloadurl:
    proxy: # this option is optional
      type: "http" # http|socks5|socks5h
      host:
      port:

limits:
    bodysize: 0 # in bytes, the default is 0, so it's 5368709120(5gb)
    timeout: 0 # in seconds, the default is 0, so it's 1800(30minutes)

# Logger configurations - required is log-collect mode
logger:
  sizeThreshold: 1048576 # in bytes (min 10mb)
  prefix: "s4-"

# TransferChain Blockchain information.
readnode:
    address: https://read-node-01.transferchain.io
    chain:
        name: medusa # constant
        version: v2 # constant
    wsaddress: wss://read-node-01.transferchain.io/ws
    fingerprint:
    insecure: false
    proxy: # this option is optional
      type: "http" # http|socks5|socks5h
      host:
      port:

# APIs verbose mode. if open showed all log events.
verbose: false
syslag: false
listen: true

logformat: "json" # or text

version: v1

{
  "force": false // if re-create account use true.
}

{
  "data": {
    "mnemonics": ["your", "account", "mnemonics", ...],
    "raw": "your account mnemonics ..."
  }
}

{
  "mnemonics": ["your", "account", "mnemonics", ...],
  "force": false // if re-restore or use other account account use true
}

{
  "files": ["raw file data", "/home/transferchain/file1.zip"]
}

{
  "data": {
    "transactions": [
      {
        "id": "<txID>",
        "version": 2,
        "type": "storage",
        "sender_addr": "<your random address>",
        "recipient_addr": "<your random address>",
        "data": "<base encoded, encrypted data>",
        "sign": "<base encoded, sha512 hashed sender signed data>",
        "fee": 0
      }
    ],
    "storages": [
      {
        "UUID": "<string>",
        "FileName": "<uuid_v4>",
        "Size": 97,
        "Slots": [
          {
            "base_uuid": "<string>",
            "uuid": "<string>",
            "storage_service": "<provider title>",
            "storage_code": "<provider code>",
            "size": 0,
            "size_rl": 0,
            "user_id": 0,
            "chunk_size": 0
          }
        ],
        "KeyAES": "<base64 encoded random bytes>",
        "KeyHMAC": "<base64 encoded random bytes>",
        "UploadDate": "RFC3339 TIMESTAMP",
        "Policy": {
          "ID": "<string>",
          "Identifier": "<string>",
          "Owner": "<your random address>",
          "SourceIdentifier": "<your random address>",
          "TargetIdentifier": "<your random address>",
          "OPCode": "storage",
          "Policy": "owner",
          "EventType": "create",
          "CreatedAt": "RFC3339 TIMESTAMP"
        }
      }
    ],
    "mapped_storages": {
      "<txID>": {
        "UUID": "<string>",
        "FileName": "<uuid_v4>",
        "Size": 97,
        "Slots": [
          {
            "base_uuid": "<string>",
            "uuid": "<string>",
            "storage_service": "<provider title>",
            "storage_code": "<provider code>",
            "size": 0,
            "size_rl": 0,
            "user_id": 0,
            "chunk_size": 0
          }
        ],
        "KeyAES": "<base64 encoded random bytes>",
        "KeyHMAC": "<base64 encoded random bytes>",
        "UploadDate": "RFC3339 TIMESTAMP",
        "Policy": {
          "ID": "<string>",
          "Identifier": "<string>",
          "Owner": "<your random address>",
          "SourceIdentifier": "<your random address>",
          "TargetIdentifier": "<your random address>",
          "OPCode": "storage",
          "Policy": "owner",
          "EventType": "create",
          "CreatedAt": "RFC3339 TIMESTAMP"
        }
      }
    }
  }
}

{
  "data": {
    "transactions": [
      {
        "id": "<txID>",
        "version": 2,
        "type": "storage",
        "sender_addr": "<your random address>",
        "recipient_addr": "<your random address>",
        "data": "<base encoded, encrypted data>",
        "sign": "<base encoded, sha512 hashed sender signed data>",
        "fee": 0
      }
    ]
  }
}

{
  "data": {
        "id": "<txID>",
        "version": 2,
        "type": "storage",
        "sender_addr": "<your random address>",
        "recipient_addr": "<your random address>",
        "data": "<base encoded, encrypted data>",
        "sign": "<base encoded, sha512 hashed sender signed data>",
        "fee": 0
  }
}

{
  "path": "<download file path>" // optional
}

{
  "tx_id": ["<txID_1>", "<txID_2>", ...]
}

name: transferchain-s4

services:
  s4-local:
    image: transferchain/transferchain-s4:latest
    environment:
      PORT: 8080
      WITHOUT_LISTEN: 'false'
      LOG_PATH: /var/log/transferchain
    volumes:
      - ./env/s4.mapstructure:/etc/transferchain/s4.yaml
      - ./data:/var/data/transferchain
      - ./log:/var/log/transferchain
    restart: always
    ports:
      - '8080:8080'