{"id":29143463,"url":"https://github.com/vulpemventures/gdk-ocean","last_synced_at":"2025-06-30T20:07:31.599Z","repository":{"id":43712356,"uuid":"455621772","full_name":"vulpemventures/gdk-ocean","owner":"vulpemventures","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-20T10:05:57.000Z","size":33,"stargazers_count":2,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-30T15:57:01.070Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/vulpemventures.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":"2022-02-04T16:39:47.000Z","updated_at":"2022-10-10T10:00:04.000Z","dependencies_parsed_at":"2022-08-22T17:11:23.116Z","dependency_job_id":null,"html_url":"https://github.com/vulpemventures/gdk-ocean","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vulpemventures/gdk-ocean","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulpemventures%2Fgdk-ocean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulpemventures%2Fgdk-ocean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulpemventures%2Fgdk-ocean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulpemventures%2Fgdk-ocean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vulpemventures","download_url":"https://codeload.github.com/vulpemventures/gdk-ocean/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulpemventures%2Fgdk-ocean/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262842920,"owners_count":23373167,"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":"2025-06-30T20:07:30.043Z","updated_at":"2025-06-30T20:07:31.507Z","avatar_url":"https://github.com/vulpemventures.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gdk-ocean\n\ngdk-ocean is a Liquid wallet running on a gRPC server. It implements the [ocean API](https://github.com/vulpemventures/ocean)\n\n# Usage\n\n## Run gdk-ocean locally\n\nThe current version of gdk-ocean uses Python 3.9\n\n__the first time you run the program, you have to set up the virtual env with all dependencies.__\n\nInit the submodules:\n```\ngit submodule update --init --recursive\n```\n\nAnd copy the stubs:\n```\nmake stubs\n```\n\nCreate virtual env (it needs Python 3.9 installed)\n```\nmake env\n```\n\nThen, activate the env and install the `requirements.txt` deps.\n```\nsource venv/bin/activate\nmake deps\n```\n\nAt any moment, you can leave the venv with `deactivate`.\n\nNow you can run the server in any Python 3.9 environmnent:\n```\nmake run\n```\nBy default, the server is running on port 50051.\n\n## Run gdk-ocean in a Docker container\n\nInit the submodules and copy the proto stubs:\n```\ngit submodule update --init --recursive\nmake stubs\n```\n\nBuild the image:\n```bash\ndocker build -t gdk-ocean . # -t is the image name\n```\n\nRun a container:\n```bash\ndocker run gdk-ocean \n```\n\nOnce the container is running, you can request it via the exposed port 50051.\n\n## CLI\n\nYou can communicate with gdk-ocean using the `cli.py` script. It must be run by python3.9.\n\nIn your virtual enviroment, install the CLI dependencies:\n```bash\npip install -r requirements_cli.txt\n```\n\n\u003e if you are running the server in a container or if u don't want to mix CLI \u0026 server env, you can create venv with: `python3.9 -m venv venv_cli`\n\nThe CLI can connect to a gdk-ocean server using `--host` and `--port` options\n```bash\npython cli.py --address 0.0.0.0:8080 \u003ccommand\u003e\npython cli.py \u003ccommand\u003e # if not set, cli.py requests localhost:50051 by default\n``` \n\nTry to create your wallet using the cli:\n```bash\npython cli.py genseed # write down your secret words!\npython cli.py create -m \"\u003cseed\u003e\" -p \"\u003cpassword\u003e\"\n```\n\nYou can print the list of commands by running `python cli.py --help`. Any command help message can be printed by running `python cli.py \u003ccommand\u003e --help`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulpemventures%2Fgdk-ocean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvulpemventures%2Fgdk-ocean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulpemventures%2Fgdk-ocean/lists"}