├── .gitignore ├── LICENSE ├── README.md ├── index.js ├── package-lock.json └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | > This repo is archived as of June 29, 2020 but made available for historical record. For a maintained version of similar software please see [@cosmos/cosmjs](https://github.com/cosmos/cosmjs). 2 | 3 | # cosmos-sdk-js 4 | JavaScript client for the Cosmos SDK API 5 | 6 | ## Usage 7 | 8 | ``` 9 | npm install --save cosmos-sdk 10 | ``` 11 | 12 | ```js 13 | let client = require('cosmos-sdk')('http://localhost:45512') 14 | 15 | // create a key 16 | let key = await client.generateKey({ name: 'matt', passphrase: 'top secret' }) 17 | 18 | 19 | // build a transaction 20 | let tx = await client.build('send', { 21 | to: key.address, 22 | amount: { amount: 12345, denom: 'mycoin' }, 23 | fee: { amount: 23, denom: 'atom' } 24 | }) 25 | 26 | // now sign the tx 27 | let signedTx = await client.sign({ tx, name: 'judd', password: 'other top secret' }) 28 | 29 | // send the signed transaction to the node to send out to other nodes 30 | let result = await client.send(tx) 31 | 32 | // query account 33 | let queryResult = await query({ 34 | type: 'account', 35 | data: 'sigs:BDADF167E6CF2CDF2D621E590FF1FED2787A40E0' 36 | }) 37 | console.log(result) 38 | 39 | /* 40 | { 41 | "height": 1170, 42 | "data": { 43 | "coins": [ 44 | { 45 | "denom": "mycoin", 46 | "amount": 12345 47 | } 48 | ] 49 | } 50 | } 51 | */ 52 | 53 | 54 | ``` 55 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | const request = require('axios') 4 | const old = require('old') 5 | 6 | // returns an async function which makes a request for the given 7 | // HTTP method (GET/POST/DELETE/etc) and path (/foo/bar) 8 | function req (method, path) { 9 | return async function (data) { 10 | return await this.request(method, path, data) 11 | } 12 | } 13 | 14 | // returns an async function which makes a request for the given 15 | // HTTP method and path, which accepts arguments to be appended 16 | // to the path (/foo/{arg}/...) 17 | function argReq (method, path) { 18 | return async function (args, data) { 19 | // `args` can either be a single value or an array 20 | if (Array.isArray(args)) { 21 | args = args.join('/') 22 | } 23 | return await this.request(method, `${path}/${args}`, data) 24 | } 25 | } 26 | 27 | class Client { 28 | constructor (server = 'http://localhost:8998') { 29 | this.server = server 30 | } 31 | 32 | async request (method, path, data) { 33 | try { 34 | let res = await request({ 35 | method, 36 | url: this.server + path, 37 | data 38 | }) 39 | return res.data 40 | } catch (resError) { 41 | let data = resError.response.data 42 | if (!data) throw resError 43 | // server responded with error message, create an Error from that 44 | let error = Error(data.error) 45 | error.code = data.code 46 | throw error 47 | } 48 | } 49 | } 50 | 51 | let fetchAccount = argReq('GET', '/query/account') 52 | let fetchNonce = argReq('GET', '/query/nonce') 53 | let fetchCandidates = argReq('GET', '/query/stake/candidates') 54 | 55 | Object.assign(Client.prototype, { 56 | sign: req('POST', '/sign'), 57 | postTx: req('POST', '/tx'), 58 | 59 | // keys 60 | generateKey: req('POST', '/keys'), 61 | listKeys: req('GET', '/keys'), 62 | getKey: argReq('GET', '/keys'), 63 | updateKey: argReq('PUT', '/keys'), 64 | deleteKey: argReq('DELETE', '/keys'), 65 | recoverKey: req('POST', '/keys/recover'), 66 | 67 | // coins 68 | buildSend: req('POST', '/build/send'), 69 | async queryAccount (address) { 70 | try { 71 | return await fetchAccount.call(this, address) 72 | } catch (err) { 73 | // if account not found, return null instead of throwing 74 | if (err.message.includes('account bytes are empty')) { 75 | return null 76 | } 77 | throw err 78 | } 79 | }, 80 | coinTxs: argReq('GET', '/tx/coin'), 81 | 82 | // nonce 83 | async queryNonce (address) { 84 | try { 85 | return await fetchNonce.call(this, address) 86 | } catch (err) { 87 | // if nonce not found, return 0 instead of throwing 88 | if (err.message.includes('nonce empty')) { 89 | return 0 90 | } 91 | throw err 92 | } 93 | }, 94 | 95 | // Tendermint RPC 96 | status: req('GET', '/tendermint/status'), 97 | 98 | // staking 99 | candidate: argReq('GET', '/query/stake/candidates'), 100 | candidates: req('GET', '/query/stake/candidates'), 101 | buildDelegate: req('POST', '/build/stake/delegate'), 102 | buildUnbond: req('POST', '/build/stake/unbond'), 103 | bondingsByDelegator: argReq('GET', '/tx/bondings/delegator'), 104 | bondingsByValidator: argReq('GET', '/tx/bondings/validator') 105 | 106 | // TODO: separate API registration for different modules 107 | }) 108 | 109 | module.exports = old(Client) 110 | -------------------------------------------------------------------------------- /package-lock.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cosmos-sdk", 3 | "version": "1.5.1", 4 | "lockfileVersion": 1, 5 | "requires": true, 6 | "dependencies": { 7 | "axios": { 8 | "version": "0.16.2", 9 | "resolved": "https://registry.npmjs.org/axios/-/axios-0.16.2.tgz", 10 | "integrity": "sha1-uk+S8XFn37q0CYN4VFS5rBScPG0=", 11 | "requires": { 12 | "follow-redirects": "1.2.4", 13 | "is-buffer": "1.1.5" 14 | } 15 | }, 16 | "debug": { 17 | "version": "2.6.8", 18 | "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.8.tgz", 19 | "integrity": "sha1-5zFTHKLt4n0YgiJCfaF4IdaP9Pw=", 20 | "requires": { 21 | "ms": "2.0.0" 22 | } 23 | }, 24 | "follow-redirects": { 25 | "version": "1.2.4", 26 | "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.2.4.tgz", 27 | "integrity": "sha512-Suw6KewLV2hReSyEOeql+UUkBVyiBm3ok1VPrVFRZnQInWpdoZbbiG5i8aJVSjTr0yQ4Ava0Sh6/joCg1Brdqw==", 28 | "requires": { 29 | "debug": "2.6.8" 30 | } 31 | }, 32 | "is-buffer": { 33 | "version": "1.1.5", 34 | "resolved": "https://registry.npmjs.org/is-buffer/-/is-buffer-1.1.5.tgz", 35 | "integrity": "sha1-Hzsm72E7IUuIy8ojzGwB2Hlh7sw=" 36 | }, 37 | "ms": { 38 | "version": "2.0.0", 39 | "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", 40 | "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" 41 | }, 42 | "object-assign": { 43 | "version": "4.1.1", 44 | "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", 45 | "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=" 46 | }, 47 | "old": { 48 | "version": "0.2.0", 49 | "resolved": "https://registry.npmjs.org/old/-/old-0.2.0.tgz", 50 | "integrity": "sha1-rnWp8zuufLP+BjEombeuWnO6JO8=", 51 | "requires": { 52 | "object-assign": "4.1.1" 53 | } 54 | } 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cosmos-sdk", 3 | "version": "1.5.1", 4 | "description": "JavaScript client for the Cosmos SDK API", 5 | "main": "index.js", 6 | "dependencies": { 7 | "axios": "^0.16.2", 8 | "old": "^0.2.0" 9 | }, 10 | "devDependencies": {}, 11 | "scripts": { 12 | "test": "echo \"Error: no test specified\" && exit 1" 13 | }, 14 | "repository": { 15 | "type": "git", 16 | "url": "git+https://github.com/tendermint/cosmos-sdk-js.git" 17 | }, 18 | "author": "", 19 | "license": "ISC", 20 | "bugs": { 21 | "url": "https://github.com/tendermint/cosmos-sdk-js/issues" 22 | }, 23 | "homepage": "https://github.com/tendermint/cosmos-sdk-js#readme" 24 | } 25 | --------------------------------------------------------------------------------