saturn-sdk v0.0.5

saturn-sdk

Saturn Network SDK is a web3.js implementation of the npm library, @saturn-network/saturn.js, for Ethereum Virtual Machine compatible blockchains.

Disclaimer

Team Saturn and Saturn DAO accepts no responsibility for any lost funds due to tokens not being compatible with Saturn Protocol's order book contracts. If any of the trading tests outlined in our self listing guide fail for your token, then do not announce your listing as your token's smart contract is not compatible with our exchange protocol. Reach out via the form below and we will investigate together.

Modules

• Saturn client for interacting with saturn-protocol
• OrderParser method / class to parse an order directly from blockchain
• TradeParser method / class to parse a trade directly from blockchain
• AbiDecoder library for decoding data params and events from etherem transactions
• RequestManager handles Aegaeon API requests
• Utils prototypes and utils
• contracts typechained Exchange, Mimas, ERC20, ... contracts, utils

Typedocs

To generate typedocs folder and run the local document web server, run:

npm run typedocs or yarn typedocs

Testing

Testing requires an active node, connected to Ethereum Classic.
We highly recommend running a local node to limit data transfer bottlenecks.

Create an .env file to setup your desired node connection string.

If you want to use an IPC provider, you additionally have to set USE_IPC=true.

If you ignore the .env file, the provider will be defaulted to https://ethercluster.com/etc. Please note that query timeouts can occour using this provider.

Example .env

# Aegaeon API URL (optional)
API_URL=http://localhost:1337/etc

# using http connection
NODE_URL=http://localhost:8545

# using ipc connection
IPC=/Users/username/Library/Ethereum/classic/geth.ipc
USE_IPC=true

Package Commands

yarn test                   # runs all test
yarn test:order             # runs orderparser module tests
yarn test:utils             # runs utils module tests
yarn test:saturn            # runs saturn module tests
yarn test:decoder           # runs abidecoder module tests
yarn test:contracts         # runs typechain contract interfaces

Example Parsing All Orders

import Web3 from 'web3'
import net from 'net'
import { config } from 'dotenv'
import { OrderParser, contracts } from 'saturn-sdk'
import type { Order } from 'saturn-protocol'

(async () => {
  config()
  const orders: Order[] = []
  const provider = new Web3.providers.IpcProvider(process.env.IPC, net)
  const web3 = new Web3(provider)
  const parser = new OrderParser(web3)
  const toBlock = await web3.eth.getBlockNumber()
  const exchange = contracts.exchanges.createExchanges(web3, 'ETC').latest()
  const fromBlock = contracts.exchanges.getFromBlock(exchange.options.address)
  const events = await contracts.getExchangeEvents('NewOrder', { toBlock, fromBlock, exchange })

  for (const event of events) {
    const order = await parser.parse(event)
    orders.push(order)
  }

  console.log(
    `TOTAL ORDERS: ${orders.length}`,
    orders.filter(o => o.type === 'SELL').pop()
  )
})()