{"id":13639917,"url":"https://github.com/ynx0/airlock","last_synced_at":"2025-06-10T08:32:09.435Z","repository":{"id":54179151,"uuid":"311522072","full_name":"ynx0/airlock","owner":"ynx0","description":"Communicate with an Urbit ship over the eyre protocol in Java","archived":false,"fork":false,"pushed_at":"2021-08-12T19:53:16.000Z","size":534757,"stargazers_count":14,"open_issues_count":5,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-02T20:22:30.568Z","etag":null,"topics":["java","urbit"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ynx0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-10T02:25:06.000Z","updated_at":"2023-05-05T20:19:58.000Z","dependencies_parsed_at":"2022-08-13T08:30:53.496Z","dependency_job_id":null,"html_url":"https://github.com/ynx0/airlock","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynx0%2Fairlock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynx0%2Fairlock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynx0%2Fairlock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynx0%2Fairlock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ynx0","download_url":"https://codeload.github.com/ynx0/airlock/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ynx0%2Fairlock/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259037751,"owners_count":22796482,"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":["java","urbit"],"created_at":"2024-08-02T01:01:06.085Z","updated_at":"2025-06-10T08:32:09.402Z","avatar_url":"https://github.com/ynx0.png","language":"Java","funding_links":[],"categories":["Developer Tools"],"sub_categories":["HTTP APIs"],"readme":"# Airlock — Java Edition\n\nCommunicate with an Urbit ship over the eyre protocol in Java\n\n[![awesome urbit badge](https://img.shields.io/badge/~-awesome%20urbit-lightgrey)](https://github.com/urbit/awesome-urbit)\n\n## Example\n```java\npublic class Main {\n\n\tprivate static final Gson gson = new Gson();\n\n\tpublic static void main(String[] args) {\n\t\tString url = \"http://localhost:8080\";\n\t\tString shipName = \"zod\";\n\t\tString code = \"lidlut-tabwed-pillex-ridrup\";\n\n\t\t// SETUP\n        // The following example assumes you have:\n        // - a ship named 'zod' running\n        // - a chat channel called 'test' (you must manually create this)\n\n\n        // MARK - connect to the ship\n\t\tUrbit urbit = new Urbit(url, shipName, code);\n        urbit.authenticate();\n\t\turbit.connect();\n\t}\n}\n\n```\n\nFor the most up to date usage examples, see `src/test/java/UrbitIntegrationTestsCore.java` and related.\n\nThe file `src/main/java/Main.java` serves as a starting point to experiment with the library, \nbut may not showcase all features and functionality of the api. \n\n\n\n\n## Using\n\n**WARNING: The library is currently in alpha and does not really have a stable api yet. Expect things to break and change**\n\nCurrently, the simplest way to play around with the library is to download the source and edit the `Main.java` file yourself.\n\n### Running From Source\n1. Clone the repository: `git clone https://github.com/ynx0/urbit`\n2. In the cloned repository, run `./gradlew run`. This will run the `Main.java` class.\n3. Edit `Main.java` to experiment\n\n### Jar\nIf the code is alpha, using the jar is the greek letter before that. It most likely doesn't work.\nTo generate a jar from the source, all you have to do is run `./gradlew jar`.\n\nHowever, if you want to try it out, you can download the jar without actually downloading the repository:\n1. Go to the [Github Actions](https://github.com/ynx0/urbit/actions) workflows page\n2. Find a commit with `Java CI with gradle` underneath that has is passing (has green checkmark).\n3. Under the **Artifacts** heading, click on `all-jars`. This will download the jar that was generated from the aforementioned task.\n\n\n\n\n\n## Roadmap\n\n- [x] Minimum viable product\n- [x] Basic integration tests\n    - [x] Github Actions automatically tests on push/pr to `master`\n- [x] Basic documentation\n    - [x] Build javadocs\n- [x] Implementation of `scry` and `spider` request types\n- [ ] Integration for `scry` and `spider`\n    - [x] `scry`\n    - [x] `spider`\n- [x] Custom Exceptions for core interface \n\n- [x] `graph-store`\n    - [x] Initial functional implementation of interface \n    - [x] Graph store tests\n    - [x] Graph store documentation\n    - [x] Graph store examples\n\n- [ ] Other gall agent interfaces\n\n- [ ] Implementation of surrounding libraries\n  - [ ] atom manipulation\n  - [ ] related urbit types\n\n  ### Deprecated\n- [ ] Implementation of `chat-store`/`chat-view`\n  - [ ] Initial functional implementation of interface to agents\n  - [ ] Graph store tests\n  - [ ] Graph store documentation\n  - [ ] Graph store examples\n\n\n\n### After Stabilization\n- [ ] Create example application that uses basic functionality\n- [ ] Examples based off of integration tests\n- [ ] Create build process (i.e. publishing artifacts to a repository)\n- [ ] Soundness tests for various parts of the library (i.e. unit tests)\n    - [ ] Urbit uid and hexString\n    - [ ] atom manipulation\n    - [ ] related urbit types\n\n\n\n\n\n## Prior Art\n- Typescript 1 - https://github.com/tylershuster/urbit/\n- Typescript 2 - https://github.com/liam-fitzgerald/urbit-airlock-ts\n- Go - https://github.com/lukechampine/go-urbit/\n- Haskell - https://github.com/bsima/urbit-airlock\n- Swift - https://github.com/dclelland/UrsusAirlock/\n- channel.js (part of Landscape) - https://github.com/urbit/urbit/blob/master/pkg/arvo/app/landscape/js/channel.js\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fynx0%2Fairlock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fynx0%2Fairlock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fynx0%2Fairlock/lists"}