{"_id":"@akhmetovdev/avalanche","_rev":"1-d112f377b11b2dca31bb5511be0a6ed1","name":"@akhmetovdev/avalanche","dist-tags":{"latest":"3.0.1"},"versions":{"3.0.1":{"name":"@akhmetovdev/avalanche","version":"3.0.1","description":"Avalanche Platform JS Library","main":"dist/index.js","scripts":{"start":"webpack-dev-server --mode development","build":"rm -rf dist/ && npx tsc -b && cp -r typings/src ./dist","prebundle":"npm run build","bundle":"webpack --mode production","lint":"eslint ./","prepublish":"npm run build","release:prepare":"rm -rf ./dist ./node_modules ./package-lock.json && npm install && npm run build && npm run bundle && npm test && git status","test":"jest","test-watch":"jest --watch","docshtml":"npx typedoc --plugin typedoc-plugin-external-module-name --mode file src","docsmd":"npx typedoc --readme none --plugin typedoc-plugin-markdown,typedoc-plugin-external-module-name --theme markdown --out docsMD src","docs":"npm run docshtml && npm run docsmd"},"repository":{"type":"git","url":"git+https://github.com/ava-labs/avalanchejs.git"},"keywords":[],"author":"","license":"BSD-3-Clause","bugs":{"url":"https://github.com/ava-labs/avalanchejs/issues"},"homepage":"https://github.com/ava-labs/avalanchejs#readme","devDependencies":{"@types/bech32":"^1.1.2","@types/bn.js":"^4.11.6","@types/create-hash":"^1.2.2","@types/jest":"^24.9.1","@types/node":"^12.12.62","@typescript-eslint/eslint-plugin":"^3.8.0","acorn":"^7.4.0","clean-webpack-plugin":"^3.0.0","eslint":"^7.9.0","eslint-config-airbnb-base":"^14.2.0","eslint-config-airbnb-typescript":"^8.0.2","eslint-plugin-import":"^2.22.0","eslint-plugin-jsx-a11y":"^6.3.1","eslint-plugin-react":"^7.20.5","eslint-plugin-react-hooks":"^2.5.1","expose-loader":"^0.7.5","git-revision-webpack-plugin":"^3.0.4","html-webpack-plugin":"^3.2.0","jest":"^26.2.2","jest-mock-axios":"^3.2.0","terser-webpack-plugin":"^2.3.5","ts-jest":"^26.1.4","ts-loader":"^6.2.2","typedoc":"^0.18.0","typedoc-plugin-external-module-name":"^4.0.3","typedoc-plugin-markdown":"^2.4.0","typescript":"^3.9.7","webpack":"^4.44.2","webpack-cli":"^3.3.11","webpack-dev-server":"^3.10.3"},"dependencies":{"axios":"0.19.2","bech32":"1.1.4","bn.js":"4.11.8","buffer":"5.5.0","create-hash":"1.2.0","elliptic":"6.5.3","node-forge":"^0.10.0","secp256k1":"4.0.2","store2":"2.11.0","web3-utils":"1.2.11","webcrypto":"0.1.1"},"gitHead":"c711219d994a26db2a66a77d181d56b766c18975","_id":"@akhmetovdev/avalanche@3.0.1","_nodeVersion":"10.22.0","_npmVersion":"6.14.6","dist":{"integrity":"sha512-WK9Izc/uPBKPB2kjP6AAN9JScZTvQftKMVgkp5YljKlVmgtnZAMAQ2subuiHCdZbe1+uoop6Iug9G5nXfwEvog==","shasum":"623ea02723c4871b6af838f1a829471b5c992abb","tarball":"https://registry.npmjs.org/@akhmetovdev/avalanche/-/avalanche-3.0.1.tgz","fileCount":593,"unpackedSize":7112337,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfbd2+CRA9TVsSAnZWagAA/4oP/2V6bWqDJtePUhJQ7Eof\nG3AetOz6D3stofK8g7w97EbGuTpUzm41+3jt1ozxPM7aUULtIoT5lt+7wFVK\n7jYLXmHC5FbpJMJkFOMbi3EyNUXbI8IxJazgG8Ov2mENksbd812EyT2McFtu\nS9r46gAw9gqt4eaNX4gcxOLQxYNBKKD3vRNCSfsEmMsTX6BQ70uZeH5uFPOb\nOzE8ocMZ8s+gC0MoTF1wjYtXI0XnjBVzaSix9kYn6xcaWtKJlL1Zw6AsMqH/\nTjctFCOsTPLr3BJf2oAUI43Fk+dpEP8W1CJJhJyUyBjg7U30spxP3CnlOpww\nCUZmwcReXAKXvHx7c+vTcNpOcTgK8arja91ATFbVzB+Dn/nTT4vZf/hgDRB4\n4jT6WPlv87w7xmrdUilp6ZP27QBCjo+Wgf5wX55NdQzlc+rd3CzaQ/Uw03vN\nGYpDYjwfdZ1ZxzSWbIp6RNofnFLEGMZLgofCQA7GTWbdr11JyExbyZRe3eIy\nsre69oEso9OB7U1qJ0KzaY2KqDbuwCdCPX0EtUr/aF78g7hVGejEic66iEYh\n80x81weWcI2aO5bGve079NfcbYtqO6hy8OcB+hZEJbIMfsitZp7f9kvH0Lox\nR4Utj7bXY2CNHL8Wx01ZZBRkvLNrHF6SAks01MihfevWvRT5gvB8+L1DC70Y\nrDBM\r\n=QlrL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDTFb4WYVUXhxeqxi+PYldai5VXqjtvq307zxmD5GoWhQIgUK9lFfBe7Fn92CXKM02GCpIzR/+oPOWkPkzxqWNuF7E="}]},"maintainers":[{"name":"akhmetovdev","email":"akhmetovdev@gmail.com"}],"_npmUser":{"name":"akhmetovdev","email":"akhmetovdev@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/avalanche_3.0.1_1601035710009_0.576538456261698"},"_hasShrinkwrap":false}},"time":{"created":"2020-09-25T12:08:29.963Z","3.0.1":"2020-09-25T12:08:30.287Z","modified":"2022-04-04T12:29:12.970Z"},"maintainers":[{"name":"akhmetovdev","email":"akhmetovdev@gmail.com"}],"description":"Avalanche Platform JS Library","homepage":"https://github.com/ava-labs/avalanchejs#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/ava-labs/avalanchejs.git"},"bugs":{"url":"https://github.com/ava-labs/avalanchejs/issues"},"license":"BSD-3-Clause","readme":"# AvalancheJS - The Avalanche Platform JavaScript Library\r\n\r\n## Overview \r\n\r\nAvalancheJS is a JavaScript Library for interfacing with the Avalanche Platform. It is built using TypeScript and intended to support both browser and Node.js. The AvalancheJS library allows one to issue commands to the Avalanche node APIs. \r\n\r\nThe APIs currently supported by default are:\r\n\r\n  * Admin API\r\n  * AVM API (X-Chain)\r\n  * Health API\r\n  * Info API\r\n  * Keystore API\r\n  * Metrics API\r\n  * PlatformVM API\r\n\r\nWe built AvalancheJS with ease of use in mind. With this library, any Javascript developer is able to interact with a node on the Avalanche Platform who has enabled their API endpoints for the developer's consumption. We keep the library up-to-date with the latest changes in the [Avalanche Platform Specification](https://docs.avax.network). \r\n\r\n  Using AvalancheJS, developers can:\r\n\r\n  * Locally manage private keys\r\n  * Retrieve balances on addresses\r\n  * Get UTXOs for addresses\r\n  * Build and sign transactions\r\n  * Issue signed transactions to the X-Chain\r\n  * Create a Subnetwork\r\n  * Administer a local node\r\n  * Retrieve Avalanche network information from a node\r\n\r\n### Requirements\r\n\r\nAvalancheJS requires Node.js LTS version 12.14.1 or higher to compile.\r\n\r\n### Installation\r\n\r\nAvalanche is available for install via `npm`:\r\n\r\n`npm install --save avalanche`\r\n\r\nYou can also pull the repo down directly and build it from scratch:\r\n\r\n`npm run build`\r\n\r\nThis will generate a pure Javascript library and place it in a folder named \"web\" in the project root. The \"avalanche.js\" file can then be dropped into any project as a pure javascript implementation of Avalanche.\r\n\r\nThe AvalancheJS library can be imported into your existing Node.js project as follows:\r\n\r\n```js\r\nconst avalanche = require(\"avalanche\");\r\n```\r\nOr into your TypeScript project like this:\r\n\r\n```js\r\nimport { Avalanche } from \"avalanche\"\r\n```\r\n\r\n### Importing essentials\r\n\r\n```js\r\nimport {\r\n    Avalanche,\r\n    BinTools,\r\n    Buffer,\r\n    BN\r\n  } from \"avalanche\"\r\n\r\nlet bintools = BinTools.getInstance();\r\n```\r\n\r\nThe above lines import the libraries used in the tutorials. The libraries include:\r\n  \r\n  * avalanche: Our javascript module.\r\n  * bn.js: A bignumber module use by AvalancheJS.\r\n  * buffer: A Buffer library.\r\n  * BinTools: A singleton built into AvalancheJS that is used for dealing with binary data.\r\n\r\n## Example 1 — Managing X-Chain Keys\r\n\r\nAvalancheJS comes with its own AVM Keychain. This KeyChain is used in the functions of the API, enabling them to sign using keys it's registered. The first step in this process is to create an instance of AvalancheJS connected to our Avalanche Platform endpoint of choice.\r\n\r\n```js\r\nimport {\r\n    Avalanche,\r\n    BinTools,\r\n    Buffer,\r\n    BN\r\n  } from \"avalanche\" \r\n\r\nlet bintools = BinTools.getInstance();\r\n\r\nlet myNetworkID = 12345; //default is 3, we want to override that for our local network\r\nlet myBlockchainID = \"GJABrZ9A6UQFpwjPU8MDxDd8vuyRoDVeDAXc694wJ5t3zEkhU\"; // The X-Chain blockchainID on this network\r\nlet ava = new avalanche.Avalanche(\"localhost\", 9650, \"http\", myNetworkID, myBlockchainID);\r\nlet xchain = ava.XChain(); //returns a reference to the X-Chain used by AvalancheJS\r\n```\r\n\r\n### Accessing the KeyChain\r\n\r\nThe KeyChain is accessed through the X-Chain and can be referenced directly or through a reference variable.\r\n\r\n```js\r\nlet myKeychain = xchain.keyChain();\r\n```\r\n\r\nThis exposes the instance of the class AVMKeyChain which is created when the X-Chain API is created. At present, this supports secp256k1 curve for ECDSA key pairs.\r\n\r\n### Creating X-Chain key pairs\r\n\r\nThe KeyChain has the ability to create new KeyPairs for you and return the address assocated with the key pair.\r\n\r\n```js\r\nlet newAddress1 = myKeychain.makeKey(); //returns a Buffer for the address\r\n```\r\n\r\nYou may also import your exsting private key into the KeyChain using either a Buffer...\r\n\r\n```js\r\nlet mypk = bintools.avaDeserialize(\"24jUJ9vZexUM6expyMcT48LBx27k1m7xpraoV62oSQAHdziao5\"); //returns a Buffer\r\nlet newAddress2 = myKeychain.importKey(mypk); //returns a Buffer for the address\r\n```\r\n\r\n... or an Avalanche serialized string works, too:\r\n\r\n```js\r\nlet mypk = \"24jUJ9vZexUM6expyMcT48LBx27k1m7xpraoV62oSQAHdziao5\";\r\nlet newAddress2 = myKeychain.importKey(mypk); //returns a Buffer for the address\r\n```\r\n\r\n### Working with KeyChains\r\n\r\nThe X-Chains's KeyChain has standardized key management capabilities. The following functions are available on any KeyChain that implements this interface.\r\n\r\n```js\r\nlet addresses = myKeychain.getAddresses(); //returns an array of Buffers for the addresses\r\nlet addressStrings = myKeychain.getAddressStrings(); //returns an array of strings for the addresses\r\nlet exists = myKeychain.hasKey(newAddress1); //returns true if the address is managed\r\nlet keypair = myKeychain.getKey(newAddress1); //returns the KeyPair class\r\n```\r\n\r\n\r\n### Working with KeyPairs\r\n\r\nThe X-Chain's KeyPair has standardized KeyPair functionality. The following operations are available on any KeyPair that implements this interface.\r\n\r\n```js\r\nlet address = keypair.getAddress(); //returns Buffer\r\nlet addressString = keypair.getAddressString(); //returns string\r\n\r\nlet pubk = keypair.getPublicKey(); //returns Buffer\r\nlet pubkstr = keypair.getPublicKeyString(); //returns a CB58 encoded string\r\n\r\nlet privk = keypair.getPrivateKey(); //returns Buffer\r\nlet privkstr = keypair.getPrivateKeyString(); //returns a CB58 encoded string\r\n\r\nkeypair.generateKey(); //creates a new random KeyPair\r\n\r\nlet mypk = \"24jUJ9vZexUM6expyMcT48LBx27k1m7xpraoV62oSQAHdziao5\";\r\nlet successul = keypair.importKey(mypk); //returns boolean if private key imported successfully\r\n\r\nlet message = Buffer.from(\"Wubalubadubdub\");\r\nlet signature = keypair.sign(message); //returns a Buffer with the signature\r\n\r\nlet signerPubk = keypair.recover(message, signature);\r\nlet isValid = keypair.verify(message, signature); //returns a boolean\r\n```\r\n\r\n## Example 2 — Creating An Asset\r\n\r\nThis example creates an asset in the X-Chain and publishes it to the Avalanche Platform. The first step in this process is to create an instance of AvalancheJS connected to our Avalanche Platform endpoint of choice.\r\n\r\n```js\r\n\r\nimport {\r\n    Avalanche,\r\n    BinTools,\r\n    Buffer,\r\n    BN\r\n  } from \"avalanche\" \r\nimport {\r\n    InitialStates,\r\n    SECPTransferOutput\r\n  } from \"avalanche/dist/apis/avm\"\r\n\r\nlet myNetworkID = 12345; //default is 3, we want to override that for our local network\r\nlet myBlockchainID = \"GJABrZ9A6UQFpwjPU8MDxDd8vuyRoDVeDAXc694wJ5t3zEkhU\"; // The X-Chain blockchainID on this network\r\nlet avax = new Avalanche(\"localhost\", 9650, \"http\", myNetworkID, myBlockchainID);\r\nlet xchain = avax.XChain(); //returns a reference to the X-Chain used by AvalancheJS\r\n```\r\n\r\n### Describe the new asset\r\n\r\nThe first steps in creating a new asset using AvalancheJS is to determine the qualities of the asset. We will give the asset a name, a ticker symbol, as well as a denomination. \r\n\r\n```js\r\n// Name our new coin and give it a symbol\r\nlet name = \"Rickcoin is the most intelligent coin\";\r\nlet symbol = \"RICK\";\r\n\r\n// Where is the decimal point indicate what 1 asset is and where fractional assets begin\r\n// Ex: 1 AVAX is denomination 9, so the smallest unit of AVAX is nanoAVAX (nAVAX) at 10^-9 AVAX\r\nlet denomination = 9;\r\n```\r\n\r\n### Creating the initial state\r\n\r\nWe want to mint an asset with 400 coins to all of our managed keys, 500 to the second address we know of, and 600 to the second and third address. This sets up the state that will result from the Create Asset transaction. \r\n\r\n*Note: This example assumes we have the keys already managed in our X-Chain's Keychain.*\r\n\r\n```js\r\nlet addresses = xchain.keyChain().getAddresses();\r\n\r\n// Create outputs for the asset's initial state\r\nlet secpOutput1 = new SECPTransferOutput(new BN(400), new BN(400), 1, addresses);\r\nlet secpOutput2 = new SECPTransferOutput(new BN(500), new BN(400), 1, [addresses[1]]);\r\nlet secpOutput3 = new SECPTransferOutput(new BN(600), new BN(400), 1, [addresses[1], addresses[2]]);\r\n\r\n// Populate the initialStates with the outputs\r\nlet initialState = new InitialStates();\r\ninitialState.addOutput(secpOutput1);\r\ninitialState.addOutput(secpOutput2);\r\ninitialState.addOutput(secpOutput3);\r\n```\r\n\r\n### Creating the signed transaction\r\n\r\nNow that we know what we want an asset to look like, we create an output to send to the network. There is an AVM helper function `buildCreateAssetTx()` which does just that. \r\n\r\n```js\r\n// Fetch the UTXOSet for our addresses\r\nlet utxos = await xchain.getUTXOs(addresses);\r\n\r\n// Make an unsigned Create Asset transaction from the data compiled earlier\r\nlet unsigned = await xchain.buildCreateAssetTx(\r\n  utxos, // the UTXOSet containing the UTXOs we're going to spend\r\n  addresses, // the addresses which will pay the fees\r\n  addresses, // the addresses which recieve the change from the spent UTXOs\r\n  initialState, // the initial state to be created for this new asset \r\n  name, // the full name of the asset\r\n  symbol, // a short ticker symbol for the asset\r\n  denomination // the asse's denomination \r\n);\r\n\r\nlet signed = xchain.keyChain().signTx(unsigned); //returns a Tx class\r\n```\r\n\r\n### Issue the signed transaction\r\n\r\nNow that we have a signed transaction ready to send to the network, let's issue it! \r\n\r\nUsing the AvalancheJS X-Chain API, we going to call the issueTx function. This function can take either the Tx class returned in the previous step, a CB58 representation of the transaction, or a raw Buffer class with the data for the transaction. Examples of each are below:\r\n\r\n```js\r\n// using the Tx class\r\nlet txid = await xchain.issueTx(signed); //returns a CB58 serialized string for the TxID\r\n```\r\n\r\n```js\r\n// using the base-58 representation\r\nlet txid = await xchain.issueTx(signed.toString()); //returns a CB58 serialized string for the TxID\r\n```\r\n\r\n```js\r\n// using the transaction Buffer\r\nlet txid = await xchain.issueTx(signed.toBuffer()); //returns a CB58 serialized string for the TxID\r\n```\r\n\r\nWe assume ONE of those methods are used to issue the transaction.\r\n\r\n### Get the status of the transaction\r\n\r\nNow that we sent the transaction to the network, it takes a few seconds to determine if the transaction has gone through. We can get an updated status on the transaction using the TxID through the AVM API.\r\n\r\n```js\r\n// returns one of: \"Accepted\", \"Processing\", \"Unknown\", and \"Rejected\"\r\nlet status = await xchain.getTxStatus(txid); \r\n```\r\n\r\nThe statuses can be one of \"Accepted\", \"Processing\", \"Unknown\", and \"Rejected\":\r\n\r\n  * \"Accepted\" indicates that the transaction has been accepted as valid by the network and executed\r\n  * \"Processing\" indicates that the transaction is being voted on.\r\n  * \"Unknown\" indicates that node knows nothing about the transaction, indicating the node doesn't have it\r\n  * \"Rejected\" indicates the node knows about the transaction, but it conflicted with an accepted transaction\r\n\r\n### Identifying the newly created asset\r\n\r\nThe X-Chain uses the TxID of the transaction which created the asset as the unique identifier for the asset. This unique identifier is henceforth known as the \"AssetID\" of the asset. When assets are traded around the X-Chain, they always reference the AssetID that they represent.\r\n\r\n## Example 3 — Sending An Asset\r\n\r\nThis example sends an asset in the X-Chain to a single recipient. The first step in this process is to create an instance of Avalanche connected to our Avalanche Platform endpoint of choice.\r\n\r\n```js\r\nimport {\r\n    Avalanche,\r\n    BinTools,\r\n    Buffer,\r\n    BN\r\n  } from \"avalanche\" \r\n\r\nlet myNetworkID = 1; //default is 3, we want to override that for our local network\r\nlet myBlockchainID = \"GJABrZ9A6UQFpwjPU8MDxDd8vuyRoDVeDAXc694wJ5t3zEkhU\"; // The X-Chain blockchainID on this network\r\nlet avax = new avalanche.Avalanche(\"localhost\", 9650, \"http\", myNetworkID, myBlockchainID);\r\nlet xchain = avax.XChain(); //returns a reference to the X-Chain used by AvalancheJS\r\n```\r\n\r\nWe're also assuming that the keystore contains a list of addresses used in this transaction.\r\n\r\n### Getting the UTXO Set\r\n\r\nThe X-Chain stores all available balances in a datastore called Unspent Transaction Outputs (UTXOs). A UTXO Set is the unique list of outputs produced by transactions, addresses that can spend those outputs, and other variables such as lockout times (a timestamp after which the output can be spent) and thresholds (how many signers are required to spend the output). \r\n\r\nFor the case of this example, we're going to create a simple transaction that spends an amount of available coins and sends it to a single address without any restrictions. The management of the UTXOs will mostly be abstracted away. \r\n\r\nHowever, we do need to get the UTXO Set for the addresses we're managing. \r\n\r\n```js\r\nlet myAddresses = xchain.keyChain().getAddresses(); //returns an array of addresses the KeyChain manages\r\nlet addressStrings = xchain.keyChain().getAddressStrings(); //returns an array of addresses the KeyChain manages as strings\r\nlet utxos = await xchain.getUTXOs(myAddresses);\r\n```\r\n\r\n### Spending the UTXOs\r\n\r\nThe `buildBaseTx()` helper function sends a single asset type. We have a particular assetID whose coins we want to send to a recipient address. This is an imaginary asset for this example which we believe to have 400 coins. Let's verify that we have the funds available for the transaction.\r\n\r\n```js\r\nlet assetid = \"23wKfz3viWLmjWo2UZ7xWegjvnZFenGAVkouwQCeB9ubPXodG6\"; //avaSerialized string\r\nlet mybalance = utxos.getBalance(myAddresses, assetid); //returns 400 as a BN\r\n```\r\nWe have 400 coins! We're going to now send 100 of those coins to our friend's address.\r\n\r\n```js\r\nlet sendAmount = new BN(100); //amounts are in BN format\r\nlet friendsAddress = \"X-avax1k26jvfdzyukms95puxcceyzsa3lzwf5ftt0fjk\"; // address format is Bech32\r\n\r\n//The below returns a UnsignedTx\r\n//Parameters sent are (in order of appearance):\r\n//   * The UTXO Set\r\n//   * The amount being sent as a BN\r\n//   * An array of addresses to send the funds\r\n//   * An array of addresses sending the funds\r\n//   * An array of addresses any leftover funds are sent\r\n//   * The AssetID of the funds being sent\r\nlet unsignedTx = await xchain.buildBaseTx(utxos, sendAmount, [friendsAddress], addressStrings, addressStrings, assetid);\r\nlet signedTx = xchain.signTx(unsignedTx);\r\nlet txid = await xchain.issueTx(signedTx);\r\n```\r\n\r\nAnd the transaction is sent!\r\n\r\n### Get the status of the transaction\r\n\r\nNow that we sent the transaction to the network, it takes a few seconds to determine if the transaction has gone through. We can get an updated status on the transaction using the TxID through the X-Chain.\r\n\r\n```js\r\n// returns one of: \"Accepted\", \"Processing\", \"Unknown\", and \"Rejected\"\r\nlet status = await xchain.getTxStatus(txid);\r\n```\r\n\r\nThe statuses can be one of \"Accepted\", \"Processing\", \"Unknown\", and \"Rejected\":\r\n\r\n  * \"Accepted\" indicates that the transaction has been accepted as valid by the network and executed\r\n  * \"Processing\" indicates that the transaction is being voted on.\r\n  * \"Unknown\" indicates that node knows nothing about the transaction, indicating the node doesn't have it\r\n  * \"Rejected\" indicates the node knows about the transaction, but it conflicted with an accepted transaction\r\n\r\n### Check the results\r\n\r\nThe transaction finally came back as \"Accepted\", now let's update the UTXOSet and verify that the transaction balance is as we expected. \r\n\r\n*Note: In a real network the balance isn't guaranteed to match this scenario. Transaction fees or additional spends may vary the balance. For the purpose of this example, we assume neither of those cases.*\r\n\r\n```js\r\nlet updatedUTXOs = await xchain.getUTXOs();\r\nlet newBalance = updatedUTXOs.getBalance(myAddresses, assetid);\r\nif(newBalance.toNumber() != mybalance.sub(sendAmount).toNumber()){\r\n    throw Error(\"heyyy these should equal!\");\r\n}\r\n```\r\n","readmeFilename":"README.md"}