{"id":20597101,"url":"https://github.com/tradle/tim-server","last_synced_at":"2025-08-26T14:29:34.190Z","repository":{"id":36848219,"uuid":"41155166","full_name":"tradle/tim-server","owner":"tradle","description":"basic http server for talking to tradle/tim","archived":false,"fork":false,"pushed_at":"2017-04-28T22:37:20.000Z","size":48,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-14T13:16:01.960Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tradle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-21T12:44:32.000Z","updated_at":"2017-04-24T12:43:30.000Z","dependencies_parsed_at":"2022-08-24T21:11:41.101Z","dependency_job_id":null,"html_url":"https://github.com/tradle/tim-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Ftim-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Ftim-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Ftim-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tradle%2Ftim-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tradle","download_url":"https://codeload.github.com/tradle/tim-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242231441,"owners_count":20093636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T08:20:18.772Z","updated_at":"2025-03-06T15:19:04.330Z","avatar_url":"https://github.com/tradle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tim-server\n\nBasic HTTP server for [tradle/tim](https://github.com/tradle/tim)\n\n_this module is used by [Tradle](https://github.com/tradle/tim)_\n\n## Usage\n\n```bash\ntim-server \u003coptions\u003e\n```\n\nExample:\n```bash\ntim-server -i ./identity.json -k ./keys.json\n```\n\n### Options\n```\n-h, --help              print usage\n-i, --identity [path]   path to identity JSON (see https://github.com/tradle/identity)\n-k, --keys [path]       path to private keys file (see https://github.com/tradle/kiki)\n-p, --port [number]     server port (default: 32123)\n-t, --tim-port [number] port tim will run on (default: 51086)\n```\n\n## Paths\n\n### Read\n\n#### /me\n\nSee if tim's identity has been published on the blockchain\n\n#### /identities\n\nPrint identities known to tim\n\n#### /identity/:id\n\nPrint a given identity. {id} is the rootHash or a fingerprint of one of the identity's keys\n\n#### /chained\n\nSee everything tim has loaded from the blockchain\n\n### Write\n\n#### /self-publish\n\nPublish tim's identity on the blockchain. You need to do this every time you edit identity.json and want your edits recorded on the blockchain. You can think of it as something like \"git push\"\n\n*Async\n\n#### /send\n\nSend a message to another party, and optionally record it on blockchain\n\nParameters:\n  msg: JSON string  \n  public: Boolean (default: false)\n  chain: Boolean (default: false)  \n  to: Array of ids (fingerprints or root hashes of identities)\n\n*Async\n\n*Async - This operation is asynchronous, so you will need to check back for results.\n\n## Misc\n\nWhile debugging, you may find it useful to look at the contents of the various leveldb databases tim creates. [level-dump](https://npmjs.org/package/level-dump) can do that for you easily.\n\nExample:\n\n```bash\nls -al\n...\ndrwxr-xr-x 10 user group  340 Aug 21 14:01 bill-addressBook.db/\ndrwxr-xr-x 12 user group  408 Aug 21 14:01 bill-messages.db/\ndrwxr-xr-x 12 user group  408 Aug 21 14:01 bill-msg-log.db/\ndrwxr-xr-x  9 user group  306 Aug 21 14:01 bill-txs.db/\n...\nlevel-dump bill-messages.db\nlevel-dump bill-addressBook.db\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Ftim-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftradle%2Ftim-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftradle%2Ftim-server/lists"}