{"id":21082735,"url":"https://github.com/renproject/multichain-proxy","last_synced_at":"2025-05-16T09:32:06.101Z","repository":{"id":40431105,"uuid":"319933805","full_name":"renproject/multichain-proxy","owner":"renproject","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-23T06:11:43.000Z","size":76,"stargazers_count":2,"open_issues_count":1,"forks_count":9,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-06-19T06:53:31.740Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/renproject.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-12-09T11:22:12.000Z","updated_at":"2022-01-12T16:31:56.000Z","dependencies_parsed_at":"2023-01-22T15:31:20.261Z","dependency_job_id":null,"html_url":"https://github.com/renproject/multichain-proxy","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/renproject%2Fmultichain-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fmultichain-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fmultichain-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fmultichain-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renproject","download_url":"https://codeload.github.com/renproject/multichain-proxy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225419562,"owners_count":17471434,"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-19T20:15:10.883Z","updated_at":"2024-11-19T20:15:11.388Z","avatar_url":"https://github.com/renproject.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Multichain Proxy\n\n## ENV Settings\n\n| Env Variable | Description | Optional | Default Value (in Docker image) |\n|----------------|----------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| DEV_MODE | Enables debug mode for verbose logging | Yes | \"false\" |\n| NODE_URL | Node url [scheme://ip:port] | No | \"\" |\n| NODE_TOKEN | JWT token for Node, if node uses jwt token | Yes | \"\" |\n| NODE_USER | Basic Auth username for Node, if node uses basic auth | Yes | \"user\" |\n| NODE_PASSWORD | Basic Auth password for Node, if node uses basic auth | Yes | \"password\" |\n| PROXY_TOKEN | JWT token for proxy, if proxy needs jwt auth | Yes | \"\" |\n| PROXY_USER | Basic Auth username for Proxy, if proxy needs basic auth | Yes | \"user\" |\n| PROXY_PASSWORD | Basic Auth password for Proxy, if proxy needs basic auth | Yes | \"password\" |\n| PROXY_METHODS | Allowed RPC methods (whitelist) | Yes, if empty all allowed | \"estimatesmartfee,estimatefee,getbestblockhash, getblockchaininfo,getblockcount,getrawtransaction, gettransaction,gettxout,listunspent,sendrawtransaction,eth_blockNumber, eth_call,eth_chainId,eth_estimateGas,eth_gasPrice,eth_getBalance, eth_getBlockByHash,eth_getBlockByNumber,eth_getCode,eth_getLogs, eth_getTransactionByHash,eth_getTransactionCount, eth_getTransactionReceipt,eth_pendingTransactions,eth_sendRawTransaction, eth_sendTransaction,eth_syncing,net_version\" |\n| PROXY_PATHS | Allowed routes/paths on the node (whitelist) | Yes, if empty all allowed | \"\" |\n| CONFIG_PATH | Route Used by admin to update proxy config | No | \"/proxy/config\" |\n| LOCAL_NODE_PATH| Route exposing the local node in the proxy | No | \"/renlocal\" |\n| CONFIG_TOKEN | JWT token for Config, if route uses jwt token | Yes | \"\" |\n| CONFIG_USER | Basic Auth username for Config, if route uses basic auth | Yes | \"user\" |\n| CONFIG_PASSWORD| Basic Auth password for Config, if route uses basic auth | Yes | \"password\" |\n| NODE_KEY | Unique key used to identify the node in proxy db | No | \"\" |\n| DB_SERVER | MongoDB service URL | Yes | \"mongodb://mongo-service:27017\" |\n| DB_USER | MongoDB Username | Yes | \"admin\" |\n| DB_PASSWORD | MongoDB Password | Yes | \"password\" |\n\n\n## Endpoints\n\n- `/` : proxy to node set in config\n- `/renlocal/` : proxy to default local node\n- `/proxy/config` : proxy config for node\n- `/renlocal/proxy/config` : proxy config for local node\n\n## Design Goals\n\n- handle any proxy requests to rpc server\n- independent of path/route, should be able to proxy to any route of the node, this enables the proxy to handle nodes that have different paths/routes for different types of rpc calls.\n- should have path whitelisting to block unwanted path access\n- should be able to whitelist rpc calls and block others\n- should be able to handle both jwt and username/password auth mechanisms\n- proxy and node can have different auth mechanisms and auth credentials\n- remote proxy config endpoint to update the proxy config (node url and credentials)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fmultichain-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenproject%2Fmultichain-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fmultichain-proxy/lists"}