TLNPM

TradeLayer NPM package for:

• node RPC access on Bitcoin or Litecoin
• wallet-aware orderbook interaction
• spot order placement
• futures market discovery

The repo now has a narrow command surface intended for fast setup and for smaller models that need clear entry points.

Start here

Read AGENT.md first if you are operating this repo through an agent.

Quickstart

1. Install dependencies.

npm install

2. Create a local .env from the template and adjust values if needed.

cp .env.example .env

The default TL_BASE_URL points at the public TradeLayer orderbook host used elsewhere in this repo. Override it if you run your own orderbook service locally.

3. Bootstrap a node.

Windows BTC:

npm run setup:win:btc

Windows LTC:

npm run setup:win:ltc

Linux BTC:

npm run setup:linux:btc

Linux LTC:

npm run setup:linux:ltc

4. Pull the loaded node wallet identity into .env.

npm run wallet:node

5. Run the repo health check.

npm run doctor

6. Inspect markets without placing orders.

npm run demo:spot
npm run demo:futures

7. Place one spot order only with explicit opt-in.

npm run trade:spot -- --place true --action BUY --idForSale 0 --idDesired 5 --price 100 --amount 0.01

Commands

• npm run doctor Checks repo shape, env, node connectivity, and orderbook HTTP reachability.
• npm run wallet:create -- LTCTEST Generates a standalone seed phrase and address. Use this for seed creation only.
• npm run wallet:node Reads the currently loaded node wallet, creates a bech32 address if needed, and persists TL_ADDRESS and TL_PUBKEY into .env.
• npm run demo:spot Loads spot markets and a sample spot orderbook and prints a dry-run order payload.
• npm run trade:spot -- --place true ... Submits a spot order through ApiWrapper.
• npm run demo:futures Loads futures markets and prints a dry-run futures order payload.

Environment

Start from .env.example.

Key fields:

• TL_BASE_URL
• TL_PORT
• TL_NETWORK
• TL_ALREADY_ON
• TL_ADDRESS
• TL_PUBKEY
• TL_ALLOW_ORDER
• RPC_HOST
• RPC_PORT
• RPC_USER
• RPC_PASS
• RPC_WALLET

JS usage

const { ApiWrapper } = require('tradelayer');

const api = new ApiWrapper(
  process.env.TL_BASE_URL || 'ws://172.81.181.19',
  Number(process.env.TL_PORT || 3001),
  String(process.env.TL_NETWORK || 'LTCTEST').includes('TEST'),
  process.env.TL_ALREADY_ON !== 'false',
  process.env.TL_ADDRESS,
  process.env.TL_PUBKEY,
  process.env.TL_NETWORK || 'LTCTEST'
);

Notes

• quick.js, quickFut.js, apiEx.js, daytrader.js, and mmEx.js remain in the repo as references, but they are not the primary entry points.
• client.js now reads RPC configuration from .env, so node settings no longer have to be hardcoded in the source.