https://github.com/hswick/dogex

Dogecoin JSONRPC client for Elixir
https://github.com/hswick/dogex

Last synced: 6 days ago
JSON representation

Dogecoin JSONRPC client for Elixir

• Host: GitHub
• URL: https://github.com/hswick/dogex
• Owner: hswick
• Created: 2018-11-24T00:44:49.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-29T03:15:10.000Z (over 5 years ago)
• Last Synced: 2024-10-29T08:41:23.889Z (18 days ago)
• Language: Elixir
• Size: 7.81 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dogex

Simple and fast http client for dogecoin. Should work for Bitcoin and forks/friends.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `dogex` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:dogex, "~> 0.1.1"}

  ]

end

def application do

  [applications: [:dogex]]

end  

```

These variables are used to generate the RPC url. Make sure you have them set in `~/.dogecoin/dogecoin.conf`.

Go [here](https://github.com/dogecoin/dogecoin/blob/master/contrib/debian/examples/dogecoin.conf) for a well documented example of the possible dogecoin config settings.

Set the elixir application's config:

```elixir

config :dogex,

  username: "rpcusername",

  password: "rpcpassword",

  port: 4242

```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at [https://hexdocs.pm/dogex](https://hexdocs.pm/dogex).

# Dogecoin

## Install Dogecoin

We can download the latest release of dogecoin [here](https://github.com/dogecoin/dogecoin/releases). This will have precompiled binaries that we can use.

If you want to add the binaries to your path, it would look something like this in Linux:

```bash

echo 'export PATH=$PATH:$HOME/dogecoin-1.14.0/bin' >> ~/.bashrc

```

## Testing

Start the local dogecoin regtest (regression test), like this:

```

dogecoind -regtest -daemon -conf="$HOME/projects/dogex/test.conf"

```

You must give the absolute path or else it will think you are in the .dogecoin directory.

Now if you run `mix test` everything should work!