\n\n## Installation\n\n```bash\nyarn add @bajetech/digitalbits-wallet-sdk # or npm i @bajetech/digitalbits-wallet-sdk\n```\n\n## Usage\n\nThis library provides straightforward APIs for handling the following tasks:\n\n- Fetching and formatting data from the DigitalBits blockchain network\n- Encrypting and storing secret keys\n\nSome things the library will try to do well:\n\n- Useful type definitions\n- Consistent, descriptive names\n- Provide one obvious, streamlined way of accomplishing each task\n\nThis is not an attempt to replace `xdb-digitalbits-sdk`, it's meant to provide a better\nAPI in some areas (data-fetching) and new functionality in others\n(key management).\n\n## Fetching and formatting data\n\nOur library's goal is to provide typed, consistently-named DigitalBits data through\na consistent, predictable API.\n\nNote that our goal was to name data properties to be _internally consistent_ and\nintuitive, _not_ to be perfectly consistent with Frontier's responses. In some\ncases (particularly around offer / trade history), properties were renamed for\nclarity.\n\n```js\nimport { DataProvider } from \"@bajetech/digitalbits-wallet-sdk\";\nimport { Networks } from \"xdb-digitalbits-sdk\";\n\n// You'll use your DataProvider instance to ask for data from DigitalBits.\nconst dataProvider = new DataProvider({\n serverUrl: \"https://frontier.livenet.digitalbits.io\",\n accountOrKey: \"<>\",\n networkPassphrase: Networks.PUBLIC,\n});\n\n// Some class functions will fetch data directly.\nconst offers = await dataProvider.fetchOpenOffers({\n limit: 20,\n order: \"desc\",\n});\n\n// Others will watch the network for changes and invoke callback when it happens.\ndataProvider.watchAccountDetails({\n onMessage: accountDetails => {\n console.log(\"Latest account details: \", accountDetails);\n },\n onError: err => {\n console.log(\"error: \", err);\n },\n});\n```\n\n## Encrypting and storing secret keys\n\nOur KeyManager class allows you to securely encrypt keys client-side so you're\nnever sending sensitive information (the user's key or password) over the wire\nin a raw state.\n\n```js\nimport {\n KeyManager,\n KeyManagerPlugins,\n KeyType,\n} from \"@bajetech/digitalbits-wallet-sdk\";\n\n// To instantiate a keyManager instance, pass it an object that conforms to\n// the KeyStore interface.\nconst keyManager = new KeyManager({\n // The library comes with a sample KeyStore that stores keys in memory.\n keyStore: new KeyManagerPlugins.MemoryKeyStore(),\n});\n\n// Then, you need to register an encrypter to handle encrypting / decrypting keys.\n// The library comes with two samples. (Don't use the Identity Encrypter in prod!)\nkeyManager.registerEncrypter(KeyManagerPlugins.ScryptEncrypter);\n\n// If you're writing a production wallet, you'll probably want to write your own\n// KeyStore and/or Encrypter. Make sure they conform to the `KeyStore` and\n// `Encrypter` interfaces defined in these docs. You can use the `PluginTesting`\n// functions to make sure that your plugins meet spec!\n\nthis.state.keyManager\n .storeKey({\n // The KeyManager takes keys that conform to our Key interface.\n key: {\n type: KeyType.plaintextKey,\n publicKey: \"<>\",\n privateKey: \"<>\",\n },\n\n password: \"hunter2\",\n encrypterName: KeyManagerPlugins.ScryptEncrypter.name,\n })\n .then(keyMetadata => {\n console.log(\"Successfully encrypted and stored key: \", keyMetadata);\n })\n .catch(e => {\n console.log(\"Error saving key: \", e.toString());\n });\n```\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/@bajetech/digitalbits-wallet-sdk?style=for-the-badge\")
\n \n \n ![\"Node.js\"](\"https://img.shields.io/badge/node-){kind=icon}
=14-yellowgreen?style=for-the-badge&labelColor=000000\">\n \n \n ![\"GitHub](\"https://img.shields.io/github/workflow/status/bajetech/js-digitalbits-wallets/js-digitalbits-wallets%20CI?label=GitHub%20Actions&logo=github&style=for-the-badge\")
\n \n