Improve Nu Exchange Integration guide for exchanges to provide liquidity

[mhps]

Thanks for the clarification. So PEGs should by Nubits on the market for their operations need.

[mhps]

I have submitted an edit suggestion to the Nu Exchange Integration page although I didn’t figure our how to format the section title.

I don’t know who is responsible for approval and accepting the changes. @Ben ? @CoinGame ? Can you do it?

[CoinGame]

We’re in the process of moving the documentation to a different platform. You can keep the change request and we’ll merge it into the new site once it’s up.

[mhps]

@CoinGame Thanks for the heads up. Will the URL to the integration guide change?

[mhps]

I am copying the current guide below in case it becomes inaccessible.

Nu Exchange Integration

This guide will explain how you can integrate NuBits and NuShares into your exchange.

1. Download the daemon

---

From NuBits.com/download you can find a package containing the daemon for your environment. The daemon will be called “nud” or “nud.exe” depending on your platform.

2. Create a nu.conf file

---

Before running the daemon you will need to create a nu.conf file. Follow our creating a nu.conf file guide to learn how to create the file. Place the following into your file:

rpcuser=anyusername rpcpassword=anypassword server=1

If you are configuring NuShares you MUST add avatar=0 to your conf file
rpcuser=anyusername rpcpassword=anypassword server=1 avatar=0

3. Start the daemon

---

Run the daemon using the --daemon parameter
Ex../nud --daemon
This will start the daemon in the background and begin syncing the blockchain. Run ./nud getinfo to verify you can communicate with the daemon through RPC.

4. Point your exchange software to the correct daemon unit

---

Nu uses different port numbers for different units. The only units in the software right now are NuBits and NuShares, but this may change in the future. Use the following guide below to select the port number for the unit you’re configuring.

PROTOCOL PORT 7890
// Base RPC port used by the NuShares RPC server.
// Other unit RPC servers listen on RPC_PORT+1, RPC_PORT+2, etc.
RPC PORT 14001 // NuShares
RPC PORT 14002 // NuBits

// Same rules apply to testnet, but on different ports
TESTNET PORT 7895
TESTNET RPC PORT 15001 // NuShares
TESTNET RPC PORT 15002 // NuBits

// Peercoin ports used when communicating with the Peercoin wallet for dividend distributions
PEERCOIN RPC PORT 9902
PEERCOIN TESTNET RPC PORT 9904

Have your software point to the correct port number to interface with the unit you’re configuring. For example this is how we would communicate with the NuBits unit in the Peatio exchange software

"rpc: http://nuEx:123exch@127.0.0.1:14002";

[CoinGame]

I’m really sorry for the super late reply. docs.nubits.com will still point to our documentation but yes the actual url behind that will be different as it will utilize a different service.

[mhps]

@CoinGame , Can you put the change in (add point 5 above) even it is still on the old platform because we are ready to send letters to PEGs and needs this instruction in its complete form?

edit: @Ben, I don’t know who does what with the website but if @CoinGame is not around can you apply the change?

[Ben]

@mhps I’ll work with CG today to see what needs to be done.

[mhps]

Thanks. Note that I can’t edit my suggested edit so please take point 5 from above only.

[CoinGame]

We made a lot of progress yesterday. We have a couple of goals with the new platform that will require some more effort than simply copy/pasting information over to another host.

1. Free - No overhead for shareholders. Our previous service required a monthly fee. There will be no cost to hosting the docs going forward.

2. Beautiful - Ugly documentation sucks. We want it to look just as good as it did on the previous platform (maybe even better!).

3. Ease - Documentation works best when anyone can jump-in to contribute content without being a techo wiz. We’re trying to make the platform easy for anyone to help contribute content.

4. Balance - We want to hit a balance between allowing anyone to contribute without opening it up to abuse or griefing. The last platform limited the number of people who could approve changes and had a less than ideal method for community support.

We have a vision that I think everyone will be pleased with. Once we get it up and running we’ll make sure to include the changes discussed here and explain the process going forward.

[mhps]

We have a vision that I think everyone will be pleased with. Once we get it up and running we’ll make sure to include the changes discussed here

Can you give an estimate when this will happen? I am not trying to rush you guys but if it will take more than a week or two we may want to go ahead with the letter to the PEGs without the changes then remind the responding PEGs of the contents in point 5.

[Ben]

Can you give an estimate when this will happen?

On Friday I was able to get the underlying framework and local development environment configured and validated. My goal by the end of today is to have the current documentation migrated from the old platform to the new one and available for review. Depending on the progress that I can make and presuming that there are no unexpected delays, I may even be able to have the front-end styled to match the rest of the Nu branding at the same time. Otherwise I expect that will take an additional half day’s work to wrap up.

In any case, I don’t foresee any reason that we won’t be able to have the documentation ready to go with the PEG content updates in place by Thursday of this week at the latest.

Will that work with your schedule?

[mhps]

Will that work with your schedule?

That will do fine. Thanks.

[Ben]

I ran into an issue while setting up the localization options for the content. It probably puts me one day behind, so rather than this afternoon, I expect that tomorrow we’ll be ready to launch the updated docs.nubits.com.

Apologies for the delay.

[mhps]

Thanks for keeping us informed,

[Ben]

Update:
Almost ready with the new site – most of the content has been ported (though updates are needed for certain areas). Styles and content links still need to be verified for all cases, but it’s getting much closer.

You can view the in-progress work here: http://nunetwork.github.io/documentation/getting-started-with-nu/

I’ll put a couple more hours in tomorrow and hopefully get us to a place where we’re ready to launch with the new site (pointing to http://docs.nubits.com) and fold in the changes that @mhps needs for PEG.

[Ben]

PEG changes are included on the document: http://nunetwork.github.io/documentation/integrating-nubits-or-nushares-with-an-exchange/

Baring any unexpected technical challenges the final link is expected to be https://docs.nubits.com/integrating-nubits-or-nushares-with-an-exchange

[Ben]

Update:

All of the content has been ported over from http://docs.nubits.com to http://nunetwork.github.io/documentation . If I could please ask for the Community’s assistance to each take a few minutes to review the new site for anything that isn’t working or obviously broken/wrong documentation, I’d appreciate it.

Each page has a “Suggest Update” link at the top so if you find something, you can use that to pre-populate a Github issue on the documentation repository. If you don’t have a Github account, please feel free to submit a comment here.

Once this has been looked at by a few sets of eyes I’ll update the DNS servers to point docs.nubits.com at the new content.

Thank you!

[Nagalim]

every link on the ‘getting started’ page works. Bter, poloniex, shapeshift, and bittylicious all point to their respective home pages instead of nbt markets. Poloniex should be near the top, in my opinion, as it is one of the highest volume pairs we have.

[mhps]

PEG changes are included on the document: http://nunetwork.github.io/documentation/integrating-nubits-or-nushares-with-an-exchange/

Baring any unexpected technical challenges the final link is expected to be https://docs.nubits.com/integrating-nubits-or-nushares-with-an-exchange

The git page looks fine. The second link causes https secrity warning and after I add an exception to the site, I get page not found 408.