{"id":13696102,"url":"https://github.com/ArkEcosystemArchive/rpc-server","last_synced_at":"2025-05-03T14:30:51.992Z","repository":{"id":109707605,"uuid":"108256015","full_name":"ArkEcosystemArchive/rpc-server","owner":"ArkEcosystemArchive","description":"RPC server to connect to blockchain ARK","archived":true,"fork":false,"pushed_at":"2019-05-03T07:23:55.000Z","size":233,"stargazers_count":12,"open_issues_count":0,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-13T20:03:18.773Z","etag":null,"topics":["ark","blockchain","cryptocurrency","rpc-client"],"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/ArkEcosystemArchive.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-10-25T10:38:02.000Z","updated_at":"2023-07-27T12:02:55.000Z","dependencies_parsed_at":"2023-05-07T00:06:43.699Z","dependency_job_id":null,"html_url":"https://github.com/ArkEcosystemArchive/rpc-server","commit_stats":null,"previous_names":["arkecosystem/ark-rpc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Frpc-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Frpc-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Frpc-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArkEcosystemArchive%2Frpc-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArkEcosystemArchive","download_url":"https://codeload.github.com/ArkEcosystemArchive/rpc-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252203153,"owners_count":21710898,"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":["ark","blockchain","cryptocurrency","rpc-client"],"created_at":"2024-08-02T18:00:36.287Z","updated_at":"2025-05-03T14:30:51.467Z","avatar_url":"https://github.com/ArkEcosystemArchive.png","language":"JavaScript","readme":"![ARK-RPC](https://cdn-images-1.medium.com/max/2000/1*QFNTgOOP_9NIaNwIrBnp_w.png)\n\n### RPC server implementation to easily connect to ARK blockchain\n\n# Security Warning\nAll calls should be made from the server where RPC is running at ( i.e., `localhost` or `127.0.0.1` ). The RPC server should never be publicly accessible. If you wish to access ark-rpc from a remote address, you can whitelist the address with `--allow \u003caddress\u003e`. Addresses allow you to use wildcards, eg. `192.168.1.*` or `10.0.*.*`.\n\nIf you do want to allow access from all remotes, start ark-rpc with the `--allow-remote` commandline switch. This can be dangerous.\n\n# How To Use It\n- install Node.JS ( https://nodejs.org/en/download/package-manager/)\n- install forever `npm install -g forever`\n- install ark-rpc: `npm install arkecosystem/ark-rpc#master`\n- start RPC server: `ark-rpc --port 8000` (default port is 8080)\n\n## Docker ##\nIf you would like to run from a docker environment, you will first need to build the container by running:\n```\ndocker build -t ark-rpc .\n```\nYou will need to run the container with the `--allow-remote` option to allow the host machine to access the container.\n```\ndocker run -d -p 8080:8080 ark-rpc --allow-remote\n```\n\n# API\nSupported networks are `mainnet` and `devnet` all calls should start with the network you want to address, for instance,  `/mainnet/account/AUDud8tvyVZa67p3QY7XPRUTjRGnWQQ9Xv` we call it `:network` in the API description.\n\n## Accounts\n- Get account balance from `address`: `GET /:network/account/:address`\n- Create account from `passphrase`: `POST /:network/account` params: `passphrase`\n- Create (or get if already existing) account and encrypt using bip38: `POST /:network/account/bip38` params: `bip38` (password for encrypted WIF), `userid` (to identify a user)\n- Get backup from `userid`: `GET /:network/account/bip38/:userid`\n\nIf you want to create several accounts for one user, you need to use a different userid.\n\n## Transactions\n- Get last 50 transactions from `address`: `GET /:network/transactions/:address`\n- Create a transaction: `POST /:network/transaction` params: `recipientId`, `amount` in satoshis, `passphrase`\n- Create a transaction using `bip38` for `userid`: `POST /:network/transaction/bip38` params: `recipientId`, `amount` in satoshis, `bip38` (password to encode wif), `userid`\n- Broadcast transaction: `POST /:network/broadcast` params: `id` of the transaction\n\nNote that if the transaction has been created via the RPC it has been stored internally, as such only the transaction `id` is needed to broadcast/rebroadcast it. Otherwise if created outside of this RPC server, pass the whole transaction body as the POST payload.\n\n## Security\n\nIf you discover a security vulnerability within this project, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.\n\n## License\n\nThe MIT License (MIT)\n","funding_links":[],"categories":["Developer Tools"],"sub_categories":["Mobile"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArkEcosystemArchive%2Frpc-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FArkEcosystemArchive%2Frpc-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FArkEcosystemArchive%2Frpc-server/lists"}