GDAX Trading toolkit

Provide all the tools traders need, both professional and hobbyist alike, to create automated trading bots on the GDAX and supported digital asset exchanges. Note: Node 7.6 or above is required.

Getting Started

Install Prereqs

Dependending on the OS of your machine, the specific method to install these application will vary. With a little Google help you can figure out how to install these: Recommended:

• Node 9.4 or above
• Typescript 2.7
• Yarn 1.3+

Install the Module

If you want to use the published version of the module in an existing TypeScript project:

yarn add gdax-trading-toolkit

Then go read the documentation referenced below.

Work with a local copy of the code

If you want to more familiar with the source, or even make a contribution

Download the code

clone the repository to directory on your machine ($WORKSPACE_ROOT)

Install depedency libraries

From $WORKSPACE_ROOT

yarn install

Test

Run the test suite just to make sure...

yarn test

VS Code Setup

If you use Visual Studio Code the following will be helpful.

1. Create a ".vscode" subdirectory in $WORKSPACE_ROOT
2. In the .vscode directory, create a "tasks.json" file that will tell VS Code how to build the software (this assumes the TypeScript compiler is in your $PATH)

{
    "version": "2.0.0",
    "tasks": [
        {
            "type": "typescript",
            "label": "tsc",
            "tsconfig": "tsconfig.json",
            "problemMatcher": [
                "$tsc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

3. Create "launch.json" file that will allow you to lauch applications for debugging or run the Mocha tests in debug mode

{
    "version": "0.2.0",
    "configurations": [
        
        {
            "type": "node",
            "request": "launch",
            "name": "Mocha Tests",
            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
            "args": [
                "-u",
                "tdd",
                "--timeout",
                "999999",
                "--colors",
                "${workspaceFolder}/test"
            ],
            "internalConsoleOptions": "openOnSessionStart",
            "preLaunchTask": "tsc"
        },
        {
            "type": "node",
            "request": "launch",
            "name": "Launch Program",
            "program": "${file}",
            "stopOnEntry": false,
            "sourceMaps": true,
            "cwd": "${workspaceRoot}",
            "outFiles": [
                "${workspaceFolder}/build/**/*.js"
            ],
            "runtimeExecutable": null,
            "outputCapture" : "std",
            "preLaunchTask": "tsc"
        }
    ]
}

Run

The src/samples folder contains many working demo scripts showcasing different aspects of the toolkit, while the tutorials folder contains running demo programs to accompany the GTT documentation.

Documentation

The GTT documentation contains blogs, reference material and step-by-step tutorials

Disclaimer

This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the authors, copyright holders, or Coinbase Inc. be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Contributors

Commits	Contributor
57	CjS77
4	mihar
3	balupton
2	kostola
2	Ameobea
2	fb55
2	discosultan
2	rmm5t
2	sds
2	akahan
1	abe238
1	EricCrosson
1	Amerzel
1	maxbeatty
1	pzagor2
1	atomantic
1	jcronq
1	kahmienah
1	mkondel
1	mmkal