nanode - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.d.ts

@@ -822,5 +822,3 @@ export default class Nano {
     }>;
-    send(amount: string, recipient_wallet_address: string, origin_private_key?: string, origin_account_address?: string): Promise<{
-        hash: string;
-    }>;
+    send(amount: string, recipient_wallet_address: string, origin_private_key?: string, origin_account_address?: string): Promise<string>;
     receive(send_block_hash: string, recipient_private_key?: string, recipient_wallet_address?: string): Promise<{
@@ -827,0 +825,0 @@ hash: string;

dist/index.js

@@ -189,3 +189,3 @@ "use strict";
                         log("Sent " + account.balance + " NANO to " + recipient_wallet_address + "!");
-                        return [2 /*return*/, result];
+                        return [2 /*return*/, result.hash];
                     case 7:
@@ -192,0 +192,0 @@ err_3 = _a.sent();

examples/init.ts

@@ -7,3 +7,3 @@ require('dotenv').config()
   api_key: process.env.API_KEY,
-  url: `https://www.nanode.co`,
+  url: `https://api.nanode.co`,
   origin_address: process.env.SENDER_WALLET,
@@ -10,0 +10,0 @@ origin_key: process.env.SENDER_WALLET_PRIVATE_KEY,

examples/open.ts

@@ -11,7 +11,7 @@ import Nano from './init'
     //send new account init funds from our walet
-    const send = await Nano.send('0.01', target.account)
+    const hash = await Nano.send('0.01', target.account)
 
     //open block with send's hash
     const result = await Nano.open(
-      send.hash,
+      hash,
       process.env.DEFAULT_REP,
@@ -18,0 +18,0 @@ target.private,

examples/send.ts

@@ -5,7 +5,7 @@ import Nano from './init'
   //send amount can't be a fraction rn
-  const result = await Nano.send('0.01', process.env.RECIPIENT_WALLET)
-  console.log(result)
-  return result
+  const hash = await Nano.send('0.01', process.env.RECIPIENT_WALLET)
+  console.log(hash)
+  return hash
 }
 
 send()

package.json

 {
   "name": "nanode",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description":
@@ -5,0 +5,0 @@ "Dead simple, promise-based client for interacting and building services on top of the NANO network.",

README.md

 # Nano Client
 
-Dead simple, promise-based client for interacting and building services on top of the NANO network.
+Dead simple, promise-based client for interacting and building services on top of the NANO network, a next-generation cryptocurrency created by Colin LeMahieu with nearly instant transactions and no fees. [Learn more on the official repo](https://nanode.co/node-api) ⚡️
 
-Not hosting your own node? [Sign up for node access and get your API key at raiblocks.club](https://www.raiblocks.club/node-api) 
+If you've worked with NANO before, you probably have experienced it's learning curve. The community is amazingly helpful and growing fast,
+but the documentation and guides to working with it currently leave a lot to be desired.
 
+**This library is designed to get anyone, even a total beginner, up and running building services on NANO in just a few minutes.** At it's core,
+this package is a wrapper around the official [RPC protocol](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol) that does a few things:
+
+1. abstracts away some of the idiosyncracies and quirks with the RPC API,
+2. exposes some top-level methods like `Nano.send()` and `Nano.recieve()`, so you don't have to know about creating, signing, publishing, etc.
+
+Want to build with NANO, but not running a full node? [Sign up for node access and get your API key at nanode.co](https://nanode.co/node-api)
+
+## Install
+
+`npm install nanode`
+
 ## Usage
 
-`npm install nano-client-node`
+This library is built with TypeScript, and I highly reccommend you take advantage of your code editor's Intellisense features. All fields on requests and responses for the RPC are strings - and for now, the same is true for this library.
 
+The full code for these snippets can be found /examples directory
+
+### Connect
+
 Initiate the client with your API key and a valid RPC url. Optionally pass your address and private key to the constructor.
 
-Not sure what your private key is? Call `nano.get_deterministic_key()` with the account seed to get all relevant account information.
+Not sure what your private key is? Call `nano.get_deterministic_key()` with your account's seed to get all relevant account information.
 
 ```typescript
-import Nano from 'nano-client-node'
+//examples/init.ts
+import Nano from 'nanode'
 const nano = new Nano({
-    api_key: process.env.API_KEY,
-    url: `https://rpc.raiblocks.club`,
-    origin_address: process.env.SENDER_WALLET,
-    origin_key: process.env.SENDER_WALLET_PRIVATE_KEY
+  api_key: process.env.API_KEY,
+  url: 'https://api.nanode.co',
+  origin_address: process.env.SENDER_WALLET, // wallet for the 'controlling' account
+  origin_key: process.env.SENDER_WALLET_PRIVATE_KEY // key for the 'controlling' account
 })
+```
 
-nano.send('0.1', process.env.RECIPIENT_WALLET).then((res) => {
-    ...
-}).catch((err) => {
-    ...
-})
+### Open account
+
+Now that we're connected, we need to 'open' the account. Opening an account is a bit of a catch-22 - it requires any amount to be sent to the address from a funded account before account is actually open.
+
+```typescript
+//examples/open.ts
+
+import Nano from './init'
+//create a new key
+const target = await Nano.key.create()
+
+console.log(`Initializing account ${target.account} with funds..`)
+
+//send new account init funds from our walet
+const hash = await Nano.send('0.01', target.account)
+
+//open block with send's hash
+const hash = await Nano.open(
+  hash,
+  process.env.DEFAULT_REP,
+  target.private,
+  target.public
+)
+console.log(`Open block published with hash: ${hash}`)
 ```
 
+### Send and receive
+
+Sending and receiving are simple one liners. For receive, we have to pass in the hash of the block we're receiving
+
+```typescript
+//examples/send.ts, examples/receive.ts
+import Nano from './init'
+
+const wallet_addr =
+  'xrb_3hk1e77fbkr67fwzswc31so7zi76g7poek9fwu1jhqxrn3r9wiohwt5hi4p1'
+
+const hash = await Nano.send('0.01', wallet_addr)
+
+return await Nano.receive(
+  hash,
+  process.env.RECIPIENT_WALLET_PRIVATE_KEY,
+  wallet_addr
+)
+```
+
+## Full list of methods
+
+If you aren't sure about some of the arguments, they're available as types in your editor, or in the official RPC guide. Full TypeDoc documentation is on the way!
+
+### Top-level calls
+
+if you only need to send and recieve NANO, **these methods should technically be the only ones you need**, per the examples above:
+
+* `Nano.open()`
+* `Nano.send()`
+* `Nano.receive()`
+* `Nano.change()`
+
+### Account
+
+Account methods take a single account string or in some cases, an array of accounts.
+
+* `Nano.account.get()`
+* `Nano.account.balance()`
+* `Nano.account.balances()`
+* `Nano.account.block_count()`
+* `Nano.account.frontiers()`
+* `Nano.account.history()`
+* `Nano.account.info()`
+* `Nano.account.key()`
+* `Nano.account.ledger()`
+* `Nano.account.pending()`
+* `Nano.account.representative()`
+* `Nano.account.weight()`
+
+### Block
+
+Block methods either require a block hash as a single argument, or a stringified block:
+
+* `Nano.block.account(block_hash)`
+* `Nano.block.count(block_hash)`
+* `Nano.block.chain(block_hash)`
+* `Nano.block.history(block_hash)`
+* `Nano.block.pending(block_hash)`
+* `Nano.block.change(block_string)`
+* `Nano.block.open(block_string)`
+* `Nano.block.publish(block_string)`
+* `Nano.block.receive(block_string)`
+* `Nano.block.send(block_string)`
+
+### Blocks
+
+This utility method allows a block hash or array of block hashes -
+
+* `Nano.blocks.find()`
+
+### Convert
+
+The convert method allows you to convert krai, mrai, and rai to and from their raw values. Both take an amount and denomination.
+
+* `Nano.convert.toRaw(22, 'mrai')`
+* `Nano.convert.fromRaw(22, 'mrai')`
+
+### Work
+
+Exposes work methods to perform on hashes
+
+* `Nano.work.generate(block_hash)`
+* `Nano.work.cancel(block_hash)`
+* `Nano.work.get(wallet, account)`
+
 ## Todos
-  - Receive call
-  - Documentation on remaining calls
+
+* Use BigNumber, etc. to allow passing numbers
+* TypeDoc site + add remaining method documentation
+* Better argument checking / error handling
+* Tests!

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

700238

increased by0.61%

Number of lines in readme file

161

increased by373.53%

Number of medium supply chain risk alerts

3

decreased by-40%

Worsened metrics

Lines of code

3348

decreased by-0.06%

No dependency changes