diff --git a/.gitignore b/.gitignore index c9c3cfdefde3..8fd034669683 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ .idea/* .nyc_output -build +dist node_modules test src/**.js diff --git a/LICENSE b/LICENSE index 53aa1e11c487..b223be5019a7 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,202 @@ -MIT License - -Copyright (c) 2019 bartosz-lipinski - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + limitations under the License. diff --git a/package-lock.json b/package-lock.json index 5c52bdb4a570..30392f2c5e3b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@solana/token-list", - "version": "1.0.0", + "version": "0.1.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -2210,6 +2210,14 @@ } } }, + "cross-fetch": { + "version": "3.0.6", + "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.0.6.tgz", + "integrity": "sha512-KBPUbqgFjzWlVcURG+Svp9TlhA5uliYtiNx/0r8nv0pdypeQCRJ9IaSIc3q/x3q8t3F75cHuwxVql1HFGHCNJQ==", + "requires": { + "node-fetch": "2.6.1" + } + }, "cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -6441,8 +6449,7 @@ "node-fetch": { "version": "2.6.1", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", - "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", - "dev": true + "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==" }, "node-preload": { "version": "0.2.1", diff --git a/package.json b/package.json index 6ad94f559cb1..6c3df99583fa 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "name": "@solana/token-list", + "name": "@solana/spl-token-registry", "version": "0.1.0", - "description": "Solana Token List", - "main": "build/main/index.js", - "typings": "build/main/index.d.ts", - "module": "build/module/index.js", - "repository": "https://github.com/bartosz-lipinski/@solana/token-list", - "license": "MIT", + "description": "Solana Token Registry", + "main": "dist/main/index.js", + "typings": "dist/main/index.d.ts", + "module": "dist/module/index.js", + "repository": "https://github.com/solana-labs/token-list", + "license": "Apache", "keywords": [], "scripts": { "build": "run-p build:*", @@ -41,7 +41,6 @@ "engines": { "node": ">=10" }, - "dependencies": {}, "devDependencies": { "@ava/typescript": "^1.1.1", "@istanbuljs/nyc-config-typescript": "^1.0.1", @@ -100,5 +99,8 @@ "exclude": [ "**/*.spec.js" ] + }, + "dependencies": { + "cross-fetch": "^3.0.6" } } diff --git a/src/lib/tokens.ts b/src/lib/tokens.ts index 5d68d7a7bc76..1f53a641aab8 100644 --- a/src/lib/tokens.ts +++ b/src/lib/tokens.ts @@ -2,6 +2,8 @@ import devnet from './../tokens/devnet.json'; import mainnetBeta from './../tokens/mainnet-beta.json'; import testnet from './../tokens/testnet.json'; +import * as cross from 'cross-fetch'; + export enum ENV { MainnetBeta = 'mainnet-beta', Testnet = 'testnet', @@ -13,3 +15,78 @@ export const TOKENS = { [ENV.Testnet]: testnet, [ENV.Devnet]: devnet, }; + +export interface KnownToken { + tokenSymbol: string; + tokenName: string; + icon?: string; + mintAddress: string; +} + +export type KnownTokenMap = Map; + +export class SolanaTokenListResolutionStrategy { + resolve = async (network: string) => { + throw new Error(`Not Implemented Yet. ${network}`,); + } +} + +export class StaticTokenListResolutionStrategy { + resolve = async (network: string) => { + return TOKENS[network as ENV] as KnownToken[]; + } +} + +const queryJsonFiles = async (network: string, files: string[]) => { + const responses = await Promise.all(files.map(async repo => { + const response = await cross.fetch(`${repo}/${network}.json`); + const json = await response.json() as KnownToken[]; + + return json; + })); + + return responses.reduce((acc, arr) => acc.concat(arr), []); +} + +export class GitHubTokenListResolutionStrategy { + repositories = [ + 'https://github.com/solana-labs/token-list/tree/main/src/tokens', + 'https://github.com/project-serum/serum-ts/tree/master/packages/tokens/src' + ]; + + resolve = async (network: string) => { + return queryJsonFiles(network, this.repositories); + } +} + +export class CDNTokenListResolutionStrategy { + repositories = [ + 'https://cdn.jsdelivr.net/gh/solana-labs/token-list@tree/main/src/tokens', + 'https://cdn.jsdelivr.net/gh/project-serum/serum-ts@tree/master/packages/tokens/src' + ]; + + resolve = async (network: string) => { + return queryJsonFiles(network, this.repositories); + } +} + +export enum Strategy { + GitHub = 'GitHub', + Static = 'Static', + Solana = 'Solana', + CDN = 'CDN', +} + +export class TokenListProvider { + static strategies = { + [Strategy.GitHub]: new GitHubTokenListResolutionStrategy(), + [Strategy.Static]: new StaticTokenListResolutionStrategy(), + [Strategy.Solana]: new SolanaTokenListResolutionStrategy(), + [Strategy.CDN]: new CDNTokenListResolutionStrategy(), + } + + + resolve = async (network: string, strategy: Strategy = Strategy.CDN) => { + return TokenListProvider.strategies[strategy].resolve(network); + }; +} diff --git a/src/tokens/devnet.json b/src/tokens/devnet.json index 24afb15c55e0..11050841cd4f 100644 --- a/src/tokens/devnet.json +++ b/src/tokens/devnet.json @@ -9,18 +9,6 @@ "tokenSymbol": "XYZ", "mintAddress": "DEhAasscXF4kEGxFgJ3bq4PpVGp5wyUxMRvn6TzGVHaw", "tokenName": "XYZ Test", - "icon": "https://raw.githubusercontent.com/trustwallet/assets/08d734b5e6ec95227dc50efef3a9cdfea4c398a1/blockchains/ethereum/assets/0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984/logo.png" - }, - { - "tokenSymbol": "ABC", - "mintAddress": "6z83b76xbSm5UhdG33ePh7QCbLS8YaXCQ9up86tDTCUH", - "tokenName": "ABC Test", - "icon": "https://raw.githubusercontent.com/trustwallet/assets/08d734b5e6ec95227dc50efef3a9cdfea4c398a1/blockchains/ethereum/assets/0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984/logo.png" - }, - { - "tokenSymbol": "DEF", - "mintAddress": "3pyeDv6AV1RQuA6KzsqkZrpsNn4b3hooHrQhGs7K2TYa", - "tokenName": "DEF Test", - "icon": "https://raw.githubusercontent.com/trustwallet/assets/08d734b5e6ec95227dc50efef3a9cdfea4c398a1/blockchains/ethereum/assets/0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984/logo.png" + "icon": "https://raw.githubusercontent.com/trustwallet/assets/f3ffd0b9ae2165336279ce2f8db1981a55ce30f8/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png" } ] diff --git a/src/tokens/mainnet-beta.json b/src/tokens/mainnet-beta.json index 51c7484715eb..cbf8e82d58a9 100644 --- a/src/tokens/mainnet-beta.json +++ b/src/tokens/mainnet-beta.json @@ -144,5 +144,48 @@ "mintAddress": "EcqExpGNFBve2i1cMJUTR4bPXj4ZoqmDD2rTkeCcaTFX", "tokenName": "Wrapped KARMA", "icon": "https://raw.githubusercontent.com/machi-x/assets/152f2ca62611ef23298fac9a8e657386984d2d33/blockchains/ethereum/assets/0xdfe691f37b6264a90ff507eb359c45d55037951c/logo.png" + }, + { + "tokenSymbol": "LUA", + "mintAddress": "EqWCKXfs3x47uVosDpTRgFniThL9Y8iCztJaapxbEaVX", + "tokenName": "Wrapped LUA", + "icon": "https://raw.githubusercontent.com/trustwallet/assets/2d2491130e6beda208ba4fc6df028a82a0106ab6/blockchains/ethereum/assets/0xB1f66997A5760428D3a87D68b90BfE0aE64121cC/logo.png" + }, + { + "tokenSymbol": "MATH", + "mintAddress": "GeDS162t9yGJuLEHPWXXGrb1zwkzinCgRwnT8vHYjKza", + "tokenName": "Wrapped MATH" + }, + { + "tokenSymbol": "KEEP", + "mintAddress": "GUohe4DJUA5FKPWo3joiPgsB7yzer7LpDmt1Vhzy3Zht", + "tokenName": "Wrapped KEEP" + }, + { + "tokenSymbol": "SWAG", + "mintAddress": "9F9fNTT6qwjsu4X4yWYKZpsbw5qT7o6yR2i57JF2jagy", + "tokenName": "Wrapped SWAG" + }, + { + "tokenSymbol": "FIDA", + "mintAddress": "EchesyfXePKdLtoiZSL8pBe8Myagyy8ZRqsACNCFGnvp", + "tokenName": "Bonfida", + "icon": "https://raw.githubusercontent.com/dr497/awesome-serum-markets/02ce7c74fd2e9bd4cb55a15f735fc3ad0e7335f6/icons/fida.svg" + }, + { + "tokenSymbol": "KIN", + "mintAddress": "kinXdEcpDQeHPEuQnqmUgtYykqKGVFq6CeVX5iAHJq6", + "tokenName": "KIN", + "icon": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/kin/info/logo.png" + }, + { + "tokenSymbol": "MAPS", + "mintAddress": "MAPS41MDahZ9QdKXhVa4dWB9RuyfV4XqhyAZ8XcYepb", + "tokenName": "MAPS" + }, + { + "tokenSymbol": "MAPS", + "mintAddress": "MAPS41MDahZ9QdKXhVa4dWB9RuyfV4XqhyAZ8XcYepb", + "tokenName": "MAPS" } ] diff --git a/src/tokens/testnet.json b/src/tokens/testnet.json index 94c712db7cd6..7c81431d20c7 100644 --- a/src/tokens/testnet.json +++ b/src/tokens/testnet.json @@ -9,6 +9,6 @@ "tokenSymbol": "ABC", "mintAddress": "D4fdoY5d2Bn1Cmjqy6J6shRHjcs7QNuBPzwEzTLrf7jm", "tokenName": "ABC Test", - "icon": "https://raw.githubusercontent.com/trustwallet/assets/master/blockchains/bitcoin/info/logo.png" + "icon": "https://raw.githubusercontent.com/trustwallet/assets/f3ffd0b9ae2165336279ce2f8db1981a55ce30f8/blockchains/ethereum/assets/0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48/logo.png" } ] diff --git a/tsconfig.json b/tsconfig.json index e2bb74cb84d6..b9ae366e4804 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -2,7 +2,7 @@ "compilerOptions": { "incremental": true, "target": "es2017", - "outDir": "build/main", + "outDir": "dist/main", "rootDir": "src", "moduleResolution": "node", "module": "commonjs", diff --git a/tsconfig.module.json b/tsconfig.module.json index dfb74fa3a355..cf32f627830b 100644 --- a/tsconfig.module.json +++ b/tsconfig.module.json @@ -2,7 +2,7 @@ "extends": "./tsconfig", "compilerOptions": { "target": "esnext", - "outDir": "build/module", + "outDir": "dist/module", "module": "esnext" }, "exclude": [