{"id":18740569,"url":"https://github.com/aratz-lasa/ex_multiaddr","last_synced_at":"2025-04-12T20:05:23.382Z","repository":{"id":36514419,"uuid":"215843061","full_name":"aratz-lasa/ex_multiaddr","owner":"aratz-lasa","description":"IPFS multiaddr implementation in Elixir","archived":false,"fork":false,"pushed_at":"2022-05-07T11:04:21.000Z","size":63,"stargazers_count":8,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-12T20:05:17.136Z","etag":null,"topics":["elixir","ipfs-multiaddr","multiaddr","p2p"],"latest_commit_sha":null,"homepage":"","language":"Elixir","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/aratz-lasa.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":"2019-10-17T16:57:40.000Z","updated_at":"2024-02-05T08:17:04.000Z","dependencies_parsed_at":"2022-08-08T15:16:58.761Z","dependency_job_id":null,"html_url":"https://github.com/aratz-lasa/ex_multiaddr","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/aratz-lasa%2Fex_multiaddr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aratz-lasa%2Fex_multiaddr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aratz-lasa%2Fex_multiaddr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aratz-lasa%2Fex_multiaddr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aratz-lasa","download_url":"https://codeload.github.com/aratz-lasa/ex_multiaddr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625493,"owners_count":21135513,"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":["elixir","ipfs-multiaddr","multiaddr","p2p"],"created_at":"2024-11-07T15:39:42.955Z","updated_at":"2025-04-12T20:05:23.358Z","avatar_url":"https://github.com/aratz-lasa.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ex-multiaddr\n[IPFS multiaddr](https://multiformats.io/multiaddr/) implementation in Elixir\n\n## Installation\n\n[Available in Hex](https://hex.pm/docs/publish), the package can be installed\nby adding `ex_multiaddr` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:ex_multiaddr, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\nThe docs can be found at [https://hexdocs.pm/ex_multiaddr](https://hexdocs.pm/ex_multiaddr).\n\n## Protocols\n- [X] ip4\n- [X] tcp\n- [X] udp\n- [X] dccp\n- [X] ip6\n- [X] ip6zone\n- [X] dns\n- [X] dns4\n- [X] dns6\n- [X] dnsaddr\n- [X] sctp\n- [X] udt\n- [X] utp\n- [X] unix\n- [X] p2p\n- [X] ipfs\n- [X] onion\n- [X] onion3\n- [X] garlic64\n- [X] garlic32\n- [X] quic\n- [X] http\n- [X] https\n- [X] ws\n- [X] wss\n- [ ] p2p-websocket-star\n- [ ] p2p-stardust\n- [ ] p2p-webrtc-star\n- [X] p2p-webrtc-direct\n- [X] p2p-circuit\n- [ ] memory\n\n\n\n## Usage\n\n### Create Multiaddr\n```elixir\nmaddr_string = \"/ip4/127.0.0.1/tcp/80\"\n{:ok, maddr} = Multiaddr.new_multiaddr_from_string(maddr_string)\n# {:ok, %Multiaddr{bytes: \u003c\u003c4, 127, 0, 0, 1, 6, 0, 80\u003e\u003e}}\n```\n\n### En/Decapsulate\n```Elixir\n{:ok, maddr_1} = Multiaddr.new_multiaddr_from_string(\"/ip4/127.0.0.1\")\n{:ok, maddr_2} = Multiaddr.new_multiaddr_from_string(\"/tcp/80\")\n{:ok, maddr_en} = Multiaddr.encapsulate(maddr_1, maddr_2)\n# {:ok, %Multiaddr{bytes: \u003c\u003c4, 127, 0, 0, 1, 6, 0, 80\u003e\u003e}}\nMultiaddr.string(maddr_en)\n# \"/ip4/127.0.0.1/tcp/80\"\n\n{:ok, maddr_de} = Multiaddr.decapsulate(maddr_en, maddr_2)\n# {:ok, %Multiaddr{bytes: \u003c\u003c4, 127, 0, 0, 1\u003e\u003e}}\nMultiaddr.string(maddr_de)\n# \"/ip4/127.0.0.1\"\n```\n\n### Inspect Multiaddr\n```elixir\n{:ok, maddr} = Multiaddr.new_multiaddr_from_string(\"/ip4/127.0.0.1/tcp/80\")\nprotocols = Multiaddr.protocols(maddr)\n\n{:ok, prot_1} = Enum.fetch(protocols, 0)\n#{:ok, %Multiaddr.Protocol{\n#   code: 4, name: \"ip4\", size: 32,\n#   transcoder: %Multiaddr.Transcoder{\n#     bytes_to_string: #Function\u003c2.41508498/1 in Multiaddr.Transcoder.ip4_transcoder/0\u003e,\n#     string_to_bytes: #Function\u003c3.41508498/1 in Multiaddr.Transcoder.ip4_transcoder/0\u003e\n#   },\n#   vcode: \u003c\u003c4\u003e\u003e\n# }}\n{:ok, ip4_value} = Multiaddr.value_for_protocol(maddr, \"ip4\")\n# {:ok, \"127.0.0.1\"}\n{:ok, tcp_value} = Multiaddr.value_for_protocol(maddr, \"tcp\")\n# {:ok, \"80\"}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faratz-lasa%2Fex_multiaddr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faratz-lasa%2Fex_multiaddr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faratz-lasa%2Fex_multiaddr/lists"}