Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

cashaccounts

1.0.1 • Public • Published

Cash Accounts javascript library

Human readable account names for Bitcoin Cash

Cashaccounts allow you to use aliases to send Bitcoin Cash and Tokens instead of having to type out or memorize things like bitcoincash:qp3wjpa3tjlj042z2wv7hahsldgwhwy0rq9sywjpyy. They look like Jonathan#100; The username followed by the number (based on block height registration).

Installation

  npm i cashaccounts

Usage

The library will default to using the cashaccounts.bchdata.cash lookup server, but if you run your own you can pass in the url as the first parameter. Note, registrations cost some satoshis to broadcast and the funds are subsidied by the node running the lookup server. This library contains methods for a trusted setup like the 3rd party cashaccount api, as well as methods for trustless setups for more advanced users who do only want to rely on the data from their own node.

  const cashAccountClass = require('cashaccounts');
  const cashAccounts = new cashAccountClass(url, nodeCredentials) // both optional

The url defaults to https://cashaccounts.bchdata.cash. the nodeCredentials object looks like

{
  host: 'example.com', // or ip
  username: 'admin',
  password: 'password1',
  port: 1234,
  timeout: 3000
}

Trusted methods

trustedRegistration(username, bchAddress, slpAddress)

returns

{
  txid: "0e436928cb4370be2f46258ace2c70e81e4cc67d88cb75805c…",
  hex: "0100000001cd90df45fba8dc4940eb72eb349a67ea63f9e451…"
}

trustedLookup(handle) // jonathan#100

returns

{
  "identifier": "tokenAware#15874;",
  "information": {
    "emoji": "🐙",
    "name": "tokenAware",
    "number": 15874,
    "collision": {
      "hash": "2091441002",
      "count": 0,
      "length": 0
  },
  "payment": [
      {
        "address": "bitcoincash:qrry6f92p7x3q4np05xhv5krssdw0q0aaq3sq20mh4",
        "type": "Key Hash"
      },
      {
        "address":"simpleledger:qr932wdxkqdavp27y4pthxn7sf0awuwd7y2swnjm5m",
        "type":"Key Hash"
      }
    ]
  }
}

handles can include the collision hash noted with a ..

For example;

trustedLookup(ectest#1106.9871360083)

trustedBitdbLookup(handle) // jonathan#100

returns

{
  "identifier": "Jonathan#100;",
  "information": {
    "emoji": "☯",
    "name": "Jonathan",
    "number": 100,
    "collision": {
    "hash": "5876958390",
    "count": 0,
    "length": 0
  },
  "payment": [
      {
        "address": "bitcoincash:qr4aadjrpu73d2wxwkxkcrt6gqxgu6a7usxfm96fst",
        "type": "Key Hash"
      }
    ]
  }
}

accountLookupViaTxid(txid)

returns

{
  "blockhash" : "00000000000000000331f42d43f6a460e1bb634bd2e16a1fad9dbdf80beae100",
  "blockheight" : 581590,
  "data" : "01249a7741ea9f5106a9d25f156a348ee554688606",
  "name" : "account1",
  "opreturn" : "OP_RETURN 01010101 6163636f756e7431 01249a7741ea9f5106a9d25f156a348ee554688606  01dd4913aaef64d4e523fcb0034c41f85947590dc0",
  "transactionhash" : "ca53a8c0f4af966a36ad9e5022c0d53f132caf4bbbafc4e0ebbc471bb4e261e5"
}

Trustless methods

requires your own node via passing in the nodeCredentials object.

trustlessLookup(handle) // jonathan#100

returns

{
  "identifier": "Jonathan#100;",
  "information": {
    "emoji": "☯",
    "name": "Jonathan",
    "number": 100,
    "collision": {
    "hash": "5876958390",
    "count": 0,
    "length": 0
  },
  "payment": [
      {
        "address": "bitcoincash:qr4aadjrpu73d2wxwkxkcrt6gqxgu6a7usxfm96fst",
        "type": "Key Hash"
      }
    ]
  }
}

Utils

splitHandle(handle)

returns an object with the username, number, and collision

{
  username: 'jonathan',
  number: '100',
  collision: false
}

isCashAccount(handle)

returns boolean

References

Official Website https://www.cashaccount.info.

Lookup Server https://gitlab.com/cash-accounts/lookup-server.

You can read the full spec https://gitlab.com/cash-accounts/specification/blob/master/SPECIFICATION.md.

Install

npm i cashaccounts

DownloadsWeekly Downloads

4

Version

1.0.1

License

MIT

Unpacked Size

27 kB

Total Files

6

Last publish

Collaborators

  • avatar