npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

saturn-sdk

v0.0.5

Published

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

Downloads

10

Readme

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()
  )
})()