init

Author: rbndg

.gitignore

@@ -0,0 +1,131 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+

README.md

@@ -0,0 +1,11 @@
+# Wallet Lib
+
+Modular multi asset non-custodial wallet library
+
+
+
+## How to use
+
+```
+const wallet = new Wallet({})
+``` 

api-notes.md

@@ -0,0 +1,94 @@
+### Wallet API 
+
+### Classes 
+
+WalletStore: Generic storage class. can be extended for various db/platforms. Inspired by hypercore's RAM.
+
+PaymentProcessor: Generic payment processor. Developers can extend this class for adding new payment processor. Payment processors have uniform apis that are called from Wallet. Inspired by BFX's btc.coin.js lib. 
+
+AssetKey: Generic asset key manager. Developer extend/implement methods of this class for building their own key manager for assets.
+
+Wallet: Main Interface for developers to interact with the wallet. Global level apis for :
+- import/export wallet 
+- sync wallet 
+- wallet events 
+- access to low level asset api.
+
+Currency: Encapsulation of currency logic. units, contract addr, conversion, symbols. To allow to 
+
+Provider: Generic class that can optionally be used for assets that can have multiple remote nodes. Example: Bitcoin Core/Electrum
+
+
+Example Wallet API calls:
+
+Wallet Creation: 
+
+const wallet = new Wallet([
+  
+  new BitcoinPayment({ //
+    
+    // unique name for accessing this asset. There could be multiple Bitcoin assets, example for bitcoin core .
+    asset_name: "btc_electrum", 
+    provider: new Electrum({ url : "blockstream.com"}), // can be BitcoinCore 
+    
+    // Modular Key manager.
+    // Developers can create their own key manager by extending AssetKey class
+    
+    keyManager: new BitcoinKeys() 
+  }),
+
+  new USDTPayments({ 
+    asset_name: 'usdt_eth'
+    provider: "infura.com", 
+    keyManager: new EthKeys(),
+  }),
+  ...etc
+], {
+
+  // Storage class. Wallet's ledger.
+  store: WalletStore,
+  seed: WalletSeed, // seed for wallet
+
+  // any other future settings
+})
+
+
+Restore Wallet: 
+
+//restore wallet, keys, missed tx.
+const wallet = await Wallet.import(snapshot)
+await wallet.sync()
+
+
+### Example of high level wallet api: 
+wallet.export(asset_name): Creates a dump of everything or just an asset needed to backup and restore wallet 
+wallet.add(PaymentProcessor): add a new payment processor to the wallet 
+wallet.remove(PaymentProcessor): add a new asset to the wallet 
+wallet.sync(options): catch up on all or some missed transactions 
+wallet.on('wallet-events'): global wallet events 
+//etc
+
+
+### Example of low level Asset api 
+For accessing per asset events 
+wallet low level asset api:
+wallet.assetName.method()
+wallet.btc.updateProvider()
+wallet.btc.getBalance()
+wallet.btc.getNewAddress()
+wallet.btc.on('eventname'): asset level events 
+wallet.btc.exportSeed()
+
+### Tx syncing 
+
+
+- Manual syncing by calling low level api refresh.
+  - used when in the asset view of a wallet 
+  - refreshing per asset 
+  - compare remote head with local head. 
+- Global asset  refresh:
+  - track refreshes per asset
+  - throttle syncing
+    - rate limites
+  - state managment of syncing
+    - next asset, current asset, previous asset 

config/eth.usdt.json

@@ -0,0 +1,5 @@
+const Currency = require('./src/lib/currency.js')
+
+module.exports = {
+  Currency
+}