Datasets:

jcarbonnell

/

structTuningNEAR

like 1

k-kinzal_solana-materials-in-japanese

README.md

# Solanaの日本語資料 Solanaの開発に関わる日本語の資料をまとめています。 - [Discord](https://discord.com/invite/w6gnxPb4JJ) ## ドキュメント - [Solana Cookbook](https://solanacookbook.com/ja/) ## 記事 - [RustでSolanaのオンチェーンプログラムをデプロイする｜cml_2010](https://note.com/cml_2010/n/n3b0895215b64) - [Nuxt.jsで@solana/web3.jsを使用する](https://note.com/cml_2010/n/n5600fb1f68b8) - [Solanaでスマートコントラクトを書いてみた - GeT_Pwn3d!](https://morimolymoly.hateblo.jp/entry/2021/10/05/191631) - [ソラナ（Solana）ブロックチェーン及び ソラナ上のトークンの発行 ...](https://recruit.gmo.jp/engineer/jisedai/blog/solana_blockchain_and_token/) - [ブロックチェーン知識ゼロから Solana ハッカソンに参戦するまでの ...](https://tomoima525.hatenablog.com/entry/2021/10/21/161644) - [React、Anchor、Rust、Phantomを使用したフルスタックSolana ...](https://note.com/nftonline/n/n21fdb1a9bcc0) - [Solana での BOT 開発の概要](https://zenn.dev/softgate/articles/8ee1e3e3f1ce33) - [イーサリアムキラーの本命？Solanaのプログラムを作って遊んで ...](https://blog.flinters.co.jp/entry/2021/11/08/090000) - [SolanaのAnchorで実装されたEscrowのコード解説](https://zenn.dev/razokulover/articles/c2338cb83f459b) - [Solanaの学習](https://zenn.dev/razokulover/scraps/31398dd485ff26) - [Solanaでの開発ことはじめ](https://zenn.dev/razokulover/scraps/0a7d6ffdffddd4) - [SolanaのWeb3.jsサンプル実装 – myMemoBlog by 256hax](https://blog.tanebox.com/archives/1638/) - [【保存版】solanaのBOT開発かんたんに説明｜20代男性の裏側](https://takenchi.com/3767-2) - [Solana Anchorのデバッグ方法 – myMemoBlog by 256hax](https://blog.tanebox.com/archives/1674/) - [Solanaさわり - Qiita](https://qiita.com/hhatto/items/d52b58aec86d1c89575f) - [Solana x Anchorのブロックチェーン開発 初心者ガイド ...](https://blog.tanebox.com/archives/1681/) - [Solana OrcaのDevnetサンプル実装（Orca Typescript SDK ...](https://blog.tanebox.com/archives/1746/) - [2021年に作ったモノや技術をふりかえる - laiso](https://laiso.hatenablog.com/entry/2021/12/24/tech2021) - [SolanaのNFTをMintするまで解説 1/4 NFTのデータ構成を把握してToken情報からNFT画像まで辿れるようにする](https://zenn.dev/regonn/articles/solana-nft-00) - [[Solana] CLI ツールを使ってみる](https://zenn.dev/utah/articles/3a7c7f60ed4e9f) - [Solanaのアカウントをデコードしてみた #Rust - Qiita](https://qiita.com/TakoM/items/d94fe3874820112e52a7) - [SolanaのNFTをMintするまで解説 2/4 Walletに入っているNFTの画像をPythonで取得する](https://zenn.dev/regonn/articles/solana-nft-01) - [SolanaのNFTをMintするまで解説 3/4 Arweaveに画像とオフチェーンメタデータをアップロード](https://zenn.dev/regonn/articles/solana-nft-02) - [SolanaのNFTをMintするまで解説 4/4 SPLトークンをミントしてNFTを作成](https://zenn.dev/regonn/articles/solana-nft-03) - [Solana のトークン価格取得｜yugure.sol](https://note.com/crypto2real/n/n6c8919653d58) - [Solana の Orca で独自プールを作る](https://note.com/crypto2real/n/n9707cef57e25) - [【解決方法は？】Solanaで”transaction was not confirmed in 60.01 ...](https://tialight.com/?p=1883) - [Solana上でNFTを発行する【Candy Machine】](https://self-development.info/solana%E4%B8%8A%E3%81%A7nft%E3%82%92%E7%99%BA%E8%A1%8C%E3%81%99%E3%82%8B%E3%80%90candy-machine%E3%80%91/) - [Solana の Anchor フレームワーク使用時のメモ](https://note.com/crypto2real/n/nf3e0f77d7dc5) - [Solana の Orca で route スワップする｜yugure.sol](https://note.com/crypto2real/n/ndb3c4b7bbe88) - [SolanaのNFT関連のアカウントをリストアップ｜yugure.sol](https://note.com/crypto2real/n/nf1d9ce688a48) - [Solana の NFT を認証要素として使う｜yugure.sol](https://note.com/crypto2real/n/n6b4d813e1a44) - [【Solana, TypeScript】自分のウォレットでSPLトークンを作成する ...](https://qiita.com/derodero24/items/7b7ff2171c2a4ea75a4f) - [【Solana, TypeScript】NFTのmintアドレスから現在のオーナー ...](https://qiita.com/derodero24/items/c5ea1c6f9468879a6085) - [【Solana, TypeScript】base58エンコードされたstring型アドレスをweb3.Publickey型に変換](https://qiita.com/derodero24/items/b601ff285d5f9bc9d8da) - [SolanaでDapps開発](https://zenn.dev/lsii/scraps/387b2a7b81e959) - [Solana開発メモ](https://zenn.dev/kinzal/scraps/6e2efb96d72950) - [dex bot開発ムズすぎワロタぁ！ - INTP型のブログ](https://intptan.hatenablog.com/entry/2022/04/07/121206) - [NEAR Protocol: はじめてのスマートコントラクト in Rust](https://smacon.dev/posts/near-first-contract/) - [はじめての Solana: Rust で Hello World!](https://smacon.dev/posts/solana-hello/) - [Solana wallet-adapterで「RPC Error: Transaction creation failed ...](https://blog.tanebox.com/archives/2078/) - [Rust ではじめるスマートコントラクト入門 | Web3 プログラミング ...](https://smacon.dev/rust/) - [Solana MetaplexでmintNFTすると「Non-base58 character」エラー ...](https://blog.tanebox.com/archives/2094/) - [Solana web3.jsでNFTミント後にNFT送信すると ...](https://blog.tanebox.com/archives/2101/) - [Solana / RPCからの結果のゆらぎ｜yugure.sol](https://note.com/crypto2real/n/n53e6f58b1cf0) - [Solanaを理解する上で重要な用語5つを噛み砕いてみる](https://zenn.dev/hyde2000/articles/e5127057e2c78a) - [Solana チェーンで NFT MINT 。 Metaplex 。candy machine ...](https://asuki-yt.hatenablog.jp/entry/2022/06/09/Solana_NFT_MINT_Metaplex_candy_machine_01) - [SolanaのEscrow実装でつまずいた人へ送る有意義な情報](https://zenn.dev/damisososo/articles/anchor-escrow-beginner) - [[Solana] Wallet情報をrecoverする | DevelopersIO](https://dev.classmethod.jp/articles/solana-wallet/) - [SolanaでHelloWorldしてみる｜yasstake](https://note.com/yasstake/n/nc88bfb1cef16) - [Solanaではじめるスマートコントラクト | DevelopersIO](https://dev.classmethod.jp/articles/solana-kickstart/) - [Solana 分散ストレージの Shadow Drive を利用して Solana エコシステム上で NFT を発行する](https://zenn.dev/regonn/articles/shadow-drive-nft) - [solanaとserumの勉強 #1 -orderbookの中身見てみる-](https://zenn.dev/dl10yr/articles/solana-serum-1) - [Solana Walletのmnemonic（シード鍵）をCLIから作る](https://zenn.dev/esplo/articles/73b8fb742e44a4) - [Rustの開発環境を構築した話 - 鈴木商店ブログ](https://blog.suzukishouten.co.jp/archives/2516) - [anchor（Rust）でuse of undeclared crate or moduleエラー ...](https://blog.tanebox.com/archives/2153/) - [RustでSolanaのNFTマーケットプレイスを自作する道](https://zenn.dev/anharu/scraps/97378e849b2fa6) - [Solana の Tx 一括実行 with Phantom｜yugure.sol](https://note.com/crypto2real/n/ne5f7d93d22cc) - [spl-token送信時にTokenAccountNotFoundError](https://penpen-dev.com/blog/spl-token-tokenaccountnotfounderror/) - [Solana, Anchorフレームワークのチュートリアルをやってみる](https://zenn.dev/yusuke_ikeda/articles/5d2faf474bbb01) - [Candy Machine v2とSugarの違い【metaplex】](https://penpen-dev.com/blog/candy-sugar-metaplex/) - [ある時点のトークン量を知る方法｜yugure.sol](https://note.com/crypto2real/n/n101dfab3519f) - [Solana上にNFTをアップロード＆mintサイトを作るまでの手順](https://penpen-dev.com/blog/candy-machine-howto/) - [【Solana 開発】Solana のスマートコントラクト開発環境を作ろう ...](https://zenn.dev/fumisouls/articles/8bf753f9deb098) - [Solana Anchorで「does not match authority provided」エラー ...](https://blog.tanebox.com/archives/2202/) - [【Solana 開発】Solana のスマートコントラクト開発環境を作ろう ...](https://zenn.dev/fumisouls/articles/dc7aa1627783b3) - [Solana, Hello world スマートコントラクトの説明](https://zenn.dev/yusuke_ikeda/articles/bf88075672f4a2) - [[Solana] NFTをmintしてみる | DevelopersIO](https://dev.classmethod.jp/articles/solana-nft-mint/) - [Solana SPLトークンのスマートコントラクトについて解説](https://zenn.dev/yusuke_ikeda/articles/b814f821e478a9) - [ぼくのかんがえたさいきょうの Solana dApp ボイラープレート](https://zenn.dev/ki4themecha2q/articles/f749e2328a7d99) - [Solana project - HackMD](https://hackmd.io/@keis/H1jotpNOc) - [SolanaのWeb3.jsを実行すると「custom program error: 0xc」エラー ...](https://blog.tanebox.com/archives/2246/) - [Solana CLI のインストール - piyopiyo](https://scrapbox.io/piyopiyo/Solana_CLI_%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB) - [Solana で特定のプログラムの BPF バイナリをダンプする方法 ...](https://hackmd.io/@kazuki-hanai/solana-dump-program) - [Solanaのトランザクションについて - HackMD](https://hackmd.io/@kazuki-hanai/solana-transaction) - [Solana のスナップショットのあれこれ｜yugure.sol](https://note.com/crypto2real/n/n71453e72cc2b) - [Web3 ハッカソンに出て初めてのブロックチェーンアプリケーション ...](https://qiita.com/kenmaro/items/7aa336227d6eb332d791) - [Solana(Anchor) + Nextjs でTODOアプリケーション構築 のまとめ ...](https://qiita.com/kenmaro/items/4732bcc5350984cd7a66) - [全然わかってないけど一回わかっていることをアウトプットして ...](https://intptan.hatenablog.com/entry/2022/12/15/203432) - [Solanaで「unknown signer: ${pubkey.toString()」エラー ...](https://blog.tanebox.com/archives/2285/) - [Solanaで独自トークンのあれこれ - Qiita](https://qiita.com/ykaun16/items/a95e1ac8cfac694acba1) - [Next.js、ReactJSエンジニアのための今使えるWeb3の話](https://zenn.dev/tfutada/articles/70db9f889cba60) - [Solana開発用のウォレット作成とdevnetトークンを取得してみよう](https://zenn.dev/yuki2020/articles/c7776592e3bda4) - [thirdwebを用いて、Solana上でトークンを発行してみよう](https://zenn.dev/yuki2020/articles/bb1ff21b2d37ab) - [thirdwebで作ったコントラクト（Solana）をCandyPayのQRコードミントで実行しよう！](https://zenn.dev/yuki2020/articles/7dba46646feff5) - [Solana AnchorでANCHOR_PROVIDER_URL、ANCHOR_WALLET ...](https://blog.tanebox.com/archives/2304/) - [anchor testで「connect ECONNREFUSED ::1:8899」エラー ...](https://blog.tanebox.com/archives/2310/) - [Solana Anchorのtestでdotenvを使って.env.devを読み込みたい ...](https://blog.tanebox.com/archives/2320/) - [Orca で 集中流動性AMM Bot を動かす Part 1 ~SDKを利用してリバランスする~](https://zenn.dev/regonn/articles/orca-clamm-bot-01) - [SolanaでToken Accountを作成すると「SendTransactionError ...](https://blog.tanebox.com/archives/2393/) - [Solana Foundation ChatGPTプラグイン｜20代男性の裏側](https://takenchi.com/solana-foundation-%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3) - [Metaplex Candy Machineで「PublicKeyMismatch: Public key ...](https://blog.tanebox.com/archives/2417/) - [Web3 Security & Privacy service Elusiv Study](https://zenn.dev/kozayupapa/articles/dda84663aebd25) - [SolanaのToken Programのソースコードを理解する - GMO ...](https://recruit.gmo.jp/engineer/jisedai/blog/solana-token-program-undersanding/) - [Solana Anchor Study](https://zenn.dev/kozayupapa/articles/e3f7e073f2b300) - [solana開発入門 備忘録 ~基本概念と開発ツールのまとめ~ - Qiita](https://qiita.com/PoKoPoKoTa2ry/items/ebdeea31ce0d735d5b07) - [【Solana NFT】@metaplex-foundation/js によってビルドが失敗するようになったら【Umiへの移行】](https://zenn.dev/ki4themecha2q/articles/9df28e76803064) - [Solana開発メモ2](https://zenn.dev/kinzal/scraps/92aedf4b383614) - [Solana バリデーター向けのオープンソースCLIツール "solv" を公開しました](https://zenn.dev/ki4themecha2q/articles/072bed24dc9345) - [忙しい人のためのSolana Compressed NFT (cNFT)](https://zenn.dev/ki4themecha2q/articles/7dcb9753783a23) - [Solana Validator のはじめかた。](https://zenn.dev/fumisouls/articles/1139254969bafb) - [Solanaバリデーターをわずか10分で立ち上げるオープンソースツール"solv"](https://zenn.dev/ki4themecha2q/articles/c65ee24ddc2a0f) - [ぼくのかんがえたさいきょうの Solana dApp ボイラープレート #React](https://qiita.com/KishiTheMechanic/items/0000fc195ae3e7092644) - [SolanaのSPLの書き方を知ろう](https://zenn.dev/kinzal/articles/c2c8ced07ecd40) - [SolanaのプログラムでCRUDしてみよう](https://zenn.dev/kinzal/articles/5302a4dae1c8d7) - [Solana Validator のはじめかた。(お引越しも対応) #Ubuntu - Qiita](https://qiita.com/FumiSOULs/items/3f26a7b29d8711fb8432) - [Pyth Networkでオンチェインデータフィードを取得する | ファブリカ ...](https://www.fabrica-com.co.jp/techblog/technology/11556/) - [Solanaのプログラムでより安全で、より可読性の高い書き方を考え ...](https://zenn.dev/kinzal/scraps/18e06c1bb0d0d3) - [忙しい人のための Sign In With Solana (SIWS)](https://zenn.dev/ki4themecha2q/articles/85b8725a142f76) - [第1章: Solana バリデーターの完全ガイド - ゼロからの設定、ノード ...](https://qiita.com/FumiSOULs/items/92df847a056ed39d5e44) - [Solanaでプログラムを使った計算結果を取得する](https://zenn.dev/kinzal/articles/559d91fe76914e) - [Solang (Solidity)で始めるSolanaスマートコントラクト開発](https://zenn.dev/kinzal/articles/5c3ee2a6b102a6) - [solv2リリース - 簡単3ステップでSolanaバリデーターを立ち上げ。Latitudeクーポンで無料お試し可能。](https://note.com/kishithemechanic/n/n3bb48f186e44) - [Solana Developer Hub Online #0: Rust入門 in Solana｜SolDevHub](https://note.com/solana_dev_hub/n/n0eed6427740c) - [Solana Developer Hub Online #0: AIで始めるRustプログラミング ...](https://note.com/solana_dev_hub/n/n941676e23230) - [Solana AnchorでProvider local is not available on browser ...](https://blog.tanebox.com/archives/2441/) - [Solana Anchorで作ったProgramのIDLをReactから呼ぶとIdlType ...](https://blog.tanebox.com/archives/2438/) - [botterのためのRustでSolana入門（前編） #Rust - Qiita](https://qiita.com/pico-sol/items/013c0645906ed598c37b) - [Solana Suiteを使ってCompressed NFTをMintする](https://fukaoi.hashnode.dev/solana-suitecompressed-nftmint) - [Solana の RPC プロバイダ比較｜yugure.sol](https://note.com/crypto2real/n/neb31115a8de5) - [Solana の Program 周りに関する調査](https://hackmd.io/@woxjro/BJyAje4vp) - [はじめてのAtomic Arbitrage with Rust とon-chain Program｜pe](https://note.com/clever_dahlia308/n/nfe54507cffe7) - [\[Typescript\] solanaのアカウント作成(テストネット) + フォーセット ...](https://qiita.com/sakenomi_dev/items/4140342271334420f326) - [SolanaのToken-2022 ProgramのMetadataを検証してみた - GMO ...](https://recruit.gmo.jp/engineer/jisedai/blog/solana-token-2022-program-metadata/) - [Pyth NetworkのAccount調査](https://zenn.dev/kinzal/articles/d6418610d83b41) - [Solana 上で複数の Compressed NFT (cNFT) を一度にMintする時の ...](https://zenn.dev/ki4themecha2q/articles/684150604d8be8) - [Solana Developer Hub #2: コントラクトを作らないブロック ...](https://note.com/solana_dev_hub/n/nfbf5250bff62) - [Metaplex UmiでCompressed NFTを発行すると「0x178c」エラー ...](https://blog.tanebox.com/archives/2507/) - [MetaplexでNFT発行すると「0x177c」エラー – myMemoBlog by ...](https://blog.tanebox.com/archives/2510/) - [Collection NFTに紐づけてCompressed NFTを発行すると「Not ...](https://blog.tanebox.com/archives/2518/) - [【完全保存版】solanaでコントラクトのデプロイから ...](https://note.com/standenglish/n/n4101cd465b2d) - [【完全保存版】ローカル環境でのsolana CLIを実行（コントラクトの ...](https://note.com/standenglish/n/nd90e38db1781) - [第1章: Solana バリデーターの完全ガイド - ゼロからの設定、ノード ...](https://zenn.dev/fumisouls/books/971a5ba1212303/viewer/b82322) ## 英語資料のリンク集 - [SolanaNatives/Solana-Programming-Resources](https://github.com/SolanaNatives/Solana-Programming-Resources)

ilyar_lab

.etc karma.conf.js service-worker.json README.md angular.json package.json src contract depositum depositum.ts web app app-routing.module.ts app.component.spec.ts app.component.ts app.module.ts panel panel.component.spec.ts panel.component.ts wallet.service.ts asset logo.svg config.ts environments environment.prod.ts environment.ts index.html main.ts polyfills.ts test.ts tsconfig.json tsconfig.spec.json tsconfig.web.json

# NgApp This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.2.6. ## Development server Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. ## Code scaffolding Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`. ## Build Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. ## Running unit tests Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). ## Running end-to-end tests Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities. ## Further help To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

Njoguu_DeFi-Public-Transport-App

README.md contract Cargo.toml build.bat build.sh src lib.rs test.sh frontend assets css main.css js NEAR contract.js near-api.js near-config.js scripts.js index.html package.json

# DeFi-Public-Transport-App A Decentralized Finance(DeFi) application that will serve as a payment service for the Public Transport sector built on the NEAR Blockchain. ## Exploring The Code 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/assests/NEAR/contract.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `npm run test`. ## Deploy Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. ### Step 0: Install near-cli (optional) [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) ### Step 1: Create an account for the contract Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet ### Step 2: set contract name in code Modify the line in `frontend/near-config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' ### Step 3: deploy! This command will build and deploy the smart contract to NEAR Testnet: npm run deploy ## Troubleshooting On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages

near_octopus

.github FUNDING.yml ISSUE_TEMPLATE BOUNTY.yml README.md examples BTC disasm_witness.py EOS bytecode_analytic.py call_graph_module.py cfg_module.py disasm_module.py source eos_ping.cpp ETH evm_cfg_ethernaut0.py evm_explorer_infura.py wasm_getcode_infura_kovan.py NEO cfg_lock.py disasm_lock.py explorer_get_code_lock.py wasm bytecode_analytic.py cfg_and_callgraph_fibo.py ssa_fibo.py wasm_module_analysis.py octopus __init__.py analysis __init__.py cfg.py graph.py arch __init__.py evm __init__.py cfg.py disassembler.py emulator.py evm.py instruction.py ssa.py vmstate.py wasm __init__.py analyzer.py cfg.py constant.py decode.py disassembler.py emulator.py format.py instruction.py signatures emscripten_syscalls.json vmstate.py wasm.py core __init__.py basicblock.py contract.py edge.py function.py instruction.py ssa.py utils.py engine __init__.py disassembler.py emulator.py engine.py explorer.py helper.py ssa.py symbolic_execution.py octopus_eth_evm.py platforms BTC __init__.py bech32.py btcscript.py disassembler.py explorer.py instruction.py EOS __init__.py analyzer.py cfg.py disassembler.py emulator.py explorer.py ETH __init__.py cfg.py constants.py contract.py disassembler.py emulator.py explorer.py save_ssa.py util.py NEO __init__.py avm.py cfg.py disassembler.py explorer.py instruction.py __init__.py tests BTC __init__.py test_disassembler.py test_explorer.py EOS __init__.py test_callgraph.py test_disassembler.py ETH __init__.py test_cfg.py test_disassembler.py test_explorer.py NEO __init__.py test_cfg.py test_disassembler.py test_explorer.py WASM __init__.py test_cfg.py test_disassembler.py __init__.py btc_run_tests.sh eos_run_tests.sh eth_run_tests.sh neo_run_tests.sh wasm_run_tests.sh octopus_eth_evm.py octopus_wasm.py requirements.txt run_explorer_tests.sh run_tests.sh setup.py

# Octopus <p align="center"> <img src="/images/logo-medium.png" height="300px"/> </p> [](https://www.python.org/) [](https://github.com/quoscient/octopus/graphs/commit-activity) [](LICENSE) Huge thanks to [QuoScient](https://www.quoscient.io/) for having sponsored this project. **Octopus is a security analysis framework for WebAssembly module and Blockchain Smart Contract.** The purpose of Octopus is to provide an easy way to analyze closed-source WebAssembly module and smart contracts bytecode to understand deeper their internal behaviours. ## Features - **Explorer**: Octopus JSON-RPC client implementation to communicate with blockchain platforms - **Disassembler**: Octopus can translate bytecode into assembly representation - **Control Flow Analysis**: Octopus can generate a Control Flow Graph (CFG) - **Call Flow Analysis**: Octopus can generate a Call Flow Graph (function level) - **IR conversion (SSA)**: Octopus can simplify assembly into Static Single Assignment (SSA) representation - **Symbolic Execution**: Octopus use symbolic execution to find new paths into a program ## Platforms / Architectures Octopus support the following types of programs/smart contracts: * WebAssembly module (WASM) * Bitcoin script (BTC script) * Ethereum smart contracts (EVM bytecode & Ewasm) * EOS smart contracts (WASM) * NEO smart contracts (AVM bytecode) || BTC | ETH (EVM) | ETH (WASM) | EOS | NEO || WASM | |:--------------------:|:---:|:---:|:---:|:---:|:---:|:---:|:---:| | **Explorer** | :heavy_check_mark: | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :o: | |**Disassembler** | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | |**Control Flow Analysis** | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | :heavy_check_mark: | |**Call Flow Analysis** | :heavy_multiplication_x: | :heavy_plus_sign: | :heavy_check_mark: | :heavy_check_mark: | :heavy_plus_sign: | | :heavy_check_mark: | |**IR conversion (SSA)** | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_plus_sign: | :heavy_plus_sign: | :heavy_multiplication_x: | | :heavy_check_mark: | |**Symbolic Execution** | :heavy_multiplication_x: | :heavy_plus_sign: | :heavy_plus_sign: | :heavy_plus_sign: | :heavy_multiplication_x: | | :heavy_plus_sign: | * PyPI package :heavy_check_mark: * Docker :heavy_check_mark: :heavy_check_mark: **DONE** / :heavy_plus_sign: **WIP** / :heavy_multiplication_x: **TODO** / :o: **N/A** ## Requirements Octopus is supported on Linux (ideally Ubuntu 16.04) and requires Python >=3.5 (ideally 3.6). Dependencies: * Graph generation: [graphviz](https://graphviz.gitlab.io/download/) * Explorer: [requests](http://docs.python-requests.org/en/master/#) * Symbolic Execution: [z3-solver](https://pypi.org/project/z3-solver/) * Wasm: [wasm](https://github.com/athre0z/wasm) ## Quick Start - Install system dependencies ``` # Install system dependencies sudo apt-get update && sudo apt-get install python-pip graphviz xdg-utils -y ``` - Install Octopus: ``` # Download Octopus git clone https://github.com/quoscient/octopus cd octopus # Install Octopus library/CLI and its dependencies python3 setup.py install ``` or ``` # but prefer the first way to install if possible pip3 install octopus ``` - Run tests ``` # Run tests for all platforms (disassembly, CFG, ...) ./run_tests.sh # Run tests that require internet access (explorer tests) ./run_explorer_tests.sh # Run tests for only one platforms # {btc, eth, eos, neo, wasm}_run_tests.sh cd octopus/tests/ ./wasm_run_tests.sh ``` #### Docker container A docker container providing the toolset is available at [docker hub](https://hub.docker.com/r/smartbugs/octopus). In a terminal, run the following commands: ``` docker pull smartbugs/octopus docker run -it smartbugs/octopus cd octopus python3 octopus_eth_evm.py -s -f examples/ETH/evm_bytecode/61EDCDf5bb737ADffE5043706e7C5bb1f1a56eEA.bytecode ``` ## Command-line tools * WebAssembly: [octopus_wasm.py](octopus_wasm.py) * Ethereum (EVM): [octopus_eth_evm.py](octopus_eth_evm.py) ## In-depth Examples using APIs <details><summary>WebAssembly</summary> <p> #### Disassembler Disassembly of a Wasm module: ```python from octopus.arch.wasm.disassembler import WasmDisassembler FILE = "examples/wasm/samples/helloworld.wasm" with open(FILE, 'rb') as f: module_bytecode = f.read() disasm = WasmDisassembler() # return list of functions instructions (list) print(disasm.disassemble_module(module_bytecode)) #[[<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904278>,<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904f60>,<octopus.arch.wasm.instruction.WasmInstruction at 0x7f85e4904ef0>]] print() # return text of functions code print(disasm.disassemble_module(module_bytecode, r_format='text')) # func 0 # i32.const 0 # call 0 # end ``` Disassembly of wasm bytecode: ```python from octopus.arch.wasm.disassembler import WasmDisassembler # bytecode in WebAssembly is the function code (i.e. function body) bytecode = b'\x02\x7fA\x18\x10\x1cA\x00\x0f\x0b' # create a WasmDisassembler object disasm = WasmDisassembler(bytecode) # disassemble bytecode into a list of WasmInstruction # attributes r_format='list' by default print(disasm.disassemble()) #[<octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904eb8>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>] print() print(disasm.disassemble(r_format='reverse')) #{0: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>, 1: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904240>, 2: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, 3: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, 4: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, 5: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>} print() print(disasm.disassemble(r_format='text')) # block -1 # i32.const 24 # call 28 # i32.const 0 # return # end ``` #### ModuleAnalyzer ```python from octopus.arch.wasm.analyzer import WasmModuleAnalyzer FILE = "examples/wasm/samples/hello_wasm_studio.wasm" with open(FILE, 'rb') as f: module_bytecode = f.read() # return list of functions instructions (list) # attributes analysis=True by default analyzer = WasmModuleAnalyzer(module_bytecode) # show analyzer attributes print(analyzer.func_prototypes) # [('putc_js', 'i32', ''), # ('__syscall0', 'i32', 'i32'), # ('__syscall3', 'i32 i32 i32 i32', 'i32'), # ('__syscall1', 'i32 i32', 'i32'), # ('__syscall5', 'i32 i32 i32 i32 i32 i32', 'i32'), # ('__syscall4', 'i32 i32 i32 i32 i32', 'i32'), # ('$func6', '', ''), # ('main', '', 'i32'), # ('writev_c', 'i32 i32 i32', 'i32'), # ('$func9', '', 'i32'), # ('$func10', 'i32', 'i32'), # ('$func11', 'i32', 'i32'), # ('$func12', 'i32', ''), # ('$func13', 'i32', 'i32'), # ('$func14', 'i32 i32 i32 i32', 'i32'), # ('$func15', 'i32 i32', 'i32'), # ('$func16', 'i32 i32', 'i32'), # ('$func17', 'i32', 'i32'), # ('$func18', 'i32', 'i32'), # ('$func19', 'i32', 'i32'), # ('$func20', 'i32 i32 i32', 'i32'), # ('$func21', 'i32 i32 i32', 'i32'), # ('$func22', 'i32 i64 i32', 'i64'), # ('$func23', 'i32 i32 i32', 'i32'), # ('$func24', 'i32', 'i32'), # ('$func25', 'i32 i32 i32 i32', '')] print() print(analyzer.contains_emscripten_syscalls()) #[('__syscall0', 'restart_syscall'), # ('__syscall3', 'read'), # ('__syscall1', 'exit'), # ('__syscall5', 'open'), # ('__syscall4', 'write')] ``` #### Control Flow Analysis ```python from octopus.arch.wasm.cfg import WasmCFG # complete wasm module file_name = "examples/wasm/samples/fib.wasm" # read file with open(file_name, 'rb') as f: raw = f.read() # create the cfg cfg = WasmCFG(raw) # visualize CFGGraph # generate graph.dot and graph.pdf file cfg.visualize() ``` <p align="center"> <img src="/images/wasm-cfg-fib.png" height="400px"/> </p> #### Functions' instructions analytics ```python from octopus.arch.wasm.cfg import WasmCFG # complete wasm module file_name = "examples/wasm/samples/hello_wasm_studio.wasm" # read file with open(file_name, 'rb') as f: raw = f.read() # create the cfg cfg = WasmCFG(raw) # visualization cfg.visualize_instrs_per_funcs() ``` <p align="center"> <img src="/images/wasm-instr-func-analytics.png" height="400px"/> </p> #### Call Flow Analysis ```python from octopus.arch.wasm.cfg import WasmCFG # fibonacci wasm module file_name = "examples/wasm/samples/hello_wasm_studio.wasm" # read file with open(file_name, 'rb') as f: raw = f.read() # create the cfg cfg = WasmCFG(raw) # visualize Call Flow Graph # generate call_graph.dot and call_graph.pdf file # # color similar to https://webassembly.studio/ # imported func == turquoise / exported func == grey # edge label = number of different calls to the function cfg.visualize_call_flow() ``` <p align="center"> <img src="/images/wasm-callflow-hello-studio.png" height="400px"/> </p> Legend: <p align="center"> <img src="/images/legend_callgraph.png" height="400px"/> </p> #### IR conversion (SSA) ```python from octopus.arch.wasm.emulator import WasmSSAEmulatorEngine # complete wasm module file_name = "examples/wasm/samples/fib.wasm" # read file with open(file_name, 'rb') as f: raw = f.read() # run the emulator for SSA emul = WasmSSAEmulatorEngine(raw) emul.emulate_one_function('fib') # or emul.emulate_functions(['fib']) # or emul.emulate_functions() # emulate all the function # visualization of the cfg with SSA emul.cfg.visualize(ssa=True) ``` <p align="center"> <img src="/images/ssa-cfg-fib-wasm.png" height="400px"/> </p> </p> </details> <details><summary>Ethereum (ETH) - EVM</summary> <p> #### Explorer ```python from octopus.platforms.ETH.explorer import EthereumInfuraExplorer from octopus.platforms.ETH.explorer import INFURA_ROPSTEN KEY_API = "bHuaQhX91nkQBac8Wtgj" # connection to ROPSTEN network (testnet) explorer = EthereumInfuraExplorer(KEY_API, network=INFURA_ROPSTEN) # connection to MAINNET network (mainnet) # explorer = EthereumInfuraExplorer(KEY_API) # Test ROPSTEN network current block number block_number = explorer.eth_blockNumber() print(block_number) # 3675552 # Retrieve code of this smart contract addr = "0x3c6B10a5239B1a8A27398583F49771485382818F" code = explorer.eth_getCode(addr) print(code) # 0x6060604052600436106049576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff16806360fe47b114604e5780636d4ce63c14606e575b600080fd5b3415605857600080fd5b606c60048080359060200190919050506094565b005b3415607857600080fd5b607e609e565b6040518082815260200191505060405180910390f35b8060008190555050565b600080549050905600a165627a7a72305820e1f98c821c12eea52047d7324b034ddccc41eaa7365d369b34580ab73c71a8940029 ``` #### Disassembler ```python from octopus.platforms.ETH.disassembler import EthereumDisassembler # smart contract bytecode bytecode_hex = "60606040526000357c0100000000000000000000000000000000000000000000000000000000900480635fd8c7101461004f578063c0e317fb1461005e578063f8b2cb4f1461006d5761004d565b005b61005c6004805050610099565b005b61006b600480505061013e565b005b610083600480803590602001909190505061017d565b6040518082815260200191505060405180910390f35b3373ffffffffffffffffffffffffffffffffffffffff16611111600060005060003373ffffffffffffffffffffffffffffffffffffffff16815260200190815260200160002060005054604051809050600060405180830381858888f19350505050151561010657610002565b6000600060005060003373ffffffffffffffffffffffffffffffffffffffff168152602001908152602001600020600050819055505b565b34600060005060003373ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000206000828282505401925050819055505b565b6000600060005060008373ffffffffffffffffffffffffffffffffffffffff1681526020019081526020016000206000505490506101b6565b91905056" disasm = EthereumDisassembler() disasm.disassemble(bytecode_hex) # disassemble bytecode into a list of EthereumInstruction # attributes r_format='list' by default print(disasm.disassemble(bytecode_hex)) #[<octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4add5c0>, <octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4ad8588>, <octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4ad8c50>] print() print(disasm.disassemble(bytecode_hex, r_format='reverse')) # {0: <octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4ad8160>, ..., 229: <octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4ad8630>, 230: <octopus.platforms.ETH.instruction.EthereumInstruction object at 0x7f85d4ad87b8>} print() print(disasm.disassemble(bytecode_hex,r_format='text')) # PUSH1 0x60 # PUSH1 0x40 # MSTORE # PUSH1 0x0 # CALLDATALOAD # PUSH29 0x100000000000000000000000000000000000000000000000000000000 # SWAP1 # DIV # DUP1 # PUSH4 0x5fd8c710 # EQ # PUSH2 0x4f # JUMPI # ... # SWAP2 # SWAP1 # POP # JUMP ``` #### Control Flow Analysis ```python from octopus.analysis.graph import CFGGraph from octopus.platforms.ETH.cfg import EthereumCFG # ethernaut0 bytecode file_name = "examples/ETH/evm_bytecode/Zeppelin_Hello_ethernaut0.bytecode" # read file with open(file_name) as f: bytecode_hex = f.read() # create the CFG cfg = EthereumCFG(bytecode_hex) # generic visualization api # generate graph.dot and graph.pdf file graph = CFGGraph(cfg) graph.view() # or directly using the cfg binding # cfg.visualize() # and you can get a simplify cfg representation using # cfg.visualize(simplify=True) or graph.view(simplify=True) ``` <p align="center"> <img src="/images/eth-cfg-evm.png"/> </p> #### IR conversion (SSA) ```python # The conversion to SSA is already done by the SSAEmulator # when the CFG is reconstruct # by default you have just to visualize it from octopus.platforms.ETH.cfg import EthereumCFG # ethernaut0 bytecode file_name = "examples/ETH/evm_bytecode/Zeppelin_Hello_ethernaut0.bytecode" # read file with open(file_name) as f: bytecode_hex = f.read() # create the CFG cfg = EthereumCFG(bytecode_hex) # SSA visualization cfg.visualize(ssa=True) ``` <p align="center"> <img src="/images/eth-cfg-evm-ssa.png"/> </p> </p> </details> <details><summary>Ethereum (WASM)</summary> <p> #### Explorer ```python from octopus.platforms.ETH.explorer import EthereumInfuraExplorer from octopus.platforms.ETH.explorer import INFURA_KOVAN # connection to ROPSTEN network (testnet) explorer = EthereumInfuraExplorer("bHuaQhX91nkQBac8Wtgj", network=INFURA_KOVAN) # connection to MAINNET network (mainnet) # explorer = EthereumInfuraExplorer("bHuaQhX91nkQBac8Wtgj") # test infura access block_number = explorer.eth_blockNumber() print('blockNumber = %d' % block_number) # retrieve code of this smart contract addr = "0x1120e596b173d953ba52ce262f73ce3734b0e40e" code = explorer.eth_getCode(addr) print() print(code) # blockNumber = 8803487 # # 0x0061736d0100000001090260000060027f7f00021a0203656e7603726574000103656e76066d656d6f7279020102100303020000040501700101010501000601000708010463616c6c00010a120205001002000b0a00418008410b1000000b0b1201004180080b0b48656c6c6f20776f726c64000b076c696e6b696e6703010b0066046e616d65015f060003726574010570616e6963020463616c6c032f5f5a4e3134707761736d5f657468657265756d3365787433726574313768363034643830393864313638366338304504066465706c6f790511727573745f626567696e5f756e77696e64 ``` #### Disassembler Disassembly of a Wasm module: ```python from octopus.platforms.ETH.disassembler import EthereumDisassembler FILE = "examples/ETH/wasm/helloworld_kovan.bytecode" with open(FILE, 'r') as f: module_bytecode = f.read() disasm = EthereumDisassembler(arch='wasm') # return list of functions instructions (list) print(disasm.disassemble_module(module_bytecode)) #[[<octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa898>], [<octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa7b8>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa780>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa748>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa6d8>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7efc0ceaa710>]] print() # return text of functions code print(disasm.disassemble_module(module_bytecode, r_format='text')) # func 0 # end # # func 1 # call 1 # i32.const 1036 # i32.const 232 # call 0 # end ``` Disassembly of wasm bytecode: ```python from octopus.platforms.ETH.disassembler import EthereumDisassembler # bytecode in WebAssembly is the function code (i.e. function body) bytecode = b'\x02\x7fA\x18\x10\x1cA\x00\x0f\x0b' # create a WasmDisassembler object disasm = EthereumDisassembler(bytecode, arch='wasm') # disassemble bytecode into a list of WasmInstruction # attributes r_format='list' by default print(disasm.disassemble()) #[<octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904eb8>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>] print() print(disasm.disassemble(r_format='reverse')) #{0: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4901048>, 1: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904240>, 2: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904f60>, 3: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904ef0>, 4: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904278>, 5: <octopus.arch.wasm.instruction.WasmInstruction object at 0x7f85e4904390>} print() print(disasm.disassemble(r_format='text')) # block -1 # i32.const 24 # call 28 # i32.const 0 # return # end ``` #### ModuleAnalyzer ```python from octopus.arch.wasm.analyzer import WasmModuleAnalyzer FILE = "examples/ETH/wasm/helloworld_kovan.bytecode" with open(FILE, 'r') as f: module_bytecode = f.read() # return list of functions instructions (list) # attributes analysis=True by default analyzer = WasmModuleAnalyzer(module_bytecode) # show analyzer attributes print(analyzer.func_prototypes) # [('ret', 'i32 i32', '', 'import'), ('$func1', '', '', 'local'), ('call', '', '', 'export')] print() print(analyzer.exports) # [{'field_str': 'call', 'kind': 0, 'index': 2}] print() print(analyzer.imports_func) # [('env', 'ret', 1)] print() print(analyzer.datas) # [{'data': b'Hello world', 'index': 0, 'offset': None, 'size': 11}, # {'data': b'\x00asm\x01\x00\x00\x00\x01\t\x02`\x00\x00`\x02\x7f\x7f\x00\x02\x1a\x02\x03env\x03ret\x00\x01\x03env\x06memory\x02\x01\x02\x10\x03\x03\x02\x00\x00\x04\x05\x01p\x01\x01\x01\x05\x01\x00\x06\x01\x00\x07\x08\x01\x04call\x00\x01\n\x12\x02\x05\x00\x10\x02\x00\x0b\n\x00A\x80\x08A\x0b\x10\x00\x00\x0b\x0b\x12\x01\x00A\x80\x08\x0b\x0bHello world\x00\x0b\x07linking\x03\x01\x0b\x00f\x04name\x01_\x06\x00\x03ret\x01\x05panic\x02\x04call\x03/_ZN14pwasm_ethereum3ext3ret17h604d8098d1686c80E\x04\x06deploy\x05\x11rust_begin_unwind', # 'index': 0, # 'offset': None, # 'size': 232}] ``` #### Control Flow Analysis ```python from octopus.platforms.ETH.cfg import EthereumCFG # HelloWorld on Kovan Parity Network file_name = "examples/ETH/wasm/helloworld_kovan.bytecode" # read file with open(file_name) as f: bytecode_hex = f.read() # create the CFG cfg = EthereumCFG(bytecode_hex, arch='wasm') cfg.visualize() ``` <p align="center"> <img src="/images/eth-wasm-cfg-hello-parity.png" height="400px"/> </p> #### Functions' instructions analytics ```python from octopus.platforms.ETH.cfg import EthereumCFG # HelloWorld on Kovan Parity Network file_name = "examples/ETH/wasm/helloworld_kovan.bytecode" # read file with open(file_name) as f: bytecode_hex = f.read() # create the CFG cfg = EthereumCFG(bytecode_hex, arch='wasm') # visualization cfg.visualize_instrs_per_funcs() ``` <p align="center"> <img src="/images/eth-wasm-func-analytics.png" height="400px"/> </p> #### Call Flow Analysis ```python from octopus.platforms.ETH.cfg import EthereumCFG # HelloWorld on Kovan Parity Network file_name = "examples/ETH/wasm/helloworld_kovan.bytecode" # read file with open(file_name) as f: bytecode_hex = f.read() # create the CFG cfg = EthereumCFG(bytecode_hex, arch='wasm') # visualization cfg.visualize_call_flow() ``` <p align="center"> <img src="/images/eth-wasm-callflow-hello-parity.png" height="400px"/> </p> Legend: <p align="center"> <img src="/images/legend_callgraph.png" height="400px"/> </p> #### IR conversion (SSA) ```python # TODO ``` </p> </details> <details><summary>NEO</summary> <p> #### Explorer ```python from octopus.platforms.NEO.explorer import NeoExplorerRPC # get list nodes here: http://monitor.cityofzion.io/ explorer = NeoExplorerRPC(host='seed2.neo.org') # get current number of block on the blockchain print(explorer.getblockcount()) # 2534868 # get information on a contract # lock smart contract address: d3cce84d0800172d09c88ccad61130611bd047a4 contract = explorer.getcontractstate("d3cce84d0800172d09c88ccad61130611bd047a4") print(contract) # {'author': 'Erik Zhang', # 'code_version': '2.0', # 'description': 'Lock 2.0', # 'email': 'erik@neo.org', # 'hash': '0xd3cce84d0800172d09c88ccad61130611bd047a4', # 'name': 'Lock', # 'parameters': ['Integer', 'PublicKey', 'Signature'], # 'properties': {'dynamic_invoke': False, 'storage': False}, # 'returntype': 'Boolean', # 'script': '56c56b6c766b00527ac46c766b51527ac46c766b52527ac4616168184e656f2e426c6f636b636861696e2e4765744865696768746168184e656f2e426c6f636b636861696e2e4765744865616465726c766b53527ac46c766b00c36c766b53c36168174e656f2e4865616465722e47657454696d657374616d70a06c766b54527ac46c766b54c3640e00006c766b55527ac4621a006c766b51c36c766b52c3617cac6c766b55527ac46203006c766b55c3616c7566', # 'version': 0} # smart contract code in contract['script'] print(contract['script']) ``` #### Disassembler ```python from octopus.platforms.NEO.disassembler import NeoDisassembler # lock contract file_name = "examples/NEO/samples/Lock.bytecode" # read file with open(file_name) as f: bytecode = f.read() disasm = NeoDisassembler() print(disasm.disassemble(bytecode, r_format='text')) # PUSH6 # NEWARRAY # TOALTSTACK # FROMALTSTACK # DUP # TOALTSTACK # PUSH0 # PUSH2 # ROLL # SETITEM # FROMALTSTACK # .... # PICKITEM # NOP # FROMALTSTACK # DROP # RET ``` #### Control Flow Analysis ```python from octopus.analysis.graph import CFGGraph from octopus.platforms.NEO.cfg import NeoCFG # lock contract file_name = "examples/NEO/samples/Lock.bytecode" # read file with open(file_name) as f: raw = f.read() # create neo cfg - automatic static analysis cfg = NeoCFG(raw) # graph visualization graph = CFGGraph(cfg, filename="Lock_cfg") graph.view_functions() ``` <p align="center"> <img src="/images/neo-cfg.png"/> </p> </p> </details> <details><summary>EOS</summary> <p> #### Explorer ```python from octopus.platforms.EOS.explorer import EosExplorer host = "api.cypherglass.com" # by defaul the port is 8888 explo = EosExplorer(host=host) # get info about the node explo.get_info()

NEARBuilders_events

.github workflows release-mainnet.yml README.md apps events bos.config.json package.json

# events ## Getting Started To run locally, make sure you have [bos-workspace](https://github.com/nearbuilders/bos-workspace) installed. Then, run the command: ```bash bw dev ``` This will serve the widgets from `http://127.0.0.1:4040/`.

FarmGameVillas_farmme-hero

.github dependabot.yml workflows tests.yml .gitpod.yml Cargo.toml README-Windows.md README.md build.bat build.sh flags.sh nft Cargo.toml src lib.rs res README.md test-approval-receiver Cargo.toml src lib.rs test-token-receiver Cargo.toml src lib.rs tests sim main.rs test_approval.rs test_core.rs test_enumeration.rs utils.rs

# Folder that contains wasm files Non-fungible Token (NFT) =================== [](https://gitpod.io/#https://github.com/near-examples/NFT) This repository includes an example implementation of a [non-fungible token] contract which uses [near-contract-standards] and [simulation] tests. [non-fungible token]: https://nomicon.io/Standards/NonFungibleToken/README.html [near-contract-standards]: https://github.com/near/near-sdk-rs/tree/master/near-contract-standards [simulation]: https://github.com/near/near-sdk-rs/tree/master/near-sdk-sim Prerequisites ============= If you're using Gitpod, you can skip this step. * Make sure Rust is installed per the prerequisites in [`near-sdk-rs`](https://github.com/near/near-sdk-rs). * Make sure [near-cli](https://github.com/near/near-cli) is installed. Explore this contract ===================== The source for this contract is in `nft/src/lib.rs`. It provides methods to manage access to tokens, transfer tokens, check access, and get token owner. Note, some further exploration inside the rust macros is needed to see how the `NonFungibleToken` contract is implemented. Building this contract ====================== Run the following, and we'll build our rust project up via cargo. This will generate our WASM binaries into our `res/` directory. This is the smart contract we'll be deploying onto the NEAR blockchain later. ```bash ./build.sh ``` Testing this contract ===================== We have some tests that you can run. For example, the following will run our simple tests to verify that our contract code is working. ```bash cargo test -- --nocapture ``` The more complex simulation tests aren't run with this command, but we can find them in `tests/sim`. Using this contract =================== ### Quickest deploy You can build and deploy this smart contract to a development account. [Dev Accounts](https://docs.near.org/docs/concepts/account#dev-accounts) are auto-generated accounts to assist in developing and testing smart contracts. Please see the [Standard deploy](#standard-deploy) section for creating a more personalized account to deploy to. ```bash near dev-deploy --wasmFile res/non_fungible_token.wasm ``` Behind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like: >Done deploying to dev-1234567890123 In this instance, the account is `dev-1234567890123`. A file has been created containing a key pair to the account, located at `neardev/dev-account`. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands. Run this command to set the environment variable: ```bash source neardev/dev-account.env ``` You can tell if the environment variable is set correctly if your command line prints the account name after this command: ```bash echo $CONTRACT_NAME ``` The next command will initialize the contract using the `new` method: ```bash near call $CONTRACT_NAME new_default_meta '{"owner_id": "'$CONTRACT_NAME'"}' --accountId $CONTRACT_NAME ``` To view the NFT metadata: ```bash near view $CONTRACT_NAME nft_metadata ``` ### Standard deploy This smart contract will get deployed to your NEAR account. For this example, please create a new NEAR account. Because NEAR allows the ability to upgrade contracts on the same account, initialization functions must be cleared. If you'd like to run this example on a NEAR account that has had prior contracts deployed, please use the `near-cli` command `near delete`, and then recreate it in Wallet. To create (or recreate) an account, please follow the directions in [Test Wallet](https://wallet.testnet.near.org) or ([NEAR Wallet](https://wallet.near.org/) if we're using `mainnet`). In the project root, log in to your newly created account with `near-cli` by following the instructions after this command. near login To make this tutorial easier to copy/paste, we're going to set an environment variable for our account id. In the below command, replace `MY_ACCOUNT_NAME` with the account name we just logged in with, including the `.testnet` (or `.near` for `mainnet`): ID=MY_ACCOUNT_NAME We can tell if the environment variable is set correctly if our command line prints the account name after this command: echo $ID Now we can deploy the compiled contract in this example to your account: near deploy --wasmFile res/non_fungible_token.wasm --accountId $ID NFT contract should be initialized before usage. More info about the metadata at [nomicon.io](https://nomicon.io/Standards/NonFungibleToken/Metadata.html). But for now, we'll initialize with the default metadata. near call $ID new_default_meta '{"owner_id": "'$ID'"}' --accountId $ID We'll be able to view our metadata right after: near view $ID nft_metadata Then, let's mint our first token. This will create a NFT based on Olympus Mons where only one copy exists: near call $ID nft_mint '{"token_id": "0", "receiver_id": "'$ID'", "token_metadata": { "title": "Olympus Mons", "description": "Tallest mountain in charted solar system", "media": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/00/Olympus_Mons_alt.jpg/1024px-Olympus_Mons_alt.jpg", "copies": 1}}' --accountId $ID --deposit 0.1 Transferring our NFT ==================== Let's set up an account to transfer our freshly minted token to. This account will be a sub-account of the NEAR account we logged in with originally via `near login`. near create-account alice.$ID --masterAccount $ID --initialBalance 10 Checking Alice's account for tokens: near view $ID nft_tokens_for_owner '{"account_id": "'alice.$ID'"}' Then we'll transfer over the NFT into Alice's account. Exactly 1 yoctoNEAR of deposit should be attached: near call $ID nft_transfer '{"token_id": "0", "receiver_id": "alice.'$ID'", "memo": "transfer ownership"}' --accountId $ID --depositYocto 1 Checking Alice's account again shows us that she has the Olympus Mons token. Notes ===== * The maximum balance value is limited by U128 (2**128 - 1). * JSON calls should pass U128 as a base-10 string. E.g. "100". * This does not include escrow functionality, as ft_transfer_call provides a superior approach. An escrow system can, of course, be added as a separate contract or additional functionality within this contract. AssemblyScript ============== Currently, AssemblyScript is not supported for this example. An old version can be found in the [NEP4 example](https://github.com/near-examples/NFT/releases/tag/nep4-example), but this is not recommended as it is out of date and does not follow the standards the NEAR SDK has set currently.

mirag0505_homework-near

.idea modules.xml vcs.xml README.md index.html package.json public vite.svg src App.css assets react.svg index.css near-wallet.js vite-env.d.ts tsconfig.json tsconfig.node.json vite.config.ts

# homework-near

NEAR-Edu_postgrest-on-render

README.md

# PostgREST & Swagger on render.com This repo is used to deploy [PostgREST](https://postgrest.org/en/stable/install.html#docker) 2 branches: - `main` is configured to launch a MainNet PostgREST instance - `testnet` is configured to launch a TestNet PostgREST instance You can use the button below to deploy to your render.com account [](https://render.com/deploy?repo=https://github.com/NEAR-Edu/postgrest-on-render)

evgenykuzyakov_artcoin

README.md neardev dev-account.env package-lock.json package.json public index.html manifest.json robots.txt src App.css App.js components ARTCard.js Alerts.js Dash.js Docs.js FAQ.js Header.js Markets.js TradeCard.js Wallet.js tokenIcon.js config.js index.css index.js setupTests.js

# Getting Started with Create React App This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts In the project directory, you can run: ### `yarn start` Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.\ You will also see any lint errors in the console. ### `yarn test` Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `yarn build` Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. ### `yarn eject` **Note: this is a one-way operation. Once you `eject`, you can’t go back!** If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. ## Learn More You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). To learn React, check out the [React documentation](https://reactjs.org/). ### Code Splitting This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) ### Analyzing the Bundle Size This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) ### Making a Progressive Web App This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) ### Advanced Configuration This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) ### Deployment This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) ### `yarn build` fails to minify This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) #### deploy command near deploy --accountId artcoin.testnet --wasmFile ./contract/art.wasm --initFunction new --initArgs '{"owner_id": "artcoin.testnet", "total_supply": "1000000000000000000000000000000000", "ausd_token": "ausd.artcoin.testnet"}'

Peersyst_lumos

.eslintrc.js .github workflows publish.yml DEVELOPMENT.md README.md babel.config.js commitlint.config.ts documentations migration-from-bigint-to-bi.md docusaurus docs intro.md website README.md babel.config.js docs intro.md docusaurus.config.js i18n zh code.json docusaurus-plugin-content-blog options.json docusaurus-plugin-content-docs current.json current intro.md run-lumos-on-web.md docusaurus-theme-classic footer.json navbar.json package.json sidebars.js src components HomepageFeatures.module.css css custom.css pages index.module.css markdown-page.md tsconfig.json examples README.md cardano-lock-namiwallet README.md generated cardano.d.ts cardano.js index.html lib.ts package.json tsconfig.json ckb-indexer-collector.ts config-manager.ts omni-lock-metamask README.md generated omni.d.ts omni.js index.html lib.ts package.json tsconfig.json pw-lock-metamask README.md index.html lib.ts package.json tsconfig.json secp256k1-multisig-transfer index.ts tsconfig.json secp256k1-transfer index.html lib.ts package.json tsconfig.json | lerna.json package.json packages base README.md index.d.ts lib api.d.ts api.js core.d.ts core.js denormalizers.d.ts denormalizers.js helpers.d.ts helpers.js index.js indexer.d.ts indexer.js logger.d.ts logger.js primitive.d.ts primitive.js since.d.ts since.js utils.d.ts utils.js values.d.ts values.js package.json tests denormalizers.js is_cell_match_query_options.js since.test.js utils-bigint.test.js utils.test.js bi README.md package.json src index.ts tests index.test.ts tsconfig.json ckb-indexer README.md mirgation.md package.json src collector.ts index.ts indexer.ts rpc.ts services.ts transaction_collector.ts type.ts tests collector.test.ts indexer.test.ts rpc.test.ts transaction_collector.test.ts transaction_collector_special_test_case.ts tsconfig.json common-scripts README.md examples pw_lock config.json lock.ts package.json src anyone_can_pay.ts common.ts dao.ts deploy.ts from_info.ts helper.ts index.ts locktime_pool.ts p2pkh.ts secp256k1_blake160.ts secp256k1_blake160_multisig.ts sudt.ts tests account_info.ts anyone_can_pay.test.ts cell_provider.ts common-bigint.test.ts common.test.ts dao-bigint.test.ts dao.test.ts deploy.test.ts dev_config.ts from_info.test.ts helper.ts inputs.ts locktime_pool-bigint.test.ts locktime_pool.test.ts p2pkh.json p2pkh.test.ts secp256k1_blake160-bigint.test.ts secp256k1_blake160.test.ts secp256k1_blake160_inputs.ts secp256k1_blake160_multisig-bigint.test.ts secp256k1_blake160_multisig.test.ts sudt.test.ts tsconfig.json config-manager README.md package.json src helpers.ts index.ts manager.ts predefined.ts types.ts tests helper.test.ts validator.js tsconfig.json experiment package.json src index.ts tests index.test.ts tsconfig.json hd-cache README.md package.json src index.ts tests cache.test.ts fixtures ckb_cli_keystore.json tsconfig.json hd README.md package.json src extended_key.ts helper.ts index.ts key.ts keychain.ts keystore.ts mnemonic index.ts word_list.ts xpub_store.ts tests extended_key.test.ts fixtures ckb_cli_keystore.json xpub.json key.test.ts keychain.test.ts keystore.test.ts mnemonic fixtures.json index.test.ts xpub_store.test.ts tsconfig.json helpers README.md package.json src index.ts tests addresses.ts convert_transaction_skeleton.test.ts fixtures tx_skeleton.json generate_address.test.ts minimal_cell_capacity-bigint.test.ts minimal_cell_capacity.test.ts parse_address.test.ts tsconfig.json lumos README.md package.json src index.ts tsconfig.json webpack.config.js rpc README.md package.json src index.ts tsconfig.json testkit README.md example mock-ckb-node.ts package.json src index.ts mock-ckb-jsonrpc.ts mock-data.ts tsconfig.json toolkit README.md images toolkit.svg index.d.ts package.json src cell_collectors index.js rpc_collector.js index.js normalizers.js reader.js rpc.js transaction_dumper.js transformers.js validators.js testfiles blockchain.umd.js tests reader.js serializers.js transformers.js validators.js transaction-manager README.md index.d.ts lib index.js package.json tests filter_cells.test.js index.test.js scripts symlink_node_modules.js style.md tsconfig.json typedoc.js

# lumos  [](https://codecov.io/gh/nervosnetwork/lumos)   > Lumos is still under active development and considered to be a work in progress. Lumos is a full featured JavaScript/TypeScript based dapp framework for Nervos CKB. It aims to simplify dapp development on Nervos CKB. The [name](https://harrypotter.fandom.com/wiki/Lumos_Maxima) explains what the project is about: the wonderland of CKB, though vast and fertile, still remains dark in most of the parts, lumos tries to shed light upon the land, guiding people into this beautiful new world. As of now, lumos contains the following components: - [ckb-indexer](./packages/ckb-indexer): an cell/tx indexer base on [ckb-indexer](https://github.com/nervosnetwork/ckb-indexer). - [BI](./packages/bi): a big number library for lumos. - [toolkit](./packages/toolkit): JavaScript toolkit for Nervos CKB. It contains a series of independent tools that can aid develoment of CKB dapps. This is different from a normal CKB SDK, since it tries to minimize the work done in an SDK, while providing more utlities that could be handy. - [lumos](./packages/lumos): A root package to integrate of common functions from the Lumos sub-package. - [base](./packages/base): a base package containing common types and utilities that are used by most packages. If there is a CKB specific task you need to perform, you might want to look here first. Chances are they are already provided. - [helpers](./packages/helpers): a helper package containing more utilities. The difference between `helpers` and `base`, is that `base` contains pure stateless functions, while `helpers` works in a more intrinsic way: it requires `config-manager` mentioned below to be setup. - [common-scripts](./packages/common-scripts): integrations for known scripts on CKB. While we try our best to provide integrations for popular CKB scripts, people might be working on innovations everyday. As a result, we are also designing a set of APIs, so developers can freely integrate their own scripts into lumos for everyone to use. One integrated, `common-scripts` should be able to leverage those new scripts as well. - [config-manager](./packages/config-manager): a manager for dealing with differences between different chains, such as mainnet, testnet, or numerous dev chains. We abstract each chain into individual config file. Once loaded, config manager will be able to handle the chain specific logic, so you don't have to deal with this in your own code. - [transaction-manager](./packages/transaction-manager): a transaction manager for CKB. One problem with UTXO based blockchains, is that a certain amount of gap period exists between a transaction is accepted by a blockchain, and when it is actually committed on chain. During this gap, new cells created by the pending transaction will not be available. Transaction manager package takes care of this. It wraps an indexer instance, and makes sure cells created in pending transactions, are also exposed and available for assembling new transactions. This means you are no longer bounded to one transaction at a time, you can freely send series of transactions as you wish. - [hd](./packages/hd): an HD wallet manager for CKB. It support mnemonic and keystore, compatible with `Neuron` and `ckb-cli`, you can load keystore from `Neuron` or `ckb-cli` directly and import mnemonic generated by `Neuron`. - [hd-cache](./packages/hd-cache): an HD cache manager for CKB. It build a memory cache for derived addresses and live cells of these addresses. - [rpc](./packages/rpc): RPC module for CKB RPC. Provide type definations for CKB RPC interface. ## Examples we have provided some use cases for Lumos, such as interactions with MetaMask, transfers CKB, address conversions, etc. which you can find in [examples](./examples) ## Building ### Requirements - [Node.js](https://nodejs.org) - [Yarn](https://yarnpkg.com/) - [node-gyp](https://github.com/nodejs/node-gyp) ```bash sudo apt-get update sudo apt install nodejs npm install --global yarn sudo apt install build-essential ``` ### Build ```bash yarn run build ``` ### Test (ava) ```bash yarn run test ``` ### Test Coverage (c8) ```bash yarn run test-coverage ``` ### Format & Lint ```bash yarn run lint ``` ### Clean ```bash yarn run clean ``` ckb-js-toolkit ============== JavaScript toolkit for Nervos CKB. It contains a series of independent tools that can aid develoment of CKB dapps. This is different from a normal CKB SDK, since it tries to minimize the work done in an SDK, while providing more utlities that could be handy. # Design Goals The toolkit here is built with specific design goals, if some of the design feels quirky to you, you might want to revisit this section to see if there is some tradeoff involved. ## Version Stability One design goal here is the stability of the toolkit, meaning the toolkit version you use can stay unchanged unless one of the following conditions is met: * A security vulnerability occurs * A fork happens in CKB ## Code Compatibility In the meantime, we also want to ensure code compatibility: we might upgrade the toolkit from time to time with new features. But when you are upgrading the toolkit version, you shouldn't expect any code breaks. Sometimes this might be infeasible, such as when security bugs or forks happen, but for the vast majority of the changes, we do want to ensure code compatibility at all costs. And before you ask, personally I don't trust in [Semantic Versioning](https://semver.org/). I do want to ensure code compatibility with all my efforts regardless of the specific part changed in the version number. ## Runtime type checking This might be a controversial one: with the whole JavaScript world moving into static typed languages such as TypeScript, ReasonML, etc. I'm building the toolkit here with plain JavaScript doing runtime type checking. This is because none of existing static typed languages in the JavaScript world provide decent type checking stories when you are calling the code from JavaScript. I've seen too many times that a piece of code runs `JSON.parse` on some user input data, then cast the resulting object directly to a TypeScript object, ignoring all the interface checks. If all you use in TypeScript in your project, that won't be a problem, but for a CKB Toolkit built for JavaScript, not TypeScript, nor ReasonML. I want to consider the case that some people would want to use JavaScript directly to call the code in the toolkit. That's why I'm opting for pure JavaScript in this project with runtime checking code. Speed is not much of a concern here, security is a huge concern. In the future we might certainly provide TypeScript typing files(and maybe also ReasonML definition files), but that is just a different metric. Runtime type checking is still a critical aspect in this project. # Table Of Contents * [RPC](#rpc) * [Reader](#reader) * [Utility Functions](#utility-functions) + [Validators](#validators) + [Transformers](#transformers) + [Normalizers](#normalizers) * [Cell Collectors](#cell-collectors) # RPC RPC class provides a way to make RPC calls directly to CKB. It works by utilizing [Proxy object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) so the toolkit can cope with new RPCs naturally in CKB. This is an example of `Code Compatibility` design goal. ``` node --experimental-repl-await Welcome to Node.js v13.9.0. Type ".help" for more information. > const toolkit = require("ckb-js-toolkit") > const rpc = new toolkit.RPC("http://127.0.0.1:9115/rpc") > await rpc.get_blockchain_info() { alerts: [], chain: 'ckb', difficulty: '0x5bb23548f6795', epoch: '0x708047900028b', is_initial_block_download: true, median_time: '0x170aee25ea5' } > await rpc.get_tip_header() { compact_target: '0x1a2cab56', dao: '0x1a7930d4812eeb308acafdfe3cf1230088a770976aef78000032f12fbd5f0107', epoch: '0x708047900028b', hash: '0x1d0c693d8a78c9e2294ac7304934c635d7b65274fcdf46d5ce3d13ed66768cfd', nonce: '0xe2b8ce400000000000000194cf350200', number: '0xfcaf2', parent_hash: '0x9cf27f050122efb35c362d105d980062d8ea29a8e0f86ec6a4ea06178a5a0381', proposals_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', timestamp: '0x170aee486ee', transactions_root: '0x16c74b3272430f1a89bb2fca39a571bf7a1bffecb314de528b6cbe9ba0f5d280', uncles_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', version: '0x0' } > await rpc.get_header_by_number("0x12") { compact_target: '0x1a08a97e', dao: '0x18a6312eb520a12e8e552ee0f286230026c8799e8500000000bc29f1c9fefe06', epoch: '0x6cf0012000000', hash: '0xbc00f447149004a38a8f7347dcd0a2050a2f10f4b926325d797c0f3e0d10f99b', nonce: '0x93317ca10000055400000000ba7e0100', number: '0x12', parent_hash: '0x4a191e12132587e852ddc30c73008426da6322a7def06ee153682afdceab16e7', proposals_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', timestamp: '0x16e71002eff', transactions_root: '0xcc05a6b1fc20464d4f07a40611f2cab00618ff66cc271ccee9a9fe5b4ea96a45', uncles_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', version: '0x0' } ``` Please refer to [CKB's RPC documentation](https://github.com/nervosnetwork/ckb/tree/develop/rpc) for more details on different RPCs. All values accepted by the RPC module has to be JSON ready values(such as hex strings or objects) following CKB's JSONRPC formatting rules. See [Validators](#validators) and [Transformers](#transformers) sections below on how the toolkit can aid the conversion work. # Reader Reader class serves a unique purpose: depending on sources of data, we might get values in different formats: * Hex string might be provided in CKB RPC responses * ArrayBuffer might be provided by CKB syscalls * Raw string might also be used for coding convenience One big question, is how we can manage all those different data formats? How can we ensure we can convert them to the correct hex format beforing sending them to CKB's RPC? Reader class serves this purpose: ``` node --experimental-repl-await Welcome to Node.js v13.9.0. Type ".help" for more information. > const toolkit = require("ckb-js-toolkit"); undefined > const { Reader } = toolkit; undefined > const reader1 = new Reader("0x31323334") undefined > const arraybuffer = new ArrayBuffer(4) undefined > const view = new DataView(arraybuffer) undefined > view.setUint8(0, 0x31) undefined > view.setUint8(1, 0x32) undefined > view.setUint8(2, 0x33) undefined > view.setUint8(3, 0x34) undefined > const reader2 = new Reader(arraybuffer) undefined > const reader3 = Reader.fromRawString("1234") undefined > reader1.serializeJson() '0x31323334' > reader2.serializeJson() '0x31323334' > reader3.serializeJson() '0x31323334' ``` Here we are setting `reader1`, `reader2` and `reader3` using differnet methods, the result here stays the same no matter what format the source data uses. Later in the [Transformers](#transformers) section we will see how we can combine Reader with transformers for a unified coding experience. # Utility Functions The toolkit doesn't provide pre-defined models on common constructs. Instead, it is defined to let you have your own model, and work with it. For example, typical Web project probably has models defined from an ORM over a SQL database. I don't want you to have both a cell data structure defined in your ORM, and in the toolkit. We wanta to take a different path here: you only need to define the data structure once, whether it's defined from an ORM, or defined as an ECMAScript class with methods customed to your project. All you need to do, is to follow rules defined by transformers, you will be able to use the utility functions defined here. The diagram below illustrates the relations between the utility functions:  `Normalizers`, `Transformers` and `Validators` are included in this repository. `Denormalizers` are kept in the more experimental [ckb-js-toolkit-contrib](https://github.com/xxuejie/ckb-js-toolkit-contrib) project for now, and might be moved here once it is stablized. `Serializers` and `Deserializers` refer to JavaScript source generated by the [moleculec-es](https://github.com/xxuejie/moleculec-es) project. In most cases, you don't have to use `moleculec-es` directly, a ready-to-use file has been put in [ckb-js-toolkit-contrib](https://github.com/xxuejie/ckb-js-toolkit-contrib/blob/master/src/blockchain.js). There is one exception here: `Deserializers` are not functions actually, they are [classes](https://github.com/xxuejie/ckb-js-toolkit-contrib/blob/747db7616116a3d5511f633f71b0415b53e83060/src/blockchain.js#L691) that is constructed from ArrayBuffer to better leverage molecule's zero copy design. You might also notice there is no conversions from JSON Ready Object to objects in your own data structures. This part will have to be implemented by yourself if needed. ## Validators ### Overview Validator is an example of the `Runtime type checking` design goal, it provides a series of functions are provided here to validate that a JSON object follows required format for a CKB data structure, such as script, outpoint, transaction, block, etc. So when you have prepared the values required by the RPC class, you can pass the value through the validators here, to ensure they are of the correct format. First, let's look at one example: ``` node --experimental-repl-await Welcome to Node.js v13.9.0. Type ".help" for more information. > const toolkit = require("ckb-js-toolkit") > const rpc = new toolkit.RPC("http://127.0.0.1:9115/rpc") > const transaction = (await rpc.get_transaction("0x71a7ba8fc96349fea0ed3a5c47992e3b4084b031a42264a018e0072e8172e46c")).transaction > toolkit.validators.ValidateTransaction(transaction) Uncaught: Error: transaction does not have correct keys! Required keys: [cell_deps, header_deps, inputs, outputs, outputs_data, version, witnesses], optional keys: [], actual keys: [cell_deps, hash, header_deps, inputs, outputs, outputs_data, version, witnesses] > delete transaction.hash > transaction { cell_deps: [ { dep_type: 'code', out_point: [Object] }, { dep_type: 'code', out_point: [Object] } ], header_deps: [], inputs: [ { previous_output: [Object], since: '0x0' } ], outputs: [ { capacity: '0x2b95fd500', lock: [Object], type: null }, { capacity: '0x2b95fd500', lock: [Object], type: null } ], outputs_data: [ '0x02000000e2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c03000000e2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c01000000', '0x02000000e2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c03000000e2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c04000000' ], version: '0x0', witnesses: [ '0x3ed693609d3ff7049415d33a2fff8eed581cf2790fae4785e27793330cfd55a6109b84a94494eae64217339bc9aafdf4e6453964c90e6752d96e20d127ca874901' ] } > toolkit.validators.ValidateTransaction(transaction) undefined > transaction.outputs[1].lock.args = 123 123 > toolkit.validators.ValidateTransaction(transaction) Uncaught Error: transaction.outputs[1].lock.args must be a hex string! at nt (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:46599) at st (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:47003) at lt (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:47614) at /home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:48132 at ct (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:48073) at ht (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:48343) at Object.dt [as ValidateTransaction] (/home/ubuntu/code/ckb-js-toolkit/dist/ckb-js-toolkit.node.js:1:48755) ``` From the example above, we can deduce some insights: * Validator function will check if given object has correct keys for each field required in the object. For example, a transaction object do not need `hash` field, but CKB's RPC response contains this field, hence the first validator invocation fails. Later when we delete the `hash` key, the object passes all validation. * By default validator function recursively check all fields to make sure they follow the correct format. In the above example, the validator would signal error when we change `args` field of one output's lock script to `123`, which is an invalid value. You will also notice that the error message generated in this case is: `transaction.outputs[1].lock.args must be a hex string!`, it contains the full path of the error value: `transaction.outputs[1].lock.args`. Notice you are not required to use validator functions in your dapp: if you are familiar with CKB's data structure, you are perfectly good ignoring all validator functions, and ensure the objects are in correct format yourself. But I personally I believe validators are gonna be a very handy component in your toolbox when you run into formatting errors in your dapp. ### Function prototypes For each CKB data structure, we have prepared a validator function, which means right now the following functions are available: * [ValidateScript](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L65) * [ValidateOutPoint](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L83) * [ValidateCellInput](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L92) * [ValidateCellOutput](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L106) * [ValidateCellDep](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L125) * [ValidateRawTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L195) * [ValidateTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L215) * [ValidateRawHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L255) * [ValidateHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L279) * [ValidateUncleBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L316) * [ValidateBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L335) * [ValidateCellbaseWitness](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L371) * [ValidateWitnessArgs](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/validators.js#L385) Each validator function uses exactly the same function prototype as below: ```js function validate(value, { nestedValidation = true, debugPath = "" } = {}) ``` `value` here contains the JSON object to check against. `nestedValidation` controls if nested validation is performed. For example, when you are validating the structure of a transaction, you can use this flag to control whether you want to validate transaction itself, or if you want to do recursive validation on all the included fields, such as inputs, outputs, etc. `debugPath` here is a value used to generate full value path in error messages, in 99% of the cases, you can safely ignore this value and just use the default ones. The validator functions here would throw errors in case validation fails, otherwise the validation is considered successful. Return values of vaildator functions shall not be used. ## Transformers ### Overview Transformer also provides a series of functions much like validators do, but transformers serve a different purpose: while RPC accepts JSON ready values such as strings or plain objects, you might not want the same thing in your dapps. Chances are you have some custom classes that wrap a CKB cell or even a CKB transaction, and will need separate processing work to transform the values into the final formats. Another case might be that you are leveraging the Reader class introduced above a lot, and you need to transform the very inner `args` part of cell outputs in your current transaction before you can send it to the RPC. Transformers fill in exactly this role: they help us transform custom data formats following a very single rule to the formats acceptable by CKB RPCs. This might sound quite abstract here, let's also look at one example. First, let's prepare a supporting commonjs JavaScript file: ``` $ cat << EOF > test.js class Script { constructor(code_hash, args) { this.code_hash = code_hash; this.args = args; } serializeJson() { return { code_hash: this.code_hash, hash_type: "data", args: this.args }; } } module.exports = Script; EOF ``` Here we are defining a custom class wrapping Script. We can now see how transformers will help us use the wrapper class: ``` node --experimental-repl-await Welcome to Node.js v13.9.0. Type ".help" for more information. > const toolkit = require("ckb-js-toolkit"); undefined > const Script = require("./test.js"); undefined > const script = new Script(new toolkit.Reader("0x71a7ba8fc96349fea0ed3a5c47992e3b4084b031a42264a018e0072e8172e46c"), "0x") undefined > script Script { code_hash: a { string: '0x71a7ba8fc96349fea0ed3a5c47992e3b4084b031a42264a018e0072e8172e46c' }, args: '0x' } > toolkit.validators.ValidateScript(script) Uncaught: Error: script does not have correct keys! Required keys: [args, code_hash, hash_type], optional keys: [], actual keys: [args, code_hash] > const transformedScript = toolkit.transformers.TransformScript(script) undefined > transformedScript { code_hash: '0x71a7ba8fc96349fea0ed3a5c47992e3b4084b031a42264a018e0072e8172e46c', hash_type: 'data', args: '0x' } > toolkit.validators.ValidateScript(transformedScript) undefined ``` If we pass objects instantiated from Script class directly, validator functions will fail, and so will CKB RPC(even if we haven't tested it here). However, if we pass the objects into transformer functions, the transformed value will have the correct format required by CKB's RPC. This shows that you can use whatever data format you want in your dapp, as long as it can be transformed to correct format by the transformers, you can largely ignore CKB's format rules in your dapp. Of course, not any format can be transformed by transformer functions here. You might already noticed the `serializeJson` function included in the `Script` class, this is exactly how transformer functions work on. What's not so obvious, here, is that transformer functions will recursively invoke `serializeJson` on nested entities to make sure all sub-fields are also transformed properly. For example, the `code_hash` passed to Script object here, is actually a Reader instance, while `serializeJson` of Script class ignored the type of `code_hash`, transformer functions also perform the necessary transformation, which converts Reader object into hex strings. Unlike validators, we expect you to heavily rely on transformers in your dapps. These days it will be very unlikely that people use plain old JavaScript objects to store data, we tend to use all kinds of abstractions that help us organize our code better. ### Function prototypes For each CKB data structure, we have prepared a transformer function, which means right now the following functions are available: * [TransformScript](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L44) * [TransformOutPoint](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L62) * [TransformCellInput](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L88) * [TransformCellOutput](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L105) * [TransformCellDep](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L123) * [TransformRawTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L148) * [TransformTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L169) * [TransformRawHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L191) * [TransformHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L216) * [TransformUncleBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L242) * [TransformBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L259) * [TransformCellbaseWitness](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L278) * [TransformWitnessArgs](https://github.com/xxuejie/ckb-js-toolkit/blob/48eb43f10da07d30ebc9411c7a0714905ef9164f/src/transformers.js#L295) Each transformer function uses exactly the same function prototype as below: ```js function transform(value, { validation = true, debugPath = "" } = {}) ``` `value` here contains the value to perform transformation(see next section for transformation rules). `validation` controls if validators should also be called after transformation. `debugPath` works like the same value in validators, and could safely be ignored in 99% of the cases. ### Transformation Rules Transformer functions use the following transformation rules: * If the provide value is an object with method `serializeJson`, invoke the method and use the return value to replace provided value; * Check if the value is an object, throw error if it is not; * Remove all extra keys that should not exist for the type of current value object; * For each field in the object, apply the transformation rules recursively. ### Note on Reader class We have already provided `serializeJson` method for all instances of the Reader class, that means you can freely use Reader class in your code. As long as you apply transformer functions before sending the values to CKB RPC, all the Reader objects will be transformed to correct hex strings. ## Normalizers ### Overview Normalizers serve a different purpose: in addition to the molecule serialization format, CKB still encodes certain domain specific knowledge to interpret the data. This brings a gap between the JSON data structure used in CKB RPC, and the molecule serialized formats used internally. If you are only using CKB RPC, you probably will not use this package, but if you need to work with CKB in a deeper level(for example, if you are writing a smart contract in JavaScript), chances are you might need this package. A sample usage for this package can be seen in the included [tests](https://github.com/xxuejie/ckb-js-toolkit/blob/master/tests/serializers.js). A normalizer function takes plain JavaScript object that can be validated by validator function, it then emits another transformed plain JavaScript object which can be serialized by [moleculec-es](https://github.com/xxuejie/moleculec-es) into serialized ArrayBuffer data in molecule format. ### Function prototypes For each CKB data structure, we have prepared a normalizer function, which means right now the following functions are available: * [NormalizeScript](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L71) * [NormalizeOutPoint](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L92) * [NormalizeCellInput](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L107) * [NormalizeCellOutput](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L117) * [NormalizeCellDep](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L133) * [NormalizeRawTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L161) * [NormalizeTransaction](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L175) * [NormalizeRawHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L189) * [NormalizeHeader](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L207) * [NormalizeUncleBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L218) * [NormalizeBlock](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L228) * [NormalizeCellbaseWitness](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L237) * [NormalizeWitnessArgs](https://github.com/xxuejie/ckb-js-toolkit/blob/d17eda8dc41689b14913500332085d9a9ae85a01/src/normalizers.js#L247) Each normalizer function uses exactly the same function prototype as below: ```js function transform(value, { debugPath = "" } = {}) ``` `value` here contains the value which can be validated by corresponding validator function. `debugPath` works like the same value in validators, and could safely be ignored in 99% of the cases. # Cell Collectors One extremely typical tasks in CKB, is to index and query cells with certain properties, such as live cells with the same lock script hash. Cell collectors has been provided in the toolkit to aid this task. As usual, first let's see an example: ``` node --experimental-repl-await Welcome to Node.js v13.9.0. Type ".help" for more information. > const toolkit = require("ckb-js-toolkit"); undefined > const rpc = new toolkit.RPC("http://127.0.0.1:9115/rpc") undefined > const collector = new toolkit.cell_collectors.RPCCollector(rpc, "0x7c7232c0af4a7261674a45e14916f926ecec64b911f539e573fb4bb7817d001e") undefined > for await (const cell of collector.collect()) { console.log(cell); } { cell_output: { capacity: '0x3faa252260000', lock: { args: '0xfa3afa2134319f9471cf21024f032831bc4651ad', code_hash: '0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8', hash_type: 'type' }, type: null }, out_point: { index: '0x7', tx_hash: '0xe2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c' }, block_hash: '0x92b197aa1fba0f63633922c61c92375c9c074a93e85963554f5499fe1450d0e5', data: null, block_number: '0x0' } ``` Here we are using [RPCCollector](https://github.com/xxuejie/ckb-js-toolkit/blob/master/src/cell_collectors/rpc_collector.js) to scan CKB via RPCs, and gather all live cells satisfying a given lock script hash. Notice [async iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator) is leveraged here to provide a clean API to the end users. ## Collector Interface A cell collector should satisfy the following rules: * It should provide a `collect` method that returns an async iterator; * The async iterator should generate plain JavaScript objects with the following fields: + `cell_output`: CellOutput object that can be validated by `ValidateCellOutput` + `out_point`: OutPoint object that can be validated by `ValidateOutPoint` + `block_hash`: A 66-byte long hex string containing block header hash * `data`: An optional hex string containing cell data, depending on the specific cell collector, this could be omitted, in which case `null` should be used here. In the above example we are only showing RPCCollector, there might be many different implementations of cell collectors, assuming they satisfy the above rules. In the future we might add more cell collector implementations here, and you are also welcome to create your own implementations of cell collectors. One additional note here, is that even though RPCCollector above only gathers cells with the same lock script hash, this is not the case for your custom cell collectors. The only true requirement of a cell collector, is the async iterator interface. You can use any filtering logic in your cell collector, for example, you can gather by type script hash, or by lock script code hash, or you can even call external services, such as [animagus](https://github.com/xxuejie/animagus) to provide you with the cells to use. ## Collector Index ### RPCCollector RPCCollector uses [get_cells_by_lock_hash](https://github.com/nervosnetwork/ckb/tree/develop/rpc#get_cells_by_lock_hash) to fetch matched live cells via CKB RPC. It only allows fetching live cells matching provided lock script hash, and can be controlled to either provide or omit cell data. Note RPCCollector is a naive implementation, meaning it would do the full scanning every time you call `collect`. This means it could be quite slow, and you should never use it in production. It is only used here for demostration purposes. # `@ckb-lumos/hd-cache` HD Cache manager for lumos. ## Usage ```javascript const { CacheManager, CellCollector, CellCollectorWithQueryOptions, getBalance } = require("@ckb-lumos/hd-cache") const { Indexer } = require("@ckb-lumos/ckb-indexer") const indexer = new Indexer("http://localhost:8114") const cacheManger = CacheManager.loadFromKeystore(indexer, "You keystore path", "You password") // start to sync cache from indexer cacheManager.startForever() // if your keystore is from ckb-cli or you set needMasterPublicKey to true, you can get you master public key info by cacheManager.getMasterPublicKeyInfo() // ckb-cli using this key by default // now you can using following methods cacheManager.getNextReceivingPublicKeyInfo() cacheManager.getNextChangePublicKeyInfo() // or collect cells by CellCollectors const cellCollector = new CellCollector(cacheManager) // or with queryOptions const cellCollector = new CellCollectorWithQueryOptions( new CellCollector(cacheManger), queryOptions, ) for await (const cell of cellCollector.collect()) { console.log(cell) } // get HD wallet balance await getBalance(cellCollector) ``` # Lumos Examples ## Quick Start ### Build lumos ```sh git clone https://github.com/nervosnetwork/lumos.git cd lumos yarn yarn build yarn build-release ``` ### Check if the build is working ``` yarn ts-node examples/config-manager.ts ``` ## Online Preview Using [GitHubBox.com](https://codesandbox.io/docs/importing#using-githubboxcom), you can preview and interact with example code online through codesandbox. For example: Change the GitHub URL: https://github.com/nervosnetwork/lumos/tree/develop/examples/omni-lock-metamask To: https://githubbox.com/nervosnetwork/lumos/tree/develop/examples/omni-lock-metamask Note that due to the incompatibility of namiwallet and iframe, you need to open the result in a new window while opening [cardano-lock-namiwallet](https://github.com/nervosnetwork/lumos/tree/develop/examples/cardano-lock-namiwallet) with codesandbox. CKB indexer is based on  [ckb-indexer](https://github.com/nervosnetwork/ckb-indexer) with more features. It is designed for: - Web client usage. - CKB's RPC query. ## **Usage** ### **Indexer** ```jsx const { Indexer } = require("@ckb-lumos/ckb-indexer"); const nodeUri = "https://testnet.ckb.dev/rpc"; const indexUri = "https://testnet.ckb.dev/indexer"; const indexer = new Indexer(indexUri, nodeUri); ``` ### **CellCollector** To query existing cells, you can create a CellCollector: ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x0000000000000000000000000000000000000000000000000000000000000000", hash_type: "data", args: "0x62e907b15cbf27d5425399ebf6f0fb50ebb88f18", }, }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` Specify `lock` or `type` script as constraints for advance search: ```jsx cellCollector = new CellCollector(indexer, { lock: { args: "0x92aad3bbab20f225cff28ec1d856c6ab63284c7a", code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", }, type: { args: "0x", code_hash: "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e", hash_type: "type", }, }); ``` Query cells in certain block_numbers range (`fromBlock` and `toBlock` are included): ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, fromBlock: "0x225510", // "0x" + 2250000n.toString(16) toBlock: "0x225ce0", // "0x" + 2252000n.toString(16) }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` Skip a certain number of query results, e.g. the below code snippet means it would skip the first 100 cells and return from the 101st one ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, skip: 100, }); for await (const tx of cellCollector.collect()) { console.log(tx); } ``` Order by block number is supported by setting `order` field explicitly: ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, fromBlock: "0x253b40", // "0x" + 2440000n.toString(16) toBlock: "0x253f28", // "0x" + 2441000n.toString(16) order: "desc", // default option is "asc" skip: 300, }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` Prefix search is supported on `args`. The default `argsLen` is -1, which means you pass the full slice of original args, and you can specify it when the `args` field is the prefix of original args. ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df3", // truncate the last byte of orignal args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, argsLen: 20, // default option is -1 fromBlock: "0x253b40", // "0x" + 2440000n.toString(16) toBlock: "0x253f28", // "0x" + 2441000n.toString(16) order: "desc", // default option is "asc" skip: 300, }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` You can also set it as `any` when the argsLen has multiple possibilities. For example, lock script's args is 20 in normal scenario and 28 in multisig scenario, or any other length in customized scenarios. ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7d", // truncate the last two bytes of original args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, argsLen: "any", fromBlock: "0x253b40", // "0x" + 2440000n.toString(16) toBlock: "0x253f28", // "0x" + 2441000n.toString(16) order: "desc", // default option is "asc" skip: 300, }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` Fine grained query for cells can be achieved by using [ScriptWrapper](https://github.com/nervosnetwork/lumos/blob/cd418d258085d3cb6ab47eeaf5347073acf5422e/packages/base/index.d.ts#L123), with customized options like `argsLen`: ```jsx cellCollector = new CellCollector(indexer, { lock: { script: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xe60f7f88c94ef365d540afc1574c46bb017765", // trucate the last byte of original args: 0xe60f7f88c94ef365d540afc1574c46bb017765a2 }, argsLen: 20, }, type: { script: { code_hash: "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e", hash_type: "type", args: "0x", }, // when the `argsLen` is not setted here, it will use the outside `argsLen` config, which in this case is -1 by default }, }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` `outputDataLenRange` for filtering cell by data length, and `outputCapacityRange` for filtering cell by capacity: ```jsx cellCollector = new CellCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7d", // truncate the last two bytes of original args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, outputDataLenRange: [0x0, 0x160], outputCapacityRange: [0x10000, 0x100000], }); for await (const cell of cellCollector.collect()) { console.log(cell); } ``` To return block_hash in the result, add the following query options: ```jsx const otherQueryOptions: OtherQueryOptions = { withBlockHash: true, ckbRpcUrl: nodeUri, }; const cellCollector = new CellCollector( indexer, { lock: type } otherQueryOptions ); ``` ### **TransactionCollector** Similar usage for quering transactions: ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x0000000000000000000000000000000000000000000000000000000000000000", hash_type: "data", args: "0x62e907b15cbf27d5425399ebf6f0fb50ebb88f18", }, CKBRpcUrl, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` Query cells in certain block_numbers range (`fromBlock` and `toBlock` are included): ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, fromBlock: "0x0", // "0x" + 0n.toString(16) toBlock: "0x7d0" , // "0x" + 2000n.toString(16) }); for await (const tx of txCollector.collect()) { console.log(tx); ``` Skip a certain number of query results, e.g. the below code snippet means it would skip the first 100 cells and return from the 101st one. ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, skip: 100, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` Order by block number is supported: ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, fromBlock: "0x4e20", // "0x" + 20000n.toString(16) toBlock: "0x5208", // "0x" + 21000n.toString(16) order: "desc", // default option is "asc" skip: 10, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` Prefix search is supported on `args`. The default `argsLen` is -1, which means you pass the full slice of original args, and you can specify it when the `args` field is the prefix of original args. ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df3", // truncate the last byte of orignal args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, argsLen: 20, // default option is -1 fromBlock: "0x253b40", // "0x" + 2440000n.toString(16) toBlock: "0x253f28", // "0x" + 2441000n.toString(16) order: "desc", // default option is "asc" skip: 300, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` You can also set it as `any` when the argsLen of the field args might have multiple possibilities, for example, lock script's args could be 20 in normal scenario and 28 in multisig scenario, or any other length in customized scenarios. However, there's some performance lost when use `any` rather than explicitly specified length due to the low-level implementation. ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7d", // truncate the last two bytes of original args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, argsLen: "any", fromBlock: "0x253b40", // "0x" + 2440000n.toString(16) toBlock: "0x253f28", // "0x" + 2441000n.toString(16) order: "desc", // default option is "asc" skip: 300, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` Fine grained query for transactions can be achieved by using [ScriptWrapper](https://github.com/nervosnetwork/lumos/blob/cd418d258085d3cb6ab47eeaf5347073acf5422e/packages/base/index.d.ts#L123), with customized options like `ioType`, `argsLen`: ```jsx txCollector = new TransactionCollector(indexer, { lock: { script: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xe60f7f88c94ef365d540afc1574c46bb017765", // trucate the last byte of original args: 0xe60f7f88c94ef365d540afc1574c46bb017765a2 }, ioType: "both", argsLen: 20, // when the `argsLen` is not setted here, it will use the outside `argsLen` config }, type: { script: { code_hash: "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e", hash_type: "type", args: "0x", }, ioType: "input", }, }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` The `ioType` field is among `input | output | both`. `outputDataLenRange` is support to filter cell by data length, `outputCapacityRange` is support to filter cell by capacity。you can use as below. ```jsx txCollector = new TransactionCollector(indexer, { lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7d", // truncate the last two bytes of original args: 0xa528f2b9a51118b193178db4cf2f3db92e7df323 }, outputDataLenRange: [0x0, 0x160], outputCapacityRange: [0x10000, 0x100000], }); for await (const tx of txCollector.collect()) { console.log(tx); } ``` ### **EventEmitter** Besides polling pattern, event-driven pattern is also supported. After subsribing for certain `lock|type` script, it will emit a `changed` event when a block containing the subsribed script is indexed or rollbacked. The principle of the design is unreliable notification queue, so developers are supposed to pull from the data sources via `CellCollector|TransactionCollector`, to find out what might happened: cell consumed, new cell generated, new transaction generated, or a chain fork happened, etc; and take the next step accordingly. ```jsx eventEmitter = indexer.subscribe({ lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0xa528f2b9a51118b193178db4cf2f3db92e7df323", }, }); eventEmitter.on("changed", () => { console.log( "States changed with the script, please pull the data sources from the indexer to find out what happend" ); }); ``` Other query options like `fromBlock|argsLen|data` are also supported. ```jsx eventEmitter = indexer.subscribe({ lock: { code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", // the args bytes length is 18, truncate the last 2 bytes. args: "0xa528f2b9a51118b193178db4cf2f3db92e7d", }, // default value is -1 argsLen: 20, // default value is "any" data: "0x", // default value is 0 fromBlock: 0x3e8, // "0x" + 1000n.toString(16) }); ``` Listen to median time change when blocks changed. ```jsx const medianTimeEmitter = indexer.subscribeMedianTime(); medianTimeEmitter.on("changed", (medianTime) => { console.log(medianTime); }); ``` ## **Migration** If you want to migrate native indexer to ckb-indexer, please check more detail in our [migration docs](https://github.com/nervosnetwork/lumos/blob/develop/packages/ckb-indexer/mirgation.md) # Website This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. ### Installation ``` $ yarn ``` ### Local Development ``` $ yarn start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ### Build ``` $ yarn build ``` This command generates static content into the `build` directory and can be served using any static contents hosting service. ### Deployment Using SSH: ``` $ USE_SSH=true yarn deploy ``` Not using SSH: ``` $ GIT_USER=<Your GitHub username> yarn deploy ``` If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. # `@ckb-lumos/base` Test toolkit for testing CKB dApps ## Work With CKB Indexer Starting a CKB mock rpc ``` $ ts-node packages/testkit/example-ckb-nodes.ts server listen to 8118 ``` And then launching a CKB indexer sync block data from the mock server ``` ckb-indexer -c http://127.0.0.1:8118/rpc -l 127.0.0.1:8116 -s indexer-store-tmp ``` # Lumos Works with MetaMask Nervos maintains a powerful lock called [Omni Lock](https://github.com/XuJiandong/docs-bank/blob/master/omni_lock.md) (previously named RC lock), which can use MetaMask as a signer. This example will show how to use Lumos to send a transaction using Omni lock and MetaMask ## Quick Start > we should [build](..) Lumos project first before we start this example ``` yarn run build yarn run build-release cd examples/omni-lock-metamask yarn start ``` ## Links - [MetaMask](https://metamask.io/) - A crpto wallet - [Nervos Faucet](https://faucet.nervos.org/) - Claim Nervos testnet CKB - [Omni lock](https://github.com/XuJiandong/docs-bank/blob/master/omni_lock.md) - Omni lock intro # `@ckb-lumos/helpers` Helper utilities for working with CKB transactions from lumos. The difference between this and `@ckb-lumos/base`, is that `@ckb-lumos/base` contains only core definitions, while this module contains utilities used in a framework sense. One example is: you can pretty much use `@ckb-lumos/base` as a standalone library, while this library integrates more with `config` module so it knows whether the framework is running under testnet, or mainnet environment. ## Usage ```javascript const { minimalCellCapacity, generateAddress, parseAddress } = require("@ckb-lumos/helpers") // Get cell minimal capacity. const result = minimalCellCapacity({ cell_output: { capacity: "0x174876e800", lock: { args: "0x36c329ed630d6ce750712a477543672adab57f4c", code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", }, type: null, }, data: "0x", block_hash: null, block_number: null, out_point: null, }) // result will be 6100000000n shannons. // Use `generateAddress` to get address from lock script. const address = generateAddress({ code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0x36c329ed630d6ce750712a477543672adab57f4c", }) // Then you will get mainnet address "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", or you can generate testnet address by const { predefined } = require("@ckb-lumos/config-manager") const address = generateAddress({ code_hash: "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8", hash_type: "type", args: "0x36c329ed630d6ce750712a477543672adab57f4c", }, { config: predefined.AGGRON4 }) // Will get testnet address "ckt1qyqrdsefa43s6m882pcj53m4gdnj4k440axqswmu83". // Use `parseAddress` to get lock script from an address. const script = parseAddress("ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd") // TransactionSkeleton <=> Object // Convert TransactionSkeleton to js object const obj = transactionSkeletonToObject(txSkeleton) // then your can write to json file fs.writeFileSync("your file", JSON.stringify(obj)) // Or convert js object to TransactionSkeleton // If your object is from json file, make sure `cellProvider` is working properly. const txSkeleton = objectToTransactionSkeleton(obj) ``` # `@ckb-lumos/base` Base data structures and utilities used in lumos. # Cardano lock NamiWallet This is a simple example of how to interactive with CKB via [NamiWallet](https://github.com/Berry-Pool/nami-wallet). The cardano lock is compiled from this [commit](https://github.com/nervosnetwork/ckb-production-scripts/tree/4b6f7ec2c3c29798ad56ed9ed513b9391ff7d60d). ## Deployment - Aggron | parameter | value | | ----------- | -------------------------------------------------------------------- | | `code_hash` | `0x3625f5ccecdbb8edff6890db2225b0218d753b7932e144a41b0a77b1111c921b` | | `hash_type` | `type` | | `tx_hash` | `0xadf72b5a58b18e3763ab9e7769e16ffcb222da07a2cae2b407a6ffc47a2d39ff` | | `index` | `0x0` | | `dep_type` | `code` | ## Reference - [cardano lock spec](https://github.com/XuJiandong/docs-bank/blob/master/cardano_lock.md) ## Online Preview Using [GitHubBox.com](https://codesandbox.io/docs/importing#using-githubboxcom), you can preview and interact with example code online through codesandbox. Change the GitHub URL: https://github.com/nervosnetwork/lumos/tree/develop/examples/cardano-lock-namiwallet To: https://githubbox.com/nervosnetwork/lumos/tree/develop/examples/cardano-lock-namiwallet Note that due to the incompatibility of namiwallet and iframe, you need to open the result in a new window:  # `@ckb-lumos/rpc` RPC module for lumos. Provide type definitions for CKB RPC interface. ## Usage ```javascript import { RPC } from "@ckb-lumos/rpc" const rpc = new RPC("http://localhost:8114"); await rpc.get_tip_header(); // Or provide an optional indexer param, if provided, will wait for sync after every RPC call. const rpc = new RPC("http://localhost:8114", indexer) await rpc.get_tip_header(); // before it return, will sync indexer to tip. ``` # @ckb-lumos/lumos A root package to integrate of common functions from the Lumos sub-package # `@ckb-lumos/transaction-manager` TransactionManager is a tool for manager uncommitted cells, you can `send_transaction` via this tool and get uncommitted outputs by `collector`. ## Usage ```javascript const TransactionManager = require("@ckb-lumos/transaction-manager"); const { Indexer } = require("@ckb-lumos/ckb-indexer"); // generate a new `TransactionManager` instance and start. const indexer = new Indexer("http://127.0.0.1:8114"); const transactionManager = new TransactionManager(indexer); transactionManager.start(); // now you send transaction via `transactionManager`. const txHash = await transactionManager.send_transaction(transaction); // you can get uncommitted cells by `transactionManager.collector`. const collector = transactionManager.collector({ lock }); for await (const cell of collector.collect()) { console.log(cell); } ``` # @ckb-lumos/bi A big number library for lumos. ## Example ```ts import { BI } from "@ckb-lumos/bi"; BI.from(1).add(1) ``` # `@ckb-lumos/common-scripts` Common script implementation for lumos. Includes `secp256k1_blake2b` lock script, `secp256k1_blake160_multisig` lock script, `dao` type script, `sudt` type script now. `LocktimePool` script includes `secp256k1_blake160_multisig` cells which with locktime in lock `args` (which `args` total length is 28 bytes, last 8 bytes is a `since` format locktime in BigUInt64LE encode) and `DAO` step2 cells. `common` script allows you to `transfer` capacity from `fromInfos` to an address. It will use locktime pool cells first by default. `deploy` script provides `generateDeployWithDataTx`, `generateDeployWithTypeIdTx` and `generateUpgradeTypeIdDataTx`, these generators help in the process of deploying contracts. `p2pkh` scripts generates message for signing P2PKH transaction. ## Usage `common` script support new lock scripts provided by user, and [`pw-lock`](./examples/pw_lock/lock.ts) shows how to do it. Following script will show how to use `common` script to transfer capacity to another address. `secp256k1_blake160`, `secp256k1_blake160_multisig` and `locktime_pool` script are similar to `common`, and `common` maybe a better choose. ```javascript const { common } = require('@ckb-lumos/common-scripts'); const { sealTransaction } = require("@ckb-lumos/helpers") const { Indexer } = require("@ckb-lumos/ckb-indexer") // We can use Indexer module as cell provider const indexer = new Indexer("http://127.0.0.1:8114"); const tipHeader = { compact_target: '0x20010000', dao: '0x49bfb20771031d556c8480d47f2a290059f0ac7e383b6509006f4a772ed50200', epoch: '0xa0006002b18', hash: '0x432451e23c26f45eaceeedcc261764d6485ea5c9a204ac55ad755bb8dec9a079', nonce: '0x8199548f8a5ac7a0f0caef1620f37b79', number: '0x1aef6', parent_hash: '0x63594a64108f19f6aed53d0dca9ab4075aac4379cb80b2097b0deac8fc16fd3b', proposals_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', timestamp: '0x172f6b9a4cf', transactions_root: '0x282dbadcd49f3e229d997875f37f4e4f19cb4f04fcf762e9639145aaa667b6f8', uncles_hash: '0x0000000000000000000000000000000000000000000000000000000000000000', version: '0x0' } const fromInfos = [ "ckb1qyqwyxfa75whssgkq9ukkdd30d8c7txct0gq5f9mxs", { R: 0, M: 1, publicKeyHashes: ["0x36c329ed630d6ce750712a477543672adab57f4c"], }, ] let txSkeleton = TransactionSkeleton({ cellProvider: indexer }) // If using secp256k1_blake160_multisig lock script, put MultisigScript to `fromInfos` for generate signing messages. // By default, `common.transfer` will use cells with locktime firstly. `tipHeader` is required when you want to spent cells with locktime. txSkeleton = await common.transfer( txSkeleton, fromInfos, "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", BigInt(3500 * 10 ** 8), tipHeader, ) // Or you want to use cells without locktime firstly. txSkeleton = await common.transfer( txSkeleton, fromInfos, "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", BigInt(3500 * 10 ** 8), tipHeader, { useLocktimeCellsFirst: false } ) // When you want to pay fee for transaction, just call `payFee`. txSkeleton = await common.payFee( txSkeleton, fromInfos, BigInt(1*10**8), tipHeader, ) // `prepareSigningEntries` will generate message for signing. // Signing messages will fill in `txSkeleton.signingEntries`. txSkeleton = await common.prepareSigningEntries( txSkeleton ) // Then you can sign messages in order and get contents. // NOTE: lumos not provided tools for generate signatures now. // Call `sealTransaction` to get a transaction. const tx = sealTransaction(txSkeleton, contents) // Then you can send tx to a CKB node via RPC `send_transaction`. ``` Following script will show how to use `DAO` script. ```javascript const { dao } = require("@ckb-lumos/common-scripts") let txSkeleton = TransactionSkeleton({ cellProvider: indexer }) // First, deposit capacity to dao. txSkeleton = await dao.deposit( txSkeleton, "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", // will gather inputs from this address. "ckb1qyqwyxfa75whssgkq9ukkdd30d8c7txct0gq5f9mxs", // will generate a dao cell with lock of this address. BigInt(1000*10**8), ) // Using `listDaoCells` to list all deposited cells. const daoDepositedCells = await dao.listDaoCells( indexer, "ckb1qyqwyxfa75whssgkq9ukkdd30d8c7txct0gq5f9mxs", "deposit", ) // Or using `CellCollector` const daoDepositedCellCollector = new dao.CellCollector( "ckb1qyqwyxfa75whssgkq9ukkdd30d8c7txct0gq5f9mxs", indexer, "deposit", ) for await (const inputCell of daoDepositedCellCollector.collect()) { console.log(inputCell) } // And pick one to withdraw. // `fromInfo` only required for multisig script. txSkeleton = await dao.withdraw( txSkeleton, daoDepositedCells[0], ) // Then if want to unlock dao withdrew cells, just use `common.transfer`. ``` Following script will show how to use `sUDT` script. ```javascript const { sudt } = require("@ckb-lumos/common-scripts") let txSkeleton = TransactionSkeleton({ cellProvider: indexer }) // issue an sudt token, will use the second param address to generate sudt token(it's lock hash). txSkeleton = await sudt.issueToken( txSkeleton, "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", 10000n, ); // and transfer sUDT const sudtToken = "0x1f2615a8dde4e28ca736ff763c2078aff990043f4cbf09eb4b3a58a140a0862d" txSkeleton = await sudt.transfer( txSkeleton, ["ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd"], sudtToken, "ckb1qyqwyxfa75whssgkq9ukkdd30d8c7txct0gq5f9mxs", 1000n, "ckb1qyqrdsefa43s6m882pcj53m4gdnj4k440axqdt9rtd", ); ``` Following script will show how to use `deploy` script. ```javascript const { generateDeployWithDataTx, generateDeployWithTypeIdTx, generateUpgradeTypeIdDataTx, payFee } = require("@ckb-lumos/common-scripts"); const { Indexer } = require("@ckb-lumos/ckb-indexer"); const { initializeConfig, predefined } = require("@ckb-lumos/config-manager"); const { parseAddress } = require("@ckb-lumos/helpers"); initializeConfig(predefined.AGGRON4); const CKB_RPC_URL = "http://localhost:8114"; const CKB_INDEXER_URL = "http://localhost:8116"; const indexer = new Indexer(CKB_INDEXER_URL, CKB_RPC_URL); const address = "ckt1qyqptxys5l9vk39ft0hswscxgseawc77y2wqlr558h"; // Lock script of the deploy account const outputScriptLock = parseAddress(address); // Binary data you want to deploy const scriptBinary = Uint8Array.of(1); let deployOptions = { cellProvider: indexer, scriptBinary: scriptBinary, outputScriptLock: outputScriptLock, } // Ganarate txSkeleton for deploying with data. let txSkeleton = await generateDeployWithDataTx(deployOptions); // Or if you want to delpoy with Type ID so that you can upgarde the contract in the future. let txSkeleton = await generateDeployWithTypeIdTx(deployOptions); // Pay transaction fee. txSkeleton = await payFee(txSkeleton, address, txFee); // Then you can sign and seal the transaction for sending. // To upgrade a contract with Type ID, add its Type ID to deployOptions. const typeId = { code_hash: '0x00000000000000000000000000000000000000000000000000545950455f4944', hash_type: 'type', args: '0x7abcd9f949a16b40ff5b50b56e62d2a6a007e544d8491bb56476693b6c45fd27' } const upgradeOptions = { cellProvider: cellProvider, scriptBinary: scriptBinary, outputScriptLock: outputScriptLock, typeId: typeId } // Ganarate txSkeleton for upgrading. let upgradeTxSkeleton = await generateUpgradeTypeIdDataTx(upgradeOptions); ``` Check [omni lock example](https://github.com/nervosnetwork/lumos/blob/develop/examples/omni-lock-metamask/lib.ts) and [pw lock example](https://github.com/nervosnetwork/lumos/blob/develop/examples/pw-lock-metamask/lib.ts) for how to use `p2pkh` script. # Lumos Works with PW-Lock via MetaMask ## Quick Start > we should [build](..) Lumos project first before we start this example ``` cd examples/pw-lock-metamask yarn start ``` ## Links - [MetaMask](https://metamask.io/) - A crpto wallet - [Nervos Faucet](https://faucet.nervos.org/) - Claim Nervos testnet CKB - [PW lock](https://docs.nervos.org/docs/essays/pw-lock) - PW lock intro # `@ckb-lumos/hd` HD & Mnemonic implementation for lumos. ## Usage Create a new HD wallet. ```javascript const { mnemonic, ExtendedPrivateKey, Keystore } = require("@ckb-lumos/hd") const m = mnemonic.generateMnemonic() const seed = mnemonic.mnemonicToSeedSync(m) const extendedPrivateKey = ExtendedPrivateKey.fromSeed(seed) const keystore = Keystore.create(extendedPrivateKey, "Your password") // save keystore file keystore.save("you path, only dir") // load keystore file const keystore = Keystore.load("you file path, with file name") ``` XPub support. ```javascript const { XPubStore } = require("@ckb-lumos/hd") // load from xpub file. const xpub = XPubStore.load("you path") // to AccountExtendedPublicKey const accountExtendedPublicKey = xpub.toAccountExtendedPublicKey() // save xpub file. xpub.save("your path") ``` # @ckb-lumos/config-manager ## Example ```ts import { initializeConfig, predefined } from '@ckb-lumos/config'; import { generateAddress } from '@ckb-lumos/helper' initializeConfig(predefined.AGGRON); generateAddress({...}) // ckt1... initializeConfig(predefined.LINA); generateAddress({...}) // ckb1... ```

marco-sundsk_NCD-GroupA-Demo

README.md babel.config.js contract dice Cargo.toml README.md build.sh compile.js src lib.rs token Cargo.toml README.md build.sh src fungible_token_core.rs fungible_token_metadata.rs internal.rs lib.rs storage_manager.rs w_near.rs copy-dev-account.js jest.config.js package.json src __mocks__ fileMock.js assets logo-black.svg logo-white.svg config.js global.css jest.init.js main.js main.test.js utils.js wallet login index.html tests unit Notification.spec.js SignedIn.spec.js SignedOut.spec.js

NCD-GroupA-Demo Smart Contract ================== A demo contract for NCD Pojrect Phase-1. Play with this contract ======================== the contract is deployed at testnet with the name `dev-1614240595058-5266655` you can set it to env for later use: ```shell export CONTRACTID=dev-1614240595058-5266655 ``` ## Look around ```shell # return playground info near view $CONTRACTID get_contract_info '' # return winner tip rate near view $CONTRACTID get_reward_fee_fraction '' # return win history list near view $CONTRACTID get_win_history '{"from_index": 0, "limit": 100}' # return dice count that alice has near view $CONTRACTID get_account_dice_count '{"account_id": "alice.testnet"}' ``` ## Let's play ```shell # attached 3 Near to buy 3 dices near call $CONTRACTID buy_dice '' --amount=3 --account_id=alice.testnet #check user's dice, would return 3 here near view $CONTRACTID get_account_dice_count '{"account_id": "alice.testnet"}' # roll dice 3 times, say how luck you are near call $CONTRACTID roll_dice '{"target": 1}' --account_id=alice.testnet near call $CONTRACTID roll_dice '{"target": 3}' --account_id=alice.testnet near call $CONTRACTID roll_dice '{"target": 4}' --account_id=alice.testnet ``` Build Deploy and Init ====================== Before you compile this code, you will need to install Rust with [correct target] ```shell # building it srouce ./build.sh ``` ```shell # dev-deploy or deploy it near dev-deploy res/neardice.wasm # say it was deploy at $CONTRACTID, then init it near call $CONTRACTID new \ '{"owner_id": "boss.testnet", "dice_number": 1, "rolling_fee": "1000000000000000000000000", "reward_fee_fraction": {"numerator": 5, "denominator": 100}}' \ --account_id=$CONTRACTID ``` ```shell # last step to open the playgroud is # to deposit to the jackpod the very first time near call $CONTRACTID deposit_jackpod '' --amount=50 --account_id=boss.testnet ``` Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/roles/developer/contracts/intro [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html NCD-GroupA-Demo ================== This is a homework demo project for NCD program phase-1. Rolling Dice On NEAR ==================== Guys, let's roll dice on NEAR. ## Why dice Randomness is always a key focus on any blockchain. We wanna show you how convenient that a random number can get on NEAR blockchain. To achieve that, it is hard to believe there is a better way than to make a dice dapp. Beyond what you can see in this demo, NEAR can even generate independent randomness not per block, but per receipt! ## How to play On home page, user can see the whole status of playground without login, i.e. an NEAR account is not necessary. He would have full imformation about owner account of this contract, dice price, commission fee rate, the size of current jackpod and etc. Then, user can login with NEAR account and buy several dices. With dices bought, he can guess a number and roll dice again and again. If the dice point is equal to his guess, half of jackpod would belong to him. Otherwise the amount he paid for the dice would belong to the jackpod. During playing, the latest 20 win records would appear and be auto refreshed on screen too. About Contract ==================== It's need to be mentioned that it is a pure dapp project, which means there is no centralized backend nor data server, all persistent information is stored and mananged on NEAR chain by a contract. ## Contract Structure ```rust /// This structure describe a winning event #[derive(BorshDeserialize, BorshSerialize)] pub struct WinnerInfo { pub user: AccountId, // winner accountId pub amount: Balance, // how much he got as win reward pub height: BlockHeight, // the block hight this event happened pub ts: u64, // the timestamp this event happened } /// main structure of this contract #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct NearDice { pub owner_id: AccountId, // owner can adjust params of this playground pub dice_number: u8, // how many dices one rolling event uses pub rolling_fee: Balance, // how much a dice costs when user buys it pub jack_pod: Balance, // as name shows and half of it would belong to the winner pub owner_pod: Balance, // winner would share a tip to the playground, this is where those tips go pub reward_fee_fraction: RewardFeeFraction, // a fraction defines tip rate // an always grow vector records all win event, // as a demo, we ignore the management of its size, // but in real project, it must be taken care of, // maybe has a maximum length and remove the oldest item when exceeds. pub win_history: Vector<WinnerInfo>, // records dice user bought by his payment amount. // This map has a mechanism to shrink, // when a user's balance is reduce to zero, the entry would be removed. pub accounts: LookupMap<AccountId, Balance>, } ``` ## Contract Interface ```rust /// winner's tip rate pub struct RewardFeeFraction { pub numerator: u32, pub denominator: u32, } /// a human readable version for win event struct, used in return value to caller pub struct HumanReadableWinnerInfo { pub user: AccountId, // winner accountId pub amount: U128, // the reward he got pub height: U64, // block height the event happens pub ts: U64, // timestamp the event happens } /// status of this playground, as return value of get_contract_info pub struct HumanReadableContractInfo { pub owner: AccountId, // who runs this playground, if you feel bad, just sue him :) pub jack_pod: U128, // you know what it means pub owner_pod: U128, // winner's tip goes to here, owner can withdraw pub dice_number: u8, // how many dice we use in one rolling event pub rolling_fee: U128, // how much a dice costs when user wanna buy it } /// every roll_dice event would return this info pub struct HumanReadableDiceResult { pub user: AccountId, // who rolls pub user_guess: u8, // the number he guess pub dice_point: u8, // the number dice shows pub reward_amount: U128, // reward he got pub jackpod_left: U128, // jackpod after this event pub height: U64, // the block height when he rolls pub ts: U64, // the timestamp when he rolls } //****************/ //***** INIT *****/ //****************/ /// initialization of this contract #[init] pub fn new( owner_id: AccountId, dice_number: u8, rolling_fee: U128, reward_fee_fraction: RewardFeeFraction, ) -> Self; //***************************/ //***** OWNER FUNCTIONS *****/ //***************************/ /// deposit to jackpod, used for initalizing the very first jackpod, /// otherwise, the jackpod is initialized as 0. #[payable] pub fn deposit_jackpod(&mut self); /// withdraw ownerpod to owner's account pub fn withdraw_ownerpod(&mut self, amount: U128); /// Updates current reward fee fraction to the new given fraction. pub fn update_reward_fee_fraction(&mut self, reward_fee_fraction: RewardFeeFraction); /// Updates current dice number used in one rolling event. pub fn update_dice_number(&mut self, dice_number: u8); /// Updates current dice price. pub fn update_rolling_fee(&mut self, rolling_fee: U128); //**************************/ //***** USER FUNCTIONS *****/ //**************************/ /// user deposit near to buy dice. /// he can buy multiple dices, /// any leftover amount would refund /// eg: rolling_fee is 1 Near, he can buy_dice with 4.4 Near and got 4 dices and 0.4 Near refund. #[payable] pub fn buy_dice(&mut self); /// user roll dice once, then his available dice count would reduce by one. pub fn roll_dice(&mut self, target: u8) -> HumanReadableDiceResult; //**************************/ //***** VIEW FUNCTIONS *****/ //**************************/ /// get a list of winn events in LIFO order /// best practise is set from_index to 0, and limit to 20, /// that means to get latest 20 win events information with latest first order. pub fn get_win_history(&self, from_index: u64, limit: u64) -> Vec<HumanReadableWinnerInfo>; /// get current playground status pub fn get_contract_info(&self) -> HumanReadableContractInfo; /// get current winner tip rate pub fn get_reward_fee_fraction(&self) -> RewardFeeFraction; /// get account's available dice count pub fn get_account_dice_count(&self, account_id: String) -> u8; ``` Quick Start =========== To run this project locally: 1. Prerequisites: Make sure you've installed [Node.js] ≥ 12 2. Install dependencies: `yarn install` 3. Run the local development server: `yarn dev` (see `package.json` for a full list of `scripts` you can run with `yarn`) Now you'll have a local development environment backed by the NEAR TestNet! Go ahead and play with the app and the code. As you make code changes, the app will automatically reload. Exploring The Code ================== 1. The "backend" code lives in the `/contract` folder. See the README there for more info. 2. The frontend code lives in the `/src` folder. `/src/main.js` is a great place to start exploring. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `yarn run test`. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally: yarn install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `NCD-GroupA-Demo.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `NCD-GroupA-Demo.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account NCD-GroupA-Demo.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: set contract name in code --------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'NCD-GroupA-Demo.YOUR-NAME.testnet' Step 3: deploy! --------------- One command: yarn deploy As you can see in `package.json`, this does two things: 1. builds & deploys smart contract to NEAR TestNet 2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere. Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [Vue]: https://vuejs.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/docs/concepts/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages NCD-GroupA-Demo Smart Contract ================== A demo contract for NCD Pojrect Phase-1. Play with this contract ======================== the contract is deployed at testnet with the name `dev-1614240595058-5266655` you can set it to env for later use: ```shell export CONTRACTID=dev-1614240595058-5266655 ``` ## Look around ```shell # return playground info near view $CONTRACTID get_contract_info '' # return winner tip rate near view $CONTRACTID get_reward_fee_fraction '' # return win history list near view $CONTRACTID get_win_history '{"from_index": 0, "limit": 100}' # return dice count that alice has near view $CONTRACTID get_account_dice_count '{"account_id": "alice.testnet"}' ``` ## Let's play ```shell # attached 3 Near to buy 3 dices near call $CONTRACTID buy_dice '' --amount=3 --account_id=alice.testnet #check user's dice, would return 3 here near view $CONTRACTID get_account_dice_count '{"account_id": "alice.testnet"}' # roll dice 3 times, say how luck you are near call $CONTRACTID roll_dice '{"target": 1}' --account_id=alice.testnet near call $CONTRACTID roll_dice '{"target": 3}' --account_id=alice.testnet near call $CONTRACTID roll_dice '{"target": 4}' --account_id=alice.testnet ``` Build Deploy and Init ====================== Before you compile this code, you will need to install Rust with [correct target] ```shell # building it srouce ./build.sh ``` ```shell # dev-deploy or deploy it near dev-deploy res/neardice.wasm # say it was deploy at $CONTRACTID, then init it near call $CONTRACTID new \ '{"owner_id": "boss.testnet", "dice_number": 1, "rolling_fee": "1000000000000000000000000", "reward_fee_fraction": {"numerator": 5, "denominator": 100}}' \ --account_id=$CONTRACTID ``` ```shell # last step to open the playgroud is # to deposit to the jackpod the very first time near call $CONTRACTID deposit_jackpod '' --amount=50 --account_id=boss.testnet ``` Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/roles/developer/contracts/intro [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html

greeny00_Near-Rent-Buy

README.md as-pect.config.js asconfig.json package.json scripts 1.dev-deploy.sh 2.use-contract.sh 3.cleanup.sh README.md functions.sh src as_types.d.ts simple __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts model.ts singleton __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts tsconfig.json utils.ts

# Dream Flight DAap With this project, it was aimed to collect space expeditions on one page, to enable users to access all flight information easily, and to reserve a seat for their desired flight using their NEAR wallet. ## Loom Video https://www.loom.com/share/9239095038814a6fad067699b82f371f ## How To Use First of all, the repo should be cloned or the files should be downloaded to the computer as ZIP from the code section above. After this step, enter the following commands using a suitable application.(This tutorial is made for gitbash here. But with minor punctuation differences, almost all applications follow the same steps.) 1)Command that downloads all packages that the project will use: ```ts yarn; ``` 2)The command that introduces the contract to the compiler and creates our wasm file: ```ts yarn build:release ``` 3)To deploy the project: ```ts near dev-deploy ./build/release/simple.wasm ``` 4)An account ID is created with the deployment of the project. This ID appears as "dev-...........".Copy and paste this ID into <Account ID>. With this step, you will not need to enter account id every time.(Please write without "<,>"these characters.) ```ts export CONTRACT=<AccountId> ``` 5)This step is not mandatory. It helps you to test the correctness of the entered accountId. ```ts echo $CONTRACT ``` After all these steps, you can now switch to using the functions. ## Functions 1-Health Check <br/> With this function, it is checked whether the user has the necessary health to fly. Is a simple dictionary function. The first entry the key is set as the name, and the second entry is set as the health status. If a value other than "healthy" is entered, the function will inform you that you are not available for this flight. How to call: ```ts near call $CONTRACT healthCheck '{"name":"NAME","heart":"healthy"}' -accountId <YOUR TESTNET ACCOUNT> ``` 2-Launching Schedule <br/> This function notifies the system of a new flight with the information it receives from the user. How to call: ```ts near call $CONTRACT Launching_schedule '{"text":"Moon and Back Mission","cost":"250000","capsul":7,"destination":"Moon","departure":"İstanbul","max_seat":7}' --accountId <YOUR TESTNET ACCOUNT> ``` 3-specific_flight <br/> This function displays the Id information received from the user and the rest of the flight that has that ID. How to call: ```ts near call $CONTRACT specific_flight '{"id":<FLİGHT ID HERE>}' --accountId <YOUR TESTNET ACCOUNT> ``` 4-Show_All <br/> This function does not receive any information from the user, when called, it displays all the flights available on the site. How to call: ```ts near call $CONTRACT Show_All '{}' --accountId <YOUR TESTNET ACCOUNT> ``` 5-delete_specific <br/> Deletes the flight associated with that id from the system with the id information it receives from the user. How to call: ```ts near call $CONTRACT delete_specific '{"id":<FLİGHT ID HERE>}' --accountId <YOUR TESTNET ACCOUNT> ``` 6-deleteall <br/> This function does not receive any information from the user, when called, it deletes all the flights available on the site. How to call: ```ts near call $CONTRACT deleteall '{}' --accountId <YOUR TESTNET ACCOUNT> ``` 7-Update <br/> This function updates the flight information associated with the id sent to the function with the information in the second parameter received by the function. In the second parameter, you need to re-enter the information you want to remain the same. The information you enter must be in the desired order. As a result of this operation, the id does not change. How to call: ```ts near call $CONTRACT Update '{"id":<FLİGHT ID HERE>,"updates":{"text":"Moon and Back","cost":"560000","capsul":5,"destination":"Moon","departure":"İstanbul","max_seat":7}}' --accountId <YOUR TESTNET ACCOUNT> ``` 8-BuyingSeat <br/> This function works with the id and passenger id sent to the function. For the transaction to take place, you must have a balance equal to or greater than the seat fee stated in your NEAR wallet. If you have the balance to buy a seat after this check, the number of seats on the flight will be reduced by one. How to call: ```ts near call $CONTRACT BuyingSeat '{"id":<FLİGHT ID HERE>,"passenger":"<YOUR TESTNET ACCOUNT>"}' --accountId <YOUR TESTNET ACCOUNT> ``` ## Setting up your terminal The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project. It uses the following setup: ```sh # set your terminal up to have 2 windows, A and B like this: ┌─────────────────────────────────┬─────────────────────────────────┐ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ └─────────────────────────────────┴─────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1615190770786-2702449 # export OWNER=sherif.testnet ``` - Commands _helper scripts_ ```sh 1.dev-deploy.sh # helper: build and deploy contracts 2.use-contract.sh # helper: call methods on ContractPromise 3.cleanup.sh # helper: delete build and deploy artifacts ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1615190770786-2702449 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068)

kaan-nacaroglu_near-plate-guesser

README.md as-pect.config.js asconfig.json assembly __tests__ as-pect.d.ts example.spec.ts as_types.d.ts index.ts tsconfig.json package.json scripts 1.dev-deploy.sh 2.use-contract.sh

# near-plate-guesser This is a guessing game done with AssemblyScript and NEAR Protocol. Its goal is to match given Turkish plate numbers with writing the correct cities. ## Requirements - Install Node.js - Install Yarn `npm install --global yarn` OR `npm i -g yarn` - Install NEAR CLI `npm install --global near-cli` - You need a NEAR Wallet. You can get a testnet wallet for free. ## How to Run 1. Run `near login`, and login to your testnet account. 2. Clone the repo to your local folder. 3. run `yarn` to load the near-modules 4. run `./scripts/1.dev-deploy.sh` 5. Follow along with the script. 6. run `./scripts/2.use-contract.sh` 7. Guess the city 8. Repeat steps 6-7 as long as you want or until you get bored ### Methods `function fillVector(): PersistentVector<string>` This function fills a PersistentVector with 9 items. Currently these items are manually inserted to the PV for the demo's sake, but this will be a JSON object that the program copies from. `function emptyVector(): PersistentVector<string>` emptyVector() cycles through all the items and uses the .pop() method, empties the whole vector. Note: You might need to run this function to cleanup every item. `function randomPlateNumber(): string` This function gives us a number between 1 and max size of our Vector. (which is currently 9) It prints out the number and asks the question. `function guessThePlate(answer: string): string` This function takes your answer and compares with the value in the vector. If it is true, it gives a correct statement, if it is incorrect it will say that you are incorrect. ## TODO LIST - Frontend - Transaction of money(like a betting pool)

Jteo10_near_learn_example

.gitpod.yml README.md as-pect.config.js asconfig.js assembly __tests__ as-pect.d.ts main.spec.ts as_types.d.ts main.ts model.ts tsconfig.json babel.config.js package.json src App.css App.js App.test.js __mocks__ fileMock.js assets gray_near_logo.svg logo.svg near.svg config.js index.html index.js jest.init.js main.test.js wallet login index.html

<br /> <br /> <p> <img src="https://nearprotocol.com/wp-content/themes/near-19/assets/img/logo.svg?t=1553011311" width="240"> </p> <br /> <br /> ## Template for NEAR dapps ### Requirements ##### IMPORTANT: Make sure you have the latest version of NEAR Shell and Node Version > 10.x 1. [Node.js](https://nodejs.org/en/download/package-manager/) 2. (optional) near-shell ``` npm i -g near-shell ``` 3. (optional) yarn ``` npm i -g yarn ``` ### To run on NEAR testnet ```bash npm install && npm dev ``` with yarn: ```bash yarn && yarn dev ``` The server that starts is for static assets and by default serves them to http://localhost:1234. Navigate there in your browser to see the app running! NOTE: Both contract and client-side code will auto-reload once you change source files. ### To run tests ```bash npm test ``` with yarn: ```bash yarn test ``` ### Deploy #### Step 1: Create account for the contract You'll now want to authorize NEAR shell on your NEAR account, which will allow NEAR Shell to deploy contracts on your NEAR account's behalf \(and spend your NEAR account balance to do so\). Type the command `near login` which opens a webpage at NEAR Wallet. Follow the instructions there and it will create a key for you, stored in the `/neardev` directory. #### Step 2: Modify `src/config.js` line that sets the account name of the contract. Set it to the account id from step 1. NOTE: When you use [create-near-app](https://github.com/nearprotocol/create-near-app) to create the project it'll infer and pre-populate name of contract based on project folder name. ```javascript const CONTRACT_NAME = 'react-template'; /* TODO: Change this to your contract's name! */ const DEFAULT_ENV = 'development'; ... ``` #### Step 3: Check the scripts in the package.json, for frontend and backend both, run the command: ```bash npm run deploy ``` with yarn: ```bash yarn deploy ``` NOTE: This uses [gh-pages](https://github.com/tschaub/gh-pages) to publish resulting website on GitHub pages. It'll only work if project already has repository set up on GitHub. Feel free to modify `deploy:pages` script in `package.json` to deploy elsewhere. ### To Explore - `assembly/main.ts` for the contract code - `src/index.html` for the front-end HTML - `src/index.js` for the JavaScript front-end code and how to integrate contracts - `src/App.js` for the main React component - `src/main.test.js` for the JavaScript integration tests of smart contract - `src/App.test.js` for the main React component tests

NearPass_nearpass-server

README.md config.js package-lock.json package.json server.js utils.js

### NearPass Server This server handles all requests from the [NearPass React Native App](https://github.com/NearPass/nearpass-rn-app). Server is deployed at: [https://nearpass-server-production.up.railway.app](https://nearpass-server-production.up.railway.app) Since, Near doesn't have a solution to connect wallet in react native I created a server that uses Unencrypted KeyStore to store the function keys for the wallet connected to the app. This server lets mobile user connect near wallet and also lets the event manager verify tickets using phone. ### How to run? Install dependencies: ```bash npm install ``` Start the server: ```bash npm start ```

Learn-NEAR_starter--near-sdk-rs2

.cargo config.toml Cargo.toml README.md build.sh scripts 1.dev-deploy.sh 2.use-contract.sh 3.cleanup.sh README.md src lib.rs

## Setting up your terminal The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project. It uses the following setup: ```sh # set your terminal up to have 2 windows, A and B like this: ┌─────────────────────────────────┬─────────────────────────────────┐ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ └─────────────────────────────────┴─────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1615190770786-2702449 # export OWNER=sherif.testnet ``` - Commands _helper scripts_ ```sh 1.dev-deploy.sh # helper: build and deploy contracts 2.use-contract.sh # helper: call methods on ContractPromise 3.cleanup.sh # helper: delete build and deploy artifacts ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1615190770786-2702449 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068) # `near-sdk-rs` Starter Kit This is a good project to use as a starting point for your Rust project. ## Samples This repository includes a very basic project structure for Rust contracts targeting the NEAR platform. The example here is a simple contract demonstrating the following concepts: - a single contract - the difference between `view` vs. `change` methods There is 1 Rust contract in this project: - **status message** in the `src` folder ## Usage ### Getting started (see below for video recordings of each of the following steps) INSTALL `NEAR CLI` first like this: `npm i -g near-cli` INSTALL RUST toolchain Add the wasm target using `rustup target add wasm32-unknown-unknown` 1. clone this repo to a local folder 2. run `./scripts/1.dev-deploy.sh` 3. run `./scripts/2.use-contract.sh` 4. run `./scripts/3.cleanup.sh`

evgenykuzyakov_berryclub-testnet

README.md contract-rs pixel-board Cargo.toml README.md build.sh src account.rs board.rs fungible_token_core.rs fungible_token_metadata.rs internal.rs lib.rs token.rs frontend README.md package.json public index.html manifest.json robots.txt src App.js Weapons.js gh-fork-ribbon.css index.css index.js

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts In the project directory, you can run: ### `yarn start` Runs the app in the development mode.<br /> Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.<br /> You will also see any lint errors in the console. ### `yarn test` Launches the test runner in the interactive watch mode.<br /> See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `yarn build` Builds the app for production to the `build` folder.<br /> It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.<br /> Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. ### `yarn eject` **Note: this is a one-way operation. Once you `eject`, you can’t go back!** If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. ## Learn More You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). To learn React, check out the [React documentation](https://reactjs.org/). ### Code Splitting This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting ### Analyzing the Bundle Size This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size ### Making a Progressive Web App This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app ### Advanced Configuration This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration ### Deployment This section has moved here: https://facebook.github.io/create-react-app/docs/deployment ### `yarn build` fails to minify This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify # NEAR Place Smart contract to keep track of the board. ## Building ```bash ./build.sh ``` ## Testing To test run: ```bash cargo test --package near-place -- --nocapture ``` # NEAR Place Draw with pixels. Your pixels earn you more pixels, so better artists get more pixels to draw.

PrimeLabCore_react-native-os

README.md android gradlew.bat src main AndroidManifest.xml java com peel react RNOS.java RNOSModule.java examples OsInfo __tests__ index.android.js index.ios.js android app src main AndroidManifest.xml java com osinfo MainActivity.java MainApplication.java res values strings.xml styles.xml gradlew.bat index.android.js index.ios.js ios OsInfo AppDelegate.h Images.xcassets AppIcon.appiconset Contents.json package.json index.js ios RNOS.h package-lock.json package.json

# os in React Native node's [os](https://nodejs.org/api/os.html) API in React Native This module is used by [Peel](http://www.peel.com/) ## Install * Create a new react-native project. [Check react-native getting started](http://facebook.github.io/react-native/docs/getting-started.html#content) * In your project dir: ``` npm install react-native-os --save ``` __Note for iOS:__ If your react-native version < 0.40 install with this tag instead: ``` npm install react-native-os@1.0.3 --save ``` ## Link in the native dependency ``` react-native link react-native-os ``` ***Step 3 Profit*** ## Usage ### package.json _only if you want to write require('os') in your javascript_ ```json { "react-native": { "os": "react-native-os" } } ``` ## Contributors [Andy Prock](https://github.com/aprock) PR's welcome!

mahmudsudo_react_for_near

.idea modules.xml vcs.xml README.md package.json public index.html manifest.json robots.txt src App.css App.js App.test.js config.js index.css index.js logo.svg reportWebVitals.js setupTests.js utils.js

# Getting Started with Create React App This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts In the project directory, you can run: ### `npm start` Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in your browser. The page will reload when you make changes.\ You may also see any lint errors in the console. ### `npm test` Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `npm run build` Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. ### `npm run eject` **Note: this is a one-way operation. Once you `eject`, you can't go back!** If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. ## Learn More You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). To learn React, check out the [React documentation](https://reactjs.org/). ### Code Splitting This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) ### Analyzing the Bundle Size This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) ### Making a Progressive Web App This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) ### Advanced Configuration This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) ### Deployment This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) ### `npm run build` fails to minify This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

near_near-discovery-indexer-alpha

.github ISSUE_TEMPLATE BOUNTY.yml README.md example-indexer Cargo.toml README.md diesel.toml migrations 2022-03-18-000000_initial_scam down.sql up.sql 2022-10-10-000000_add_receipts down.sql up.sql src main.rs models enums.rs events.rs mod.rs social.rs retriable.rs schema.rs

# example-indexer This repository contains finished code for Indexer tutorial from official docs https://docs.near.org/docs/tools/near-indexer # Indexer tutorials This repository contains the code for indexer tutorials from official documentation. ## Contents * example-indexer https://docs.near.org/docs/tools/near-indexer

nearprotocol_pairing

Cargo.toml README.md benches bls12_381 ec.rs fq.rs fq12.rs fq2.rs fr.rs mod.rs pairing_benches.rs src bls12_381 README.md ec.rs fq.rs fq12.rs fq2.rs fq6.rs fr.rs mod.rs tests mod.rs lib.rs tests curve.rs engine.rs field.rs mod.rs repr.rs wnaf.rs

# pairing [](https://crates.io/crates/pairing) # This is a Rust crate for using pairing-friendly elliptic curves. Currently, only the [BLS12-381](https://z.cash/blog/new-snark-curve.html) construction is implemented. ## [Documentation](https://docs.rs/pairing/) Bring the `pairing` crate into your project just as you normally would. If you're using a supported platform and the nightly Rust compiler, you can enable the `u128-support` feature for faster arithmetic. ```toml [dependencies.pairing] version = "0.14" features = ["u128-support"] ``` ## Security Warnings This library does not make any guarantees about constant-time operations, memory access patterns, or resistance to side-channel attacks. ## License Licensed under either of * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. # BLS12-381 This is an implementation of the BLS12-381 pairing-friendly elliptic curve construction. ## BLS12 Parameterization BLS12 curves are parameterized by a value *x* such that the base field modulus *q* and subgroup *r* can be computed by: * q = (x - 1)² ((x⁴ - x² + 1) / 3) + x * r = (x⁴ - x² + 1) Given primes *q* and *r* parameterized as above, we can easily construct an elliptic curve over the prime field F_*q* which contains a subgroup of order *r* such that *r* | (*q*¹² - 1), giving it an embedding degree of 12. Instantiating its sextic twist over an extension field F_q² gives rise to an efficient bilinear pairing function between elements of the order *r* subgroups of either curves, into an order *r* multiplicative subgroup of F_q¹². In zk-SNARK schemes, we require F_r with large 2ⁿ roots of unity for performing efficient fast-fourier transforms. As such, guaranteeing that large 2ⁿ | (r - 1), or equivalently that *x* has a large 2ⁿ factor, gives rise to BLS12 curves suitable for zk-SNARKs. Due to recent research, it is estimated by many that *q* should be approximately 384 bits to target 128-bit security. Conveniently, *r* is approximately 256 bits when *q* is approximately 384 bits, making BLS12 curves ideal for 128-bit security. It also makes them ideal for many zk-SNARK applications, as the scalar field can be used for keying material such as embedded curve constructions. Many curves match our descriptions, but we require some extra properties for efficiency purposes: * *q* should be smaller than 2³⁸³, and *r* should be smaller than 2²⁵⁵, so that the most significant bit is unset when using 64-bit or 32-bit limbs. This allows for cheap reductions. * F_q¹² is typically constructed using towers of extension fields. As a byproduct of [research](https://eprint.iacr.org/2011/465.pdf) for BLS curves of embedding degree 24, we can identify subfamilies of BLS12 curves (for our purposes, where x mod 72 = {16, 64}) that produce efficient extension field towers and twisting isomorphisms. * We desire *x* of small Hamming weight, to increase the performance of the pairing function. ## BLS12-381 Instantiation The BLS12-381 construction is instantiated by `x = -0xd201000000010000`, which produces the largest `q` and smallest Hamming weight of `x` that meets the above requirements. This produces: * q = `0x1a0111ea397fe69a4b1ba7b6434bacd764774b84f38512bf6730d2a0f6b0f6241eabfffeb153ffffb9feffffffffaaab` (381 bits) * r = `0x73eda753299d7d483339d80809a1d80553bda402fffe5bfeffffffff00000001` (255 bits) Our extension field tower is constructed as follows: 1. F_q² is constructed as F_q(u) / (u² - β) where β = -1. 2. F_q⁶ is constructed as F_q²(v) / (v³ - ξ) where ξ = u + 1 3. F_q¹² is constructed as F_q⁶(w) / (w² - γ) where γ = v Now, we instantiate the elliptic curve E(F_q) : y² = x³ + 4, and the elliptic curve E'(F_q²) : y² = x³ + 4(u + 1). The group G₁ is the *r* order subgroup of E, which has cofactor (x - 1)² / 3. The group G₂ is the *r* order subgroup of E', which has cofactor (x⁸ - 4x⁷ + 5x⁶ - 4x⁴ + 6x³ - 4x² - 4x + 13) / 9. ### Generators The generators of G₁ and G₂ are computed by finding the lexicographically smallest valid `x`-coordinate, and its lexicographically smallest `y`-coordinate and scaling it by the cofactor such that the result is not the point at infinity. #### G1 ``` x = 3685416753713387016781088315183077757961620795782546409894578378688607592378376318836054947676345821548104185464507 y = 1339506544944476473020471379941921221584933875938349620426543736416511423956333506472724655353366534992391756441569 ``` #### G2 ``` x = 3059144344244213709971259814753781636986470325476647558659373206291635324768958432433509563104347017837885763365758*u + 352701069587466618187139116011060144890029952792775240219908644239793785735715026873347600343865175952761926303160 y = 927553665492332455747201965776037880757740193453592970025027978793976877002675564980949289727957565575433344219582*u + 1985150602287291935568054521177171638300868978215655730859378665066344726373823718423869104263333984641494340347905 ``` ### Serialization * Fq elements are encoded in big-endian form. They occupy 48 bytes in this form. * Fq2 elements are encoded in big-endian form, meaning that the Fq element c0 + c1 * u is represented by the Fq element c1 followed by the Fq element c0. This means Fq2 elements occupy 96 bytes in this form. * The group G1 uses Fq elements for coordinates. The group G2 uses Fq2 elements for coordinates. * G1 and G2 elements can be encoded in uncompressed form (the x-coordinate followed by the y-coordinate) or in compressed form (just the x-coordinate). G1 elements occupy 96 bytes in uncompressed form, and 48 bytes in compressed form. G2 elements occupy 192 bytes in uncompressed form, and 96 bytes in compressed form. The most-significant three bits of a G1 or G2 encoding should be masked away before the coordinate(s) are interpreted. These bits are used to unambiguously represent the underlying element: * The most significant bit, when set, indicates that the point is in compressed form. Otherwise, the point is in uncompressed form. * The second-most significant bit indicates that the point is at infinity. If this bit is set, the remaining bits of the group element's encoding should be set to zero. * The third-most significant bit is set if (and only if) this point is in compressed form _and_ it is not the point at infinity _and_ its y-coordinate is the lexicographically largest of the two associated with the encoded x-coordinate. ### Hashing to the Curve * Elements of Fq are encoded by taking the output of a BLAKE2b digest and interpreting it as a big-endian integer. The integer is reduced (mod q), making it uniform in the field with negligible bias. * Elements of Fq2 are encoded by appending "_c0" to the supplied BLAKE2b preimage, to compute the encoding to Fq for c0, and by appending "_c1" to the same BLAKE2b preimage, to compute the encoding to Fq for c1. * Elements of E and E' are encoded from an element *t* by taking the first valid abscissa (for the b in each respective curve): * x_1 = (-1 + sqrt(-3))/2 - (sqrt(-3) * t^2)/(1 + b + t^2) * x_2 = (-1 - sqrt(-3))/2 + (sqrt(-3) * t^2)/(1 + b + t^2) * x_3 = 1 - (1 + b + t^2)^2 / (3 * t^2) * In this encoding, we always map t=0 to the point at infinity. For the encoding to E, We also map: * `t = 0x019cfaba0c258165d092f6bca9a081871e62a126c499340dc71c0e9527f923f3b299592a7a9503066cc5362484d96dd7` to the fixed generator. (See "Generators" above.) * `t = 0x186417302d5a65347a88b0f999ab2b504614aa5e2eebdeb1a014c40bceb7d2306c12a6d436befcf94d39c9db7b263cd4` to the negative of the fixed generator. (See "Generators" above.) * In this encoding, the y-coordinate of the resulting point is chosen to be the lexicographically largest if (and only if) the input `t` is also lexicographically larger than its negative. * Hashing to G1, given a message `msg`, involves hashing to Fq by supplying the BLAKE2b preimage `msg | "G1_0"` to create `t0`, and hashing to Fq by supplying the BLAKE2b preimage `msg | "G1_1"` to create `t1`. `t0` and `t1` are used to encode into E via the above encoding, the resulting points are added together, and that result is multiplied by the cofactor. * Hashing to G2, given a message `msg`, involves hashing to Fq2 by supplying the BLAKE2b preimage `msg | "G2_0"` to create `t0`, and hashing to Fq2 by supplying the BLAKE2b preimage `msg | "G2_1"` to create `t1`. `t0` and `t1` are used to encode into E' via the above encoding, the resulting points are added together, and that result is multiplied by the cofactor.

evgenykuzyakov_fundraiser

Cargo.toml README.md build_docker.sh build_local.sh migrtation.txt src lib.rs migration_0.rs sale.rs token_receiver.rs

# Fundraising contract Fundraising contract, with two core features: - Create sales, that people can deposit funds into. - Create linkdrops for creating accounts. This gets recorded in the internal table of this contract to see which account helped created which account. ## Registering new accounts As a secondary goal of this fundraising contract is to help onboard more users on NEAR. To facilitate this, contract provides existing users a way to create a linkdrop for onboarding users. Linkdrops are a single usage private key that allows to issue a transaction to the given contract. This call will in turn create a new ".near" account and record that this account was paid by user who created linkdrop. ## Sales distribution process This contract doesn't handle sales distribution process, instead leaving this to the owner. Owner will be able to extra the table of all the users and how much they have deposited for the given sale. After that, owner should airdrop the tokens according to whatever other rules (referral, whitelists, etc). Referral map of account creations can be extracted as well by listing all the users or queried for specific user. # Testing We are going to use `dev-1634658127682-97093903837694` test token as a deposit token. To mint yourself some of it call: ``` near call dev-1634658127682-97093903837694 mint '{"account_id": "dev-1634657876145-24893242863336", "amount": "10000000000000"}' --accountId dev-1634657876145-24893242863336 ``` Next steps dev-deploy the contract: ``` ./build_local.sh near dev-deploy --wasmFile=res/fundraiser_local.wasm near call dev-1634657876145-24893242863336 new '{"owner_id": "dev-1634657876145-24893242863336", "join_fee": "100000", "referral_fees": [10, 20, 30]}' --accountId dev-1634657876145-24893242863336 ``` Replace `dev-1634657876145-24893242863336` with what dev-deploy command will output. Create new sale with the token above: ``` near call dev-1634657876145-24893242863336 create_sale '{"sale": {"metadata": {"name": "test", "symbol": "TEST", "description": "test", "logo_url": "", "smart_contract_url": ""}, "min_near_deposit": "0", "deposit_token_id": "dev-1634658127682-97093903837694", "min_buy": "1", "max_buy": "10000", "start_date": "10000000", "end_date": "100000000", "price": "1000"}}' --accountId dev-1634657876145-24893242863336 ``` View sale info: ``` near view dev-1634657876145-24893242863336 get_sale '{"sale_id": 2}' ```

MattHillWakatipu_rust-testing

Cargo.toml README.md build.bat build.sh src lib.rs

# Rust Smart Contract Template ## Getting started To get started with this template: 1. Click the "Use this template" button to create a new repo based on this template 2. Update line 2 of `Cargo.toml` with your project name 3. Update line 4 of `Cargo.toml` with your project author names 4. Set up the [prerequisites](https://github.com/near/near-sdk-rs#pre-requisites) 5. Begin writing your smart contract in `src/lib.rs` 6. Test the contract `cargo test -- --nocapture` 8. Build the contract `RUSTFLAGS='-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release` **Get more info at:** * [Rust Smart Contract Quick Start](https://docs.near.org/docs/develop/contracts/rust/intro) * [Rust SDK Book](https://www.near-sdk.io/)

Kondwani7_test_near_app

.gitpod.yml README.md babel.config.js contract README.md as-pect.config.js asconfig.json assembly __tests__ as-pect.d.ts main.spec.ts as_types.d.ts index.ts tsconfig.json compile.js node_modules .package-lock.json @as-covers assembly CONTRIBUTING.md README.md index.ts package.json tsconfig.json core CONTRIBUTING.md README.md package.json glue README.md lib index.d.ts index.js package.json transform README.md lib index.d.ts index.js util.d.ts util.js node_modules visitor-as .github workflows test.yml README.md as index.d.ts index.js asconfig.json dist astBuilder.d.ts astBuilder.js base.d.ts base.js baseTransform.d.ts baseTransform.js decorator.d.ts decorator.js examples capitalize.d.ts capitalize.js exportAs.d.ts exportAs.js functionCallTransform.d.ts functionCallTransform.js includeBytesTransform.d.ts includeBytesTransform.js list.d.ts list.js toString.d.ts toString.js index.d.ts index.js path.d.ts path.js simpleParser.d.ts simpleParser.js transformRange.d.ts transformRange.js transformer.d.ts transformer.js utils.d.ts utils.js visitor.d.ts visitor.js package.json tsconfig.json package.json @as-pect assembly README.md assembly index.ts internal Actual.ts Expectation.ts Expected.ts Reflect.ts ReflectedValueType.ts Test.ts assert.ts call.ts comparison toIncludeComparison.ts toIncludeEqualComparison.ts log.ts noOp.ts package.json types as-pect.d.ts as-pect.portable.d.ts env.d.ts cli README.md init as-pect.config.js env.d.ts example.spec.ts init-types.d.ts portable-types.d.ts lib as-pect.cli.amd.d.ts as-pect.cli.amd.js help.d.ts help.js index.d.ts index.js init.d.ts init.js portable.d.ts portable.js run.d.ts run.js test.d.ts test.js types.d.ts types.js util CommandLineArg.d.ts CommandLineArg.js IConfiguration.d.ts IConfiguration.js asciiArt.d.ts asciiArt.js collectReporter.d.ts collectReporter.js getTestEntryFiles.d.ts getTestEntryFiles.js removeFile.d.ts removeFile.js strings.d.ts strings.js writeFile.d.ts writeFile.js worklets ICommand.d.ts ICommand.js compiler.d.ts compiler.js package.json core README.md lib as-pect.core.amd.d.ts as-pect.core.amd.js index.d.ts index.js reporter CombinationReporter.d.ts CombinationReporter.js EmptyReporter.d.ts EmptyReporter.js IReporter.d.ts IReporter.js SummaryReporter.d.ts SummaryReporter.js VerboseReporter.d.ts VerboseReporter.js test IWarning.d.ts IWarning.js TestContext.d.ts TestContext.js TestNode.d.ts TestNode.js transform assemblyscript.d.ts assemblyscript.js createAddReflectedValueKeyValuePairsMember.d.ts createAddReflectedValueKeyValuePairsMember.js createGenericTypeParameter.d.ts createGenericTypeParameter.js createStrictEqualsMember.d.ts createStrictEqualsMember.js emptyTransformer.d.ts emptyTransformer.js hash.d.ts hash.js index.d.ts index.js util IAspectExports.d.ts IAspectExports.js IWriteable.d.ts IWriteable.js ReflectedValue.d.ts ReflectedValue.js TestNodeType.d.ts TestNodeType.js rTrace.d.ts rTrace.js stringifyReflectedValue.d.ts stringifyReflectedValue.js timeDifference.d.ts timeDifference.js wasmTools.d.ts wasmTools.js package.json csv-reporter index.ts lib as-pect.csv-reporter.amd.d.ts as-pect.csv-reporter.amd.js index.d.ts index.js package.json readme.md tsconfig.json json-reporter index.ts lib as-pect.json-reporter.amd.d.ts as-pect.json-reporter.amd.js index.d.ts index.js package.json readme.md tsconfig.json snapshots __tests__ snapshot.spec.ts jest.config.js lib Snapshot.d.ts Snapshot.js SnapshotDiff.d.ts SnapshotDiff.js SnapshotDiffResult.d.ts SnapshotDiffResult.js as-pect.core.amd.d.ts as-pect.core.amd.js index.d.ts index.js parser grammar.d.ts grammar.js package.json src Snapshot.ts SnapshotDiff.ts SnapshotDiffResult.ts index.ts parser grammar.ts tsconfig.json @assemblyscript loader README.md index.d.ts index.js package.json umd index.d.ts index.js package.json @babel code-frame README.md lib index.js package.json helper-validator-identifier README.md lib identifier.js index.js keyword.js package.json scripts generate-identifier-regex.js highlight README.md lib index.js node_modules ansi-styles index.js package.json readme.md chalk index.js package.json readme.md templates.js types index.d.ts color-convert CHANGELOG.md README.md conversions.js index.js package.json route.js color-name .eslintrc.json README.md index.js package.json test.js escape-string-regexp index.js package.json readme.md has-flag index.js package.json readme.md supports-color browser.js index.js package.json readme.md package.json @eslint eslintrc CHANGELOG.md README.md conf config-schema.js environments.js eslint-all.js eslint-recommended.js lib cascading-config-array-factory.js config-array-factory.js config-array config-array.js config-dependency.js extracted-config.js ignore-pattern.js index.js override-tester.js flat-compat.js index.js shared ajv.js config-ops.js config-validator.js deprecation-warnings.js naming.js relative-module-resolver.js types.js package.json @humanwhocodes config-array README.md api.js package.json object-schema .eslintrc.js .github workflows nodejs-test.yml release-please.yml CHANGELOG.md README.md package.json src index.js merge-strategy.js object-schema.js validation-strategy.js tests merge-strategy.js object-schema.js validation-strategy.js acorn-jsx README.md index.d.ts index.js package.json xhtml.js acorn CHANGELOG.md README.md dist acorn.d.ts acorn.js acorn.mjs.d.ts bin.js package.json ajv .tonic_example.js README.md dist ajv.bundle.js ajv.min.js lib ajv.d.ts ajv.js cache.js compile async.js equal.js error_classes.js formats.js index.js resolve.js rules.js schema_obj.js ucs2length.js util.js data.js definition_schema.js dotjs README.md _limit.js _limitItems.js _limitLength.js _limitProperties.js allOf.js anyOf.js comment.js const.js contains.js custom.js dependencies.js enum.js format.js if.js index.js items.js multipleOf.js not.js oneOf.js pattern.js properties.js propertyNames.js ref.js required.js uniqueItems.js validate.js keyword.js refs data.json json-schema-draft-04.json json-schema-draft-06.json json-schema-draft-07.json json-schema-secure.json package.json scripts .eslintrc.yml bundle.js compile-dots.js ansi-colors README.md index.js package.json symbols.js types index.d.ts ansi-regex index.d.ts index.js package.json readme.md ansi-styles index.d.ts index.js package.json readme.md argparse CHANGELOG.md README.md index.js lib action.js action append.js append constant.js count.js help.js store.js store constant.js false.js true.js subparsers.js version.js action_container.js argparse.js argument error.js exclusive.js group.js argument_parser.js const.js help added_formatters.js formatter.js namespace.js utils.js package.json as-bignum README.md assembly __tests__ as-pect.d.ts i128.spec.as.ts safe_u128.spec.as.ts u128.spec.as.ts u256.spec.as.ts utils.ts fixed fp128.ts fp256.ts index.ts safe fp128.ts fp256.ts types.ts globals.ts index.ts integer i128.ts i256.ts index.ts safe i128.ts i256.ts i64.ts index.ts u128.ts u256.ts u64.ts u128.ts u256.ts tsconfig.json utils.ts package.json asbuild README.md dist cli.d.ts cli.js commands build.d.ts build.js fmt.d.ts fmt.js index.d.ts index.js init cmd.d.ts cmd.js files asconfigJson.d.ts asconfigJson.js aspecConfig.d.ts aspecConfig.js assembly_files.d.ts assembly_files.js eslintConfig.d.ts eslintConfig.js gitignores.d.ts gitignores.js index.d.ts index.js indexJs.d.ts indexJs.js packageJson.d.ts packageJson.js test_files.d.ts test_files.js index.d.ts index.js interfaces.d.ts interfaces.js run.d.ts run.js test.d.ts test.js index.d.ts index.js main.d.ts main.js utils.d.ts utils.js index.js node_modules cliui CHANGELOG.md LICENSE.txt README.md index.js package.json wrap-ansi index.js package.json readme.md y18n CHANGELOG.md README.md index.js package.json yargs-parser CHANGELOG.md LICENSE.txt README.md index.js lib tokenize-arg-string.js package.json yargs CHANGELOG.md README.md build lib apply-extends.d.ts apply-extends.js argsert.d.ts argsert.js command.d.ts command.js common-types.d.ts common-types.js completion-templates.d.ts completion-templates.js completion.d.ts completion.js is-promise.d.ts is-promise.js levenshtein.d.ts levenshtein.js middleware.d.ts middleware.js obj-filter.d.ts obj-filter.js parse-command.d.ts parse-command.js process-argv.d.ts process-argv.js usage.d.ts usage.js validation.d.ts validation.js yargs.d.ts yargs.js yerror.d.ts yerror.js index.js locales be.json de.json en.json es.json fi.json fr.json hi.json hu.json id.json it.json ja.json ko.json nb.json nl.json nn.json pirate.json pl.json pt.json pt_BR.json ru.json th.json tr.json zh_CN.json zh_TW.json package.json yargs.js package.json assemblyscript-json .eslintrc.js .travis.yml README.md assembly JSON.ts decoder.ts encoder.ts index.ts tsconfig.json util index.ts index.js package.json temp-docs README.md classes decoderstate.md json.arr.md json.bool.md json.float.md json.integer.md json.null.md json.num.md json.obj.md json.str.md json.value.md jsondecoder.md jsonencoder.md jsonhandler.md throwingjsonhandler.md modules json.md assemblyscript-regex .eslintrc.js .github workflows benchmark.yml release.yml test.yml README.md as-pect.config.js asconfig.empty.json asconfig.json assembly __spec_tests__ generated.spec.ts __tests__ alterations.spec.ts as-pect.d.ts boundary-assertions.spec.ts capture-group.spec.ts character-classes.spec.ts character-sets.spec.ts characters.ts empty.ts quantifiers.spec.ts range-quantifiers.spec.ts regex.spec.ts utils.ts char.ts env.ts index.ts nfa matcher.ts nfa.ts types.ts walker.ts parser node.ts parser.ts string-iterator.ts walker.ts regexp.ts tsconfig.json util.ts benchmark benchmark.js package.json spec test-generator.js ts index.ts tsconfig.json assemblyscript-temporal .github workflows node.js.yml release.yml .vscode launch.json README.md as-pect.config.js asconfig.empty.json asconfig.json assembly __tests__ README.md as-pect.d.ts date.spec.ts duration.spec.ts empty.ts plaindate.spec.ts plaindatetime.spec.ts plainmonthday.spec.ts plaintime.spec.ts plainyearmonth.spec.ts timezone.spec.ts zoneddatetime.spec.ts constants.ts date.ts duration.ts enums.ts env.ts index.ts instant.ts now.ts plaindate.ts plaindatetime.ts plainmonthday.ts plaintime.ts plainyearmonth.ts timezone.ts tsconfig.json tz __tests__ index.spec.ts rule.spec.ts zone.spec.ts iana.ts index.ts rule.ts zone.ts utils.ts zoneddatetime.ts development.md package.json tzdb README.md iana theory.html zoneinfo2tdf.pl assemblyscript README.md cli README.md asc.d.ts asc.js asc.json shim README.md fs.js path.js process.js transform.d.ts transform.js util colors.d.ts colors.js find.d.ts find.js mkdirp.d.ts mkdirp.js options.d.ts options.js utf8.d.ts utf8.js dist asc.js assemblyscript.d.ts assemblyscript.js sdk.js index.d.ts index.js lib loader README.md index.d.ts index.js package.json umd index.d.ts index.js package.json rtrace README.md bin rtplot.js index.d.ts index.js package.json umd index.d.ts index.js package.json package-lock.json package.json std README.md assembly.json assembly array.ts arraybuffer.ts atomics.ts bindings Date.ts Math.ts Reflect.ts asyncify.ts console.ts wasi.ts wasi_snapshot_preview1.ts wasi_unstable.ts builtins.ts compat.ts console.ts crypto.ts dataview.ts date.ts diagnostics.ts error.ts function.ts index.d.ts iterator.ts map.ts math.ts memory.ts number.ts object.ts polyfills.ts process.ts reference.ts regexp.ts rt.ts rt README.md common.ts index-incremental.ts index-minimal.ts index-stub.ts index.d.ts itcms.ts rtrace.ts stub.ts tcms.ts tlsf.ts set.ts shared feature.ts target.ts tsconfig.json typeinfo.ts staticarray.ts string.ts symbol.ts table.ts tsconfig.json typedarray.ts uri.ts util casemap.ts error.ts hash.ts math.ts memory.ts number.ts sort.ts string.ts uri.ts vector.ts wasi index.ts portable.json portable index.d.ts index.js types assembly index.d.ts package.json portable index.d.ts package.json tsconfig-base.json astral-regex index.d.ts index.js package.json readme.md axios CHANGELOG.md README.md UPGRADE_GUIDE.md dist axios.js axios.min.js index.d.ts index.js lib adapters README.md http.js xhr.js axios.js cancel Cancel.js CancelToken.js isCancel.js core Axios.js InterceptorManager.js README.md buildFullPath.js createError.js dispatchRequest.js enhanceError.js mergeConfig.js settle.js transformData.js defaults.js helpers README.md bind.js buildURL.js combineURLs.js cookies.js deprecatedMethod.js isAbsoluteURL.js isURLSameOrigin.js normalizeHeaderName.js parseHeaders.js spread.js utils.js package.json balanced-match .github FUNDING.yml LICENSE.md README.md index.js package.json base-x LICENSE.md README.md package.json src index.d.ts index.js binary-install README.md example binary.js package.json run.js index.js package.json src binary.js binaryen README.md index.d.ts package-lock.json package.json wasm.d.ts bn.js CHANGELOG.md README.md lib bn.js package.json brace-expansion README.md index.js package.json bs58 CHANGELOG.md README.md index.js package.json callsites index.d.ts index.js package.json readme.md camelcase index.d.ts index.js package.json readme.md chalk index.d.ts package.json readme.md source index.js templates.js util.js chownr README.md chownr.js package.json cliui CHANGELOG.md LICENSE.txt README.md build lib index.js string-utils.js package.json color-convert CHANGELOG.md README.md conversions.js index.js package.json route.js color-name README.md index.js package.json commander CHANGELOG.md Readme.md index.js package.json typings index.d.ts concat-map .travis.yml example map.js index.js package.json test map.js cross-spawn CHANGELOG.md README.md index.js lib enoent.js parse.js util escape.js readShebang.js resolveCommand.js package.json csv-stringify README.md lib browser index.js sync.js es5 index.d.ts index.js sync.d.ts sync.js index.d.ts index.js sync.d.ts sync.js package.json debug README.md package.json src browser.js common.js index.js node.js decamelize index.js package.json readme.md deep-is .travis.yml example cmp.js index.js package.json test NaN.js cmp.js neg-vs-pos-0.js diff CONTRIBUTING.md README.md dist diff.js lib convert dmp.js xml.js diff array.js base.js character.js css.js json.js line.js sentence.js word.js index.es6.js index.js patch apply.js create.js merge.js parse.js util array.js distance-iterator.js params.js package.json release-notes.md runtime.js discontinuous-range .travis.yml README.md index.js package.json test main-test.js doctrine CHANGELOG.md README.md lib doctrine.js typed.js utility.js package.json emoji-regex LICENSE-MIT.txt README.md es2015 index.js text.js index.d.ts index.js package.json text.js enquirer CHANGELOG.md README.md index.d.ts index.js lib ansi.js combos.js completer.js interpolate.js keypress.js placeholder.js prompt.js prompts autocomplete.js basicauth.js confirm.js editable.js form.js index.js input.js invisible.js list.js multiselect.js numeral.js password.js quiz.js scale.js select.js snippet.js sort.js survey.js text.js toggle.js render.js roles.js state.js styles.js symbols.js theme.js timer.js types array.js auth.js boolean.js index.js number.js string.js utils.js package.json env-paths index.d.ts index.js package.json readme.md escalade dist index.js index.d.ts package.json readme.md sync index.d.ts index.js escape-string-regexp index.d.ts index.js package.json readme.md eslint-scope CHANGELOG.md README.md lib definition.js index.js pattern-visitor.js reference.js referencer.js scope-manager.js scope.js variable.js package.json eslint-utils README.md index.js node_modules eslint-visitor-keys CHANGELOG.md README.md lib index.js visitor-keys.json package.json package.json eslint-visitor-keys CHANGELOG.md README.md lib index.js visitor-keys.json package.json eslint CHANGELOG.md README.md bin eslint.js conf category-list.json config-schema.js default-cli-options.js eslint-all.js eslint-recommended.js replacements.json lib api.js cli-engine cli-engine.js file-enumerator.js formatters checkstyle.js codeframe.js compact.js html.js jslint-xml.js json-with-metadata.js json.js junit.js stylish.js table.js tap.js unix.js visualstudio.js hash.js index.js lint-result-cache.js load-rules.js xml-escape.js cli.js config default-config.js flat-config-array.js flat-config-schema.js rule-validator.js eslint eslint.js index.js init autoconfig.js config-file.js config-initializer.js config-rule.js npm-utils.js source-code-utils.js linter apply-disable-directives.js code-path-analysis code-path-analyzer.js code-path-segment.js code-path-state.js code-path.js debug-helpers.js fork-context.js id-generator.js config-comment-parser.js index.js interpolate.js linter.js node-event-generator.js report-translator.js rule-fixer.js rules.js safe-emitter.js source-code-fixer.js timing.js options.js rule-tester index.js rule-tester.js rules accessor-pairs.js array-bracket-newline.js array-bracket-spacing.js array-callback-return.js array-element-newline.js arrow-body-style.js arrow-parens.js arrow-spacing.js block-scoped-var.js block-spacing.js brace-style.js callback-return.js camelcase.js capitalized-comments.js class-methods-use-this.js comma-dangle.js comma-spacing.js comma-style.js complexity.js computed-property-spacing.js consistent-return.js consistent-this.js constructor-super.js curly.js default-case-last.js default-case.js default-param-last.js dot-location.js dot-notation.js eol-last.js eqeqeq.js for-direction.js func-call-spacing.js func-name-matching.js func-names.js func-style.js function-call-argument-newline.js function-paren-newline.js generator-star-spacing.js getter-return.js global-require.js grouped-accessor-pairs.js guard-for-in.js handle-callback-err.js id-blacklist.js id-denylist.js id-length.js id-match.js implicit-arrow-linebreak.js indent-legacy.js indent.js index.js init-declarations.js jsx-quotes.js key-spacing.js keyword-spacing.js line-comment-position.js linebreak-style.js lines-around-comment.js lines-around-directive.js lines-between-class-members.js max-classes-per-file.js max-depth.js max-len.js max-lines-per-function.js max-lines.js max-nested-callbacks.js max-params.js max-statements-per-line.js max-statements.js multiline-comment-style.js multiline-ternary.js new-cap.js new-parens.js newline-after-var.js newline-before-return.js newline-per-chained-call.js no-alert.js no-array-constructor.js no-async-promise-executor.js no-await-in-loop.js no-bitwise.js no-buffer-constructor.js no-caller.js no-case-declarations.js no-catch-shadow.js no-class-assign.js no-compare-neg-zero.js no-cond-assign.js no-confusing-arrow.js no-console.js no-const-assign.js no-constant-condition.js no-constructor-return.js no-continue.js no-control-regex.js no-debugger.js no-delete-var.js no-div-regex.js no-dupe-args.js no-dupe-class-members.js no-dupe-else-if.js no-dupe-keys.js no-duplicate-case.js no-duplicate-imports.js no-else-return.js no-empty-character-class.js no-empty-function.js no-empty-pattern.js no-empty.js no-eq-null.js no-eval.js no-ex-assign.js no-extend-native.js no-extra-bind.js no-extra-boolean-cast.js no-extra-label.js no-extra-parens.js no-extra-semi.js no-fallthrough.js no-floating-decimal.js no-func-assign.js no-global-assign.js no-implicit-coercion.js no-implicit-globals.js no-implied-eval.js no-import-assign.js no-inline-comments.js no-inner-declarations.js no-invalid-regexp.js no-invalid-this.js no-irregular-whitespace.js no-iterator.js no-label-var.js no-labels.js no-lone-blocks.js no-lonely-if.js no-loop-func.js no-loss-of-precision.js no-magic-numbers.js no-misleading-character-class.js no-mixed-operators.js no-mixed-requires.js no-mixed-spaces-and-tabs.js no-multi-assign.js no-multi-spaces.js no-multi-str.js no-multiple-empty-lines.js no-native-reassign.js no-negated-condition.js no-negated-in-lhs.js no-nested-ternary.js no-new-func.js no-new-object.js no-new-require.js no-new-symbol.js no-new-wrappers.js no-new.js no-nonoctal-decimal-escape.js no-obj-calls.js no-octal-escape.js no-octal.js no-param-reassign.js no-path-concat.js no-plusplus.js no-process-env.js no-process-exit.js no-promise-executor-return.js no-proto.js no-prototype-builtins.js no-redeclare.js no-regex-spaces.js no-restricted-exports.js no-restricted-globals.js no-restricted-imports.js no-restricted-modules.js no-restricted-properties.js no-restricted-syntax.js no-return-assign.js no-return-await.js no-script-url.js no-self-assign.js no-self-compare.js no-sequences.js no-setter-return.js no-shadow-restricted-names.js no-shadow.js no-spaced-func.js no-sparse-arrays.js no-sync.js no-tabs.js no-template-curly-in-string.js no-ternary.js no-this-before-super.js no-throw-literal.js no-trailing-spaces.js no-undef-init.js no-undef.js no-undefined.js no-underscore-dangle.js no-unexpected-multiline.js no-unmodified-loop-condition.js no-unneeded-ternary.js no-unreachable-loop.js no-unreachable.js no-unsafe-finally.js no-unsafe-negation.js no-unsafe-optional-chaining.js no-unused-expressions.js no-unused-labels.js no-unused-vars.js no-use-before-define.js no-useless-backreference.js no-useless-call.js no-useless-catch.js no-useless-computed-key.js no-useless-concat.js no-useless-constructor.js no-useless-escape.js no-useless-rename.js no-useless-return.js no-var.js no-void.js no-warning-comments.js no-whitespace-before-property.js no-with.js nonblock-statement-body-position.js object-curly-newline.js object-curly-spacing.js object-property-newline.js object-shorthand.js one-var-declaration-per-line.js one-var.js operator-assignment.js operator-linebreak.js padded-blocks.js padding-line-between-statements.js prefer-arrow-callback.js prefer-const.js prefer-destructuring.js prefer-exponentiation-operator.js prefer-named-capture-group.js prefer-numeric-literals.js prefer-object-spread.js prefer-promise-reject-errors.js prefer-reflect.js prefer-regex-literals.js prefer-rest-params.js prefer-spread.js prefer-template.js quote-props.js quotes.js radix.js require-atomic-updates.js require-await.js require-jsdoc.js require-unicode-regexp.js require-yield.js rest-spread-spacing.js semi-spacing.js semi-style.js semi.js sort-imports.js sort-keys.js sort-vars.js space-before-blocks.js space-before-function-paren.js space-in-parens.js space-infix-ops.js space-unary-ops.js spaced-comment.js strict.js switch-colon-spacing.js symbol-description.js template-curly-spacing.js template-tag-spacing.js unicode-bom.js use-isnan.js utils ast-utils.js fix-tracker.js keywords.js lazy-loading-rule-map.js patterns letters.js unicode index.js is-combining-character.js is-emoji-modifier.js is-regional-indicator-symbol.js is-surrogate-pair.js valid-jsdoc.js valid-typeof.js vars-on-top.js wrap-iife.js wrap-regex.js yield-star-spacing.js yoda.js shared ajv.js ast-utils.js config-validator.js deprecation-warnings.js logging.js relative-module-resolver.js runtime-info.js string-utils.js traverser.js types.js source-code index.js source-code.js token-store backward-token-comment-cursor.js backward-token-cursor.js cursor.js cursors.js decorative-cursor.js filter-cursor.js forward-token-comment-cursor.js forward-token-cursor.js index.js limit-cursor.js padded-token-cursor.js skip-cursor.js utils.js messages all-files-ignored.js extend-config-missing.js failed-to-read-json.js file-not-found.js no-config-found.js plugin-conflict.js plugin-invalid.js plugin-missing.js print-config-with-directory-path.js whitespace-found.js package.json espree CHANGELOG.md README.md espree.js lib ast-node-types.js espree.js features.js options.js token-translator.js visitor-keys.js node_modules eslint-visitor-keys CHANGELOG.md README.md lib index.js visitor-keys.json package.json package.json esprima README.md bin esparse.js esvalidate.js dist esprima.js package.json esquery README.md dist esquery.esm.js esquery.esm.min.js esquery.js esquery.lite.js esquery.lite.min.js esquery.min.js license.txt node_modules estraverse README.md estraverse.js gulpfile.js package.json package.json parser.js esrecurse README.md esrecurse.js gulpfile.babel.js node_modules estraverse README.md estraverse.js gulpfile.js package.json package.json estraverse README.md estraverse.js gulpfile.js package.json esutils README.md lib ast.js code.js keyword.js utils.js package.json fast-deep-equal README.md es6 index.d.ts index.js react.d.ts react.js index.d.ts index.js package.json react.d.ts react.js fast-json-stable-stringify .eslintrc.yml .github FUNDING.yml .travis.yml README.md benchmark index.js test.json example key_cmp.js nested.js str.js value_cmp.js index.d.ts index.js package.json test cmp.js nested.js str.js to-json.js fast-levenshtein LICENSE.md README.md levenshtein.js package.json file-entry-cache README.md cache.js changelog.md package.json find-up index.d.ts index.js package.json readme.md flat-cache README.md changelog.md package.json src cache.js del.js utils.js flatted .github FUNDING.yml workflows node.js.yml README.md SPECS.md cjs index.js package.json es.js esm index.js index.js min.js package.json php flatted.php types.d.ts follow-redirects README.md http.js https.js index.js node_modules debug .coveralls.yml .travis.yml CHANGELOG.md README.md karma.conf.js node.js package.json src browser.js debug.js index.js node.js ms index.js license.md package.json readme.md package.json fs-minipass README.md index.js package.json fs.realpath README.md index.js old.js package.json function-bind .jscs.json .travis.yml README.md implementation.js index.js package.json test index.js functional-red-black-tree README.md bench test.js package.json rbtree.js test test.js get-caller-file LICENSE.md README.md index.d.ts index.js package.json glob-parent CHANGELOG.md README.md index.js package.json glob README.md common.js glob.js package.json sync.js globals globals.json index.d.ts index.js package.json readme.md has-flag index.d.ts index.js package.json readme.md has README.md package.json src index.js test index.js hasurl README.md index.js package.json ignore CHANGELOG.md README.md index.d.ts index.js legacy.js package.json import-fresh index.d.ts index.js package.json readme.md imurmurhash README.md imurmurhash.js imurmurhash.min.js package.json inflight README.md inflight.js package.json inherits README.md inherits.js inherits_browser.js package.json interpret README.md index.js mjs-stub.js package.json is-core-module CHANGELOG.md README.md core.json index.js package.json test index.js is-extglob README.md index.js package.json is-fullwidth-code-point index.d.ts index.js package.json readme.md is-glob README.md index.js package.json isarray .travis.yml README.md component.json index.js package.json test.js isexe README.md index.js mode.js package.json test basic.js windows.js isobject README.md index.js package.json js-base64 LICENSE.md README.md base64.d.ts base64.js package.json js-tokens CHANGELOG.md README.md index.js package.json js-yaml CHANGELOG.md README.md bin js-yaml.js dist js-yaml.js js-yaml.min.js index.js lib js-yaml.js js-yaml common.js dumper.js exception.js loader.js mark.js schema.js schema core.js default_full.js default_safe.js failsafe.js json.js type.js type binary.js bool.js float.js int.js js function.js regexp.js undefined.js map.js merge.js null.js omap.js pairs.js seq.js set.js str.js timestamp.js package.json json-schema-traverse .eslintrc.yml .travis.yml README.md index.js package.json spec .eslintrc.yml fixtures schema.js index.spec.js json-stable-stringify-without-jsonify .travis.yml example key_cmp.js nested.js str.js value_cmp.js index.js package.json test cmp.js nested.js replacer.js space.js str.js to-json.js levn README.md lib cast.js index.js parse-string.js package.json line-column README.md lib line-column.js package.json locate-path index.d.ts index.js package.json readme.md lodash.clonedeep README.md index.js package.json lodash.merge README.md index.js package.json lodash.sortby README.md index.js package.json lodash.truncate README.md index.js package.json long README.md dist long.js index.js package.json src long.js lru-cache README.md index.js package.json minimatch README.md minimatch.js package.json minimist .travis.yml example parse.js index.js package.json test all_bool.js bool.js dash.js default_bool.js dotted.js kv_short.js long.js num.js parse.js parse_modified.js proto.js short.js stop_early.js unknown.js whitespace.js minipass README.md index.js package.json minizlib README.md constants.js index.js package.json mkdirp bin cmd.js usage.txt index.js package.json moo README.md moo.js package.json ms index.js license.md package.json readme.md natural-compare README.md index.js package.json near-mock-vm assembly __tests__ main.ts context.ts index.ts outcome.ts vm.ts bin bin.js package.json pkg near_mock_vm.d.ts near_mock_vm.js package.json vm dist cli.d.ts cli.js context.d.ts context.js index.d.ts index.js memory.d.ts memory.js runner.d.ts runner.js utils.d.ts utils.js index.js near-sdk-as as-pect.config.js as_types.d.ts asconfig.json asp.asconfig.json assembly __tests__ as-pect.d.ts assert.spec.ts avl-tree.spec.ts bignum.spec.ts contract.spec.ts contract.ts data.txt empty.ts generic.ts includeBytes.spec.ts main.ts max-heap.spec.ts model.ts near.spec.ts persistent-set.spec.ts promise.spec.ts rollback.spec.ts roundtrip.spec.ts runtime.spec.ts unordered-map.spec.ts util.ts utils.spec.ts as_types.d.ts bindgen.ts index.ts json.lib.ts tsconfig.json vm __tests__ vm.include.ts index.ts compiler.js imports.js package.json near-sdk-bindgen README.md assembly index.ts compiler.js dist JSONBuilder.d.ts JSONBuilder.js classExporter.d.ts classExporter.js index.d.ts index.js transformer.d.ts transformer.js typeChecker.d.ts typeChecker.js utils.d.ts utils.js index.js package.json near-sdk-core README.md asconfig.json assembly as_types.d.ts base58.ts base64.ts bignum.ts collections avlTree.ts index.ts maxHeap.ts persistentDeque.ts persistentMap.ts persistentSet.ts persistentUnorderedMap.ts persistentVector.ts util.ts contract.ts datetime.ts env env.ts index.ts runtime_api.ts index.ts logging.ts math.ts promise.ts storage.ts tsconfig.json util.ts docs assets css main.css js main.js search.json classes _sdk_core_assembly_collections_avltree_.avltree.html _sdk_core_assembly_collections_avltree_.avltreenode.html _sdk_core_assembly_collections_avltree_.childparentpair.html _sdk_core_assembly_collections_avltree_.nullable.html _sdk_core_assembly_collections_persistentdeque_.persistentdeque.html _sdk_core_assembly_collections_persistentmap_.persistentmap.html _sdk_core_assembly_collections_persistentset_.persistentset.html _sdk_core_assembly_collections_persistentunorderedmap_.persistentunorderedmap.html _sdk_core_assembly_collections_persistentvector_.persistentvector.html _sdk_core_assembly_contract_.context-1.html _sdk_core_assembly_contract_.contractpromise.html _sdk_core_assembly_contract_.contractpromiseresult.html _sdk_core_assembly_math_.rng.html _sdk_core_assembly_promise_.contractpromisebatch.html _sdk_core_assembly_storage_.storage-1.html globals.html index.html modules _sdk_core_assembly_base58_.base58.html _sdk_core_assembly_base58_.html _sdk_core_assembly_base64_.base64.html _sdk_core_assembly_base64_.html _sdk_core_assembly_collections_avltree_.html _sdk_core_assembly_collections_index_.collections.html _sdk_core_assembly_collections_index_.html _sdk_core_assembly_collections_persistentdeque_.html _sdk_core_assembly_collections_persistentmap_.html _sdk_core_assembly_collections_persistentset_.html _sdk_core_assembly_collections_persistentunorderedmap_.html _sdk_core_assembly_collections_persistentvector_.html _sdk_core_assembly_collections_util_.html _sdk_core_assembly_contract_.html _sdk_core_assembly_env_env_.env.html _sdk_core_assembly_env_env_.html _sdk_core_assembly_env_index_.html _sdk_core_assembly_env_runtime_api_.html _sdk_core_assembly_index_.html _sdk_core_assembly_logging_.html _sdk_core_assembly_logging_.logging.html _sdk_core_assembly_math_.html _sdk_core_assembly_math_.math.html _sdk_core_assembly_promise_.html _sdk_core_assembly_storage_.html _sdk_core_assembly_util_.html _sdk_core_assembly_util_.util.html package.json near-sdk-simulator __tests__ avl-tree-contract.spec.ts cross.spec.ts empty.spec.ts exportAs.spec.ts singleton-no-constructor.spec.ts singleton.spec.ts asconfig.js asconfig.json assembly __tests__ avlTreeContract.ts empty.ts exportAs.ts model.ts sentences.ts singleton-fail.ts singleton-no-constructor.ts singleton.ts words.ts as_types.d.ts tsconfig.json dist bin.d.ts bin.js context.d.ts context.js index.d.ts index.js runtime.d.ts runtime.js types.d.ts types.js utils.d.ts utils.js jest.config.js out assembly __tests__ empty.ts exportAs.ts model.ts sentences.ts singleton copy.ts singleton-no-constructor.ts singleton.ts package.json src context.ts index.ts runtime.ts types.ts utils.ts tsconfig.json near-vm getBinary.js install.js package.json run.js uninstall.js nearley LICENSE.txt README.md bin nearley-railroad.js nearley-test.js nearley-unparse.js nearleyc.js lib compile.js generate.js lint.js nearley-language-bootstrapped.js nearley.js stream.js unparse.js package.json once README.md once.js package.json optionator CHANGELOG.md README.md lib help.js index.js util.js package.json p-limit index.d.ts index.js package.json readme.md p-locate index.d.ts index.js package.json readme.md p-try index.d.ts index.js package.json readme.md parent-module index.js package.json readme.md path-exists index.d.ts index.js package.json readme.md path-is-absolute index.js package.json readme.md path-key index.d.ts index.js package.json readme.md path-parse README.md index.js package.json prelude-ls CHANGELOG.md README.md lib Func.js List.js Num.js Obj.js Str.js index.js package.json progress CHANGELOG.md Readme.md index.js lib node-progress.js package.json punycode LICENSE-MIT.txt README.md package.json punycode.es6.js punycode.js railroad-diagrams README.md example.html generator.html package.json railroad-diagrams.css railroad-diagrams.js railroad_diagrams.py randexp README.md lib randexp.js package.json rechoir .travis.yml README.md index.js lib extension.js normalize.js register.js package.json regexpp README.md index.d.ts index.js package.json require-directory .travis.yml index.js package.json require-from-string index.js package.json readme.md require-main-filename CHANGELOG.md LICENSE.txt README.md index.js package.json resolve-from index.js package.json readme.md resolve .github FUNDING.yml SECURITY.md appveyor.yml async.js example async.js sync.js index.js lib async.js caller.js core.js core.json homedir.js is-core.js node-modules-paths.js normalize-options.js sync.js package.json sync.js test core.js dotdot.js dotdot abc index.js index.js faulty_basedir.js filter.js filter_sync.js home_paths.js home_paths_sync.js mock.js mock_sync.js module_dir.js module_dir xmodules aaa index.js ymodules aaa index.js zmodules bbb main.js package.json node-modules-paths.js node_path.js node_path x aaa index.js ccc index.js y bbb index.js ccc index.js nonstring.js pathfilter.js pathfilter deep_ref main.js precedence.js precedence aaa.js aaa index.js main.js bbb.js bbb main.js resolver.js resolver baz doom.js package.json quux.js browser_field a.js b.js package.json cup.coffee dot_main index.js package.json dot_slash_main index.js package.json foo.js incorrect_main index.js package.json invalid_main package.json malformed_package_json index.js package.json mug.coffee mug.js multirepo lerna.json package.json packages package-a index.js package.json package-b index.js package.json nested_symlinks mylib async.js package.json sync.js other_path lib other-lib.js root.js quux foo index.js same_names foo.js foo index.js symlinked _ node_modules foo.js package bar.js package.json without_basedir main.js resolver_sync.js shadowed_core.js shadowed_core node_modules util index.js subdirs.js symlinks.js ret README.md lib index.js positions.js sets.js types.js util.js package.json rimraf CHANGELOG.md README.md bin.js package.json rimraf.js safe-buffer README.md index.d.ts index.js package.json semver CHANGELOG.md README.md bin semver.js classes comparator.js index.js range.js semver.js functions clean.js cmp.js coerce.js compare-build.js compare-loose.js compare.js diff.js eq.js gt.js gte.js inc.js lt.js lte.js major.js minor.js neq.js parse.js patch.js prerelease.js rcompare.js rsort.js satisfies.js sort.js valid.js index.js internal constants.js debug.js identifiers.js parse-options.js re.js package.json preload.js ranges gtr.js intersects.js ltr.js max-satisfying.js min-satisfying.js min-version.js outside.js simplify.js subset.js to-comparators.js valid.js set-blocking CHANGELOG.md LICENSE.txt README.md index.js package.json shebang-command index.js package.json readme.md shebang-regex index.d.ts index.js package.json readme.md shelljs CHANGELOG.md README.md commands.js global.js make.js package.json plugin.js shell.js src cat.js cd.js chmod.js common.js cp.js dirs.js echo.js error.js exec-child.js exec.js find.js grep.js head.js ln.js ls.js mkdir.js mv.js popd.js pushd.js pwd.js rm.js sed.js set.js sort.js tail.js tempdir.js test.js to.js toEnd.js touch.js uniq.js which.js slice-ansi index.js package.json readme.md sprintf-js README.md bower.json demo angular.html dist angular-sprintf.min.js sprintf.min.js gruntfile.js package.json src angular-sprintf.js sprintf.js test test.js string-width index.d.ts index.js package.json readme.md strip-ansi index.d.ts index.js package.json readme.md strip-json-comments index.d.ts index.js package.json readme.md supports-color browser.js index.js package.json readme.md supports-preserve-symlinks-flag .github FUNDING.yml CHANGELOG.md README.md browser.js index.js package.json test index.js table README.md dist src alignSpanningCell.d.ts alignSpanningCell.js alignString.d.ts alignString.js alignTableData.d.ts alignTableData.js calculateCellHeight.d.ts calculateCellHeight.js calculateMaximumColumnWidths.d.ts calculateMaximumColumnWidths.js calculateOutputColumnWidths.d.ts calculateOutputColumnWidths.js calculateRowHeights.d.ts calculateRowHeights.js calculateSpanningCellWidth.d.ts calculateSpanningCellWidth.js createStream.d.ts createStream.js drawBorder.d.ts drawBorder.js drawContent.d.ts drawContent.js drawRow.d.ts drawRow.js drawTable.d.ts drawTable.js generated validators.d.ts validators.js getBorderCharacters.d.ts getBorderCharacters.js index.d.ts index.js injectHeaderConfig.d.ts injectHeaderConfig.js makeRangeConfig.d.ts makeRangeConfig.js makeStreamConfig.d.ts makeStreamConfig.js makeTableConfig.d.ts makeTableConfig.js mapDataUsingRowHeights.d.ts mapDataUsingRowHeights.js padTableData.d.ts padTableData.js schemas config.json shared.json streamConfig.json spanningCellManager.d.ts spanningCellManager.js stringifyTableData.d.ts stringifyTableData.js table.d.ts table.js truncateTableData.d.ts truncateTableData.js types api.d.ts api.js internal.d.ts internal.js utils.d.ts utils.js validateConfig.d.ts validateConfig.js validateSpanningCellConfig.d.ts validateSpanningCellConfig.js validateTableData.d.ts validateTableData.js wrapCell.d.ts wrapCell.js wrapString.d.ts wrapString.js wrapWord.d.ts wrapWord.js node_modules ajv .runkit_example.js README.md dist 2019.d.ts 2019.js 2020.d.ts 2020.js ajv.d.ts ajv.js compile codegen code.d.ts code.js index.d.ts index.js scope.d.ts scope.js errors.d.ts errors.js index.d.ts index.js jtd parse.d.ts parse.js serialize.d.ts serialize.js types.d.ts types.js names.d.ts names.js ref_error.d.ts ref_error.js resolve.d.ts resolve.js rules.d.ts rules.js util.d.ts util.js validate applicability.d.ts applicability.js boolSchema.d.ts boolSchema.js dataType.d.ts dataType.js defaults.d.ts defaults.js index.d.ts index.js keyword.d.ts keyword.js subschema.d.ts subschema.js core.d.ts core.js jtd.d.ts jtd.js refs data.json json-schema-2019-09 index.d.ts index.js meta applicator.json content.json core.json format.json meta-data.json validation.json schema.json json-schema-2020-12 index.d.ts index.js meta applicator.json content.json core.json format-annotation.json meta-data.json unevaluated.json validation.json schema.json json-schema-draft-06.json json-schema-draft-07.json json-schema-secure.json jtd-schema.d.ts jtd-schema.js runtime equal.d.ts equal.js parseJson.d.ts parseJson.js quote.d.ts quote.js re2.d.ts re2.js timestamp.d.ts timestamp.js ucs2length.d.ts ucs2length.js uri.d.ts uri.js validation_error.d.ts validation_error.js standalone index.d.ts index.js instance.d.ts instance.js types index.d.ts index.js json-schema.d.ts json-schema.js jtd-schema.d.ts jtd-schema.js vocabularies applicator additionalItems.d.ts additionalItems.js additionalProperties.d.ts additionalProperties.js allOf.d.ts allOf.js anyOf.d.ts anyOf.js contains.d.ts contains.js dependencies.d.ts dependencies.js dependentSchemas.d.ts dependentSchemas.js if.d.ts if.js index.d.ts index.js items.d.ts items.js items2020.d.ts items2020.js not.d.ts not.js oneOf.d.ts oneOf.js patternProperties.d.ts patternProperties.js prefixItems.d.ts prefixItems.js properties.d.ts properties.js propertyNames.d.ts propertyNames.js thenElse.d.ts thenElse.js code.d.ts code.js core id.d.ts id.js index.d.ts index.js ref.d.ts ref.js discriminator index.d.ts index.js types.d.ts types.js draft2020.d.ts draft2020.js draft7.d.ts draft7.js dynamic dynamicAnchor.d.ts dynamicAnchor.js dynamicRef.d.ts dynamicRef.js index.d.ts index.js recursiveAnchor.d.ts recursiveAnchor.js recursiveRef.d.ts recursiveRef.js errors.d.ts errors.js format format.d.ts format.js index.d.ts index.js jtd discriminator.d.ts discriminator.js elements.d.ts elements.js enum.d.ts enum.js error.d.ts error.js index.d.ts index.js metadata.d.ts metadata.js nullable.d.ts nullable.js optionalProperties.d.ts optionalProperties.js properties.d.ts properties.js ref.d.ts ref.js type.d.ts type.js union.d.ts union.js values.d.ts values.js metadata.d.ts metadata.js next.d.ts next.js unevaluated index.d.ts index.js unevaluatedItems.d.ts unevaluatedItems.js unevaluatedProperties.d.ts unevaluatedProperties.js validation const.d.ts const.js dependentRequired.d.ts dependentRequired.js enum.d.ts enum.js index.d.ts index.js limitContains.d.ts limitContains.js limitItems.d.ts limitItems.js limitLength.d.ts limitLength.js limitNumber.d.ts limitNumber.js limitProperties.d.ts limitProperties.js multipleOf.d.ts multipleOf.js pattern.d.ts pattern.js required.d.ts required.js uniqueItems.d.ts uniqueItems.js lib 2019.ts 2020.ts ajv.ts compile codegen code.ts index.ts scope.ts errors.ts index.ts jtd parse.ts serialize.ts types.ts names.ts ref_error.ts resolve.ts rules.ts util.ts validate applicability.ts boolSchema.ts dataType.ts defaults.ts index.ts keyword.ts subschema.ts core.ts jtd.ts refs data.json json-schema-2019-09 index.ts meta applicator.json content.json core.json format.json meta-data.json validation.json schema.json json-schema-2020-12 index.ts meta applicator.json content.json core.json format-annotation.json meta-data.json unevaluated.json validation.json schema.json json-schema-draft-06.json json-schema-draft-07.json json-schema-secure.json jtd-schema.ts runtime equal.ts parseJson.ts quote.ts re2.ts timestamp.ts ucs2length.ts uri.ts validation_error.ts standalone index.ts instance.ts types index.ts json-schema.ts jtd-schema.ts vocabularies applicator additionalItems.ts additionalProperties.ts allOf.ts anyOf.ts contains.ts dependencies.ts dependentSchemas.ts if.ts index.ts items.ts items2020.ts not.ts oneOf.ts patternProperties.ts prefixItems.ts properties.ts propertyNames.ts thenElse.ts code.ts core id.ts index.ts ref.ts discriminator index.ts types.ts draft2020.ts draft7.ts dynamic dynamicAnchor.ts dynamicRef.ts index.ts recursiveAnchor.ts recursiveRef.ts errors.ts format format.ts index.ts jtd discriminator.ts elements.ts enum.ts error.ts index.ts metadata.ts nullable.ts optionalProperties.ts properties.ts ref.ts type.ts union.ts values.ts metadata.ts next.ts unevaluated index.ts unevaluatedItems.ts unevaluatedProperties.ts validation const.ts dependentRequired.ts enum.ts index.ts limitContains.ts limitItems.ts limitLength.ts limitNumber.ts limitProperties.ts multipleOf.ts pattern.ts required.ts uniqueItems.ts package.json json-schema-traverse .eslintrc.yml .github FUNDING.yml workflows build.yml publish.yml README.md index.d.ts index.js package.json spec .eslintrc.yml fixtures schema.js index.spec.js package.json tar README.md index.js lib create.js extract.js get-write-flag.js header.js high-level-opt.js large-numbers.js list.js mkdir.js mode-fix.js normalize-windows-path.js pack.js parse.js path-reservations.js pax.js read-entry.js replace.js strip-absolute-path.js strip-trailing-slashes.js types.js unpack.js update.js warn-mixin.js winchars.js write-entry.js package.json text-table .travis.yml example align.js center.js dotalign.js doubledot.js table.js index.js package.json test align.js ansi-colors.js center.js dotalign.js doubledot.js table.js tr46 LICENSE.md README.md index.js lib mappingTable.json regexes.js package.json ts-mixer CHANGELOG.md README.md dist cjs decorator.js index.js mixin-tracking.js mixins.js proxy.js settings.js types.js util.js esm index.js index.min.js types decorator.d.ts index.d.ts mixin-tracking.d.ts mixins.d.ts proxy.d.ts settings.d.ts types.d.ts util.d.ts package.json type-check README.md lib check.js index.js parse-type.js package.json type-fest base.d.ts index.d.ts package.json readme.md source async-return-type.d.ts asyncify.d.ts basic.d.ts conditional-except.d.ts conditional-keys.d.ts conditional-pick.d.ts entries.d.ts entry.d.ts except.d.ts fixed-length-array.d.ts iterable-element.d.ts literal-union.d.ts merge-exclusive.d.ts merge.d.ts mutable.d.ts opaque.d.ts package-json.d.ts partial-deep.d.ts promisable.d.ts promise-value.d.ts readonly-deep.d.ts require-at-least-one.d.ts require-exactly-one.d.ts set-optional.d.ts set-required.d.ts set-return-type.d.ts stringified.d.ts tsconfig-json.d.ts union-to-intersection.d.ts utilities.d.ts value-of.d.ts ts41 camel-case.d.ts delimiter-case.d.ts index.d.ts kebab-case.d.ts pascal-case.d.ts snake-case.d.ts universal-url README.md browser.js index.js package.json uri-js README.md dist es5 uri.all.d.ts uri.all.js uri.all.min.d.ts uri.all.min.js esnext index.d.ts index.js regexps-iri.d.ts regexps-iri.js regexps-uri.d.ts regexps-uri.js schemes http.d.ts http.js https.d.ts https.js mailto.d.ts mailto.js urn-uuid.d.ts urn-uuid.js urn.d.ts urn.js ws.d.ts ws.js wss.d.ts wss.js uri.d.ts uri.js util.d.ts util.js package.json v8-compile-cache CHANGELOG.md README.md package.json v8-compile-cache.js visitor-as .github workflows test.yml README.md as index.d.ts index.js asconfig.json dist astBuilder.d.ts astBuilder.js base.d.ts base.js baseTransform.d.ts baseTransform.js decorator.d.ts decorator.js examples capitalize.d.ts capitalize.js exportAs.d.ts exportAs.js functionCallTransform.d.ts functionCallTransform.js includeBytesTransform.d.ts includeBytesTransform.js list.d.ts list.js index.d.ts index.js path.d.ts path.js simpleParser.d.ts simpleParser.js transformer.d.ts transformer.js utils.d.ts utils.js visitor.d.ts visitor.js package.json tsconfig.json webidl-conversions LICENSE.md README.md lib index.js package.json whatwg-url LICENSE.txt README.md lib URL-impl.js URL.js URLSearchParams-impl.js URLSearchParams.js infra.js public-api.js url-state-machine.js urlencoded.js utils.js package.json which-module CHANGELOG.md README.md index.js package.json which CHANGELOG.md README.md package.json which.js word-wrap README.md index.d.ts index.js package.json wrap-ansi index.js package.json readme.md wrappy README.md package.json wrappy.js y18n CHANGELOG.md README.md build lib cjs.js index.js platform-shims node.js package.json yallist README.md iterator.js package.json yallist.js yargs-parser CHANGELOG.md LICENSE.txt README.md browser.js build lib index.js string-utils.js tokenize-arg-string.js yargs-parser-types.js yargs-parser.js package.json yargs CHANGELOG.md README.md build lib argsert.js command.js completion-templates.js completion.js middleware.js parse-command.js typings common-types.js yargs-parser-types.js usage.js utils apply-extends.js is-promise.js levenshtein.js obj-filter.js process-argv.js set-blocking.js which-module.js validation.js yargs-factory.js yerror.js helpers index.js package.json locales be.json de.json en.json es.json fi.json fr.json hi.json hu.json id.json it.json ja.json ko.json nb.json nl.json nn.json pirate.json pl.json pt.json pt_BR.json ru.json th.json tr.json zh_CN.json zh_TW.json package.json package-lock.json package.json | features not yet implemented issues with the tests differences between PCRE and JS regex | | | package.json src App.js __mocks__ fileMock.js assets logo-black.svg logo-white.svg components ActiveKeySub FullAccess.js FunctionCall.js ActiveKeys.js Metadata.js SendToken.js config.js global.css index.html index.js jest.init.js main.test.js utils.js wallet login index.html

# fast-json-stable-stringify Deterministic `JSON.stringify()` - a faster version of [@substack](https://github.com/substack)'s json-stable-strigify without [jsonify](https://github.com/substack/jsonify). You can also pass in a custom comparison function. [](https://travis-ci.org/epoberezkin/fast-json-stable-stringify) [](https://coveralls.io/github/epoberezkin/fast-json-stable-stringify?branch=master) # example ``` js var stringify = require('fast-json-stable-stringify'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; console.log(stringify(obj)); ``` output: ``` {"a":3,"b":[{"x":4,"y":5,"z":6},7],"c":8} ``` # methods ``` js var stringify = require('fast-json-stable-stringify') ``` ## var str = stringify(obj, opts) Return a deterministic stringified string `str` from the object `obj`. ## options ### cmp If `opts` is given, you can supply an `opts.cmp` to have a custom comparison function for object keys. Your function `opts.cmp` is called with these parameters: ``` js opts.cmp({ key: akey, value: avalue }, { key: bkey, value: bvalue }) ``` For example, to sort on the object key names in reverse order you could write: ``` js var stringify = require('fast-json-stable-stringify'); var obj = { c: 8, b: [{z:6,y:5,x:4},7], a: 3 }; var s = stringify(obj, function (a, b) { return a.key < b.key ? 1 : -1; }); console.log(s); ``` which results in the output string: ``` {"c":8,"b":[{"z":6,"y":5,"x":4},7],"a":3} ``` Or if you wanted to sort on the object values in reverse order, you could write: ``` var stringify = require('fast-json-stable-stringify'); var obj = { d: 6, c: 5, b: [{z:3,y:2,x:1},9], a: 10 }; var s = stringify(obj, function (a, b) { return a.value < b.value ? 1 : -1; }); console.log(s); ``` which outputs: ``` {"d":6,"c":5,"b":[{"z":3,"y":2,"x":1},9],"a":10} ``` ### cycles Pass `true` in `opts.cycles` to stringify circular property as `__cycle__` - the result will not be a valid JSON string in this case. TypeError will be thrown in case of circular object without this option. # install With [npm](https://npmjs.org) do: ``` npm install fast-json-stable-stringify ``` # benchmark To run benchmark (requires Node.js 6+): ``` node benchmark ``` Results: ``` fast-json-stable-stringify x 17,189 ops/sec ±1.43% (83 runs sampled) json-stable-stringify x 13,634 ops/sec ±1.39% (85 runs sampled) fast-stable-stringify x 20,212 ops/sec ±1.20% (84 runs sampled) faster-stable-stringify x 15,549 ops/sec ±1.12% (84 runs sampled) The fastest is fast-stable-stringify ``` ## Enterprise support fast-json-stable-stringify package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-json-stable-stringify?utm_source=npm-fast-json-stable-stringify&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers. ## Security contact To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues. # license [MIT](https://github.com/epoberezkin/fast-json-stable-stringify/blob/master/LICENSE) # <img src="./logo.png" alt="bn.js" width="160" height="160" /> > BigNum in pure javascript [](http://travis-ci.org/indutny/bn.js) ## Install `npm install --save bn.js` ## Usage ```js const BN = require('bn.js'); var a = new BN('dead', 16); var b = new BN('101010', 2); var res = a.add(b); console.log(res.toString(10)); // 57047 ``` **Note**: decimals are not supported in this library. ## Notation ### Prefixes There are several prefixes to instructions that affect the way the work. Here is the list of them in the order of appearance in the function name: * `i` - perform operation in-place, storing the result in the host object (on which the method was invoked). Might be used to avoid number allocation costs * `u` - unsigned, ignore the sign of operands when performing operation, or always return positive value. Second case applies to reduction operations like `mod()`. In such cases if the result will be negative - modulo will be added to the result to make it positive ### Postfixes * `n` - the argument of the function must be a plain JavaScript Number. Decimals are not supported. * `rn` - both argument and return value of the function are plain JavaScript Numbers. Decimals are not supported. ### Examples * `a.iadd(b)` - perform addition on `a` and `b`, storing the result in `a` * `a.umod(b)` - reduce `a` modulo `b`, returning positive value * `a.iushln(13)` - shift bits of `a` left by 13 ## Instructions Prefixes/postfixes are put in parens at the of the line. `endian` - could be either `le` (little-endian) or `be` (big-endian). ### Utilities * `a.clone()` - clone number * `a.toString(base, length)` - convert to base-string and pad with zeroes * `a.toNumber()` - convert to Javascript Number (limited to 53 bits) * `a.toJSON()` - convert to JSON compatible hex string (alias of `toString(16)`) * `a.toArray(endian, length)` - convert to byte `Array`, and optionally zero pad to length, throwing if already exceeding * `a.toArrayLike(type, endian, length)` - convert to an instance of `type`, which must behave like an `Array` * `a.toBuffer(endian, length)` - convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: `a.toArrayLike(Buffer, endian, length)` * `a.bitLength()` - get number of bits occupied * `a.zeroBits()` - return number of less-significant consequent zero bits (example: `1010000` has 4 zero bits) * `a.byteLength()` - return number of bytes occupied * `a.isNeg()` - true if the number is negative * `a.isEven()` - no comments * `a.isOdd()` - no comments * `a.isZero()` - no comments * `a.cmp(b)` - compare numbers and return `-1` (a `<` b), `0` (a `==` b), or `1` (a `>` b) depending on the comparison result (`ucmp`, `cmpn`) * `a.lt(b)` - `a` less than `b` (`n`) * `a.lte(b)` - `a` less than or equals `b` (`n`) * `a.gt(b)` - `a` greater than `b` (`n`) * `a.gte(b)` - `a` greater than or equals `b` (`n`) * `a.eq(b)` - `a` equals `b` (`n`) * `a.toTwos(width)` - convert to two's complement representation, where `width` is bit width * `a.fromTwos(width)` - convert from two's complement representation, where `width` is the bit width * `BN.isBN(object)` - returns true if the supplied `object` is a BN.js instance * `BN.max(a, b)` - return `a` if `a` bigger than `b` * `BN.min(a, b)` - return `a` if `a` less than `b` ### Arithmetics * `a.neg()` - negate sign (`i`) * `a.abs()` - absolute value (`i`) * `a.add(b)` - addition (`i`, `n`, `in`) * `a.sub(b)` - subtraction (`i`, `n`, `in`) * `a.mul(b)` - multiply (`i`, `n`, `in`) * `a.sqr()` - square (`i`) * `a.pow(b)` - raise `a` to the power of `b` * `a.div(b)` - divide (`divn`, `idivn`) * `a.mod(b)` - reduct (`u`, `n`) (but no `umodn`) * `a.divmod(b)` - quotient and modulus obtained by dividing * `a.divRound(b)` - rounded division ### Bit operations * `a.or(b)` - or (`i`, `u`, `iu`) * `a.and(b)` - and (`i`, `u`, `iu`, `andln`) (NOTE: `andln` is going to be replaced with `andn` in future) * `a.xor(b)` - xor (`i`, `u`, `iu`) * `a.setn(b, value)` - set specified bit to `value` * `a.shln(b)` - shift left (`i`, `u`, `iu`) * `a.shrn(b)` - shift right (`i`, `u`, `iu`) * `a.testn(b)` - test if specified bit is set * `a.maskn(b)` - clear bits with indexes higher or equal to `b` (`i`) * `a.bincn(b)` - add `1 << b` to the number * `a.notn(w)` - not (for the width specified by `w`) (`i`) ### Reduction * `a.gcd(b)` - GCD * `a.egcd(b)` - Extended GCD results (`{ a: ..., b: ..., gcd: ... }`) * `a.invm(b)` - inverse `a` modulo `b` ## Fast reduction When doing lots of reductions using the same modulo, it might be beneficial to use some tricks: like [Montgomery multiplication][0], or using special algorithm for [Mersenne Prime][1]. ### Reduction context To enable this tricks one should create a reduction context: ```js var red = BN.red(num); ``` where `num` is just a BN instance. Or: ```js var red = BN.red(primeName); ``` Where `primeName` is either of these [Mersenne Primes][1]: * `'k256'` * `'p224'` * `'p192'` * `'p25519'` Or: ```js var red = BN.mont(num); ``` To reduce numbers with [Montgomery trick][0]. `.mont()` is generally faster than `.red(num)`, but slower than `BN.red(primeName)`. ### Converting numbers Before performing anything in reduction context - numbers should be converted to it. Usually, this means that one should: * Convert inputs to reducted ones * Operate on them in reduction context * Convert outputs back from the reduction context Here is how one may convert numbers to `red`: ```js var redA = a.toRed(red); ``` Where `red` is a reduction context created using instructions above Here is how to convert them back: ```js var a = redA.fromRed(); ``` ### Red instructions Most of the instructions from the very start of this readme have their counterparts in red context: * `a.redAdd(b)`, `a.redIAdd(b)` * `a.redSub(b)`, `a.redISub(b)` * `a.redShl(num)` * `a.redMul(b)`, `a.redIMul(b)` * `a.redSqr()`, `a.redISqr()` * `a.redSqrt()` - square root modulo reduction context's prime * `a.redInvm()` - modular inverse of the number * `a.redNeg()` * `a.redPow(b)` - modular exponentiation ### Number Size Optimized for elliptic curves that work with 256-bit numbers. There is no limitation on the size of the numbers. ## LICENSE This software is licensed under the MIT License. [0]: https://en.wikipedia.org/wiki/Montgomery_modular_multiplication [1]: https://en.wikipedia.org/wiki/Mersenne_prime # lru cache A cache object that deletes the least-recently-used items. [](https://travis-ci.org/isaacs/node-lru-cache) [](https://coveralls.io/github/isaacs/node-lru-cache) ## Installation: ```javascript npm install lru-cache --save ``` ## Usage: ```javascript var LRU = require("lru-cache") , options = { max: 500 , length: function (n, key) { return n * 2 + key.length } , dispose: function (key, n) { n.close() } , maxAge: 1000 * 60 * 60 } , cache = new LRU(options) , otherCache = new LRU(50) // sets just the max size cache.set("key", "value") cache.get("key") // "value" // non-string keys ARE fully supported // but note that it must be THE SAME object, not // just a JSON-equivalent object. var someObject = { a: 1 } cache.set(someObject, 'a value') // Object keys are not toString()-ed cache.set('[object Object]', 'a different value') assert.equal(cache.get(someObject), 'a value') // A similar object with same keys/values won't work, // because it's a different object identity assert.equal(cache.get({ a: 1 }), undefined) cache.reset() // empty the cache ``` If you put more stuff in it, then items will fall out. If you try to put an oversized thing in it, then it'll fall out right away. ## Options * `max` The maximum size of the cache, checked by applying the length function to all values in the cache. Not setting this is kind of silly, since that's the whole purpose of this lib, but it defaults to `Infinity`. Setting it to a non-number or negative number will throw a `TypeError`. Setting it to 0 makes it be `Infinity`. * `maxAge` Maximum age in ms. Items are not pro-actively pruned out as they age, but if you try to get an item that is too old, it'll drop it and return undefined instead of giving it to you. Setting this to a negative value will make everything seem old! Setting it to a non-number will throw a `TypeError`. * `length` Function that is used to calculate the length of stored items. If you're storing strings or buffers, then you probably want to do something like `function(n, key){return n.length}`. The default is `function(){return 1}`, which is fine if you want to store `max` like-sized things. The item is passed as the first argument, and the key is passed as the second argumnet. * `dispose` Function that is called on items when they are dropped from the cache. This can be handy if you want to close file descriptors or do other cleanup tasks when items are no longer accessible. Called with `key, value`. It's called *before* actually removing the item from the internal cache, so if you want to immediately put it back in, you'll have to do that in a `nextTick` or `setTimeout` callback or it won't do anything. * `stale` By default, if you set a `maxAge`, it'll only actually pull stale items out of the cache when you `get(key)`. (That is, it's not pre-emptively doing a `setTimeout` or anything.) If you set `stale:true`, it'll return the stale value before deleting it. If you don't set this, then it'll return `undefined` when you try to get a stale entry, as if it had already been deleted. * `noDisposeOnSet` By default, if you set a `dispose()` method, then it'll be called whenever a `set()` operation overwrites an existing key. If you set this option, `dispose()` will only be called when a key falls out of the cache, not when it is overwritten. * `updateAgeOnGet` When using time-expiring entries with `maxAge`, setting this to `true` will make each item's effective time update to the current time whenever it is retrieved from cache, causing it to not expire. (It can still fall out of cache based on recency of use, of course.) ## API * `set(key, value, maxAge)` * `get(key) => value` Both of these will update the "recently used"-ness of the key. They do what you think. `maxAge` is optional and overrides the cache `maxAge` option if provided. If the key is not found, `get()` will return `undefined`. The key and val can be any value. * `peek(key)` Returns the key value (or `undefined` if not found) without updating the "recently used"-ness of the key. (If you find yourself using this a lot, you *might* be using the wrong sort of data structure, but there are some use cases where it's handy.) * `del(key)` Deletes a key out of the cache. * `reset()` Clear the cache entirely, throwing away all values. * `has(key)` Check if a key is in the cache, without updating the recent-ness or deleting it for being stale. * `forEach(function(value,key,cache), [thisp])` Just like `Array.prototype.forEach`. Iterates over all the keys in the cache, in order of recent-ness. (Ie, more recently used items are iterated over first.) * `rforEach(function(value,key,cache), [thisp])` The same as `cache.forEach(...)` but items are iterated over in reverse order. (ie, less recently used items are iterated over first.) * `keys()` Return an array of the keys in the cache. * `values()` Return an array of the values in the cache. * `length` Return total length of objects in cache taking into account `length` options function. * `itemCount` Return total quantity of objects currently in cache. Note, that `stale` (see options) items are returned as part of this item count. * `dump()` Return an array of the cache entries ready for serialization and usage with 'destinationCache.load(arr)`. * `load(cacheEntriesArray)` Loads another cache entries array, obtained with `sourceCache.dump()`, into the cache. The destination cache is reset before loading new entries * `prune()` Manually iterates over the entire cache proactively pruning old entries Shims used when bundling asc for browser usage. # randexp.js randexp will generate a random string that matches a given RegExp Javascript object. [](http://travis-ci.org/fent/randexp.js) [](https://david-dm.org/fent/randexp.js) [](https://codecov.io/gh/fent/randexp.js) # Usage ```js var RandExp = require('randexp'); // supports grouping and piping new RandExp(/hello+ (world|to you)/).gen(); // => hellooooooooooooooooooo world // sets and ranges and references new RandExp(/<([a-z]\w{0,20})>foo<\1>/).gen(); // => <m5xhdg>foo<m5xhdg> // wildcard new RandExp(/random stuff: .+/).gen(); // => random stuff: l3m;Hf9XYbI [YPaxV>U*4-_F!WXQh9>;rH3i l!8.zoh?[utt1OWFQrE ^~8zEQm]~tK // ignore case new RandExp(/xxx xtreme dragon warrior xxx/i).gen(); // => xxx xtReME dRAGON warRiOR xXX // dynamic regexp shortcut new RandExp('(sun|mon|tue|wednes|thurs|fri|satur)day', 'i'); // is the same as new RandExp(new RegExp('(sun|mon|tue|wednes|thurs|fri|satur)day', 'i')); ``` If you're only going to use `gen()` once with a regexp and want slightly shorter syntax for it ```js var randexp = require('randexp').randexp; randexp(/[1-6]/); // 4 randexp('great|good( job)?|excellent'); // great ``` If you miss the old syntax ```js require('randexp').sugar(); /yes|no|maybe|i don't know/.gen(); // maybe ``` # Motivation Regular expressions are used in every language, every programmer is familiar with them. Regex can be used to easily express complex strings. What better way to generate a random string than with a language you can use to express the string you want? Thanks to [String-Random](http://search.cpan.org/~steve/String-Random-0.22/lib/String/Random.pm) for giving me the idea to make this in the first place and [randexp](https://github.com/benburkert/randexp) for the sweet `.gen()` syntax. # Default Range The default generated character range includes printable ASCII. In order to add or remove characters, a `defaultRange` attribute is exposed. you can `subtract(from, to)` and `add(from, to)` ```js var randexp = new RandExp(/random stuff: .+/); randexp.defaultRange.subtract(32, 126); randexp.defaultRange.add(0, 65535); randexp.gen(); // => random stuff: 湐箻ໜ䫴␩⶛㳸長���邓蕲뤀쑡篷皇硬剈궦佔칗븛뀃匫鴔事좍ﯣ⭼ꝏ䭍詳蒂䥂뽭 ``` # Custom PRNG The default randomness is provided by `Math.random()`. If you need to use a seedable or cryptographic PRNG, you can override `RandExp.prototype.randInt` or `randexp.randInt` (where `randexp` is an instance of `RandExp`). `randInt(from, to)` accepts an inclusive range and returns a randomly selected number within that range. # Infinite Repetitionals Repetitional tokens such as `*`, `+`, and `{3,}` have an infinite max range. In this case, randexp looks at its min and adds 100 to it to get a useable max value. If you want to use another int other than 100 you can change the `max` property in `RandExp.prototype` or the RandExp instance. ```js var randexp = new RandExp(/no{1,}/); randexp.max = 1000000; ``` With `RandExp.sugar()` ```js var regexp = /(hi)*/; regexp.max = 1000000; ``` # Bad Regular Expressions There are some regular expressions which can never match any string. * Ones with badly placed positionals such as `/a^/` and `/$c/m`. Randexp will ignore positional tokens. * Back references to non-existing groups like `/(a)\1\2/`. Randexp will ignore those references, returning an empty string for them. If the group exists only after the reference is used such as in `/\1 (hey)/`, it will too be ignored. * Custom negated character sets with two sets inside that cancel each other out. Example: `/[^\w\W]/`. If you give this to randexp, it will return an empty string for this set since it can't match anything. # Projects based on randexp.js ## JSON-Schema Faker Use generators to populate JSON Schema samples. See: [jsf on github](https://github.com/json-schema-faker/json-schema-faker/) and [jsf demo page](http://json-schema-faker.js.org/). # Install ### Node.js npm install randexp ### Browser Download the [minified version](https://github.com/fent/randexp.js/releases) from the latest release. # Tests Tests are written with [mocha](https://mochajs.org) ```bash npm test ``` # License MIT # ESLint Scope ESLint Scope is the [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) scope analyzer used in ESLint. It is a fork of [escope](http://github.com/estools/escope). ## Usage Install: ``` npm i eslint-scope --save ``` Example: ```js var eslintScope = require('eslint-scope'); var espree = require('espree'); var estraverse = require('estraverse'); var ast = espree.parse(code); var scopeManager = eslintScope.analyze(ast); var currentScope = scopeManager.acquire(ast); // global scope estraverse.traverse(ast, { enter: function(node, parent) { // do stuff if (/Function/.test(node.type)) { currentScope = scopeManager.acquire(node); // get current function scope } }, leave: function(node, parent) { if (/Function/.test(node.type)) { currentScope = currentScope.upper; // set to parent scope } // do stuff } }); ``` ## Contributing Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/eslint-scope/issues). ## Build Commands * `npm test` - run all linting and tests * `npm run lint` - run all linting ## License ESLint Scope is licensed under a permissive BSD 2-clause license. # lodash.merge v4.6.2 The [Lodash](https://lodash.com/) method `_.merge` exported as a [Node.js](https://nodejs.org/) module. ## Installation Using npm: ```bash $ {sudo -H} npm i -g npm $ npm i --save lodash.merge ``` In Node.js: ```js var merge = require('lodash.merge'); ``` See the [documentation](https://lodash.com/docs#merge) or [package source](https://github.com/lodash/lodash/blob/4.6.2-npm-packages/lodash.merge) for more details. # eslint-visitor-keys [](https://www.npmjs.com/package/eslint-visitor-keys) [](http://www.npmtrends.com/eslint-visitor-keys) [](https://travis-ci.org/eslint/eslint-visitor-keys) [](https://david-dm.org/eslint/eslint-visitor-keys) Constants and utilities about visitor keys to traverse AST. ## 💿 Installation Use [npm] to install. ```bash $ npm install eslint-visitor-keys ``` ### Requirements - [Node.js] 4.0.0 or later. ## 📖 Usage ```js const evk = require("eslint-visitor-keys") ``` ### evk.KEYS > type: `{ [type: string]: string[] | undefined }` Visitor keys. This keys are frozen. This is an object. Keys are the type of [ESTree] nodes. Their values are an array of property names which have child nodes. For example: ``` console.log(evk.KEYS.AssignmentExpression) // → ["left", "right"] ``` ### evk.getKeys(node) > type: `(node: object) => string[]` Get the visitor keys of a given AST node. This is similar to `Object.keys(node)` of ES Standard, but some keys are excluded: `parent`, `leadingComments`, `trailingComments`, and names which start with `_`. This will be used to traverse unknown nodes. For example: ``` const node = { type: "AssignmentExpression", left: { type: "Identifier", name: "foo" }, right: { type: "Literal", value: 0 } } console.log(evk.getKeys(node)) // → ["type", "left", "right"] ``` ### evk.unionWith(additionalKeys) > type: `(additionalKeys: object) => { [type: string]: string[] | undefined }` Make the union set with `evk.KEYS` and the given keys. - The order of keys is, `additionalKeys` is at first, then `evk.KEYS` is concatenated after that. - It removes duplicated keys as keeping the first one. For example: ``` console.log(evk.unionWith({ MethodDefinition: ["decorators"] })) // → { ..., MethodDefinition: ["decorators", "key", "value"], ... } ``` ## 📰 Change log See [GitHub releases](https://github.com/eslint/eslint-visitor-keys/releases). ## 🍻 Contributing Welcome. See [ESLint contribution guidelines](https://eslint.org/docs/developer-guide/contributing/). ### Development commands - `npm test` runs tests and measures code coverage. - `npm run lint` checks source codes with ESLint. - `npm run coverage` opens the code coverage report of the previous test with your default browser. - `npm run release` publishes this package to [npm] registory. [npm]: https://www.npmjs.com/ [Node.js]: https://nodejs.org/en/ [ESTree]: https://github.com/estree/estree # minimatch A minimal matching utility. [](http://travis-ci.org/isaacs/minimatch) This is the matching library used internally by npm. It works by converting glob expressions into JavaScript `RegExp` objects. ## Usage ```javascript var minimatch = require("minimatch") minimatch("bar.foo", "*.foo") // true! minimatch("bar.foo", "*.bar") // false! minimatch("bar.foo", "*.+(bar|foo)", { debug: true }) // true, and noisy! ``` ## Features Supports these glob features: * Brace Expansion * Extended glob matching * "Globstar" `**` matching See: * `man sh` * `man bash` * `man 3 fnmatch` * `man 5 gitignore` ## Minimatch Class Create a minimatch object by instantiating the `minimatch.Minimatch` class. ```javascript var Minimatch = require("minimatch").Minimatch var mm = new Minimatch(pattern, options) ``` ### Properties * `pattern` The original pattern the minimatch object represents. * `options` The options supplied to the constructor. * `set` A 2-dimensional array of regexp or string expressions. Each row in the array corresponds to a brace-expanded pattern. Each item in the row corresponds to a single path-part. For example, the pattern `{a,b/c}/d` would expand to a set of patterns like: [ [ a, d ] , [ b, c, d ] ] If a portion of the pattern doesn't have any "magic" in it (that is, it's something like `"foo"` rather than `fo*o?`), then it will be left as a string rather than converted to a regular expression. * `regexp` Created by the `makeRe` method. A single regular expression expressing the entire pattern. This is useful in cases where you wish to use the pattern somewhat like `fnmatch(3)` with `FNM_PATH` enabled. * `negate` True if the pattern is negated. * `comment` True if the pattern is a comment. * `empty` True if the pattern is `""`. ### Methods * `makeRe` Generate the `regexp` member if necessary, and return it. Will return `false` if the pattern is invalid. * `match(fname)` Return true if the filename matches the pattern, or false otherwise. * `matchOne(fileArray, patternArray, partial)` Take a `/`-split filename, and match it against a single row in the `regExpSet`. This method is mainly for internal use, but is exposed so that it can be used by a glob-walker that needs to avoid excessive filesystem calls. All other methods are internal, and will be called as necessary. ### minimatch(path, pattern, options) Main export. Tests a path against the pattern using the options. ```javascript var isJS = minimatch(file, "*.js", { matchBase: true }) ``` ### minimatch.filter(pattern, options) Returns a function that tests its supplied argument, suitable for use with `Array.filter`. Example: ```javascript var javascripts = fileList.filter(minimatch.filter("*.js", {matchBase: true})) ``` ### minimatch.match(list, pattern, options) Match against the list of files, in the style of fnmatch or glob. If nothing is matched, and options.nonull is set, then return a list containing the pattern itself. ```javascript var javascripts = minimatch.match(fileList, "*.js", {matchBase: true})) ``` ### minimatch.makeRe(pattern, options) Make a regular expression object from the pattern. ## Options All options are `false` by default. ### debug Dump a ton of stuff to stderr. ### nobrace Do not expand `{a,b}` and `{1..3}` brace sets. ### noglobstar Disable `**` matching against multiple folder names. ### dot Allow patterns to match filenames starting with a period, even if the pattern does not explicitly have a period in that spot. Note that by default, `a/**/b` will **not** match `a/.d/b`, unless `dot` is set. ### noext Disable "extglob" style patterns like `+(a|b)`. ### nocase Perform a case-insensitive match. ### nonull When a match is not found by `minimatch.match`, return a list containing the pattern itself if this option is set. When not set, an empty list is returned if there are no matches. ### matchBase If set, then patterns without slashes will be matched against the basename of the path if it contains slashes. For example, `a?b` would match the path `/xyz/123/acb`, but not `/xyz/acb/123`. ### nocomment Suppress the behavior of treating `#` at the start of a pattern as a comment. ### nonegate Suppress the behavior of treating a leading `!` character as negation. ### flipNegate Returns from negate expressions the same as if they were not negated. (Ie, true on a hit, false on a miss.) ## Comparisons to other fnmatch/glob implementations While strict compliance with the existing standards is a worthwhile goal, some discrepancies exist between minimatch and other implementations, and are intentional. If the pattern starts with a `!` character, then it is negated. Set the `nonegate` flag to suppress this behavior, and treat leading `!` characters normally. This is perhaps relevant if you wish to start the pattern with a negative extglob pattern like `!(a|B)`. Multiple `!` characters at the start of a pattern will negate the pattern multiple times. If a pattern starts with `#`, then it is treated as a comment, and will not match anything. Use `\#` to match a literal `#` at the start of a line, or set the `nocomment` flag to suppress this behavior. The double-star character `**` is supported by default, unless the `noglobstar` flag is set. This is supported in the manner of bsdglob and bash 4.1, where `**` only has special significance if it is the only thing in a path part. That is, `a/**/b` will match `a/x/y/b`, but `a/**b` will not. If an escaped pattern has no matches, and the `nonull` flag is set, then minimatch.match returns the pattern as-provided, rather than interpreting the character escapes. For example, `minimatch.match([], "\\*a\\?")` will return `"\\*a\\?"` rather than `"*a?"`. This is akin to setting the `nullglob` option in bash, except that it does not resolve escaped pattern characters. If brace expansion is not disabled, then it is performed before any other interpretation of the glob pattern. Thus, a pattern like `+(a|{b),c)}`, which would not be valid in bash or zsh, is expanded **first** into the set of `+(a|b)` and `+(a|c)`, and those patterns are checked for validity. Since those two are valid, matching proceeds. # regexpp [](https://www.npmjs.com/package/regexpp) [](http://www.npmtrends.com/regexpp) [](https://github.com/mysticatea/regexpp/actions) [](https://codecov.io/gh/mysticatea/regexpp) [](https://david-dm.org/mysticatea/regexpp) A regular expression parser for ECMAScript. ## 💿 Installation ```bash $ npm install regexpp ``` - require Node.js 8 or newer. ## 📖 Usage ```ts import { AST, RegExpParser, RegExpValidator, RegExpVisitor, parseRegExpLiteral, validateRegExpLiteral, visitRegExpAST } from "regexpp" ``` ### parseRegExpLiteral(source, options?) Parse a given regular expression literal then make AST object. This is equivalent to `new RegExpParser(options).parseLiteral(source)`. - **Parameters:** - `source` (`string | RegExp`) The source code to parse. - `options?` ([`RegExpParser.Options`]) The options to parse. - **Return:** - The AST of the regular expression. ### validateRegExpLiteral(source, options?) Validate a given regular expression literal. This is equivalent to `new RegExpValidator(options).validateLiteral(source)`. - **Parameters:** - `source` (`string`) The source code to validate. - `options?` ([`RegExpValidator.Options`]) The options to validate. ### visitRegExpAST(ast, handlers) Visit each node of a given AST. This is equivalent to `new RegExpVisitor(handlers).visit(ast)`. - **Parameters:** - `ast` ([`AST.Node`]) The AST to visit. - `handlers` ([`RegExpVisitor.Handlers`]) The callbacks. ### RegExpParser #### new RegExpParser(options?) - **Parameters:** - `options?` ([`RegExpParser.Options`]) The options to parse. #### parser.parseLiteral(source, start?, end?) Parse a regular expression literal. - **Parameters:** - `source` (`string`) The source code to parse. E.g. `"/abc/g"`. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. - **Return:** - The AST of the regular expression. #### parser.parsePattern(source, start?, end?, uFlag?) Parse a regular expression pattern. - **Parameters:** - `source` (`string`) The source code to parse. E.g. `"abc"`. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. - `uFlag?` (`boolean`) The flag to enable Unicode mode. - **Return:** - The AST of the regular expression pattern. #### parser.parseFlags(source, start?, end?) Parse a regular expression flags. - **Parameters:** - `source` (`string`) The source code to parse. E.g. `"gim"`. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. - **Return:** - The AST of the regular expression flags. ### RegExpValidator #### new RegExpValidator(options) - **Parameters:** - `options` ([`RegExpValidator.Options`]) The options to validate. #### validator.validateLiteral(source, start, end) Validate a regular expression literal. - **Parameters:** - `source` (`string`) The source code to validate. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. #### validator.validatePattern(source, start, end, uFlag) Validate a regular expression pattern. - **Parameters:** - `source` (`string`) The source code to validate. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. - `uFlag?` (`boolean`) The flag to enable Unicode mode. #### validator.validateFlags(source, start, end) Validate a regular expression flags. - **Parameters:** - `source` (`string`) The source code to validate. - `start?` (`number`) The start index in the source code. Default is `0`. - `end?` (`number`) The end index in the source code. Default is `source.length`. ### RegExpVisitor #### new RegExpVisitor(handlers) - **Parameters:** - `handlers` ([`RegExpVisitor.Handlers`]) The callbacks. #### visitor.visit(ast) Validate a regular expression literal. - **Parameters:** - `ast` ([`AST.Node`]) The AST to visit. ## 📰 Changelog - [GitHub Releases](https://github.com/mysticatea/regexpp/releases) ## 🍻 Contributing Welcome contributing! Please use GitHub's Issues/PRs. ### Development Tools - `npm test` runs tests and measures coverage. - `npm run build` compiles TypeScript source code to `index.js`, `index.js.map`, and `index.d.ts`. - `npm run clean` removes the temporary files which are created by `npm test` and `npm run build`. - `npm run lint` runs ESLint. - `npm run update:test` updates test fixtures. - `npm run update:ids` updates `src/unicode/ids.ts`. - `npm run watch` runs tests with `--watch` option. [`AST.Node`]: src/ast.ts#L4 [`RegExpParser.Options`]: src/parser.ts#L539 [`RegExpValidator.Options`]: src/validator.ts#L127 [`RegExpVisitor.Handlers`]: src/visitor.ts#L204 # which-module > Find the module object for something that was require()d [](https://travis-ci.org/nexdrew/which-module) [](https://coveralls.io/github/nexdrew/which-module?branch=master) [](https://github.com/conventional-changelog/standard-version) Find the `module` object in `require.cache` for something that was `require()`d or `import`ed - essentially a reverse `require()` lookup. Useful for libs that want to e.g. lookup a filename for a module or submodule that it did not `require()` itself. ## Install and Usage ``` npm install --save which-module ``` ```js const whichModule = require('which-module') console.log(whichModule(require('something'))) // Module { // id: '/path/to/project/node_modules/something/index.js', // exports: [Function], // parent: ..., // filename: '/path/to/project/node_modules/something/index.js', // loaded: true, // children: [], // paths: [ '/path/to/project/node_modules/something/node_modules', // '/path/to/project/node_modules', // '/path/to/node_modules', // '/path/node_modules', // '/node_modules' ] } ``` ## API ### `whichModule(exported)` Return the [`module` object](https://nodejs.org/api/modules.html#modules_the_module_object), if any, that represents the given argument in the `require.cache`. `exported` can be anything that was previously `require()`d or `import`ed as a module, submodule, or dependency - which means `exported` is identical to the `module.exports` returned by this method. If `exported` did not come from the `exports` of a `module` in `require.cache`, then this method returns `null`. ## License ISC © Contributors # lodash.truncate v4.4.2 The [lodash](https://lodash.com/) method `_.truncate` exported as a [Node.js](https://nodejs.org/) module. ## Installation Using npm: ```bash $ {sudo -H} npm i -g npm $ npm i --save lodash.truncate ``` In Node.js: ```js var truncate = require('lodash.truncate'); ``` See the [documentation](https://lodash.com/docs#truncate) or [package source](https://github.com/lodash/lodash/blob/4.4.2-npm-packages/lodash.truncate) for more details. # near-sdk-core This package contain a convenient interface for interacting with NEAR's host runtime. To see the functions that are provided by the host node see [`env.ts`](./assembly/env/env.ts). # ShellJS - Unix shell commands for Node.js [](https://travis-ci.org/shelljs/shelljs) [](https://ci.appveyor.com/project/shelljs/shelljs/branch/master) [](https://codecov.io/gh/shelljs/shelljs) [](https://www.npmjs.com/package/shelljs) [](https://www.npmjs.com/package/shelljs) ShellJS is a portable **(Windows/Linux/OS X)** implementation of Unix shell commands on top of the Node.js API. You can use it to eliminate your shell script's dependency on Unix while still keeping its familiar and powerful commands. You can also install it globally so you can run it from outside Node projects - say goodbye to those gnarly Bash scripts! ShellJS is proudly tested on every node release since `v4`! The project is [unit-tested](http://travis-ci.org/shelljs/shelljs) and battle-tested in projects like: + [Firebug](http://getfirebug.com/) - Firefox's infamous debugger + [JSHint](http://jshint.com) & [ESLint](http://eslint.org/) - popular JavaScript linters + [Zepto](http://zeptojs.com) - jQuery-compatible JavaScript library for modern browsers + [Yeoman](http://yeoman.io/) - Web application stack and development tool + [Deployd.com](http://deployd.com) - Open source PaaS for quick API backend generation + And [many more](https://npmjs.org/browse/depended/shelljs). If you have feedback, suggestions, or need help, feel free to post in our [issue tracker](https://github.com/shelljs/shelljs/issues). Think ShellJS is cool? Check out some related projects in our [Wiki page](https://github.com/shelljs/shelljs/wiki)! Upgrading from an older version? Check out our [breaking changes](https://github.com/shelljs/shelljs/wiki/Breaking-Changes) page to see what changes to watch out for while upgrading. ## Command line use If you just want cross platform UNIX commands, checkout our new project [shelljs/shx](https://github.com/shelljs/shx), a utility to expose `shelljs` to the command line. For example: ``` $ shx mkdir -p foo $ shx touch foo/bar.txt $ shx rm -rf foo ``` ## Plugin API ShellJS now supports third-party plugins! You can learn more about using plugins and writing your own ShellJS commands in [the wiki](https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins). ## A quick note about the docs For documentation on all the latest features, check out our [README](https://github.com/shelljs/shelljs). To read docs that are consistent with the latest release, check out [the npm page](https://www.npmjs.com/package/shelljs) or [shelljs.org](http://documentup.com/shelljs/shelljs). ## Installing Via npm: ```bash $ npm install [-g] shelljs ``` ## Examples ```javascript var shell = require('shelljs'); if (!shell.which('git')) { shell.echo('Sorry, this script requires git'); shell.exit(1); } // Copy files to release dir shell.rm('-rf', 'out/Release'); shell.cp('-R', 'stuff/', 'out/Release'); // Replace macros in each .js file shell.cd('lib'); shell.ls('*.js').forEach(function (file) { shell.sed('-i', 'BUILD_VERSION', 'v0.1.2', file); shell.sed('-i', /^.*REMOVE_THIS_LINE.*$/, '', file); shell.sed('-i', /.*REPLACE_LINE_WITH_MACRO.*\n/, shell.cat('macro.js'), file); }); shell.cd('..'); // Run external tool synchronously if (shell.exec('git commit -am "Auto-commit"').code !== 0) { shell.echo('Error: Git commit failed'); shell.exit(1); } ``` ## Exclude options If you need to pass a parameter that looks like an option, you can do so like: ```js shell.grep('--', '-v', 'path/to/file'); // Search for "-v", no grep options shell.cp('-R', '-dir', 'outdir'); // If already using an option, you're done ``` ## Global vs. Local We no longer recommend using a global-import for ShellJS (i.e. `require('shelljs/global')`). While still supported for convenience, this pollutes the global namespace, and should therefore only be used with caution. Instead, we recommend a local import (standard for npm packages): ```javascript var shell = require('shelljs'); shell.echo('hello world'); ``` <!-- DO NOT MODIFY BEYOND THIS POINT - IT'S AUTOMATICALLY GENERATED --> ## Command reference All commands run synchronously, unless otherwise stated. All commands accept standard bash globbing characters (`*`, `?`, etc.), compatible with the [node `glob` module](https://github.com/isaacs/node-glob). For less-commonly used commands and features, please check out our [wiki page](https://github.com/shelljs/shelljs/wiki). ### cat([options,] file [, file ...]) ### cat([options,] file_array) Available options: + `-n`: number all output lines Examples: ```javascript var str = cat('file*.txt'); var str = cat('file1', 'file2'); var str = cat(['file1', 'file2']); // same as above ``` Returns a string containing the given file, or a concatenated string containing the files if more than one file is given (a new line character is introduced between each file). ### cd([dir]) Changes to directory `dir` for the duration of the script. Changes to home directory if no argument is supplied. ### chmod([options,] octal_mode || octal_string, file) ### chmod([options,] symbolic_mode, file) Available options: + `-v`: output a diagnostic for every file processed + `-c`: like verbose, but report only when a change is made + `-R`: change files and directories recursively Examples: ```javascript chmod(755, '/Users/brandon'); chmod('755', '/Users/brandon'); // same as above chmod('u+x', '/Users/brandon'); chmod('-R', 'a-w', '/Users/brandon'); ``` Alters the permissions of a file or directory by either specifying the absolute permissions in octal form or expressing the changes in symbols. This command tries to mimic the POSIX behavior as much as possible. Notable exceptions: + In symbolic modes, `a-r` and `-r` are identical. No consideration is given to the `umask`. + There is no "quiet" option, since default behavior is to run silent. ### cp([options,] source [, source ...], dest) ### cp([options,] source_array, dest) Available options: + `-f`: force (default behavior) + `-n`: no-clobber + `-u`: only copy if `source` is newer than `dest` + `-r`, `-R`: recursive + `-L`: follow symlinks + `-P`: don't follow symlinks Examples: ```javascript cp('file1', 'dir1'); cp('-R', 'path/to/dir/', '~/newCopy/'); cp('-Rf', '/tmp/*', '/usr/local/*', '/home/tmp'); cp('-Rf', ['/tmp/*', '/usr/local/*'], '/home/tmp'); // same as above ``` Copies files. ### pushd([options,] [dir | '-N' | '+N']) Available options: + `-n`: Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated. + `-q`: Supresses output to the console. Arguments: + `dir`: Sets the current working directory to the top of the stack, then executes the equivalent of `cd dir`. + `+N`: Brings the Nth directory (counting from the left of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. + `-N`: Brings the Nth directory (counting from the right of the list printed by dirs, starting with zero) to the top of the list by rotating the stack. Examples: ```javascript // process.cwd() === '/usr' pushd('/etc'); // Returns /etc /usr pushd('+1'); // Returns /usr /etc ``` Save the current directory on the top of the directory stack and then `cd` to `dir`. With no arguments, `pushd` exchanges the top two directories. Returns an array of paths in the stack. ### popd([options,] ['-N' | '+N']) Available options: + `-n`: Suppress the normal directory change when removing directories from the stack, so that only the stack is manipulated. + `-q`: Supresses output to the console. Arguments: + `+N`: Removes the Nth directory (counting from the left of the list printed by dirs), starting with zero. + `-N`: Removes the Nth directory (counting from the right of the list printed by dirs), starting with zero. Examples: ```javascript echo(process.cwd()); // '/usr' pushd('/etc'); // '/etc /usr' echo(process.cwd()); // '/etc' popd(); // '/usr' echo(process.cwd()); // '/usr' ``` When no arguments are given, `popd` removes the top directory from the stack and performs a `cd` to the new top directory. The elements are numbered from 0, starting at the first directory listed with dirs (i.e., `popd` is equivalent to `popd +0`). Returns an array of paths in the stack. ### dirs([options | '+N' | '-N']) Available options: + `-c`: Clears the directory stack by deleting all of the elements. + `-q`: Supresses output to the console. Arguments: + `+N`: Displays the Nth directory (counting from the left of the list printed by dirs when invoked without options), starting with zero. + `-N`: Displays the Nth directory (counting from the right of the list printed by dirs when invoked without options), starting with zero. Display the list of currently remembered directories. Returns an array of paths in the stack, or a single path if `+N` or `-N` was specified. See also: `pushd`, `popd` ### echo([options,] string [, string ...]) Available options: + `-e`: interpret backslash escapes (default) + `-n`: remove trailing newline from output Examples: ```javascript echo('hello world'); var str = echo('hello world'); echo('-n', 'no newline at end'); ``` Prints `string` to stdout, and returns string with additional utility methods like `.to()`. ### exec(command [, options] [, callback]) Available options: + `async`: Asynchronous execution. If a callback is provided, it will be set to `true`, regardless of the passed value (default: `false`). + `silent`: Do not echo program output to console (default: `false`). + `encoding`: Character encoding to use. Affects the values returned to stdout and stderr, and what is written to stdout and stderr when not in silent mode (default: `'utf8'`). + and any option available to Node.js's [`child_process.exec()`](https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) Examples: ```javascript var version = exec('node --version', {silent:true}).stdout; var child = exec('some_long_running_process', {async:true}); child.stdout.on('data', function(data) { /* ... do something with data ... */ }); exec('some_long_running_process', function(code, stdout, stderr) { console.log('Exit code:', code); console.log('Program output:', stdout); console.log('Program stderr:', stderr); }); ``` Executes the given `command` _synchronously_, unless otherwise specified. When in synchronous mode, this returns a `ShellString` (compatible with ShellJS v0.6.x, which returns an object of the form `{ code:..., stdout:... , stderr:... }`). Otherwise, this returns the child process object, and the `callback` receives the arguments `(code, stdout, stderr)`. Not seeing the behavior you want? `exec()` runs everything through `sh` by default (or `cmd.exe` on Windows), which differs from `bash`. If you need bash-specific behavior, try out the `{shell: 'path/to/bash'}` option. ### find(path [, path ...]) ### find(path_array) Examples: ```javascript find('src', 'lib'); find(['src', 'lib']); // same as above find('.').filter(function(file) { return file.match(/\.js$/); }); ``` Returns array of all files (however deep) in the given paths. The main difference from `ls('-R', path)` is that the resulting file names include the base directories (e.g., `lib/resources/file1` instead of just `file1`). ### grep([options,] regex_filter, file [, file ...]) ### grep([options,] regex_filter, file_array) Available options: + `-v`: Invert `regex_filter` (only print non-matching lines). + `-l`: Print only filenames of matching files. + `-i`: Ignore case. Examples: ```javascript grep('-v', 'GLOBAL_VARIABLE', '*.js'); grep('GLOBAL_VARIABLE', '*.js'); ``` Reads input string from given files and returns a string containing all lines of the file that match the given `regex_filter`. ### head([{'-n': \<num\>},] file [, file ...]) ### head([{'-n': \<num\>},] file_array) Available options: + `-n <num>`: Show the first `<num>` lines of the files Examples: ```javascript var str = head({'-n': 1}, 'file*.txt'); var str = head('file1', 'file2'); var str = head(['file1', 'file2']); // same as above ``` Read the start of a file. ### ln([options,] source, dest) Available options: + `-s`: symlink + `-f`: force Examples: ```javascript ln('file', 'newlink'); ln('-sf', 'file', 'existing'); ``` Links `source` to `dest`. Use `-f` to force the link, should `dest` already exist. ### ls([options,] [path, ...]) ### ls([options,] path_array) Available options: + `-R`: recursive + `-A`: all files (include files beginning with `.`, except for `.` and `..`) + `-L`: follow symlinks + `-d`: list directories themselves, not their contents + `-l`: list objects representing each file, each with fields containing `ls -l` output fields. See [`fs.Stats`](https://nodejs.org/api/fs.html#fs_class_fs_stats) for more info Examples: ```javascript ls('projs/*.js'); ls('-R', '/users/me', '/tmp'); ls('-R', ['/users/me', '/tmp']); // same as above ls('-l', 'file.txt'); // { name: 'file.txt', mode: 33188, nlink: 1, ...} ``` Returns array of files in the given `path`, or files in the current directory if no `path` is provided. ### mkdir([options,] dir [, dir ...]) ### mkdir([options,] dir_array) Available options: + `-p`: full path (and create intermediate directories, if necessary) Examples: ```javascript mkdir('-p', '/tmp/a/b/c/d', '/tmp/e/f/g'); mkdir('-p', ['/tmp/a/b/c/d', '/tmp/e/f/g']); // same as above ``` Creates directories. ### mv([options ,] source [, source ...], dest') ### mv([options ,] source_array, dest') Available options: + `-f`: force (default behavior) + `-n`: no-clobber Examples: ```javascript mv('-n', 'file', 'dir/'); mv('file1', 'file2', 'dir/'); mv(['file1', 'file2'], 'dir/'); // same as above ``` Moves `source` file(s) to `dest`. ### pwd() Returns the current directory. ### rm([options,] file [, file ...]) ### rm([options,] file_array) Available options: + `-f`: force + `-r, -R`: recursive Examples: ```javascript rm('-rf', '/tmp/*'); rm('some_file.txt', 'another_file.txt'); rm(['some_file.txt', 'another_file.txt']); // same as above ``` Removes files. ### sed([options,] search_regex, replacement, file [, file ...]) ### sed([options,] search_regex, replacement, file_array) Available options: + `-i`: Replace contents of `file` in-place. _Note that no backups will be created!_ Examples: ```javascript sed('-i', 'PROGRAM_VERSION', 'v0.1.3', 'source.js'); sed(/.*DELETE_THIS_LINE.*\n/, '', 'source.js'); ``` Reads an input string from `file`s, and performs a JavaScript `replace()` on the input using the given `search_regex` and `replacement` string or function. Returns the new string after replacement. Note: Like unix `sed`, ShellJS `sed` supports capture groups. Capture groups are specified using the `$n` syntax: ```javascript sed(/(\w+)\s(\w+)/, '$2, $1', 'file.txt'); ``` ### set(options) Available options: + `+/-e`: exit upon error (`config.fatal`) + `+/-v`: verbose: show all commands (`config.verbose`) + `+/-f`: disable filename expansion (globbing) Examples: ```javascript set('-e'); // exit upon first error set('+e'); // this undoes a "set('-e')" ``` Sets global configuration variables. ### sort([options,] file [, file ...]) ### sort([options,] file_array) Available options: + `-r`: Reverse the results + `-n`: Compare according to numerical value Examples: ```javascript sort('foo.txt', 'bar.txt'); sort('-r', 'foo.txt'); ``` Return the contents of the `file`s, sorted line-by-line. Sorting multiple files mixes their content (just as unix `sort` does). ### tail([{'-n': \<num\>},] file [, file ...]) ### tail([{'-n': \<num\>},] file_array) Available options: + `-n <num>`: Show the last `<num>` lines of `file`s Examples: ```javascript var str = tail({'-n': 1}, 'file*.txt'); var str = tail('file1', 'file2'); var str = tail(['file1', 'file2']); // same as above ``` Read the end of a `file`. ### tempdir() Examples: ```javascript var tmp = tempdir(); // "/tmp" for most *nix platforms ``` Searches and returns string containing a writeable, platform-dependent temporary directory. Follows Python's [tempfile algorithm](http://docs.python.org/library/tempfile.html#tempfile.tempdir). ### test(expression) Available expression primaries: + `'-b', 'path'`: true if path is a block device + `'-c', 'path'`: true if path is a character device + `'-d', 'path'`: true if path is a directory + `'-e', 'path'`: true if path exists + `'-f', 'path'`: true if path is a regular file + `'-L', 'path'`: true if path is a symbolic link + `'-p', 'path'`: true if path is a pipe (FIFO) + `'-S', 'path'`: true if path is a socket Examples: ```javascript if (test('-d', path)) { /* do something with dir */ }; if (!test('-f', path)) continue; // skip if it's a regular file ``` Evaluates `expression` using the available primaries and returns corresponding value. ### ShellString.prototype.to(file) Examples: ```javascript cat('input.txt').to('output.txt'); ``` Analogous to the redirection operator `>` in Unix, but works with `ShellStrings` (such as those returned by `cat`, `grep`, etc.). _Like Unix redirections, `to()` will overwrite any existing file!_ ### ShellString.prototype.toEnd(file) Examples: ```javascript cat('input.txt').toEnd('output.txt'); ``` Analogous to the redirect-and-append operator `>>` in Unix, but works with `ShellStrings` (such as those returned by `cat`, `grep`, etc.). ### touch([options,] file [, file ...]) ### touch([options,] file_array) Available options: + `-a`: Change only the access time + `-c`: Do not create any files + `-m`: Change only the modification time + `-d DATE`: Parse `DATE` and use it instead of current time + `-r FILE`: Use `FILE`'s times instead of current time Examples: ```javascript touch('source.js'); touch('-c', '/path/to/some/dir/source.js'); touch({ '-r': FILE }, '/path/to/some/dir/source.js'); ``` Update the access and modification times of each `FILE` to the current time. A `FILE` argument that does not exist is created empty, unless `-c` is supplied. This is a partial implementation of [`touch(1)`](http://linux.die.net/man/1/touch). ### uniq([options,] [input, [output]]) Available options: + `-i`: Ignore case while comparing + `-c`: Prefix lines by the number of occurrences + `-d`: Only print duplicate lines, one for each group of identical lines Examples: ```javascript uniq('foo.txt'); uniq('-i', 'foo.txt'); uniq('-cd', 'foo.txt', 'bar.txt'); ``` Filter adjacent matching lines from `input`. ### which(command) Examples: ```javascript var nodeExec = which('node'); ``` Searches for `command` in the system's `PATH`. On Windows, this uses the `PATHEXT` variable to append the extension if it's not already executable. Returns string containing the absolute path to `command`. ### exit(code) Exits the current process with the given exit `code`. ### error() Tests if error occurred in the last command. Returns a truthy value if an error returned, or a falsy value otherwise. **Note**: do not rely on the return value to be an error message. If you need the last error message, use the `.stderr` attribute from the last command's return value instead. ### ShellString(str) Examples: ```javascript var foo = ShellString('hello world'); ``` Turns a regular string into a string-like object similar to what each command returns. This has special methods, like `.to()` and `.toEnd()`. ### env['VAR_NAME'] Object containing environment variables (both getter and setter). Shortcut to `process.env`. ### Pipes Examples: ```javascript grep('foo', 'file1.txt', 'file2.txt').sed(/o/g, 'a').to('output.txt'); echo('files with o\'s in the name:\n' + ls().grep('o')); cat('test.js').exec('node'); // pipe to exec() call ``` Commands can send their output to another command in a pipe-like fashion. `sed`, `grep`, `cat`, `exec`, `to`, and `toEnd` can appear on the right-hand side of a pipe. Pipes can be chained. ## Configuration ### config.silent Example: ```javascript var sh = require('shelljs'); var silentState = sh.config.silent; // save old silent state sh.config.silent = true; /* ... */ sh.config.silent = silentState; // restore old silent state ``` Suppresses all command output if `true`, except for `echo()` calls. Default is `false`. ### config.fatal Example: ```javascript require('shelljs/global'); config.fatal = true; // or set('-e'); cp('this_file_does_not_exist', '/dev/null'); // throws Error here /* more commands... */ ``` If `true`, the script will throw a Javascript error when any shell.js command encounters an error. Default is `false`. This is analogous to Bash's `set -e`. ### config.verbose Example: ```javascript config.verbose = true; // or set('-v'); cd('dir/'); rm('-rf', 'foo.txt', 'bar.txt'); exec('echo hello'); ``` Will print each command as follows: ``` cd dir/ rm -rf foo.txt bar.txt exec echo hello ``` ### config.globOptions Example: ```javascript config.globOptions = {nodir: true}; ``` Use this value for calls to `glob.sync()` instead of the default options. ### config.reset() Example: ```javascript var shell = require('shelljs'); // Make changes to shell.config, and do stuff... /* ... */ shell.config.reset(); // reset to original state // Do more stuff, but with original settings /* ... */ ``` Reset `shell.config` to the defaults: ```javascript { fatal: false, globOptions: {}, maxdepth: 255, noglob: false, silent: false, verbose: false, } ``` ## Team | [](https://github.com/nfischer) | [](http://github.com/freitagbr) | |:---:|:---:| | [Nate Fischer](https://github.com/nfischer) | [Brandon Freitag](http://github.com/freitagbr) | bs58 ==== [](https://travis-ci.org/cryptocoinjs/bs58) JavaScript component to compute base 58 encoding. This encoding is typically used for crypto currencies such as Bitcoin. **Note:** If you're looking for **base 58 check** encoding, see: [https://github.com/bitcoinjs/bs58check](https://github.com/bitcoinjs/bs58check), which depends upon this library. Install ------- npm i --save bs58 API --- ### encode(input) `input` must be a [Buffer](https://nodejs.org/api/buffer.html) or an `Array`. It returns a `string`. **example**: ```js const bs58 = require('bs58') const bytes = Buffer.from('003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187', 'hex') const address = bs58.encode(bytes) console.log(address) // => 16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS ``` ### decode(input) `input` must be a base 58 encoded string. Returns a [Buffer](https://nodejs.org/api/buffer.html). **example**: ```js const bs58 = require('bs58') const address = '16UjcYNBG9GTK4uq2f7yYEbuifqCzoLMGS' const bytes = bs58.decode(address) console.log(out.toString('hex')) // => 003c176e659bea0f29a3e9bf7880c112b1b31b4dc826268187 ``` Hack / Test ----------- Uses JavaScript standard style. Read more: [](https://github.com/feross/standard) Credits ------- - [Mike Hearn](https://github.com/mikehearn) for original Java implementation - [Stefan Thomas](https://github.com/justmoon) for porting to JavaScript - [Stephan Pair](https://github.com/gasteve) for buffer improvements - [Daniel Cousens](https://github.com/dcousens) for cleanup and merging improvements from bitcoinjs-lib - [Jared Deckard](https://github.com/deckar01) for killing `bigi` as a dependency License ------- MIT binaryen.js =========== **binaryen.js** is a port of [Binaryen](https://github.com/WebAssembly/binaryen) to the Web, allowing you to generate [WebAssembly](https://webassembly.org) using a JavaScript API. <a href="https://github.com/AssemblyScript/binaryen.js/actions?query=workflow%3ABuild"><img src="https://img.shields.io/github/workflow/status/AssemblyScript/binaryen.js/Build/master?label=build&logo=github" alt="Build status" /></a> <a href="https://www.npmjs.com/package/binaryen"><img src="https://img.shields.io/npm/v/binaryen.svg?label=latest&color=007acc&logo=npm" alt="npm version" /></a> <a href="https://www.npmjs.com/package/binaryen"><img src="https://img.shields.io/npm/v/binaryen/nightly.svg?label=nightly&color=007acc&logo=npm" alt="npm nightly version" /></a> Usage ----- ``` $> npm install binaryen ``` ```js var binaryen = require("binaryen"); // Create a module with a single function var myModule = new binaryen.Module(); myModule.addFunction("add", binaryen.createType([ binaryen.i32, binaryen.i32 ]), binaryen.i32, [ binaryen.i32 ], myModule.block(null, [ myModule.local.set(2, myModule.i32.add( myModule.local.get(0, binaryen.i32), myModule.local.get(1, binaryen.i32) ) ), myModule.return( myModule.local.get(2, binaryen.i32) ) ]) ); myModule.addFunctionExport("add", "add"); // Optimize the module using default passes and levels myModule.optimize(); // Validate the module if (!myModule.validate()) throw new Error("validation error"); // Generate text format and binary var textData = myModule.emitText(); var wasmData = myModule.emitBinary(); // Example usage with the WebAssembly API var compiled = new WebAssembly.Module(wasmData); var instance = new WebAssembly.Instance(compiled, {}); console.log(instance.exports.add(41, 1)); ``` The buildbot also publishes nightly versions once a day if there have been changes. The latest nightly can be installed through ``` $> npm install binaryen@nightly ``` or you can use one of the [previous versions](https://github.com/AssemblyScript/binaryen.js/tags) instead if necessary. ### Usage with a CDN * From GitHub via [jsDelivr](https://www.jsdelivr.com):<br /> `https://cdn.jsdelivr.net/gh/AssemblyScript/binaryen.js@VERSION/index.js` * From npm via [jsDelivr](https://www.jsdelivr.com):<br /> `https://cdn.jsdelivr.net/npm/binaryen@VERSION/index.js` * From npm via [unpkg](https://unpkg.com):<br /> `https://unpkg.com/binaryen@VERSION/index.js` Replace `VERSION` with a [specific version](https://github.com/AssemblyScript/binaryen.js/releases) or omit it (not recommended in production) to use master/latest. API --- **Please note** that the Binaryen API is evolving fast and that definitions and documentation provided by the package tend to get out of sync despite our best efforts. It's a bot after all. If you rely on binaryen.js and spot an issue, please consider sending a PR our way by updating [index.d.ts](./index.d.ts) and [README.md](./README.md) to reflect the [current API](https://github.com/WebAssembly/binaryen/blob/master/src/js/binaryen.js-post.js). <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> ### Contents - [Types](#types) - [Module construction](#module-construction) - [Module manipulation](#module-manipulation) - [Module validation](#module-validation) - [Module optimization](#module-optimization) - [Module creation](#module-creation) - [Expression construction](#expression-construction) - [Control flow](#control-flow) - [Variable accesses](#variable-accesses) - [Integer operations](#integer-operations) - [Floating point operations](#floating-point-operations) - [Datatype conversions](#datatype-conversions) - [Function calls](#function-calls) - [Linear memory accesses](#linear-memory-accesses) - [Host operations](#host-operations) - [Vector operations 🦄](#vector-operations-) - [Atomic memory accesses 🦄](#atomic-memory-accesses-) - [Atomic read-modify-write operations 🦄](#atomic-read-modify-write-operations-) - [Atomic wait and notify operations 🦄](#atomic-wait-and-notify-operations-) - [Sign extension operations 🦄](#sign-extension-operations-) - [Multi-value operations 🦄](#multi-value-operations-) - [Exception handling operations 🦄](#exception-handling-operations-) - [Reference types operations 🦄](#reference-types-operations-) - [Expression manipulation](#expression-manipulation) - [Relooper](#relooper) - [Source maps](#source-maps) - [Debugging](#debugging) <!-- END doctoc generated TOC please keep comment here to allow auto update --> [Future features](http://webassembly.org/docs/future-features/) 🦄 might not be supported by all runtimes. ### Types * **none**: `Type`<br /> The none type, e.g., `void`. * **i32**: `Type`<br /> 32-bit integer type. * **i64**: `Type`<br /> 64-bit integer type. * **f32**: `Type`<br /> 32-bit float type. * **f64**: `Type`<br /> 64-bit float (double) type. * **v128**: `Type`<br /> 128-bit vector type. 🦄 * **funcref**: `Type`<br /> A function reference. 🦄 * **anyref**: `Type`<br /> Any host reference. 🦄 * **nullref**: `Type`<br /> A null reference. 🦄 * **exnref**: `Type`<br /> An exception reference. 🦄 * **unreachable**: `Type`<br /> Special type indicating unreachable code when obtaining information about an expression. * **auto**: `Type`<br /> Special type used in **Module#block** exclusively. Lets the API figure out a block's result type automatically. * **createType**(types: `Type[]`): `Type`<br /> Creates a multi-value type from an array of types. * **expandType**(type: `Type`): `Type[]`<br /> Expands a multi-value type to an array of types. ### Module construction * new **Module**()<br /> Constructs a new module. * **parseText**(text: `string`): `Module`<br /> Creates a module from Binaryen's s-expression text format (not official stack-style text format). * **readBinary**(data: `Uint8Array`): `Module`<br /> Creates a module from binary data. ### Module manipulation * Module#**addFunction**(name: `string`, params: `Type`, results: `Type`, vars: `Type[]`, body: `ExpressionRef`): `FunctionRef`<br /> Adds a function. `vars` indicate additional locals, in the given order. * Module#**getFunction**(name: `string`): `FunctionRef`<br /> Gets a function, by name, * Module#**removeFunction**(name: `string`): `void`<br /> Removes a function, by name. * Module#**getNumFunctions**(): `number`<br /> Gets the number of functions within the module. * Module#**getFunctionByIndex**(index: `number`): `FunctionRef`<br /> Gets the function at the specified index. * Module#**addFunctionImport**(internalName: `string`, externalModuleName: `string`, externalBaseName: `string`, params: `Type`, results: `Type`): `void`<br /> Adds a function import. * Module#**addTableImport**(internalName: `string`, externalModuleName: `string`, externalBaseName: `string`): `void`<br /> Adds a table import. There's just one table for now, using name `"0"`. * Module#**addMemoryImport**(internalName: `string`, externalModuleName: `string`, externalBaseName: `string`): `void`<br /> Adds a memory import. There's just one memory for now, using name `"0"`. * Module#**addGlobalImport**(internalName: `string`, externalModuleName: `string`, externalBaseName: `string`, globalType: `Type`): `void`<br /> Adds a global variable import. Imported globals must be immutable. * Module#**addFunctionExport**(internalName: `string`, externalName: `string`): `ExportRef`<br /> Adds a function export. * Module#**addTableExport**(internalName: `string`, externalName: `string`): `ExportRef`<br /> Adds a table export. There's just one table for now, using name `"0"`. * Module#**addMemoryExport**(internalName: `string`, externalName: `string`): `ExportRef`<br /> Adds a memory export. There's just one memory for now, using name `"0"`. * Module#**addGlobalExport**(internalName: `string`, externalName: `string`): `ExportRef`<br /> Adds a global variable export. Exported globals must be immutable. * Module#**getNumExports**(): `number`<br /> Gets the number of exports witin the module. * Module#**getExportByIndex**(index: `number`): `ExportRef`<br /> Gets the export at the specified index. * Module#**removeExport**(externalName: `string`): `void`<br /> Removes an export, by external name. * Module#**addGlobal**(name: `string`, type: `Type`, mutable: `number`, value: `ExpressionRef`): `GlobalRef`<br /> Adds a global instance variable. * Module#**getGlobal**(name: `string`): `GlobalRef`<br /> Gets a global, by name, * Module#**removeGlobal**(name: `string`): `void`<br /> Removes a global, by name. * Module#**setFunctionTable**(initial: `number`, maximum: `number`, funcs: `string[]`, offset?: `ExpressionRef`): `void`<br /> Sets the contents of the function table. There's just one table for now, using name `"0"`. * Module#**getFunctionTable**(): `{ imported: boolean, segments: TableElement[] }`<br /> Gets the contents of the function table. * TableElement#**offset**: `ExpressionRef` * TableElement#**names**: `string[]` * Module#**setMemory**(initial: `number`, maximum: `number`, exportName: `string | null`, segments: `MemorySegment[]`, flags?: `number[]`, shared?: `boolean`): `void`<br /> Sets the memory. There's just one memory for now, using name `"0"`. Providing `exportName` also creates a memory export. * MemorySegment#**offset**: `ExpressionRef` * MemorySegment#**data**: `Uint8Array` * MemorySegment#**passive**: `boolean` * Module#**getNumMemorySegments**(): `number`<br /> Gets the number of memory segments within the module. * Module#**getMemorySegmentInfoByIndex**(index: `number`): `MemorySegmentInfo`<br /> Gets information about the memory segment at the specified index. * MemorySegmentInfo#**offset**: `number` * MemorySegmentInfo#**data**: `Uint8Array` * MemorySegmentInfo#**passive**: `boolean` * Module#**setStart**(start: `FunctionRef`): `void`<br /> Sets the start function. * Module#**getFeatures**(): `Features`<br /> Gets the WebAssembly features enabled for this module. Note that the return value may be a bitmask indicating multiple features. Possible feature flags are: * Features.**MVP**: `Features` * Features.**Atomics**: `Features` * Features.**BulkMemory**: `Features` * Features.**MutableGlobals**: `Features` * Features.**NontrappingFPToInt**: `Features` * Features.**SignExt**: `Features` * Features.**SIMD128**: `Features` * Features.**ExceptionHandling**: `Features` * Features.**TailCall**: `Features` * Features.**ReferenceTypes**: `Features` * Features.**Multivalue**: `Features` * Features.**All**: `Features` * Module#**setFeatures**(features: `Features`): `void`<br /> Sets the WebAssembly features enabled for this module. * Module#**addCustomSection**(name: `string`, contents: `Uint8Array`): `void`<br /> Adds a custom section to the binary. * Module#**autoDrop**(): `void`<br /> Enables automatic insertion of `drop` operations where needed. Lets you not worry about dropping when creating your code. * **getFunctionInfo**(ftype: `FunctionRef`: `FunctionInfo`<br /> Obtains information about a function. * FunctionInfo#**name**: `string` * FunctionInfo#**module**: `string | null` (if imported) * FunctionInfo#**base**: `string | null` (if imported) * FunctionInfo#**params**: `Type` * FunctionInfo#**results**: `Type` * FunctionInfo#**vars**: `Type` * FunctionInfo#**body**: `ExpressionRef` * **getGlobalInfo**(global: `GlobalRef`): `GlobalInfo`<br /> Obtains information about a global. * GlobalInfo#**name**: `string` * GlobalInfo#**module**: `string | null` (if imported) * GlobalInfo#**base**: `string | null` (if imported) * GlobalInfo#**type**: `Type` * GlobalInfo#**mutable**: `boolean` * GlobalInfo#**init**: `ExpressionRef` * **getExportInfo**(export_: `ExportRef`): `ExportInfo`<br /> Obtains information about an export. * ExportInfo#**kind**: `ExternalKind` * ExportInfo#**name**: `string` * ExportInfo#**value**: `string` Possible `ExternalKind` values are: * **ExternalFunction**: `ExternalKind` * **ExternalTable**: `ExternalKind` * **ExternalMemory**: `ExternalKind` * **ExternalGlobal**: `ExternalKind` * **ExternalEvent**: `ExternalKind` * **getEventInfo**(event: `EventRef`): `EventInfo`<br /> Obtains information about an event. * EventInfo#**name**: `string` * EventInfo#**module**: `string | null` (if imported) * EventInfo#**base**: `string | null` (if imported) * EventInfo#**attribute**: `number` * EventInfo#**params**: `Type` * EventInfo#**results**: `Type` * **getSideEffects**(expr: `ExpressionRef`, features: `FeatureFlags`): `SideEffects`<br /> Gets the side effects of the specified expression. * SideEffects.**None**: `SideEffects` * SideEffects.**Branches**: `SideEffects` * SideEffects.**Calls**: `SideEffects` * SideEffects.**ReadsLocal**: `SideEffects` * SideEffects.**WritesLocal**: `SideEffects` * SideEffects.**ReadsGlobal**: `SideEffects` * SideEffects.**WritesGlobal**: `SideEffects` * SideEffects.**ReadsMemory**: `SideEffects` * SideEffects.**WritesMemory**: `SideEffects` * SideEffects.**ImplicitTrap**: `SideEffects` * SideEffects.**IsAtomic**: `SideEffects` * SideEffects.**Throws**: `SideEffects` * SideEffects.**Any**: `SideEffects` ### Module validation * Module#**validate**(): `boolean`<br /> Validates the module. Returns `true` if valid, otherwise prints validation errors and returns `false`. ### Module optimization * Module#**optimize**(): `void`<br /> Optimizes the module using the default optimization passes. * Module#**optimizeFunction**(func: `FunctionRef | string`): `void`<br /> Optimizes a single function using the default optimization passes. * Module#**runPasses**(passes: `string[]`): `void`<br /> Runs the specified passes on the module. * Module#**runPassesOnFunction**(func: `FunctionRef | string`, passes: `string[]`): `void`<br /> Runs the specified passes on a single function. * **getOptimizeLevel**(): `number`<br /> Gets the currently set optimize level. `0`, `1`, `2` correspond to `-O0`, `-O1`, `-O2` (default), etc. * **setOptimizeLevel**(level: `number`): `void`<br /> Sets the optimization level to use. `0`, `1`, `2` correspond to `-O0`, `-O1`, `-O2` (default), etc. * **getShrinkLevel**(): `number`<br /> Gets the currently set shrink level. `0`, `1`, `2` correspond to `-O0`, `-Os` (default), `-Oz`. * **setShrinkLevel**(level: `number`): `void`<br /> Sets the shrink level to use. `0`, `1`, `2` correspond to `-O0`, `-Os` (default), `-Oz`. * **getDebugInfo**(): `boolean`<br /> Gets whether generating debug information is currently enabled or not. * **setDebugInfo**(on: `boolean`): `void`<br /> Enables or disables debug information in emitted binaries. * **getLowMemoryUnused**(): `boolean`<br /> Gets whether the low 1K of memory can be considered unused when optimizing. * **setLowMemoryUnused**(on: `boolean`): `void`<br /> Enables or disables whether the low 1K of memory can be considered unused when optimizing. * **getPassArgument**(key: `string`): `string | null`<br /> Gets the value of the specified arbitrary pass argument. * **setPassArgument**(key: `string`, value: `string | null`): `void`<br /> Sets the value of the specified arbitrary pass argument. Removes the respective argument if `value` is `null`. * **clearPassArguments**(): `void`<br /> Clears all arbitrary pass arguments. * **getAlwaysInlineMaxSize**(): `number`<br /> Gets the function size at which we always inline. * **setAlwaysInlineMaxSize**(size: `number`): `void`<br /> Sets the function size at which we always inline. * **getFlexibleInlineMaxSize**(): `number`<br /> Gets the function size which we inline when functions are lightweight. * **setFlexibleInlineMaxSize**(size: `number`): `void`<br /> Sets the function size which we inline when functions are lightweight. * **getOneCallerInlineMaxSize**(): `number`<br /> Gets the function size which we inline when there is only one caller. * **setOneCallerInlineMaxSize**(size: `number`): `void`<br /> Sets the function size which we inline when there is only one caller. ### Module creation * Module#**emitBinary**(): `Uint8Array`<br /> Returns the module in binary format. * Module#**emitBinary**(sourceMapUrl: `string | null`): `BinaryWithSourceMap`<br /> Returns the module in binary format with its source map. If `sourceMapUrl` is `null`, source map generation is skipped. * BinaryWithSourceMap#**binary**: `Uint8Array` * BinaryWithSourceMap#**sourceMap**: `string | null` * Module#**emitText**(): `string`<br /> Returns the module in Binaryen's s-expression text format (not official stack-style text format). * Module#**emitAsmjs**(): `string`<br /> Returns the [asm.js](http://asmjs.org/) representation of the module. * Module#**dispose**(): `void`<br /> Releases the resources held by the module once it isn't needed anymore. ### Expression construction #### [Control flow](http://webassembly.org/docs/semantics/#control-constructs-and-instructions) * Module#**block**(label: `string | null`, children: `ExpressionRef[]`, resultType?: `Type`): `ExpressionRef`<br /> Creates a block. `resultType` defaults to `none`. * Module#**if**(condition: `ExpressionRef`, ifTrue: `ExpressionRef`, ifFalse?: `ExpressionRef`): `ExpressionRef`<br /> Creates an if or if/else combination. * Module#**loop**(label: `string | null`, body: `ExpressionRef`): `ExpressionRef`<br /> Creates a loop. * Module#**br**(label: `string`, condition?: `ExpressionRef`, value?: `ExpressionRef`): `ExpressionRef`<br /> Creates a branch (br) to a label. * Module#**switch**(labels: `string[]`, defaultLabel: `string`, condition: `ExpressionRef`, value?: `ExpressionRef`): `ExpressionRef`<br /> Creates a switch (br_table). * Module#**nop**(): `ExpressionRef`<br /> Creates a no-operation (nop) instruction. * Module#**return**(value?: `ExpressionRef`): `ExpressionRef` Creates a return. * Module#**unreachable**(): `ExpressionRef`<br /> Creates an [unreachable](http://webassembly.org/docs/semantics/#unreachable) instruction that will always trap. * Module#**drop**(value: `ExpressionRef`): `ExpressionRef`<br /> Creates a [drop](http://webassembly.org/docs/semantics/#type-parametric-operators) of a value. * Module#**select**(condition: `ExpressionRef`, ifTrue: `ExpressionRef`, ifFalse: `ExpressionRef`, type?: `Type`): `ExpressionRef`<br /> Creates a [select](http://webassembly.org/docs/semantics/#type-parametric-operators) of one of two values. #### [Variable accesses](http://webassembly.org/docs/semantics/#local-variables) * Module#**local.get**(index: `number`, type: `Type`): `ExpressionRef`<br /> Creates a local.get for the local at the specified index. Note that we must specify the type here as we may not have created the local being accessed yet. * Module#**local.set**(index: `number`, value: `ExpressionRef`): `ExpressionRef`<br /> Creates a local.set for the local at the specified index. * Module#**local.tee**(index: `number`, value: `ExpressionRef`, type: `Type`): `ExpressionRef`<br /> Creates a local.tee for the local at the specified index. A tee differs from a set in that the value remains on the stack. Note that we must specify the type here as we may not have created the local being accessed yet. * Module#**global.get**(name: `string`, type: `Type`): `ExpressionRef`<br /> Creates a global.get for the global with the specified name. Note that we must specify the type here as we may not have created the global being accessed yet. * Module#**global.set**(name: `string`, value: `ExpressionRef`): `ExpressionRef`<br /> Creates a global.set for the global with the specified name. #### [Integer operations](http://webassembly.org/docs/semantics/#32-bit-integer-operators) * Module#i32.**const**(value: `number`): `ExpressionRef` * Module#i32.**clz**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**ctz**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**popcnt**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**eqz**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**div_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**div_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**rem_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**rem_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**and**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**or**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**xor**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**shl**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**shr_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**shr_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**rotl**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**rotr**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**lt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**le_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**le_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**gt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**gt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**ge_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32.**ge_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` > * Module#i64.**const**(low: `number`, high: `number`): `ExpressionRef` * Module#i64.**clz**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**ctz**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**popcnt**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**eqz**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**div_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**div_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**rem_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**rem_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**and**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**or**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**xor**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**shl**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**shr_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**shr_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**rotl**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**rotr**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**lt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**le_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**le_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**gt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**gt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**ge_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64.**ge_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` #### [Floating point operations](http://webassembly.org/docs/semantics/#floating-point-operators) * Module#f32.**const**(value: `number`): `ExpressionRef` * Module#f32.**const_bits**(value: `number`): `ExpressionRef` * Module#f32.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**abs**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**ceil**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**floor**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**trunc**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**nearest**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**sqrt**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**div**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**copysign**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**min**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**max**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**lt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**le**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**gt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32.**ge**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` > * Module#f64.**const**(value: `number`): `ExpressionRef` * Module#f64.**const_bits**(value: `number`): `ExpressionRef` * Module#f64.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**abs**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**ceil**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**floor**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**trunc**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**nearest**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**sqrt**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**div**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**copysign**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**min**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**max**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**lt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**le**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**gt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64.**ge**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` #### [Datatype conversions](http://webassembly.org/docs/semantics/#datatype-conversions-truncations-reinterpretations-promotions-and-demotions) * Module#i32.**trunc_s.f32**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**trunc_s.f64**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**trunc_u.f32**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**trunc_u.f64**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**reinterpret**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**wrap**(value: `ExpressionRef`): `ExpressionRef` > * Module#i64.**trunc_s.f32**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**trunc_s.f64**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**trunc_u.f32**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**trunc_u.f64**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**reinterpret**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**extend_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**extend_u**(value: `ExpressionRef`): `ExpressionRef` > * Module#f32.**reinterpret**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**convert_s.i32**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**convert_s.i64**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**convert_u.i32**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**convert_u.i64**(value: `ExpressionRef`): `ExpressionRef` * Module#f32.**demote**(value: `ExpressionRef`): `ExpressionRef` > * Module#f64.**reinterpret**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**convert_s.i32**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**convert_s.i64**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**convert_u.i32**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**convert_u.i64**(value: `ExpressionRef`): `ExpressionRef` * Module#f64.**promote**(value: `ExpressionRef`): `ExpressionRef` #### [Function calls](http://webassembly.org/docs/semantics/#calls) * Module#**call**(name: `string`, operands: `ExpressionRef[]`, returnType: `Type`): `ExpressionRef` Creates a call to a function. Note that we must specify the return type here as we may not have created the function being called yet. * Module#**return_call**(name: `string`, operands: `ExpressionRef[]`, returnType: `Type`): `ExpressionRef`<br /> Like **call**, but creates a tail-call. 🦄 * Module#**call_indirect**(target: `ExpressionRef`, operands: `ExpressionRef[]`, params: `Type`, results: `Type`): `ExpressionRef`<br /> Similar to **call**, but calls indirectly, i.e., via a function pointer, so an expression replaces the name as the called value. * Module#**return_call_indirect**(target: `ExpressionRef`, operands: `ExpressionRef[]`, params: `Type`, results: `Type`): `ExpressionRef`<br /> Like **call_indirect**, but creates a tail-call. 🦄 #### [Linear memory accesses](http://webassembly.org/docs/semantics/#linear-memory-accesses) * Module#i32.**load**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**load8_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**load8_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**load16_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**load16_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**store**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**store8**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef`<br /> * Module#i32.**store16**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef`<br /> > * Module#i64.**load**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load8_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load8_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load16_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load16_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load32_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**load32_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**store**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**store8**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**store16**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**store32**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` > * Module#f32.**load**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#f32.**store**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` > * Module#f64.**load**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#f64.**store**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` #### [Host operations](http://webassembly.org/docs/semantics/#resizing) * Module#**memory.size**(): `ExpressionRef` * Module#**memory.grow**(value: `number`): `ExpressionRef` #### [Vector operations](https://github.com/WebAssembly/simd/blob/master/proposals/simd/SIMD.md) 🦄 * Module#v128.**const**(bytes: `Uint8Array`): `ExpressionRef` * Module#v128.**load**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#v128.**store**(offset: `number`, align: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#v128.**not**(value: `ExpressionRef`): `ExpressionRef` * Module#v128.**and**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#v128.**or**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#v128.**xor**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#v128.**andnot**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#v128.**bitselect**(left: `ExpressionRef`, right: `ExpressionRef`, cond: `ExpressionRef`): `ExpressionRef` > * Module#i8x16.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**extract_lane_s**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i8x16.**extract_lane_u**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i8x16.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**lt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**gt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**gt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**le_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**ge_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**ge_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**any_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**all_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**shl**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**shr_s**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**shr_u**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**add_saturate_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**add_saturate_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**sub_saturate_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**sub_saturate_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**min_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**min_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**max_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**max_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**avgr_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**narrow_i16x8_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i8x16.**narrow_i16x8_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` > * Module#i16x8.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**extract_lane_s**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i16x8.**extract_lane_u**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i16x8.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**lt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**gt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**gt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**le_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**ge_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**ge_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**any_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**all_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**shl**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**shr_s**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**shr_u**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**add_saturate_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**add_saturate_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**sub_saturate_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**sub_saturate_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**min_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**min_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**max_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**max_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**avgr_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**narrow_i32x4_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**narrow_i32x4_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**widen_low_i8x16_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**widen_high_i8x16_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**widen_low_i8x16_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**widen_high_i8x16_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**load8x8_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i16x8.**load8x8_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#i32x4.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**extract_lane_s**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i32x4.**extract_lane_u**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i32x4.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**lt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**gt_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**gt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**le_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**lt_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**ge_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**ge_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**any_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**all_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**shl**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**shr_s**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**shr_u**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**min_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**min_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**max_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**max_u**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**dot_i16x8_s**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**trunc_sat_f32x4_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**trunc_sat_f32x4_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**widen_low_i16x8_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**widen_high_i16x8_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**widen_low_i16x8_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**widen_high_i16x8_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**load16x4_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i32x4.**load16x4_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#i64x2.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**extract_lane_s**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i64x2.**extract_lane_u**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#i64x2.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**any_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**all_true**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**shl**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**shr_s**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**shr_u**(vec: `ExpressionRef`, shift: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**trunc_sat_f64x2_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**trunc_sat_f64x2_u**(value: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**load32x2_s**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64x2.**load32x2_u**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#f32x4.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**extract_lane**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#f32x4.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**lt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**gt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**le**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**ge**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**abs**(value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**sqrt**(value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**qfma**(a: `ExpressionRef`, b: `ExpressionRef`, c: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**qfms**(a: `ExpressionRef`, b: `ExpressionRef`, c: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**div**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**min**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**max**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**convert_i32x4_s**(value: `ExpressionRef`): `ExpressionRef` * Module#f32x4.**convert_i32x4_u**(value: `ExpressionRef`): `ExpressionRef` > * Module#f64x2.**splat**(value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**extract_lane**(vec: `ExpressionRef`, index: `number`): `ExpressionRef` * Module#f64x2.**replace_lane**(vec: `ExpressionRef`, index: `number`, value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**eq**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**ne**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**lt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**gt**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**le**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**ge**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**abs**(value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**neg**(value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**sqrt**(value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**qfma**(a: `ExpressionRef`, b: `ExpressionRef`, c: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**qfms**(a: `ExpressionRef`, b: `ExpressionRef`, c: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**add**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**sub**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**mul**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**div**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**min**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**max**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**convert_i64x2_s**(value: `ExpressionRef`): `ExpressionRef` * Module#f64x2.**convert_i64x2_u**(value: `ExpressionRef`): `ExpressionRef` > * Module#v8x16.**shuffle**(left: `ExpressionRef`, right: `ExpressionRef`, mask: `Uint8Array`): `ExpressionRef` * Module#v8x16.**swizzle**(left: `ExpressionRef`, right: `ExpressionRef`): `ExpressionRef` * Module#v8x16.**load_splat**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#v16x8.**load_splat**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#v32x4.**load_splat**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` > * Module#v64x2.**load_splat**(offset: `number`, align: `number`, ptr: `ExpressionRef`): `ExpressionRef` #### [Atomic memory accesses](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md#atomic-memory-accesses) 🦄 * Module#i32.**atomic.load**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.load8_u**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.load16_u**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.store**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.store8**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.store16**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` > * Module#i64.**atomic.load**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.load8_u**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.load16_u**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.load32_u**(offset: `number`, ptr: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.store**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.store8**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.store16**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.store32**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` #### [Atomic read-modify-write operations](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md#read-modify-write) 🦄 * Module#i32.**atomic.rmw.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw8_u.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i32.**atomic.rmw16_u.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` > * Module#i64.**atomic.rmw.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw8_u.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw16_u.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.add**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.sub**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.and**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.or**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.xor**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.xchg**(offset: `number`, ptr: `ExpressionRef`, value: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.rmw32_u.cmpxchg**(offset: `number`, ptr: `ExpressionRef`, expected: `ExpressionRef`, replacement: `ExpressionRef`): `ExpressionRef` #### [Atomic wait and notify operations](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md#wait-and-notify-operators) 🦄 * Module#i32.**atomic.wait**(ptr: `ExpressionRef`, expected: `ExpressionRef`, timeout: `ExpressionRef`): `ExpressionRef` * Module#i64.**atomic.wait**(ptr: `ExpressionRef`, expected: `ExpressionRef`, timeout: `ExpressionRef`): `ExpressionRef` * Module#**atomic.notify**(ptr: `ExpressionRef`, notifyCount: `ExpressionRef`): `ExpressionRef` * Module#**atomic.fence**(): `ExpressionRef` #### [Sign extension operations](https://github.com/WebAssembly/sign-extension-ops/blob/master/proposals/sign-extension-ops/Overview.md) 🦄 * Module#i32.**extend8_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**extend16_s**(value: `ExpressionRef`): `ExpressionRef` > * Module#i64.**extend8_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**extend16_s**(value: `ExpressionRef`): `ExpressionRef` * Module#i64.**extend32_s**(value: `ExpressionRef`): `ExpressionRef` #### [Multi-value operations](https://github.com/WebAssembly/multi-value/blob/master/proposals/multi-value/Overview.md) 🦄 Note that these are pseudo instructions enabling Binaryen to reason about multiple values on the stack. * Module#**push**(value: `ExpressionRef`): `ExpressionRef` * Module#i32.**pop**(): `ExpressionRef` * Module#i64.**pop**(): `ExpressionRef` * Module#f32.**pop**(): `ExpressionRef` * Module#f64.**pop**(): `ExpressionRef` * Module#v128.**pop**(): `ExpressionRef` * Module#funcref.**pop**(): `ExpressionRef` * Module#anyref.**pop**(): `ExpressionRef` * Module#nullref.**pop**(): `ExpressionRef` * Module#exnref.**pop**(): `ExpressionRef` * Module#tuple.**make**(elements: `ExpressionRef[]`): `ExpressionRef` * Module#tuple.**extract**(tuple: `ExpressionRef`, index: `number`): `ExpressionRef` #### [Exception handling operations](https://github.com/WebAssembly/exception-handling/blob/master/proposals/Exceptions.md) 🦄 * Module#**try**(body: `ExpressionRef`, catchBody: `ExpressionRef`): `ExpressionRef` * Module#**throw**(event: `string`, operands: `ExpressionRef[]`): `ExpressionRef` * Module#**rethrow**(exnref: `ExpressionRef`): `ExpressionRef` * Module#**br_on_exn**(label: `string`, event: `string`, exnref: `ExpressionRef`): `ExpressionRef` > * Module#**addEvent**(name: `string`, attribute: `number`, params: `Type`, results: `Type`): `Event` * Module#**getEvent**(name: `string`): `Event` * Module#**removeEvent**(name: `stirng`): `void` * Module#**addEventImport**(internalName: `string`, externalModuleName: `string`, externalBaseName: `string`, attribute: `number`, params: `Type`, results: `Type`): `void` * Module#**addEventExport**(internalName: `string`, externalName: `string`): `ExportRef` #### [Reference types operations](https://github.com/WebAssembly/reference-types/blob/master/proposals/reference-types/Overview.md) 🦄 * Module#ref.**null**(): `ExpressionRef` * Module#ref.**is_null**(value: `ExpressionRef`): `ExpressionRef` * Module#ref.**func**(name: `string`): `ExpressionRef` ### Expression manipulation * **getExpressionId**(expr: `ExpressionRef`): `ExpressionId`<br /> Gets the id (kind) of the specified expression. Possible values are: * **InvalidId**: `ExpressionId` * **BlockId**: `ExpressionId` * **IfId**: `ExpressionId` * **LoopId**: `ExpressionId` * **BreakId**: `ExpressionId` * **SwitchId**: `ExpressionId` * **CallId**: `ExpressionId` * **CallIndirectId**: `ExpressionId` * **LocalGetId**: `ExpressionId` * **LocalSetId**: `ExpressionId` * **GlobalGetId**: `ExpressionId` * **GlobalSetId**: `ExpressionId` * **LoadId**: `ExpressionId` * **StoreId**: `ExpressionId` * **ConstId**: `ExpressionId` * **UnaryId**: `ExpressionId` * **BinaryId**: `ExpressionId` * **SelectId**: `ExpressionId` * **DropId**: `ExpressionId` * **ReturnId**: `ExpressionId` * **HostId**: `ExpressionId` * **NopId**: `ExpressionId` * **UnreachableId**: `ExpressionId` * **AtomicCmpxchgId**: `ExpressionId` * **AtomicRMWId**: `ExpressionId` * **AtomicWaitId**: `ExpressionId` * **AtomicNotifyId**: `ExpressionId` * **AtomicFenceId**: `ExpressionId` * **SIMDExtractId**: `ExpressionId` * **SIMDReplaceId**: `ExpressionId` * **SIMDShuffleId**: `ExpressionId` * **SIMDTernaryId**: `ExpressionId` * **SIMDShiftId**: `ExpressionId` * **SIMDLoadId**: `ExpressionId` * **MemoryInitId**: `ExpressionId` * **DataDropId**: `ExpressionId` * **MemoryCopyId**: `ExpressionId` * **MemoryFillId**: `ExpressionId` * **RefNullId**: `ExpressionId` * **RefIsNullId**: `ExpressionId` * **RefFuncId**: `ExpressionId` * **TryId**: `ExpressionId` * **ThrowId**: `ExpressionId` * **RethrowId**: `ExpressionId` * **BrOnExnId**: `ExpressionId` * **PushId**: `ExpressionId` * **PopId**: `ExpressionId` * **getExpressionType**(expr: `ExpressionRef`): `Type`<br /> Gets the type of the specified expression. * **getExpressionInfo**(expr: `ExpressionRef`): `ExpressionInfo`<br /> Obtains information about an expression, always including: * Info#**id**: `ExpressionId` * Info#**type**: `Type` Additional properties depend on the expression's `id` and are usually equivalent to the respective parameters when creating such an expression: * BlockInfo#**name**: `string` * BlockInfo#**children**: `ExpressionRef[]` > * IfInfo#**condition**: `ExpressionRef` * IfInfo#**ifTrue**: `ExpressionRef` * IfInfo#**ifFalse**: `ExpressionRef | null` > * LoopInfo#**name**: `string` * LoopInfo#**body**: `ExpressionRef` > * BreakInfo#**name**: `string` * BreakInfo#**condition**: `ExpressionRef | null` * BreakInfo#**value**: `ExpressionRef | null` > * SwitchInfo#**names**: `string[]` * SwitchInfo#**defaultName**: `string | null` * SwitchInfo#**condition**: `ExpressionRef` * SwitchInfo#**value**: `ExpressionRef | null` > * CallInfo#**target**: `string` * CallInfo#**operands**: `ExpressionRef[]` > * CallImportInfo#**target**: `string` * CallImportInfo#**operands**: `ExpressionRef[]` > * CallIndirectInfo#**target**: `ExpressionRef` * CallIndirectInfo#**operands**: `ExpressionRef[]` > * LocalGetInfo#**index**: `number` > * LocalSetInfo#**isTee**: `boolean` * LocalSetInfo#**index**: `number` * LocalSetInfo#**value**: `ExpressionRef` > * GlobalGetInfo#**name**: `string` > * GlobalSetInfo#**name**: `string` * GlobalSetInfo#**value**: `ExpressionRef` > * LoadInfo#**isAtomic**: `boolean` * LoadInfo#**isSigned**: `boolean` * LoadInfo#**offset**: `number` * LoadInfo#**bytes**: `number` * LoadInfo#**align**: `number` * LoadInfo#**ptr**: `ExpressionRef` > * StoreInfo#**isAtomic**: `boolean` * StoreInfo#**offset**: `number` * StoreInfo#**bytes**: `number` * StoreInfo#**align**: `number` * StoreInfo#**ptr**: `ExpressionRef` * StoreInfo#**value**: `ExpressionRef` > * ConstInfo#**value**: `number | { low: number, high: number }` > * UnaryInfo#**op**: `number` * UnaryInfo#**value**: `ExpressionRef` > * BinaryInfo#**op**: `number` * BinaryInfo#**left**: `ExpressionRef` * BinaryInfo#**right**: `ExpressionRef` > * SelectInfo#**ifTrue**: `ExpressionRef` * SelectInfo#**ifFalse**: `ExpressionRef` * SelectInfo#**condition**: `ExpressionRef` > * DropInfo#**value**: `ExpressionRef` > * ReturnInfo#**value**: `ExpressionRef | null` > * NopInfo > * UnreachableInfo > * HostInfo#**op**: `number` * HostInfo#**nameOperand**: `string | null` * HostInfo#**operands**: `ExpressionRef[]` > * AtomicRMWInfo#**op**: `number` * AtomicRMWInfo#**bytes**: `number` * AtomicRMWInfo#**offset**: `number` * AtomicRMWInfo#**ptr**: `ExpressionRef` * AtomicRMWInfo#**value**: `ExpressionRef` > * AtomicCmpxchgInfo#**bytes**: `number` * AtomicCmpxchgInfo#**offset**: `number` * AtomicCmpxchgInfo#**ptr**: `ExpressionRef` * AtomicCmpxchgInfo#**expected**: `ExpressionRef` * AtomicCmpxchgInfo#**replacement**: `ExpressionRef` > * AtomicWaitInfo#**ptr**: `ExpressionRef` * AtomicWaitInfo#**expected**: `ExpressionRef` * AtomicWaitInfo#**timeout**: `ExpressionRef` * AtomicWaitInfo#**expectedType**: `Type` > * AtomicNotifyInfo#**ptr**: `ExpressionRef` * AtomicNotifyInfo#**notifyCount**: `ExpressionRef` > * AtomicFenceInfo > * SIMDExtractInfo#**op**: `Op` * SIMDExtractInfo#**vec**: `ExpressionRef` * SIMDExtractInfo#**index**: `ExpressionRef` > * SIMDReplaceInfo#**op**: `Op` * SIMDReplaceInfo#**vec**: `ExpressionRef` * SIMDReplaceInfo#**index**: `ExpressionRef` * SIMDReplaceInfo#**value**: `ExpressionRef` > * SIMDShuffleInfo#**left**: `ExpressionRef` * SIMDShuffleInfo#**right**: `ExpressionRef` * SIMDShuffleInfo#**mask**: `Uint8Array` > * SIMDTernaryInfo#**op**: `Op` * SIMDTernaryInfo#**a**: `ExpressionRef` * SIMDTernaryInfo#**b**: `ExpressionRef` * SIMDTernaryInfo#**c**: `ExpressionRef` > * SIMDShiftInfo#**op**: `Op` * SIMDShiftInfo#**vec**: `ExpressionRef` * SIMDShiftInfo#**shift**: `ExpressionRef` > * SIMDLoadInfo#**op**: `Op` * SIMDLoadInfo#**offset**: `number` * SIMDLoadInfo#**align**: `number` * SIMDLoadInfo#**ptr**: `ExpressionRef` > * MemoryInitInfo#**segment**: `number` * MemoryInitInfo#**dest**: `ExpressionRef` * MemoryInitInfo#**offset**: `ExpressionRef` * MemoryInitInfo#**size**: `ExpressionRef` > * MemoryDropInfo#**segment**: `number` > * MemoryCopyInfo#**dest**: `ExpressionRef` * MemoryCopyInfo#**source**: `ExpressionRef` * MemoryCopyInfo#**size**: `ExpressionRef` > * MemoryFillInfo#**dest**: `ExpressionRef` * MemoryFillInfo#**value**: `ExpressionRef` * MemoryFillInfo#**size**: `ExpressionRef` > * TryInfo#**body**: `ExpressionRef` * TryInfo#**catchBody**: `ExpressionRef` > * RefNullInfo > * RefIsNullInfo#**value**: `ExpressionRef` > * RefFuncInfo#**func**: `string` > * ThrowInfo#**event**: `string` * ThrowInfo#**operands**: `ExpressionRef[]` > * RethrowInfo#**exnref**: `ExpressionRef` > * BrOnExnInfo#**name**: `string` * BrOnExnInfo#**event**: `string` * BrOnExnInfo#**exnref**: `ExpressionRef` > * PopInfo > * PushInfo#**value**: `ExpressionRef` * **emitText**(expression: `ExpressionRef`): `string`<br /> Emits the expression in Binaryen's s-expression text format (not official stack-style text format). * **copyExpression**(expression: `ExpressionRef`): `ExpressionRef`<br /> Creates a deep copy of an expression. ### Relooper * new **Relooper**()<br /> Constructs a relooper instance. This lets you provide an arbitrary CFG, and the relooper will structure it for WebAssembly. * Relooper#**addBlock**(code: `ExpressionRef`): `RelooperBlockRef`<br /> Adds a new block to the CFG, containing the provided code as its body. * Relooper#**addBranch**(from: `RelooperBlockRef`, to: `RelooperBlockRef`, condition: `ExpressionRef`, code: `ExpressionRef`): `void`<br /> Adds a branch from a block to another block, with a condition (or nothing, if this is the default branch to take from the origin - each block must have one such branch), and optional code to execute on the branch (useful for phis). * Relooper#**addBlockWithSwitch**(code: `ExpressionRef`, condition: `ExpressionRef`): `RelooperBlockRef`<br /> Adds a new block, which ends with a switch/br_table, with provided code and condition (that determines where we go in the switch). * Relooper#**addBranchForSwitch**(from: `RelooperBlockRef`, to: `RelooperBlockRef`, indexes: `number[]`, code: `ExpressionRef`): `void`<br /> Adds a branch from a block ending in a switch, to another block, using an array of indexes that determine where to go, and optional code to execute on the branch. * Relooper#**renderAndDispose**(entry: `RelooperBlockRef`, labelHelper: `number`, module: `Module`): `ExpressionRef`<br /> Renders and cleans up the Relooper instance. Call this after you have created all the blocks and branches, giving it the entry block (where control flow begins), a label helper variable (an index of a local we can use, necessary for irreducible control flow), and the module. This returns an expression - normal WebAssembly code - that you can use normally anywhere. ### Source maps * Module#**addDebugInfoFileName**(filename: `string`): `number`<br /> Adds a debug info file name to the module and returns its index. * Module#**getDebugInfoFileName**(index: `number`): `string | null` <br /> Gets the name of the debug info file at the specified index. * Module#**setDebugLocation**(func: `FunctionRef`, expr: `ExpressionRef`, fileIndex: `number`, lineNumber: `number`, columnNumber: `number`): `void`<br /> Sets the debug location of the specified `ExpressionRef` within the specified `FunctionRef`. ### Debugging * Module#**interpret**(): `void`<br /> Runs the module in the interpreter, calling the start function. iMurmurHash.js ============== An incremental implementation of the MurmurHash3 (32-bit) hashing algorithm for JavaScript based on [Gary Court's implementation](https://github.com/garycourt/murmurhash-js) with [kazuyukitanimura's modifications](https://github.com/kazuyukitanimura/murmurhash-js). This version works significantly faster than the non-incremental version if you need to hash many small strings into a single hash, since string concatenation (to build the single string to pass the non-incremental version) is fairly costly. In one case tested, using the incremental version was about 50% faster than concatenating 5-10 strings and then hashing. Installation ------------ To use iMurmurHash in the browser, [download the latest version](https://raw.github.com/jensyt/imurmurhash-js/master/imurmurhash.min.js) and include it as a script on your site. ```html <script type="text/javascript" src="/scripts/imurmurhash.min.js"></script> <script> // Your code here, access iMurmurHash using the global object MurmurHash3 </script> ``` --- To use iMurmurHash in Node.js, install the module using NPM: ```bash npm install imurmurhash ``` Then simply include it in your scripts: ```javascript MurmurHash3 = require('imurmurhash'); ``` Quick Example ------------- ```javascript // Create the initial hash var hashState = MurmurHash3('string'); // Incrementally add text hashState.hash('more strings'); hashState.hash('even more strings'); // All calls can be chained if desired hashState.hash('and').hash('some').hash('more'); // Get a result hashState.result(); // returns 0xe4ccfe6b ``` Functions --------- ### MurmurHash3 ([string], [seed]) Get a hash state object, optionally initialized with the given _string_ and _seed_. _Seed_ must be a positive integer if provided. Calling this function without the `new` keyword will return a cached state object that has been reset. This is safe to use as long as the object is only used from a single thread and no other hashes are created while operating on this one. If this constraint cannot be met, you can use `new` to create a new state object. For example: ```javascript // Use the cached object, calling the function again will return the same // object (but reset, so the current state would be lost) hashState = MurmurHash3(); ... // Create a new object that can be safely used however you wish. Calling the // function again will simply return a new state object, and no state loss // will occur, at the cost of creating more objects. hashState = new MurmurHash3(); ``` Both methods can be mixed however you like if you have different use cases. --- ### MurmurHash3.prototype.hash (string) Incrementally add _string_ to the hash. This can be called as many times as you want for the hash state object, including after a call to `result()`. Returns `this` so calls can be chained. --- ### MurmurHash3.prototype.result () Get the result of the hash as a 32-bit positive integer. This performs the tail and finalizer portions of the algorithm, but does not store the result in the state object. This means that it is perfectly safe to get results and then continue adding strings via `hash`. ```javascript // Do the whole string at once MurmurHash3('this is a test string').result(); // 0x70529328 // Do part of the string, get a result, then the other part var m = MurmurHash3('this is a'); m.result(); // 0xbfc4f834 m.hash(' test string').result(); // 0x70529328 (same as above) ``` --- ### MurmurHash3.prototype.reset ([seed]) Reset the state object for reuse, optionally using the given _seed_ (defaults to 0 like the constructor). Returns `this` so calls can be chained. --- License (MIT) ------------- Copyright (c) 2013 Gary Court, Jens Taylor 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. # get-caller-file [](https://travis-ci.org/stefanpenner/get-caller-file) [](https://ci.appveyor.com/project/embercli/get-caller-file/branch/master) This is a utility, which allows a function to figure out from which file it was invoked. It does so by inspecting v8's stack trace at the time it is invoked. Inspired by http://stackoverflow.com/questions/13227489 *note: this relies on Node/V8 specific APIs, as such other runtimes may not work* ## Installation ```bash yarn add get-caller-file ``` ## Usage Given: ```js // ./foo.js const getCallerFile = require('get-caller-file'); module.exports = function() { return getCallerFile(); // figures out who called it }; ``` ```js // index.js const foo = require('./foo'); foo() // => /full/path/to/this/file/index.js ``` ## Options: * `getCallerFile(position = 2)`: where position is stack frame whos fileName we want. # debug [](https://travis-ci.org/visionmedia/debug) [](https://coveralls.io/github/visionmedia/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers) [](#sponsors) <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> A tiny JavaScript debugging utility modelled after Node.js core's debugging technique. Works in Node.js and web browsers. ## Installation ```bash $ npm install debug ``` ## Usage `debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole. Example [_app.js_](./examples/node/app.js): ```js var debug = require('debug')('http') , http = require('http') , name = 'My App'; // fake app debug('booting %o', name); http.createServer(function(req, res){ debug(req.method + ' ' + req.url); res.end('hello\n'); }).listen(3000, function(){ debug('listening'); }); // fake worker of some kind require('./worker'); ``` Example [_worker.js_](./examples/node/worker.js): ```js var a = require('debug')('worker:a') , b = require('debug')('worker:b'); function work() { a('doing lots of uninteresting work'); setTimeout(work, Math.random() * 1000); } work(); function workb() { b('doing some work'); setTimeout(workb, Math.random() * 2000); } workb(); ``` The `DEBUG` environment variable is then used to enable these based on space or comma-delimited names. Here are some examples: <img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png"> <img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png"> <img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png"> #### Windows note On Windows the environment variable is set using the `set` command. ```cmd set DEBUG=*,-not_this ``` Note that PowerShell uses different syntax to set environment variables. ```cmd $env:DEBUG = "*,-not_this" ``` Then, run the program to be debugged as usual. ## Namespace Colors Every debug instance has a color generated for it based on its namespace name. This helps when visually parsing the debug output to identify which debug instance a debug line belongs to. #### Node.js In Node.js, colors are enabled when stderr is a TTY. You also _should_ install the [`supports-color`](https://npmjs.org/supports-color) module alongside debug, otherwise debug will only use a small handful of basic colors. <img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png"> #### Web Browser Colors are also enabled on "Web Inspectors" that understand the `%c` formatting option. These are WebKit web inspectors, Firefox ([since version 31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/)) and the Firebug plugin for Firefox (any version). <img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png"> ## Millisecond diff When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls. <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below: <img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png"> ## Conventions If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output. ## Wildcards The `*` character may be used as a wildcard. Suppose for example your library has debuggers named "connect:bodyParser", "connect:compress", "connect:session", instead of listing all three with `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`. You can also exclude specific debuggers by prefixing them with a "-" character. For example, `DEBUG=*,-connect:*` would include all debuggers except those starting with "connect:". ## Environment Variables When running through Node.js, you can set a few environment variables that will change the behavior of the debug logging: | Name | Purpose | |-----------|-------------------------------------------------| | `DEBUG` | Enables/disables specific debugging namespaces. | | `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). | | `DEBUG_COLORS`| Whether or not to use colors in the debug output. | | `DEBUG_DEPTH` | Object inspection depth. | | `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. | __Note:__ The environment variables beginning with `DEBUG_` end up being converted into an Options object that gets used with `%o`/`%O` formatters. See the Node.js documentation for [`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options) for the complete list. ## Formatters Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. Below are the officially supported formatters: | Formatter | Representation | |-----------|----------------| | `%O` | Pretty-print an Object on multiple lines. | | `%o` | Pretty-print an Object all on a single line. | | `%s` | String. | | `%d` | Number (both integer and float). | | `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. | | `%%` | Single percent sign ('%'). This does not consume an argument. | ### Custom formatters You can add custom formatters by extending the `debug.formatters` object. For example, if you wanted to add support for rendering a Buffer as hex with `%h`, you could do something like: ```js const createDebug = require('debug') createDebug.formatters.h = (v) => { return v.toString('hex') } // …elsewhere const debug = createDebug('foo') debug('this is hex: %h', new Buffer('hello world')) // foo this is hex: 68656c6c6f20776f726c6421 +0ms ``` ## Browser Support You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify), or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest), if you don't want to build it yourself. Debug's enable state is currently persisted by `localStorage`. Consider the situation shown below where you have `worker:a` and `worker:b`, and wish to debug both. You can enable this using `localStorage.debug`: ```js localStorage.debug = 'worker:*' ``` And then refresh the page. ```js a = debug('worker:a'); b = debug('worker:b'); setInterval(function(){ a('doing some work'); }, 1000); setInterval(function(){ b('doing some work'); }, 1200); ``` ## Output streams By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method: Example [_stdout.js_](./examples/node/stdout.js): ```js var debug = require('debug'); var error = debug('app:error'); // by default stderr is used error('goes to stderr!'); var log = debug('app:log'); // set this namespace to log via console.log log.log = console.log.bind(console); // don't forget to bind to console! log('goes to stdout'); error('still goes to stderr!'); // set all output to go via console.info // overrides all per-namespace log settings debug.log = console.info.bind(console); error('now goes to stdout via console.info'); log('still goes to stdout, but via console.info now'); ``` ## Checking whether a debug target is enabled After you've created a debug instance, you can determine whether or not it is enabled by checking the `enabled` property: ```javascript const debug = require('debug')('http'); if (debug.enabled) { // do stuff... } ``` You can also manually toggle this property to force the debug instance to be enabled or disabled. ## Authors - TJ Holowaychuk - Nathan Rajlich - Andrew Rhyne ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)] <a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a> ## Sponsors Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)] <a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a> ## License (The MIT License) Copyright (c) 2014-2017 TJ Holowaychuk &lt;tj@vision-media.ca&gt; 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. # hasurl [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] > Determine whether Node.js' native [WHATWG `URL`](https://nodejs.org/api/url.html#url_the_whatwg_url_api) implementation is available. ## Installation [Node.js](http://nodejs.org/) `>= 4` is required. To install, type this at the command line: ```shell npm install hasurl ``` ## Usage ```js const hasURL = require('hasurl'); if (hasURL()) { // supported } else { // fallback } ``` [npm-image]: https://img.shields.io/npm/v/hasurl.svg [npm-url]: https://npmjs.org/package/hasurl [travis-image]: https://img.shields.io/travis/stevenvachon/hasurl.svg [travis-url]: https://travis-ci.org/stevenvachon/hasurl [](https://www.npmjs.com/package/esprima) [](https://www.npmjs.com/package/esprima) [](https://travis-ci.org/jquery/esprima) [](https://codecov.io/github/jquery/esprima) **Esprima** ([esprima.org](http://esprima.org), BSD license) is a high performance, standard-compliant [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) parser written in ECMAScript (also popularly known as [JavaScript](https://en.wikipedia.org/wiki/JavaScript)). Esprima is created and maintained by [Ariya Hidayat](https://twitter.com/ariyahidayat), with the help of [many contributors](https://github.com/jquery/esprima/contributors). ### Features - Full support for ECMAScript 2017 ([ECMA-262 8th Edition](http://www.ecma-international.org/publications/standards/Ecma-262.htm)) - Sensible [syntax tree format](https://github.com/estree/estree/blob/master/es5.md) as standardized by [ESTree project](https://github.com/estree/estree) - Experimental support for [JSX](https://facebook.github.io/jsx/), a syntax extension for [React](https://facebook.github.io/react/) - Optional tracking of syntax node location (index-based and line-column) - [Heavily tested](http://esprima.org/test/ci.html) (~1500 [unit tests](https://github.com/jquery/esprima/tree/master/test/fixtures) with [full code coverage](https://codecov.io/github/jquery/esprima)) ### API Esprima can be used to perform [lexical analysis](https://en.wikipedia.org/wiki/Lexical_analysis) (tokenization) or [syntactic analysis](https://en.wikipedia.org/wiki/Parsing) (parsing) of a JavaScript program. A simple example on Node.js REPL: ```javascript > var esprima = require('esprima'); > var program = 'const answer = 42'; > esprima.tokenize(program); [ { type: 'Keyword', value: 'const' }, { type: 'Identifier', value: 'answer' }, { type: 'Punctuator', value: '=' }, { type: 'Numeric', value: '42' } ] > esprima.parseScript(program); { type: 'Program', body: [ { type: 'VariableDeclaration', declarations: [Object], kind: 'const' } ], sourceType: 'script' } ``` For more information, please read the [complete documentation](http://esprima.org/doc). # function-bind <!-- [![build status][travis-svg]][travis-url] [![NPM version][npm-badge-svg]][npm-url] [![Coverage Status][5]][6] [![gemnasium Dependency Status][7]][8] [![Dependency status][deps-svg]][deps-url] [![Dev Dependency status][dev-deps-svg]][dev-deps-url] --> <!-- [![browser support][11]][12] --> Implementation of function.prototype.bind ## Example I mainly do this for unit tests I run on phantomjs. PhantomJS does not have Function.prototype.bind :( ```js Function.prototype.bind = require("function-bind") ``` ## Installation `npm install function-bind` ## Contributors - Raynos ## MIT Licenced [travis-svg]: https://travis-ci.org/Raynos/function-bind.svg [travis-url]: https://travis-ci.org/Raynos/function-bind [npm-badge-svg]: https://badge.fury.io/js/function-bind.svg [npm-url]: https://npmjs.org/package/function-bind [5]: https://coveralls.io/repos/Raynos/function-bind/badge.png [6]: https://coveralls.io/r/Raynos/function-bind [7]: https://gemnasium.com/Raynos/function-bind.png [8]: https://gemnasium.com/Raynos/function-bind [deps-svg]: https://david-dm.org/Raynos/function-bind.svg [deps-url]: https://david-dm.org/Raynos/function-bind [dev-deps-svg]: https://david-dm.org/Raynos/function-bind/dev-status.svg [dev-deps-url]: https://david-dm.org/Raynos/function-bind#info=devDependencies [11]: https://ci.testling.com/Raynos/function-bind.png [12]: https://ci.testling.com/Raynos/function-bind test Smart Contract ================== A [smart contract] written in [AssemblyScript] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install [Node.js] ≥ 12 Exploring The Code ================== 1. The main smart contract code lives in `assembly/index.ts`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard AssemblyScript tests using [as-pect]. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [AssemblyScript]: https://www.assemblyscript.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [as-pect]: https://www.npmjs.com/package/@as-pect/cli # ansi-colors [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [](https://www.npmjs.com/package/ansi-colors) [](https://npmjs.org/package/ansi-colors) [](https://npmjs.org/package/ansi-colors) [](https://travis-ci.org/doowb/ansi-colors) > Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in replacement for chalk, kleur and turbocolor (without the dependencies and rendering bugs). Please consider following this project's author, [Brian Woodward](https://github.com/doowb), and consider starring the project to show your :heart: and support. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save ansi-colors ```  ## Why use this? ansi-colors is _the fastest Node.js library for terminal styling_. A more performant drop-in replacement for chalk, with no dependencies. * _Blazing fast_ - Fastest terminal styling library in node.js, 10-20x faster than chalk! * _Drop-in replacement_ for [chalk](https://github.com/chalk/chalk). * _No dependencies_ (Chalk has 7 dependencies in its tree!) * _Safe_ - Does not modify the `String.prototype` like [colors](https://github.com/Marak/colors.js). * Supports [nested colors](#nested-colors), **and does not have the [nested styling bug](#nested-styling-bug) that is present in [colorette](https://github.com/jorgebucaran/colorette), [chalk](https://github.com/chalk/chalk), and [kleur](https://github.com/lukeed/kleur)**. * Supports [chained colors](#chained-colors). * [Toggle color support](#toggle-color-support) on or off. ## Usage ```js const c = require('ansi-colors'); console.log(c.red('This is a red string!')); console.log(c.green('This is a red string!')); console.log(c.cyan('This is a cyan string!')); console.log(c.yellow('This is a yellow string!')); ```  ## Chained colors ```js console.log(c.bold.red('this is a bold red message')); console.log(c.bold.yellow.italic('this is a bold yellow italicized message')); console.log(c.green.bold.underline('this is a bold green underlined message')); ```  ## Nested colors ```js console.log(c.yellow(`foo ${c.red.bold('red')} bar ${c.cyan('cyan')} baz`)); ```  ### Nested styling bug `ansi-colors` does not have the nested styling bug found in [colorette](https://github.com/jorgebucaran/colorette), [chalk](https://github.com/chalk/chalk), and [kleur](https://github.com/lukeed/kleur). ```js const { bold, red } = require('ansi-styles'); console.log(bold(`foo ${red.dim('bar')} baz`)); const colorette = require('colorette'); console.log(colorette.bold(`foo ${colorette.red(colorette.dim('bar'))} baz`)); const kleur = require('kleur'); console.log(kleur.bold(`foo ${kleur.red.dim('bar')} baz`)); const chalk = require('chalk'); console.log(chalk.bold(`foo ${chalk.red.dim('bar')} baz`)); ``` **Results in the following** (sans icons and labels)  ## Toggle color support Easily enable/disable colors. ```js const c = require('ansi-colors'); // disable colors manually c.enabled = false; // or use a library to automatically detect support c.enabled = require('color-support').hasBasic; console.log(c.red('I will only be colored red if the terminal supports colors')); ``` ## Strip ANSI codes Use the `.unstyle` method to strip ANSI codes from a string. ```js console.log(c.unstyle(c.blue.bold('foo bar baz'))); //=> 'foo bar baz' ``` ## Available styles **Note** that bright and bright-background colors are not always supported. | Colors | Background Colors | Bright Colors | Bright Background Colors | | ------- | ----------------- | ------------- | ------------------------ | | black | bgBlack | blackBright | bgBlackBright | | red | bgRed | redBright | bgRedBright | | green | bgGreen | greenBright | bgGreenBright | | yellow | bgYellow | yellowBright | bgYellowBright | | blue | bgBlue | blueBright | bgBlueBright | | magenta | bgMagenta | magentaBright | bgMagentaBright | | cyan | bgCyan | cyanBright | bgCyanBright | | white | bgWhite | whiteBright | bgWhiteBright | | gray | | | | | grey | | | | _(`gray` is the U.S. spelling, `grey` is more commonly used in the Canada and U.K.)_ ### Style modifiers * dim * **bold** * hidden * _italic_ * underline * inverse * ~~strikethrough~~ * reset ## Aliases Create custom aliases for styles. ```js const colors = require('ansi-colors'); colors.alias('primary', colors.yellow); colors.alias('secondary', colors.bold); console.log(colors.primary.secondary('Foo')); ``` ## Themes A theme is an object of custom aliases. ```js const colors = require('ansi-colors'); colors.theme({ danger: colors.red, dark: colors.dim.gray, disabled: colors.gray, em: colors.italic, heading: colors.bold.underline, info: colors.cyan, muted: colors.dim, primary: colors.blue, strong: colors.bold, success: colors.green, underline: colors.underline, warning: colors.yellow }); // Now, we can use our custom styles alongside the built-in styles! console.log(colors.danger.strong.em('Error!')); console.log(colors.warning('Heads up!')); console.log(colors.info('Did you know...')); console.log(colors.success.bold('It worked!')); ``` ## Performance **Libraries tested** * ansi-colors v3.0.4 * chalk v2.4.1 ### Mac > MacBook Pro, Intel Core i7, 2.3 GHz, 16 GB. **Load time** Time it takes to load the first time `require()` is called: * ansi-colors - `1.915ms` * chalk - `12.437ms` **Benchmarks** ``` # All Colors ansi-colors x 173,851 ops/sec ±0.42% (91 runs sampled) chalk x 9,944 ops/sec ±2.53% (81 runs sampled))) # Chained colors ansi-colors x 20,791 ops/sec ±0.60% (88 runs sampled) chalk x 2,111 ops/sec ±2.34% (83 runs sampled) # Nested colors ansi-colors x 59,304 ops/sec ±0.98% (92 runs sampled) chalk x 4,590 ops/sec ±2.08% (82 runs sampled) ``` ### Windows > Windows 10, Intel Core i7-7700k CPU @ 4.2 GHz, 32 GB **Load time** Time it takes to load the first time `require()` is called: * ansi-colors - `1.494ms` * chalk - `11.523ms` **Benchmarks** ``` # All Colors ansi-colors x 193,088 ops/sec ±0.51% (95 runs sampled)) chalk x 9,612 ops/sec ±3.31% (77 runs sampled))) # Chained colors ansi-colors x 26,093 ops/sec ±1.13% (94 runs sampled) chalk x 2,267 ops/sec ±2.88% (80 runs sampled)) # Nested colors ansi-colors x 67,747 ops/sec ±0.49% (93 runs sampled) chalk x 4,446 ops/sec ±3.01% (82 runs sampled)) ``` ## About <details> <summary><strong>Contributing</strong></summary> Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). </details> <details> <summary><strong>Running Tests</strong></summary> Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ``` </details> <details> <summary><strong>Building docs</strong></summary> _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` </details> ### Related projects You might also be interested in these projects: * [ansi-wrap](https://www.npmjs.com/package/ansi-wrap): Create ansi colors by passing the open and close codes. | [homepage](https://github.com/jonschlinkert/ansi-wrap "Create ansi colors by passing the open and close codes.") * [strip-color](https://www.npmjs.com/package/strip-color): Strip ANSI color codes from a string. No dependencies. | [homepage](https://github.com/jonschlinkert/strip-color "Strip ANSI color codes from a string. No dependencies.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 48 | [jonschlinkert](https://github.com/jonschlinkert) | | 42 | [doowb](https://github.com/doowb) | | 6 | [lukeed](https://github.com/lukeed) | | 2 | [Silic0nS0ldier](https://github.com/Silic0nS0ldier) | | 1 | [dwieeb](https://github.com/dwieeb) | | 1 | [jorgebucaran](https://github.com/jorgebucaran) | | 1 | [madhavarshney](https://github.com/madhavarshney) | | 1 | [chapterjason](https://github.com/chapterjason) | ### Author **Brian Woodward** * [GitHub Profile](https://github.com/doowb) * [Twitter Profile](https://twitter.com/doowb) * [LinkedIn Profile](https://linkedin.com/in/woodwardbrian) ### License Copyright © 2019, [Brian Woodward](https://github.com/doowb). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on July 01, 2019._ ### Estraverse [](http://travis-ci.org/estools/estraverse) Estraverse ([estraverse](http://github.com/estools/estraverse)) is [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) traversal functions from [esmangle project](http://github.com/estools/esmangle). ### Documentation You can find usage docs at [wiki page](https://github.com/estools/estraverse/wiki/Usage). ### Example Usage The following code will output all variables declared at the root of a file. ```javascript estraverse.traverse(ast, { enter: function (node, parent) { if (node.type == 'FunctionExpression' || node.type == 'FunctionDeclaration') return estraverse.VisitorOption.Skip; }, leave: function (node, parent) { if (node.type == 'VariableDeclarator') console.log(node.id.name); } }); ``` We can use `this.skip`, `this.remove` and `this.break` functions instead of using Skip, Remove and Break. ```javascript estraverse.traverse(ast, { enter: function (node) { this.break(); } }); ``` And estraverse provides `estraverse.replace` function. When returning node from `enter`/`leave`, current node is replaced with it. ```javascript result = estraverse.replace(tree, { enter: function (node) { // Replace it with replaced. if (node.type === 'Literal') return replaced; } }); ``` By passing `visitor.keys` mapping, we can extend estraverse traversing functionality. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Extending the existing traversing rules. keys: { // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ] TestExpression: ['argument'] } }); ``` By passing `visitor.fallback` option, we can control the behavior when encountering unknown nodes. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Iterating the child **nodes** of unknown nodes. fallback: 'iteration' }); ``` When `visitor.fallback` is a function, we can determine which keys to visit on each node. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Skip the `argument` property of each node fallback: function(node) { return Object.keys(node).filter(function(key) { return key !== 'argument'; }); } }); ``` ### License Copyright (C) 2012-2016 [Yusuke Suzuki](http://github.com/Constellation) (twitter: [@Constellation](http://twitter.com/Constellation)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # is-core-module <sup>[![Version Badge][2]][1]</sup> [![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![dependency status][5]][6] [![dev dependency status][7]][8] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url] [![npm badge][11]][1] Is this specifier a node.js core module? Optionally provide a node version to check; defaults to the current node version. ## Example ```js var isCore = require('is-core-module'); var assert = require('assert'); assert(isCore('fs')); assert(!isCore('butts')); ``` ## Tests Clone the repo, `npm install`, and run `npm test` [1]: https://npmjs.org/package/is-core-module [2]: https://versionbadg.es/inspect-js/is-core-module.svg [5]: https://david-dm.org/inspect-js/is-core-module.svg [6]: https://david-dm.org/inspect-js/is-core-module [7]: https://david-dm.org/inspect-js/is-core-module/dev-status.svg [8]: https://david-dm.org/inspect-js/is-core-module#info=devDependencies [11]: https://nodei.co/npm/is-core-module.png?downloads=true&stars=true [license-image]: https://img.shields.io/npm/l/is-core-module.svg [license-url]: LICENSE [downloads-image]: https://img.shields.io/npm/dm/is-core-module.svg [downloads-url]: https://npm-stat.com/charts.html?package=is-core-module [codecov-image]: https://codecov.io/gh/inspect-js/is-core-module/branch/main/graphs/badge.svg [codecov-url]: https://app.codecov.io/gh/inspect-js/is-core-module/ [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/is-core-module [actions-url]: https://github.com/inspect-js/is-core-module/actions # balanced-match Match balanced string pairs, like `{` and `}` or `<b>` and `</b>`. Supports regular expressions as well! [](http://travis-ci.org/juliangruber/balanced-match) [](https://www.npmjs.org/package/balanced-match) [](https://ci.testling.com/juliangruber/balanced-match) ## Example Get the first matching pair of braces: ```js var balanced = require('balanced-match'); console.log(balanced('{', '}', 'pre{in{nested}}post')); console.log(balanced('{', '}', 'pre{first}between{second}post')); console.log(balanced(/\s+\{\s+/, /\s+\}\s+/, 'pre { in{nest} } post')); ``` The matches are: ```bash $ node example.js { start: 3, end: 14, pre: 'pre', body: 'in{nested}', post: 'post' } { start: 3, end: 9, pre: 'pre', body: 'first', post: 'between{second}post' } { start: 3, end: 17, pre: 'pre', body: 'in{nest}', post: 'post' } ``` ## API ### var m = balanced(a, b, str) For the first non-nested matching pair of `a` and `b` in `str`, return an object with those keys: * **start** the index of the first match of `a` * **end** the index of the matching `b` * **pre** the preamble, `a` and `b` not included * **body** the match, `a` and `b` not included * **post** the postscript, `a` and `b` not included If there's no match, `undefined` will be returned. If the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `['{', 'a', '']` and `{a}}` will match `['', 'a', '}']`. ### var r = balanced.range(a, b, str) For the first non-nested matching pair of `a` and `b` in `str`, return an array with indexes: `[ <a index>, <b index> ]`. If there's no match, `undefined` will be returned. If the `str` contains more `a` than `b` / there are unmatched pairs, the first match that was closed will be used. For example, `{{a}` will match `[ 1, 3 ]` and `{a}}` will match `[0, 2]`. ## Installation With [npm](https://npmjs.org) do: ```bash npm install balanced-match ``` ## Security contact information To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. ## License (MIT) Copyright (c) 2013 Julian Gruber &lt;julian@juliangruber.com&gt; 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. ### Estraverse [](http://travis-ci.org/estools/estraverse) Estraverse ([estraverse](http://github.com/estools/estraverse)) is [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) traversal functions from [esmangle project](http://github.com/estools/esmangle). ### Documentation You can find usage docs at [wiki page](https://github.com/estools/estraverse/wiki/Usage). ### Example Usage The following code will output all variables declared at the root of a file. ```javascript estraverse.traverse(ast, { enter: function (node, parent) { if (node.type == 'FunctionExpression' || node.type == 'FunctionDeclaration') return estraverse.VisitorOption.Skip; }, leave: function (node, parent) { if (node.type == 'VariableDeclarator') console.log(node.id.name); } }); ``` We can use `this.skip`, `this.remove` and `this.break` functions instead of using Skip, Remove and Break. ```javascript estraverse.traverse(ast, { enter: function (node) { this.break(); } }); ``` And estraverse provides `estraverse.replace` function. When returning node from `enter`/`leave`, current node is replaced with it. ```javascript result = estraverse.replace(tree, { enter: function (node) { // Replace it with replaced. if (node.type === 'Literal') return replaced; } }); ``` By passing `visitor.keys` mapping, we can extend estraverse traversing functionality. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Extending the existing traversing rules. keys: { // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ] TestExpression: ['argument'] } }); ``` By passing `visitor.fallback` option, we can control the behavior when encountering unknown nodes. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Iterating the child **nodes** of unknown nodes. fallback: 'iteration' }); ``` When `visitor.fallback` is a function, we can determine which keys to visit on each node. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Skip the `argument` property of each node fallback: function(node) { return Object.keys(node).filter(function(key) { return key !== 'argument'; }); } }); ``` ### License Copyright (C) 2012-2016 [Yusuke Suzuki](http://github.com/Constellation) (twitter: [@Constellation](http://twitter.com/Constellation)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. [](https://www.npmjs.com/package/eslint) [](https://www.npmjs.com/package/eslint) [](https://github.com/eslint/eslint/actions) [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_shield) <br /> [](https://opencollective.com/eslint) [](https://opencollective.com/eslint) [](https://twitter.com/intent/user?screen_name=geteslint) # ESLint [Website](https://eslint.org) | [Configuring](https://eslint.org/docs/user-guide/configuring) | [Rules](https://eslint.org/docs/rules/) | [Contributing](https://eslint.org/docs/developer-guide/contributing) | [Reporting Bugs](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) | [Code of Conduct](https://eslint.org/conduct) | [Twitter](https://twitter.com/geteslint) | [Mailing List](https://groups.google.com/group/eslint) | [Chat Room](https://eslint.org/chat) ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. In many ways, it is similar to JSLint and JSHint with a few exceptions: * ESLint uses [Espree](https://github.com/eslint/espree) for JavaScript parsing. * ESLint uses an AST to evaluate patterns in code. * ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime. ## Table of Contents 1. [Installation and Usage](#installation-and-usage) 2. [Configuration](#configuration) 3. [Code of Conduct](#code-of-conduct) 4. [Filing Issues](#filing-issues) 5. [Frequently Asked Questions](#faq) 6. [Releases](#releases) 7. [Security Policy](#security-policy) 8. [Semantic Versioning Policy](#semantic-versioning-policy) 9. [Stylistic Rule Updates](#stylistic-rule-updates) 10. [License](#license) 11. [Team](#team) 12. [Sponsors](#sponsors) 13. [Technology Sponsors](#technology-sponsors) ## <a name="installation-and-usage"></a>Installation and Usage Prerequisites: [Node.js](https://nodejs.org/) (`^10.12.0`, or `>=12.0.0`) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.) You can install ESLint using npm: ``` $ npm install eslint --save-dev ``` You should then set up a configuration file: ``` $ ./node_modules/.bin/eslint --init ``` After that, you can run ESLint on any file or directory like this: ``` $ ./node_modules/.bin/eslint yourfile.js ``` ## <a name="configuration"></a>Configuration After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this: ```json { "rules": { "semi": ["error", "always"], "quotes": ["error", "double"] } } ``` The names `"semi"` and `"quotes"` are the names of [rules](https://eslint.org/docs/rules) in ESLint. The first value is the error level of the rule and can be one of these values: * `"off"` or `0` - turn the rule off * `"warn"` or `1` - turn the rule on as a warning (doesn't affect exit code) * `"error"` or `2` - turn the rule on as an error (exit code will be 1) The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the [configuration docs](https://eslint.org/docs/user-guide/configuring)). ## <a name="code-of-conduct"></a>Code of Conduct ESLint adheres to the [JS Foundation Code of Conduct](https://eslint.org/conduct). ## <a name="filing-issues"></a>Filing Issues Before filing an issue, please be sure to read the guidelines for what you're reporting: * [Bug Report](https://eslint.org/docs/developer-guide/contributing/reporting-bugs) * [Propose a New Rule](https://eslint.org/docs/developer-guide/contributing/new-rules) * [Proposing a Rule Change](https://eslint.org/docs/developer-guide/contributing/rule-changes) * [Request a Change](https://eslint.org/docs/developer-guide/contributing/changes) ## <a name="faq"></a>Frequently Asked Questions ### I'm using JSCS, should I migrate to ESLint? Yes. [JSCS has reached end of life](https://eslint.org/blog/2016/07/jscs-end-of-life) and is no longer supported. We have prepared a [migration guide](https://eslint.org/docs/user-guide/migrating-from-jscs) to help you convert your JSCS settings to an ESLint configuration. We are now at or near 100% compatibility with JSCS. If you try ESLint and believe we are not yet compatible with a JSCS rule/configuration, please create an issue (mentioning that it is a JSCS compatibility issue) and we will evaluate it as per our normal process. ### Does Prettier replace ESLint? No, ESLint does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use ESLint for everything, or you can combine both using Prettier to format your code and ESLint to catch possible errors. ### Why can't ESLint find my plugins? * Make sure your plugins (and ESLint) are both in your project's `package.json` as devDependencies (or dependencies, if your project uses ESLint at runtime). * Make sure you have run `npm install` and all your dependencies are installed. * Make sure your plugins' peerDependencies have been installed as well. You can use `npm view eslint-plugin-myplugin peerDependencies` to see what peer dependencies `eslint-plugin-myplugin` has. ### Does ESLint support JSX? Yes, ESLint natively supports parsing JSX syntax (this must be enabled in [configuration](https://eslint.org/docs/user-guide/configuring)). Please note that supporting JSX syntax *is not* the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend using [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) if you are using React and want React semantics. ### What ECMAScript versions does ESLint support? ESLint has full support for ECMAScript 3, 5 (default), 2015, 2016, 2017, 2018, 2019, and 2020. You can set your desired ECMAScript syntax (and other settings, like global variables or your target environments) through [configuration](https://eslint.org/docs/user-guide/configuring). ### What about experimental features? ESLint's parser only officially supports the latest final ECMAScript standard. We will make changes to core rules in order to avoid crashes on stage 3 ECMAScript syntax proposals (as long as they are implemented using the correct experimental ESTree syntax). We may make changes to core rules to better work with language extensions (such as JSX, Flow, and TypeScript) on a case-by-case basis. In other cases (including if rules need to warn on more or fewer cases due to new syntax, rather than just not crashing), we recommend you use other parsers and/or rule plugins. If you are using Babel, you can use the [babel-eslint](https://github.com/babel/babel-eslint) parser and [eslint-plugin-babel](https://github.com/babel/eslint-plugin-babel) to use any option available in Babel. Once a language feature has been adopted into the ECMAScript standard (stage 4 according to the [TC39 process](https://tc39.github.io/process-document/)), we will accept issues and pull requests related to the new feature, subject to our [contributing guidelines](https://eslint.org/docs/developer-guide/contributing). Until then, please use the appropriate parser and plugin(s) for your experimental feature. ### Where to ask for help? Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](https://eslint.org/chat). ### Why doesn't ESLint lock dependency versions? Lock files like `package-lock.json` are helpful for deployed applications. They ensure that dependencies are consistent between environments and across deployments. Packages like `eslint` that get published to the npm registry do not include lock files. `npm install eslint` as a user will respect version constraints in ESLint's `package.json`. ESLint and its dependencies will be included in the user's lock file if one exists, but ESLint's own lock file would not be used. We intentionally don't lock dependency versions so that we have the latest compatible dependency versions in development and CI that our users get when installing ESLint in a project. The Twilio blog has a [deeper dive](https://www.twilio.com/blog/lockfiles-nodejs) to learn more. ## <a name="releases"></a>Releases We have scheduled releases every two weeks on Friday or Saturday. You can follow a [release issue](https://github.com/eslint/eslint/issues?q=is%3Aopen+is%3Aissue+label%3Arelease) for updates about the scheduling of any particular release. ## <a name="security-policy"></a>Security Policy ESLint takes security seriously. We work hard to ensure that ESLint is safe for everyone and that security issues are addressed quickly and responsibly. Read the full [security policy](https://github.com/eslint/.github/blob/master/SECURITY.md). ## <a name="semantic-versioning-policy"></a>Semantic Versioning Policy ESLint follows [semantic versioning](https://semver.org). However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint: * Patch release (intended to not break your lint build) * A bug fix in a rule that results in ESLint reporting fewer linting errors. * A bug fix to the CLI or core (including formatters). * Improvements to documentation. * Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage. * Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone). * Minor release (might break your lint build) * A bug fix in a rule that results in ESLint reporting more linting errors. * A new rule is created. * A new option to an existing rule that does not result in ESLint reporting more linting errors by default. * A new addition to an existing rule to support a newly-added language feature (within the last 12 months) that will result in ESLint reporting more linting errors by default. * An existing rule is deprecated. * A new CLI capability is created. * New capabilities to the public API are added (new classes, new methods, new arguments to existing methods, etc.). * A new formatter is created. * `eslint:recommended` is updated and will result in strictly fewer linting errors (e.g., rule removals). * Major release (likely to break your lint build) * `eslint:recommended` is updated and may result in new linting errors (e.g., rule additions, most rule option updates). * A new option to an existing rule that results in ESLint reporting more linting errors by default. * An existing formatter is removed. * Part of the public API is removed or changed in an incompatible way. The public API includes: * Rule schemas * Configuration schema * Command-line options * Node.js API * Rule, formatter, parser, plugin APIs According to our policy, any minor update may report more linting errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"eslint": "~3.1.0"` to guarantee the results of your builds. ## <a name="stylistic-rule-updates"></a>Stylistic Rule Updates Stylistic rules are frozen according to [our policy](https://eslint.org/blog/2020/05/changes-to-rules-policies) on how we evaluate new rules and rule changes. This means: * **Bug fixes**: We will still fix bugs in stylistic rules. * **New ECMAScript features**: We will also make sure stylistic rules are compatible with new ECMAScript features. * **New options**: We will **not** add any new options to stylistic rules unless an option is the only way to fix a bug or support a newly-added ECMAScript feature. ## <a name="license"></a>License [](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_large) ## <a name="team"></a>Team These folks keep the project moving and are resources for help. <!-- NOTE: This section is autogenerated. Do not manually edit.--> <!--teamstart--> ### Technical Steering Committee (TSC) The people who manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained. <table><tbody><tr><td align="center" valign="top" width="11%"> <a href="https://github.com/nzakas"> <img src="https://github.com/nzakas.png?s=75" width="75" height="75"><br /> Nicholas C. Zakas </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/btmills"> <img src="https://github.com/btmills.png?s=75" width="75" height="75"><br /> Brandon Mills </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/mdjermanovic"> <img src="https://github.com/mdjermanovic.png?s=75" width="75" height="75"><br /> Milos Djermanovic </a> </td></tr></tbody></table> ### Reviewers The people who review and implement new features. <table><tbody><tr><td align="center" valign="top" width="11%"> <a href="https://github.com/mysticatea"> <img src="https://github.com/mysticatea.png?s=75" width="75" height="75"><br /> Toru Nagashima </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/aladdin-add"> <img src="https://github.com/aladdin-add.png?s=75" width="75" height="75"><br /> 薛定谔的猫 </a> </td></tr></tbody></table> ### Committers The people who review and fix bugs and help triage issues. <table><tbody><tr><td align="center" valign="top" width="11%"> <a href="https://github.com/brettz9"> <img src="https://github.com/brettz9.png?s=75" width="75" height="75"><br /> Brett Zamir </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/bmish"> <img src="https://github.com/bmish.png?s=75" width="75" height="75"><br /> Bryan Mishkin </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/g-plane"> <img src="https://github.com/g-plane.png?s=75" width="75" height="75"><br /> Pig Fang </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/anikethsaha"> <img src="https://github.com/anikethsaha.png?s=75" width="75" height="75"><br /> Anix </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/yeonjuan"> <img src="https://github.com/yeonjuan.png?s=75" width="75" height="75"><br /> YeonJuan </a> </td><td align="center" valign="top" width="11%"> <a href="https://github.com/snitin315"> <img src="https://github.com/snitin315.png?s=75" width="75" height="75"><br /> Nitin Kumar </a> </td></tr></tbody></table> <!--teamend--> ## <a name="sponsors"></a>Sponsors The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. [Become a Sponsor](https://opencollective.com/eslint) to get your logo on our README and website. <!-- NOTE: This section is autogenerated. Do not manually edit.--> <!--sponsorsstart--> <h3>Platinum Sponsors</h3> <p><a href="https://automattic.com"><img src="https://images.opencollective.com/photomatt/d0ef3e1/logo.png" alt="Automattic" height="undefined"></a></p><h3>Gold Sponsors</h3> <p><a href="https://nx.dev"><img src="https://images.opencollective.com/nx/0efbe42/logo.png" alt="Nx (by Nrwl)" height="96"></a> <a href="https://google.com/chrome"><img src="https://images.opencollective.com/chrome/dc55bd4/logo.png" alt="Chrome's Web Framework & Tools Performance Fund" height="96"></a> <a href="https://www.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a> <a href="https://coinbase.com"><img src="https://avatars.githubusercontent.com/u/1885080?v=4" alt="Coinbase" height="96"></a> <a href="https://substack.com/"><img src="https://avatars.githubusercontent.com/u/53023767?v=4" alt="Substack" height="96"></a></p><h3>Silver Sponsors</h3> <p><a href="https://retool.com/"><img src="https://images.opencollective.com/retool/98ea68e/logo.png" alt="Retool" height="64"></a> <a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a></p><h3>Bronze Sponsors</h3> <p><a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="null"><img src="https://images.opencollective.com/bugsnag-stability-monitoring/c2cef36/logo.png" alt="Bugsnag Stability Monitoring" height="32"></a> <a href="https://mixpanel.com"><img src="https://images.opencollective.com/mixpanel/cd682f7/logo.png" alt="Mixpanel" height="32"></a> <a href="https://www.vpsserver.com"><img src="https://images.opencollective.com/vpsservercom/logo.png" alt="VPS Server" height="32"></a> <a href="https://icons8.com"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8: free icons, photos, illustrations, and music" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://www.firesticktricks.com"><img src="https://images.opencollective.com/fire-stick-tricks/b8fbe2c/logo.png" alt="Fire Stick Tricks" height="32"></a> <a href="https://www.practiceignition.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Practice Ignition" height="32"></a></p> <!--sponsorsend--> ## <a name="technology-sponsors"></a>Technology Sponsors * Site search ([eslint.org](https://eslint.org)) is sponsored by [Algolia](https://www.algolia.com) * Hosting for ([eslint.org](https://eslint.org)) is sponsored by [Netlify](https://www.netlify.com) * Password management is sponsored by [1Password](https://www.1password.com) # fs.realpath A backwards-compatible fs.realpath for Node v6 and above In Node v6, the JavaScript implementation of fs.realpath was replaced with a faster (but less resilient) native implementation. That raises new and platform-specific errors and cannot handle long or excessively symlink-looping paths. This module handles those cases by detecting the new errors and falling back to the JavaScript implementation. On versions of Node prior to v6, it has no effect. ## USAGE ```js var rp = require('fs.realpath') // async version rp.realpath(someLongAndLoopingPath, function (er, real) { // the ELOOP was handled, but it was a bit slower }) // sync version var real = rp.realpathSync(someLongAndLoopingPath) // monkeypatch at your own risk! // This replaces the fs.realpath/fs.realpathSync builtins rp.monkeypatch() // un-do the monkeypatching rp.unmonkeypatch() ``` Compiler frontend for node.js ============================= Usage ----- For an up to date list of available command line options, see: ``` $> asc --help ``` API --- The API accepts the same options as the CLI but also lets you override stdout and stderr and/or provide a callback. Example: ```js const asc = require("assemblyscript/cli/asc"); asc.ready.then(() => { asc.main([ "myModule.ts", "--binaryFile", "myModule.wasm", "--optimize", "--sourceMap", "--measure" ], { stdout: process.stdout, stderr: process.stderr }, function(err) { if (err) throw err; ... }); }); ``` Available command line options can also be obtained programmatically: ```js const options = require("assemblyscript/cli/asc.json"); ... ``` You can also compile a source string directly, for example in a browser environment: ```js const asc = require("assemblyscript/cli/asc"); asc.ready.then(() => { const { binary, text, stdout, stderr } = asc.compileString(`...`, { optimize: 2 }); }); ... ``` [](https://www.npmjs.com/package/espree) [](https://travis-ci.org/eslint/espree) [](https://www.npmjs.com/package/espree) [](https://www.bountysource.com/trackers/9348450-eslint?utm_source=9348450&utm_medium=shield&utm_campaign=TRACKER_BADGE) # Espree Espree started out as a fork of [Esprima](http://esprima.org) v1.2.2, the last stable published released of Esprima before work on ECMAScript 6 began. Espree is now built on top of [Acorn](https://github.com/ternjs/acorn), which has a modular architecture that allows extension of core functionality. The goal of Espree is to produce output that is similar to Esprima with a similar API so that it can be used in place of Esprima. ## Usage Install: ``` npm i espree ``` And in your Node.js code: ```javascript const espree = require("espree"); const ast = espree.parse(code); ``` ## API ### `parse()` `parse` parses the given code and returns a abstract syntax tree (AST). It takes two parameters. - `code` [string]() - the code which needs to be parsed. - `options (Optional)` [Object]() - read more about this [here](#options). ```javascript const espree = require("espree"); const ast = espree.parse(code, options); ``` **Example :** ```js const ast = espree.parse('let foo = "bar"', { ecmaVersion: 6 }); console.log(ast); ``` <details><summary>Output</summary> <p> ``` Node { type: 'Program', start: 0, end: 15, body: [ Node { type: 'VariableDeclaration', start: 0, end: 15, declarations: [Array], kind: 'let' } ], sourceType: 'script' } ``` </p> </details> ### `tokenize()` `tokenize` returns the tokens of a given code. It takes two parameters. - `code` [string]() - the code which needs to be parsed. - `options (Optional)` [Object]() - read more about this [here](#options). Even if `options` is empty or undefined or `options.tokens` is `false`, it assigns it to `true` in order to get the `tokens` array **Example :** ```js const tokens = espree.tokenize('let foo = "bar"', { ecmaVersion: 6 }); console.log(tokens); ``` <details><summary>Output</summary> <p> ``` Token { type: 'Keyword', value: 'let', start: 0, end: 3 }, Token { type: 'Identifier', value: 'foo', start: 4, end: 7 }, Token { type: 'Punctuator', value: '=', start: 8, end: 9 }, Token { type: 'String', value: '"bar"', start: 10, end: 15 } ``` </p> </details> ### `version` Returns the current `espree` version ### `VisitorKeys` Returns all visitor keys for traversing the AST from [eslint-visitor-keys](https://github.com/eslint/eslint-visitor-keys) ### `latestEcmaVersion` Returns the latest ECMAScript supported by `espree` ### `supportedEcmaVersions` Returns an array of all supported ECMAScript versions ## Options ```js const options = { // attach range information to each node range: false, // attach line/column location information to each node loc: false, // create a top-level comments array containing all comments comment: false, // create a top-level tokens array containing all tokens tokens: false, // Set to 3, 5 (default), 6, 7, 8, 9, 10, 11, or 12 to specify the version of ECMAScript syntax you want to use. // You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), or 2021 (same as 12) to use the year-based naming. ecmaVersion: 5, // specify which type of script you're parsing ("script" or "module") sourceType: "script", // specify additional language features ecmaFeatures: { // enable JSX parsing jsx: false, // enable return in global scope globalReturn: false, // enable implied strict mode (if ecmaVersion >= 5) impliedStrict: false } } ``` ## Esprima Compatibility Going Forward The primary goal is to produce the exact same AST structure and tokens as Esprima, and that takes precedence over anything else. (The AST structure being the [ESTree](https://github.com/estree/estree) API with JSX extensions.) Separate from that, Espree may deviate from what Esprima outputs in terms of where and how comments are attached, as well as what additional information is available on AST nodes. That is to say, Espree may add more things to the AST nodes than Esprima does but the overall AST structure produced will be the same. Espree may also deviate from Esprima in the interface it exposes. ## Contributing Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/espree/issues). Espree is licensed under a permissive BSD 2-clause license. ## Security Policy We work hard to ensure that Espree is safe for everyone and that security issues are addressed quickly and responsibly. Read the full [security policy](https://github.com/eslint/.github/blob/master/SECURITY.md). ## Build Commands * `npm test` - run all linting and tests * `npm run lint` - run all linting * `npm run browserify` - creates a version of Espree that is usable in a browser ## Differences from Espree 2.x * The `tokenize()` method does not use `ecmaFeatures`. Any string will be tokenized completely based on ECMAScript 6 semantics. * Trailing whitespace no longer is counted as part of a node. * `let` and `const` declarations are no longer parsed by default. You must opt-in by using an `ecmaVersion` newer than `5` or setting `sourceType` to `module`. * The `esparse` and `esvalidate` binary scripts have been removed. * There is no `tolerant` option. We will investigate adding this back in the future. ## Known Incompatibilities In an effort to help those wanting to transition from other parsers to Espree, the following is a list of noteworthy incompatibilities with other parsers. These are known differences that we do not intend to change. ### Esprima 1.2.2 * Esprima counts trailing whitespace as part of each AST node while Espree does not. In Espree, the end of a node is where the last token occurs. * Espree does not parse `let` and `const` declarations by default. * Error messages returned for parsing errors are different. * There are two addition properties on every node and token: `start` and `end`. These represent the same data as `range` and are used internally by Acorn. ### Esprima 2.x * Esprima 2.x uses a different comment attachment algorithm that results in some comments being added in different places than Espree. The algorithm Espree uses is the same one used in Esprima 1.2.2. ## Frequently Asked Questions ### Why another parser [ESLint](http://eslint.org) had been relying on Esprima as its parser from the beginning. While that was fine when the JavaScript language was evolving slowly, the pace of development increased dramatically and Esprima had fallen behind. ESLint, like many other tools reliant on Esprima, has been stuck in using new JavaScript language features until Esprima updates, and that caused our users frustration. We decided the only way for us to move forward was to create our own parser, bringing us inline with JSHint and JSLint, and allowing us to keep implementing new features as we need them. We chose to fork Esprima instead of starting from scratch in order to move as quickly as possible with a compatible API. With Espree 2.0.0, we are no longer a fork of Esprima but rather a translation layer between Acorn and Esprima syntax. This allows us to put work back into a community-supported parser (Acorn) that is continuing to grow and evolve while maintaining an Esprima-compatible parser for those utilities still built on Esprima. ### Have you tried working with Esprima? Yes. Since the start of ESLint, we've regularly filed bugs and feature requests with Esprima and will continue to do so. However, there are some different philosophies around how the projects work that need to be worked through. The initial goal was to have Espree track Esprima and eventually merge the two back together, but we ultimately decided that building on top of Acorn was a better choice due to Acorn's plugin support. ### Why don't you just use Acorn? Acorn is a great JavaScript parser that produces an AST that is compatible with Esprima. Unfortunately, ESLint relies on more than just the AST to do its job. It relies on Esprima's tokens and comment attachment features to get a complete picture of the source code. We investigated switching to Acorn, but the inconsistencies between Esprima and Acorn created too much work for a project like ESLint. We are building on top of Acorn, however, so that we can contribute back and help make Acorn even better. ### What ECMAScript features do you support? Espree supports all ECMAScript 2020 features and partially supports ECMAScript 2021 features. Because ECMAScript 2021 is still under development, we are implementing features as they are finalized. Currently, Espree supports: * [Logical Assignment Operators](https://github.com/tc39/proposal-logical-assignment) * [Numeric Separators](https://github.com/tc39/proposal-numeric-separator) See [finished-proposals.md](https://github.com/tc39/proposals/blob/master/finished-proposals.md) to know what features are finalized. ### How do you determine which experimental features to support? In general, we do not support experimental JavaScript features. We may make exceptions from time to time depending on the maturity of the features. # flatted [](https://www.npmjs.com/package/flatted) [](https://coveralls.io/github/WebReflection/flatted?branch=main) [](https://travis-ci.com/WebReflection/flatted) [](https://opensource.org/licenses/ISC)   <sup>**Social Media Photo by [Matt Seymour](https://unsplash.com/@mattseymour) on [Unsplash](https://unsplash.com/)**</sup> ## Announcement 📣 There is a standard approach to recursion and more data-types than what JSON allows, and it's part of the [Structured Clone polyfill](https://github.com/ungap/structured-clone/#readme). Beside acting as a polyfill, its `@ungap/structured-clone/json` export provides both `stringify` and `parse`, and it's been tested for being faster than *flatted*, but its produced output is also smaller than *flatted* in general. The *@ungap/structured-clone* module is, in short, a drop in replacement for *flatted*, but it's not compatible with *flatted* specialized syntax. However, if recursion, as well as more data-types, are what you are after, or interesting for your projects/use cases, consider switching to this new module whenever you can 👍 - - - A super light (0.5K) and fast circular JSON parser, directly from the creator of [CircularJSON](https://github.com/WebReflection/circular-json/#circularjson). Now available also for **[PHP](./php/flatted.php)**. ```js npm i flatted ``` Usable via [CDN](https://unpkg.com/flatted) or as regular module. ```js // ESM import {parse, stringify, toJSON, fromJSON} from 'flatted'; // CJS const {parse, stringify, toJSON, fromJSON} = require('flatted'); const a = [{}]; a[0].a = a; a.push(a); stringify(a); // [["1","0"],{"a":"0"}] ``` ## toJSON and fromJSON If you'd like to implicitly survive JSON serialization, these two helpers helps: ```js import {toJSON, fromJSON} from 'flatted'; class RecursiveMap extends Map { static fromJSON(any) { return new this(fromJSON(any)); } toJSON() { return toJSON([...this.entries()]); } } const recursive = new RecursiveMap; const same = {}; same.same = same; recursive.set('same', same); const asString = JSON.stringify(recursive); const asMap = RecursiveMap.fromJSON(JSON.parse(asString)); asMap.get('same') === asMap.get('same').same; // true ``` ## Flatted VS JSON As it is for every other specialized format capable of serializing and deserializing circular data, you should never `JSON.parse(Flatted.stringify(data))`, and you should never `Flatted.parse(JSON.stringify(data))`. The only way this could work is to `Flatted.parse(Flatted.stringify(data))`, as it is also for _CircularJSON_ or any other, otherwise there's no granted data integrity. Also please note this project serializes and deserializes only data compatible with JSON, so that sockets, or anything else with internal classes different from those allowed by JSON standard, won't be serialized and unserialized as expected. ### New in V1: Exact same JSON API * Added a [reviver](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Syntax) parameter to `.parse(string, reviver)` and revive your own objects. * Added a [replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Syntax) and a `space` parameter to `.stringify(object, replacer, space)` for feature parity with JSON signature. ### Compatibility All ECMAScript engines compatible with `Map`, `Set`, `Object.keys`, and `Array.prototype.reduce` will work, even if polyfilled. ### How does it work ? While stringifying, all Objects, including Arrays, and strings, are flattened out and replaced as unique index. `*` Once parsed, all indexes will be replaced through the flattened collection. <sup><sub>`*` represented as string to avoid conflicts with numbers</sub></sup> ```js // logic example var a = [{one: 1}, {two: '2'}]; a[0].a = a; // a is the main object, will be at index '0' // {one: 1} is the second object, index '1' // {two: '2'} the third, in '2', and it has a string // which will be found at index '3' Flatted.stringify(a); // [["1","2"],{"one":1,"a":"0"},{"two":"3"},"2"] // a[one,two] {one: 1, a} {two: '2'} '2' ``` # json-schema-traverse Traverse JSON Schema passing each schema object to callback [](https://github.com/epoberezkin/json-schema-traverse/actions?query=workflow%3Abuild) [](https://www.npmjs.com/package/json-schema-traverse) [](https://coveralls.io/github/epoberezkin/json-schema-traverse?branch=master) ## Install ``` npm install json-schema-traverse ``` ## Usage ```javascript const traverse = require('json-schema-traverse'); const schema = { properties: { foo: {type: 'string'}, bar: {type: 'integer'} } }; traverse(schema, {cb}); // cb is called 3 times with: // 1. root schema // 2. {type: 'string'} // 3. {type: 'integer'} // Or: traverse(schema, {cb: {pre, post}}); // pre is called 3 times with: // 1. root schema // 2. {type: 'string'} // 3. {type: 'integer'} // // post is called 3 times with: // 1. {type: 'string'} // 2. {type: 'integer'} // 3. root schema ``` Callback function `cb` is called for each schema object (not including draft-06 boolean schemas), including the root schema, in pre-order traversal. Schema references ($ref) are not resolved, they are passed as is. Alternatively, you can pass a `{pre, post}` object as `cb`, and then `pre` will be called before traversing child elements, and `post` will be called after all child elements have been traversed. Callback is passed these parameters: - _schema_: the current schema object - _JSON pointer_: from the root schema to the current schema object - _root schema_: the schema passed to `traverse` object - _parent JSON pointer_: from the root schema to the parent schema object (see below) - _parent keyword_: the keyword inside which this schema appears (e.g. `properties`, `anyOf`, etc.) - _parent schema_: not necessarily parent object/array; in the example above the parent schema for `{type: 'string'}` is the root schema - _index/property_: index or property name in the array/object containing multiple schemas; in the example above for `{type: 'string'}` the property name is `'foo'` ## Traverse objects in all unknown keywords ```javascript const traverse = require('json-schema-traverse'); const schema = { mySchema: { minimum: 1, maximum: 2 } }; traverse(schema, {allKeys: true, cb}); // cb is called 2 times with: // 1. root schema // 2. mySchema ``` Without option `allKeys: true` callback will be called only with root schema. ## Enterprise support json-schema-traverse package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-json-schema-traverse?utm_source=npm-json-schema-traverse&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers. ## Security contact To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues. ## License [MIT](https://github.com/epoberezkin/json-schema-traverse/blob/master/LICENSE) # sprintf.js **sprintf.js** is a complete open source JavaScript sprintf implementation for the *browser* and *node.js*. Its prototype is simple: string sprintf(string format , [mixed arg1 [, mixed arg2 [ ,...]]]) The placeholders in the format string are marked by `%` and are followed by one or more of these elements, in this order: * An optional number followed by a `$` sign that selects which argument index to use for the value. If not specified, arguments will be placed in the same order as the placeholders in the input string. * An optional `+` sign that forces to preceed the result with a plus or minus sign on numeric values. By default, only the `-` sign is used on negative numbers. * An optional padding specifier that says what character to use for padding (if specified). Possible values are `0` or any other character precedeed by a `'` (single quote). The default is to pad with *spaces*. * An optional `-` sign, that causes sprintf to left-align the result of this placeholder. The default is to right-align the result. * An optional number, that says how many characters the result should have. If the value to be returned is shorter than this number, the result will be padded. When used with the `j` (JSON) type specifier, the padding length specifies the tab size used for indentation. * An optional precision modifier, consisting of a `.` (dot) followed by a number, that says how many digits should be displayed for floating point numbers. When used with the `g` type specifier, it specifies the number of significant digits. When used on a string, it causes the result to be truncated. * A type specifier that can be any of: * `%` — yields a literal `%` character * `b` — yields an integer as a binary number * `c` — yields an integer as the character with that ASCII value * `d` or `i` — yields an integer as a signed decimal number * `e` — yields a float using scientific notation * `u` — yields an integer as an unsigned decimal number * `f` — yields a float as is; see notes on precision above * `g` — yields a float as is; see notes on precision above * `o` — yields an integer as an octal number * `s` — yields a string as is * `x` — yields an integer as a hexadecimal number (lower-case) * `X` — yields an integer as a hexadecimal number (upper-case) * `j` — yields a JavaScript object or array as a JSON encoded string ## JavaScript `vsprintf` `vsprintf` is the same as `sprintf` except that it accepts an array of arguments, rather than a variable number of arguments: vsprintf("The first 4 letters of the english alphabet are: %s, %s, %s and %s", ["a", "b", "c", "d"]) ## Argument swapping You can also swap the arguments. That is, the order of the placeholders doesn't have to match the order of the arguments. You can do that by simply indicating in the format string which arguments the placeholders refer to: sprintf("%2$s %3$s a %1$s", "cracker", "Polly", "wants") And, of course, you can repeat the placeholders without having to increase the number of arguments. ## Named arguments Format strings may contain replacement fields rather than positional placeholders. Instead of referring to a certain argument, you can now refer to a certain key within an object. Replacement fields are surrounded by rounded parentheses - `(` and `)` - and begin with a keyword that refers to a key: var user = { name: "Dolly" } sprintf("Hello %(name)s", user) // Hello Dolly Keywords in replacement fields can be optionally followed by any number of keywords or indexes: var users = [ {name: "Dolly"}, {name: "Molly"}, {name: "Polly"} ] sprintf("Hello %(users[0].name)s, %(users[1].name)s and %(users[2].name)s", {users: users}) // Hello Dolly, Molly and Polly Note: mixing positional and named placeholders is not (yet) supported ## Computed values You can pass in a function as a dynamic value and it will be invoked (with no arguments) in order to compute the value on-the-fly. sprintf("Current timestamp: %d", Date.now) // Current timestamp: 1398005382890 sprintf("Current date and time: %s", function() { return new Date().toString() }) # AngularJS You can now use `sprintf` and `vsprintf` (also aliased as `fmt` and `vfmt` respectively) in your AngularJS projects. See `demo/`. # Installation ## Via Bower bower install sprintf ## Or as a node.js module npm install sprintf-js ### Usage var sprintf = require("sprintf-js").sprintf, vsprintf = require("sprintf-js").vsprintf sprintf("%2$s %3$s a %1$s", "cracker", "Polly", "wants") vsprintf("The first 4 letters of the english alphabet are: %s, %s, %s and %s", ["a", "b", "c", "d"]) # License **sprintf.js** is licensed under the terms of the 3-clause BSD license. # v8-compile-cache [](https://travis-ci.org/zertosh/v8-compile-cache) `v8-compile-cache` attaches a `require` hook to use [V8's code cache](https://v8project.blogspot.com/2015/07/code-caching.html) to speed up instantiation time. The "code cache" is the work of parsing and compiling done by V8. The ability to tap into V8 to produce/consume this cache was introduced in [Node v5.7.0](https://nodejs.org/en/blog/release/v5.7.0/). ## Usage 1. Add the dependency: ```sh $ npm install --save v8-compile-cache ``` 2. Then, in your entry module add: ```js require('v8-compile-cache'); ``` **Requiring `v8-compile-cache` in Node <5.7.0 is a noop – but you need at least Node 4.0.0 to support the ES2015 syntax used by `v8-compile-cache`.** ## Options Set the environment variable `DISABLE_V8_COMPILE_CACHE=1` to disable the cache. Cache directory is defined by environment variable `V8_COMPILE_CACHE_CACHE_DIR` or defaults to `<os.tmpdir()>/v8-compile-cache-<V8_VERSION>`. ## Internals Cache files are suffixed `.BLOB` and `.MAP` corresponding to the entry module that required `v8-compile-cache`. The cache is _entry module specific_ because it is faster to load the entire code cache into memory at once, than it is to read it from disk on a file-by-file basis. ## Benchmarks See https://github.com/zertosh/v8-compile-cache/tree/master/bench. **Load Times:** | Module | Without Cache | With Cache | | ---------------- | -------------:| ----------:| | `babel-core` | `218ms` | `185ms` | | `yarn` | `153ms` | `113ms` | | `yarn` (bundled) | `228ms` | `105ms` | _^ Includes the overhead of loading the cache itself._ ## Acknowledgements * `FileSystemBlobStore` and `NativeCompileCache` are based on Atom's implementation of their v8 compile cache: - https://github.com/atom/atom/blob/b0d7a8a/src/file-system-blob-store.js - https://github.com/atom/atom/blob/b0d7a8a/src/native-compile-cache.js * `mkdirpSync` is based on: - https://github.com/substack/node-mkdirp/blob/f2003bb/index.js#L55-L98 # Near Bindings Generator Transforms the Assembyscript AST to serialize exported functions and add `encode` and `decode` functions for generating and parsing JSON strings. ## Using via CLI After installling, `npm install nearprotocol/near-bindgen-as`, it can be added to the cli arguments of the assemblyscript compiler you must add the following: ```bash asc <file> --transform near-bindgen-as ... ``` This module also adds a binary `near-asc` which adds the default arguments required to build near contracts as well as the transformer. ```bash near-asc <input file> <output file> ``` ## Using a script to compile Another way is to add a file such as `asconfig.js` such as: ```js const compile = require("near-bindgen-as/compiler").compile; compile("assembly/index.ts", // input file "out/index.wasm", // output file [ // "-O1", // Optional arguments "--debug", "--measure" ], // Prints out the final cli arguments passed to compiler. {verbose: true} ); ``` It can then be built with `node asconfig.js`. There is an example of this in the test directory. # assemblyscript-regex A regex engine for AssemblyScript. [AssemblyScript](https://www.assemblyscript.org/) is a new language, based on TypeScript, that runs on WebAssembly. AssemblyScript has a lightweight standard library, but lacks support for Regular Expression. The project fills that gap! This project exposes an API that mirrors the JavaScript [RegExp](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) class: ```javascript const regex = new RegExp("fo*", "g"); const str = "table football, foul"; let match: Match | null = regex.exec(str); while (match != null) { // first iteration // match.index = 6 // match.matches[0] = "foo" // second iteration // match.index = 16 // match.matches[0] = "fo" match = regex.exec(str); } ``` ## Project status The initial focus of this implementation has been feature support and functionality over performance. It currently supports a sufficient number of regex features to be considered useful, including most character classes, common assertions, groups, alternations, capturing groups and quantifiers. The next phase of development will focussed on more extensive testing and performance. The project currently has reasonable unit test coverage, focussed on positive and negative test cases on a per-feature basis. It also includes a more exhaustive test suite with test cases borrowed from another regex library. ### Feature support Based on the classfication within the [MDN cheatsheet](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet) **Character sets** - [x] . - [x] \d - [x] \D - [x] \w - [x] \W - [x] \s - [x] \S - [x] \t - [x] \r - [x] \n - [x] \v - [x] \f - [ ] [\b] - [ ] \0 - [ ] \cX - [x] \xhh - [x] \uhhhh - [ ] \u{hhhh} or \u{hhhhh} - [x] \ **Assertions** - [x] ^ - [x] $ - [ ] \b - [ ] \B **Other assertions** - [ ] x(?=y) Lookahead assertion - [ ] x(?!y) Negative lookahead assertion - [ ] (?<=y)x Lookbehind assertion - [ ] (?<!y)x Negative lookbehind assertion **Groups and ranges** - [x] x|y - [x] [xyz][a-c] - [x] [^xyz][^a-c] - [x] (x) capturing group - [ ] \n back reference - [ ] (?<Name>x) named capturing group - [x] (?:x) Non-capturing group **Quantifiers** - [x] x\* - [x] x+ - [x] x? - [x] x{n} - [x] x{n,} - [x] x{n,m} - [ ] x\*? / x+? / ... **RegExp** - [x] global - [ ] sticky - [x] case insensitive - [x] multiline - [x] dotAll - [ ] unicode ### Development This project is open source, MIT licenced and your contributions are very much welcomed. To get started, check out the repository and install dependencies: ``` $ npm install ``` A few general points about the tools and processes this project uses: - This project uses prettier for code formatting and eslint to provide additional syntactic checks. These are both run on `npm test` and as part of the CI build. - The unit tests are executed using [as-pect](https://github.com/jtenner/as-pect) - a native AssemblyScript test runner - The specification tests are within the `spec` folder. The `npm run test:generate` target transforms these tests into as-pect tests which execute as part of the standard build / test cycle - In order to support improved debugging you can execute this library as TypeScript (rather than WebAssembly), via the `npm run tsrun` target. ## Test Strategy - tests are copied from the [polyfill implementation](https://github.com/tc39/proposal-temporal/tree/main/polyfill/test) - tests should be removed if they relate to features that do not make sense for TS/AS, i.e. tests that validate the shape of an object do not make sense in a language with compile-time type checking - tests that fail because a feature has not been implemented yet should be left as failures. # file-entry-cache > Super simple cache for file metadata, useful for process that work o a given series of files > and that only need to repeat the job on the changed ones since the previous run of the process — Edit [](https://npmjs.org/package/file-entry-cache) [](https://travis-ci.org/royriojas/file-entry-cache) ## install ```bash npm i --save file-entry-cache ``` ## Usage The module exposes two functions `create` and `createFromFile`. ## `create(cacheName, [directory, useCheckSum])` - **cacheName**: the name of the cache to be created - **directory**: Optional the directory to load the cache from - **usecheckSum**: Whether to use md5 checksum to verify if file changed. If false the default will be to use the mtime and size of the file. ## `createFromFile(pathToCache, [useCheckSum])` - **pathToCache**: the path to the cache file (this combines the cache name and directory) - **useCheckSum**: Whether to use md5 checksum to verify if file changed. If false the default will be to use the mtime and size of the file. ```js // loads the cache, if one does not exists for the given // Id a new one will be prepared to be created var fileEntryCache = require('file-entry-cache'); var cache = fileEntryCache.create('testCache'); var files = expand('../fixtures/*.txt'); // the first time this method is called, will return all the files var oFiles = cache.getUpdatedFiles(files); // this will persist this to disk checking each file stats and // updating the meta attributes `size` and `mtime`. // custom fields could also be added to the meta object and will be persisted // in order to retrieve them later cache.reconcile(); // use this if you want the non visited file entries to be kept in the cache // for more than one execution // // cache.reconcile( true /* noPrune */) // on a second run var cache2 = fileEntryCache.create('testCache'); // will return now only the files that were modified or none // if no files were modified previous to the execution of this function var oFiles = cache.getUpdatedFiles(files); // if you want to prevent a file from being considered non modified // something useful if a file failed some sort of validation // you can then remove the entry from the cache doing cache.removeEntry('path/to/file'); // path to file should be the same path of the file received on `getUpdatedFiles` // that will effectively make the file to appear again as modified until the validation is passed. In that // case you should not remove it from the cache // if you need all the files, so you can determine what to do with the changed ones // you can call var oFiles = cache.normalizeEntries(files); // oFiles will be an array of objects like the following entry = { key: 'some/name/file', the path to the file changed: true, // if the file was changed since previous run meta: { size: 3242, // the size of the file mtime: 231231231, // the modification time of the file data: {} // some extra field stored for this file (useful to save the result of a transformation on the file } } ``` ## Motivation for this module I needed a super simple and dumb **in-memory cache** with optional disk persistence (write-back cache) in order to make a script that will beautify files with `esformatter` to execute only on the files that were changed since the last run. In doing so the process of beautifying files was reduced from several seconds to a small fraction of a second. This module uses [flat-cache](https://www.npmjs.com/package/flat-cache) a super simple `key/value` cache storage with optional file persistance. The main idea is to read the files when the task begins, apply the transforms required, and if the process succeed, then store the new state of the files. The next time this module request for `getChangedFiles` will return only the files that were modified. Making the process to end faster. This module could also be used by processes that modify the files applying a transform, in that case the result of the transform could be stored in the `meta` field, of the entries. Anything added to the meta field will be persisted. Those processes won't need to call `getChangedFiles` they will instead call `normalizeEntries` that will return the entries with a `changed` field that can be used to determine if the file was changed or not. If it was not changed the transformed stored data could be used instead of actually applying the transformation, saving time in case of only a few files changed. In the worst case scenario all the files will be processed. In the best case scenario only a few of them will be processed. ## Important notes - The values set on the meta attribute of the entries should be `stringify-able` ones if possible, flat-cache uses `circular-json` to try to persist circular structures, but this should be considered experimental. The best results are always obtained with non circular values - All the changes to the cache state are done to memory first and only persisted after reconcile. ## License MIT # ts-mixer [version-badge]: https://badgen.net/npm/v/ts-mixer [version-link]: https://npmjs.com/package/ts-mixer [build-badge]: https://img.shields.io/github/workflow/status/tannerntannern/ts-mixer/ts-mixer%20CI [build-link]: https://github.com/tannerntannern/ts-mixer/actions [ts-versions]: https://badgen.net/badge/icon/3.8,3.9,4.0,4.1,4.2?icon=typescript&label&list=| [node-versions]: https://badgen.net/badge/node/10%2C12%2C14/blue/?list=| [![npm version][version-badge]][version-link] [![github actions][build-badge]][build-link] [![TS Versions][ts-versions]][build-link] [![Node.js Versions][node-versions]][build-link] [](https://bundlephobia.com/result?p=ts-mixer) [](https://conventionalcommits.org) ## Overview `ts-mixer` brings mixins to TypeScript. "Mixins" to `ts-mixer` are just classes, so you already know how to write them, and you can probably mix classes from your favorite library without trouble. The mixin problem is more nuanced than it appears. I've seen countless code snippets that work for certain situations, but fail in others. `ts-mixer` tries to take the best from all these solutions while accounting for the situations you might not have considered. [Quick start guide](#quick-start) ### Features * mixes plain classes * mixes classes that extend other classes * mixes classes that were mixed with `ts-mixer` * supports static properties * supports protected/private properties (the popular function-that-returns-a-class solution does not) * mixes abstract classes (with caveats [[1](#caveats)]) * mixes generic classes (with caveats [[2](#caveats)]) * supports class, method, and property decorators (with caveats [[3, 6](#caveats)]) * mostly supports the complexity presented by constructor functions (with caveats [[4](#caveats)]) * comes with an `instanceof`-like replacement (with caveats [[5, 6](#caveats)]) * [multiple mixing strategies](#settings) (ES6 proxies vs hard copy) ### Caveats 1. Mixing abstract classes requires a bit of a hack that may break in future versions of TypeScript. See [mixing abstract classes](#mixing-abstract-classes) below. 2. Mixing generic classes requires a more cumbersome notation, but it's still possible. See [mixing generic classes](#mixing-generic-classes) below. 3. Using decorators in mixed classes also requires a more cumbersome notation. See [mixing with decorators](#mixing-with-decorators) below. 4. ES6 made it impossible to use `.apply(...)` on class constructors (or any means of calling them without `new`), which makes it impossible for `ts-mixer` to pass the proper `this` to your constructors. This may or may not be an issue for your code, but there are options to work around it. See [dealing with constructors](#dealing-with-constructors) below. 5. `ts-mixer` does not support `instanceof` for mixins, but it does offer a replacement. See the [hasMixin function](#hasmixin) for more details. 6. Certain features (specifically, `@decorator` and `hasMixin`) make use of ES6 `Map`s, which means you must either use ES6+ or polyfill `Map` to use them. If you don't need these features, you should be fine without. ## Quick Start ### Installation ``` $ npm install ts-mixer ``` or if you prefer [Yarn](https://yarnpkg.com): ``` $ yarn add ts-mixer ``` ### Basic Example ```typescript import { Mixin } from 'ts-mixer'; class Foo { protected makeFoo() { return 'foo'; } } class Bar { protected makeBar() { return 'bar'; } } class FooBar extends Mixin(Foo, Bar) { public makeFooBar() { return this.makeFoo() + this.makeBar(); } } const fooBar = new FooBar(); console.log(fooBar.makeFooBar()); // "foobar" ``` ## Special Cases ### Mixing Abstract Classes Abstract classes, by definition, cannot be constructed, which means they cannot take on the type, `new(...args) => any`, and by extension, are incompatible with `ts-mixer`. BUT, you can "trick" TypeScript into giving you all the benefits of an abstract class without making it technically abstract. The trick is just some strategic `// @ts-ignore`'s: ```typescript import { Mixin } from 'ts-mixer'; // note that Foo is not marked as an abstract class class Foo { // @ts-ignore: "Abstract methods can only appear within an abstract class" public abstract makeFoo(): string; } class Bar { public makeBar() { return 'bar'; } } class FooBar extends Mixin(Foo, Bar) { // we still get all the benefits of abstract classes here, because TypeScript // will still complain if this method isn't implemented public makeFoo() { return 'foo'; } } ``` Do note that while this does work quite well, it is a bit of a hack and I can't promise that it will continue to work in future TypeScript versions. ### Mixing Generic Classes Frustratingly, it is _impossible_ for generic parameters to be referenced in base class expressions. No matter what, you will eventually run into `Base class expressions cannot reference class type parameters.` The way to get around this is to leverage [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html), and a slightly different mixing function from ts-mixer: `mix`. It works exactly like `Mixin`, except it's a decorator, which means it doesn't affect the type information of the class being decorated. See it in action below: ```typescript import { mix } from 'ts-mixer'; class Foo<T> { public fooMethod(input: T): T { return input; } } class Bar<T> { public barMethod(input: T): T { return input; } } interface FooBar<T1, T2> extends Foo<T1>, Bar<T2> { } @mix(Foo, Bar) class FooBar<T1, T2> { public fooBarMethod(input1: T1, input2: T2) { return [this.fooMethod(input1), this.barMethod(input2)]; } } ``` Key takeaways from this example: * `interface FooBar<T1, T2> extends Foo<T1>, Bar<T2> { }` makes sure `FooBar` has the typing we want, thanks to declaration merging * `@mix(Foo, Bar)` wires things up "on the JavaScript side", since the interface declaration has nothing to do with runtime behavior. * The reason we have to use the `mix` decorator is that the typing produced by `Mixin(Foo, Bar)` would conflict with the typing of the interface. `mix` has no effect "on the TypeScript side," thus avoiding type conflicts. ### Mixing with Decorators Popular libraries such as [class-validator](https://github.com/typestack/class-validator) and [TypeORM](https://github.com/typeorm/typeorm) use decorators to add functionality. Unfortunately, `ts-mixer` has no way of knowing what these libraries do with the decorators behind the scenes. So if you want these decorators to be "inherited" with classes you plan to mix, you first have to wrap them with a special `decorate` function exported by `ts-mixer`. Here's an example using `class-validator`: ```typescript import { IsBoolean, IsIn, validate } from 'class-validator'; import { Mixin, decorate } from 'ts-mixer'; class Disposable { @decorate(IsBoolean()) // instead of @IsBoolean() isDisposed: boolean = false; } class Statusable { @decorate(IsIn(['red', 'green'])) // instead of @IsIn(['red', 'green']) status: string = 'green'; } class ExtendedObject extends Mixin(Disposable, Statusable) {} const extendedObject = new ExtendedObject(); extendedObject.status = 'blue'; validate(extendedObject).then(errors => { console.log(errors); }); ``` ### Dealing with Constructors As mentioned in the [caveats section](#caveats), ES6 disallowed calling constructor functions without `new`. This means that the only way for `ts-mixer` to mix instance properties is to instantiate each base class separately, then copy the instance properties into a common object. The consequence of this is that constructors mixed by `ts-mixer` will _not_ receive the proper `this`. **This very well may not be an issue for you!** It only means that your constructors need to be "mostly pure" in terms of how they handle `this`. Specifically, your constructors cannot produce [side effects](https://en.wikipedia.org/wiki/Side_effect_%28computer_science%29) involving `this`, _other than adding properties to `this`_ (the most common side effect in JavaScript constructors). If you simply cannot eliminate `this` side effects from your constructor, there is a workaround available: `ts-mixer` will automatically forward constructor parameters to a predesignated init function (`settings.initFunction`) if it's present on the class. Unlike constructors, functions can be called with an arbitrary `this`, so this predesignated init function _will_ have the proper `this`. Here's a basic example: ```typescript import { Mixin, settings } from 'ts-mixer'; settings.initFunction = 'init'; class Person { public static allPeople: Set<Person> = new Set(); protected init() { Person.allPeople.add(this); } } type PartyAffiliation = 'democrat' | 'republican'; class PoliticalParticipant { public static democrats: Set<PoliticalParticipant> = new Set(); public static republicans: Set<PoliticalParticipant> = new Set(); public party: PartyAffiliation; // note that these same args will also be passed to init function public constructor(party: PartyAffiliation) { this.party = party; } protected init(party: PartyAffiliation) { if (party === 'democrat') PoliticalParticipant.democrats.add(this); else PoliticalParticipant.republicans.add(this); } } class Voter extends Mixin(Person, PoliticalParticipant) {} const v1 = new Voter('democrat'); const v2 = new Voter('democrat'); const v3 = new Voter('republican'); const v4 = new Voter('republican'); ``` Note the above `.add(this)` statements. These would not work as expected if they were placed in the constructor instead, since `this` is not the same between the constructor and `init`, as explained above. ## Other Features ### hasMixin As mentioned above, `ts-mixer` does not support `instanceof` for mixins. While it is possible to implement [custom `instanceof` behavior](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance), this library does not do so because it would require modifying the source classes, which is deliberately avoided. You can fill this missing functionality with `hasMixin(instance, mixinClass)` instead. See the below example: ```typescript import { Mixin, hasMixin } from 'ts-mixer'; class Foo {} class Bar {} class FooBar extends Mixin(Foo, Bar) {} const instance = new FooBar(); // doesn't work with instanceof... console.log(instance instanceof FooBar) // true console.log(instance instanceof Foo) // false console.log(instance instanceof Bar) // false // but everything works nicely with hasMixin! console.log(hasMixin(instance, FooBar)) // true console.log(hasMixin(instance, Foo)) // true console.log(hasMixin(instance, Bar)) // true ``` `hasMixin(instance, mixinClass)` will work anywhere that `instance instanceof mixinClass` works. Additionally, like `instanceof`, you get the same [type narrowing benefits](https://www.typescriptlang.org/docs/handbook/advanced-types.html#instanceof-type-guards): ```typescript if (hasMixin(instance, Foo)) { // inferred type of instance is "Foo" } if (hasMixin(instance, Bar)) { // inferred type of instance of "Bar" } ``` ## Settings ts-mixer has multiple strategies for mixing classes which can be configured by modifying `settings` from ts-mixer. For example: ```typescript import { settings, Mixin } from 'ts-mixer'; settings.prototypeStrategy = 'proxy'; // then use `Mixin` as normal... ``` ### `settings.prototypeStrategy` * Determines how ts-mixer will mix class prototypes together * Possible values: - `'copy'` (default) - Copies all methods from the classes being mixed into a new prototype object. (This will include all methods up the prototype chains as well.) This is the default for ES5 compatibility, but it has the downside of stale references. For example, if you mix `Foo` and `Bar` to make `FooBar`, then redefine a method on `Foo`, `FooBar` will not have the latest methods from `Foo`. If this is not a concern for you, `'copy'` is the best value for this setting. - `'proxy'` - Uses an ES6 Proxy to "soft mix" prototypes. Unlike `'copy'`, updates to the base classes _will_ be reflected in the mixed class, which may be desirable. The downside is that method access is not as performant, nor is it ES5 compatible. ### `settings.staticsStrategy` * Determines how static properties are inherited * Possible values: - `'copy'` (default) - Simply copies all properties (minus `prototype`) from the base classes/constructor functions onto the mixed class. Like `settings.prototypeStrategy = 'copy'`, this strategy also suffers from stale references, but shouldn't be a concern if you don't redefine static methods after mixing. - `'proxy'` - Similar to `settings.prototypeStrategy`, proxy's static method access to base classes. Has the same benefits/downsides. ### `settings.initFunction` * If set, `ts-mixer` will automatically call the function with this name upon construction * Possible values: - `null` (default) - disables the behavior - a string - function name to call upon construction * Read more about why you would want this in [dealing with constructors](#dealing-with-constructors) ### `settings.decoratorInheritance` * Determines how decorators are inherited from classes passed to `Mixin(...)` * Possible values: - `'deep'` (default) - Deeply inherits decorators from all given classes and their ancestors - `'direct'` - Only inherits decorators defined directly on the given classes - `'none'` - Skips decorator inheritance # Author Tanner Nielsen <tannerntannern@gmail.com> * Website - [tannernielsen.com](http://tannernielsen.com) * Github - [tannerntannern](https://github.com/tannerntannern) Like `chown -R`. Takes the same arguments as `fs.chown()` [](https://www.npmjs.com/package/as-bignum)[](https://travis-ci.com/MaxGraey/as-bignum)[](LICENSE.md) ## WebAssembly fixed length big numbers written on [AssemblyScript](https://github.com/AssemblyScript/assemblyscript) ### Status: Work in progress Provide wide numeric types such as `u128`, `u256`, `i128`, `i256` and fixed points and also its arithmetic operations. Namespace `safe` contain equivalents with overflow/underflow traps. All kind of types pretty useful for economical and cryptographic usages and provide deterministic behavior. ### Install > yarn add as-bignum or > npm i as-bignum ### Usage via AssemblyScript ```ts import { u128 } from "as-bignum"; declare function logF64(value: f64): void; declare function logU128(hi: u64, lo: u64): void; var a = u128.One; var b = u128.from(-32); // same as u128.from<i32>(-32) var c = new u128(0x1, -0xF); var d = u128.from(0x0123456789ABCDEF); // same as u128.from<i64>(0x0123456789ABCDEF) var e = u128.from('0x0123456789ABCDEF01234567'); var f = u128.fromString('11100010101100101', 2); // same as u128.from('0b11100010101100101') var r = d / c + (b << 5) + e; logF64(r.as<f64>()); logU128(r.hi, r.lo); ``` ### Usage via JavaScript/Typescript ```ts TODO ``` ### List of types - [x] [`u128`](https://github.com/MaxGraey/as-bignum/blob/master/assembly/integer/u128.ts) unsigned type (tested) - [ ] [`u256`](https://github.com/MaxGraey/as-bignum/blob/master/assembly/integer/u256.ts) unsigned type (very basic) - [ ] `i128` signed type - [ ] `i256` signed type --- - [x] [`safe.u128`](https://github.com/MaxGraey/as-bignum/blob/master/assembly/integer/safe/u128.ts) unsigned type (tested) - [ ] `safe.u256` unsigned type - [ ] `safe.i128` signed type - [ ] `safe.i256` signed type --- - [ ] [`fp128<Q>`](https://github.com/MaxGraey/as-bignum/blob/master/assembly/fixed/fp128.ts) generic fixed point signed type٭ (very basic for now) - [ ] `fp256<Q>` generic fixed point signed type٭ --- - [ ] `safe.fp128<Q>` generic fixed point signed type٭ - [ ] `safe.fp256<Q>` generic fixed point signed type٭ ٭ _typename_ `Q` _is a type representing count of fractional bits_ # levn [](https://travis-ci.org/gkz/levn) <a name="levn" /> __Light ECMAScript (JavaScript) Value Notation__ Levn is a library which allows you to parse a string into a JavaScript value based on an expected type. It is meant for short amounts of human entered data (eg. config files, command line arguments). Levn aims to concisely describe JavaScript values in text, and allow for the extraction and validation of those values. Levn uses [type-check](https://github.com/gkz/type-check) for its type format, and to validate the results. MIT license. Version 0.4.1. __How is this different than JSON?__ levn is meant to be written by humans only, is (due to the previous point) much more concise, can be validated against supplied types, has regex and date literals, and can easily be extended with custom types. On the other hand, it is probably slower and thus less efficient at transporting large amounts of data, which is fine since this is not its purpose. npm install levn For updates on levn, [follow me on twitter](https://twitter.com/gkzahariev). ## Quick Examples ```js var parse = require('levn').parse; parse('Number', '2'); // 2 parse('String', '2'); // '2' parse('String', 'levn'); // 'levn' parse('String', 'a b'); // 'a b' parse('Boolean', 'true'); // true parse('Date', '#2011-11-11#'); // (Date object) parse('Date', '2011-11-11'); // (Date object) parse('RegExp', '/[a-z]/gi'); // /[a-z]/gi parse('RegExp', 're'); // /re/ parse('Int', '2'); // 2 parse('Number | String', 'str'); // 'str' parse('Number | String', '2'); // 2 parse('[Number]', '[1,2,3]'); // [1,2,3] parse('(String, Boolean)', '(hi, false)'); // ['hi', false] parse('{a: String, b: Number}', '{a: str, b: 2}'); // {a: 'str', b: 2} // at the top level, you can ommit surrounding delimiters parse('[Number]', '1,2,3'); // [1,2,3] parse('(String, Boolean)', 'hi, false'); // ['hi', false] parse('{a: String, b: Number}', 'a: str, b: 2'); // {a: 'str', b: 2} // wildcard - auto choose type parse('*', '[hi,(null,[42]),{k: true}]'); // ['hi', [null, [42]], {k: true}] ``` ## Usage `require('levn');` returns an object that exposes three properties. `VERSION` is the current version of the library as a string. `parse` and `parsedTypeParse` are functions. ```js // parse(type, input, options); parse('[Number]', '1,2,3'); // [1, 2, 3] // parsedTypeParse(parsedType, input, options); var parsedType = require('type-check').parseType('[Number]'); parsedTypeParse(parsedType, '1,2,3'); // [1, 2, 3] ``` ### parse(type, input, options) `parse` casts the string `input` into a JavaScript value according to the specified `type` in the [type format](https://github.com/gkz/type-check#type-format) (and taking account the optional `options`) and returns the resulting JavaScript value. ##### arguments * type - `String` - the type written in the [type format](https://github.com/gkz/type-check#type-format) which to check against * input - `String` - the value written in the [levn format](#levn-format) * options - `Maybe Object` - an optional parameter specifying additional [options](#options) ##### returns `*` - the resulting JavaScript value ##### example ```js parse('[Number]', '1,2,3'); // [1, 2, 3] ``` ### parsedTypeParse(parsedType, input, options) `parsedTypeParse` casts the string `input` into a JavaScript value according to the specified `type` which has already been parsed (and taking account the optional `options`) and returns the resulting JavaScript value. You can parse a type using the [type-check](https://github.com/gkz/type-check) library's `parseType` function. ##### arguments * type - `Object` - the type in the parsed type format which to check against * input - `String` - the value written in the [levn format](#levn-format) * options - `Maybe Object` - an optional parameter specifying additional [options](#options) ##### returns `*` - the resulting JavaScript value ##### example ```js var parsedType = require('type-check').parseType('[Number]'); parsedTypeParse(parsedType, '1,2,3'); // [1, 2, 3] ``` ## Levn Format Levn can use the type information you provide to choose the appropriate value to produce from the input. For the same input, it will choose a different output value depending on the type provided. For example, `parse('Number', '2')` will produce the number `2`, but `parse('String', '2')` will produce the string `"2"`. If you do not provide type information, and simply use `*`, levn will parse the input according the unambiguous "explicit" mode, which we will now detail - you can also set the `explicit` option to true manually in the [options](#options). * `"string"`, `'string'` are parsed as a String, eg. `"a msg"` is `"a msg"` * `#date#` is parsed as a Date, eg. `#2011-11-11#` is `new Date('2011-11-11')` * `/regexp/flags` is parsed as a RegExp, eg. `/re/gi` is `/re/gi` * `undefined`, `null`, `NaN`, `true`, and `false` are all their JavaScript equivalents * `[element1, element2, etc]` is an Array, and the casting procedure is recursively applied to each element. Eg. `[1,2,3]` is `[1,2,3]`. * `(element1, element2, etc)` is an tuple, and the casting procedure is recursively applied to each element. Eg. `(1, a)` is `(1, a)` (is `[1, 'a']`). * `{key1: val1, key2: val2, ...}` is an Object, and the casting procedure is recursively applied to each property. Eg. `{a: 1, b: 2}` is `{a: 1, b: 2}`. * Any test which does not fall under the above, and which does not contain special characters (`[``]``(``)``{``}``:``,`) is a string, eg. `$12- blah` is `"$12- blah"`. If you do provide type information, you can make your input more concise as the program already has some information about what it expects. Please see the [type format](https://github.com/gkz/type-check#type-format) section of [type-check](https://github.com/gkz/type-check) for more information about how to specify types. There are some rules about what levn can do with the information: * If a String is expected, and only a String, all characters of the input (including any special ones) will become part of the output. Eg. `[({})]` is `"[({})]"`, and `"hi"` is `'"hi"'`. * If a Date is expected, the surrounding `#` can be omitted from date literals. Eg. `2011-11-11` is `new Date('2011-11-11')`. * If a RegExp is expected, no flags need to be specified, and the regex is not using any of the special characters,the opening and closing `/` can be omitted - this will have the affect of setting the source of the regex to the input. Eg. `regex` is `/regex/`. * If an Array is expected, and it is the root node (at the top level), the opening `[` and closing `]` can be omitted. Eg. `1,2,3` is `[1,2,3]`. * If a tuple is expected, and it is the root node (at the top level), the opening `(` and closing `)` can be omitted. Eg. `1, a` is `(1, a)` (is `[1, 'a']`). * If an Object is expected, and it is the root node (at the top level), the opening `{` and closing `}` can be omitted. Eg `a: 1, b: 2` is `{a: 1, b: 2}`. If you list multiple types (eg. `Number | String`), it will first attempt to cast to the first type and then validate - if the validation fails it will move on to the next type and so forth, left to right. You must be careful as some types will succeed with any input, such as String. Thus put String at the end of your list. In non-explicit mode, Date and RegExp will succeed with a large variety of input - also be careful with these and list them near the end if not last in your list. Whitespace between special characters and elements is inconsequential. ## Options Options is an object. It is an optional parameter to the `parse` and `parsedTypeParse` functions. ### Explicit A `Boolean`. By default it is `false`. __Example:__ ```js parse('RegExp', 're', {explicit: false}); // /re/ parse('RegExp', 're', {explicit: true}); // Error: ... does not type check... parse('RegExp | String', 're', {explicit: true}); // 're' ``` `explicit` sets whether to be in explicit mode or not. Using `*` automatically activates explicit mode. For more information, read the [levn format](#levn-format) section. ### customTypes An `Object`. Empty `{}` by default. __Example:__ ```js var options = { customTypes: { Even: { typeOf: 'Number', validate: function (x) { return x % 2 === 0; }, cast: function (x) { return {type: 'Just', value: parseInt(x)}; } } } } parse('Even', '2', options); // 2 parse('Even', '3', options); // Error: Value: "3" does not type check... ``` __Another Example:__ ```js function Person(name, age){ this.name = name; this.age = age; } var options = { customTypes: { Person: { typeOf: 'Object', validate: function (x) { x instanceof Person; }, cast: function (value, options, typesCast) { var name, age; if ({}.toString.call(value).slice(8, -1) !== 'Object') { return {type: 'Nothing'}; } name = typesCast(value.name, [{type: 'String'}], options); age = typesCast(value.age, [{type: 'Numger'}], options); return {type: 'Just', value: new Person(name, age)}; } } } parse('Person', '{name: Laura, age: 25}', options); // Person {name: 'Laura', age: 25} ``` `customTypes` is an object whose keys are the name of the types, and whose values are an object with three properties, `typeOf`, `validate`, and `cast`. For more information about `typeOf` and `validate`, please see the [custom types](https://github.com/gkz/type-check#custom-types) section of type-check. `cast` is a function which receives three arguments, the value under question, options, and the typesCast function. In `cast`, attempt to cast the value into the specified type. If you are successful, return an object in the format `{type: 'Just', value: CAST-VALUE}`, if you know it won't work, return `{type: 'Nothing'}`. You can use the `typesCast` function to cast any child values. Remember to pass `options` to it. In your function you can also check for `options.explicit` and act accordingly. ## Technical About `levn` is written in [LiveScript](http://livescript.net/) - a language that compiles to JavaScript. It uses [type-check](https://github.com/gkz/type-check) to both parse types and validate values. It also uses the [prelude.ls](http://preludels.com/) library. # require-main-filename [](https://travis-ci.org/yargs/require-main-filename) [](https://coveralls.io/r/yargs/require-main-filename?branch=master) [](https://www.npmjs.com/package/require-main-filename) `require.main.filename` is great for figuring out the entry point for the current application. This can be combined with a module like [pkg-conf](https://www.npmjs.com/package/pkg-conf) to, _as if by magic_, load top-level configuration. Unfortunately, `require.main.filename` sometimes fails when an application is executed with an alternative process manager, e.g., [iisnode](https://github.com/tjanczuk/iisnode). `require-main-filename` is a shim that addresses this problem. ## Usage ```js var main = require('require-main-filename')() // use main as an alternative to require.main.filename. ``` ## License ISC Standard library ================ Standard library components for use with `tsc` (portable) and `asc` (assembly). Base configurations (.json) and definition files (.d.ts) are relevant to `tsc` only and not used by `asc`. long.js ======= A Long class for representing a 64 bit two's-complement integer value derived from the [Closure Library](https://github.com/google/closure-library) for stand-alone use and extended with unsigned support. [](https://travis-ci.org/dcodeIO/long.js) Background ---------- As of [ECMA-262 5th Edition](http://ecma262-5.com/ELS5_HTML.htm#Section_8.5), "all the positive and negative integers whose magnitude is no greater than 2<sup>53</sup> are representable in the Number type", which is "representing the doubleprecision 64-bit format IEEE 754 values as specified in the IEEE Standard for Binary Floating-Point Arithmetic". The [maximum safe integer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER) in JavaScript is 2<sup>53</sup>-1. Example: 2<sup>64</sup>-1 is 1844674407370955**1615** but in JavaScript it evaluates to 1844674407370955**2000**. Furthermore, bitwise operators in JavaScript "deal only with integers in the range −2<sup>31</sup> through 2<sup>31</sup>−1, inclusive, or in the range 0 through 2<sup>32</sup>−1, inclusive. These operators accept any value of the Number type but first convert each such value to one of 2<sup>32</sup> integer values." In some use cases, however, it is required to be able to reliably work with and perform bitwise operations on the full 64 bits. This is where long.js comes into play. Usage ----- The class is compatible with CommonJS and AMD loaders and is exposed globally as `Long` if neither is available. ```javascript var Long = require("long"); var longVal = new Long(0xFFFFFFFF, 0x7FFFFFFF); console.log(longVal.toString()); ... ``` API --- ### Constructor * new **Long**(low: `number`, high: `number`, unsigned?: `boolean`)<br /> Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers. See the from* functions below for more convenient ways of constructing Longs. ### Fields * Long#**low**: `number`<br /> The low 32 bits as a signed value. * Long#**high**: `number`<br /> The high 32 bits as a signed value. * Long#**unsigned**: `boolean`<br /> Whether unsigned or not. ### Constants * Long.**ZERO**: `Long`<br /> Signed zero. * Long.**ONE**: `Long`<br /> Signed one. * Long.**NEG_ONE**: `Long`<br /> Signed negative one. * Long.**UZERO**: `Long`<br /> Unsigned zero. * Long.**UONE**: `Long`<br /> Unsigned one. * Long.**MAX_VALUE**: `Long`<br /> Maximum signed value. * Long.**MIN_VALUE**: `Long`<br /> Minimum signed value. * Long.**MAX_UNSIGNED_VALUE**: `Long`<br /> Maximum unsigned value. ### Utility * Long.**isLong**(obj: `*`): `boolean`<br /> Tests if the specified object is a Long. * Long.**fromBits**(lowBits: `number`, highBits: `number`, unsigned?: `boolean`): `Long`<br /> Returns a Long representing the 64 bit integer that comes by concatenating the given low and high bits. Each is assumed to use 32 bits. * Long.**fromBytes**(bytes: `number[]`, unsigned?: `boolean`, le?: `boolean`): `Long`<br /> Creates a Long from its byte representation. * Long.**fromBytesLE**(bytes: `number[]`, unsigned?: `boolean`): `Long`<br /> Creates a Long from its little endian byte representation. * Long.**fromBytesBE**(bytes: `number[]`, unsigned?: `boolean`): `Long`<br /> Creates a Long from its big endian byte representation. * Long.**fromInt**(value: `number`, unsigned?: `boolean`): `Long`<br /> Returns a Long representing the given 32 bit integer value. * Long.**fromNumber**(value: `number`, unsigned?: `boolean`): `Long`<br /> Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned. * Long.**fromString**(str: `string`, unsigned?: `boolean`, radix?: `number`)<br /> Long.**fromString**(str: `string`, radix: `number`)<br /> Returns a Long representation of the given string, written using the specified radix. * Long.**fromValue**(val: `*`, unsigned?: `boolean`): `Long`<br /> Converts the specified value to a Long using the appropriate from* function for its type. ### Methods * Long#**add**(addend: `Long | number | string`): `Long`<br /> Returns the sum of this and the specified Long. * Long#**and**(other: `Long | number | string`): `Long`<br /> Returns the bitwise AND of this Long and the specified. * Long#**compare**/**comp**(other: `Long | number | string`): `number`<br /> Compares this Long's value with the specified's. Returns `0` if they are the same, `1` if the this is greater and `-1` if the given one is greater. * Long#**divide**/**div**(divisor: `Long | number | string`): `Long`<br /> Returns this Long divided by the specified. * Long#**equals**/**eq**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value equals the specified's. * Long#**getHighBits**(): `number`<br /> Gets the high 32 bits as a signed integer. * Long#**getHighBitsUnsigned**(): `number`<br /> Gets the high 32 bits as an unsigned integer. * Long#**getLowBits**(): `number`<br /> Gets the low 32 bits as a signed integer. * Long#**getLowBitsUnsigned**(): `number`<br /> Gets the low 32 bits as an unsigned integer. * Long#**getNumBitsAbs**(): `number`<br /> Gets the number of bits needed to represent the absolute value of this Long. * Long#**greaterThan**/**gt**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value is greater than the specified's. * Long#**greaterThanOrEqual**/**gte**/**ge**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value is greater than or equal the specified's. * Long#**isEven**(): `boolean`<br /> Tests if this Long's value is even. * Long#**isNegative**(): `boolean`<br /> Tests if this Long's value is negative. * Long#**isOdd**(): `boolean`<br /> Tests if this Long's value is odd. * Long#**isPositive**(): `boolean`<br /> Tests if this Long's value is positive. * Long#**isZero**/**eqz**(): `boolean`<br /> Tests if this Long's value equals zero. * Long#**lessThan**/**lt**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value is less than the specified's. * Long#**lessThanOrEqual**/**lte**/**le**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value is less than or equal the specified's. * Long#**modulo**/**mod**/**rem**(divisor: `Long | number | string`): `Long`<br /> Returns this Long modulo the specified. * Long#**multiply**/**mul**(multiplier: `Long | number | string`): `Long`<br /> Returns the product of this and the specified Long. * Long#**negate**/**neg**(): `Long`<br /> Negates this Long's value. * Long#**not**(): `Long`<br /> Returns the bitwise NOT of this Long. * Long#**notEquals**/**neq**/**ne**(other: `Long | number | string`): `boolean`<br /> Tests if this Long's value differs from the specified's. * Long#**or**(other: `Long | number | string`): `Long`<br /> Returns the bitwise OR of this Long and the specified. * Long#**shiftLeft**/**shl**(numBits: `Long | number | string`): `Long`<br /> Returns this Long with bits shifted to the left by the given amount. * Long#**shiftRight**/**shr**(numBits: `Long | number | string`): `Long`<br /> Returns this Long with bits arithmetically shifted to the right by the given amount. * Long#**shiftRightUnsigned**/**shru**/**shr_u**(numBits: `Long | number | string`): `Long`<br /> Returns this Long with bits logically shifted to the right by the given amount. * Long#**subtract**/**sub**(subtrahend: `Long | number | string`): `Long`<br /> Returns the difference of this and the specified Long. * Long#**toBytes**(le?: `boolean`): `number[]`<br /> Converts this Long to its byte representation. * Long#**toBytesLE**(): `number[]`<br /> Converts this Long to its little endian byte representation. * Long#**toBytesBE**(): `number[]`<br /> Converts this Long to its big endian byte representation. * Long#**toInt**(): `number`<br /> Converts the Long to a 32 bit integer, assuming it is a 32 bit integer. * Long#**toNumber**(): `number`<br /> Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa). * Long#**toSigned**(): `Long`<br /> Converts this Long to signed. * Long#**toString**(radix?: `number`): `string`<br /> Converts the Long to a string written in the specified radix. * Long#**toUnsigned**(): `Long`<br /> Converts this Long to unsigned. * Long#**xor**(other: `Long | number | string`): `Long`<br /> Returns the bitwise XOR of this Long and the given one. Building -------- To build an UMD bundle to `dist/long.js`, run: ``` $> npm install $> npm run build ``` Running the [tests](./tests): ``` $> npm test ``` # tr46.js > An implementation of the [Unicode TR46 specification](http://unicode.org/reports/tr46/). ## Installation [Node.js](http://nodejs.org) `>= 6` is required. To install, type this at the command line: ```shell npm install tr46 ``` ## API ### `toASCII(domainName[, options])` Converts a string of Unicode symbols to a case-folded Punycode string of ASCII symbols. Available options: * [`checkBidi`](#checkBidi) * [`checkHyphens`](#checkHyphens) * [`checkJoiners`](#checkJoiners) * [`processingOption`](#processingOption) * [`useSTD3ASCIIRules`](#useSTD3ASCIIRules) * [`verifyDNSLength`](#verifyDNSLength) ### `toUnicode(domainName[, options])` Converts a case-folded Punycode string of ASCII symbols to a string of Unicode symbols. Available options: * [`checkBidi`](#checkBidi) * [`checkHyphens`](#checkHyphens) * [`checkJoiners`](#checkJoiners) * [`useSTD3ASCIIRules`](#useSTD3ASCIIRules) ## Options ### `checkBidi` Type: `Boolean` Default value: `false` When set to `true`, any bi-directional text within the input will be checked for validation. ### `checkHyphens` Type: `Boolean` Default value: `false` When set to `true`, the positions of any hyphen characters within the input will be checked for validation. ### `checkJoiners` Type: `Boolean` Default value: `false` When set to `true`, any word joiner characters within the input will be checked for validation. ### `processingOption` Type: `String` Default value: `"nontransitional"` When set to `"transitional"`, symbols within the input will be validated according to the older IDNA2003 protocol. When set to `"nontransitional"`, the current IDNA2008 protocol will be used. ### `useSTD3ASCIIRules` Type: `Boolean` Default value: `false` When set to `true`, input will be validated according to [STD3 Rules](http://unicode.org/reports/tr46/#STD3_Rules). ### `verifyDNSLength` Type: `Boolean` Default value: `false` When set to `true`, the length of each DNS label within the input will be checked for validation. # path-parse [](https://travis-ci.org/jbgutierrez/path-parse) > Node.js [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) [ponyfill](https://ponyfill.com). ## Install ``` $ npm install --save path-parse ``` ## Usage ```js var pathParse = require('path-parse'); pathParse('/home/user/dir/file.txt'); //=> { // root : "/", // dir : "/home/user/dir", // base : "file.txt", // ext : ".txt", // name : "file" // } ``` ## API See [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) docs. ### pathParse(path) ### pathParse.posix(path) The Posix specific version. ### pathParse.win32(path) The Windows specific version. ## License MIT © [Javier Blanco](http://jbgutierrez.info) # AssemblyScript Loader A convenient loader for [AssemblyScript](https://assemblyscript.org) modules. Demangles module exports to a friendly object structure compatible with TypeScript definitions and provides useful utility to read/write data from/to memory. [Documentation](https://assemblyscript.org/loader.html) # isarray `Array#isArray` for older browsers. [](http://travis-ci.org/juliangruber/isarray) [](https://www.npmjs.org/package/isarray) [ ](https://ci.testling.com/juliangruber/isarray) ## Usage ```js var isArray = require('isarray'); console.log(isArray([])); // => true console.log(isArray({})); // => false ``` ## Installation With [npm](http://npmjs.org) do ```bash $ npm install isarray ``` Then bundle for the browser with [browserify](https://github.com/substack/browserify). With [component](http://component.io) do ```bash $ component install juliangruber/isarray ``` ## License (MIT) Copyright (c) 2013 Julian Gruber &lt;julian@juliangruber.com&gt; 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. These files are compiled dot templates from dot folder. Do NOT edit them directly, edit the templates and run `npm run build` from main ajv folder. # inflight Add callbacks to requests in flight to avoid async duplication ## USAGE ```javascript var inflight = require('inflight') // some request that does some stuff function req(key, callback) { // key is any random string. like a url or filename or whatever. // // will return either a falsey value, indicating that the // request for this key is already in flight, or a new callback // which when called will call all callbacks passed to inflightk // with the same key callback = inflight(key, callback) // If we got a falsey value back, then there's already a req going if (!callback) return // this is where you'd fetch the url or whatever // callback is also once()-ified, so it can safely be assigned // to multiple events etc. First call wins. setTimeout(function() { callback(null, key) }, 100) } // only assigns a single setTimeout // when it dings, all cbs get called req('foo', cb1) req('foo', cb2) req('foo', cb3) req('foo', cb4) ``` # word-wrap [](https://www.npmjs.com/package/word-wrap) [](https://npmjs.org/package/word-wrap) [](https://npmjs.org/package/word-wrap) [](https://travis-ci.org/jonschlinkert/word-wrap) > Wrap words to a specified length. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save word-wrap ``` ## Usage ```js var wrap = require('word-wrap'); wrap('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.'); ``` Results in: ``` Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. ``` ## Options  ### options.width Type: `Number` Default: `50` The width of the text before wrapping to a new line. **Example:** ```js wrap(str, {width: 60}); ``` ### options.indent Type: `String` Default: `` (two spaces) The string to use at the beginning of each line. **Example:** ```js wrap(str, {indent: ' '}); ``` ### options.newline Type: `String` Default: `\n` The string to use at the end of each line. **Example:** ```js wrap(str, {newline: '\n\n'}); ``` ### options.escape Type: `function` Default: `function(str){return str;}` An escape function to run on each line after splitting them. **Example:** ```js var xmlescape = require('xml-escape'); wrap(str, { escape: function(string){ return xmlescape(string); } }); ``` ### options.trim Type: `Boolean` Default: `false` Trim trailing whitespace from the returned string. This option is included since `.trim()` would also strip the leading indentation from the first line. **Example:** ```js wrap(str, {trim: true}); ``` ### options.cut Type: `Boolean` Default: `false` Break a word between any two letters when the word is longer than the specified width. **Example:** ```js wrap(str, {cut: true}); ``` ## About ### Related projects * [common-words](https://www.npmjs.com/package/common-words): Updated list (JSON) of the 100 most common words in the English language. Useful for… [more](https://github.com/jonschlinkert/common-words) | [homepage](https://github.com/jonschlinkert/common-words "Updated list (JSON) of the 100 most common words in the English language. Useful for excluding these words from arrays.") * [shuffle-words](https://www.npmjs.com/package/shuffle-words): Shuffle the words in a string and optionally the letters in each word using the… [more](https://github.com/jonschlinkert/shuffle-words) | [homepage](https://github.com/jonschlinkert/shuffle-words "Shuffle the words in a string and optionally the letters in each word using the Fisher-Yates algorithm. Useful for creating test fixtures, benchmarking samples, etc.") * [unique-words](https://www.npmjs.com/package/unique-words): Return the unique words in a string or array. | [homepage](https://github.com/jonschlinkert/unique-words "Return the unique words in a string or array.") * [wordcount](https://www.npmjs.com/package/wordcount): Count the words in a string. Support for english, CJK and Cyrillic. | [homepage](https://github.com/jonschlinkert/wordcount "Count the words in a string. Support for english, CJK and Cyrillic.") ### Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Contributors | **Commits** | **Contributor** | | --- | --- | | 43 | [jonschlinkert](https://github.com/jonschlinkert) | | 2 | [lordvlad](https://github.com/lordvlad) | | 2 | [hildjj](https://github.com/hildjj) | | 1 | [danilosampaio](https://github.com/danilosampaio) | | 1 | [2fd](https://github.com/2fd) | | 1 | [toddself](https://github.com/toddself) | | 1 | [wolfgang42](https://github.com/wolfgang42) | | 1 | [zachhale](https://github.com/zachhale) | ### Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` ### Running tests Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ``` ### Author **Jon Schlinkert** * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 02, 2017._ # fs-minipass Filesystem streams based on [minipass](http://npm.im/minipass). 4 classes are exported: - ReadStream - ReadStreamSync - WriteStream - WriteStreamSync When using `ReadStreamSync`, all of the data is made available immediately upon consuming the stream. Nothing is buffered in memory when the stream is constructed. If the stream is piped to a writer, then it will synchronously `read()` and emit data into the writer as fast as the writer can consume it. (That is, it will respect backpressure.) If you call `stream.read()` then it will read the entire file and return the contents. When using `WriteStreamSync`, every write is flushed to the file synchronously. If your writes all come in a single tick, then it'll write it all out in a single tick. It's as synchronous as you are. The async versions work much like their node builtin counterparts, with the exception of introducing significantly less Stream machinery overhead. ## USAGE It's just streams, you pipe them or read() them or write() to them. ```js const fsm = require('fs-minipass') const readStream = new fsm.ReadStream('file.txt') const writeStream = new fsm.WriteStream('output.txt') writeStream.write('some file header or whatever\n') readStream.pipe(writeStream) ``` ## ReadStream(path, options) Path string is required, but somewhat irrelevant if an open file descriptor is passed in as an option. Options: - `fd` Pass in a numeric file descriptor, if the file is already open. - `readSize` The size of reads to do, defaults to 16MB - `size` The size of the file, if known. Prevents zero-byte read() call at the end. - `autoClose` Set to `false` to prevent the file descriptor from being closed when the file is done being read. ## WriteStream(path, options) Path string is required, but somewhat irrelevant if an open file descriptor is passed in as an option. Options: - `fd` Pass in a numeric file descriptor, if the file is already open. - `mode` The mode to create the file with. Defaults to `0o666`. - `start` The position in the file to start reading. If not specified, then the file will start writing at position zero, and be truncated by default. - `autoClose` Set to `false` to prevent the file descriptor from being closed when the stream is ended. - `flags` Flags to use when opening the file. Irrelevant if `fd` is passed in, since file won't be opened in that case. Defaults to `'a'` if a `pos` is specified, or `'w'` otherwise. # Punycode.js [](https://travis-ci.org/bestiejs/punycode.js) [](https://codecov.io/gh/bestiejs/punycode.js) [](https://gemnasium.com/bestiejs/punycode.js) Punycode.js is a robust Punycode converter that fully complies to [RFC 3492](https://tools.ietf.org/html/rfc3492) and [RFC 5891](https://tools.ietf.org/html/rfc5891). This JavaScript library is the result of comparing, optimizing and documenting different open-source implementations of the Punycode algorithm: * [The C example code from RFC 3492](https://tools.ietf.org/html/rfc3492#appendix-C) * [`punycode.c` by _Markus W. Scherer_ (IBM)](http://opensource.apple.com/source/ICU/ICU-400.42/icuSources/common/punycode.c) * [`punycode.c` by _Ben Noordhuis_](https://github.com/bnoordhuis/punycode/blob/master/punycode.c) * [JavaScript implementation by _some_](http://stackoverflow.com/questions/183485/can-anyone-recommend-a-good-free-javascript-for-punycode-to-unicode-conversion/301287#301287) * [`punycode.js` by _Ben Noordhuis_](https://github.com/joyent/node/blob/426298c8c1c0d5b5224ac3658c41e7c2a3fe9377/lib/punycode.js) (note: [not fully compliant](https://github.com/joyent/node/issues/2072)) This project was [bundled](https://github.com/joyent/node/blob/master/lib/punycode.js) with Node.js from [v0.6.2+](https://github.com/joyent/node/compare/975f1930b1...61e796decc) until [v7](https://github.com/nodejs/node/pull/7941) (soft-deprecated). The current version supports recent versions of Node.js only. It provides a CommonJS module and an ES6 module. For the old version that offers the same functionality with broader support, including Rhino, Ringo, Narwhal, and web browsers, see [v1.4.1](https://github.com/bestiejs/punycode.js/releases/tag/v1.4.1). ## Installation Via [npm](https://www.npmjs.com/): ```bash npm install punycode --save ``` In [Node.js](https://nodejs.org/): ```js const punycode = require('punycode'); ``` ## API ### `punycode.decode(string)` Converts a Punycode string of ASCII symbols to a string of Unicode symbols. ```js // decode domain name parts punycode.decode('maana-pta'); // 'mañana' punycode.decode('--dqo34k'); // '☃-⌘' ``` ### `punycode.encode(string)` Converts a string of Unicode symbols to a Punycode string of ASCII symbols. ```js // encode domain name parts punycode.encode('mañana'); // 'maana-pta' punycode.encode('☃-⌘'); // '--dqo34k' ``` ### `punycode.toUnicode(input)` Converts a Punycode string representing a domain name or an email address to Unicode. Only the Punycoded parts of the input will be converted, i.e. it doesn’t matter if you call it on a string that has already been converted to Unicode. ```js // decode domain names punycode.toUnicode('xn--maana-pta.com'); // → 'mañana.com' punycode.toUnicode('xn----dqo34k.com'); // → '☃-⌘.com' // decode email addresses punycode.toUnicode('джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'); // → 'джумла@джpумлатест.bрфa' ``` ### `punycode.toASCII(input)` Converts a lowercased Unicode string representing a domain name or an email address to Punycode. Only the non-ASCII parts of the input will be converted, i.e. it doesn’t matter if you call it with a domain that’s already in ASCII. ```js // encode domain names punycode.toASCII('mañana.com'); // → 'xn--maana-pta.com' punycode.toASCII('☃-⌘.com'); // → 'xn----dqo34k.com' // encode email addresses punycode.toASCII('джумла@джpумлатест.bрфa'); // → 'джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq' ``` ### `punycode.ucs2` #### `punycode.ucs2.decode(string)` Creates an array containing the numeric code point values of each Unicode symbol in the string. While [JavaScript uses UCS-2 internally](https://mathiasbynens.be/notes/javascript-encoding), this function will convert a pair of surrogate halves (each of which UCS-2 exposes as separate characters) into a single code point, matching UTF-16. ```js punycode.ucs2.decode('abc'); // → [0x61, 0x62, 0x63] // surrogate pair for U+1D306 TETRAGRAM FOR CENTRE: punycode.ucs2.decode('\uD834\uDF06'); // → [0x1D306] ``` #### `punycode.ucs2.encode(codePoints)` Creates a string based on an array of numeric code point values. ```js punycode.ucs2.encode([0x61, 0x62, 0x63]); // → 'abc' punycode.ucs2.encode([0x1D306]); // → '\uD834\uDF06' ``` ### `punycode.version` A string representing the current Punycode.js version number. ## Author | [](https://twitter.com/mathias "Follow @mathias on Twitter") | |---| | [Mathias Bynens](https://mathiasbynens.be/) | ## License Punycode.js is available under the [MIT](https://mths.be/mit) license. # is-extglob [](https://www.npmjs.com/package/is-extglob) [](https://npmjs.org/package/is-extglob) [](https://travis-ci.org/jonschlinkert/is-extglob) > Returns true if a string has an extglob. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save is-extglob ``` ## Usage ```js var isExtglob = require('is-extglob'); ``` **True** ```js isExtglob('?(abc)'); isExtglob('@(abc)'); isExtglob('!(abc)'); isExtglob('*(abc)'); isExtglob('+(abc)'); ``` **False** Escaped extglobs: ```js isExtglob('\\?(abc)'); isExtglob('\\@(abc)'); isExtglob('\\!(abc)'); isExtglob('\\*(abc)'); isExtglob('\\+(abc)'); ``` Everything else... ```js isExtglob('foo.js'); isExtglob('!foo.js'); isExtglob('*.js'); isExtglob('**/abc.js'); isExtglob('abc/*.js'); isExtglob('abc/(aaa|bbb).js'); isExtglob('abc/[a-z].js'); isExtglob('abc/{a,b}.js'); isExtglob('abc/?.js'); isExtglob('abc.js'); isExtglob('abc/def/ghi.js'); ``` ## History **v2.0** Adds support for escaping. Escaped exglobs no longer return true. ## About ### Related projects * [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob "Returns `true` if an array has a glob pattern.") * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet") * [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.") ### Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Building docs _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_ To generate the readme and API documentation with [verb](https://github.com/verbose/verb): ```sh $ npm install -g verb verb-generate-readme && verb ``` ### Running tests Install dev dependencies: ```sh $ npm install -d && npm test ``` ### Author **Jon Schlinkert** * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](http://twitter.com/jonschlinkert) ### License Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT license](https://github.com/jonschlinkert/is-extglob/blob/master/LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 12, 2016._ # Acorn-JSX [](https://travis-ci.org/acornjs/acorn-jsx) [](https://www.npmjs.org/package/acorn-jsx) This is plugin for [Acorn](http://marijnhaverbeke.nl/acorn/) - a tiny, fast JavaScript parser, written completely in JavaScript. It was created as an experimental alternative, faster [React.js JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) parser. Later, it replaced the [official parser](https://github.com/facebookarchive/esprima) and these days is used by many prominent development tools. ## Transpiler Please note that this tool only parses source code to JSX AST, which is useful for various language tools and services. If you want to transpile your code to regular ES5-compliant JavaScript with source map, check out [Babel](https://babeljs.io/) and [Buble](https://buble.surge.sh/) transpilers which use `acorn-jsx` under the hood. ## Usage Requiring this module provides you with an Acorn plugin that you can use like this: ```javascript var acorn = require("acorn"); var jsx = require("acorn-jsx"); acorn.Parser.extend(jsx()).parse("my(<jsx/>, 'code');"); ``` Note that official spec doesn't support mix of XML namespaces and object-style access in tag names (#27) like in `<namespace:Object.Property />`, so it was deprecated in `acorn-jsx@3.0`. If you still want to opt-in to support of such constructions, you can pass the following option: ```javascript acorn.Parser.extend(jsx({ allowNamespacedObjects: true })) ``` Also, since most apps use pure React transformer, a new option was introduced that allows to prohibit namespaces completely: ```javascript acorn.Parser.extend(jsx({ allowNamespaces: false })) ``` Note that by default `allowNamespaces` is enabled for spec compliancy. ## License This plugin is issued under the [MIT license](./LICENSE). # `asbuild` [](https://github.com/AssemblyScript/asbuild/stargazers) *A simple build tool for [AssemblyScript](https://assemblyscript.org) projects, similar to `cargo`, etc.* ## 🚩 Table of Contents - [Installing](#-installing) - [Usage](#-usage) - [`asb init`](#asb-init---create-an-empty-project) - [`asb test`](#asb-test---run-as-pect-tests) - [`asb fmt`](#asb-fmt---format-as-files-using-eslint) - [`asb run`](#asb-run---run-a-wasi-binary) - [`asb build`](#asb-build---compile-the-project-using-asc) - [Background](#-background) ## 🔧 Installing Install it globally ``` npm install -g asbuild ``` Or, locally as dev dependencies ``` npm install --save-dev asbuild ``` ## 💡 Usage ``` Build tool for AssemblyScript projects. Usage: asb [command] [options] Commands: asb Alias of build command, to maintain back-ward compatibility [default] asb build Compile a local package and all of its dependencies [aliases: compile, make] asb init [baseDir] Create a new AS package in an given directory asb test Run as-pect tests asb fmt [paths..] This utility formats current module using eslint. [aliases: format, lint] Options: --version Show version number [boolean] --help Show help [boolean] ``` ### `asb init` - Create an empty project ``` asb init [baseDir] Create a new AS package in an given directory Positionals: baseDir Create a sample AS project in this directory [string] [default: "."] Options: --version Show version number [boolean] --help Show help [boolean] --yes Skip the interactive prompt [boolean] [default: false] ``` ### `asb test` - Run as-pect tests ``` asb test Run as-pect tests USAGE: asb test [options] -- [aspect_options] Options: --version Show version number [boolean] --help Show help [boolean] --verbose, --vv Print out arguments passed to as-pect [boolean] [default: false] ``` ### `asb fmt` - Format AS files using ESlint ``` asb fmt [paths..] This utility formats current module using eslint. Positionals: paths Paths to format [array] [default: ["."]] Initialisation: --init Generates recommended eslint config for AS Projects [boolean] Miscellaneous --lint, --dry-run Tries to fix problems without saving the changes to the file system [boolean] [default: false] Options: --version Show version number [boolean] --help Show help ``` ### `asb run` - Run a WASI binary ``` asb run Run a WASI binary USAGE: asb run [options] [binary path] -- [binary options] Positionals: binary path to Wasm binary [string] [required] Options: --version Show version number [boolean] --help Show help [boolean] --preopen, -p comma separated list of directories to open. [default: "."] ``` ### `asb build` - Compile the project using asc ``` asb build Compile a local package and all of its dependencies USAGE: asb build [entry_file] [options] -- [asc_options] Options: --version Show version number [boolean] --help Show help [boolean] --baseDir, -d Base directory of project. [string] [default: "."] --config, -c Path to asconfig file [string] [default: "./asconfig.json"] --wat Output wat file to outDir [boolean] [default: false] --outDir Directory to place built binaries. Default "./build/<target>/" [string] --target Target for compilation [string] [default: "release"] --verbose Print out arguments passed to asc [boolean] [default: false] Examples: asb build Build release of 'assembly/index.ts to build/release/packageName.wasm asb build --target release Build a release binary asb build -- --measure Pass argument to 'asc' ``` #### Defaults ##### Project structure ``` project/ package.json asconfig.json assembly/ index.ts build/ release/ project.wasm debug/ project.wasm ``` - If no entry file passed and no `entry` field is in `asconfig.json`, `project/assembly/index.ts` is assumed. - `asconfig.json` allows for options for different compile targets, e.g. release, debug, etc. `asc` defaults to the release target. - The default build directory is `./build`, and artifacts are placed at `./build/<target>/packageName.wasm`. ##### Workspaces If a `workspace` field is added to a top level `asconfig.json` file, then each path in the array is built and placed into the top level `outDir`. For example, `asconfig.json`: ```json { "workspaces": ["a", "b"] } ``` Running `asb` in the directory below will use the top level build directory to place all the binaries. ``` project/ package.json asconfig.json a/ asconfig.json assembly/ index.ts b/ asconfig.json assembly/ index.ts build/ release/ a.wasm b.wasm debug/ a.wasm b.wasm ``` To see an example in action check out the [test workspace](./tests/build_test) ## 📖 Background Asbuild started as wrapper around `asc` to provide an easier CLI interface and now has been extened to support other commands like `init`, `test` and `fmt` just like `cargo` to become a one stop build tool for AS Projects. ## 📜 License This library is provided under the open-source [MIT license](https://choosealicense.com/licenses/mit/). # lodash.sortby v4.7.0 The [lodash](https://lodash.com/) method `_.sortBy` exported as a [Node.js](https://nodejs.org/) module. ## Installation Using npm: ```bash $ {sudo -H} npm i -g npm $ npm i --save lodash.sortby ``` In Node.js: ```js var sortBy = require('lodash.sortby'); ``` See the [documentation](https://lodash.com/docs#sortBy) or [package source](https://github.com/lodash/lodash/blob/4.7.0-npm-packages/lodash.sortby) for more details. # debug [](https://travis-ci.org/debug-js/debug) [](https://coveralls.io/github/debug-js/debug?branch=master) [](https://visionmedia-community-slackin.now.sh/) [](#backers) [](#sponsors) <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> A tiny JavaScript debugging utility modelled after Node.js core's debugging technique. Works in Node.js and web browsers. ## Installation ```bash $ npm install debug ``` ## Usage `debug` exposes a function; simply pass this function the name of your module, and it will return a decorated version of `console.error` for you to pass debug statements to. This will allow you to toggle the debug output for different parts of your module as well as the module as a whole. Example [_app.js_](./examples/node/app.js): ```js var debug = require('debug')('http') , http = require('http') , name = 'My App'; // fake app debug('booting %o', name); http.createServer(function(req, res){ debug(req.method + ' ' + req.url); res.end('hello\n'); }).listen(3000, function(){ debug('listening'); }); // fake worker of some kind require('./worker'); ``` Example [_worker.js_](./examples/node/worker.js): ```js var a = require('debug')('worker:a') , b = require('debug')('worker:b'); function work() { a('doing lots of uninteresting work'); setTimeout(work, Math.random() * 1000); } work(); function workb() { b('doing some work'); setTimeout(workb, Math.random() * 2000); } workb(); ``` The `DEBUG` environment variable is then used to enable these based on space or comma-delimited names. Here are some examples: <img width="647" alt="screen shot 2017-08-08 at 12 53 04 pm" src="https://user-images.githubusercontent.com/71256/29091703-a6302cdc-7c38-11e7-8304-7c0b3bc600cd.png"> <img width="647" alt="screen shot 2017-08-08 at 12 53 38 pm" src="https://user-images.githubusercontent.com/71256/29091700-a62a6888-7c38-11e7-800b-db911291ca2b.png"> <img width="647" alt="screen shot 2017-08-08 at 12 53 25 pm" src="https://user-images.githubusercontent.com/71256/29091701-a62ea114-7c38-11e7-826a-2692bedca740.png"> #### Windows command prompt notes ##### CMD On Windows the environment variable is set using the `set` command. ```cmd set DEBUG=*,-not_this ``` Example: ```cmd set DEBUG=* & node app.js ``` ##### PowerShell (VS Code default) PowerShell uses different syntax to set environment variables. ```cmd $env:DEBUG = "*,-not_this" ``` Example: ```cmd $env:DEBUG='app';node app.js ``` Then, run the program to be debugged as usual. npm script example: ```js "windowsDebug": "@powershell -Command $env:DEBUG='*';node app.js", ``` ## Namespace Colors Every debug instance has a color generated for it based on its namespace name. This helps when visually parsing the debug output to identify which debug instance a debug line belongs to. #### Node.js In Node.js, colors are enabled when stderr is a TTY. You also _should_ install the [`supports-color`](https://npmjs.org/supports-color) module alongside debug, otherwise debug will only use a small handful of basic colors. <img width="521" src="https://user-images.githubusercontent.com/71256/29092181-47f6a9e6-7c3a-11e7-9a14-1928d8a711cd.png"> #### Web Browser Colors are also enabled on "Web Inspectors" that understand the `%c` formatting option. These are WebKit web inspectors, Firefox ([since version 31](https://hacks.mozilla.org/2014/05/editable-box-model-multiple-selection-sublime-text-keys-much-more-firefox-developer-tools-episode-31/)) and the Firebug plugin for Firefox (any version). <img width="524" src="https://user-images.githubusercontent.com/71256/29092033-b65f9f2e-7c39-11e7-8e32-f6f0d8e865c1.png"> ## Millisecond diff When actively developing an application it can be useful to see when the time spent between one `debug()` call and the next. Suppose for example you invoke `debug()` before requesting a resource, and after as well, the "+NNNms" will show you how much time was spent between calls. <img width="647" src="https://user-images.githubusercontent.com/71256/29091486-fa38524c-7c37-11e7-895f-e7ec8e1039b6.png"> When stdout is not a TTY, `Date#toISOString()` is used, making it more useful for logging the debug information as shown below: <img width="647" src="https://user-images.githubusercontent.com/71256/29091956-6bd78372-7c39-11e7-8c55-c948396d6edd.png"> ## Conventions If you're using this in one or more of your libraries, you _should_ use the name of your library so that developers may toggle debugging as desired without guessing names. If you have more than one debuggers you _should_ prefix them with your library name and use ":" to separate features. For example "bodyParser" from Connect would then be "connect:bodyParser". If you append a "*" to the end of your name, it will always be enabled regardless of the setting of the DEBUG environment variable. You can then use it for normal output as well as debug output. ## Wildcards The `*` character may be used as a wildcard. Suppose for example your library has debuggers named "connect:bodyParser", "connect:compress", "connect:session", instead of listing all three with `DEBUG=connect:bodyParser,connect:compress,connect:session`, you may simply do `DEBUG=connect:*`, or to run everything using this module simply use `DEBUG=*`. You can also exclude specific debuggers by prefixing them with a "-" character. For example, `DEBUG=*,-connect:*` would include all debuggers except those starting with "connect:". ## Environment Variables When running through Node.js, you can set a few environment variables that will change the behavior of the debug logging: | Name | Purpose | |-----------|-------------------------------------------------| | `DEBUG` | Enables/disables specific debugging namespaces. | | `DEBUG_HIDE_DATE` | Hide date from debug output (non-TTY). | | `DEBUG_COLORS`| Whether or not to use colors in the debug output. | | `DEBUG_DEPTH` | Object inspection depth. | | `DEBUG_SHOW_HIDDEN` | Shows hidden properties on inspected objects. | __Note:__ The environment variables beginning with `DEBUG_` end up being converted into an Options object that gets used with `%o`/`%O` formatters. See the Node.js documentation for [`util.inspect()`](https://nodejs.org/api/util.html#util_util_inspect_object_options) for the complete list. ## Formatters Debug uses [printf-style](https://wikipedia.org/wiki/Printf_format_string) formatting. Below are the officially supported formatters: | Formatter | Representation | |-----------|----------------| | `%O` | Pretty-print an Object on multiple lines. | | `%o` | Pretty-print an Object all on a single line. | | `%s` | String. | | `%d` | Number (both integer and float). | | `%j` | JSON. Replaced with the string '[Circular]' if the argument contains circular references. | | `%%` | Single percent sign ('%'). This does not consume an argument. | ### Custom formatters You can add custom formatters by extending the `debug.formatters` object. For example, if you wanted to add support for rendering a Buffer as hex with `%h`, you could do something like: ```js const createDebug = require('debug') createDebug.formatters.h = (v) => { return v.toString('hex') } // …elsewhere const debug = createDebug('foo') debug('this is hex: %h', new Buffer('hello world')) // foo this is hex: 68656c6c6f20776f726c6421 +0ms ``` ## Browser Support You can build a browser-ready script using [browserify](https://github.com/substack/node-browserify), or just use the [browserify-as-a-service](https://wzrd.in/) [build](https://wzrd.in/standalone/debug@latest), if you don't want to build it yourself. Debug's enable state is currently persisted by `localStorage`. Consider the situation shown below where you have `worker:a` and `worker:b`, and wish to debug both. You can enable this using `localStorage.debug`: ```js localStorage.debug = 'worker:*' ``` And then refresh the page. ```js a = debug('worker:a'); b = debug('worker:b'); setInterval(function(){ a('doing some work'); }, 1000); setInterval(function(){ b('doing some work'); }, 1200); ``` ## Output streams By default `debug` will log to stderr, however this can be configured per-namespace by overriding the `log` method: Example [_stdout.js_](./examples/node/stdout.js): ```js var debug = require('debug'); var error = debug('app:error'); // by default stderr is used error('goes to stderr!'); var log = debug('app:log'); // set this namespace to log via console.log log.log = console.log.bind(console); // don't forget to bind to console! log('goes to stdout'); error('still goes to stderr!'); // set all output to go via console.info // overrides all per-namespace log settings debug.log = console.info.bind(console); error('now goes to stdout via console.info'); log('still goes to stdout, but via console.info now'); ``` ## Extend You can simply extend debugger ```js const log = require('debug')('auth'); //creates new debug instance with extended namespace const logSign = log.extend('sign'); const logLogin = log.extend('login'); log('hello'); // auth hello logSign('hello'); //auth:sign hello logLogin('hello'); //auth:login hello ``` ## Set dynamically You can also enable debug dynamically by calling the `enable()` method : ```js let debug = require('debug'); console.log(1, debug.enabled('test')); debug.enable('test'); console.log(2, debug.enabled('test')); debug.disable(); console.log(3, debug.enabled('test')); ``` print : ``` 1 false 2 true 3 false ``` Usage : `enable(namespaces)` `namespaces` can include modes separated by a colon and wildcards. Note that calling `enable()` completely overrides previously set DEBUG variable : ``` $ DEBUG=foo node -e 'var dbg = require("debug"); dbg.enable("bar"); console.log(dbg.enabled("foo"))' => false ``` `disable()` Will disable all namespaces. The functions returns the namespaces currently enabled (and skipped). This can be useful if you want to disable debugging temporarily without knowing what was enabled to begin with. For example: ```js let debug = require('debug'); debug.enable('foo:*,-foo:bar'); let namespaces = debug.disable(); debug.enable(namespaces); ``` Note: There is no guarantee that the string will be identical to the initial enable string, but semantically they will be identical. ## Checking whether a debug target is enabled After you've created a debug instance, you can determine whether or not it is enabled by checking the `enabled` property: ```javascript const debug = require('debug')('http'); if (debug.enabled) { // do stuff... } ``` You can also manually toggle this property to force the debug instance to be enabled or disabled. ## Usage in child processes Due to the way `debug` detects if the output is a TTY or not, colors are not shown in child processes when `stderr` is piped. A solution is to pass the `DEBUG_COLORS=1` environment variable to the child process. For example: ```javascript worker = fork(WORKER_WRAP_PATH, [workerPath], { stdio: [ /* stdin: */ 0, /* stdout: */ 'pipe', /* stderr: */ 'pipe', 'ipc', ], env: Object.assign({}, process.env, { DEBUG_COLORS: 1 // without this settings, colors won't be shown }), }); worker.stderr.pipe(process.stderr, { end: false }); ``` ## Authors - TJ Holowaychuk - Nathan Rajlich - Andrew Rhyne - Josh Junon ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/debug#backer)] <a href="https://opencollective.com/debug/backer/0/website" target="_blank"><img src="https://opencollective.com/debug/backer/0/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/1/website" target="_blank"><img src="https://opencollective.com/debug/backer/1/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/2/website" target="_blank"><img src="https://opencollective.com/debug/backer/2/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/3/website" target="_blank"><img src="https://opencollective.com/debug/backer/3/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/4/website" target="_blank"><img src="https://opencollective.com/debug/backer/4/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/5/website" target="_blank"><img src="https://opencollective.com/debug/backer/5/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/6/website" target="_blank"><img src="https://opencollective.com/debug/backer/6/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/7/website" target="_blank"><img src="https://opencollective.com/debug/backer/7/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/8/website" target="_blank"><img src="https://opencollective.com/debug/backer/8/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/9/website" target="_blank"><img src="https://opencollective.com/debug/backer/9/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/10/website" target="_blank"><img src="https://opencollective.com/debug/backer/10/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/11/website" target="_blank"><img src="https://opencollective.com/debug/backer/11/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/12/website" target="_blank"><img src="https://opencollective.com/debug/backer/12/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/13/website" target="_blank"><img src="https://opencollective.com/debug/backer/13/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/14/website" target="_blank"><img src="https://opencollective.com/debug/backer/14/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/15/website" target="_blank"><img src="https://opencollective.com/debug/backer/15/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/16/website" target="_blank"><img src="https://opencollective.com/debug/backer/16/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/17/website" target="_blank"><img src="https://opencollective.com/debug/backer/17/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/18/website" target="_blank"><img src="https://opencollective.com/debug/backer/18/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/19/website" target="_blank"><img src="https://opencollective.com/debug/backer/19/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/20/website" target="_blank"><img src="https://opencollective.com/debug/backer/20/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/21/website" target="_blank"><img src="https://opencollective.com/debug/backer/21/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/22/website" target="_blank"><img src="https://opencollective.com/debug/backer/22/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/23/website" target="_blank"><img src="https://opencollective.com/debug/backer/23/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/24/website" target="_blank"><img src="https://opencollective.com/debug/backer/24/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/25/website" target="_blank"><img src="https://opencollective.com/debug/backer/25/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/26/website" target="_blank"><img src="https://opencollective.com/debug/backer/26/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/27/website" target="_blank"><img src="https://opencollective.com/debug/backer/27/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/28/website" target="_blank"><img src="https://opencollective.com/debug/backer/28/avatar.svg"></a> <a href="https://opencollective.com/debug/backer/29/website" target="_blank"><img src="https://opencollective.com/debug/backer/29/avatar.svg"></a> ## Sponsors Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/debug#sponsor)] <a href="https://opencollective.com/debug/sponsor/0/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/0/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/1/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/1/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/2/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/2/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/3/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/3/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/4/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/4/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/5/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/5/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/6/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/6/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/7/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/7/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/8/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/8/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/9/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/9/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/10/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/10/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/11/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/11/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/12/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/12/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/13/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/13/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/14/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/14/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/15/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/15/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/16/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/16/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/17/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/17/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/18/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/18/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/19/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/19/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/20/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/20/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/21/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/21/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/22/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/22/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/23/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/23/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/24/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/24/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/25/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/25/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/26/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/26/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/27/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/27/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/28/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/28/avatar.svg"></a> <a href="https://opencollective.com/debug/sponsor/29/website" target="_blank"><img src="https://opencollective.com/debug/sponsor/29/avatar.svg"></a> ## License (The MIT License) Copyright (c) 2014-2017 TJ Holowaychuk &lt;tj@vision-media.ca&gt; Copyright (c) 2018-2021 Josh Junon 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. [Build]: http://img.shields.io/travis/litejs/natural-compare-lite.png [Coverage]: http://img.shields.io/coveralls/litejs/natural-compare-lite.png [1]: https://travis-ci.org/litejs/natural-compare-lite [2]: https://coveralls.io/r/litejs/natural-compare-lite [npm package]: https://npmjs.org/package/natural-compare-lite [GitHub repo]: https://github.com/litejs/natural-compare-lite @version 1.4.0 @date 2015-10-26 @stability 3 - Stable Natural Compare &ndash; [![Build][]][1] [![Coverage][]][2] =============== Compare strings containing a mix of letters and numbers in the way a human being would in sort order. This is described as a "natural ordering". ```text Standard sorting: Natural order sorting: img1.png img1.png img10.png img2.png img12.png img10.png img2.png img12.png ``` String.naturalCompare returns a number indicating whether a reference string comes before or after or is the same as the given string in sort order. Use it with builtin sort() function. ### Installation - In browser ```html <script src=min.natural-compare.js></script> ``` - In node.js: `npm install natural-compare-lite` ```javascript require("natural-compare-lite") ``` ### Usage ```javascript // Simple case sensitive example var a = ["z1.doc", "z10.doc", "z17.doc", "z2.doc", "z23.doc", "z3.doc"]; a.sort(String.naturalCompare); // ["z1.doc", "z2.doc", "z3.doc", "z10.doc", "z17.doc", "z23.doc"] // Use wrapper function for case insensitivity a.sort(function(a, b){ return String.naturalCompare(a.toLowerCase(), b.toLowerCase()); }) // In most cases we want to sort an array of objects var a = [ {"street":"350 5th Ave", "room":"A-1021"} , {"street":"350 5th Ave", "room":"A-21046-b"} ]; // sort by street, then by room a.sort(function(a, b){ return String.naturalCompare(a.street, b.street) || String.naturalCompare(a.room, b.room); }) // When text transformation is needed (eg toLowerCase()), // it is best for performance to keep // transformed key in that object. // There are no need to do text transformation // on each comparision when sorting. var a = [ {"make":"Audi", "model":"A6"} , {"make":"Kia", "model":"Rio"} ]; // sort by make, then by model a.map(function(car){ car.sort_key = (car.make + " " + car.model).toLowerCase(); }) a.sort(function(a, b){ return String.naturalCompare(a.sort_key, b.sort_key); }) ``` - Works well with dates in ISO format eg "Rev 2012-07-26.doc". ### Custom alphabet It is possible to configure a custom alphabet to achieve a desired order. ```javascript // Estonian alphabet String.alphabet = "ABDEFGHIJKLMNOPRSŠZŽTUVÕÄÖÜXYabdefghijklmnoprsšzžtuvõäöüxy" ["t", "z", "x", "õ"].sort(String.naturalCompare) // ["z", "t", "õ", "x"] // Russian alphabet String.alphabet = "АБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯабвгдеёжзийклмнопрстуфхцчшщъыьэюя" ["Ё", "А", "Б"].sort(String.naturalCompare) // ["А", "Б", "Ё"] ``` External links -------------- - [GitHub repo][https://github.com/litejs/natural-compare-lite] - [jsperf test](http://jsperf.com/natural-sort-2/12) Licence ------- Copyright (c) 2012-2015 Lauri Rooden &lt;lauri@rooden.ee&gt; [The MIT License](http://lauri.rooden.ee/mit-license.txt) [](https://app.travis-ci.com/github/dankogai/js-base64) # base64.js Yet another [Base64] transcoder. [Base64]: http://en.wikipedia.org/wiki/Base64 ## Install ```shell $ npm install --save js-base64 ``` ## Usage ### In Browser Locally… ```html <script src="base64.js"></script> ``` … or Directly from CDN. In which case you don't even need to install. ```html <script src="https://cdn.jsdelivr.net/npm/js-base64@3.7.2/base64.min.js"></script> ``` This good old way loads `Base64` in the global context (`window`). Though `Base64.noConflict()` is made available, you should consider using ES6 Module to avoid tainting `window`. ### As an ES6 Module locally… ```javascript import { Base64 } from 'js-base64'; ``` ```javascript // or if you prefer no Base64 namespace import { encode, decode } from 'js-base64'; ``` or even remotely. ```html <script type="module"> // note jsdelivr.net does not automatically minify .mjs import { Base64 } from 'https://cdn.jsdelivr.net/npm/js-base64@3.7.2/base64.mjs'; </script> ``` ```html <script type="module"> // or if you prefer no Base64 namespace import { encode, decode } from 'https://cdn.jsdelivr.net/npm/js-base64@3.7.2/base64.mjs'; </script> ``` ### node.js (commonjs) ```javascript const {Base64} = require('js-base64'); ``` Unlike the case above, the global context is no longer modified. You can also use [esm] to `import` instead of `require`. [esm]: https://github.com/standard-things/esm ```javascript require=require('esm')(module); import {Base64} from 'js-base64'; ``` ## SYNOPSIS ```javascript let latin = 'dankogai'; let utf8 = '小飼弾' let u8s = new Uint8Array([100,97,110,107,111,103,97,105]); Base64.encode(latin); // ZGFua29nYWk= Base64.encode(latin, true)); // ZGFua29nYWk skips padding Base64.encodeURI(latin)); // ZGFua29nYWk Base64.btoa(latin); // ZGFua29nYWk= Base64.btoa(utf8); // raises exception Base64.fromUint8Array(u8s); // ZGFua29nYWk= Base64.fromUint8Array(u8s, true); // ZGFua29nYW which is URI safe Base64.encode(utf8); // 5bCP6aO85by+ Base64.encode(utf8, true) // 5bCP6aO85by- Base64.encodeURI(utf8); // 5bCP6aO85by- ``` ```javascript Base64.decode( 'ZGFua29nYWk=');// dankogai Base64.decode( 'ZGFua29nYWk'); // dankogai Base64.atob( 'ZGFua29nYWk=');// dankogai Base64.atob( '5bCP6aO85by+');// '小飼弾' which is nonsense Base64.toUint8Array('ZGFua29nYWk=');// u8s above Base64.decode( '5bCP6aO85by+');// 小飼弾 // note .decodeURI() is unnecessary since it accepts both flavors Base64.decode( '5bCP6aO85by-');// 小飼弾 ``` ```javascript Base64.isValid(0); // false: 0 is not string Base64.isValid(''); // true: a valid Base64-encoded empty byte Base64.isValid('ZA=='); // true: a valid Base64-encoded 'd' Base64.isValid('Z A='); // true: whitespaces are okay Base64.isValid('ZA'); // true: padding ='s can be omitted Base64.isValid('++'); // true: can be non URL-safe Base64.isValid('--'); // true: or URL-safe Base64.isValid('+-'); // false: can't mix both ``` ### Built-in Extensions By default `Base64` leaves built-in prototypes untouched. But you can extend them as below. ```javascript // you have to explicitly extend String.prototype Base64.extendString(); // once extended, you can do the following 'dankogai'.toBase64(); // ZGFua29nYWk= '小飼弾'.toBase64(); // 5bCP6aO85by+ '小飼弾'.toBase64(true); // 5bCP6aO85by- '小飼弾'.toBase64URI(); // 5bCP6aO85by- ab alias of .toBase64(true) '小飼弾'.toBase64URL(); // 5bCP6aO85by- an alias of .toBase64URI() 'ZGFua29nYWk='.fromBase64(); // dankogai '5bCP6aO85by+'.fromBase64(); // 小飼弾 '5bCP6aO85by-'.fromBase64(); // 小飼弾 '5bCP6aO85by-'.toUint8Array();// u8s above ``` ```javascript // you have to explicitly extend Uint8Array.prototype Base64.extendUint8Array(); // once extended, you can do the following u8s.toBase64(); // 'ZGFua29nYWk=' u8s.toBase64URI(); // 'ZGFua29nYWk' u8s.toBase64URL(); // 'ZGFua29nYWk' an alias of .toBase64URI() ``` ```javascript // extend all at once Base64.extendBuiltins() ``` ## `.decode()` vs `.atob` (and `.encode()` vs `btoa()`) Suppose you have: ``` var pngBase64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="; ``` Which is a Base64-encoded 1x1 transparent PNG, **DO NOT USE** `Base64.decode(pngBase64)`.  Use `Base64.atob(pngBase64)` instead.  `Base64.decode()` decodes to UTF-8 string while `Base64.atob()` decodes to bytes, which is compatible to browser built-in `atob()` (Which is absent in node.js).  The same rule applies to the opposite direction. Or even better, `Base64.toUint8Array(pngBase64)`. ### If you really, really need an ES5 version You can transpiles to an ES5 that runs on IEs before 11. Do the following in your shell. ```shell $ make base64.es5.js ``` ## Brief History * Since version 3.3 it is written in TypeScript. Now `base64.mjs` is compiled from `base64.ts` then `base64.js` is generated from `base64.mjs`. * Since version 3.7 `base64.js` is ES5-compatible again (hence IE11-compabile). * Since 3.0 `js-base64` switch to ES2015 module so it is no longer compatible with legacy browsers like IE (see above) [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url] [![Downloads][downloads-image]][downloads-url] [](https://gitter.im/eslint/doctrine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) # Doctrine Doctrine is a [JSDoc](http://usejsdoc.org) parser that parses documentation comments from JavaScript (you need to pass in the comment, not a whole JavaScript file). ## Installation You can install Doctrine using [npm](https://npmjs.com): ``` $ npm install doctrine --save-dev ``` Doctrine can also be used in web browsers using [Browserify](http://browserify.org). ## Usage Require doctrine inside of your JavaScript: ```js var doctrine = require("doctrine"); ``` ### parse() The primary method is `parse()`, which accepts two arguments: the JSDoc comment to parse and an optional options object. The available options are: * `unwrap` - set to `true` to delete the leading `/**`, any `*` that begins a line, and the trailing `*/` from the source text. Default: `false`. * `tags` - an array of tags to return. When specified, Doctrine returns only tags in this array. For example, if `tags` is `["param"]`, then only `@param` tags will be returned. Default: `null`. * `recoverable` - set to `true` to keep parsing even when syntax errors occur. Default: `false`. * `sloppy` - set to `true` to allow optional parameters to be specified in brackets (`@param {string} [foo]`). Default: `false`. * `lineNumbers` - set to `true` to add `lineNumber` to each node, specifying the line on which the node is found in the source. Default: `false`. * `range` - set to `true` to add `range` to each node, specifying the start and end index of the node in the original comment. Default: `false`. Here's a simple example: ```js var ast = doctrine.parse( [ "/**", " * This function comment is parsed by doctrine", " * @param {{ok:String}} userName", "*/" ].join('\n'), { unwrap: true }); ``` This example returns the following AST: { "description": "This function comment is parsed by doctrine", "tags": [ { "title": "param", "description": null, "type": { "type": "RecordType", "fields": [ { "type": "FieldType", "key": "ok", "value": { "type": "NameExpression", "name": "String" } } ] }, "name": "userName" } ] } See the [demo page](http://eslint.org/doctrine/demo/) more detail. ## Team These folks keep the project moving and are resources for help: * Nicholas C. Zakas ([@nzakas](https://github.com/nzakas)) - project lead * Yusuke Suzuki ([@constellation](https://github.com/constellation)) - reviewer ## Contributing Issues and pull requests will be triaged and responded to as quickly as possible. We operate under the [ESLint Contributor Guidelines](http://eslint.org/docs/developer-guide/contributing), so please be sure to read them before contributing. If you're not sure where to dig in, check out the [issues](https://github.com/eslint/doctrine/issues). ## Frequently Asked Questions ### Can I pass a whole JavaScript file to Doctrine? No. Doctrine can only parse JSDoc comments, so you'll need to pass just the JSDoc comment to Doctrine in order to work. ### License #### doctrine Copyright JS Foundation and other contributors, https://js.foundation 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. #### esprima some of functions is derived from esprima Copyright (C) 2012, 2011 [Ariya Hidayat](http://ariya.ofilabs.com/about) (twitter: [@ariyahidayat](http://twitter.com/ariyahidayat)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #### closure-compiler some of extensions is derived from closure-compiler Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ ### Where to ask for help? Join our [Chatroom](https://gitter.im/eslint/doctrine) [npm-image]: https://img.shields.io/npm/v/doctrine.svg?style=flat-square [npm-url]: https://www.npmjs.com/package/doctrine [travis-image]: https://img.shields.io/travis/eslint/doctrine/master.svg?style=flat-square [travis-url]: https://travis-ci.org/eslint/doctrine [coveralls-image]: https://img.shields.io/coveralls/eslint/doctrine/master.svg?style=flat-square [coveralls-url]: https://coveralls.io/r/eslint/doctrine?branch=master [downloads-image]: http://img.shields.io/npm/dm/doctrine.svg?style=flat-square [downloads-url]: https://www.npmjs.com/package/doctrine <p align="center"> <a href="https://gulpjs.com"> <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"> </a> </p> # glob-parent [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Azure Pipelines Build Status][azure-pipelines-image]][azure-pipelines-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] Extract the non-magic parent path from a glob string. ## Usage ```js var globParent = require('glob-parent'); globParent('path/to/*.js'); // 'path/to' globParent('/root/path/to/*.js'); // '/root/path/to' globParent('/*.js'); // '/' globParent('*.js'); // '.' globParent('**/*.js'); // '.' globParent('path/{to,from}'); // 'path' globParent('path/!(to|from)'); // 'path' globParent('path/?(to|from)'); // 'path' globParent('path/+(to|from)'); // 'path' globParent('path/*(to|from)'); // 'path' globParent('path/@(to|from)'); // 'path' globParent('path/**/*'); // 'path' // if provided a non-glob path, returns the nearest dir globParent('path/foo/bar.js'); // 'path/foo' globParent('path/foo/'); // 'path/foo' globParent('path/foo'); // 'path' (see issue #3 for details) ``` ## API ### `globParent(maybeGlobString, [options])` Takes a string and returns the part of the path before the glob begins. Be aware of Escaping rules and Limitations below. #### options ```js { // Disables the automatic conversion of slashes for Windows flipBackslashes: true } ``` ## Escaping The following characters have special significance in glob patterns and must be escaped if you want them to be treated as regular path characters: - `?` (question mark) unless used as a path segment alone - `*` (asterisk) - `|` (pipe) - `(` (opening parenthesis) - `)` (closing parenthesis) - `{` (opening curly brace) - `}` (closing curly brace) - `[` (opening bracket) - `]` (closing bracket) **Example** ```js globParent('foo/[bar]/') // 'foo' globParent('foo/\\[bar]/') // 'foo/[bar]' ``` ## Limitations ### Braces & Brackets This library attempts a quick and imperfect method of determining which path parts have glob magic without fully parsing/lexing the pattern. There are some advanced use cases that can trip it up, such as nested braces where the outer pair is escaped and the inner one contains a path separator. If you find yourself in the unlikely circumstance of being affected by this or need to ensure higher-fidelity glob handling in your library, it is recommended that you pre-process your input with [expand-braces] and/or [expand-brackets]. ### Windows Backslashes are not valid path separators for globs. If a path with backslashes is provided anyway, for simple cases, glob-parent will replace the path separator for you and return the non-glob parent path (now with forward-slashes, which are still valid as Windows path separators). This cannot be used in conjunction with escape characters. ```js // BAD globParent('C:\\Program Files \\(x86\\)\\*.ext') // 'C:/Program Files /(x86/)' // GOOD globParent('C:/Program Files\\(x86\\)/*.ext') // 'C:/Program Files (x86)' ``` If you are using escape characters for a pattern without path parts (i.e. relative to `cwd`), prefix with `./` to avoid confusing glob-parent. ```js // BAD globParent('foo \\[bar]') // 'foo ' globParent('foo \\[bar]*') // 'foo ' // GOOD globParent('./foo \\[bar]') // 'foo [bar]' globParent('./foo \\[bar]*') // '.' ``` ## License ISC [expand-braces]: https://github.com/jonschlinkert/expand-braces [expand-brackets]: https://github.com/jonschlinkert/expand-brackets [downloads-image]: https://img.shields.io/npm/dm/glob-parent.svg [npm-url]: https://www.npmjs.com/package/glob-parent [npm-image]: https://img.shields.io/npm/v/glob-parent.svg [azure-pipelines-url]: https://dev.azure.com/gulpjs/gulp/_build/latest?definitionId=2&branchName=master [azure-pipelines-image]: https://dev.azure.com/gulpjs/gulp/_apis/build/status/glob-parent?branchName=master [travis-url]: https://travis-ci.org/gulpjs/glob-parent [travis-image]: https://img.shields.io/travis/gulpjs/glob-parent.svg?label=travis-ci [appveyor-url]: https://ci.appveyor.com/project/gulpjs/glob-parent [appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/glob-parent.svg?label=appveyor [coveralls-url]: https://coveralls.io/r/gulpjs/glob-parent [coveralls-image]: https://img.shields.io/coveralls/gulpjs/glob-parent/master.svg [gitter-url]: https://gitter.im/gulpjs/gulp [gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg # cliui  [](https://www.npmjs.com/package/cliui) [](https://conventionalcommits.org)  easily create complex multi-column command-line-interfaces. ## Example ```js const ui = require('cliui')() ui.div('Usage: $0 [command] [options]') ui.div({ text: 'Options:', padding: [2, 0, 1, 0] }) ui.div( { text: "-f, --file", width: 20, padding: [0, 4, 0, 4] }, { text: "the file to load." + chalk.green("(if this description is long it wraps).") , width: 20 }, { text: chalk.red("[required]"), align: 'right' } ) console.log(ui.toString()) ``` ## Deno/ESM Support As of `v7` `cliui` supports [Deno](https://github.com/denoland/deno) and [ESM](https://nodejs.org/api/esm.html#esm_ecmascript_modules): ```typescript import cliui from "https://deno.land/x/cliui/deno.ts"; const ui = cliui({}) ui.div('Usage: $0 [command] [options]') ui.div({ text: 'Options:', padding: [2, 0, 1, 0] }) ui.div({ text: "-f, --file", width: 20, padding: [0, 4, 0, 4] }) console.log(ui.toString()) ``` <img width="500" src="screenshot.png"> ## Layout DSL cliui exposes a simple layout DSL: If you create a single `ui.div`, passing a string rather than an object: * `\n`: characters will be interpreted as new rows. * `\t`: characters will be interpreted as new columns. * `\s`: characters will be interpreted as padding. **as an example...** ```js var ui = require('./')({ width: 60 }) ui.div( 'Usage: node ./bin/foo.js\n' + ' <regex>\t provide a regex\n' + ' <glob>\t provide a glob\t [required]' ) console.log(ui.toString()) ``` **will output:** ```shell Usage: node ./bin/foo.js <regex> provide a regex <glob> provide a glob [required] ``` ## Methods ```js cliui = require('cliui') ``` ### cliui({width: integer}) Specify the maximum width of the UI being generated. If no width is provided, cliui will try to get the current window's width and use it, and if that doesn't work, width will be set to `80`. ### cliui({wrap: boolean}) Enable or disable the wrapping of text in a column. ### cliui.div(column, column, column) Create a row with any number of columns, a column can either be a string, or an object with the following options: * **text:** some text to place in the column. * **width:** the width of a column. * **align:** alignment, `right` or `center`. * **padding:** `[top, right, bottom, left]`. * **border:** should a border be placed around the div? ### cliui.span(column, column, column) Similar to `div`, except the next row will be appended without a new line being created. ### cliui.resetOutput() Resets the UI elements of the current cliui instance, maintaining the values set for `width` and `wrap`. # Glob Match files using the patterns the shell uses, like stars and stuff. [](https://travis-ci.org/isaacs/node-glob/) [](https://ci.appveyor.com/project/isaacs/node-glob) [](https://coveralls.io/github/isaacs/node-glob?branch=master) This is a glob implementation in JavaScript. It uses the `minimatch` library to do its matching.  ## Usage Install with npm ``` npm i glob ``` ```javascript var glob = require("glob") // options is optional glob("**/*.js", options, function (er, files) { // files is an array of filenames. // If the `nonull` option is set, and nothing // was found, then files is ["**/*.js"] // er is an error object or null. }) ``` ## Glob Primer "Globs" are the patterns you type when you do stuff like `ls *.js` on the command line, or put `build/*` in a `.gitignore` file. Before parsing the path part patterns, braced sections are expanded into a set. Braced sections start with `{` and end with `}`, with any number of comma-delimited sections within. Braced sections may contain slash characters, so `a{/b/c,bcd}` would expand into `a/b/c` and `abcd`. The following characters have special magic meaning when used in a path portion: * `*` Matches 0 or more characters in a single path portion * `?` Matches 1 character * `[...]` Matches a range of characters, similar to a RegExp range. If the first character of the range is `!` or `^` then it matches any character not in the range. * `!(pattern|pattern|pattern)` Matches anything that does not match any of the patterns provided. * `?(pattern|pattern|pattern)` Matches zero or one occurrence of the patterns provided. * `+(pattern|pattern|pattern)` Matches one or more occurrences of the patterns provided. * `*(a|b|c)` Matches zero or more occurrences of the patterns provided * `@(pattern|pat*|pat?erN)` Matches exactly one of the patterns provided * `**` If a "globstar" is alone in a path portion, then it matches zero or more directories and subdirectories searching for matches. It does not crawl symlinked directories. ### Dots If a file or directory path portion has a `.` as the first character, then it will not match any glob pattern unless that pattern's corresponding path part also has a `.` as its first character. For example, the pattern `a/.*/c` would match the file at `a/.b/c`. However the pattern `a/*/c` would not, because `*` does not start with a dot character. You can make glob treat dots as normal characters by setting `dot:true` in the options. ### Basename Matching If you set `matchBase:true` in the options, and the pattern has no slashes in it, then it will seek for any file anywhere in the tree with a matching basename. For example, `*.js` would match `test/simple/basic.js`. ### Empty Sets If no matching files are found, then an empty array is returned. This differs from the shell, where the pattern itself is returned. For example: $ echo a*s*d*f a*s*d*f To get the bash-style behavior, set the `nonull:true` in the options. ### See Also: * `man sh` * `man bash` (Search for "Pattern Matching") * `man 3 fnmatch` * `man 5 gitignore` * [minimatch documentation](https://github.com/isaacs/minimatch) ## glob.hasMagic(pattern, [options]) Returns `true` if there are any special characters in the pattern, and `false` otherwise. Note that the options affect the results. If `noext:true` is set in the options object, then `+(a|b)` will not be considered a magic pattern. If the pattern has a brace expansion, like `a/{b/c,x/y}` then that is considered magical, unless `nobrace:true` is set in the options. ## glob(pattern, [options], cb) * `pattern` `{String}` Pattern to be matched * `options` `{Object}` * `cb` `{Function}` * `err` `{Error | null}` * `matches` `{Array<String>}` filenames found matching the pattern Perform an asynchronous glob search. ## glob.sync(pattern, [options]) * `pattern` `{String}` Pattern to be matched * `options` `{Object}` * return: `{Array<String>}` filenames found matching the pattern Perform a synchronous glob search. ## Class: glob.Glob Create a Glob object by instantiating the `glob.Glob` class. ```javascript var Glob = require("glob").Glob var mg = new Glob(pattern, options, cb) ``` It's an EventEmitter, and starts walking the filesystem to find matches immediately. ### new glob.Glob(pattern, [options], [cb]) * `pattern` `{String}` pattern to search for * `options` `{Object}` * `cb` `{Function}` Called when an error occurs, or matches are found * `err` `{Error | null}` * `matches` `{Array<String>}` filenames found matching the pattern Note that if the `sync` flag is set in the options, then matches will be immediately available on the `g.found` member. ### Properties * `minimatch` The minimatch object that the glob uses. * `options` The options object passed in. * `aborted` Boolean which is set to true when calling `abort()`. There is no way at this time to continue a glob search after aborting, but you can re-use the statCache to avoid having to duplicate syscalls. * `cache` Convenience object. Each field has the following possible values: * `false` - Path does not exist * `true` - Path exists * `'FILE'` - Path exists, and is not a directory * `'DIR'` - Path exists, and is a directory * `[file, entries, ...]` - Path exists, is a directory, and the array value is the results of `fs.readdir` * `statCache` Cache of `fs.stat` results, to prevent statting the same path multiple times. * `symlinks` A record of which paths are symbolic links, which is relevant in resolving `**` patterns. * `realpathCache` An optional object which is passed to `fs.realpath` to minimize unnecessary syscalls. It is stored on the instantiated Glob object, and may be re-used. ### Events * `end` When the matching is finished, this is emitted with all the matches found. If the `nonull` option is set, and no match was found, then the `matches` list contains the original pattern. The matches are sorted, unless the `nosort` flag is set. * `match` Every time a match is found, this is emitted with the specific thing that matched. It is not deduplicated or resolved to a realpath. * `error` Emitted when an unexpected error is encountered, or whenever any fs error occurs if `options.strict` is set. * `abort` When `abort()` is called, this event is raised. ### Methods * `pause` Temporarily stop the search * `resume` Resume the search * `abort` Stop the search forever ### Options All the options that can be passed to Minimatch can also be passed to Glob to change pattern matching behavior. Also, some have been added, or have glob-specific ramifications. All options are false by default, unless otherwise noted. All options are added to the Glob object, as well. If you are running many `glob` operations, you can pass a Glob object as the `options` argument to a subsequent operation to shortcut some `stat` and `readdir` calls. At the very least, you may pass in shared `symlinks`, `statCache`, `realpathCache`, and `cache` options, so that parallel glob operations will be sped up by sharing information about the filesystem. * `cwd` The current working directory in which to search. Defaults to `process.cwd()`. * `root` The place where patterns starting with `/` will be mounted onto. Defaults to `path.resolve(options.cwd, "/")` (`/` on Unix systems, and `C:\` or some such on Windows.) * `dot` Include `.dot` files in normal matches and `globstar` matches. Note that an explicit dot in a portion of the pattern will always match dot files. * `nomount` By default, a pattern starting with a forward-slash will be "mounted" onto the root setting, so that a valid filesystem path is returned. Set this flag to disable that behavior. * `mark` Add a `/` character to directory matches. Note that this requires additional stat calls. * `nosort` Don't sort the results. * `stat` Set to true to stat *all* results. This reduces performance somewhat, and is completely unnecessary, unless `readdir` is presumed to be an untrustworthy indicator of file existence. * `silent` When an unusual error is encountered when attempting to read a directory, a warning will be printed to stderr. Set the `silent` option to true to suppress these warnings. * `strict` When an unusual error is encountered when attempting to read a directory, the process will just continue on in search of other matches. Set the `strict` option to raise an error in these cases. * `cache` See `cache` property above. Pass in a previously generated cache object to save some fs calls. * `statCache` A cache of results of filesystem information, to prevent unnecessary stat calls. While it should not normally be necessary to set this, you may pass the statCache from one glob() call to the options object of another, if you know that the filesystem will not change between calls. (See "Race Conditions" below.) * `symlinks` A cache of known symbolic links. You may pass in a previously generated `symlinks` object to save `lstat` calls when resolving `**` matches. * `sync` DEPRECATED: use `glob.sync(pattern, opts)` instead. * `nounique` In some cases, brace-expanded patterns can result in the same file showing up multiple times in the result set. By default, this implementation prevents duplicates in the result set. Set this flag to disable that behavior. * `nonull` Set to never return an empty set, instead returning a set containing the pattern itself. This is the default in glob(3). * `debug` Set to enable debug logging in minimatch and glob. * `nobrace` Do not expand `{a,b}` and `{1..3}` brace sets. * `noglobstar` Do not match `**` against multiple filenames. (Ie, treat it as a normal `*` instead.) * `noext` Do not match `+(a|b)` "extglob" patterns. * `nocase` Perform a case-insensitive match. Note: on case-insensitive filesystems, non-magic patterns will match by default, since `stat` and `readdir` will not raise errors. * `matchBase` Perform a basename-only match if the pattern does not contain any slash characters. That is, `*.js` would be treated as equivalent to `**/*.js`, matching all js files in all directories. * `nodir` Do not match directories, only files. (Note: to match *only* directories, simply put a `/` at the end of the pattern.) * `ignore` Add a pattern or an array of glob patterns to exclude matches. Note: `ignore` patterns are *always* in `dot:true` mode, regardless of any other settings. * `follow` Follow symlinked directories when expanding `**` patterns. Note that this can result in a lot of duplicate references in the presence of cyclic links. * `realpath` Set to true to call `fs.realpath` on all of the results. In the case of a symlink that cannot be resolved, the full absolute path to the matched entry is returned (though it will usually be a broken symlink) * `absolute` Set to true to always receive absolute paths for matched files. Unlike `realpath`, this also affects the values returned in the `match` event. * `fs` File-system object with Node's `fs` API. By default, the built-in `fs` module will be used. Set to a volume provided by a library like `memfs` to avoid using the "real" file-system. ## Comparisons to other fnmatch/glob implementations While strict compliance with the existing standards is a worthwhile goal, some discrepancies exist between node-glob and other implementations, and are intentional. The double-star character `**` is supported by default, unless the `noglobstar` flag is set. This is supported in the manner of bsdglob and bash 4.3, where `**` only has special significance if it is the only thing in a path part. That is, `a/**/b` will match `a/x/y/b`, but `a/**b` will not. Note that symlinked directories are not crawled as part of a `**`, though their contents may match against subsequent portions of the pattern. This prevents infinite loops and duplicates and the like. If an escaped pattern has no matches, and the `nonull` flag is set, then glob returns the pattern as-provided, rather than interpreting the character escapes. For example, `glob.match([], "\\*a\\?")` will return `"\\*a\\?"` rather than `"*a?"`. This is akin to setting the `nullglob` option in bash, except that it does not resolve escaped pattern characters. If brace expansion is not disabled, then it is performed before any other interpretation of the glob pattern. Thus, a pattern like `+(a|{b),c)}`, which would not be valid in bash or zsh, is expanded **first** into the set of `+(a|b)` and `+(a|c)`, and those patterns are checked for validity. Since those two are valid, matching proceeds. ### Comments and Negation Previously, this module let you mark a pattern as a "comment" if it started with a `#` character, or a "negated" pattern if it started with a `!` character. These options were deprecated in version 5, and removed in version 6. To specify things that should not match, use the `ignore` option. ## Windows **Please only use forward-slashes in glob expressions.** Though windows uses either `/` or `\` as its path separator, only `/` characters are used by this glob implementation. You must use forward-slashes **only** in glob expressions. Back-slashes will always be interpreted as escape characters, not path separators. Results from absolute patterns such as `/foo/*` are mounted onto the root setting using `path.join`. On windows, this will by default result in `/foo/*` matching `C:\foo\bar.txt`. ## Race Conditions Glob searching, by its very nature, is susceptible to race conditions, since it relies on directory walking and such. As a result, it is possible that a file that exists when glob looks for it may have been deleted or modified by the time it returns the result. As part of its internal implementation, this program caches all stat and readdir calls that it makes, in order to cut down on system overhead. However, this also makes it even more susceptible to races, especially if the cache or statCache objects are reused between glob calls. Users are thus advised not to use a glob result as a guarantee of filesystem state in the face of rapid changes. For the vast majority of operations, this is never a problem. ## Glob Logo Glob's logo was created by [Tanya Brassie](http://tanyabrassie.com/). Logo files can be found [here](https://github.com/isaacs/node-glob/tree/master/logo). The logo is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). ## Contributing Any change to behavior (including bugfixes) must come with a test. Patches that fail tests or reduce performance will be rejected. ``` # to run tests npm test # to re-generate test fixtures npm run test-regen # to benchmark against bash/zsh npm run bench # to profile javascript npm run prof ```  # json-schema-traverse Traverse JSON Schema passing each schema object to callback [](https://travis-ci.org/epoberezkin/json-schema-traverse) [](https://www.npmjs.com/package/json-schema-traverse) [](https://coveralls.io/github/epoberezkin/json-schema-traverse?branch=master) ## Install ``` npm install json-schema-traverse ``` ## Usage ```javascript const traverse = require('json-schema-traverse'); const schema = { properties: { foo: {type: 'string'}, bar: {type: 'integer'} } }; traverse(schema, {cb}); // cb is called 3 times with: // 1. root schema // 2. {type: 'string'} // 3. {type: 'integer'} // Or: traverse(schema, {cb: {pre, post}}); // pre is called 3 times with: // 1. root schema // 2. {type: 'string'} // 3. {type: 'integer'} // // post is called 3 times with: // 1. {type: 'string'} // 2. {type: 'integer'} // 3. root schema ``` Callback function `cb` is called for each schema object (not including draft-06 boolean schemas), including the root schema, in pre-order traversal. Schema references ($ref) are not resolved, they are passed as is. Alternatively, you can pass a `{pre, post}` object as `cb`, and then `pre` will be called before traversing child elements, and `post` will be called after all child elements have been traversed. Callback is passed these parameters: - _schema_: the current schema object - _JSON pointer_: from the root schema to the current schema object - _root schema_: the schema passed to `traverse` object - _parent JSON pointer_: from the root schema to the parent schema object (see below) - _parent keyword_: the keyword inside which this schema appears (e.g. `properties`, `anyOf`, etc.) - _parent schema_: not necessarily parent object/array; in the example above the parent schema for `{type: 'string'}` is the root schema - _index/property_: index or property name in the array/object containing multiple schemas; in the example above for `{type: 'string'}` the property name is `'foo'` ## Traverse objects in all unknown keywords ```javascript const traverse = require('json-schema-traverse'); const schema = { mySchema: { minimum: 1, maximum: 2 } }; traverse(schema, {allKeys: true, cb}); // cb is called 2 times with: // 1. root schema // 2. mySchema ``` Without option `allKeys: true` callback will be called only with root schema. ## License [MIT](https://github.com/epoberezkin/json-schema-traverse/blob/master/LICENSE) functional-red-black-tree ========================= A [fully persistent](http://en.wikipedia.org/wiki/Persistent_data_structure) [red-black tree](http://en.wikipedia.org/wiki/Red%E2%80%93black_tree) written 100% in JavaScript. Works both in node.js and in the browser via [browserify](http://browserify.org/). Functional (or fully presistent) data structures allow for non-destructive updates. So if you insert an element into the tree, it returns a new tree with the inserted element rather than destructively updating the existing tree in place. Doing this requires using extra memory, and if one were naive it could cost as much as reallocating the entire tree. Instead, this data structure saves some memory by recycling references to previously allocated subtrees. This requires using only O(log(n)) additional memory per update instead of a full O(n) copy. Some advantages of this is that it is possible to apply insertions and removals to the tree while still iterating over previous versions of the tree. Functional and persistent data structures can also be useful in many geometric algorithms like point location within triangulations or ray queries, and can be used to analyze the history of executing various algorithms. This added power though comes at a cost, since it is generally a bit slower to use a functional data structure than an imperative version. However, if your application needs this behavior then you may consider using this module. # Install npm install functional-red-black-tree # Example Here is an example of some basic usage: ```javascript //Load the library var createTree = require("functional-red-black-tree") //Create a tree var t1 = createTree() //Insert some items into the tree var t2 = t1.insert(1, "foo") var t3 = t2.insert(2, "bar") //Remove something var t4 = t3.remove(1) ``` # API ```javascript var createTree = require("functional-red-black-tree") ``` ## Overview - [Tree methods](#tree-methods) - [`var tree = createTree([compare])`](#var-tree-=-createtreecompare) - [`tree.keys`](#treekeys) - [`tree.values`](#treevalues) - [`tree.length`](#treelength) - [`tree.get(key)`](#treegetkey) - [`tree.insert(key, value)`](#treeinsertkey-value) - [`tree.remove(key)`](#treeremovekey) - [`tree.find(key)`](#treefindkey) - [`tree.ge(key)`](#treegekey) - [`tree.gt(key)`](#treegtkey) - [`tree.lt(key)`](#treeltkey) - [`tree.le(key)`](#treelekey) - [`tree.at(position)`](#treeatposition) - [`tree.begin`](#treebegin) - [`tree.end`](#treeend) - [`tree.forEach(visitor(key,value)[, lo[, hi]])`](#treeforEachvisitorkeyvalue-lo-hi) - [`tree.root`](#treeroot) - [Node properties](#node-properties) - [`node.key`](#nodekey) - [`node.value`](#nodevalue) - [`node.left`](#nodeleft) - [`node.right`](#noderight) - [Iterator methods](#iterator-methods) - [`iter.key`](#iterkey) - [`iter.value`](#itervalue) - [`iter.node`](#iternode) - [`iter.tree`](#itertree) - [`iter.index`](#iterindex) - [`iter.valid`](#itervalid) - [`iter.clone()`](#iterclone) - [`iter.remove()`](#iterremove) - [`iter.update(value)`](#iterupdatevalue) - [`iter.next()`](#iternext) - [`iter.prev()`](#iterprev) - [`iter.hasNext`](#iterhasnext) - [`iter.hasPrev`](#iterhasprev) ## Tree methods ### `var tree = createTree([compare])` Creates an empty functional tree * `compare` is an optional comparison function, same semantics as array.sort() **Returns** An empty tree ordered by `compare` ### `tree.keys` A sorted array of all the keys in the tree ### `tree.values` An array array of all the values in the tree ### `tree.length` The number of items in the tree ### `tree.get(key)` Retrieves the value associated to the given key * `key` is the key of the item to look up **Returns** The value of the first node associated to `key` ### `tree.insert(key, value)` Creates a new tree with the new pair inserted. * `key` is the key of the item to insert * `value` is the value of the item to insert **Returns** A new tree with `key` and `value` inserted ### `tree.remove(key)` Removes the first item with `key` in the tree * `key` is the key of the item to remove **Returns** A new tree with the given item removed if it exists ### `tree.find(key)` Returns an iterator pointing to the first item in the tree with `key`, otherwise `null`. ### `tree.ge(key)` Find the first item in the tree whose key is `>= key` * `key` is the key to search for **Returns** An iterator at the given element. ### `tree.gt(key)` Finds the first item in the tree whose key is `> key` * `key` is the key to search for **Returns** An iterator at the given element ### `tree.lt(key)` Finds the last item in the tree whose key is `< key` * `key` is the key to search for **Returns** An iterator at the given element ### `tree.le(key)` Finds the last item in the tree whose key is `<= key` * `key` is the key to search for **Returns** An iterator at the given element ### `tree.at(position)` Finds an iterator starting at the given element * `position` is the index at which the iterator gets created **Returns** An iterator starting at position ### `tree.begin` An iterator pointing to the first element in the tree ### `tree.end` An iterator pointing to the last element in the tree ### `tree.forEach(visitor(key,value)[, lo[, hi]])` Walks a visitor function over the nodes of the tree in order. * `visitor(key,value)` is a callback that gets executed on each node. If a truthy value is returned from the visitor, then iteration is stopped. * `lo` is an optional start of the range to visit (inclusive) * `hi` is an optional end of the range to visit (non-inclusive) **Returns** The last value returned by the callback ### `tree.root` Returns the root node of the tree ## Node properties Each node of the tree has the following properties: ### `node.key` The key associated to the node ### `node.value` The value associated to the node ### `node.left` The left subtree of the node ### `node.right` The right subtree of the node ## Iterator methods ### `iter.key` The key of the item referenced by the iterator ### `iter.value` The value of the item referenced by the iterator ### `iter.node` The value of the node at the iterator's current position. `null` is iterator is node valid. ### `iter.tree` The tree associated to the iterator ### `iter.index` Returns the position of this iterator in the sequence. ### `iter.valid` Checks if the iterator is valid ### `iter.clone()` Makes a copy of the iterator ### `iter.remove()` Removes the item at the position of the iterator **Returns** A new binary search tree with `iter`'s item removed ### `iter.update(value)` Updates the value of the node in the tree at this iterator **Returns** A new binary search tree with the corresponding node updated ### `iter.next()` Advances the iterator to the next position ### `iter.prev()` Moves the iterator backward one element ### `iter.hasNext` If true, then the iterator is not at the end of the sequence ### `iter.hasPrev` If true, then the iterator is not at the beginning of the sequence # Credits (c) 2013 Mikola Lysenko. MIT License ## Follow Redirects Drop-in replacement for Nodes `http` and `https` that automatically follows redirects. [](https://www.npmjs.com/package/follow-redirects) [](https://travis-ci.org/follow-redirects/follow-redirects) [](https://coveralls.io/r/follow-redirects/follow-redirects?branch=master) [](https://david-dm.org/follow-redirects/follow-redirects) [](https://www.npmjs.com/package/follow-redirects) `follow-redirects` provides [request](https://nodejs.org/api/http.html#http_http_request_options_callback) and [get](https://nodejs.org/api/http.html#http_http_get_options_callback) methods that behave identically to those found on the native [http](https://nodejs.org/api/http.html#http_http_request_options_callback) and [https](https://nodejs.org/api/https.html#https_https_request_options_callback) modules, with the exception that they will seamlessly follow redirects. ```javascript var http = require('follow-redirects').http; var https = require('follow-redirects').https; http.get('http://bit.ly/900913', function (response) { response.on('data', function (chunk) { console.log(chunk); }); }).on('error', function (err) { console.error(err); }); ``` You can inspect the final redirected URL through the `responseUrl` property on the `response`. If no redirection happened, `responseUrl` is the original request URL. ```javascript https.request({ host: 'bitly.com', path: '/UHfDGO', }, function (response) { console.log(response.responseUrl); // 'http://duckduckgo.com/robots.txt' }); ``` ## Options ### Global options Global options are set directly on the `follow-redirects` module: ```javascript var followRedirects = require('follow-redirects'); followRedirects.maxRedirects = 10; followRedirects.maxBodyLength = 20 * 1024 * 1024; // 20 MB ``` The following global options are supported: - `maxRedirects` (default: `21`) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted. - `maxBodyLength` (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted. ### Per-request options Per-request options are set by passing an `options` object: ```javascript var url = require('url'); var followRedirects = require('follow-redirects'); var options = url.parse('http://bit.ly/900913'); options.maxRedirects = 10; http.request(options); ``` In addition to the [standard HTTP](https://nodejs.org/api/http.html#http_http_request_options_callback) and [HTTPS options](https://nodejs.org/api/https.html#https_https_request_options_callback), the following per-request options are supported: - `followRedirects` (default: `true`) – whether redirects should be followed. - `maxRedirects` (default: `21`) – sets the maximum number of allowed redirects; if exceeded, an error will be emitted. - `maxBodyLength` (default: 10MB) – sets the maximum size of the request body; if exceeded, an error will be emitted. - `agents` (default: `undefined`) – sets the `agent` option per protocol, since HTTP and HTTPS use different agents. Example value: `{ http: new http.Agent(), https: new https.Agent() }` - `trackRedirects` (default: `false`) – whether to store the redirected response details into the `redirects` array on the response object. ### Advanced usage By default, `follow-redirects` will use the Node.js default implementations of [`http`](https://nodejs.org/api/http.html) and [`https`](https://nodejs.org/api/https.html). To enable features such as caching and/or intermediate request tracking, you might instead want to wrap `follow-redirects` around custom protocol implementations: ```javascript var followRedirects = require('follow-redirects').wrap({ http: require('your-custom-http'), https: require('your-custom-https'), }); ``` Such custom protocols only need an implementation of the `request` method. ## Browserify Usage Due to the way `XMLHttpRequest` works, the `browserify` versions of `http` and `https` already follow redirects. If you are *only* targeting the browser, then this library has little value for you. If you want to write cross platform code for node and the browser, `follow-redirects` provides a great solution for making the native node modules behave the same as they do in browserified builds in the browser. To avoid bundling unnecessary code you should tell browserify to swap out `follow-redirects` with the standard modules when bundling. To make this easier, you need to change how you require the modules: ```javascript var http = require('follow-redirects/http'); var https = require('follow-redirects/https'); ``` You can then replace `follow-redirects` in your browserify configuration like so: ```javascript "browser": { "follow-redirects/http" : "http", "follow-redirects/https" : "https" } ``` The `browserify-http` module has not kept pace with node development, and no long behaves identically to the native module when running in the browser. If you are experiencing problems, you may want to check out [browserify-http-2](https://www.npmjs.com/package/http-browserify-2). It is more actively maintained and attempts to address a few of the shortcomings of `browserify-http`. In that case, your browserify config should look something like this: ```javascript "browser": { "follow-redirects/http" : "browserify-http-2/http", "follow-redirects/https" : "browserify-http-2/https" } ``` ## Contributing Pull Requests are always welcome. Please [file an issue](https://github.com/follow-redirects/follow-redirects/issues) detailing your proposal before you invest your valuable time. Additional features and bug fixes should be accompanied by tests. You can run the test suite locally with a simple `npm test` command. ## Debug Logging `follow-redirects` uses the excellent [debug](https://www.npmjs.com/package/debug) for logging. To turn on logging set the environment variable `DEBUG=follow-redirects` for debug output from just this module. When running the test suite it is sometimes advantageous to set `DEBUG=*` to see output from the express server as well. ## Authors - Olivier Lalonde (olalonde@gmail.com) - James Talmage (james@talmage.io) - [Ruben Verborgh](https://ruben.verborgh.org/) ## License [https://github.com/follow-redirects/follow-redirects/blob/master/LICENSE](MIT License) # rechoir [](http://travis-ci.org/tkellen/js-rechoir) > Require any supported file as a node module. [](https://nodei.co/npm/rechoir/) ## What is it? This module, in conjunction with [interpret]-like objects can register any file type the npm ecosystem has a module loader for. This library is a dependency of [Liftoff]. ## API ### prepare(config, filepath, requireFrom) Look for a module loader associated with the provided file and attempt require it. If necessary, run any setup required to inject it into [require.extensions](http://nodejs.org/api/globals.html#globals_require_extensions). `config` An [interpret]-like configuration object. `filepath` A file whose type you'd like to register a module loader for. `requireFrom` An optional path to start searching for the module required to load the requested file. Defaults to the directory of `filepath`. If calling this method is successful (aka: it doesn't throw), you can now require files of the type you requested natively. An error with a `failures` property will be thrown if the module loader(s) configured for a given extension cannot be registered. If a loader is already registered, this will simply return `true`. **Note:** While rechoir will automatically load and register transpilers like `coffee-script`, you must provide a local installation. The transpilers are **not** bundled with this module. #### Usage ```js const config = require('interpret').extensions; const rechoir = require('rechoir'); rechoir.prepare(config, './test/fixtures/test.coffee'); rechoir.prepare(config, './test/fixtures/test.csv'); rechoir.prepare(config, './test/fixtures/test.toml'); console.log(require('./test/fixtures/test.coffee')); console.log(require('./test/fixtures/test.csv')); console.log(require('./test/fixtures/test.toml')); ``` [interpret]: http://github.com/tkellen/js-interpret [Liftoff]: http://github.com/tkellen/js-liftoff # isobject [](https://www.npmjs.com/package/isobject) [](https://npmjs.org/package/isobject) [](https://travis-ci.org/jonschlinkert/isobject) Returns true if the value is an object and not an array or null. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install isobject --save ``` Use [is-plain-object](https://github.com/jonschlinkert/is-plain-object) if you want only objects that are created by the `Object` constructor. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install isobject ``` Install with [bower](http://bower.io/) ```sh $ bower install isobject ``` ## Usage ```js var isObject = require('isobject'); ``` **True** All of the following return `true`: ```js isObject({}); isObject(Object.create({})); isObject(Object.create(Object.prototype)); isObject(Object.create(null)); isObject({}); isObject(new Foo); isObject(/foo/); ``` **False** All of the following return `false`: ```js isObject(); isObject(function () {}); isObject(1); isObject([]); isObject(undefined); isObject(null); ``` ## Related projects You might also be interested in these projects: [merge-deep](https://www.npmjs.com/package/merge-deep): Recursively merge values in a javascript object. | [homepage](https://github.com/jonschlinkert/merge-deep) * [extend-shallow](https://www.npmjs.com/package/extend-shallow): Extend an object with the properties of additional objects. node.js/javascript util. | [homepage](https://github.com/jonschlinkert/extend-shallow) * [is-plain-object](https://www.npmjs.com/package/is-plain-object): Returns true if an object was created by the `Object` constructor. | [homepage](https://github.com/jonschlinkert/is-plain-object) * [kind-of](https://www.npmjs.com/package/kind-of): Get the native type of a value. | [homepage](https://github.com/jonschlinkert/kind-of) ## Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/isobject/issues/new). ## Building docs Generate readme and API documentation with [verb](https://github.com/verbose/verb): ```sh $ npm install verb && npm run docs ``` Or, if [verb](https://github.com/verbose/verb) is installed globally: ```sh $ verb ``` ## Running tests Install dev dependencies: ```sh $ npm install -d && npm test ``` ## Author **Jon Schlinkert** * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](http://twitter.com/jonschlinkert) ## License Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT license](https://github.com/jonschlinkert/isobject/blob/master/LICENSE). *** _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 25, 2016._ <img align="right" alt="Ajv logo" width="160" src="https://ajv.js.org/images/ajv_logo.png"> # Ajv: Another JSON Schema Validator The fastest JSON Schema validator for Node.js and browser. Supports draft-04/06/07. [](https://travis-ci.org/ajv-validator/ajv) [](https://www.npmjs.com/package/ajv) [](https://www.npmjs.com/package/ajv/v/7.0.0-beta.0) [](https://www.npmjs.com/package/ajv) [](https://coveralls.io/github/ajv-validator/ajv?branch=master) [](https://gitter.im/ajv-validator/ajv) [](https://github.com/sponsors/epoberezkin) ## Ajv v7 beta is released [Ajv version 7.0.0-beta.0](https://github.com/ajv-validator/ajv/tree/v7-beta) is released with these changes: - to reduce the mistakes in JSON schemas and unexpected validation results, [strict mode](./docs/strict-mode.md) is added - it prohibits ignored or ambiguous JSON Schema elements. - to make code injection from untrusted schemas impossible, [code generation](./docs/codegen.md) is fully re-written to be safe. - to simplify Ajv extensions, the new keyword API that is used by pre-defined keywords is available to user-defined keywords - it is much easier to define any keywords now, especially with subschemas. - schemas are compiled to ES6 code (ES5 code generation is supported with an option). - to improve reliability and maintainability the code is migrated to TypeScript. **Please note**: - the support for JSON-Schema draft-04 is removed - if you have schemas using "id" attributes you have to replace them with "\$id" (or continue using version 6 that will be supported until 02/28/2021). - all formats are separated to ajv-formats package - they have to be explicitely added if you use them. See [release notes](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0-beta.0) for the details. To install the new version: ```bash npm install ajv@beta ``` See [Getting started with v7](https://github.com/ajv-validator/ajv/tree/v7-beta#usage) for code example. ## Mozilla MOSS grant and OpenJS Foundation [<img src="https://www.poberezkin.com/images/mozilla.png" width="240" height="68">](https://www.mozilla.org/en-US/moss/) &nbsp;&nbsp;&nbsp; [<img src="https://www.poberezkin.com/images/openjs.png" width="220" height="68">](https://openjsf.org/blog/2020/08/14/ajv-joins-openjs-foundation-as-an-incubation-project/) Ajv has been awarded a grant from Mozilla’s [Open Source Support (MOSS) program](https://www.mozilla.org/en-US/moss/) in the “Foundational Technology” track! It will sponsor the development of Ajv support of [JSON Schema version 2019-09](https://tools.ietf.org/html/draft-handrews-json-schema-02) and of [JSON Type Definition](https://tools.ietf.org/html/draft-ucarion-json-type-definition-04). Ajv also joined [OpenJS Foundation](https://openjsf.org/) – having this support will help ensure the longevity and stability of Ajv for all its users. This [blog post](https://www.poberezkin.com/posts/2020-08-14-ajv-json-validator-mozilla-open-source-grant-openjs-foundation.html) has more details. I am looking for the long term maintainers of Ajv – working with [ReadySet](https://www.thereadyset.co/), also sponsored by Mozilla, to establish clear guidelines for the role of a "maintainer" and the contribution standards, and to encourage a wider, more inclusive, contribution from the community. ## Please [sponsor Ajv development](https://github.com/sponsors/epoberezkin) Since I asked to support Ajv development 40 people and 6 organizations contributed via GitHub and OpenCollective - this support helped receiving the MOSS grant! Your continuing support is very important - the funds will be used to develop and maintain Ajv once the next major version is released. Please sponsor Ajv via: - [GitHub sponsors page](https://github.com/sponsors/epoberezkin) (GitHub will match it) - [Ajv Open Collective️](https://opencollective.com/ajv) Thank you. #### Open Collective sponsors <a href="https://opencollective.com/ajv"><img src="https://opencollective.com/ajv/individuals.svg?width=890"></a> <a href="https://opencollective.com/ajv/organization/0/website"><img src="https://opencollective.com/ajv/organization/0/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/1/website"><img src="https://opencollective.com/ajv/organization/1/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/2/website"><img src="https://opencollective.com/ajv/organization/2/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/3/website"><img src="https://opencollective.com/ajv/organization/3/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/4/website"><img src="https://opencollective.com/ajv/organization/4/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/5/website"><img src="https://opencollective.com/ajv/organization/5/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/6/website"><img src="https://opencollective.com/ajv/organization/6/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/7/website"><img src="https://opencollective.com/ajv/organization/7/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/8/website"><img src="https://opencollective.com/ajv/organization/8/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/9/website"><img src="https://opencollective.com/ajv/organization/9/avatar.svg"></a> ## Using version 6 [JSON Schema draft-07](http://json-schema.org/latest/json-schema-validation.html) is published. [Ajv version 6.0.0](https://github.com/ajv-validator/ajv/releases/tag/v6.0.0) that supports draft-07 is released. It may require either migrating your schemas or updating your code (to continue using draft-04 and v5 schemas, draft-06 schemas will be supported without changes). __Please note__: To use Ajv with draft-06 schemas you need to explicitly add the meta-schema to the validator instance: ```javascript ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-06.json')); ``` To use Ajv with draft-04 schemas in addition to explicitly adding meta-schema you also need to use option schemaId: ```javascript var ajv = new Ajv({schemaId: 'id'}); // If you want to use both draft-04 and draft-06/07 schemas: // var ajv = new Ajv({schemaId: 'auto'}); ajv.addMetaSchema(require('ajv/lib/refs/json-schema-draft-04.json')); ``` ## Contents - [Performance](#performance) - [Features](#features) - [Getting started](#getting-started) - [Frequently Asked Questions](https://github.com/ajv-validator/ajv/blob/master/FAQ.md) - [Using in browser](#using-in-browser) - [Ajv and Content Security Policies (CSP)](#ajv-and-content-security-policies-csp) - [Command line interface](#command-line-interface) - Validation - [Keywords](#validation-keywords) - [Annotation keywords](#annotation-keywords) - [Formats](#formats) - [Combining schemas with $ref](#ref) - [$data reference](#data-reference) - NEW: [$merge and $patch keywords](#merge-and-patch-keywords) - [Defining custom keywords](#defining-custom-keywords) - [Asynchronous schema compilation](#asynchronous-schema-compilation) - [Asynchronous validation](#asynchronous-validation) - [Security considerations](#security-considerations) - [Security contact](#security-contact) - [Untrusted schemas](#untrusted-schemas) - [Circular references in objects](#circular-references-in-javascript-objects) - [Trusted schemas](#security-risks-of-trusted-schemas) - [ReDoS attack](#redos-attack) - Modifying data during validation - [Filtering data](#filtering-data) - [Assigning defaults](#assigning-defaults) - [Coercing data types](#coercing-data-types) - API - [Methods](#api) - [Options](#options) - [Validation errors](#validation-errors) - [Plugins](#plugins) - [Related packages](#related-packages) - [Some packages using Ajv](#some-packages-using-ajv) - [Tests, Contributing, Changes history](#tests) - [Support, Code of conduct, License](#open-source-software-support) ## Performance Ajv generates code using [doT templates](https://github.com/olado/doT) to turn JSON Schemas into super-fast validation functions that are efficient for v8 optimization. Currently Ajv is the fastest and the most standard compliant validator according to these benchmarks: - [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark) - 50% faster than the second place - [jsck benchmark](https://github.com/pandastrike/jsck#benchmarks) - 20-190% faster - [z-schema benchmark](https://rawgit.com/zaggino/z-schema/master/benchmark/results.html) - [themis benchmark](https://cdn.rawgit.com/playlyfe/themis/master/benchmark/results.html) Performance of different validators by [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark): [](https://github.com/ebdrup/json-schema-benchmark/blob/master/README.md#performance) ## Features - Ajv implements full JSON Schema [draft-06/07](http://json-schema.org/) and draft-04 standards: - all validation keywords (see [JSON Schema validation keywords](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md)) - full support of remote refs (remote schemas have to be added with `addSchema` or compiled to be available) - support of circular references between schemas - correct string lengths for strings with unicode pairs (can be turned off) - [formats](#formats) defined by JSON Schema draft-07 standard and custom formats (can be turned off) - [validates schemas against meta-schema](#api-validateschema) - supports [browsers](#using-in-browser) and Node.js 0.10-14.x - [asynchronous loading](#asynchronous-schema-compilation) of referenced schemas during compilation - "All errors" validation mode with [option allErrors](#options) - [error messages with parameters](#validation-errors) describing error reasons to allow creating custom error messages - i18n error messages support with [ajv-i18n](https://github.com/ajv-validator/ajv-i18n) package - [filtering data](#filtering-data) from additional properties - [assigning defaults](#assigning-defaults) to missing properties and items - [coercing data](#coercing-data-types) to the types specified in `type` keywords - [custom keywords](#defining-custom-keywords) - draft-06/07 keywords `const`, `contains`, `propertyNames` and `if/then/else` - draft-06 boolean schemas (`true`/`false` as a schema to always pass/fail). - keywords `switch`, `patternRequired`, `formatMaximum` / `formatMinimum` and `formatExclusiveMaximum` / `formatExclusiveMinimum` from [JSON Schema extension proposals](https://github.com/json-schema/json-schema/wiki/v5-Proposals) with [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) package - [$data reference](#data-reference) to use values from the validated data as values for the schema keywords - [asynchronous validation](#asynchronous-validation) of custom formats and keywords ## Install ``` npm install ajv ``` ## <a name="usage"></a>Getting started Try it in the Node.js REPL: https://tonicdev.com/npm/ajv The fastest validation call: ```javascript // Node.js require: var Ajv = require('ajv'); // or ESM/TypeScript import import Ajv from 'ajv'; var ajv = new Ajv(); // options can be passed, e.g. {allErrors: true} var validate = ajv.compile(schema); var valid = validate(data); if (!valid) console.log(validate.errors); ``` or with less code ```javascript // ... var valid = ajv.validate(schema, data); if (!valid) console.log(ajv.errors); // ... ``` or ```javascript // ... var valid = ajv.addSchema(schema, 'mySchema') .validate('mySchema', data); if (!valid) console.log(ajv.errorsText()); // ... ``` See [API](#api) and [Options](#options) for more details. Ajv compiles schemas to functions and caches them in all cases (using schema serialized with [fast-json-stable-stringify](https://github.com/epoberezkin/fast-json-stable-stringify) or a custom function as a key), so that the next time the same schema is used (not necessarily the same object instance) it won't be compiled again. The best performance is achieved when using compiled functions returned by `compile` or `getSchema` methods (there is no additional function call). __Please note__: every time a validation function or `ajv.validate` are called `errors` property is overwritten. You need to copy `errors` array reference to another variable if you want to use it later (e.g., in the callback). See [Validation errors](#validation-errors) __Note for TypeScript users__: `ajv` provides its own TypeScript declarations out of the box, so you don't need to install the deprecated `@types/ajv` module. ## Using in browser You can require Ajv directly from the code you browserify - in this case Ajv will be a part of your bundle. If you need to use Ajv in several bundles you can create a separate UMD bundle using `npm run bundle` script (thanks to [siddo420](https://github.com/siddo420)). Then you need to load Ajv in the browser: ```html <script src="ajv.min.js"></script> ``` This bundle can be used with different module systems; it creates global `Ajv` if no module system is found. The browser bundle is available on [cdnjs](https://cdnjs.com/libraries/ajv). Ajv is tested with these browsers: [](https://saucelabs.com/u/epoberezkin) __Please note__: some frameworks, e.g. Dojo, may redefine global require in such way that is not compatible with CommonJS module format. In such case Ajv bundle has to be loaded before the framework and then you can use global Ajv (see issue [#234](https://github.com/ajv-validator/ajv/issues/234)). ### Ajv and Content Security Policies (CSP) If you're using Ajv to compile a schema (the typical use) in a browser document that is loaded with a Content Security Policy (CSP), that policy will require a `script-src` directive that includes the value `'unsafe-eval'`. :warning: NOTE, however, that `unsafe-eval` is NOT recommended in a secure CSP[[1]](https://developer.chrome.com/extensions/contentSecurityPolicy#relaxing-eval), as it has the potential to open the document to cross-site scripting (XSS) attacks. In order to make use of Ajv without easing your CSP, you can [pre-compile a schema using the CLI](https://github.com/ajv-validator/ajv-cli#compile-schemas). This will transpile the schema JSON into a JavaScript file that exports a `validate` function that works simlarly to a schema compiled at runtime. Note that pre-compilation of schemas is performed using [ajv-pack](https://github.com/ajv-validator/ajv-pack) and there are [some limitations to the schema features it can compile](https://github.com/ajv-validator/ajv-pack#limitations). A successfully pre-compiled schema is equivalent to the same schema compiled at runtime. ## Command line interface CLI is available as a separate npm package [ajv-cli](https://github.com/ajv-validator/ajv-cli). It supports: - compiling JSON Schemas to test their validity - BETA: generating standalone module exporting a validation function to be used without Ajv (using [ajv-pack](https://github.com/ajv-validator/ajv-pack)) - migrate schemas to draft-07 (using [json-schema-migrate](https://github.com/epoberezkin/json-schema-migrate)) - validating data file(s) against JSON Schema - testing expected validity of data against JSON Schema - referenced schemas - custom meta-schemas - files in JSON, JSON5, YAML, and JavaScript format - all Ajv options - reporting changes in data after validation in [JSON-patch](https://tools.ietf.org/html/rfc6902) format ## Validation keywords Ajv supports all validation keywords from draft-07 of JSON Schema standard: - [type](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#type) - [for numbers](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#keywords-for-numbers) - maximum, minimum, exclusiveMaximum, exclusiveMinimum, multipleOf - [for strings](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#keywords-for-strings) - maxLength, minLength, pattern, format - [for arrays](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#keywords-for-arrays) - maxItems, minItems, uniqueItems, items, additionalItems, [contains](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#contains) - [for objects](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#keywords-for-objects) - maxProperties, minProperties, required, properties, patternProperties, additionalProperties, dependencies, [propertyNames](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#propertynames) - [for all types](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#keywords-for-all-types) - enum, [const](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#const) - [compound keywords](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#compound-keywords) - not, oneOf, anyOf, allOf, [if/then/else](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#ifthenelse) With [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) package Ajv also supports validation keywords from [JSON Schema extension proposals](https://github.com/json-schema/json-schema/wiki/v5-Proposals) for JSON Schema standard: - [patternRequired](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#patternrequired-proposed) - like `required` but with patterns that some property should match. - [formatMaximum, formatMinimum, formatExclusiveMaximum, formatExclusiveMinimum](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md#formatmaximum--formatminimum-and-exclusiveformatmaximum--exclusiveformatminimum-proposed) - setting limits for date, time, etc. See [JSON Schema validation keywords](https://github.com/ajv-validator/ajv/blob/master/KEYWORDS.md) for more details. ## Annotation keywords JSON Schema specification defines several annotation keywords that describe schema itself but do not perform any validation. - `title` and `description`: information about the data represented by that schema - `$comment` (NEW in draft-07): information for developers. With option `$comment` Ajv logs or passes the comment string to the user-supplied function. See [Options](#options). - `default`: a default value of the data instance, see [Assigning defaults](#assigning-defaults). - `examples` (NEW in draft-06): an array of data instances. Ajv does not check the validity of these instances against the schema. - `readOnly` and `writeOnly` (NEW in draft-07): marks data-instance as read-only or write-only in relation to the source of the data (database, api, etc.). - `contentEncoding`: [RFC 2045](https://tools.ietf.org/html/rfc2045#section-6.1 ), e.g., "base64". - `contentMediaType`: [RFC 2046](https://tools.ietf.org/html/rfc2046), e.g., "image/png". __Please note__: Ajv does not implement validation of the keywords `examples`, `contentEncoding` and `contentMediaType` but it reserves them. If you want to create a plugin that implements some of them, it should remove these keywords from the instance. ## Formats Ajv implements formats defined by JSON Schema specification and several other formats. It is recommended NOT to use "format" keyword implementations with untrusted data, as they use potentially unsafe regular expressions - see [ReDoS attack](#redos-attack). __Please note__: if you need to use "format" keyword to validate untrusted data, you MUST assess their suitability and safety for your validation scenarios. The following formats are implemented for string validation with "format" keyword: - _date_: full-date according to [RFC3339](http://tools.ietf.org/html/rfc3339#section-5.6). - _time_: time with optional time-zone. - _date-time_: date-time from the same source (time-zone is mandatory). `date`, `time` and `date-time` validate ranges in `full` mode and only regexp in `fast` mode (see [options](#options)). - _uri_: full URI. - _uri-reference_: URI reference, including full and relative URIs. - _uri-template_: URI template according to [RFC6570](https://tools.ietf.org/html/rfc6570) - _url_ (deprecated): [URL record](https://url.spec.whatwg.org/#concept-url). - _email_: email address. - _hostname_: host name according to [RFC1034](http://tools.ietf.org/html/rfc1034#section-3.5). - _ipv4_: IP address v4. - _ipv6_: IP address v6. - _regex_: tests whether a string is a valid regular expression by passing it to RegExp constructor. - _uuid_: Universally Unique IDentifier according to [RFC4122](http://tools.ietf.org/html/rfc4122). - _json-pointer_: JSON-pointer according to [RFC6901](https://tools.ietf.org/html/rfc6901). - _relative-json-pointer_: relative JSON-pointer according to [this draft](http://tools.ietf.org/html/draft-luff-relative-json-pointer-00). __Please note__: JSON Schema draft-07 also defines formats `iri`, `iri-reference`, `idn-hostname` and `idn-email` for URLs, hostnames and emails with international characters. Ajv does not implement these formats. If you create Ajv plugin that implements them please make a PR to mention this plugin here. There are two modes of format validation: `fast` and `full`. This mode affects formats `date`, `time`, `date-time`, `uri`, `uri-reference`, and `email`. See [Options](#options) for details. You can add additional formats and replace any of the formats above using [addFormat](#api-addformat) method. The option `unknownFormats` allows changing the default behaviour when an unknown format is encountered. In this case Ajv can either fail schema compilation (default) or ignore it (default in versions before 5.0.0). You also can allow specific format(s) that will be ignored. See [Options](#options) for details. You can find regular expressions used for format validation and the sources that were used in [formats.js](https://github.com/ajv-validator/ajv/blob/master/lib/compile/formats.js). ## <a name="ref"></a>Combining schemas with $ref You can structure your validation logic across multiple schema files and have schemas reference each other using `$ref` keyword. Example: ```javascript var schema = { "$id": "http://example.com/schemas/schema.json", "type": "object", "properties": { "foo": { "$ref": "defs.json#/definitions/int" }, "bar": { "$ref": "defs.json#/definitions/str" } } }; var defsSchema = { "$id": "http://example.com/schemas/defs.json", "definitions": { "int": { "type": "integer" }, "str": { "type": "string" } } }; ``` Now to compile your schema you can either pass all schemas to Ajv instance: ```javascript var ajv = new Ajv({schemas: [schema, defsSchema]}); var validate = ajv.getSchema('http://example.com/schemas/schema.json'); ``` or use `addSchema` method: ```javascript var ajv = new Ajv; var validate = ajv.addSchema(defsSchema) .compile(schema); ``` See [Options](#options) and [addSchema](#api) method. __Please note__: - `$ref` is resolved as the uri-reference using schema $id as the base URI (see the example). - References can be recursive (and mutually recursive) to implement the schemas for different data structures (such as linked lists, trees, graphs, etc.). - You don't have to host your schema files at the URIs that you use as schema $id. These URIs are only used to identify the schemas, and according to JSON Schema specification validators should not expect to be able to download the schemas from these URIs. - The actual location of the schema file in the file system is not used. - You can pass the identifier of the schema as the second parameter of `addSchema` method or as a property name in `schemas` option. This identifier can be used instead of (or in addition to) schema $id. - You cannot have the same $id (or the schema identifier) used for more than one schema - the exception will be thrown. - You can implement dynamic resolution of the referenced schemas using `compileAsync` method. In this way you can store schemas in any system (files, web, database, etc.) and reference them without explicitly adding to Ajv instance. See [Asynchronous schema compilation](#asynchronous-schema-compilation). ## $data reference With `$data` option you can use values from the validated data as the values for the schema keywords. See [proposal](https://github.com/json-schema-org/json-schema-spec/issues/51) for more information about how it works. `$data` reference is supported in the keywords: const, enum, format, maximum/minimum, exclusiveMaximum / exclusiveMinimum, maxLength / minLength, maxItems / minItems, maxProperties / minProperties, formatMaximum / formatMinimum, formatExclusiveMaximum / formatExclusiveMinimum, multipleOf, pattern, required, uniqueItems. The value of "$data" should be a [JSON-pointer](https://tools.ietf.org/html/rfc6901) to the data (the root is always the top level data object, even if the $data reference is inside a referenced subschema) or a [relative JSON-pointer](http://tools.ietf.org/html/draft-luff-relative-json-pointer-00) (it is relative to the current point in data; if the $data reference is inside a referenced subschema it cannot point to the data outside of the root level for this subschema). Examples. This schema requires that the value in property `smaller` is less or equal than the value in the property larger: ```javascript var ajv = new Ajv({$data: true}); var schema = { "properties": { "smaller": { "type": "number", "maximum": { "$data": "1/larger" } }, "larger": { "type": "number" } } }; var validData = { smaller: 5, larger: 7 }; ajv.validate(schema, validData); // true ``` This schema requires that the properties have the same format as their field names: ```javascript var schema = { "additionalProperties": { "type": "string", "format": { "$data": "0#" } } }; var validData = { 'date-time': '1963-06-19T08:30:06.283185Z', email: 'joe.bloggs@example.com' } ``` `$data` reference is resolved safely - it won't throw even if some property is undefined. If `$data` resolves to `undefined` the validation succeeds (with the exclusion of `const` keyword). If `$data` resolves to incorrect type (e.g. not "number" for maximum keyword) the validation fails. ## $merge and $patch keywords With the package [ajv-merge-patch](https://github.com/ajv-validator/ajv-merge-patch) you can use the keywords `$merge` and `$patch` that allow extending JSON Schemas with patches using formats [JSON Merge Patch (RFC 7396)](https://tools.ietf.org/html/rfc7396) and [JSON Patch (RFC 6902)](https://tools.ietf.org/html/rfc6902). To add keywords `$merge` and `$patch` to Ajv instance use this code: ```javascript require('ajv-merge-patch')(ajv); ``` Examples. Using `$merge`: ```json { "$merge": { "source": { "type": "object", "properties": { "p": { "type": "string" } }, "additionalProperties": false }, "with": { "properties": { "q": { "type": "number" } } } } } ``` Using `$patch`: ```json { "$patch": { "source": { "type": "object", "properties": { "p": { "type": "string" } }, "additionalProperties": false }, "with": [ { "op": "add", "path": "/properties/q", "value": { "type": "number" } } ] } } ``` The schemas above are equivalent to this schema: ```json { "type": "object", "properties": { "p": { "type": "string" }, "q": { "type": "number" } }, "additionalProperties": false } ``` The properties `source` and `with` in the keywords `$merge` and `$patch` can use absolute or relative `$ref` to point to other schemas previously added to the Ajv instance or to the fragments of the current schema. See the package [ajv-merge-patch](https://github.com/ajv-validator/ajv-merge-patch) for more information. ## Defining custom keywords The advantages of using custom keywords are: - allow creating validation scenarios that cannot be expressed using JSON Schema - simplify your schemas - help bringing a bigger part of the validation logic to your schemas - make your schemas more expressive, less verbose and closer to your application domain - implement custom data processors that modify your data (`modifying` option MUST be used in keyword definition) and/or create side effects while the data is being validated If a keyword is used only for side-effects and its validation result is pre-defined, use option `valid: true/false` in keyword definition to simplify both generated code (no error handling in case of `valid: true`) and your keyword functions (no need to return any validation result). The concerns you have to be aware of when extending JSON Schema standard with custom keywords are the portability and understanding of your schemas. You will have to support these custom keywords on other platforms and to properly document these keywords so that everybody can understand them in your schemas. You can define custom keywords with [addKeyword](#api-addkeyword) method. Keywords are defined on the `ajv` instance level - new instances will not have previously defined keywords. Ajv allows defining keywords with: - validation function - compilation function - macro function - inline compilation function that should return code (as string) that will be inlined in the currently compiled schema. Example. `range` and `exclusiveRange` keywords using compiled schema: ```javascript ajv.addKeyword('range', { type: 'number', compile: function (sch, parentSchema) { var min = sch[0]; var max = sch[1]; return parentSchema.exclusiveRange === true ? function (data) { return data > min && data < max; } : function (data) { return data >= min && data <= max; } } }); var schema = { "range": [2, 4], "exclusiveRange": true }; var validate = ajv.compile(schema); console.log(validate(2.01)); // true console.log(validate(3.99)); // true console.log(validate(2)); // false console.log(validate(4)); // false ``` Several custom keywords (typeof, instanceof, range and propertyNames) are defined in [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) package - they can be used for your schemas and as a starting point for your own custom keywords. See [Defining custom keywords](https://github.com/ajv-validator/ajv/blob/master/CUSTOM.md) for more details. ## Asynchronous schema compilation During asynchronous compilation remote references are loaded using supplied function. See `compileAsync` [method](#api-compileAsync) and `loadSchema` [option](#options). Example: ```javascript var ajv = new Ajv({ loadSchema: loadSchema }); ajv.compileAsync(schema).then(function (validate) { var valid = validate(data); // ... }); function loadSchema(uri) { return request.json(uri).then(function (res) { if (res.statusCode >= 400) throw new Error('Loading error: ' + res.statusCode); return res.body; }); } ``` __Please note__: [Option](#options) `missingRefs` should NOT be set to `"ignore"` or `"fail"` for asynchronous compilation to work. ## Asynchronous validation Example in Node.js REPL: https://tonicdev.com/esp/ajv-asynchronous-validation You can define custom formats and keywords that perform validation asynchronously by accessing database or some other service. You should add `async: true` in the keyword or format definition (see [addFormat](#api-addformat), [addKeyword](#api-addkeyword) and [Defining custom keywords](#defining-custom-keywords)). If your schema uses asynchronous formats/keywords or refers to some schema that contains them it should have `"$async": true` keyword so that Ajv can compile it correctly. If asynchronous format/keyword or reference to asynchronous schema is used in the schema without `$async` keyword Ajv will throw an exception during schema compilation. __Please note__: all asynchronous subschemas that are referenced from the current or other schemas should have `"$async": true` keyword as well, otherwise the schema compilation will fail. Validation function for an asynchronous custom format/keyword should return a promise that resolves with `true` or `false` (or rejects with `new Ajv.ValidationError(errors)` if you want to return custom errors from the keyword function). Ajv compiles asynchronous schemas to [es7 async functions](http://tc39.github.io/ecmascript-asyncawait/) that can optionally be transpiled with [nodent](https://github.com/MatAtBread/nodent). Async functions are supported in Node.js 7+ and all modern browsers. You can also supply any other transpiler as a function via `processCode` option. See [Options](#options). The compiled validation function has `$async: true` property (if the schema is asynchronous), so you can differentiate these functions if you are using both synchronous and asynchronous schemas. Validation result will be a promise that resolves with validated data or rejects with an exception `Ajv.ValidationError` that contains the array of validation errors in `errors` property. Example: ```javascript var ajv = new Ajv; // require('ajv-async')(ajv); ajv.addKeyword('idExists', { async: true, type: 'number', validate: checkIdExists }); function checkIdExists(schema, data) { return knex(schema.table) .select('id') .where('id', data) .then(function (rows) { return !!rows.length; // true if record is found }); } var schema = { "$async": true, "properties": { "userId": { "type": "integer", "idExists": { "table": "users" } }, "postId": { "type": "integer", "idExists": { "table": "posts" } } } }; var validate = ajv.compile(schema); validate({ userId: 1, postId: 19 }) .then(function (data) { console.log('Data is valid', data); // { userId: 1, postId: 19 } }) .catch(function (err) { if (!(err instanceof Ajv.ValidationError)) throw err; // data is invalid console.log('Validation errors:', err.errors); }); ``` ### Using transpilers with asynchronous validation functions. [ajv-async](https://github.com/ajv-validator/ajv-async) uses [nodent](https://github.com/MatAtBread/nodent) to transpile async functions. To use another transpiler you should separately install it (or load its bundle in the browser). #### Using nodent ```javascript var ajv = new Ajv; require('ajv-async')(ajv); // in the browser if you want to load ajv-async bundle separately you can: // window.ajvAsync(ajv); var validate = ajv.compile(schema); // transpiled es7 async function validate(data).then(successFunc).catch(errorFunc); ``` #### Using other transpilers ```javascript var ajv = new Ajv({ processCode: transpileFunc }); var validate = ajv.compile(schema); // transpiled es7 async function validate(data).then(successFunc).catch(errorFunc); ``` See [Options](#options). ## Security considerations JSON Schema, if properly used, can replace data sanitisation. It doesn't replace other API security considerations. It also introduces additional security aspects to consider. ##### Security contact To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerabilities via GitHub issues. ##### Untrusted schemas Ajv treats JSON schemas as trusted as your application code. This security model is based on the most common use case, when the schemas are static and bundled together with the application. If your schemas are received from untrusted sources (or generated from untrusted data) there are several scenarios you need to prevent: - compiling schemas can cause stack overflow (if they are too deep) - compiling schemas can be slow (e.g. [#557](https://github.com/ajv-validator/ajv/issues/557)) - validating certain data can be slow It is difficult to predict all the scenarios, but at the very least it may help to limit the size of untrusted schemas (e.g. limit JSON string length) and also the maximum schema object depth (that can be high for relatively small JSON strings). You also may want to mitigate slow regular expressions in `pattern` and `patternProperties` keywords. Regardless the measures you take, using untrusted schemas increases security risks. ##### Circular references in JavaScript objects Ajv does not support schemas and validated data that have circular references in objects. See [issue #802](https://github.com/ajv-validator/ajv/issues/802). An attempt to compile such schemas or validate such data would cause stack overflow (or will not complete in case of asynchronous validation). Depending on the parser you use, untrusted data can lead to circular references. ##### Security risks of trusted schemas Some keywords in JSON Schemas can lead to very slow validation for certain data. These keywords include (but may be not limited to): - `pattern` and `format` for large strings - in some cases using `maxLength` can help mitigate it, but certain regular expressions can lead to exponential validation time even with relatively short strings (see [ReDoS attack](#redos-attack)). - `patternProperties` for large property names - use `propertyNames` to mitigate, but some regular expressions can have exponential evaluation time as well. - `uniqueItems` for large non-scalar arrays - use `maxItems` to mitigate __Please note__: The suggestions above to prevent slow validation would only work if you do NOT use `allErrors: true` in production code (using it would continue validation after validation errors). You can validate your JSON schemas against [this meta-schema](https://github.com/ajv-validator/ajv/blob/master/lib/refs/json-schema-secure.json) to check that these recommendations are followed: ```javascript const isSchemaSecure = ajv.compile(require('ajv/lib/refs/json-schema-secure.json')); const schema1 = {format: 'email'}; isSchemaSecure(schema1); // false const schema2 = {format: 'email', maxLength: MAX_LENGTH}; isSchemaSecure(schema2); // true ``` __Please note__: following all these recommendation is not a guarantee that validation of untrusted data is safe - it can still lead to some undesirable results. ##### Content Security Policies (CSP) See [Ajv and Content Security Policies (CSP)](#ajv-and-content-security-policies-csp) ## ReDoS attack Certain regular expressions can lead to the exponential evaluation time even with relatively short strings. Please assess the regular expressions you use in the schemas on their vulnerability to this attack - see [safe-regex](https://github.com/substack/safe-regex), for example. __Please note__: some formats that Ajv implements use [regular expressions](https://github.com/ajv-validator/ajv/blob/master/lib/compile/formats.js) that can be vulnerable to ReDoS attack, so if you use Ajv to validate data from untrusted sources __it is strongly recommended__ to consider the following: - making assessment of "format" implementations in Ajv. - using `format: 'fast'` option that simplifies some of the regular expressions (although it does not guarantee that they are safe). - replacing format implementations provided by Ajv with your own implementations of "format" keyword that either uses different regular expressions or another approach to format validation. Please see [addFormat](#api-addformat) method. - disabling format validation by ignoring "format" keyword with option `format: false` Whatever mitigation you choose, please assume all formats provided by Ajv as potentially unsafe and make your own assessment of their suitability for your validation scenarios. ## Filtering data With [option `removeAdditional`](#options) (added by [andyscott](https://github.com/andyscott)) you can filter data during the validation. This option modifies original data. Example: ```javascript var ajv = new Ajv({ removeAdditional: true }); var schema = { "additionalProperties": false, "properties": { "foo": { "type": "number" }, "bar": { "additionalProperties": { "type": "number" }, "properties": { "baz": { "type": "string" } } } } } var data = { "foo": 0, "additional1": 1, // will be removed; `additionalProperties` == false "bar": { "baz": "abc", "additional2": 2 // will NOT be removed; `additionalProperties` != false }, } var validate = ajv.compile(schema); console.log(validate(data)); // true console.log(data); // { "foo": 0, "bar": { "baz": "abc", "additional2": 2 } ``` If `removeAdditional` option in the example above were `"all"` then both `additional1` and `additional2` properties would have been removed. If the option were `"failing"` then property `additional1` would have been removed regardless of its value and property `additional2` would have been removed only if its value were failing the schema in the inner `additionalProperties` (so in the example above it would have stayed because it passes the schema, but any non-number would have been removed). __Please note__: If you use `removeAdditional` option with `additionalProperties` keyword inside `anyOf`/`oneOf` keywords your validation can fail with this schema, for example: ```json { "type": "object", "oneOf": [ { "properties": { "foo": { "type": "string" } }, "required": [ "foo" ], "additionalProperties": false }, { "properties": { "bar": { "type": "integer" } }, "required": [ "bar" ], "additionalProperties": false } ] } ``` The intention of the schema above is to allow objects with either the string property "foo" or the integer property "bar", but not with both and not with any other properties. With the option `removeAdditional: true` the validation will pass for the object `{ "foo": "abc"}` but will fail for the object `{"bar": 1}`. It happens because while the first subschema in `oneOf` is validated, the property `bar` is removed because it is an additional property according to the standard (because it is not included in `properties` keyword in the same schema). While this behaviour is unexpected (issues [#129](https://github.com/ajv-validator/ajv/issues/129), [#134](https://github.com/ajv-validator/ajv/issues/134)), it is correct. To have the expected behaviour (both objects are allowed and additional properties are removed) the schema has to be refactored in this way: ```json { "type": "object", "properties": { "foo": { "type": "string" }, "bar": { "type": "integer" } }, "additionalProperties": false, "oneOf": [ { "required": [ "foo" ] }, { "required": [ "bar" ] } ] } ``` The schema above is also more efficient - it will compile into a faster function. ## Assigning defaults With [option `useDefaults`](#options) Ajv will assign values from `default` keyword in the schemas of `properties` and `items` (when it is the array of schemas) to the missing properties and items. With the option value `"empty"` properties and items equal to `null` or `""` (empty string) will be considered missing and assigned defaults. This option modifies original data. __Please note__: the default value is inserted in the generated validation code as a literal, so the value inserted in the data will be the deep clone of the default in the schema. Example 1 (`default` in `properties`): ```javascript var ajv = new Ajv({ useDefaults: true }); var schema = { "type": "object", "properties": { "foo": { "type": "number" }, "bar": { "type": "string", "default": "baz" } }, "required": [ "foo", "bar" ] }; var data = { "foo": 1 }; var validate = ajv.compile(schema); console.log(validate(data)); // true console.log(data); // { "foo": 1, "bar": "baz" } ``` Example 2 (`default` in `items`): ```javascript var schema = { "type": "array", "items": [ { "type": "number" }, { "type": "string", "default": "foo" } ] } var data = [ 1 ]; var validate = ajv.compile(schema); console.log(validate(data)); // true console.log(data); // [ 1, "foo" ] ``` `default` keywords in other cases are ignored: - not in `properties` or `items` subschemas - in schemas inside `anyOf`, `oneOf` and `not` (see [#42](https://github.com/ajv-validator/ajv/issues/42)) - in `if` subschema of `switch` keyword - in schemas generated by custom macro keywords The [`strictDefaults` option](#options) customizes Ajv's behavior for the defaults that Ajv ignores (`true` raises an error, and `"log"` outputs a warning). ## Coercing data types When you are validating user inputs all your data properties are usually strings. The option `coerceTypes` allows you to have your data types coerced to the types specified in your schema `type` keywords, both to pass the validation and to use the correctly typed data afterwards. This option modifies original data. __Please note__: if you pass a scalar value to the validating function its type will be coerced and it will pass the validation, but the value of the variable you pass won't be updated because scalars are passed by value. Example 1: ```javascript var ajv = new Ajv({ coerceTypes: true }); var schema = { "type": "object", "properties": { "foo": { "type": "number" }, "bar": { "type": "boolean" } }, "required": [ "foo", "bar" ] }; var data = { "foo": "1", "bar": "false" }; var validate = ajv.compile(schema); console.log(validate(data)); // true console.log(data); // { "foo": 1, "bar": false } ``` Example 2 (array coercions): ```javascript var ajv = new Ajv({ coerceTypes: 'array' }); var schema = { "properties": { "foo": { "type": "array", "items": { "type": "number" } }, "bar": { "type": "boolean" } } }; var data = { "foo": "1", "bar": ["false"] }; var validate = ajv.compile(schema); console.log(validate(data)); // true console.log(data); // { "foo": [1], "bar": false } ``` The coercion rules, as you can see from the example, are different from JavaScript both to validate user input as expected and to have the coercion reversible (to correctly validate cases where different types are defined in subschemas of "anyOf" and other compound keywords). See [Coercion rules](https://github.com/ajv-validator/ajv/blob/master/COERCION.md) for details. ## API ##### new Ajv(Object options) -&gt; Object Create Ajv instance. ##### .compile(Object schema) -&gt; Function&lt;Object data&gt; Generate validating function and cache the compiled schema for future use. Validating function returns a boolean value. This function has properties `errors` and `schema`. Errors encountered during the last validation are assigned to `errors` property (it is assigned `null` if there was no errors). `schema` property contains the reference to the original schema. The schema passed to this method will be validated against meta-schema unless `validateSchema` option is false. If schema is invalid, an error will be thrown. See [options](#options). ##### <a name="api-compileAsync"></a>.compileAsync(Object schema [, Boolean meta] [, Function callback]) -&gt; Promise Asynchronous version of `compile` method that loads missing remote schemas using asynchronous function in `options.loadSchema`. This function returns a Promise that resolves to a validation function. An optional callback passed to `compileAsync` will be called with 2 parameters: error (or null) and validating function. The returned promise will reject (and the callback will be called with an error) when: - missing schema can't be loaded (`loadSchema` returns a Promise that rejects). - a schema containing a missing reference is loaded, but the reference cannot be resolved. - schema (or some loaded/referenced schema) is invalid. The function compiles schema and loads the first missing schema (or meta-schema) until all missing schemas are loaded. You can asynchronously compile meta-schema by passing `true` as the second parameter. See example in [Asynchronous compilation](#asynchronous-schema-compilation). ##### .validate(Object schema|String key|String ref, data) -&gt; Boolean Validate data using passed schema (it will be compiled and cached). Instead of the schema you can use the key that was previously passed to `addSchema`, the schema id if it was present in the schema or any previously resolved reference. Validation errors will be available in the `errors` property of Ajv instance (`null` if there were no errors). __Please note__: every time this method is called the errors are overwritten so you need to copy them to another variable if you want to use them later. If the schema is asynchronous (has `$async` keyword on the top level) this method returns a Promise. See [Asynchronous validation](#asynchronous-validation). ##### .addSchema(Array&lt;Object&gt;|Object schema [, String key]) -&gt; Ajv Add schema(s) to validator instance. This method does not compile schemas (but it still validates them). Because of that dependencies can be added in any order and circular dependencies are supported. It also prevents unnecessary compilation of schemas that are containers for other schemas but not used as a whole. Array of schemas can be passed (schemas should have ids), the second parameter will be ignored. Key can be passed that can be used to reference the schema and will be used as the schema id if there is no id inside the schema. If the key is not passed, the schema id will be used as the key. Once the schema is added, it (and all the references inside it) can be referenced in other schemas and used to validate data. Although `addSchema` does not compile schemas, explicit compilation is not required - the schema will be compiled when it is used first time. By default the schema is validated against meta-schema before it is added, and if the schema does not pass validation the exception is thrown. This behaviour is controlled by `validateSchema` option. __Please note__: Ajv uses the [method chaining syntax](https://en.wikipedia.org/wiki/Method_chaining) for all methods with the prefix `add*` and `remove*`. This allows you to do nice things like the following. ```javascript var validate = new Ajv().addSchema(schema).addFormat(name, regex).getSchema(uri); ``` ##### .addMetaSchema(Array&lt;Object&gt;|Object schema [, String key]) -&gt; Ajv Adds meta schema(s) that can be used to validate other schemas. That function should be used instead of `addSchema` because there may be instance options that would compile a meta schema incorrectly (at the moment it is `removeAdditional` option). There is no need to explicitly add draft-07 meta schema (http://json-schema.org/draft-07/schema) - it is added by default, unless option `meta` is set to `false`. You only need to use it if you have a changed meta-schema that you want to use to validate your schemas. See `validateSchema`. ##### <a name="api-validateschema"></a>.validateSchema(Object schema) -&gt; Boolean Validates schema. This method should be used to validate schemas rather than `validate` due to the inconsistency of `uri` format in JSON Schema standard. By default this method is called automatically when the schema is added, so you rarely need to use it directly. If schema doesn't have `$schema` property, it is validated against draft 6 meta-schema (option `meta` should not be false). If schema has `$schema` property, then the schema with this id (that should be previously added) is used to validate passed schema. Errors will be available at `ajv.errors`. ##### .getSchema(String key) -&gt; Function&lt;Object data&gt; Retrieve compiled schema previously added with `addSchema` by the key passed to `addSchema` or by its full reference (id). The returned validating function has `schema` property with the reference to the original schema. ##### .removeSchema([Object schema|String key|String ref|RegExp pattern]) -&gt; Ajv Remove added/cached schema. Even if schema is referenced by other schemas it can be safely removed as dependent schemas have local references. Schema can be removed using: - key passed to `addSchema` - it's full reference (id) - RegExp that should match schema id or key (meta-schemas won't be removed) - actual schema object that will be stable-stringified to remove schema from cache If no parameter is passed all schemas but meta-schemas will be removed and the cache will be cleared. ##### <a name="api-addformat"></a>.addFormat(String name, String|RegExp|Function|Object format) -&gt; Ajv Add custom format to validate strings or numbers. It can also be used to replace pre-defined formats for Ajv instance. Strings are converted to RegExp. Function should return validation result as `true` or `false`. If object is passed it should have properties `validate`, `compare` and `async`: - _validate_: a string, RegExp or a function as described above. - _compare_: an optional comparison function that accepts two strings and compares them according to the format meaning. This function is used with keywords `formatMaximum`/`formatMinimum` (defined in [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) package). It should return `1` if the first value is bigger than the second value, `-1` if it is smaller and `0` if it is equal. - _async_: an optional `true` value if `validate` is an asynchronous function; in this case it should return a promise that resolves with a value `true` or `false`. - _type_: an optional type of data that the format applies to. It can be `"string"` (default) or `"number"` (see https://github.com/ajv-validator/ajv/issues/291#issuecomment-259923858). If the type of data is different, the validation will pass. Custom formats can be also added via `formats` option. ##### <a name="api-addkeyword"></a>.addKeyword(String keyword, Object definition) -&gt; Ajv Add custom validation keyword to Ajv instance. Keyword should be different from all standard JSON Schema keywords and different from previously defined keywords. There is no way to redefine keywords or to remove keyword definition from the instance. Keyword must start with a letter, `_` or `$`, and may continue with letters, numbers, `_`, `$`, or `-`. It is recommended to use an application-specific prefix for keywords to avoid current and future name collisions. Example Keywords: - `"xyz-example"`: valid, and uses prefix for the xyz project to avoid name collisions. - `"example"`: valid, but not recommended as it could collide with future versions of JSON Schema etc. - `"3-example"`: invalid as numbers are not allowed to be the first character in a keyword Keyword definition is an object with the following properties: - _type_: optional string or array of strings with data type(s) that the keyword applies to. If not present, the keyword will apply to all types. - _validate_: validating function - _compile_: compiling function - _macro_: macro function - _inline_: compiling function that returns code (as string) - _schema_: an optional `false` value used with "validate" keyword to not pass schema - _metaSchema_: an optional meta-schema for keyword schema - _dependencies_: an optional list of properties that must be present in the parent schema - it will be checked during schema compilation - _modifying_: `true` MUST be passed if keyword modifies data - _statements_: `true` can be passed in case inline keyword generates statements (as opposed to expression) - _valid_: pass `true`/`false` to pre-define validation result, the result returned from validation function will be ignored. This option cannot be used with macro keywords. - _$data_: an optional `true` value to support [$data reference](#data-reference) as the value of custom keyword. The reference will be resolved at validation time. If the keyword has meta-schema it would be extended to allow $data and it will be used to validate the resolved value. Supporting $data reference requires that keyword has validating function (as the only option or in addition to compile, macro or inline function). - _async_: an optional `true` value if the validation function is asynchronous (whether it is compiled or passed in _validate_ property); in this case it should return a promise that resolves with a value `true` or `false`. This option is ignored in case of "macro" and "inline" keywords. - _errors_: an optional boolean or string `"full"` indicating whether keyword returns errors. If this property is not set Ajv will determine if the errors were set in case of failed validation. _compile_, _macro_ and _inline_ are mutually exclusive, only one should be used at a time. _validate_ can be used separately or in addition to them to support $data reference. __Please note__: If the keyword is validating data type that is different from the type(s) in its definition, the validation function will not be called (and expanded macro will not be used), so there is no need to check for data type inside validation function or inside schema returned by macro function (unless you want to enforce a specific type and for some reason do not want to use a separate `type` keyword for that). In the same way as standard keywords work, if the keyword does not apply to the data type being validated, the validation of this keyword will succeed. See [Defining custom keywords](#defining-custom-keywords) for more details. ##### .getKeyword(String keyword) -&gt; Object|Boolean Returns custom keyword definition, `true` for pre-defined keywords and `false` if the keyword is unknown. ##### .removeKeyword(String keyword) -&gt; Ajv Removes custom or pre-defined keyword so you can redefine them. While this method can be used to extend pre-defined keywords, it can also be used to completely change their meaning - it may lead to unexpected results. __Please note__: schemas compiled before the keyword is removed will continue to work without changes. To recompile schemas use `removeSchema` method and compile them again. ##### .errorsText([Array&lt;Object&gt; errors [, Object options]]) -&gt; String Returns the text with all errors in a String. Options can have properties `separator` (string used to separate errors, ", " by default) and `dataVar` (the variable name that dataPaths are prefixed with, "data" by default). ## Options Defaults: ```javascript { // validation and reporting options: $data: false, allErrors: false, verbose: false, $comment: false, // NEW in Ajv version 6.0 jsonPointers: false, uniqueItems: true, unicode: true, nullable: false, format: 'fast', formats: {}, unknownFormats: true, schemas: {}, logger: undefined, // referenced schema options: schemaId: '$id', missingRefs: true, extendRefs: 'ignore', // recommended 'fail' loadSchema: undefined, // function(uri: string): Promise {} // options to modify validated data: removeAdditional: false, useDefaults: false, coerceTypes: false, // strict mode options strictDefaults: false, strictKeywords: false, strictNumbers: false, // asynchronous validation options: transpile: undefined, // requires ajv-async package // advanced options: meta: true, validateSchema: true, addUsedSchema: true, inlineRefs: true, passContext: false, loopRequired: Infinity, ownProperties: false, multipleOfPrecision: false, errorDataPath: 'object', // deprecated messages: true, sourceCode: false, processCode: undefined, // function (str: string, schema: object): string {} cache: new Cache, serialize: undefined } ``` ##### Validation and reporting options - _$data_: support [$data references](#data-reference). Draft 6 meta-schema that is added by default will be extended to allow them. If you want to use another meta-schema you need to use $dataMetaSchema method to add support for $data reference. See [API](#api). - _allErrors_: check all rules collecting all errors. Default is to return after the first error. - _verbose_: include the reference to the part of the schema (`schema` and `parentSchema`) and validated data in errors (false by default). - _$comment_ (NEW in Ajv version 6.0): log or pass the value of `$comment` keyword to a function. Option values: - `false` (default): ignore $comment keyword. - `true`: log the keyword value to console. - function: pass the keyword value, its schema path and root schema to the specified function - _jsonPointers_: set `dataPath` property of errors using [JSON Pointers](https://tools.ietf.org/html/rfc6901) instead of JavaScript property access notation. - _uniqueItems_: validate `uniqueItems` keyword (true by default). - _unicode_: calculate correct length of strings with unicode pairs (true by default). Pass `false` to use `.length` of strings that is faster, but gives "incorrect" lengths of strings with unicode pairs - each unicode pair is counted as two characters. - _nullable_: support keyword "nullable" from [Open API 3 specification](https://swagger.io/docs/specification/data-models/data-types/). - _format_: formats validation mode. Option values: - `"fast"` (default) - simplified and fast validation (see [Formats](#formats) for details of which formats are available and affected by this option). - `"full"` - more restrictive and slow validation. E.g., 25:00:00 and 2015/14/33 will be invalid time and date in 'full' mode but it will be valid in 'fast' mode. - `false` - ignore all format keywords. - _formats_: an object with custom formats. Keys and values will be passed to `addFormat` method. - _keywords_: an object with custom keywords. Keys and values will be passed to `addKeyword` method. - _unknownFormats_: handling of unknown formats. Option values: - `true` (default) - if an unknown format is encountered the exception is thrown during schema compilation. If `format` keyword value is [$data reference](#data-reference) and it is unknown the validation will fail. - `[String]` - an array of unknown format names that will be ignored. This option can be used to allow usage of third party schemas with format(s) for which you don't have definitions, but still fail if another unknown format is used. If `format` keyword value is [$data reference](#data-reference) and it is not in this array the validation will fail. - `"ignore"` - to log warning during schema compilation and always pass validation (the default behaviour in versions before 5.0.0). This option is not recommended, as it allows to mistype format name and it won't be validated without any error message. This behaviour is required by JSON Schema specification. - _schemas_: an array or object of schemas that will be added to the instance. In case you pass the array the schemas must have IDs in them. When the object is passed the method `addSchema(value, key)` will be called for each schema in this object. - _logger_: sets the logging method. Default is the global `console` object that should have methods `log`, `warn` and `error`. See [Error logging](#error-logging). Option values: - custom logger - it should have methods `log`, `warn` and `error`. If any of these methods is missing an exception will be thrown. - `false` - logging is disabled. ##### Referenced schema options - _schemaId_: this option defines which keywords are used as schema URI. Option value: - `"$id"` (default) - only use `$id` keyword as schema URI (as specified in JSON Schema draft-06/07), ignore `id` keyword (if it is present a warning will be logged). - `"id"` - only use `id` keyword as schema URI (as specified in JSON Schema draft-04), ignore `$id` keyword (if it is present a warning will be logged). - `"auto"` - use both `$id` and `id` keywords as schema URI. If both are present (in the same schema object) and different the exception will be thrown during schema compilation. - _missingRefs_: handling of missing referenced schemas. Option values: - `true` (default) - if the reference cannot be resolved during compilation the exception is thrown. The thrown error has properties `missingRef` (with hash fragment) and `missingSchema` (without it). Both properties are resolved relative to the current base id (usually schema id, unless it was substituted). - `"ignore"` - to log error during compilation and always pass validation. - `"fail"` - to log error and successfully compile schema but fail validation if this rule is checked. - _extendRefs_: validation of other keywords when `$ref` is present in the schema. Option values: - `"ignore"` (default) - when `$ref` is used other keywords are ignored (as per [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3) standard). A warning will be logged during the schema compilation. - `"fail"` (recommended) - if other validation keywords are used together with `$ref` the exception will be thrown when the schema is compiled. This option is recommended to make sure schema has no keywords that are ignored, which can be confusing. - `true` - validate all keywords in the schemas with `$ref` (the default behaviour in versions before 5.0.0). - _loadSchema_: asynchronous function that will be used to load remote schemas when `compileAsync` [method](#api-compileAsync) is used and some reference is missing (option `missingRefs` should NOT be 'fail' or 'ignore'). This function should accept remote schema uri as a parameter and return a Promise that resolves to a schema. See example in [Asynchronous compilation](#asynchronous-schema-compilation). ##### Options to modify validated data - _removeAdditional_: remove additional properties - see example in [Filtering data](#filtering-data). This option is not used if schema is added with `addMetaSchema` method. Option values: - `false` (default) - not to remove additional properties - `"all"` - all additional properties are removed, regardless of `additionalProperties` keyword in schema (and no validation is made for them). - `true` - only additional properties with `additionalProperties` keyword equal to `false` are removed. - `"failing"` - additional properties that fail schema validation will be removed (where `additionalProperties` keyword is `false` or schema). - _useDefaults_: replace missing or undefined properties and items with the values from corresponding `default` keywords. Default behaviour is to ignore `default` keywords. This option is not used if schema is added with `addMetaSchema` method. See examples in [Assigning defaults](#assigning-defaults). Option values: - `false` (default) - do not use defaults - `true` - insert defaults by value (object literal is used). - `"empty"` - in addition to missing or undefined, use defaults for properties and items that are equal to `null` or `""` (an empty string). - `"shared"` (deprecated) - insert defaults by reference. If the default is an object, it will be shared by all instances of validated data. If you modify the inserted default in the validated data, it will be modified in the schema as well. - _coerceTypes_: change data type of data to match `type` keyword. See the example in [Coercing data types](#coercing-data-types) and [coercion rules](https://github.com/ajv-validator/ajv/blob/master/COERCION.md). Option values: - `false` (default) - no type coercion. - `true` - coerce scalar data types. - `"array"` - in addition to coercions between scalar types, coerce scalar data to an array with one element and vice versa (as required by the schema). ##### Strict mode options - _strictDefaults_: report ignored `default` keywords in schemas. Option values: - `false` (default) - ignored defaults are not reported - `true` - if an ignored default is present, throw an error - `"log"` - if an ignored default is present, log warning - _strictKeywords_: report unknown keywords in schemas. Option values: - `false` (default) - unknown keywords are not reported - `true` - if an unknown keyword is present, throw an error - `"log"` - if an unknown keyword is present, log warning - _strictNumbers_: validate numbers strictly, failing validation for NaN and Infinity. Option values: - `false` (default) - NaN or Infinity will pass validation for numeric types - `true` - NaN or Infinity will not pass validation for numeric types ##### Asynchronous validation options - _transpile_: Requires [ajv-async](https://github.com/ajv-validator/ajv-async) package. It determines whether Ajv transpiles compiled asynchronous validation function. Option values: - `undefined` (default) - transpile with [nodent](https://github.com/MatAtBread/nodent) if async functions are not supported. - `true` - always transpile with nodent. - `false` - do not transpile; if async functions are not supported an exception will be thrown. ##### Advanced options - _meta_: add [meta-schema](http://json-schema.org/documentation.html) so it can be used by other schemas (true by default). If an object is passed, it will be used as the default meta-schema for schemas that have no `$schema` keyword. This default meta-schema MUST have `$schema` keyword. - _validateSchema_: validate added/compiled schemas against meta-schema (true by default). `$schema` property in the schema can be http://json-schema.org/draft-07/schema or absent (draft-07 meta-schema will be used) or can be a reference to the schema previously added with `addMetaSchema` method. Option values: - `true` (default) - if the validation fails, throw the exception. - `"log"` - if the validation fails, log error. - `false` - skip schema validation. - _addUsedSchema_: by default methods `compile` and `validate` add schemas to the instance if they have `$id` (or `id`) property that doesn't start with "#". If `$id` is present and it is not unique the exception will be thrown. Set this option to `false` to skip adding schemas to the instance and the `$id` uniqueness check when these methods are used. This option does not affect `addSchema` method. - _inlineRefs_: Affects compilation of referenced schemas. Option values: - `true` (default) - the referenced schemas that don't have refs in them are inlined, regardless of their size - that substantially improves performance at the cost of the bigger size of compiled schema functions. - `false` - to not inline referenced schemas (they will be compiled as separate functions). - integer number - to limit the maximum number of keywords of the schema that will be inlined. - _passContext_: pass validation context to custom keyword functions. If this option is `true` and you pass some context to the compiled validation function with `validate.call(context, data)`, the `context` will be available as `this` in your custom keywords. By default `this` is Ajv instance. - _loopRequired_: by default `required` keyword is compiled into a single expression (or a sequence of statements in `allErrors` mode). In case of a very large number of properties in this keyword it may result in a very big validation function. Pass integer to set the number of properties above which `required` keyword will be validated in a loop - smaller validation function size but also worse performance. - _ownProperties_: by default Ajv iterates over all enumerable object properties; when this option is `true` only own enumerable object properties (i.e. found directly on the object rather than on its prototype) are iterated. Contributed by @mbroadst. - _multipleOfPrecision_: by default `multipleOf` keyword is validated by comparing the result of division with parseInt() of that result. It works for dividers that are bigger than 1. For small dividers such as 0.01 the result of the division is usually not integer (even when it should be integer, see issue [#84](https://github.com/ajv-validator/ajv/issues/84)). If you need to use fractional dividers set this option to some positive integer N to have `multipleOf` validated using this formula: `Math.abs(Math.round(division) - division) < 1e-N` (it is slower but allows for float arithmetics deviations). - _errorDataPath_ (deprecated): set `dataPath` to point to 'object' (default) or to 'property' when validating keywords `required`, `additionalProperties` and `dependencies`. - _messages_: Include human-readable messages in errors. `true` by default. `false` can be passed when custom messages are used (e.g. with [ajv-i18n](https://github.com/ajv-validator/ajv-i18n)). - _sourceCode_: add `sourceCode` property to validating function (for debugging; this code can be different from the result of toString call). - _processCode_: an optional function to process generated code before it is passed to Function constructor. It can be used to either beautify (the validating function is generated without line-breaks) or to transpile code. Starting from version 5.0.0 this option replaced options: - `beautify` that formatted the generated function using [js-beautify](https://github.com/beautify-web/js-beautify). If you want to beautify the generated code pass a function calling `require('js-beautify').js_beautify` as `processCode: code => js_beautify(code)`. - `transpile` that transpiled asynchronous validation function. You can still use `transpile` option with [ajv-async](https://github.com/ajv-validator/ajv-async) package. See [Asynchronous validation](#asynchronous-validation) for more information. - _cache_: an optional instance of cache to store compiled schemas using stable-stringified schema as a key. For example, set-associative cache [sacjs](https://github.com/epoberezkin/sacjs) can be used. If not passed then a simple hash is used which is good enough for the common use case (a limited number of statically defined schemas). Cache should have methods `put(key, value)`, `get(key)`, `del(key)` and `clear()`. - _serialize_: an optional function to serialize schema to cache key. Pass `false` to use schema itself as a key (e.g., if WeakMap used as a cache). By default [fast-json-stable-stringify](https://github.com/epoberezkin/fast-json-stable-stringify) is used. ## Validation errors In case of validation failure, Ajv assigns the array of errors to `errors` property of validation function (or to `errors` property of Ajv instance when `validate` or `validateSchema` methods were called). In case of [asynchronous validation](#asynchronous-validation), the returned promise is rejected with exception `Ajv.ValidationError` that has `errors` property. ### Error objects Each error is an object with the following properties: - _keyword_: validation keyword. - _dataPath_: the path to the part of the data that was validated. By default `dataPath` uses JavaScript property access notation (e.g., `".prop[1].subProp"`). When the option `jsonPointers` is true (see [Options](#options)) `dataPath` will be set using JSON pointer standard (e.g., `"/prop/1/subProp"`). - _schemaPath_: the path (JSON-pointer as a URI fragment) to the schema of the keyword that failed validation. - _params_: the object with the additional information about error that can be used to create custom error messages (e.g., using [ajv-i18n](https://github.com/ajv-validator/ajv-i18n) package). See below for parameters set by all keywords. - _message_: the standard error message (can be excluded with option `messages` set to false). - _schema_: the schema of the keyword (added with `verbose` option). - _parentSchema_: the schema containing the keyword (added with `verbose` option) - _data_: the data validated by the keyword (added with `verbose` option). __Please note__: `propertyNames` keyword schema validation errors have an additional property `propertyName`, `dataPath` points to the object. After schema validation for each property name, if it is invalid an additional error is added with the property `keyword` equal to `"propertyNames"`. ### Error parameters Properties of `params` object in errors depend on the keyword that failed validation. - `maxItems`, `minItems`, `maxLength`, `minLength`, `maxProperties`, `minProperties` - property `limit` (number, the schema of the keyword). - `additionalItems` - property `limit` (the maximum number of allowed items in case when `items` keyword is an array of schemas and `additionalItems` is false). - `additionalProperties` - property `additionalProperty` (the property not used in `properties` and `patternProperties` keywords). - `dependencies` - properties: - `property` (dependent property), - `missingProperty` (required missing dependency - only the first one is reported currently) - `deps` (required dependencies, comma separated list as a string), - `depsCount` (the number of required dependencies). - `format` - property `format` (the schema of the keyword). - `maximum`, `minimum` - properties: - `limit` (number, the schema of the keyword), - `exclusive` (boolean, the schema of `exclusiveMaximum` or `exclusiveMinimum`), - `comparison` (string, comparison operation to compare the data to the limit, with the data on the left and the limit on the right; can be "<", "<=", ">", ">=") - `multipleOf` - property `multipleOf` (the schema of the keyword) - `pattern` - property `pattern` (the schema of the keyword) - `required` - property `missingProperty` (required property that is missing). - `propertyNames` - property `propertyName` (an invalid property name). - `patternRequired` (in ajv-keywords) - property `missingPattern` (required pattern that did not match any property). - `type` - property `type` (required type(s), a string, can be a comma-separated list) - `uniqueItems` - properties `i` and `j` (indices of duplicate items). - `const` - property `allowedValue` pointing to the value (the schema of the keyword). - `enum` - property `allowedValues` pointing to the array of values (the schema of the keyword). - `$ref` - property `ref` with the referenced schema URI. - `oneOf` - property `passingSchemas` (array of indices of passing schemas, null if no schema passes). - custom keywords (in case keyword definition doesn't create errors) - property `keyword` (the keyword name). ### Error logging Using the `logger` option when initiallizing Ajv will allow you to define custom logging. Here you can build upon the exisiting logging. The use of other logging packages is supported as long as the package or its associated wrapper exposes the required methods. If any of the required methods are missing an exception will be thrown. - **Required Methods**: `log`, `warn`, `error` ```javascript var otherLogger = new OtherLogger(); var ajv = new Ajv({ logger: { log: console.log.bind(console), warn: function warn() { otherLogger.logWarn.apply(otherLogger, arguments); }, error: function error() { otherLogger.logError.apply(otherLogger, arguments); console.error.apply(console, arguments); } } }); ``` ## Plugins Ajv can be extended with plugins that add custom keywords, formats or functions to process generated code. When such plugin is published as npm package it is recommended that it follows these conventions: - it exports a function - this function accepts ajv instance as the first parameter and returns the same instance to allow chaining - this function can accept an optional configuration as the second parameter If you have published a useful plugin please submit a PR to add it to the next section. ## Related packages - [ajv-async](https://github.com/ajv-validator/ajv-async) - plugin to configure async validation mode - [ajv-bsontype](https://github.com/BoLaMN/ajv-bsontype) - plugin to validate mongodb's bsonType formats - [ajv-cli](https://github.com/jessedc/ajv-cli) - command line interface - [ajv-errors](https://github.com/ajv-validator/ajv-errors) - plugin for custom error messages - [ajv-i18n](https://github.com/ajv-validator/ajv-i18n) - internationalised error messages - [ajv-istanbul](https://github.com/ajv-validator/ajv-istanbul) - plugin to instrument generated validation code to measure test coverage of your schemas - [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) - plugin with custom validation keywords (select, typeof, etc.) - [ajv-merge-patch](https://github.com/ajv-validator/ajv-merge-patch) - plugin with keywords $merge and $patch - [ajv-pack](https://github.com/ajv-validator/ajv-pack) - produces a compact module exporting validation functions - [ajv-formats-draft2019](https://github.com/luzlab/ajv-formats-draft2019) - format validators for draft2019 that aren't already included in ajv (ie. `idn-hostname`, `idn-email`, `iri`, `iri-reference` and `duration`). ## Some packages using Ajv - [webpack](https://github.com/webpack/webpack) - a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser - [jsonscript-js](https://github.com/JSONScript/jsonscript-js) - the interpreter for [JSONScript](http://www.jsonscript.org) - scripted processing of existing endpoints and services - [osprey-method-handler](https://github.com/mulesoft-labs/osprey-method-handler) - Express middleware for validating requests and responses based on a RAML method object, used in [osprey](https://github.com/mulesoft/osprey) - validating API proxy generated from a RAML definition - [har-validator](https://github.com/ahmadnassri/har-validator) - HTTP Archive (HAR) validator - [jsoneditor](https://github.com/josdejong/jsoneditor) - a web-based tool to view, edit, format, and validate JSON http://jsoneditoronline.org - [JSON Schema Lint](https://github.com/nickcmaynard/jsonschemalint) - a web tool to validate JSON/YAML document against a single JSON Schema http://jsonschemalint.com - [objection](https://github.com/vincit/objection.js) - SQL-friendly ORM for Node.js - [table](https://github.com/gajus/table) - formats data into a string table - [ripple-lib](https://github.com/ripple/ripple-lib) - a JavaScript API for interacting with [Ripple](https://ripple.com) in Node.js and the browser - [restbase](https://github.com/wikimedia/restbase) - distributed storage with REST API & dispatcher for backend services built to provide a low-latency & high-throughput API for Wikipedia / Wikimedia content - [hippie-swagger](https://github.com/CacheControl/hippie-swagger) - [Hippie](https://github.com/vesln/hippie) wrapper that provides end to end API testing with swagger validation - [react-form-controlled](https://github.com/seeden/react-form-controlled) - React controlled form components with validation - [rabbitmq-schema](https://github.com/tjmehta/rabbitmq-schema) - a schema definition module for RabbitMQ graphs and messages - [@query/schema](https://www.npmjs.com/package/@query/schema) - stream filtering with a URI-safe query syntax parsing to JSON Schema - [chai-ajv-json-schema](https://github.com/peon374/chai-ajv-json-schema) - chai plugin to us JSON Schema with expect in mocha tests - [grunt-jsonschema-ajv](https://github.com/SignpostMarv/grunt-jsonschema-ajv) - Grunt plugin for validating files against JSON Schema - [extract-text-webpack-plugin](https://github.com/webpack-contrib/extract-text-webpack-plugin) - extract text from bundle into a file - [electron-builder](https://github.com/electron-userland/electron-builder) - a solution to package and build a ready for distribution Electron app - [addons-linter](https://github.com/mozilla/addons-linter) - Mozilla Add-ons Linter - [gh-pages-generator](https://github.com/epoberezkin/gh-pages-generator) - multi-page site generator converting markdown files to GitHub pages - [ESLint](https://github.com/eslint/eslint) - the pluggable linting utility for JavaScript and JSX ## Tests ``` npm install git submodule update --init npm test ``` ## Contributing All validation functions are generated using doT templates in [dot](https://github.com/ajv-validator/ajv/tree/master/lib/dot) folder. Templates are precompiled so doT is not a run-time dependency. `npm run build` - compiles templates to [dotjs](https://github.com/ajv-validator/ajv/tree/master/lib/dotjs) folder. `npm run watch` - automatically compiles templates when files in dot folder change Please see [Contributing guidelines](https://github.com/ajv-validator/ajv/blob/master/CONTRIBUTING.md) ## Changes history See https://github.com/ajv-validator/ajv/releases __Please note__: [Changes in version 7.0.0-beta](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0-beta.0) [Version 6.0.0](https://github.com/ajv-validator/ajv/releases/tag/v6.0.0). ## Code of conduct Please review and follow the [Code of conduct](https://github.com/ajv-validator/ajv/blob/master/CODE_OF_CONDUCT.md). Please report any unacceptable behaviour to ajv.validator@gmail.com - it will be reviewed by the project team. ## Open-source software support Ajv is a part of [Tidelift subscription](https://tidelift.com/subscription/pkg/npm-ajv?utm_source=npm-ajv&utm_medium=referral&utm_campaign=readme) - it provides a centralised support to open-source software users, in addition to the support provided by software maintainers. ## License [MIT](https://github.com/ajv-validator/ajv/blob/master/LICENSE) # type-check [](https://travis-ci.org/gkz/type-check) <a name="type-check" /> `type-check` is a library which allows you to check the types of JavaScript values at runtime with a Haskell like type syntax. It is great for checking external input, for testing, or even for adding a bit of safety to your internal code. It is a major component of [levn](https://github.com/gkz/levn). MIT license. Version 0.4.0. Check out the [demo](http://gkz.github.io/type-check/). For updates on `type-check`, [follow me on twitter](https://twitter.com/gkzahariev). npm install type-check ## Quick Examples ```js // Basic types: var typeCheck = require('type-check').typeCheck; typeCheck('Number', 1); // true typeCheck('Number', 'str'); // false typeCheck('Error', new Error); // true typeCheck('Undefined', undefined); // true // Comment typeCheck('count::Number', 1); // true // One type OR another type: typeCheck('Number | String', 2); // true typeCheck('Number | String', 'str'); // true // Wildcard, matches all types: typeCheck('*', 2) // true // Array, all elements of a single type: typeCheck('[Number]', [1, 2, 3]); // true typeCheck('[Number]', [1, 'str', 3]); // false // Tuples, or fixed length arrays with elements of different types: typeCheck('(String, Number)', ['str', 2]); // true typeCheck('(String, Number)', ['str']); // false typeCheck('(String, Number)', ['str', 2, 5]); // false // Object properties: typeCheck('{x: Number, y: Boolean}', {x: 2, y: false}); // true typeCheck('{x: Number, y: Boolean}', {x: 2}); // false typeCheck('{x: Number, y: Maybe Boolean}', {x: 2}); // true typeCheck('{x: Number, y: Boolean}', {x: 2, y: false, z: 3}); // false typeCheck('{x: Number, y: Boolean, ...}', {x: 2, y: false, z: 3}); // true // A particular type AND object properties: typeCheck('RegExp{source: String, ...}', /re/i); // true typeCheck('RegExp{source: String, ...}', {source: 're'}); // false // Custom types: var opt = {customTypes: {Even: { typeOf: 'Number', validate: function(x) { return x % 2 === 0; }}}}; typeCheck('Even', 2, opt); // true // Nested: var type = '{a: (String, [Number], {y: Array, ...}), b: Error{message: String, ...}}' typeCheck(type, {a: ['hi', [1, 2, 3], {y: [1, 'ms']}], b: new Error('oh no')}); // true ``` Check out the [type syntax format](#syntax) and [guide](#guide). ## Usage `require('type-check');` returns an object that exposes four properties. `VERSION` is the current version of the library as a string. `typeCheck`, `parseType`, and `parsedTypeCheck` are functions. ```js // typeCheck(type, input, options); typeCheck('Number', 2); // true // parseType(type); var parsedType = parseType('Number'); // object // parsedTypeCheck(parsedType, input, options); parsedTypeCheck(parsedType, 2); // true ``` ### typeCheck(type, input, options) `typeCheck` checks a JavaScript value `input` against `type` written in the [type format](#type-format) (and taking account the optional `options`) and returns whether the `input` matches the `type`. ##### arguments * type - `String` - the type written in the [type format](#type-format) which to check against * input - `*` - any JavaScript value, which is to be checked against the type * options - `Maybe Object` - an optional parameter specifying additional options, currently the only available option is specifying [custom types](#custom-types) ##### returns `Boolean` - whether the input matches the type ##### example ```js typeCheck('Number', 2); // true ``` ### parseType(type) `parseType` parses string `type` written in the [type format](#type-format) into an object representing the parsed type. ##### arguments * type - `String` - the type written in the [type format](#type-format) which to parse ##### returns `Object` - an object in the parsed type format representing the parsed type ##### example ```js parseType('Number'); // [{type: 'Number'}] ``` ### parsedTypeCheck(parsedType, input, options) `parsedTypeCheck` checks a JavaScript value `input` against parsed `type` in the parsed type format (and taking account the optional `options`) and returns whether the `input` matches the `type`. Use this in conjunction with `parseType` if you are going to use a type more than once. ##### arguments * type - `Object` - the type in the parsed type format which to check against * input - `*` - any JavaScript value, which is to be checked against the type * options - `Maybe Object` - an optional parameter specifying additional options, currently the only available option is specifying [custom types](#custom-types) ##### returns `Boolean` - whether the input matches the type ##### example ```js parsedTypeCheck([{type: 'Number'}], 2); // true var parsedType = parseType('String'); parsedTypeCheck(parsedType, 'str'); // true ``` <a name="type-format" /> ## Type Format ### Syntax White space is ignored. The root node is a __Types__. * __Identifier__ = `[\$\w]+` - a group of any lower or upper case letters, numbers, underscores, or dollar signs - eg. `String` * __Type__ = an `Identifier`, an `Identifier` followed by a `Structure`, just a `Structure`, or a wildcard `*` - eg. `String`, `Object{x: Number}`, `{x: Number}`, `Array{0: String, 1: Boolean, length: Number}`, `*` * __Types__ = optionally a comment (an `Identifier` followed by a `::`), optionally the identifier `Maybe`, one or more `Type`, separated by `|` - eg. `Number`, `String | Date`, `Maybe Number`, `Maybe Boolean | String` * __Structure__ = `Fields`, or a `Tuple`, or an `Array` - eg. `{x: Number}`, `(String, Number)`, `[Date]` * __Fields__ = a `{`, followed one or more `Field` separated by a comma `,` (trailing comma `,` is permitted), optionally an `...` (always preceded by a comma `,`), followed by a `}` - eg. `{x: Number, y: String}`, `{k: Function, ...}` * __Field__ = an `Identifier`, followed by a colon `:`, followed by `Types` - eg. `x: Date | String`, `y: Boolean` * __Tuple__ = a `(`, followed by one or more `Types` separated by a comma `,` (trailing comma `,` is permitted), followed by a `)` - eg `(Date)`, `(Number, Date)` * __Array__ = a `[` followed by exactly one `Types` followed by a `]` - eg. `[Boolean]`, `[Boolean | Null]` ### Guide `type-check` uses `Object.toString` to find out the basic type of a value. Specifically, ```js {}.toString.call(VALUE).slice(8, -1) {}.toString.call(true).slice(8, -1) // 'Boolean' ``` A basic type, eg. `Number`, uses this check. This is much more versatile than using `typeof` - for example, with `document`, `typeof` produces `'object'` which isn't that useful, and our technique produces `'HTMLDocument'`. You may check for multiple types by separating types with a `|`. The checker proceeds from left to right, and passes if the value is any of the types - eg. `String | Boolean` first checks if the value is a string, and then if it is a boolean. If it is none of those, then it returns false. Adding a `Maybe` in front of a list of multiple types is the same as also checking for `Null` and `Undefined` - eg. `Maybe String` is equivalent to `Undefined | Null | String`. You may add a comment to remind you of what the type is for by following an identifier with a `::` before a type (or multiple types). The comment is simply thrown out. The wildcard `*` matches all types. There are three types of structures for checking the contents of a value: 'fields', 'tuple', and 'array'. If used by itself, a 'fields' structure will pass with any type of object as long as it is an instance of `Object` and the properties pass - this allows for duck typing - eg. `{x: Boolean}`. To check if the properties pass, and the value is of a certain type, you can specify the type - eg. `Error{message: String}`. If you want to make a field optional, you can simply use `Maybe` - eg. `{x: Boolean, y: Maybe String}` will still pass if `y` is undefined (or null). If you don't care if the value has properties beyond what you have specified, you can use the 'etc' operator `...` - eg. `{x: Boolean, ...}` will match an object with an `x` property that is a boolean, and with zero or more other properties. For an array, you must specify one or more types (separated by `|`) - it will pass for something of any length as long as each element passes the types provided - eg. `[Number]`, `[Number | String]`. A tuple checks for a fixed number of elements, each of a potentially different type. Each element is separated by a comma - eg. `(String, Number)`. An array and tuple structure check that the value is of type `Array` by default, but if another type is specified, they will check for that instead - eg. `Int32Array[Number]`. You can use the wildcard `*` to search for any type at all. Check out the [type precedence](https://github.com/zaboco/type-precedence) library for type-check. ## Options Options is an object. It is an optional parameter to the `typeCheck` and `parsedTypeCheck` functions. The only current option is `customTypes`. <a name="custom-types" /> ### Custom Types __Example:__ ```js var options = { customTypes: { Even: { typeOf: 'Number', validate: function(x) { return x % 2 === 0; } } } }; typeCheck('Even', 2, options); // true typeCheck('Even', 3, options); // false ``` `customTypes` allows you to set up custom types for validation. The value of this is an object. The keys of the object are the types you will be matching. Each value of the object will be an object having a `typeOf` property - a string, and `validate` property - a function. The `typeOf` property is the type the value should be (optional - if not set only `validate` will be used), and `validate` is a function which should return true if the value is of that type. `validate` receives one parameter, which is the value that we are checking. ## Technical About `type-check` is written in [LiveScript](http://livescript.net/) - a language that compiles to JavaScript. It also uses the [prelude.ls](http://preludels.com/) library. # once Only call a function once. ## usage ```javascript var once = require('once') function load (file, cb) { cb = once(cb) loader.load('file') loader.once('load', cb) loader.once('error', cb) } ``` Or add to the Function.prototype in a responsible way: ```javascript // only has to be done once require('once').proto() function load (file, cb) { cb = cb.once() loader.load('file') loader.once('load', cb) loader.once('error', cb) } ``` Ironically, the prototype feature makes this module twice as complicated as necessary. To check whether you function has been called, use `fn.called`. Once the function is called for the first time the return value of the original function is saved in `fn.value` and subsequent calls will continue to return this value. ```javascript var once = require('once') function load (cb) { cb = once(cb) var stream = createStream() stream.once('data', cb) stream.once('end', function () { if (!cb.called) cb(new Error('not found')) }) } ``` ## `once.strict(func)` Throw an error if the function is called twice. Some functions are expected to be called only once. Using `once` for them would potentially hide logical errors. In the example below, the `greet` function has to call the callback only once: ```javascript function greet (name, cb) { // return is missing from the if statement // when no name is passed, the callback is called twice if (!name) cb('Hello anonymous') cb('Hello ' + name) } function log (msg) { console.log(msg) } // this will print 'Hello anonymous' but the logical error will be missed greet(null, once(msg)) // once.strict will print 'Hello anonymous' and throw an error when the callback will be called the second time greet(null, once.strict(msg)) ``` ### esutils [](http://travis-ci.org/estools/esutils) esutils ([esutils](http://github.com/estools/esutils)) is utility box for ECMAScript language tools. ### API ### ast #### ast.isExpression(node) Returns true if `node` is an Expression as defined in ECMA262 edition 5.1 section [11](https://es5.github.io/#x11). #### ast.isStatement(node) Returns true if `node` is a Statement as defined in ECMA262 edition 5.1 section [12](https://es5.github.io/#x12). #### ast.isIterationStatement(node) Returns true if `node` is an IterationStatement as defined in ECMA262 edition 5.1 section [12.6](https://es5.github.io/#x12.6). #### ast.isSourceElement(node) Returns true if `node` is a SourceElement as defined in ECMA262 edition 5.1 section [14](https://es5.github.io/#x14). #### ast.trailingStatement(node) Returns `Statement?` if `node` has trailing `Statement`. ```js if (cond) consequent; ``` When taking this `IfStatement`, returns `consequent;` statement. #### ast.isProblematicIfStatement(node) Returns true if `node` is a problematic IfStatement. If `node` is a problematic `IfStatement`, `node` cannot be represented as an one on one JavaScript code. ```js { type: 'IfStatement', consequent: { type: 'WithStatement', body: { type: 'IfStatement', consequent: {type: 'EmptyStatement'} } }, alternate: {type: 'EmptyStatement'} } ``` The above node cannot be represented as a JavaScript code, since the top level `else` alternate belongs to an inner `IfStatement`. ### code #### code.isDecimalDigit(code) Return true if provided code is decimal digit. #### code.isHexDigit(code) Return true if provided code is hexadecimal digit. #### code.isOctalDigit(code) Return true if provided code is octal digit. #### code.isWhiteSpace(code) Return true if provided code is white space. White space characters are formally defined in ECMA262. #### code.isLineTerminator(code) Return true if provided code is line terminator. Line terminator characters are formally defined in ECMA262. #### code.isIdentifierStart(code) Return true if provided code can be the first character of ECMA262 Identifier. They are formally defined in ECMA262. #### code.isIdentifierPart(code) Return true if provided code can be the trailing character of ECMA262 Identifier. They are formally defined in ECMA262. ### keyword #### keyword.isKeywordES5(id, strict) Returns `true` if provided identifier string is a Keyword or Future Reserved Word in ECMA262 edition 5.1. They are formally defined in ECMA262 sections [7.6.1.1](http://es5.github.io/#x7.6.1.1) and [7.6.1.2](http://es5.github.io/#x7.6.1.2), respectively. If the `strict` flag is truthy, this function additionally checks whether `id` is a Keyword or Future Reserved Word under strict mode. #### keyword.isKeywordES6(id, strict) Returns `true` if provided identifier string is a Keyword or Future Reserved Word in ECMA262 edition 6. They are formally defined in ECMA262 sections [11.6.2.1](http://ecma-international.org/ecma-262/6.0/#sec-keywords) and [11.6.2.2](http://ecma-international.org/ecma-262/6.0/#sec-future-reserved-words), respectively. If the `strict` flag is truthy, this function additionally checks whether `id` is a Keyword or Future Reserved Word under strict mode. #### keyword.isReservedWordES5(id, strict) Returns `true` if provided identifier string is a Reserved Word in ECMA262 edition 5.1. They are formally defined in ECMA262 section [7.6.1](http://es5.github.io/#x7.6.1). If the `strict` flag is truthy, this function additionally checks whether `id` is a Reserved Word under strict mode. #### keyword.isReservedWordES6(id, strict) Returns `true` if provided identifier string is a Reserved Word in ECMA262 edition 6. They are formally defined in ECMA262 section [11.6.2](http://ecma-international.org/ecma-262/6.0/#sec-reserved-words). If the `strict` flag is truthy, this function additionally checks whether `id` is a Reserved Word under strict mode. #### keyword.isRestrictedWord(id) Returns `true` if provided identifier string is one of `eval` or `arguments`. They are restricted in strict mode code throughout ECMA262 edition 5.1 and in ECMA262 edition 6 section [12.1.1](http://ecma-international.org/ecma-262/6.0/#sec-identifiers-static-semantics-early-errors). #### keyword.isIdentifierNameES5(id) Return true if provided identifier string is an IdentifierName as specified in ECMA262 edition 5.1 section [7.6](https://es5.github.io/#x7.6). #### keyword.isIdentifierNameES6(id) Return true if provided identifier string is an IdentifierName as specified in ECMA262 edition 6 section [11.6](http://ecma-international.org/ecma-262/6.0/#sec-names-and-keywords). #### keyword.isIdentifierES5(id, strict) Return true if provided identifier string is an Identifier as specified in ECMA262 edition 5.1 section [7.6](https://es5.github.io/#x7.6). If the `strict` flag is truthy, this function additionally checks whether `id` is an Identifier under strict mode. #### keyword.isIdentifierES6(id, strict) Return true if provided identifier string is an Identifier as specified in ECMA262 edition 6 section [12.1](http://ecma-international.org/ecma-262/6.0/#sec-identifiers). If the `strict` flag is truthy, this function additionally checks whether `id` is an Identifier under strict mode. ### License Copyright (C) 2013 [Yusuke Suzuki](http://github.com/Constellation) (twitter: [@Constellation](http://twitter.com/Constellation)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # binary-install Install .tar.gz binary applications via npm ## Usage This library provides a single class `Binary` that takes a download url and some optional arguments. You **must** provide either `name` or `installDirectory` when creating your `Binary`. | option | decription | | ---------------- | --------------------------------------------- | | name | The name of your binary | | installDirectory | A path to the directory to install the binary | If an `installDirectory` is not provided, the binary will be installed at your OS specific config directory. On MacOS it defaults to `~/Library/Preferences/${name}-nodejs` After your `Binary` has been created, you can run `.install()` to install the binary, and `.run()` to run it. ### Example This is meant to be used as a library - create your `Binary` with your desired options, then call `.install()` in the `postinstall` of your `package.json`, `.run()` in the `bin` section of your `package.json`, and `.uninstall()` in the `preuninstall` section of your `package.json`. See [this example project](/example) to see how to create an npm package that installs and runs a binary using the Github releases API. # Optionator <a name="optionator" /> Optionator is a JavaScript/Node.js option parsing and help generation library used by [eslint](http://eslint.org), [Grasp](http://graspjs.com), [LiveScript](http://livescript.net), [esmangle](https://github.com/estools/esmangle), [escodegen](https://github.com/estools/escodegen), and [many more](https://www.npmjs.com/browse/depended/optionator). For an online demo, check out the [Grasp online demo](http://www.graspjs.com/#demo). [About](#about) &middot; [Usage](#usage) &middot; [Settings Format](#settings-format) &middot; [Argument Format](#argument-format) ## Why? The problem with other option parsers, such as `yargs` or `minimist`, is they just accept all input, valid or not. With Optionator, if you mistype an option, it will give you an error (with a suggestion for what you meant). If you give the wrong type of argument for an option, it will give you an error rather than supplying the wrong input to your application. $ cmd --halp Invalid option '--halp' - perhaps you meant '--help'? $ cmd --count str Invalid value for option 'count' - expected type Int, received value: str. Other helpful features include reformatting the help text based on the size of the console, so that it fits even if the console is narrow, and accepting not just an array (eg. process.argv), but a string or object as well, making things like testing much easier. ## About Optionator uses [type-check](https://github.com/gkz/type-check) and [levn](https://github.com/gkz/levn) behind the scenes to cast and verify input according the specified types. MIT license. Version 0.9.1 npm install optionator For updates on Optionator, [follow me on twitter](https://twitter.com/gkzahariev). Optionator is a Node.js module, but can be used in the browser as well if packed with webpack/browserify. ## Usage `require('optionator');` returns a function. It has one property, `VERSION`, the current version of the library as a string. This function is called with an object specifying your options and other information, see the [settings format section](#settings-format). This in turn returns an object with three properties, `parse`, `parseArgv`, `generateHelp`, and `generateHelpForOption`, which are all functions. ```js var optionator = require('optionator')({ prepend: 'Usage: cmd [options]', append: 'Version 1.0.0', options: [{ option: 'help', alias: 'h', type: 'Boolean', description: 'displays help' }, { option: 'count', alias: 'c', type: 'Int', description: 'number of things', example: 'cmd --count 2' }] }); var options = optionator.parseArgv(process.argv); if (options.help) { console.log(optionator.generateHelp()); } ... ``` ### parse(input, parseOptions) `parse` processes the `input` according to your settings, and returns an object with the results. ##### arguments * input - `[String] | Object | String` - the input you wish to parse * parseOptions - `{slice: Int}` - all options optional - `slice` specifies how much to slice away from the beginning if the input is an array or string - by default `0` for string, `2` for array (works with `process.argv`) ##### returns `Object` - the parsed options, each key is a camelCase version of the option name (specified in dash-case), and each value is the processed value for that option. Positional values are in an array under the `_` key. ##### example ```js parse(['node', 't.js', '--count', '2', 'positional']); // {count: 2, _: ['positional']} parse('--count 2 positional'); // {count: 2, _: ['positional']} parse({count: 2, _:['positional']}); // {count: 2, _: ['positional']} ``` ### parseArgv(input) `parseArgv` works exactly like `parse`, but only for array input and it slices off the first two elements. ##### arguments * input - `[String]` - the input you wish to parse ##### returns See "returns" section in "parse" ##### example ```js parseArgv(process.argv); ``` ### generateHelp(helpOptions) `generateHelp` produces help text based on your settings. ##### arguments * helpOptions - `{showHidden: Boolean, interpolate: Object}` - all options optional - `showHidden` specifies whether to show options with `hidden: true` specified, by default it is `false` - `interpolate` specify data to be interpolated in `prepend` and `append` text, `{{key}}` is the format - eg. `generateHelp({interpolate:{version: '0.4.2'}})`, will change this `append` text: `Version {{version}}` to `Version 0.4.2` ##### returns `String` - the generated help text ##### example ```js generateHelp(); /* "Usage: cmd [options] positional -h, --help displays help -c, --count Int number of things Version 1.0.0 "*/ ``` ### generateHelpForOption(optionName) `generateHelpForOption` produces expanded help text for the specified with `optionName` option. If an `example` was specified for the option, it will be displayed, and if a `longDescription` was specified, it will display that instead of the `description`. ##### arguments * optionName - `String` - the name of the option to display ##### returns `String` - the generated help text for the option ##### example ```js generateHelpForOption('count'); /* "-c, --count Int description: number of things example: cmd --count 2 "*/ ``` ## Settings Format When your `require('optionator')`, you get a function that takes in a settings object. This object has the type: { prepend: String, append: String, options: [{heading: String} | { option: String, alias: [String] | String, type: String, enum: [String], default: String, restPositional: Boolean, required: Boolean, overrideRequired: Boolean, dependsOn: [String] | String, concatRepeatedArrays: Boolean | (Boolean, Object), mergeRepeatedObjects: Boolean, description: String, longDescription: String, example: [String] | String }], helpStyle: { aliasSeparator: String, typeSeparator: String, descriptionSeparator: String, initialIndent: Int, secondaryIndent: Int, maxPadFactor: Number }, mutuallyExclusive: [[String | [String]]], concatRepeatedArrays: Boolean | (Boolean, Object), // deprecated, set in defaults object mergeRepeatedObjects: Boolean, // deprecated, set in defaults object positionalAnywhere: Boolean, typeAliases: Object, defaults: Object } All of the properties are optional (the `Maybe` has been excluded for brevities sake), except for having either `heading: String` or `option: String` in each object in the `options` array. ### Top Level Properties * `prepend` is an optional string to be placed before the options in the help text * `append` is an optional string to be placed after the options in the help text * `options` is a required array specifying your options and headings, the options and headings will be displayed in the order specified * `helpStyle` is an optional object which enables you to change the default appearance of some aspects of the help text * `mutuallyExclusive` is an optional array of arrays of either strings or arrays of strings. The top level array is a list of rules, each rule is a list of elements - each element can be either a string (the name of an option), or a list of strings (a group of option names) - there will be an error if more than one element is present * `concatRepeatedArrays` see description under the "Option Properties" heading - use at the top level is deprecated, if you want to set this for all options, use the `defaults` property * `mergeRepeatedObjects` see description under the "Option Properties" heading - use at the top level is deprecated, if you want to set this for all options, use the `defaults` property * `positionalAnywhere` is an optional boolean (defaults to `true`) - when `true` it allows positional arguments anywhere, when `false`, all arguments after the first positional one are taken to be positional as well, even if they look like a flag. For example, with `positionalAnywhere: false`, the arguments `--flag --boom 12 --crack` would have two positional arguments: `12` and `--crack` * `typeAliases` is an optional object, it allows you to set aliases for types, eg. `{Path: 'String'}` would allow you to use the type `Path` as an alias for the type `String` * `defaults` is an optional object following the option properties format, which specifies default values for all options. A default will be overridden if manually set. For example, you can do `default: { type: "String" }` to set the default type of all options to `String`, and then override that default in an individual option by setting the `type` property #### Heading Properties * `heading` a required string, the name of the heading #### Option Properties * `option` the required name of the option - use dash-case, without the leading dashes * `alias` is an optional string or array of strings which specify any aliases for the option * `type` is a required string in the [type check](https://github.com/gkz/type-check) [format](https://github.com/gkz/type-check#type-format), this will be used to cast the inputted value and validate it * `enum` is an optional array of strings, each string will be parsed by [levn](https://github.com/gkz/levn) - the argument value must be one of the resulting values - each potential value must validate against the specified `type` * `default` is a optional string, which will be parsed by [levn](https://github.com/gkz/levn) and used as the default value if none is set - the value must validate against the specified `type` * `restPositional` is an optional boolean - if set to `true`, everything after the option will be taken to be a positional argument, even if it looks like a named argument * `required` is an optional boolean - if set to `true`, the option parsing will fail if the option is not defined * `overrideRequired` is a optional boolean - if set to `true` and the option is used, and there is another option which is required but not set, it will override the need for the required option and there will be no error - this is useful if you have required options and want to use `--help` or `--version` flags * `concatRepeatedArrays` is an optional boolean or tuple with boolean and options object (defaults to `false`) - when set to `true` and an option contains an array value and is repeated, the subsequent values for the flag will be appended rather than overwriting the original value - eg. option `g` of type `[String]`: `-g a -g b -g c,d` will result in `['a','b','c','d']` You can supply an options object by giving the following value: `[true, options]`. The one currently supported option is `oneValuePerFlag`, this only allows one array value per flag. This is useful if your potential values contain a comma. * `mergeRepeatedObjects` is an optional boolean (defaults to `false`) - when set to `true` and an option contains an object value and is repeated, the subsequent values for the flag will be merged rather than overwriting the original value - eg. option `g` of type `Object`: `-g a:1 -g b:2 -g c:3,d:4` will result in `{a: 1, b: 2, c: 3, d: 4}` * `dependsOn` is an optional string or array of strings - if simply a string (the name of another option), it will make sure that that other option is set, if an array of strings, depending on whether `'and'` or `'or'` is first, it will either check whether all (`['and', 'option-a', 'option-b']`), or at least one (`['or', 'option-a', 'option-b']`) other options are set * `description` is an optional string, which will be displayed next to the option in the help text * `longDescription` is an optional string, it will be displayed instead of the `description` when `generateHelpForOption` is used * `example` is an optional string or array of strings with example(s) for the option - these will be displayed when `generateHelpForOption` is used #### Help Style Properties * `aliasSeparator` is an optional string, separates multiple names from each other - default: ' ,' * `typeSeparator` is an optional string, separates the type from the names - default: ' ' * `descriptionSeparator` is an optional string , separates the description from the padded name and type - default: ' ' * `initialIndent` is an optional int - the amount of indent for options - default: 2 * `secondaryIndent` is an optional int - the amount of indent if wrapped fully (in addition to the initial indent) - default: 4 * `maxPadFactor` is an optional number - affects the default level of padding for the names/type, it is multiplied by the average of the length of the names/type - default: 1.5 ## Argument Format At the highest level there are two types of arguments: named, and positional. Name arguments of any length are prefixed with `--` (eg. `--go`), and those of one character may be prefixed with either `--` or `-` (eg. `-g`). There are two types of named arguments: boolean flags (eg. `--problemo`, `-p`) which take no value and result in a `true` if they are present, the falsey `undefined` if they are not present, or `false` if present and explicitly prefixed with `no` (eg. `--no-problemo`). Named arguments with values (eg. `--tseries 800`, `-t 800`) are the other type. If the option has a type `Boolean` it will automatically be made into a boolean flag. Any other type results in a named argument that takes a value. For more information about how to properly set types to get the value you want, take a look at the [type check](https://github.com/gkz/type-check) and [levn](https://github.com/gkz/levn) pages. You can group single character arguments that use a single `-`, however all except the last must be boolean flags (which take no value). The last may be a boolean flag, or an argument which takes a value - eg. `-ba 2` is equivalent to `-b -a 2`. Positional arguments are all those values which do not fall under the above - they can be anywhere, not just at the end. For example, in `cmd -b one -a 2 two` where `b` is a boolean flag, and `a` has the type `Number`, there are two positional arguments, `one` and `two`. Everything after an `--` is positional, even if it looks like a named argument. You may optionally use `=` to separate option names from values, for example: `--count=2`. If you specify the option `NUM`, then any argument using a single `-` followed by a number will be valid and will set the value of `NUM`. Eg. `-2` will be parsed into `NUM: 2`. If duplicate named arguments are present, the last one will be taken. ## Technical About `optionator` is written in [LiveScript](http://livescript.net/) - a language that compiles to JavaScript. It uses [levn](https://github.com/gkz/levn) to cast arguments to their specified type, and uses [type-check](https://github.com/gkz/type-check) to validate values. It also uses the [prelude.ls](http://preludels.com/) library. # eslint-utils [](https://www.npmjs.com/package/eslint-utils) [](http://www.npmtrends.com/eslint-utils) [](https://github.com/mysticatea/eslint-utils/actions) [](https://codecov.io/gh/mysticatea/eslint-utils) [](https://david-dm.org/mysticatea/eslint-utils) ## 🏁 Goal This package provides utility functions and classes for make ESLint custom rules. For examples: - [getStaticValue](https://eslint-utils.mysticatea.dev/api/ast-utils.html#getstaticvalue) evaluates static value on AST. - [ReferenceTracker](https://eslint-utils.mysticatea.dev/api/scope-utils.html#referencetracker-class) checks the members of modules/globals as handling assignments and destructuring. ## 📖 Usage See [documentation](https://eslint-utils.mysticatea.dev/). ## 📰 Changelog See [releases](https://github.com/mysticatea/eslint-utils/releases). ## ❤️ Contributing Welcome contributing! Please use GitHub's Issues/PRs. ### Development Tools - `npm test` runs tests and measures coverage. - `npm run clean` removes the coverage result of `npm test` command. - `npm run coverage` shows the coverage result of the last `npm test` command. - `npm run lint` runs ESLint. - `npm run watch` runs tests on each file change. # minipass A _very_ minimal implementation of a [PassThrough stream](https://nodejs.org/api/stream.html#stream_class_stream_passthrough) [It's very fast](https://docs.google.com/spreadsheets/d/1oObKSrVwLX_7Ut4Z6g3fZW-AX1j1-k6w-cDsrkaSbHM/edit#gid=0) for objects, strings, and buffers. Supports `pipe()`ing (including multi-`pipe()` and backpressure transmission), buffering data until either a `data` event handler or `pipe()` is added (so you don't lose the first chunk), and most other cases where PassThrough is a good idea. There is a `read()` method, but it's much more efficient to consume data from this stream via `'data'` events or by calling `pipe()` into some other stream. Calling `read()` requires the buffer to be flattened in some cases, which requires copying memory. There is also no `unpipe()` method. Once you start piping, there is no stopping it! If you set `objectMode: true` in the options, then whatever is written will be emitted. Otherwise, it'll do a minimal amount of Buffer copying to ensure proper Streams semantics when `read(n)` is called. `objectMode` can also be set by doing `stream.objectMode = true`, or by writing any non-string/non-buffer data. `objectMode` cannot be set to false once it is set. This is not a `through` or `through2` stream. It doesn't transform the data, it just passes it right through. If you want to transform the data, extend the class, and override the `write()` method. Once you're done transforming the data however you want, call `super.write()` with the transform output. For some examples of streams that extend Minipass in various ways, check out: - [minizlib](http://npm.im/minizlib) - [fs-minipass](http://npm.im/fs-minipass) - [tar](http://npm.im/tar) - [minipass-collect](http://npm.im/minipass-collect) - [minipass-flush](http://npm.im/minipass-flush) - [minipass-pipeline](http://npm.im/minipass-pipeline) - [tap](http://npm.im/tap) - [tap-parser](http://npm.im/tap-parser) - [treport](http://npm.im/treport) - [minipass-fetch](http://npm.im/minipass-fetch) - [pacote](http://npm.im/pacote) - [make-fetch-happen](http://npm.im/make-fetch-happen) - [cacache](http://npm.im/cacache) - [ssri](http://npm.im/ssri) - [npm-registry-fetch](http://npm.im/npm-registry-fetch) - [minipass-json-stream](http://npm.im/minipass-json-stream) - [minipass-sized](http://npm.im/minipass-sized) ## Differences from Node.js Streams There are several things that make Minipass streams different from (and in some ways superior to) Node.js core streams. Please read these caveats if you are familiar with node-core streams and intend to use Minipass streams in your programs. ### Timing Minipass streams are designed to support synchronous use-cases. Thus, data is emitted as soon as it is available, always. It is buffered until read, but no longer. Another way to look at it is that Minipass streams are exactly as synchronous as the logic that writes into them. This can be surprising if your code relies on `PassThrough.write()` always providing data on the next tick rather than the current one, or being able to call `resume()` and not have the entire buffer disappear immediately. However, without this synchronicity guarantee, there would be no way for Minipass to achieve the speeds it does, or support the synchronous use cases that it does. Simply put, waiting takes time. This non-deferring approach makes Minipass streams much easier to reason about, especially in the context of Promises and other flow-control mechanisms. ### No High/Low Water Marks Node.js core streams will optimistically fill up a buffer, returning `true` on all writes until the limit is hit, even if the data has nowhere to go. Then, they will not attempt to draw more data in until the buffer size dips below a minimum value. Minipass streams are much simpler. The `write()` method will return `true` if the data has somewhere to go (which is to say, given the timing guarantees, that the data is already there by the time `write()` returns). If the data has nowhere to go, then `write()` returns false, and the data sits in a buffer, to be drained out immediately as soon as anyone consumes it. ### Hazards of Buffering (or: Why Minipass Is So Fast) Since data written to a Minipass stream is immediately written all the way through the pipeline, and `write()` always returns true/false based on whether the data was fully flushed, backpressure is communicated immediately to the upstream caller. This minimizes buffering. Consider this case: ```js const {PassThrough} = require('stream') const p1 = new PassThrough({ highWaterMark: 1024 }) const p2 = new PassThrough({ highWaterMark: 1024 }) const p3 = new PassThrough({ highWaterMark: 1024 }) const p4 = new PassThrough({ highWaterMark: 1024 }) p1.pipe(p2).pipe(p3).pipe(p4) p4.on('data', () => console.log('made it through')) // this returns false and buffers, then writes to p2 on next tick (1) // p2 returns false and buffers, pausing p1, then writes to p3 on next tick (2) // p3 returns false and buffers, pausing p2, then writes to p4 on next tick (3) // p4 returns false and buffers, pausing p3, then emits 'data' and 'drain' // on next tick (4) // p3 sees p4's 'drain' event, and calls resume(), emitting 'resume' and // 'drain' on next tick (5) // p2 sees p3's 'drain', calls resume(), emits 'resume' and 'drain' on next tick (6) // p1 sees p2's 'drain', calls resume(), emits 'resume' and 'drain' on next // tick (7) p1.write(Buffer.alloc(2048)) // returns false ``` Along the way, the data was buffered and deferred at each stage, and multiple event deferrals happened, for an unblocked pipeline where it was perfectly safe to write all the way through! Furthermore, setting a `highWaterMark` of `1024` might lead someone reading the code to think an advisory maximum of 1KiB is being set for the pipeline. However, the actual advisory buffering level is the _sum_ of `highWaterMark` values, since each one has its own bucket. Consider the Minipass case: ```js const m1 = new Minipass() const m2 = new Minipass() const m3 = new Minipass() const m4 = new Minipass() m1.pipe(m2).pipe(m3).pipe(m4) m4.on('data', () => console.log('made it through')) // m1 is flowing, so it writes the data to m2 immediately // m2 is flowing, so it writes the data to m3 immediately // m3 is flowing, so it writes the data to m4 immediately // m4 is flowing, so it fires the 'data' event immediately, returns true // m4's write returned true, so m3 is still flowing, returns true // m3's write returned true, so m2 is still flowing, returns true // m2's write returned true, so m1 is still flowing, returns true // No event deferrals or buffering along the way! m1.write(Buffer.alloc(2048)) // returns true ``` It is extremely unlikely that you _don't_ want to buffer any data written, or _ever_ buffer data that can be flushed all the way through. Neither node-core streams nor Minipass ever fail to buffer written data, but node-core streams do a lot of unnecessary buffering and pausing. As always, the faster implementation is the one that does less stuff and waits less time to do it. ### Immediately emit `end` for empty streams (when not paused) If a stream is not paused, and `end()` is called before writing any data into it, then it will emit `end` immediately. If you have logic that occurs on the `end` event which you don't want to potentially happen immediately (for example, closing file descriptors, moving on to the next entry in an archive parse stream, etc.) then be sure to call `stream.pause()` on creation, and then `stream.resume()` once you are ready to respond to the `end` event. ### Emit `end` When Asked One hazard of immediately emitting `'end'` is that you may not yet have had a chance to add a listener. In order to avoid this hazard, Minipass streams safely re-emit the `'end'` event if a new listener is added after `'end'` has been emitted. Ie, if you do `stream.on('end', someFunction)`, and the stream has already emitted `end`, then it will call the handler right away. (You can think of this somewhat like attaching a new `.then(fn)` to a previously-resolved Promise.) To prevent calling handlers multiple times who would not expect multiple ends to occur, all listeners are removed from the `'end'` event whenever it is emitted. ### Impact of "immediate flow" on Tee-streams A "tee stream" is a stream piping to multiple destinations: ```js const tee = new Minipass() t.pipe(dest1) t.pipe(dest2) t.write('foo') // goes to both destinations ``` Since Minipass streams _immediately_ process any pending data through the pipeline when a new pipe destination is added, this can have surprising effects, especially when a stream comes in from some other function and may or may not have data in its buffer. ```js // WARNING! WILL LOSE DATA! const src = new Minipass() src.write('foo') src.pipe(dest1) // 'foo' chunk flows to dest1 immediately, and is gone src.pipe(dest2) // gets nothing! ``` The solution is to create a dedicated tee-stream junction that pipes to both locations, and then pipe to _that_ instead. ```js // Safe example: tee to both places const src = new Minipass() src.write('foo') const tee = new Minipass() tee.pipe(dest1) tee.pipe(dest2) src.pipe(tee) // tee gets 'foo', pipes to both locations ``` The same caveat applies to `on('data')` event listeners. The first one added will _immediately_ receive all of the data, leaving nothing for the second: ```js // WARNING! WILL LOSE DATA! const src = new Minipass() src.write('foo') src.on('data', handler1) // receives 'foo' right away src.on('data', handler2) // nothing to see here! ``` Using a dedicated tee-stream can be used in this case as well: ```js // Safe example: tee to both data handlers const src = new Minipass() src.write('foo') const tee = new Minipass() tee.on('data', handler1) tee.on('data', handler2) src.pipe(tee) ``` ## USAGE It's a stream! Use it like a stream and it'll most likely do what you want. ```js const Minipass = require('minipass') const mp = new Minipass(options) // optional: { encoding, objectMode } mp.write('foo') mp.pipe(someOtherStream) mp.end('bar') ``` ### OPTIONS * `encoding` How would you like the data coming _out_ of the stream to be encoded? Accepts any values that can be passed to `Buffer.toString()`. * `objectMode` Emit data exactly as it comes in. This will be flipped on by default if you write() something other than a string or Buffer at any point. Setting `objectMode: true` will prevent setting any encoding value. ### API Implements the user-facing portions of Node.js's `Readable` and `Writable` streams. ### Methods * `write(chunk, [encoding], [callback])` - Put data in. (Note that, in the base Minipass class, the same data will come out.) Returns `false` if the stream will buffer the next write, or true if it's still in "flowing" mode. * `end([chunk, [encoding]], [callback])` - Signal that you have no more data to write. This will queue an `end` event to be fired when all the data has been consumed. * `setEncoding(encoding)` - Set the encoding for data coming of the stream. This can only be done once. * `pause()` - No more data for a while, please. This also prevents `end` from being emitted for empty streams until the stream is resumed. * `resume()` - Resume the stream. If there's data in the buffer, it is all discarded. Any buffered events are immediately emitted. * `pipe(dest)` - Send all output to the stream provided. There is no way to unpipe. When data is emitted, it is immediately written to any and all pipe destinations. * `on(ev, fn)`, `emit(ev, fn)` - Minipass streams are EventEmitters. Some events are given special treatment, however. (See below under "events".) * `promise()` - Returns a Promise that resolves when the stream emits `end`, or rejects if the stream emits `error`. * `collect()` - Return a Promise that resolves on `end` with an array containing each chunk of data that was emitted, or rejects if the stream emits `error`. Note that this consumes the stream data. * `concat()` - Same as `collect()`, but concatenates the data into a single Buffer object. Will reject the returned promise if the stream is in objectMode, or if it goes into objectMode by the end of the data. * `read(n)` - Consume `n` bytes of data out of the buffer. If `n` is not provided, then consume all of it. If `n` bytes are not available, then it returns null. **Note** consuming streams in this way is less efficient, and can lead to unnecessary Buffer copying. * `destroy([er])` - Destroy the stream. If an error is provided, then an `'error'` event is emitted. If the stream has a `close()` method, and has not emitted a `'close'` event yet, then `stream.close()` will be called. Any Promises returned by `.promise()`, `.collect()` or `.concat()` will be rejected. After being destroyed, writing to the stream will emit an error. No more data will be emitted if the stream is destroyed, even if it was previously buffered. ### Properties * `bufferLength` Read-only. Total number of bytes buffered, or in the case of objectMode, the total number of objects. * `encoding` The encoding that has been set. (Setting this is equivalent to calling `setEncoding(enc)` and has the same prohibition against setting multiple times.) * `flowing` Read-only. Boolean indicating whether a chunk written to the stream will be immediately emitted. * `emittedEnd` Read-only. Boolean indicating whether the end-ish events (ie, `end`, `prefinish`, `finish`) have been emitted. Note that listening on any end-ish event will immediateyl re-emit it if it has already been emitted. * `writable` Whether the stream is writable. Default `true`. Set to `false` when `end()` * `readable` Whether the stream is readable. Default `true`. * `buffer` A [yallist](http://npm.im/yallist) linked list of chunks written to the stream that have not yet been emitted. (It's probably a bad idea to mess with this.) * `pipes` A [yallist](http://npm.im/yallist) linked list of streams that this stream is piping into. (It's probably a bad idea to mess with this.) * `destroyed` A getter that indicates whether the stream was destroyed. * `paused` True if the stream has been explicitly paused, otherwise false. * `objectMode` Indicates whether the stream is in `objectMode`. Once set to `true`, it cannot be set to `false`. ### Events * `data` Emitted when there's data to read. Argument is the data to read. This is never emitted while not flowing. If a listener is attached, that will resume the stream. * `end` Emitted when there's no more data to read. This will be emitted immediately for empty streams when `end()` is called. If a listener is attached, and `end` was already emitted, then it will be emitted again. All listeners are removed when `end` is emitted. * `prefinish` An end-ish event that follows the same logic as `end` and is emitted in the same conditions where `end` is emitted. Emitted after `'end'`. * `finish` An end-ish event that follows the same logic as `end` and is emitted in the same conditions where `end` is emitted. Emitted after `'prefinish'`. * `close` An indication that an underlying resource has been released. Minipass does not emit this event, but will defer it until after `end` has been emitted, since it throws off some stream libraries otherwise. * `drain` Emitted when the internal buffer empties, and it is again suitable to `write()` into the stream. * `readable` Emitted when data is buffered and ready to be read by a consumer. * `resume` Emitted when stream changes state from buffering to flowing mode. (Ie, when `resume` is called, `pipe` is called, or a `data` event listener is added.) ### Static Methods * `Minipass.isStream(stream)` Returns `true` if the argument is a stream, and false otherwise. To be considered a stream, the object must be either an instance of Minipass, or an EventEmitter that has either a `pipe()` method, or both `write()` and `end()` methods. (Pretty much any stream in node-land will return `true` for this.) ## EXAMPLES Here are some examples of things you can do with Minipass streams. ### simple "are you done yet" promise ```js mp.promise().then(() => { // stream is finished }, er => { // stream emitted an error }) ``` ### collecting ```js mp.collect().then(all => { // all is an array of all the data emitted // encoding is supported in this case, so // so the result will be a collection of strings if // an encoding is specified, or buffers/objects if not. // // In an async function, you may do // const data = await stream.collect() }) ``` ### collecting into a single blob This is a bit slower because it concatenates the data into one chunk for you, but if you're going to do it yourself anyway, it's convenient this way: ```js mp.concat().then(onebigchunk => { // onebigchunk is a string if the stream // had an encoding set, or a buffer otherwise. }) ``` ### iteration You can iterate over streams synchronously or asynchronously in platforms that support it. Synchronous iteration will end when the currently available data is consumed, even if the `end` event has not been reached. In string and buffer mode, the data is concatenated, so unless multiple writes are occurring in the same tick as the `read()`, sync iteration loops will generally only have a single iteration. To consume chunks in this way exactly as they have been written, with no flattening, create the stream with the `{ objectMode: true }` option. ```js const mp = new Minipass({ objectMode: true }) mp.write('a') mp.write('b') for (let letter of mp) { console.log(letter) // a, b } mp.write('c') mp.write('d') for (let letter of mp) { console.log(letter) // c, d } mp.write('e') mp.end() for (let letter of mp) { console.log(letter) // e } for (let letter of mp) { console.log(letter) // nothing } ``` Asynchronous iteration will continue until the end event is reached, consuming all of the data. ```js const mp = new Minipass({ encoding: 'utf8' }) // some source of some data let i = 5 const inter = setInterval(() => { if (i-- > 0) mp.write(Buffer.from('foo\n', 'utf8')) else { mp.end() clearInterval(inter) } }, 100) // consume the data with asynchronous iteration async function consume () { for await (let chunk of mp) { console.log(chunk) } return 'ok' } consume().then(res => console.log(res)) // logs `foo\n` 5 times, and then `ok` ``` ### subclass that `console.log()`s everything written into it ```js class Logger extends Minipass { write (chunk, encoding, callback) { console.log('WRITE', chunk, encoding) return super.write(chunk, encoding, callback) } end (chunk, encoding, callback) { console.log('END', chunk, encoding) return super.end(chunk, encoding, callback) } } someSource.pipe(new Logger()).pipe(someDest) ``` ### same thing, but using an inline anonymous class ```js // js classes are fun someSource .pipe(new (class extends Minipass { emit (ev, ...data) { // let's also log events, because debugging some weird thing console.log('EMIT', ev) return super.emit(ev, ...data) } write (chunk, encoding, callback) { console.log('WRITE', chunk, encoding) return super.write(chunk, encoding, callback) } end (chunk, encoding, callback) { console.log('END', chunk, encoding) return super.end(chunk, encoding, callback) } })) .pipe(someDest) ``` ### subclass that defers 'end' for some reason ```js class SlowEnd extends Minipass { emit (ev, ...args) { if (ev === 'end') { console.log('going to end, hold on a sec') setTimeout(() => { console.log('ok, ready to end now') super.emit('end', ...args) }, 100) } else { return super.emit(ev, ...args) } } } ``` ### transform that creates newline-delimited JSON ```js class NDJSONEncode extends Minipass { write (obj, cb) { try { // JSON.stringify can throw, emit an error on that return super.write(JSON.stringify(obj) + '\n', 'utf8', cb) } catch (er) { this.emit('error', er) } } end (obj, cb) { if (typeof obj === 'function') { cb = obj obj = undefined } if (obj !== undefined) { this.write(obj) } return super.end(cb) } } ``` ### transform that parses newline-delimited JSON ```js class NDJSONDecode extends Minipass { constructor (options) { // always be in object mode, as far as Minipass is concerned super({ objectMode: true }) this._jsonBuffer = '' } write (chunk, encoding, cb) { if (typeof chunk === 'string' && typeof encoding === 'string' && encoding !== 'utf8') { chunk = Buffer.from(chunk, encoding).toString() } else if (Buffer.isBuffer(chunk)) chunk = chunk.toString() } if (typeof encoding === 'function') { cb = encoding } const jsonData = (this._jsonBuffer + chunk).split('\n') this._jsonBuffer = jsonData.pop() for (let i = 0; i < jsonData.length; i++) { try { // JSON.parse can throw, emit an error on that super.write(JSON.parse(jsonData[i])) } catch (er) { this.emit('error', er) continue } } if (cb) cb() } } ```  Moo! ==== Moo is a highly-optimised tokenizer/lexer generator. Use it to tokenize your strings, before parsing 'em with a parser like [nearley](https://github.com/hardmath123/nearley) or whatever else you're into. * [Fast](#is-it-fast) * [Convenient](#usage) * uses [Regular Expressions](#on-regular-expressions) * tracks [Line Numbers](#line-numbers) * handles [Keywords](#keywords) * supports [States](#states) * custom [Errors](#errors) * is even [Iterable](#iteration) * has no dependencies * 4KB minified + gzipped * Moo! Is it fast? ----------- Yup! Flying-cows-and-singed-steak fast. Moo is the fastest JS tokenizer around. It's **~2–10x** faster than most other tokenizers; it's a **couple orders of magnitude** faster than some of the slower ones. Define your tokens **using regular expressions**. Moo will compile 'em down to a **single RegExp for performance**. It uses the new ES6 **sticky flag** where possible to make things faster; otherwise it falls back to an almost-as-efficient workaround. (For more than you ever wanted to know about this, read [adventures in the land of substrings and RegExps](http://mrale.ph/blog/2016/11/23/making-less-dart-faster.html).) You _might_ be able to go faster still by writing your lexer by hand rather than using RegExps, but that's icky. Oh, and it [avoids parsing RegExps by itself](https://hackernoon.com/the-madness-of-parsing-real-world-javascript-regexps-d9ee336df983#.2l8qu3l76). Because that would be horrible. Usage ----- First, you need to do the needful: `$ npm install moo`, or whatever will ship this code to your computer. Alternatively, grab the `moo.js` file by itself and slap it into your web page via a `<script>` tag; moo is completely standalone. Then you can start roasting your very own lexer/tokenizer: ```js const moo = require('moo') let lexer = moo.compile({ WS: /[ \t]+/, comment: /\/\/.*?$/, number: /0|[1-9][0-9]*/, string: /"(?:\\["\\]|[^\n"\\])*"/, lparen: '(', rparen: ')', keyword: ['while', 'if', 'else', 'moo', 'cows'], NL: { match: /\n/, lineBreaks: true }, }) ``` And now throw some text at it: ```js lexer.reset('while (10) cows\nmoo') lexer.next() // -> { type: 'keyword', value: 'while' } lexer.next() // -> { type: 'WS', value: ' ' } lexer.next() // -> { type: 'lparen', value: '(' } lexer.next() // -> { type: 'number', value: '10' } // ... ``` When you reach the end of Moo's internal buffer, next() will return `undefined`. You can always `reset()` it and feed it more data when that happens. On Regular Expressions ---------------------- RegExps are nifty for making tokenizers, but they can be a bit of a pain. Here are some things to be aware of: * You often want to use **non-greedy quantifiers**: e.g. `*?` instead of `*`. Otherwise your tokens will be longer than you expect: ```js let lexer = moo.compile({ string: /".*"/, // greedy quantifier * // ... }) lexer.reset('"foo" "bar"') lexer.next() // -> { type: 'string', value: 'foo" "bar' } ``` Better: ```js let lexer = moo.compile({ string: /".*?"/, // non-greedy quantifier *? // ... }) lexer.reset('"foo" "bar"') lexer.next() // -> { type: 'string', value: 'foo' } lexer.next() // -> { type: 'space', value: ' ' } lexer.next() // -> { type: 'string', value: 'bar' } ``` * The **order of your rules** matters. Earlier ones will take precedence. ```js moo.compile({ identifier: /[a-z0-9]+/, number: /[0-9]+/, }).reset('42').next() // -> { type: 'identifier', value: '42' } moo.compile({ number: /[0-9]+/, identifier: /[a-z0-9]+/, }).reset('42').next() // -> { type: 'number', value: '42' } ``` * Moo uses **multiline RegExps**. This has a few quirks: for example, the **dot `/./` doesn't include newlines**. Use `[^]` instead if you want to match newlines too. * Since an excluding character ranges like `/[^ ]/` (which matches anything but a space) _will_ include newlines, you have to be careful not to include them by accident! In particular, the whitespace metacharacter `\s` includes newlines. Line Numbers ------------ Moo tracks detailed information about the input for you. It will track line numbers, as long as you **apply the `lineBreaks: true` option to any rules which might contain newlines**. Moo will try to warn you if you forget to do this. Note that this is `false` by default, for performance reasons: counting the number of lines in a matched token has a small cost. For optimal performance, only match newlines inside a dedicated token: ```js newline: {match: '\n', lineBreaks: true}, ``` ### Token Info ### Token objects (returned from `next()`) have the following attributes: * **`type`**: the name of the group, as passed to compile. * **`text`**: the string that was matched. * **`value`**: the string that was matched, transformed by your `value` function (if any). * **`offset`**: the number of bytes from the start of the buffer where the match starts. * **`lineBreaks`**: the number of line breaks found in the match. (Always zero if this rule has `lineBreaks: false`.) * **`line`**: the line number of the beginning of the match, starting from 1. * **`col`**: the column where the match begins, starting from 1. ### Value vs. Text ### The `value` is the same as the `text`, unless you provide a [value transform](#transform). ```js const moo = require('moo') const lexer = moo.compile({ ws: /[ \t]+/, string: {match: /"(?:\\["\\]|[^\n"\\])*"/, value: s => s.slice(1, -1)}, }) lexer.reset('"test"') lexer.next() /* { value: 'test', text: '"test"', ... } */ ``` ### Reset ### Calling `reset()` on your lexer will empty its internal buffer, and set the line, column, and offset counts back to their initial value. If you don't want this, you can `save()` the state, and later pass it as the second argument to `reset()` to explicitly control the internal state of the lexer. ```js    lexer.reset('some line\n') let info = lexer.save() // -> { line: 10 } lexer.next() // -> { line: 10 } lexer.next() // -> { line: 11 } // ... lexer.reset('a different line\n', info) lexer.next() // -> { line: 10 } ``` Keywords -------- Moo makes it convenient to define literals. ```js moo.compile({ lparen: '(', rparen: ')', keyword: ['while', 'if', 'else', 'moo', 'cows'], }) ``` It'll automatically compile them into regular expressions, escaping them where necessary. **Keywords** should be written using the `keywords` transform. ```js moo.compile({ IDEN: {match: /[a-zA-Z]+/, type: moo.keywords({ KW: ['while', 'if', 'else', 'moo', 'cows'], })}, SPACE: {match: /\s+/, lineBreaks: true}, }) ``` ### Why? ### You need to do this to ensure the **longest match** principle applies, even in edge cases. Imagine trying to parse the input `className` with the following rules: ```js keyword: ['class'], identifier: /[a-zA-Z]+/, ``` You'll get _two_ tokens — `['class', 'Name']` -- which is _not_ what you want! If you swap the order of the rules, you'll fix this example; but now you'll lex `class` wrong (as an `identifier`). The keywords helper checks matches against the list of keywords; if any of them match, it uses the type `'keyword'` instead of `'identifier'` (for this example). ### Keyword Types ### Keywords can also have **individual types**. ```js let lexer = moo.compile({ name: {match: /[a-zA-Z]+/, type: moo.keywords({ 'kw-class': 'class', 'kw-def': 'def', 'kw-if': 'if', })}, // ... }) lexer.reset('def foo') lexer.next() // -> { type: 'kw-def', value: 'def' } lexer.next() // space lexer.next() // -> { type: 'name', value: 'foo' } ``` You can use [itt](https://github.com/nathan/itt)'s iterator adapters to make constructing keyword objects easier: ```js itt(['class', 'def', 'if']) .map(k => ['kw-' + k, k]) .toObject() ``` States ------ Moo allows you to define multiple lexer **states**. Each state defines its own separate set of token rules. Your lexer will start off in the first state given to `moo.states({})`. Rules can be annotated with `next`, `push`, and `pop`, to change the current state after that token is matched. A "stack" of past states is kept, which is used by `push` and `pop`. * **`next: 'bar'`** moves to the state named `bar`. (The stack is not changed.) * **`push: 'bar'`** moves to the state named `bar`, and pushes the old state onto the stack. * **`pop: 1`** removes one state from the top of the stack, and moves to that state. (Only `1` is supported.) Only rules from the current state can be matched. You need to copy your rule into all the states you want it to be matched in. For example, to tokenize JS-style string interpolation such as `a${{c: d}}e`, you might use: ```js let lexer = moo.states({ main: { strstart: {match: '`', push: 'lit'}, ident: /\w+/, lbrace: {match: '{', push: 'main'}, rbrace: {match: '}', pop: true}, colon: ':', space: {match: /\s+/, lineBreaks: true}, }, lit: { interp: {match: '${', push: 'main'}, escape: /\\./, strend: {match: '`', pop: true}, const: {match: /(?:[^$`]|\$(?!\{))+/, lineBreaks: true}, }, }) // <= `a${{c: d}}e` // => strstart const interp lbrace ident colon space ident rbrace rbrace const strend ``` The `rbrace` rule is annotated with `pop`, so it moves from the `main` state into either `lit` or `main`, depending on the stack. Errors ------ If none of your rules match, Moo will throw an Error; since it doesn't know what else to do. If you prefer, you can have moo return an error token instead of throwing an exception. The error token will contain the whole of the rest of the buffer. ```js moo.compile({ // ... myError: moo.error, }) moo.reset('invalid') moo.next() // -> { type: 'myError', value: 'invalid', text: 'invalid', offset: 0, lineBreaks: 0, line: 1, col: 1 } moo.next() // -> undefined ``` You can have a token type that both matches tokens _and_ contains error values. ```js moo.compile({ // ... myError: {match: /[\$?`]/, error: true}, }) ``` ### Formatting errors ### If you want to throw an error from your parser, you might find `formatError` helpful. Call it with the offending token: ```js throw new Error(lexer.formatError(token, "invalid syntax")) ``` It returns a string with a pretty error message. ``` Error: invalid syntax at line 2 col 15: totally valid `syntax` ^ ``` Iteration --------- Iterators: we got 'em. ```js for (let here of lexer) { // here = { type: 'number', value: '123', ... } } ``` Create an array of tokens. ```js let tokens = Array.from(lexer); ``` Use [itt](https://github.com/nathan/itt)'s iteration tools with Moo. ```js for (let [here, next] = itt(lexer).lookahead()) { // pass a number if you need more tokens // enjoy! } ``` Transform --------- Moo doesn't allow capturing groups, but you can supply a transform function, `value()`, which will be called on the value before storing it in the Token object. ```js moo.compile({ STRING: [ {match: /"""[^]*?"""/, lineBreaks: true, value: x => x.slice(3, -3)}, {match: /"(?:\\["\\rn]|[^"\\])*?"/, lineBreaks: true, value: x => x.slice(1, -1)}, {match: /'(?:\\['\\rn]|[^'\\])*?'/, lineBreaks: true, value: x => x.slice(1, -1)}, ], // ... }) ``` Contributing ------------ Do check the [FAQ](https://github.com/tjvr/moo/issues?q=label%3Aquestion). Before submitting an issue, [remember...](https://github.com/tjvr/moo/blob/master/.github/CONTRIBUTING.md) discontinuous-range =================== ``` DiscontinuousRange(1, 10).subtract(4, 6); // [ 1-3, 7-10 ] ``` [](https://travis-ci.org/dtudury/discontinuous-range) this is a pretty simple module, but it exists to service another project so this'll be pretty lacking documentation. reading the test to see how this works may help. otherwise, here's an example that I think pretty much sums it up ###Example ``` var all_numbers = new DiscontinuousRange(1, 100); var bad_numbers = DiscontinuousRange(13).add(8).add(60,80); var good_numbers = all_numbers.clone().subtract(bad_numbers); console.log(good_numbers.toString()); //[ 1-7, 9-12, 14-59, 81-100 ] var random_good_number = good_numbers.index(Math.floor(Math.random() * good_numbers.length)); ``` # [nearley](http://nearley.js.org) ↗️ [](http://js.org) [](https://badge.fury.io/js/nearley) nearley is a simple, fast and powerful parsing toolkit. It consists of: 1. [A powerful, modular DSL for describing languages](https://nearley.js.org/docs/grammar) 2. [An efficient, lightweight Earley parser](https://nearley.js.org/docs/parser) 3. [Loads of tools, editor plug-ins, and other goodies!](https://nearley.js.org/docs/tooling) nearley is a **streaming** parser with support for catching **errors** gracefully and providing _all_ parsings for **ambiguous** grammars. It is compatible with a variety of **lexers** (we recommend [moo](http://github.com/tjvr/moo)). It comes with tools for creating **tests**, **railroad diagrams** and **fuzzers** from your grammars, and has support for a variety of editors and platforms. It works in both node and the browser. Unlike most other parser generators, nearley can handle *any* grammar you can define in BNF (and more!). In particular, while most existing JS parsers such as PEGjs and Jison choke on certain grammars (e.g. [left recursive ones](http://en.wikipedia.org/wiki/Left_recursion)), nearley handles them easily and efficiently by using the [Earley parsing algorithm](https://en.wikipedia.org/wiki/Earley_parser). nearley is used by a wide variety of projects: - [artificial intelligence](https://github.com/ChalmersGU-AI-course/shrdlite-course-project) and - [computational linguistics](https://wiki.eecs.yorku.ca/course_archive/2014-15/W/6339/useful_handouts) classes at universities; - [file format parsers](https://github.com/raymond-h/node-dmi); - [data-driven markup languages](https://github.com/idyll-lang/idyll-compiler); - [compilers for real-world programming languages](https://github.com/sizigi/lp5562); - and nearley itself! The nearley compiler is bootstrapped. nearley is an npm [staff pick](https://www.npmjs.com/package/npm-collection-staff-picks). ## Documentation Please visit our website https://nearley.js.org to get started! You will find a tutorial, detailed reference documents, and links to several real-world examples to get inspired. ## Contributing Please read [this document](.github/CONTRIBUTING.md) *before* working on nearley. If you are interested in contributing but unsure where to start, take a look at the issues labeled "up for grabs" on the issue tracker, or message a maintainer (@kach or @tjvr on Github). nearley is MIT licensed. A big thanks to Nathan Dinsmore for teaching me how to Earley, Aria Stewart for helping structure nearley into a mature module, and Robin Windels for bootstrapping the grammar. Additionally, Jacob Edelman wrote an experimental JavaScript parser with nearley and contributed ideas for EBNF support. Joshua T. Corbin refactored the compiler to be much, much prettier. Bojidar Marinov implemented postprocessors-in-other-languages. Shachar Itzhaky fixed a subtle bug with nullables. ## Citing nearley If you are citing nearley in academic work, please use the following BibTeX entry. ```bibtex @misc{nearley, author = "Kartik Chandra and Tim Radvan", title = "{nearley}: a parsing toolkit for {JavaScript}", year = {2014}, doi = {10.5281/zenodo.3897993}, url = {https://github.com/kach/nearley} } ``` A JSON with color names and its values. Based on http://dev.w3.org/csswg/css-color/#named-colors. [](https://nodei.co/npm/color-name/) ```js var colors = require('color-name'); colors.red //[255,0,0] ``` <a href="LICENSE"><img src="https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg" width="120"/></a> <table><thead> <tr> <th>Linux</th> <th>OS X</th> <th>Windows</th> <th>Coverage</th> <th>Downloads</th> </tr> </thead><tbody><tr> <td colspan="2" align="center"> <a href="https://travis-ci.org/kaelzhang/node-ignore"> <img src="https://travis-ci.org/kaelzhang/node-ignore.svg?branch=master" alt="Build Status" /></a> </td> <td align="center"> <a href="https://ci.appveyor.com/project/kaelzhang/node-ignore"> <img src="https://ci.appveyor.com/api/projects/status/github/kaelzhang/node-ignore?branch=master&svg=true" alt="Windows Build Status" /></a> </td> <td align="center"> <a href="https://codecov.io/gh/kaelzhang/node-ignore"> <img src="https://codecov.io/gh/kaelzhang/node-ignore/branch/master/graph/badge.svg" alt="Coverage Status" /></a> </td> <td align="center"> <a href="https://www.npmjs.org/package/ignore"> <img src="http://img.shields.io/npm/dm/ignore.svg" alt="npm module downloads per month" /></a> </td> </tr></tbody></table> # ignore `ignore` is a manager, filter and parser which implemented in pure JavaScript according to the .gitignore [spec](http://git-scm.com/docs/gitignore). Pay attention that [`minimatch`](https://www.npmjs.org/package/minimatch) does not work in the gitignore way. To filter filenames according to .gitignore file, I recommend this module. ##### Tested on - Linux + Node: `0.8` - `7.x` - Windows + Node: `0.10` - `7.x`, node < `0.10` is not tested due to the lack of support of appveyor. Actually, `ignore` does not rely on any versions of node specially. Since `4.0.0`, ignore will no longer support `node < 6` by default, to use in node < 6, `require('ignore/legacy')`. For details, see [CHANGELOG](https://github.com/kaelzhang/node-ignore/blob/master/CHANGELOG.md). ## Table Of Main Contents - [Usage](#usage) - [`Pathname` Conventions](#pathname-conventions) - [Guide for 2.x -> 3.x](#upgrade-2x---3x) - [Guide for 3.x -> 4.x](#upgrade-3x---4x) - See Also: - [`glob-gitignore`](https://www.npmjs.com/package/glob-gitignore) matches files using patterns and filters them according to gitignore rules. ## Usage ```js import ignore from 'ignore' const ig = ignore().add(['.abc/*', '!.abc/d/']) ``` ### Filter the given paths ```js const paths = [ '.abc/a.js', // filtered out '.abc/d/e.js' // included ] ig.filter(paths) // ['.abc/d/e.js'] ig.ignores('.abc/a.js') // true ``` ### As the filter function ```js paths.filter(ig.createFilter()); // ['.abc/d/e.js'] ``` ### Win32 paths will be handled ```js ig.filter(['.abc\\a.js', '.abc\\d\\e.js']) // if the code above runs on windows, the result will be // ['.abc\\d\\e.js'] ``` ## Why another ignore? - `ignore` is a standalone module, and is much simpler so that it could easy work with other programs, unlike [isaacs](https://npmjs.org/~isaacs)'s [fstream-ignore](https://npmjs.org/package/fstream-ignore) which must work with the modules of the fstream family. - `ignore` only contains utility methods to filter paths according to the specified ignore rules, so - `ignore` never try to find out ignore rules by traversing directories or fetching from git configurations. - `ignore` don't cares about sub-modules of git projects. - Exactly according to [gitignore man page](http://git-scm.com/docs/gitignore), fixes some known matching issues of fstream-ignore, such as: - '`/*.js`' should only match '`a.js`', but not '`abc/a.js`'. - '`**/foo`' should match '`foo`' anywhere. - Prevent re-including a file if a parent directory of that file is excluded. - Handle trailing whitespaces: - `'a '`(one space) should not match `'a '`(two spaces). - `'a \ '` matches `'a '` - All test cases are verified with the result of `git check-ignore`. # Methods ## .add(pattern: string | Ignore): this ## .add(patterns: Array<string | Ignore>): this - **pattern** `String | Ignore` An ignore pattern string, or the `Ignore` instance - **patterns** `Array<String | Ignore>` Array of ignore patterns. Adds a rule or several rules to the current manager. Returns `this` Notice that a line starting with `'#'`(hash) is treated as a comment. Put a backslash (`'\'`) in front of the first hash for patterns that begin with a hash, if you want to ignore a file with a hash at the beginning of the filename. ```js ignore().add('#abc').ignores('#abc') // false ignore().add('\#abc').ignores('#abc') // true ``` `pattern` could either be a line of ignore pattern or a string of multiple ignore patterns, which means we could just `ignore().add()` the content of a ignore file: ```js ignore() .add(fs.readFileSync(filenameOfGitignore).toString()) .filter(filenames) ``` `pattern` could also be an `ignore` instance, so that we could easily inherit the rules of another `Ignore` instance. ## <strike>.addIgnoreFile(path)</strike> REMOVED in `3.x` for now. To upgrade `ignore@2.x` up to `3.x`, use ```js import fs from 'fs' if (fs.existsSync(filename)) { ignore().add(fs.readFileSync(filename).toString()) } ``` instead. ## .filter(paths: Array<Pathname>): Array<Pathname> ```ts type Pathname = string ``` Filters the given array of pathnames, and returns the filtered array. - **paths** `Array.<Pathname>` The array of `pathname`s to be filtered. ### `Pathname` Conventions: #### 1. `Pathname` should be a `path.relative()`d pathname `Pathname` should be a string that have been `path.join()`ed, or the return value of `path.relative()` to the current directory. ```js // WRONG ig.ignores('./abc') // WRONG, for it will never happen. // If the gitignore rule locates at the root directory, // `'/abc'` should be changed to `'abc'`. // ``` // path.relative('/', '/abc') -> 'abc' // ``` ig.ignores('/abc') // Right ig.ignores('abc') // Right ig.ignores(path.join('./abc')) // path.join('./abc') -> 'abc' ``` In other words, each `Pathname` here should be a relative path to the directory of the gitignore rules. Suppose the dir structure is: ``` /path/to/your/repo |-- a | |-- a.js | |-- .b | |-- .c |-- .DS_store ``` Then the `paths` might be like this: ```js [ 'a/a.js' '.b', '.c/.DS_store' ] ``` Usually, you could use [`glob`](http://npmjs.org/package/glob) with `option.mark = true` to fetch the structure of the current directory: ```js import glob from 'glob' glob('**', { // Adds a / character to directory matches. mark: true }, (err, files) => { if (err) { return console.error(err) } let filtered = ignore().add(patterns).filter(files) console.log(filtered) }) ``` #### 2. filenames and dirnames `node-ignore` does NO `fs.stat` during path matching, so for the example below: ```js ig.add('config/') // `ig` does NOT know if 'config' is a normal file, directory or something ig.ignores('config') // And it returns `false` ig.ignores('config/') // returns `true` ``` Specially for people who develop some library based on `node-ignore`, it is important to understand that. ## .ignores(pathname: Pathname): boolean > new in 3.2.0 Returns `Boolean` whether `pathname` should be ignored. ```js ig.ignores('.abc/a.js') // true ``` ## .createFilter() Creates a filter function which could filter an array of paths with `Array.prototype.filter`. Returns `function(path)` the filter function. ## `options.ignorecase` since 4.0.0 Similar as the `core.ignorecase` option of [git-config](https://git-scm.com/docs/git-config), `node-ignore` will be case insensitive if `options.ignorecase` is set to `true` (default value), otherwise case sensitive. ```js const ig = ignore({ ignorecase: false }) ig.add('*.png') ig.ignores('*.PNG') // false ``` **** # Upgrade Guide ## Upgrade 2.x -> 3.x - All `options` of 2.x are unnecessary and removed, so just remove them. - `ignore()` instance is no longer an [`EventEmitter`](nodejs.org/api/events.html), and all events are unnecessary and removed. - `.addIgnoreFile()` is removed, see the [.addIgnoreFile](#addignorefilepath) section for details. ## Upgrade 3.x -> 4.x Since `4.0.0`, `ignore` will no longer support node < 6, to use `ignore` in node < 6: ```js var ignore = require('ignore/legacy') ``` **** # Collaborators - [@whitecolor](https://github.com/whitecolor) *Alex* - [@SamyPesse](https://github.com/SamyPesse) *Samy Pessé* - [@azproduction](https://github.com/azproduction) *Mikhail Davydov* - [@TrySound](https://github.com/TrySound) *Bogdan Chadkin* - [@JanMattner](https://github.com/JanMattner) *Jan Mattner* - [@ntwb](https://github.com/ntwb) *Stephen Edgar* - [@kasperisager](https://github.com/kasperisager) *Kasper Isager* - [@sandersn](https://github.com/sandersn) *Nathan Shively-Sanders* # Visitor utilities for AssemblyScript Compiler transformers ## Example ### List Fields The transformer: ```ts import { ClassDeclaration, FieldDeclaration, MethodDeclaration, } from "../../as"; import { ClassDecorator, registerDecorator } from "../decorator"; import { toString } from "../utils"; class ListMembers extends ClassDecorator { visitFieldDeclaration(node: FieldDeclaration): void { if (!node.name) console.log(toString(node) + "\n"); const name = toString(node.name); const _type = toString(node.type!); this.stdout.write(name + ": " + _type + "\n"); } visitMethodDeclaration(node: MethodDeclaration): void { const name = toString(node.name); if (name == "constructor") { return; } const sig = toString(node.signature); this.stdout.write(name + ": " + sig + "\n"); } visitClassDeclaration(node: ClassDeclaration): void { this.visit(node.members); } get name(): string { return "list"; } } export = registerDecorator(new ListMembers()); ``` assembly/foo.ts: ```ts @list class Foo { a: u8; b: bool; i: i32; } ``` And then compile with `--transform` flag: ``` asc assembly/foo.ts --transform ./dist/examples/list --noEmit ``` Which prints the following to the console: ``` a: u8 b: bool i: i32 ``` # assemblyscript-json   JSON encoder / decoder for AssemblyScript. Special thanks to https://github.com/MaxGraey/bignum.wasm for basic unit testing infra for AssemblyScript. ## Installation `assemblyscript-json` is available as a [npm package](https://www.npmjs.com/package/assemblyscript-json). You can install `assemblyscript-json` in your AssemblyScript project by running: `npm install --save assemblyscript-json` ## Usage ### Parsing JSON ```typescript import { JSON } from "assemblyscript-json"; // Parse an object using the JSON object let jsonObj: JSON.Obj = <JSON.Obj>(JSON.parse('{"hello": "world", "value": 24}')); // We can then use the .getX functions to read from the object if you know it's type // This will return the appropriate JSON.X value if the key exists, or null if the key does not exist let worldOrNull: JSON.Str | null = jsonObj.getString("hello"); // This will return a JSON.Str or null if (worldOrNull != null) { // use .valueOf() to turn the high level JSON.Str type into a string let world: string = worldOrNull.valueOf(); } let numOrNull: JSON.Num | null = jsonObj.getNum("value"); if (numOrNull != null) { // use .valueOf() to turn the high level JSON.Num type into a f64 let value: f64 = numOrNull.valueOf(); } // If you don't know the value type, get the parent JSON.Value let valueOrNull: JSON.Value | null = jsonObj.getValue("hello"); if (valueOrNull != null) { let value = <JSON.Value>valueOrNull; // Next we could figure out what type we are if(value.isString) { // value.isString would be true, so we can cast to a string let innerString = (<JSON.Str>value).valueOf(); let jsonString = (<JSON.Str>value).stringify(); // Do something with string value } } ``` ### Encoding JSON ```typescript import { JSONEncoder } from "assemblyscript-json"; // Create encoder let encoder = new JSONEncoder(); // Construct necessary object encoder.pushObject("obj"); encoder.setInteger("int", 10); encoder.setString("str", ""); encoder.popObject(); // Get serialized data let json: Uint8Array = encoder.serialize(); // Or get serialized data as string let jsonString: string = encoder.stringify(); assert(jsonString, '"obj": {"int": 10, "str": ""}'); // True! ``` ### Custom JSON Deserializers ```typescript import { JSONDecoder, JSONHandler } from "assemblyscript-json"; // Events need to be received by custom object extending JSONHandler. // NOTE: All methods are optional to implement. class MyJSONEventsHandler extends JSONHandler { setString(name: string, value: string): void { // Handle field } setBoolean(name: string, value: bool): void { // Handle field } setNull(name: string): void { // Handle field } setInteger(name: string, value: i64): void { // Handle field } setFloat(name: string, value: f64): void { // Handle field } pushArray(name: string): bool { // Handle array start // true means that nested object needs to be traversed, false otherwise // Note that returning false means JSONDecoder.startIndex need to be updated by handler return true; } popArray(): void { // Handle array end } pushObject(name: string): bool { // Handle object start // true means that nested object needs to be traversed, false otherwise // Note that returning false means JSONDecoder.startIndex need to be updated by handler return true; } popObject(): void { // Handle object end } } // Create decoder let decoder = new JSONDecoder<MyJSONEventsHandler>(new MyJSONEventsHandler()); // Create a byte buffer of our JSON. NOTE: Deserializers work on UTF8 string buffers. let jsonString = '{"hello": "world"}'; let jsonBuffer = Uint8Array.wrap(String.UTF8.encode(jsonString)); // Parse JSON decoder.deserialize(jsonBuffer); // This will send events to MyJSONEventsHandler ``` Feel free to look through the [tests](https://github.com/nearprotocol/assemblyscript-json/tree/master/assembly/__tests__) for more usage examples. ## Reference Documentation Reference API Documentation can be found in the [docs directory](./docs). ## License [MIT](./LICENSE) # prelude.ls [](https://travis-ci.org/gkz/prelude-ls) is a functionally oriented utility library. It is powerful and flexible. Almost all of its functions are curried. It is written in, and is the recommended base library for, <a href="http://livescript.net">LiveScript</a>. See **[the prelude.ls site](http://preludels.com)** for examples, a reference, and more. You can install via npm `npm install prelude-ls` ### Development `make test` to test `make build` to build `lib` from `src` `make build-browser` to build browser versions # axios [](https://www.npmjs.org/package/axios) [](https://travis-ci.org/axios/axios) [](https://coveralls.io/r/mzabriskie/axios) [](https://packagephobia.now.sh/result?p=axios) [](http://npm-stat.com/charts.html?package=axios) [](https://gitter.im/mzabriskie/axios) [](https://www.codetriage.com/axios/axios) Promise based HTTP client for the browser and node.js ## Features - Make [XMLHttpRequests](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) from the browser - Make [http](http://nodejs.org/api/http.html) requests from node.js - Supports the [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) API - Intercept request and response - Transform request and response data - Cancel requests - Automatic transforms for JSON data - Client side support for protecting against [XSRF](http://en.wikipedia.org/wiki/Cross-site_request_forgery) ## Browser Support  |  |  |  |  |  | --- | --- | --- | --- | --- | --- | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ | [](https://saucelabs.com/u/axios) ## Installing Using npm: ```bash $ npm install axios ``` Using bower: ```bash $ bower install axios ``` Using yarn: ```bash $ yarn add axios ``` Using cdn: ```html <script src="https://unpkg.com/axios/dist/axios.min.js"></script> ``` ## Example ### note: CommonJS usage In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with `require()` use the following approach: ```js const axios = require('axios').default; // axios.<method> will now provide autocomplete and parameter typings ``` Performing a `GET` request ```js const axios = require('axios'); // Make a request for a user with a given ID axios.get('/user?ID=12345') .then(function (response) { // handle success console.log(response); }) .catch(function (error) { // handle error console.log(error); }) .finally(function () { // always executed }); // Optionally the request above could also be done as axios.get('/user', { params: { ID: 12345 } }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }) .finally(function () { // always executed }); // Want to use async/await? Add the `async` keyword to your outer function/method. async function getUser() { try { const response = await axios.get('/user?ID=12345'); console.log(response); } catch (error) { console.error(error); } } ``` > **NOTE:** `async/await` is part of ECMAScript 2017 and is not supported in Internet > Explorer and older browsers, so use with caution. Performing a `POST` request ```js axios.post('/user', { firstName: 'Fred', lastName: 'Flintstone' }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); ``` Performing multiple concurrent requests ```js function getUserAccount() { return axios.get('/user/12345'); } function getUserPermissions() { return axios.get('/user/12345/permissions'); } axios.all([getUserAccount(), getUserPermissions()]) .then(axios.spread(function (acct, perms) { // Both requests are now complete })); ``` ## axios API Requests can be made by passing the relevant config to `axios`. ##### axios(config) ```js // Send a POST request axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' } }); ``` ```js // GET request for remote image axios({ method: 'get', url: 'http://bit.ly/2mTM3nY', responseType: 'stream' }) .then(function (response) { response.data.pipe(fs.createWriteStream('ada_lovelace.jpg')) }); ``` ##### axios(url[, config]) ```js // Send a GET request (default method) axios('/user/12345'); ``` ### Request method aliases For convenience aliases have been provided for all supported request methods. ##### axios.request(config) ##### axios.get(url[, config]) ##### axios.delete(url[, config]) ##### axios.head(url[, config]) ##### axios.options(url[, config]) ##### axios.post(url[, data[, config]]) ##### axios.put(url[, data[, config]]) ##### axios.patch(url[, data[, config]]) ###### NOTE When using the alias methods `url`, `method`, and `data` properties don't need to be specified in config. ### Concurrency Helper functions for dealing with concurrent requests. ##### axios.all(iterable) ##### axios.spread(callback) ### Creating an instance You can create a new instance of axios with a custom config. ##### axios.create([config]) ```js const instance = axios.create({ baseURL: 'https://some-domain.com/api/', timeout: 1000, headers: {'X-Custom-Header': 'foobar'} }); ``` ### Instance methods The available instance methods are listed below. The specified config will be merged with the instance config. ##### axios#request(config) ##### axios#get(url[, config]) ##### axios#delete(url[, config]) ##### axios#head(url[, config]) ##### axios#options(url[, config]) ##### axios#post(url[, data[, config]]) ##### axios#put(url[, data[, config]]) ##### axios#patch(url[, data[, config]]) ##### axios#getUri([config]) ## Request Config These are the available config options for making requests. Only the `url` is required. Requests will default to `GET` if `method` is not specified. ```js { // `url` is the server URL that will be used for the request url: '/user', // `method` is the request method to be used when making the request method: 'get', // default // `baseURL` will be prepended to `url` unless `url` is absolute. // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs // to methods of that instance. baseURL: 'https://some-domain.com/api/', // `transformRequest` allows changes to the request data before it is sent to the server // This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE' // The last function in the array must return a string or an instance of Buffer, ArrayBuffer, // FormData or Stream // You may modify the headers object. transformRequest: [function (data, headers) { // Do whatever you want to transform the data return data; }], // `transformResponse` allows changes to the response data to be made before // it is passed to then/catch transformResponse: [function (data) { // Do whatever you want to transform the data return data; }], // `headers` are custom headers to be sent headers: {'X-Requested-With': 'XMLHttpRequest'}, // `params` are the URL parameters to be sent with the request // Must be a plain object or a URLSearchParams object params: { ID: 12345 }, // `paramsSerializer` is an optional function in charge of serializing `params` // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/) paramsSerializer: function (params) { return Qs.stringify(params, {arrayFormat: 'brackets'}) }, // `data` is the data to be sent as the request body // Only applicable for request methods 'PUT', 'POST', and 'PATCH' // When no `transformRequest` is set, must be of one of the following types: // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams // - Browser only: FormData, File, Blob // - Node only: Stream, Buffer data: { firstName: 'Fred' }, // syntax alternative to send data into the body // method post // only the value is sent, not the key data: 'Country=Brasil&City=Belo Horizonte', // `timeout` specifies the number of milliseconds before the request times out. // If the request takes longer than `timeout`, the request will be aborted. timeout: 1000, // default is `0` (no timeout) // `withCredentials` indicates whether or not cross-site Access-Control requests // should be made using credentials withCredentials: false, // default // `adapter` allows custom handling of requests which makes testing easier. // Return a promise and supply a valid response (see lib/adapters/README.md). adapter: function (config) { /* ... */ }, // `auth` indicates that HTTP Basic auth should be used, and supplies credentials. // This will set an `Authorization` header, overwriting any existing // `Authorization` custom headers you have set using `headers`. // Please note that only HTTP Basic auth is configurable through this parameter. // For Bearer tokens and such, use `Authorization` custom headers instead. auth: { username: 'janedoe', password: 's00pers3cret' }, // `responseType` indicates the type of data that the server will respond with // options are: 'arraybuffer', 'document', 'json', 'text', 'stream' // browser only: 'blob' responseType: 'json', // default // `responseEncoding` indicates encoding to use for decoding responses // Note: Ignored for `responseType` of 'stream' or client-side requests responseEncoding: 'utf8', // default // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token xsrfCookieName: 'XSRF-TOKEN', // default // `xsrfHeaderName` is the name of the http header that carries the xsrf token value xsrfHeaderName: 'X-XSRF-TOKEN', // default // `onUploadProgress` allows handling of progress events for uploads onUploadProgress: function (progressEvent) { // Do whatever you want with the native progress event }, // `onDownloadProgress` allows handling of progress events for downloads onDownloadProgress: function (progressEvent) { // Do whatever you want with the native progress event }, // `maxContentLength` defines the max size of the http response content in bytes allowed maxContentLength: 2000, // `validateStatus` defines whether to resolve or reject the promise for a given // HTTP response status code. If `validateStatus` returns `true` (or is set to `null` // or `undefined`), the promise will be resolved; otherwise, the promise will be // rejected. validateStatus: function (status) { return status >= 200 && status < 300; // default }, // `maxRedirects` defines the maximum number of redirects to follow in node.js. // If set to 0, no redirects will be followed. maxRedirects: 5, // default // `socketPath` defines a UNIX Socket to be used in node.js. // e.g. '/var/run/docker.sock' to send requests to the docker daemon. // Only either `socketPath` or `proxy` can be specified. // If both are specified, `socketPath` is used. socketPath: null, // default // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http // and https requests, respectively, in node.js. This allows options to be added like // `keepAlive` that are not enabled by default. httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // 'proxy' defines the hostname and port of the proxy server. // You can also define your proxy using the conventional `http_proxy` and // `https_proxy` environment variables. If you are using environment variables // for your proxy configuration, you can also define a `no_proxy` environment // variable as a comma-separated list of domains that should not be proxied. // Use `false` to disable proxies, ignoring environment variables. // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and // supplies credentials. // This will set an `Proxy-Authorization` header, overwriting any existing // `Proxy-Authorization` custom headers you have set using `headers`. proxy: { host: '127.0.0.1', port: 9000, auth: { username: 'mikeymike', password: 'rapunz3l' } }, // `cancelToken` specifies a cancel token that can be used to cancel the request // (see Cancellation section below for details) cancelToken: new CancelToken(function (cancel) { }) } ``` ## Response Schema The response for a request contains the following information. ```js { // `data` is the response that was provided by the server data: {}, // `status` is the HTTP status code from the server response status: 200, // `statusText` is the HTTP status message from the server response statusText: 'OK', // `headers` the headers that the server responded with // All header names are lower cased headers: {}, // `config` is the config that was provided to `axios` for the request config: {}, // `request` is the request that generated this response // It is the last ClientRequest instance in node.js (in redirects) // and an XMLHttpRequest instance in the browser request: {} } ``` When using `then`, you will receive the response as follows: ```js axios.get('/user/12345') .then(function (response) { console.log(response.data); console.log(response.status); console.log(response.statusText); console.log(response.headers); console.log(response.config); }); ``` When using `catch`, or passing a [rejection callback](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then) as second parameter of `then`, the response will be available through the `error` object as explained in the [Handling Errors](#handling-errors) section. ## Config Defaults You can specify config defaults that will be applied to every request. ### Global axios defaults ```js axios.defaults.baseURL = 'https://api.example.com'; axios.defaults.headers.common['Authorization'] = AUTH_TOKEN; axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded'; ``` ### Custom instance defaults ```js // Set config defaults when creating the instance const instance = axios.create({ baseURL: 'https://api.example.com' }); // Alter defaults after instance has been created instance.defaults.headers.common['Authorization'] = AUTH_TOKEN; ``` ### Config order of precedence Config will be merged with an order of precedence. The order is library defaults found in [lib/defaults.js](https://github.com/axios/axios/blob/master/lib/defaults.js#L28), then `defaults` property of the instance, and finally `config` argument for the request. The latter will take precedence over the former. Here's an example. ```js // Create an instance using the config defaults provided by the library // At this point the timeout config value is `0` as is the default for the library const instance = axios.create(); // Override timeout default for the library // Now all requests using this instance will wait 2.5 seconds before timing out instance.defaults.timeout = 2500; // Override timeout for this request as it's known to take a long time instance.get('/longRequest', { timeout: 5000 }); ``` ## Interceptors You can intercept requests or responses before they are handled by `then` or `catch`. ```js // Add a request interceptor axios.interceptors.request.use(function (config) { // Do something before request is sent return config; }, function (error) { // Do something with request error return Promise.reject(error); }); // Add a response interceptor axios.interceptors.response.use(function (response) { // Any status code that lie within the range of 2xx cause this function to trigger // Do something with response data return response; }, function (error) { // Any status codes that falls outside the range of 2xx cause this function to trigger // Do something with response error return Promise.reject(error); }); ``` If you need to remove an interceptor later you can. ```js const myInterceptor = axios.interceptors.request.use(function () {/*...*/}); axios.interceptors.request.eject(myInterceptor); ``` You can add interceptors to a custom instance of axios. ```js const instance = axios.create(); instance.interceptors.request.use(function () {/*...*/}); ``` ## Handling Errors ```js axios.get('/user/12345') .catch(function (error) { if (error.response) { // The request was made and the server responded with a status code // that falls out of the range of 2xx console.log(error.response.data); console.log(error.response.status); console.log(error.response.headers); } else if (error.request) { // The request was made but no response was received // `error.request` is an instance of XMLHttpRequest in the browser and an instance of // http.ClientRequest in node.js console.log(error.request); } else { // Something happened in setting up the request that triggered an Error console.log('Error', error.message); } console.log(error.config); }); ``` Using the `validateStatus` config option, you can define HTTP code(s) that should throw an error. ```js axios.get('/user/12345', { validateStatus: function (status) { return status < 500; // Reject only if the status code is greater than or equal to 500 } }) ``` Using `toJSON` you get an object with more information about the HTTP error. ```js axios.get('/user/12345') .catch(function (error) { console.log(error.toJSON()); }); ``` ## Cancellation You can cancel a request using a *cancel token*. > The axios cancel token API is based on the withdrawn [cancelable promises proposal](https://github.com/tc39/proposal-cancelable-promises). You can create a cancel token using the `CancelToken.source` factory as shown below: ```js const CancelToken = axios.CancelToken; const source = CancelToken.source(); axios.get('/user/12345', { cancelToken: source.token }).catch(function (thrown) { if (axios.isCancel(thrown)) { console.log('Request canceled', thrown.message); } else { // handle error } }); axios.post('/user/12345', { name: 'new name' }, { cancelToken: source.token }) // cancel the request (the message parameter is optional) source.cancel('Operation canceled by the user.'); ``` You can also create a cancel token by passing an executor function to the `CancelToken` constructor: ```js const CancelToken = axios.CancelToken; let cancel; axios.get('/user/12345', { cancelToken: new CancelToken(function executor(c) { // An executor function receives a cancel function as a parameter cancel = c; }) }); // cancel the request cancel(); ``` > Note: you can cancel several requests with the same cancel token. ## Using application/x-www-form-urlencoded format By default, axios serializes JavaScript objects to `JSON`. To send data in the `application/x-www-form-urlencoded` format instead, you can use one of the following options. ### Browser In a browser, you can use the [`URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) API as follows: ```js const params = new URLSearchParams(); params.append('param1', 'value1'); params.append('param2', 'value2'); axios.post('/foo', params); ``` > Note that `URLSearchParams` is not supported by all browsers (see [caniuse.com](http://www.caniuse.com/#feat=urlsearchparams)), but there is a [polyfill](https://github.com/WebReflection/url-search-params) available (make sure to polyfill the global environment). Alternatively, you can encode data using the [`qs`](https://github.com/ljharb/qs) library: ```js const qs = require('qs'); axios.post('/foo', qs.stringify({ 'bar': 123 })); ``` Or in another way (ES6), ```js import qs from 'qs'; const data = { 'bar': 123 }; const options = { method: 'POST', headers: { 'content-type': 'application/x-www-form-urlencoded' }, data: qs.stringify(data), url, }; axios(options); ``` ### Node.js In node.js, you can use the [`querystring`](https://nodejs.org/api/querystring.html) module as follows: ```js const querystring = require('querystring'); axios.post('http://something.com/', querystring.stringify({ foo: 'bar' })); ``` You can also use the [`qs`](https://github.com/ljharb/qs) library. ###### NOTE The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has known issues with that use case (https://github.com/nodejs/node-v0.x-archive/issues/1665). ## Semver Until axios reaches a `1.0` release, breaking changes will be released with a new minor version. For example `0.5.1`, and `0.5.4` will have the same API, but `0.6.0` will have breaking changes. ## Promises axios depends on a native ES6 Promise implementation to be [supported](http://caniuse.com/promises). If your environment doesn't support ES6 Promises, you can [polyfill](https://github.com/jakearchibald/es6-promise). ## TypeScript axios includes [TypeScript](http://typescriptlang.org) definitions. ```typescript import axios from 'axios'; axios.get('/user?ID=12345'); ``` ## Resources * [Changelog](https://github.com/axios/axios/blob/master/CHANGELOG.md) * [Upgrade Guide](https://github.com/axios/axios/blob/master/UPGRADE_GUIDE.md) * [Ecosystem](https://github.com/axios/axios/blob/master/ECOSYSTEM.md) * [Contributing Guide](https://github.com/axios/axios/blob/master/CONTRIBUTING.md) * [Code of Conduct](https://github.com/axios/axios/blob/master/CODE_OF_CONDUCT.md) ## Credits axios is heavily inspired by the [$http service](https://docs.angularjs.org/api/ng/service/$http) provided in [Angular](https://angularjs.org/). Ultimately axios is an effort to provide a standalone `$http`-like service for use outside of Angular. ## License [MIT](LICENSE) # node-tar [](https://travis-ci.org/npm/node-tar) [Fast](./benchmarks) and full-featured Tar for Node.js The API is designed to mimic the behavior of `tar(1)` on unix systems. If you are familiar with how tar works, most of this will hopefully be straightforward for you. If not, then hopefully this module can teach you useful unix skills that may come in handy someday :) ## Background A "tar file" or "tarball" is an archive of file system entries (directories, files, links, etc.) The name comes from "tape archive". If you run `man tar` on almost any Unix command line, you'll learn quite a bit about what it can do, and its history. Tar has 5 main top-level commands: * `c` Create an archive * `r` Replace entries within an archive * `u` Update entries within an archive (ie, replace if they're newer) * `t` List out the contents of an archive * `x` Extract an archive to disk The other flags and options modify how this top level function works. ## High-Level API These 5 functions are the high-level API. All of them have a single-character name (for unix nerds familiar with `tar(1)`) as well as a long name (for everyone else). All the high-level functions take the following arguments, all three of which are optional and may be omitted. 1. `options` - An optional object specifying various options 2. `paths` - An array of paths to add or extract 3. `callback` - Called when the command is completed, if async. (If sync or no file specified, providing a callback throws a `TypeError`.) If the command is sync (ie, if `options.sync=true`), then the callback is not allowed, since the action will be completed immediately. If a `file` argument is specified, and the command is async, then a `Promise` is returned. In this case, if async, a callback may be provided which is called when the command is completed. If a `file` option is not specified, then a stream is returned. For `create`, this is a readable stream of the generated archive. For `list` and `extract` this is a writable stream that an archive should be written into. If a file is not specified, then a callback is not allowed, because you're already getting a stream to work with. `replace` and `update` only work on existing archives, and so require a `file` argument. Sync commands without a file argument return a stream that acts on its input immediately in the same tick. For readable streams, this means that all of the data is immediately available by calling `stream.read()`. For writable streams, it will be acted upon as soon as it is provided, but this can be at any time. ### Warnings and Errors Tar emits warnings and errors for recoverable and unrecoverable situations, respectively. In many cases, a warning only affects a single entry in an archive, or is simply informing you that it's modifying an entry to comply with the settings provided. Unrecoverable warnings will always raise an error (ie, emit `'error'` on streaming actions, throw for non-streaming sync actions, reject the returned Promise for non-streaming async operations, or call a provided callback with an `Error` as the first argument). Recoverable errors will raise an error only if `strict: true` is set in the options. Respond to (recoverable) warnings by listening to the `warn` event. Handlers receive 3 arguments: - `code` String. One of the error codes below. This may not match `data.code`, which preserves the original error code from fs and zlib. - `message` String. More details about the error. - `data` Metadata about the error. An `Error` object for errors raised by fs and zlib. All fields are attached to errors raisd by tar. Typically contains the following fields, as relevant: - `tarCode` The tar error code. - `code` Either the tar error code, or the error code set by the underlying system. - `file` The archive file being read or written. - `cwd` Working directory for creation and extraction operations. - `entry` The entry object (if it could be created) for `TAR_ENTRY_INFO`, `TAR_ENTRY_INVALID`, and `TAR_ENTRY_ERROR` warnings. - `header` The header object (if it could be created, and the entry could not be created) for `TAR_ENTRY_INFO` and `TAR_ENTRY_INVALID` warnings. - `recoverable` Boolean. If `false`, then the warning will emit an `error`, even in non-strict mode. #### Error Codes * `TAR_ENTRY_INFO` An informative error indicating that an entry is being modified, but otherwise processed normally. For example, removing `/` or `C:\` from absolute paths if `preservePaths` is not set. * `TAR_ENTRY_INVALID` An indication that a given entry is not a valid tar archive entry, and will be skipped. This occurs when: - a checksum fails, - a `linkpath` is missing for a link type, or - a `linkpath` is provided for a non-link type. If every entry in a parsed archive raises an `TAR_ENTRY_INVALID` error, then the archive is presumed to be unrecoverably broken, and `TAR_BAD_ARCHIVE` will be raised. * `TAR_ENTRY_ERROR` The entry appears to be a valid tar archive entry, but encountered an error which prevented it from being unpacked. This occurs when: - an unrecoverable fs error happens during unpacking, - an entry has `..` in the path and `preservePaths` is not set, or - an entry is extracting through a symbolic link, when `preservePaths` is not set. * `TAR_ENTRY_UNSUPPORTED` An indication that a given entry is a valid archive entry, but of a type that is unsupported, and so will be skipped in archive creation or extracting. * `TAR_ABORT` When parsing gzipped-encoded archives, the parser will abort the parse process raise a warning for any zlib errors encountered. Aborts are considered unrecoverable for both parsing and unpacking. * `TAR_BAD_ARCHIVE` The archive file is totally hosed. This can happen for a number of reasons, and always occurs at the end of a parse or extract: - An entry body was truncated before seeing the full number of bytes. - The archive contained only invalid entries, indicating that it is likely not an archive, or at least, not an archive this library can parse. `TAR_BAD_ARCHIVE` is considered informative for parse operations, but unrecoverable for extraction. Note that, if encountered at the end of an extraction, tar WILL still have extracted as much it could from the archive, so there may be some garbage files to clean up. Errors that occur deeper in the system (ie, either the filesystem or zlib) will have their error codes left intact, and a `tarCode` matching one of the above will be added to the warning metadata or the raised error object. Errors generated by tar will have one of the above codes set as the `error.code` field as well, but since errors originating in zlib or fs will have their original codes, it's better to read `error.tarCode` if you wish to see how tar is handling the issue. ### Examples The API mimics the `tar(1)` command line functionality, with aliases for more human-readable option and function names. The goal is that if you know how to use `tar(1)` in Unix, then you know how to use `require('tar')` in JavaScript. To replicate `tar czf my-tarball.tgz files and folders`, you'd do: ```js tar.c( { gzip: <true|gzip options>, file: 'my-tarball.tgz' }, ['some', 'files', 'and', 'folders'] ).then(_ => { .. tarball has been created .. }) ``` To replicate `tar cz files and folders > my-tarball.tgz`, you'd do: ```js tar.c( // or tar.create { gzip: <true|gzip options> }, ['some', 'files', 'and', 'folders'] ).pipe(fs.createWriteStream('my-tarball.tgz')) ``` To replicate `tar xf my-tarball.tgz` you'd do: ```js tar.x( // or tar.extract( { file: 'my-tarball.tgz' } ).then(_=> { .. tarball has been dumped in cwd .. }) ``` To replicate `cat my-tarball.tgz | tar x -C some-dir --strip=1`: ```js fs.createReadStream('my-tarball.tgz').pipe( tar.x({ strip: 1, C: 'some-dir' // alias for cwd:'some-dir', also ok }) ) ``` To replicate `tar tf my-tarball.tgz`, do this: ```js tar.t({ file: 'my-tarball.tgz', onentry: entry => { .. do whatever with it .. } }) ``` To replicate `cat my-tarball.tgz | tar t` do: ```js fs.createReadStream('my-tarball.tgz') .pipe(tar.t()) .on('entry', entry => { .. do whatever with it .. }) ``` To do anything synchronous, add `sync: true` to the options. Note that sync functions don't take a callback and don't return a promise. When the function returns, it's already done. Sync methods without a file argument return a sync stream, which flushes immediately. But, of course, it still won't be done until you `.end()` it. To filter entries, add `filter: <function>` to the options. Tar-creating methods call the filter with `filter(path, stat)`. Tar-reading methods (including extraction) call the filter with `filter(path, entry)`. The filter is called in the `this`-context of the `Pack` or `Unpack` stream object. The arguments list to `tar t` and `tar x` specify a list of filenames to extract or list, so they're equivalent to a filter that tests if the file is in the list. For those who _aren't_ fans of tar's single-character command names: ``` tar.c === tar.create tar.r === tar.replace (appends to archive, file is required) tar.u === tar.update (appends if newer, file is required) tar.x === tar.extract tar.t === tar.list ``` Keep reading for all the command descriptions and options, as well as the low-level API that they are built on. ### tar.c(options, fileList, callback) [alias: tar.create] Create a tarball archive. The `fileList` is an array of paths to add to the tarball. Adding a directory also adds its children recursively. An entry in `fileList` that starts with an `@` symbol is a tar archive whose entries will be added. To add a file that starts with `@`, prepend it with `./`. The following options are supported: - `file` Write the tarball archive to the specified filename. If this is specified, then the callback will be fired when the file has been written, and a promise will be returned that resolves when the file is written. If a filename is not specified, then a Readable Stream will be returned which will emit the file data. [Alias: `f`] - `sync` Act synchronously. If this is set, then any provided file will be fully written after the call to `tar.c`. If this is set, and a file is not provided, then the resulting stream will already have the data ready to `read` or `emit('data')` as soon as you request it. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `strict` Treat warnings as crash-worthy errors. Default false. - `cwd` The current working directory for creating the archive. Defaults to `process.cwd()`. [Alias: `C`] - `prefix` A path portion to prefix onto the entries in the archive. - `gzip` Set to any truthy value to create a gzipped archive, or an object with settings for `zlib.Gzip()` [Alias: `z`] - `filter` A function that gets called with `(path, stat)` for each entry being added. Return `true` to add the entry to the archive, or `false` to omit it. - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. [Alias: `P`] - `mode` The mode to set on the created file archive - `noDirRecurse` Do not recursively archive the contents of directories. [Alias: `n`] - `follow` Set to true to pack the targets of symbolic links. Without this option, symbolic links are archived as such. [Alias: `L`, `h`] - `noPax` Suppress pax extended headers. Note that this means that long paths and linkpaths will be truncated, and large or negative numeric values may be interpreted incorrectly. - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. [Alias: `m`, `no-mtime`] - `mtime` Set to a `Date` object to force a specific `mtime` for everything added to the archive. Overridden by `noMtime`. The following options are mostly internal, but can be modified in some advanced use cases, such as re-using caches between runs. - `linkCache` A Map object containing the device and inode value for any file whose nlink is > 1, to identify hard links. - `statCache` A Map object that caches calls `lstat`. - `readdirCache` A Map object that caches calls to `readdir`. - `jobs` A number specifying how many concurrent jobs to run. Defaults to 4. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. ### tar.x(options, fileList, callback) [alias: tar.extract] Extract a tarball archive. The `fileList` is an array of paths to extract from the tarball. If no paths are provided, then all the entries are extracted. If the archive is gzipped, then tar will detect this and unzip it. Note that all directories that are created will be forced to be writable, readable, and listable by their owner, to avoid cases where a directory prevents extraction of child entries by virtue of its mode. Most extraction errors will cause a `warn` event to be emitted. If the `cwd` is missing, or not a directory, then the extraction will fail completely. The following options are supported: - `cwd` Extract files relative to the specified directory. Defaults to `process.cwd()`. If provided, this must exist and must be a directory. [Alias: `C`] - `file` The archive file to extract. If not specified, then a Writable stream is returned where the archive data should be written. [Alias: `f`] - `sync` Create files and directories synchronously. - `strict` Treat warnings as crash-worthy errors. Default false. - `filter` A function that gets called with `(path, entry)` for each entry being unpacked. Return `true` to unpack the entry from the archive, or `false` to skip it. - `newer` Set to true to keep the existing file on disk if it's newer than the file in the archive. [Alias: `keep-newer`, `keep-newer-files`] - `keep` Do not overwrite existing files. In particular, if a file appears more than once in an archive, later copies will not overwrite earlier copies. [Alias: `k`, `keep-existing`] - `preservePaths` Allow absolute paths, paths containing `..`, and extracting through symbolic links. By default, `/` is stripped from absolute paths, `..` paths are not extracted, and any file whose location would be modified by a symbolic link is not extracted. [Alias: `P`] - `unlink` Unlink files before creating them. Without this option, tar overwrites existing files, which preserves existing hardlinks. With this option, existing hardlinks will be broken, as will any symlink that would affect the location of an extracted file. [Alias: `U`] - `strip` Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. Note that the pathname is edited after applying the filter, but before security checks. [Alias: `strip-components`, `stripComponents`] - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `preserveOwner` If true, tar will set the `uid` and `gid` of extracted entries to the `uid` and `gid` fields in the archive. This defaults to true when run as root, and false otherwise. If false, then files and directories will be set with the owner and group of the user running the process. This is similar to `-p` in `tar(1)`, but ACLs and other system-specific data is never unpacked in this implementation, and modes are set by default already. [Alias: `p`] - `uid` Set to a number to force ownership of all extracted files and folders, and all implicitly created directories, to be owned by the specified user id, regardless of the `uid` field in the archive. Cannot be used along with `preserveOwner`. Requires also setting a `gid` option. - `gid` Set to a number to force ownership of all extracted files and folders, and all implicitly created directories, to be owned by the specified group id, regardless of the `gid` field in the archive. Cannot be used along with `preserveOwner`. Requires also setting a `uid` option. - `noMtime` Set to true to omit writing `mtime` value for extracted entries. [Alias: `m`, `no-mtime`] - `transform` Provide a function that takes an `entry` object, and returns a stream, or any falsey value. If a stream is provided, then that stream's data will be written instead of the contents of the archive entry. If a falsey value is provided, then the entry is written to disk as normal. (To exclude items from extraction, use the `filter` option described above.) - `onentry` A function that gets called with `(entry)` for each entry that passes the filter. The following options are mostly internal, but can be modified in some advanced use cases, such as re-using caches between runs. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. - `umask` Filter the modes of entries like `process.umask()`. - `dmode` Default mode for directories - `fmode` Default mode for files - `dirCache` A Map object of which directories exist. - `maxMetaEntrySize` The maximum size of meta entries that is supported. Defaults to 1 MB. Note that using an asynchronous stream type with the `transform` option will cause undefined behavior in sync extractions. [MiniPass](http://npm.im/minipass)-based streams are designed for this use case. ### tar.t(options, fileList, callback) [alias: tar.list] List the contents of a tarball archive. The `fileList` is an array of paths to list from the tarball. If no paths are provided, then all the entries are listed. If the archive is gzipped, then tar will detect this and unzip it. Returns an event emitter that emits `entry` events with `tar.ReadEntry` objects. However, they don't emit `'data'` or `'end'` events. (If you want to get actual readable entries, use the `tar.Parse` class instead.) The following options are supported: - `cwd` Extract files relative to the specified directory. Defaults to `process.cwd()`. [Alias: `C`] - `file` The archive file to list. If not specified, then a Writable stream is returned where the archive data should be written. [Alias: `f`] - `sync` Read the specified file synchronously. (This has no effect when a file option isn't specified, because entries are emitted as fast as they are parsed from the stream anyway.) - `strict` Treat warnings as crash-worthy errors. Default false. - `filter` A function that gets called with `(path, entry)` for each entry being listed. Return `true` to emit the entry from the archive, or `false` to skip it. - `onentry` A function that gets called with `(entry)` for each entry that passes the filter. This is important for when both `file` and `sync` are set, because it will be called synchronously. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. - `noResume` By default, `entry` streams are resumed immediately after the call to `onentry`. Set `noResume: true` to suppress this behavior. Note that by opting into this, the stream will never complete until the entry data is consumed. ### tar.u(options, fileList, callback) [alias: tar.update] Add files to an archive if they are newer than the entry already in the tarball archive. The `fileList` is an array of paths to add to the tarball. Adding a directory also adds its children recursively. An entry in `fileList` that starts with an `@` symbol is a tar archive whose entries will be added. To add a file that starts with `@`, prepend it with `./`. The following options are supported: - `file` Required. Write the tarball archive to the specified filename. [Alias: `f`] - `sync` Act synchronously. If this is set, then any provided file will be fully written after the call to `tar.c`. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `strict` Treat warnings as crash-worthy errors. Default false. - `cwd` The current working directory for adding entries to the archive. Defaults to `process.cwd()`. [Alias: `C`] - `prefix` A path portion to prefix onto the entries in the archive. - `gzip` Set to any truthy value to create a gzipped archive, or an object with settings for `zlib.Gzip()` [Alias: `z`] - `filter` A function that gets called with `(path, stat)` for each entry being added. Return `true` to add the entry to the archive, or `false` to omit it. - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. [Alias: `P`] - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. - `noDirRecurse` Do not recursively archive the contents of directories. [Alias: `n`] - `follow` Set to true to pack the targets of symbolic links. Without this option, symbolic links are archived as such. [Alias: `L`, `h`] - `noPax` Suppress pax extended headers. Note that this means that long paths and linkpaths will be truncated, and large or negative numeric values may be interpreted incorrectly. - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. [Alias: `m`, `no-mtime`] - `mtime` Set to a `Date` object to force a specific `mtime` for everything added to the archive. Overridden by `noMtime`. ### tar.r(options, fileList, callback) [alias: tar.replace] Add files to an existing archive. Because later entries override earlier entries, this effectively replaces any existing entries. The `fileList` is an array of paths to add to the tarball. Adding a directory also adds its children recursively. An entry in `fileList` that starts with an `@` symbol is a tar archive whose entries will be added. To add a file that starts with `@`, prepend it with `./`. The following options are supported: - `file` Required. Write the tarball archive to the specified filename. [Alias: `f`] - `sync` Act synchronously. If this is set, then any provided file will be fully written after the call to `tar.c`. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `strict` Treat warnings as crash-worthy errors. Default false. - `cwd` The current working directory for adding entries to the archive. Defaults to `process.cwd()`. [Alias: `C`] - `prefix` A path portion to prefix onto the entries in the archive. - `gzip` Set to any truthy value to create a gzipped archive, or an object with settings for `zlib.Gzip()` [Alias: `z`] - `filter` A function that gets called with `(path, stat)` for each entry being added. Return `true` to add the entry to the archive, or `false` to omit it. - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. [Alias: `P`] - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. - `noDirRecurse` Do not recursively archive the contents of directories. [Alias: `n`] - `follow` Set to true to pack the targets of symbolic links. Without this option, symbolic links are archived as such. [Alias: `L`, `h`] - `noPax` Suppress pax extended headers. Note that this means that long paths and linkpaths will be truncated, and large or negative numeric values may be interpreted incorrectly. - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. [Alias: `m`, `no-mtime`] - `mtime` Set to a `Date` object to force a specific `mtime` for everything added to the archive. Overridden by `noMtime`. ## Low-Level API ### class tar.Pack A readable tar stream. Has all the standard readable stream interface stuff. `'data'` and `'end'` events, `read()` method, `pause()` and `resume()`, etc. #### constructor(options) The following options are supported: - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `strict` Treat warnings as crash-worthy errors. Default false. - `cwd` The current working directory for creating the archive. Defaults to `process.cwd()`. - `prefix` A path portion to prefix onto the entries in the archive. - `gzip` Set to any truthy value to create a gzipped archive, or an object with settings for `zlib.Gzip()` - `filter` A function that gets called with `(path, stat)` for each entry being added. Return `true` to add the entry to the archive, or `false` to omit it. - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. - `linkCache` A Map object containing the device and inode value for any file whose nlink is > 1, to identify hard links. - `statCache` A Map object that caches calls `lstat`. - `readdirCache` A Map object that caches calls to `readdir`. - `jobs` A number specifying how many concurrent jobs to run. Defaults to 4. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 16 MB. - `noDirRecurse` Do not recursively archive the contents of directories. - `follow` Set to true to pack the targets of symbolic links. Without this option, symbolic links are archived as such. - `noPax` Suppress pax extended headers. Note that this means that long paths and linkpaths will be truncated, and large or negative numeric values may be interpreted incorrectly. - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. - `mtime` Set to a `Date` object to force a specific `mtime` for everything added to the archive. Overridden by `noMtime`. #### add(path) Adds an entry to the archive. Returns the Pack stream. #### write(path) Adds an entry to the archive. Returns true if flushed. #### end() Finishes the archive. ### class tar.Pack.Sync Synchronous version of `tar.Pack`. ### class tar.Unpack A writable stream that unpacks a tar archive onto the file system. All the normal writable stream stuff is supported. `write()` and `end()` methods, `'drain'` events, etc. Note that all directories that are created will be forced to be writable, readable, and listable by their owner, to avoid cases where a directory prevents extraction of child entries by virtue of its mode. `'close'` is emitted when it's done writing stuff to the file system. Most unpack errors will cause a `warn` event to be emitted. If the `cwd` is missing, or not a directory, then an error will be emitted. #### constructor(options) - `cwd` Extract files relative to the specified directory. Defaults to `process.cwd()`. If provided, this must exist and must be a directory. - `filter` A function that gets called with `(path, entry)` for each entry being unpacked. Return `true` to unpack the entry from the archive, or `false` to skip it. - `newer` Set to true to keep the existing file on disk if it's newer than the file in the archive. - `keep` Do not overwrite existing files. In particular, if a file appears more than once in an archive, later copies will not overwrite earlier copies. - `preservePaths` Allow absolute paths, paths containing `..`, and extracting through symbolic links. By default, `/` is stripped from absolute paths, `..` paths are not extracted, and any file whose location would be modified by a symbolic link is not extracted. - `unlink` Unlink files before creating them. Without this option, tar overwrites existing files, which preserves existing hardlinks. With this option, existing hardlinks will be broken, as will any symlink that would affect the location of an extracted file. - `strip` Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped. Note that the pathname is edited after applying the filter, but before security checks. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `umask` Filter the modes of entries like `process.umask()`. - `dmode` Default mode for directories - `fmode` Default mode for files - `dirCache` A Map object of which directories exist. - `maxMetaEntrySize` The maximum size of meta entries that is supported. Defaults to 1 MB. - `preserveOwner` If true, tar will set the `uid` and `gid` of extracted entries to the `uid` and `gid` fields in the archive. This defaults to true when run as root, and false otherwise. If false, then files and directories will be set with the owner and group of the user running the process. This is similar to `-p` in `tar(1)`, but ACLs and other system-specific data is never unpacked in this implementation, and modes are set by default already. - `win32` True if on a windows platform. Causes behavior where filenames containing `<|>?` chars are converted to windows-compatible values while being unpacked. - `uid` Set to a number to force ownership of all extracted files and folders, and all implicitly created directories, to be owned by the specified user id, regardless of the `uid` field in the archive. Cannot be used along with `preserveOwner`. Requires also setting a `gid` option. - `gid` Set to a number to force ownership of all extracted files and folders, and all implicitly created directories, to be owned by the specified group id, regardless of the `gid` field in the archive. Cannot be used along with `preserveOwner`. Requires also setting a `uid` option. - `noMtime` Set to true to omit writing `mtime` value for extracted entries. - `transform` Provide a function that takes an `entry` object, and returns a stream, or any falsey value. If a stream is provided, then that stream's data will be written instead of the contents of the archive entry. If a falsey value is provided, then the entry is written to disk as normal. (To exclude items from extraction, use the `filter` option described above.) - `strict` Treat warnings as crash-worthy errors. Default false. - `onentry` A function that gets called with `(entry)` for each entry that passes the filter. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") ### class tar.Unpack.Sync Synchronous version of `tar.Unpack`. Note that using an asynchronous stream type with the `transform` option will cause undefined behavior in sync unpack streams. [MiniPass](http://npm.im/minipass)-based streams are designed for this use case. ### class tar.Parse A writable stream that parses a tar archive stream. All the standard writable stream stuff is supported. If the archive is gzipped, then tar will detect this and unzip it. Emits `'entry'` events with `tar.ReadEntry` objects, which are themselves readable streams that you can pipe wherever. Each `entry` will not emit until the one before it is flushed through, so make sure to either consume the data (with `on('data', ...)` or `.pipe(...)`) or throw it away with `.resume()` to keep the stream flowing. #### constructor(options) Returns an event emitter that emits `entry` events with `tar.ReadEntry` objects. The following options are supported: - `strict` Treat warnings as crash-worthy errors. Default false. - `filter` A function that gets called with `(path, entry)` for each entry being listed. Return `true` to emit the entry from the archive, or `false` to skip it. - `onentry` A function that gets called with `(entry)` for each entry that passes the filter. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") #### abort(error) Stop all parsing activities. This is called when there are zlib errors. It also emits an unrecoverable warning with the error provided. ### class tar.ReadEntry extends [MiniPass](http://npm.im/minipass) A representation of an entry that is being read out of a tar archive. It has the following fields: - `extended` The extended metadata object provided to the constructor. - `globalExtended` The global extended metadata object provided to the constructor. - `remain` The number of bytes remaining to be written into the stream. - `blockRemain` The number of 512-byte blocks remaining to be written into the stream. - `ignore` Whether this entry should be ignored. - `meta` True if this represents metadata about the next entry, false if it represents a filesystem object. - All the fields from the header, extended header, and global extended header are added to the ReadEntry object. So it has `path`, `type`, `size, `mode`, and so on. #### constructor(header, extended, globalExtended) Create a new ReadEntry object with the specified header, extended header, and global extended header values. ### class tar.WriteEntry extends [MiniPass](http://npm.im/minipass) A representation of an entry that is being written from the file system into a tar archive. Emits data for the Header, and for the Pax Extended Header if one is required, as well as any body data. Creating a WriteEntry for a directory does not also create WriteEntry objects for all of the directory contents. It has the following fields: - `path` The path field that will be written to the archive. By default, this is also the path from the cwd to the file system object. - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `myuid` If supported, the uid of the user running the current process. - `myuser` The `env.USER` string if set, or `''`. Set as the entry `uname` field if the file's `uid` matches `this.myuid`. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 1 MB. - `linkCache` A Map object containing the device and inode value for any file whose nlink is > 1, to identify hard links. - `statCache` A Map object that caches calls `lstat`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. - `cwd` The current working directory for creating the archive. Defaults to `process.cwd()`. - `absolute` The absolute path to the entry on the filesystem. By default, this is `path.resolve(this.cwd, this.path)`, but it can be overridden explicitly. - `strict` Treat warnings as crash-worthy errors. Default false. - `win32` True if on a windows platform. Causes behavior where paths replace `\` with `/` and filenames containing the windows-compatible forms of `<|>?:` characters are converted to actual `<|>?:` characters in the archive. - `noPax` Suppress pax extended headers. Note that this means that long paths and linkpaths will be truncated, and large or negative numeric values may be interpreted incorrectly. - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. #### constructor(path, options) `path` is the path of the entry as it is written in the archive. The following options are supported: - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `maxReadSize` The maximum buffer size for `fs.read()` operations. Defaults to 1 MB. - `linkCache` A Map object containing the device and inode value for any file whose nlink is > 1, to identify hard links. - `statCache` A Map object that caches calls `lstat`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. - `cwd` The current working directory for creating the archive. Defaults to `process.cwd()`. - `absolute` The absolute path to the entry on the filesystem. By default, this is `path.resolve(this.cwd, this.path)`, but it can be overridden explicitly. - `strict` Treat warnings as crash-worthy errors. Default false. - `win32` True if on a windows platform. Causes behavior where paths replace `\` with `/`. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. - `umask` Set to restrict the modes on the entries in the archive, somewhat like how umask works on file creation. Defaults to `process.umask()` on unix systems, or `0o22` on Windows. #### warn(message, data) If strict, emit an error with the provided message. Othewise, emit a `'warn'` event with the provided message and data. ### class tar.WriteEntry.Sync Synchronous version of tar.WriteEntry ### class tar.WriteEntry.Tar A version of tar.WriteEntry that gets its data from a tar.ReadEntry instead of from the filesystem. #### constructor(readEntry, options) `readEntry` is the entry being read out of another archive. The following options are supported: - `portable` Omit metadata that is system-specific: `ctime`, `atime`, `uid`, `gid`, `uname`, `gname`, `dev`, `ino`, and `nlink`. Note that `mtime` is still included, because this is necessary for other time-based operations. Additionally, `mode` is set to a "reasonable default" for most unix systems, based on a `umask` value of `0o22`. - `preservePaths` Allow absolute paths. By default, `/` is stripped from absolute paths. - `strict` Treat warnings as crash-worthy errors. Default false. - `onwarn` A function that will get called with `(code, message, data)` for any warnings encountered. (See "Warnings and Errors") - `noMtime` Set to true to omit writing `mtime` values for entries. Note that this prevents using other mtime-based features like `tar.update` or the `keepNewer` option with the resulting tar archive. ### class tar.Header A class for reading and writing header blocks. It has the following fields: - `nullBlock` True if decoding a block which is entirely composed of `0x00` null bytes. (Useful because tar files are terminated by at least 2 null blocks.) - `cksumValid` True if the checksum in the header is valid, false otherwise. - `needPax` True if the values, as encoded, will require a Pax extended header. - `path` The path of the entry. - `mode` The 4 lowest-order octal digits of the file mode. That is, read/write/execute permissions for world, group, and owner, and the setuid, setgid, and sticky bits. - `uid` Numeric user id of the file owner - `gid` Numeric group id of the file owner - `size` Size of the file in bytes - `mtime` Modified time of the file - `cksum` The checksum of the header. This is generated by adding all the bytes of the header block, treating the checksum field itself as all ascii space characters (that is, `0x20`). - `type` The human-readable name of the type of entry this represents, or the alphanumeric key if unknown. - `typeKey` The alphanumeric key for the type of entry this header represents. - `linkpath` The target of Link and SymbolicLink entries. - `uname` Human-readable user name of the file owner - `gname` Human-readable group name of the file owner - `devmaj` The major portion of the device number. Always `0` for files, directories, and links. - `devmin` The minor portion of the device number. Always `0` for files, directories, and links. - `atime` File access time. - `ctime` File change time. #### constructor(data, [offset=0]) `data` is optional. It is either a Buffer that should be interpreted as a tar Header starting at the specified offset and continuing for 512 bytes, or a data object of keys and values to set on the header object, and eventually encode as a tar Header. #### decode(block, offset) Decode the provided buffer starting at the specified offset. Buffer length must be greater than 512 bytes. #### set(data) Set the fields in the data object. #### encode(buffer, offset) Encode the header fields into the buffer at the specified offset. Returns `this.needPax` to indicate whether a Pax Extended Header is required to properly encode the specified data. ### class tar.Pax An object representing a set of key-value pairs in an Pax extended header entry. It has the following fields. Where the same name is used, they have the same semantics as the tar.Header field of the same name. - `global` True if this represents a global extended header, or false if it is for a single entry. - `atime` - `charset` - `comment` - `ctime` - `gid` - `gname` - `linkpath` - `mtime` - `path` - `size` - `uid` - `uname` - `dev` - `ino` - `nlink` #### constructor(object, global) Set the fields set in the object. `global` is a boolean that defaults to false. #### encode() Return a Buffer containing the header and body for the Pax extended header entry, or `null` if there is nothing to encode. #### encodeBody() Return a string representing the body of the pax extended header entry. #### encodeField(fieldName) Return a string representing the key/value encoding for the specified fieldName, or `''` if the field is unset. ### tar.Pax.parse(string, extended, global) Return a new Pax object created by parsing the contents of the string provided. If the `extended` object is set, then also add the fields from that object. (This is necessary because multiple metadata entries can occur in sequence.) ### tar.types A translation table for the `type` field in tar headers. #### tar.types.name.get(code) Get the human-readable name for a given alphanumeric code. #### tar.types.code.get(name) Get the alphanumeric code for a given human-readable name. ESQuery is a library for querying the AST output by Esprima for patterns of syntax using a CSS style selector system. Check out the demo: [demo](https://estools.github.io/esquery/) The following selectors are supported: * AST node type: `ForStatement` * [wildcard](http://dev.w3.org/csswg/selectors4/#universal-selector): `*` * [attribute existence](http://dev.w3.org/csswg/selectors4/#attribute-selectors): `[attr]` * [attribute value](http://dev.w3.org/csswg/selectors4/#attribute-selectors): `[attr="foo"]` or `[attr=123]` * attribute regex: `[attr=/foo.*/]` or (with flags) `[attr=/foo.*/is]` * attribute conditions: `[attr!="foo"]`, `[attr>2]`, `[attr<3]`, `[attr>=2]`, or `[attr<=3]` * nested attribute: `[attr.level2="foo"]` * field: `FunctionDeclaration > Identifier.id` * [First](http://dev.w3.org/csswg/selectors4/#the-first-child-pseudo) or [last](http://dev.w3.org/csswg/selectors4/#the-last-child-pseudo) child: `:first-child` or `:last-child` * [nth-child](http://dev.w3.org/csswg/selectors4/#the-nth-child-pseudo) (no ax+b support): `:nth-child(2)` * [nth-last-child](http://dev.w3.org/csswg/selectors4/#the-nth-last-child-pseudo) (no ax+b support): `:nth-last-child(1)` * [descendant](http://dev.w3.org/csswg/selectors4/#descendant-combinators): `ancestor descendant` * [child](http://dev.w3.org/csswg/selectors4/#child-combinators): `parent > child` * [following sibling](http://dev.w3.org/csswg/selectors4/#general-sibling-combinators): `node ~ sibling` * [adjacent sibling](http://dev.w3.org/csswg/selectors4/#adjacent-sibling-combinators): `node + adjacent` * [negation](http://dev.w3.org/csswg/selectors4/#negation-pseudo): `:not(ForStatement)` * [has](https://drafts.csswg.org/selectors-4/#has-pseudo): `:has(ForStatement)` * [matches-any](http://dev.w3.org/csswg/selectors4/#matches): `:matches([attr] > :first-child, :last-child)` * [subject indicator](http://dev.w3.org/csswg/selectors4/#subject): `!IfStatement > [name="foo"]` * class of AST node: `:statement`, `:expression`, `:declaration`, `:function`, or `:pattern` [](https://travis-ci.org/estools/esquery) # set-blocking [](https://travis-ci.org/yargs/set-blocking) [](https://www.npmjs.com/package/set-blocking) [](https://coveralls.io/r/yargs/set-blocking?branch=master) [](https://github.com/conventional-changelog/standard-version) set blocking `stdio` and `stderr` ensuring that terminal output does not truncate. ```js const setBlocking = require('set-blocking') setBlocking(true) console.log(someLargeStringToOutput) ``` ## Historical Context/Word of Warning This was created as a shim to address the bug discussed in [node #6456](https://github.com/nodejs/node/issues/6456). This bug crops up on newer versions of Node.js (`0.12+`), truncating terminal output. You should be mindful of the side-effects caused by using `set-blocking`: * if your module sets blocking to `true`, it will effect other modules consuming your library. In [yargs](https://github.com/yargs/yargs/blob/master/yargs.js#L653) we only call `setBlocking(true)` once we already know we are about to call `process.exit(code)`. * this patch will not apply to subprocesses spawned with `isTTY = true`, this is the [default `spawn()` behavior](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options). ## License ISC # cliui [](https://travis-ci.org/yargs/cliui) [](https://coveralls.io/r/yargs/cliui?branch=) [](https://www.npmjs.com/package/cliui) [](https://github.com/conventional-changelog/standard-version) easily create complex multi-column command-line-interfaces. ## Example ```js var ui = require('cliui')() ui.div('Usage: $0 [command] [options]') ui.div({ text: 'Options:', padding: [2, 0, 2, 0] }) ui.div( { text: "-f, --file", width: 20, padding: [0, 4, 0, 4] }, { text: "the file to load." + chalk.green("(if this description is long it wraps).") , width: 20 }, { text: chalk.red("[required]"), align: 'right' } ) console.log(ui.toString()) ``` <img width="500" src="screenshot.png"> ## Layout DSL cliui exposes a simple layout DSL: If you create a single `ui.div`, passing a string rather than an object: * `\n`: characters will be interpreted as new rows. * `\t`: characters will be interpreted as new columns. * `\s`: characters will be interpreted as padding. **as an example...** ```js var ui = require('./')({ width: 60 }) ui.div( 'Usage: node ./bin/foo.js\n' + ' <regex>\t provide a regex\n' + ' <glob>\t provide a glob\t [required]' ) console.log(ui.toString()) ``` **will output:** ```shell Usage: node ./bin/foo.js <regex> provide a regex <glob> provide a glob [required] ``` ## Methods ```js cliui = require('cliui') ``` ### cliui({width: integer}) Specify the maximum width of the UI being generated. If no width is provided, cliui will try to get the current window's width and use it, and if that doesn't work, width will be set to `80`. ### cliui({wrap: boolean}) Enable or disable the wrapping of text in a column. ### cliui.div(column, column, column) Create a row with any number of columns, a column can either be a string, or an object with the following options: * **text:** some text to place in the column. * **width:** the width of a column. * **align:** alignment, `right` or `center`. * **padding:** `[top, right, bottom, left]`. * **border:** should a border be placed around the div? ### cliui.span(column, column, column) Similar to `div`, except the next row will be appended without a new line being created. ### cliui.resetOutput() Resets the UI elements of the current cliui instance, maintaining the values set for `width` and `wrap`. # eslint-visitor-keys [](https://www.npmjs.com/package/eslint-visitor-keys) [](http://www.npmtrends.com/eslint-visitor-keys) [](https://travis-ci.org/eslint/eslint-visitor-keys) [](https://david-dm.org/eslint/eslint-visitor-keys) Constants and utilities about visitor keys to traverse AST. ## 💿 Installation Use [npm] to install. ```bash $ npm install eslint-visitor-keys ``` ### Requirements - [Node.js] 10.0.0 or later. ## 📖 Usage ```js const evk = require("eslint-visitor-keys") ``` ### evk.KEYS > type: `{ [type: string]: string[] | undefined }` Visitor keys. This keys are frozen. This is an object. Keys are the type of [ESTree] nodes. Their values are an array of property names which have child nodes. For example: ``` console.log(evk.KEYS.AssignmentExpression) // → ["left", "right"] ``` ### evk.getKeys(node) > type: `(node: object) => string[]` Get the visitor keys of a given AST node. This is similar to `Object.keys(node)` of ES Standard, but some keys are excluded: `parent`, `leadingComments`, `trailingComments`, and names which start with `_`. This will be used to traverse unknown nodes. For example: ``` const node = { type: "AssignmentExpression", left: { type: "Identifier", name: "foo" }, right: { type: "Literal", value: 0 } } console.log(evk.getKeys(node)) // → ["type", "left", "right"] ``` ### evk.unionWith(additionalKeys) > type: `(additionalKeys: object) => { [type: string]: string[] | undefined }` Make the union set with `evk.KEYS` and the given keys. - The order of keys is, `additionalKeys` is at first, then `evk.KEYS` is concatenated after that. - It removes duplicated keys as keeping the first one. For example: ``` console.log(evk.unionWith({ MethodDefinition: ["decorators"] })) // → { ..., MethodDefinition: ["decorators", "key", "value"], ... } ``` ## 📰 Change log See [GitHub releases](https://github.com/eslint/eslint-visitor-keys/releases). ## 🍻 Contributing Welcome. See [ESLint contribution guidelines](https://eslint.org/docs/developer-guide/contributing/). ### Development commands - `npm test` runs tests and measures code coverage. - `npm run lint` checks source codes with ESLint. - `npm run coverage` opens the code coverage report of the previous test with your default browser. - `npm run release` publishes this package to [npm] registory. [npm]: https://www.npmjs.com/ [Node.js]: https://nodejs.org/en/ [ESTree]: https://github.com/estree/estree ### Esrecurse [](https://travis-ci.org/estools/esrecurse) Esrecurse ([esrecurse](https://github.com/estools/esrecurse)) is [ECMAScript](https://www.ecma-international.org/publications/standards/Ecma-262.htm) recursive traversing functionality. ### Example Usage The following code will output all variables declared at the root of a file. ```javascript esrecurse.visit(ast, { XXXStatement: function (node) { this.visit(node.left); // do something... this.visit(node.right); } }); ``` We can use `Visitor` instance. ```javascript var visitor = new esrecurse.Visitor({ XXXStatement: function (node) { this.visit(node.left); // do something... this.visit(node.right); } }); visitor.visit(ast); ``` We can inherit `Visitor` instance easily. ```javascript class Derived extends esrecurse.Visitor { constructor() { super(null); } XXXStatement(node) { } } ``` ```javascript function DerivedVisitor() { esrecurse.Visitor.call(/* this for constructor */ this /* visitor object automatically becomes this. */); } util.inherits(DerivedVisitor, esrecurse.Visitor); DerivedVisitor.prototype.XXXStatement = function (node) { this.visit(node.left); // do something... this.visit(node.right); }; ``` And you can invoke default visiting operation inside custom visit operation. ```javascript function DerivedVisitor() { esrecurse.Visitor.call(/* this for constructor */ this /* visitor object automatically becomes this. */); } util.inherits(DerivedVisitor, esrecurse.Visitor); DerivedVisitor.prototype.XXXStatement = function (node) { // do something... this.visitChildren(node); }; ``` The `childVisitorKeys` option does customize the behaviour of `this.visitChildren(node)`. We can use user-defined node types. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; esrecurse.visit( ast, { Literal: function (node) { // do something... } }, { // Extending the existing traversing rules. childVisitorKeys: { // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ] TestExpression: ['argument'] } } ); ``` We can use the `fallback` option as well. If the `fallback` option is `"iteration"`, `esrecurse` would visit all enumerable properties of unknown nodes. Please note circular references cause the stack overflow. AST might have circular references in additional properties for some purpose (e.g. `node.parent`). ```javascript esrecurse.visit( ast, { Literal: function (node) { // do something... } }, { fallback: 'iteration' } ); ``` If the `fallback` option is a function, `esrecurse` calls this function to determine the enumerable properties of unknown nodes. Please note circular references cause the stack overflow. AST might have circular references in additional properties for some purpose (e.g. `node.parent`). ```javascript esrecurse.visit( ast, { Literal: function (node) { // do something... } }, { fallback: function (node) { return Object.keys(node).filter(function(key) { return key !== 'argument' }); } } ); ``` ### License Copyright (C) 2014 [Yusuke Suzuki](https://github.com/Constellation) (twitter: [@Constellation](https://twitter.com/Constellation)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # Web IDL Type Conversions on JavaScript Values This package implements, in JavaScript, the algorithms to convert a given JavaScript value according to a given [Web IDL](http://heycam.github.io/webidl/) [type](http://heycam.github.io/webidl/#idl-types). The goal is that you should be able to write code like ```js "use strict"; const conversions = require("webidl-conversions"); function doStuff(x, y) { x = conversions["boolean"](x); y = conversions["unsigned long"](y); // actual algorithm code here } ``` and your function `doStuff` will behave the same as a Web IDL operation declared as ```webidl void doStuff(boolean x, unsigned long y); ``` ## API This package's main module's default export is an object with a variety of methods, each corresponding to a different Web IDL type. Each method, when invoked on a JavaScript value, will give back the new JavaScript value that results after passing through the Web IDL conversion rules. (See below for more details on what that means.) Alternately, the method could throw an error, if the Web IDL algorithm is specified to do so: for example `conversions["float"](NaN)` [will throw a `TypeError`](http://heycam.github.io/webidl/#es-float). Each method also accepts a second, optional, parameter for miscellaneous options. For conversion methods that throw errors, a string option `{ context }` may be provided to provide more information in the error message. (For example, `conversions["float"](NaN, { context: "Argument 1 of Interface's operation" })` will throw an error with message `"Argument 1 of Interface's operation is not a finite floating-point value."`) Specific conversions may also accept other options, the details of which can be found below. ## Conversions implemented Conversions for all of the basic types from the Web IDL specification are implemented: - [`any`](https://heycam.github.io/webidl/#es-any) - [`void`](https://heycam.github.io/webidl/#es-void) - [`boolean`](https://heycam.github.io/webidl/#es-boolean) - [Integer types](https://heycam.github.io/webidl/#es-integer-types), which can additionally be provided the boolean options `{ clamp, enforceRange }` as a second parameter - [`float`](https://heycam.github.io/webidl/#es-float), [`unrestricted float`](https://heycam.github.io/webidl/#es-unrestricted-float) - [`double`](https://heycam.github.io/webidl/#es-double), [`unrestricted double`](https://heycam.github.io/webidl/#es-unrestricted-double) - [`DOMString`](https://heycam.github.io/webidl/#es-DOMString), which can additionally be provided the boolean option `{ treatNullAsEmptyString }` as a second parameter - [`ByteString`](https://heycam.github.io/webidl/#es-ByteString), [`USVString`](https://heycam.github.io/webidl/#es-USVString) - [`object`](https://heycam.github.io/webidl/#es-object) - [`Error`](https://heycam.github.io/webidl/#es-Error) - [Buffer source types](https://heycam.github.io/webidl/#es-buffer-source-types) Additionally, for convenience, the following derived type definitions are implemented: - [`ArrayBufferView`](https://heycam.github.io/webidl/#ArrayBufferView) - [`BufferSource`](https://heycam.github.io/webidl/#BufferSource) - [`DOMTimeStamp`](https://heycam.github.io/webidl/#DOMTimeStamp) - [`Function`](https://heycam.github.io/webidl/#Function) - [`VoidFunction`](https://heycam.github.io/webidl/#VoidFunction) (although it will not censor the return type) Derived types, such as nullable types, promise types, sequences, records, etc. are not handled by this library. You may wish to investigate the [webidl2js](https://github.com/jsdom/webidl2js) project. ### A note on the `long long` types The `long long` and `unsigned long long` Web IDL types can hold values that cannot be stored in JavaScript numbers, so the conversion is imperfect. For example, converting the JavaScript number `18446744073709552000` to a Web IDL `long long` is supposed to produce the Web IDL value `-18446744073709551232`. Since we are representing our Web IDL values in JavaScript, we can't represent `-18446744073709551232`, so we instead the best we could do is `-18446744073709552000` as the output. This library actually doesn't even get that far. Producing those results would require doing accurate modular arithmetic on 64-bit intermediate values, but JavaScript does not make this easy. We could pull in a big-integer library as a dependency, but in lieu of that, we for now have decided to just produce inaccurate results if you pass in numbers that are not strictly between `Number.MIN_SAFE_INTEGER` and `Number.MAX_SAFE_INTEGER`. ## Background What's actually going on here, conceptually, is pretty weird. Let's try to explain. Web IDL, as part of its madness-inducing design, has its own type system. When people write algorithms in web platform specs, they usually operate on Web IDL values, i.e. instances of Web IDL types. For example, if they were specifying the algorithm for our `doStuff` operation above, they would treat `x` as a Web IDL value of [Web IDL type `boolean`](http://heycam.github.io/webidl/#idl-boolean). Crucially, they would _not_ treat `x` as a JavaScript variable whose value is either the JavaScript `true` or `false`. They're instead working in a different type system altogether, with its own rules. Separately from its type system, Web IDL defines a ["binding"](http://heycam.github.io/webidl/#ecmascript-binding) of the type system into JavaScript. This contains rules like: when you pass a JavaScript value to the JavaScript method that manifests a given Web IDL operation, how does that get converted into a Web IDL value? For example, a JavaScript `true` passed in the position of a Web IDL `boolean` argument becomes a Web IDL `true`. But, a JavaScript `true` passed in the position of a [Web IDL `unsigned long`](http://heycam.github.io/webidl/#idl-unsigned-long) becomes a Web IDL `1`. And so on. Finally, we have the actual implementation code. This is usually C++, although these days [some smart people are using Rust](https://github.com/servo/servo). The implementation, of course, has its own type system. So when they implement the Web IDL algorithms, they don't actually use Web IDL values, since those aren't "real" outside of specs. Instead, implementations apply the Web IDL binding rules in such a way as to convert incoming JavaScript values into C++ values. For example, if code in the browser called `doStuff(true, true)`, then the implementation code would eventually receive a C++ `bool` containing `true` and a C++ `uint32_t` containing `1`. The upside of all this is that implementations can abstract all the conversion logic away, letting Web IDL handle it, and focus on implementing the relevant methods in C++ with values of the correct type already provided. That is payoff of Web IDL, in a nutshell. And getting to that payoff is the goal of _this_ project—but for JavaScript implementations, instead of C++ ones. That is, this library is designed to make it easier for JavaScript developers to write functions that behave like a given Web IDL operation. So conceptually, the conversion pipeline, which in its general form is JavaScript values ↦ Web IDL values ↦ implementation-language values, in this case becomes JavaScript values ↦ Web IDL values ↦ JavaScript values. And that intermediate step is where all the logic is performed: a JavaScript `true` becomes a Web IDL `1` in an unsigned long context, which then becomes a JavaScript `1`. ## Don't use this Seriously, why would you ever use this? You really shouldn't. Web IDL is … strange, and you shouldn't be emulating its semantics. If you're looking for a generic argument-processing library, you should find one with better rules than those from Web IDL. In general, your JavaScript should not be trying to become more like Web IDL; if anything, we should fix Web IDL to make it more like JavaScript. The _only_ people who should use this are those trying to create faithful implementations (or polyfills) of web platform interfaces defined in Web IDL. Its main consumer is the [jsdom](https://github.com/tmpvar/jsdom) project. <p align="center"> <a href="http://gulpjs.com"> <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png"> </a> </p> # interpret [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] A dictionary of file extensions and associated module loaders. ## What is it This is used by [Liftoff](http://github.com/tkellen/node-liftoff) to automatically require dependencies for configuration files, and by [rechoir](http://github.com/tkellen/node-rechoir) for registering module loaders. ## API ### extensions Map file types to modules which provide a [require.extensions] loader. ```js { '.babel.js': [ { module: '@babel/register', register: function(hook) { // register on .js extension due to https://github.com/joyent/node/blob/v0.12.0/lib/module.js#L353 // which only captures the final extension (.babel.js -> .js) hook({ extensions: '.js' }); }, }, { module: 'babel-register', register: function(hook) { hook({ extensions: '.js' }); }, }, { module: 'babel-core/register', register: function(hook) { hook({ extensions: '.js' }); }, }, { module: 'babel/register', register: function(hook) { hook({ extensions: '.js' }); }, }, ], '.babel.ts': [ { module: '@babel/register', register: function(hook) { hook({ extensions: '.ts' }); }, }, ], '.buble.js': 'buble/register', '.cirru': 'cirru-script/lib/register', '.cjsx': 'node-cjsx/register', '.co': 'coco', '.coffee': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], '.coffee.md': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], '.csv': 'require-csv', '.eg': 'earlgrey/register', '.esm.js': { module: 'esm', register: function(hook) { // register on .js extension due to https://github.com/joyent/node/blob/v0.12.0/lib/module.js#L353 // which only captures the final extension (.babel.js -> .js) var esmLoader = hook(module); require.extensions['.js'] = esmLoader('module')._extensions['.js']; }, }, '.iced': ['iced-coffee-script/register', 'iced-coffee-script'], '.iced.md': 'iced-coffee-script/register', '.ini': 'require-ini', '.js': null, '.json': null, '.json5': 'json5/lib/require', '.jsx': [ { module: '@babel/register', register: function(hook) { hook({ extensions: '.jsx' }); }, }, { module: 'babel-register', register: function(hook) { hook({ extensions: '.jsx' }); }, }, { module: 'babel-core/register', register: function(hook) { hook({ extensions: '.jsx' }); }, }, { module: 'babel/register', register: function(hook) { hook({ extensions: '.jsx' }); }, }, { module: 'node-jsx', register: function(hook) { hook.install({ extension: '.jsx', harmony: true }); }, }, ], '.litcoffee': ['coffeescript/register', 'coffee-script/register', 'coffeescript', 'coffee-script'], '.liticed': 'iced-coffee-script/register', '.ls': ['livescript', 'LiveScript'], '.mjs': '/absolute/path/to/interpret/mjs-stub.js', '.node': null, '.toml': { module: 'toml-require', register: function(hook) { hook.install(); }, }, '.ts': [ 'ts-node/register', 'typescript-node/register', 'typescript-register', 'typescript-require', 'sucrase/register/ts', { module: '@babel/register', register: function(hook) { hook({ extensions: '.ts' }); }, }, ], '.tsx': [ 'ts-node/register', 'typescript-node/register', 'sucrase/register', { module: '@babel/register', register: function(hook) { hook({ extensions: '.tsx' }); }, }, ], '.wisp': 'wisp/engine/node', '.xml': 'require-xml', '.yaml': 'require-yaml', '.yml': 'require-yaml', } ``` ### jsVariants Same as above, but only include the extensions which are javascript variants. ## How to use it Consumers should use the exported `extensions` or `jsVariants` object to determine which module should be loaded for a given extension. If a matching extension is found, consumers should do the following: 1. If the value is null, do nothing. 2. If the value is a string, try to require it. 3. If the value is an object, try to require the `module` property. If successful, the `register` property (a function) should be called with the module passed as the first argument. 4. If the value is an array, iterate over it, attempting step #2 or #3 until one of the attempts does not throw. [require.extensions]: http://nodejs.org/api/globals.html#globals_require_extensions [downloads-image]: http://img.shields.io/npm/dm/interpret.svg [npm-url]: https://www.npmjs.com/package/interpret [npm-image]: http://img.shields.io/npm/v/interpret.svg [travis-url]: https://travis-ci.org/gulpjs/interpret [travis-image]: http://img.shields.io/travis/gulpjs/interpret.svg?label=travis-ci [appveyor-url]: https://ci.appveyor.com/project/gulpjs/interpret [appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/interpret.svg?label=appveyor [coveralls-url]: https://coveralls.io/r/gulpjs/interpret [coveralls-image]: http://img.shields.io/coveralls/gulpjs/interpret/master.svg [gitter-url]: https://gitter.im/gulpjs/gulp [gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg assemblyscript-json # assemblyscript-json ## Table of contents ### Namespaces - [JSON](modules/json.md) ### Classes - [DecoderState](classes/decoderstate.md) - [JSONDecoder](classes/jsondecoder.md) - [JSONEncoder](classes/jsonencoder.md) - [JSONHandler](classes/jsonhandler.md) - [ThrowingJSONHandler](classes/throwingjsonhandler.md) ## Timezone support In order to provide support for timezones, without relying on the JavaScript host or any other time-zone aware environment, this library makes use of teh IANA Timezone Database directly: https://www.iana.org/time-zones The database files are parsed by the scripts in this folder, which emit AssemblyScript code which is used to process the various rules at runtime. <img align="right" alt="Ajv logo" width="160" src="https://ajv.js.org/img/ajv.svg"> &nbsp; # Ajv JSON schema validator The fastest JSON validator for Node.js and browser. Supports JSON Schema draft-04/06/07/2019-09/2020-12 ([draft-04 support](https://ajv.js.org/json-schema.html#draft-04) requires ajv-draft-04 package) and JSON Type Definition [RFC8927](https://datatracker.ietf.org/doc/rfc8927/). [](https://github.com/ajv-validator/ajv/actions?query=workflow%3Abuild) [](https://www.npmjs.com/package/ajv) [](https://www.npmjs.com/package/ajv) [](https://coveralls.io/github/ajv-validator/ajv?branch=master) [](https://simplex.chat/contact#/?v=1&smp=smp%3A%2F%2Fu2dS9sG8nMNURyZwqASV4yROM28Er0luVTx5X1CsMrU%3D%40smp4.simplex.im%2Fap4lMFzfXF8Hzmh-Vz0WNxp_1jKiOa-h%23MCowBQYDK2VuAyEAcdefddRvDfI8iAuBpztm_J3qFucj8MDZoVs_2EcMTzU%3D) [](https://gitter.im/ajv-validator/ajv) [](https://github.com/sponsors/epoberezkin) ## Ajv sponsors [<img src="https://ajv.js.org/img/mozilla.svg" width="45%" alt="Mozilla">](https://www.mozilla.org)<img src="https://ajv.js.org/img/gap.svg" width="9%">[<img src="https://ajv.js.org/img/reserved.svg" width="45%">](https://opencollective.com/ajv) [<img src="https://ajv.js.org/img/microsoft.png" width="31%" alt="Microsoft">](https://opensource.microsoft.com)<img src="https://ajv.js.org/img/gap.svg" width="3%">[<img src="https://ajv.js.org/img/reserved.svg" width="31%">](https://opencollective.com/ajv)<img src="https://ajv.js.org/img/gap.svg" width="3%">[<img src="https://ajv.js.org/img/reserved.svg" width="31%">](https://opencollective.com/ajv) [<img src="https://ajv.js.org/img/retool.svg" width="22.5%" alt="Retool">](https://retool.com/?utm_source=sponsor&utm_campaign=ajv)<img src="https://ajv.js.org/img/gap.svg" width="3%">[<img src="https://ajv.js.org/img/tidelift.svg" width="22.5%" alt="Tidelift">](https://tidelift.com/subscription/pkg/npm-ajv?utm_source=npm-ajv&utm_medium=referral&utm_campaign=enterprise)<img src="https://ajv.js.org/img/gap.svg" width="3%">[<img src="https://ajv.js.org/img/simplex.svg" width="22.5%" alt="SimpleX">](https://github.com/simplex-chat/simplex-chat)<img src="https://ajv.js.org/img/gap.svg" width="3%">[<img src="https://ajv.js.org/img/reserved.svg" width="22.5%">](https://opencollective.com/ajv) ## Contributing More than 100 people contributed to Ajv, and we would love to have you join the development. We welcome implementing new features that will benefit many users and ideas to improve our documentation. Please review [Contributing guidelines](./CONTRIBUTING.md) and [Code components](https://ajv.js.org/components.html). ## Documentation All documentation is available on the [Ajv website](https://ajv.js.org). Some useful site links: - [Getting started](https://ajv.js.org/guide/getting-started.html) - [JSON Schema vs JSON Type Definition](https://ajv.js.org/guide/schema-language.html) - [API reference](https://ajv.js.org/api.html) - [Strict mode](https://ajv.js.org/strict-mode.html) - [Standalone validation code](https://ajv.js.org/standalone.html) - [Security considerations](https://ajv.js.org/security.html) - [Command line interface](https://ajv.js.org/packages/ajv-cli.html) - [Frequently Asked Questions](https://ajv.js.org/faq.html) ## <a name="sponsors"></a>Please [sponsor Ajv development](https://github.com/sponsors/epoberezkin) Since I asked to support Ajv development 40 people and 6 organizations contributed via GitHub and OpenCollective - this support helped receiving the MOSS grant! Your continuing support is very important - the funds will be used to develop and maintain Ajv once the next major version is released. Please sponsor Ajv via: - [GitHub sponsors page](https://github.com/sponsors/epoberezkin) (GitHub will match it) - [Ajv Open Collective️](https://opencollective.com/ajv) Thank you. #### Open Collective sponsors <a href="https://opencollective.com/ajv"><img src="https://opencollective.com/ajv/individuals.svg?width=890"></a> <a href="https://opencollective.com/ajv/organization/0/website"><img src="https://opencollective.com/ajv/organization/0/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/1/website"><img src="https://opencollective.com/ajv/organization/1/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/2/website"><img src="https://opencollective.com/ajv/organization/2/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/3/website"><img src="https://opencollective.com/ajv/organization/3/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/4/website"><img src="https://opencollective.com/ajv/organization/4/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/5/website"><img src="https://opencollective.com/ajv/organization/5/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/6/website"><img src="https://opencollective.com/ajv/organization/6/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/7/website"><img src="https://opencollective.com/ajv/organization/7/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/8/website"><img src="https://opencollective.com/ajv/organization/8/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/9/website"><img src="https://opencollective.com/ajv/organization/9/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/10/website"><img src="https://opencollective.com/ajv/organization/10/avatar.svg"></a> <a href="https://opencollective.com/ajv/organization/11/website"><img src="https://opencollective.com/ajv/organization/11/avatar.svg"></a> ## Performance Ajv generates code to turn JSON Schemas into super-fast validation functions that are efficient for v8 optimization. Currently Ajv is the fastest and the most standard compliant validator according to these benchmarks: - [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark) - 50% faster than the second place - [jsck benchmark](https://github.com/pandastrike/jsck#benchmarks) - 20-190% faster - [z-schema benchmark](https://rawgit.com/zaggino/z-schema/master/benchmark/results.html) - [themis benchmark](https://cdn.rawgit.com/playlyfe/themis/master/benchmark/results.html) Performance of different validators by [json-schema-benchmark](https://github.com/ebdrup/json-schema-benchmark): [](https://github.com/ebdrup/json-schema-benchmark/blob/master/README.md#performance) ## Features - Ajv implements JSON Schema [draft-06/07/2019-09/2020-12](http://json-schema.org/) standards (draft-04 is supported in v6): - all validation keywords (see [JSON Schema validation keywords](https://ajv.js.org/json-schema.html)) - [OpenAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md) extensions: - NEW: keyword [discriminator](https://ajv.js.org/json-schema.html#discriminator). - keyword [nullable](https://ajv.js.org/json-schema.html#nullable). - full support of remote references (remote schemas have to be added with `addSchema` or compiled to be available) - support of recursive references between schemas - correct string lengths for strings with unicode pairs - JSON Schema [formats](https://ajv.js.org/guide/formats.html) (with [ajv-formats](https://github.com/ajv-validator/ajv-formats) plugin). - [validates schemas against meta-schema](https://ajv.js.org/api.html#api-validateschema) - NEW: supports [JSON Type Definition](https://datatracker.ietf.org/doc/rfc8927/): - all keywords (see [JSON Type Definition schema forms](https://ajv.js.org/json-type-definition.html)) - meta-schema for JTD schemas - "union" keyword and user-defined keywords (can be used inside "metadata" member of the schema) - supports [browsers](https://ajv.js.org/guide/environments.html#browsers) and Node.js 10.x - current - [asynchronous loading](https://ajv.js.org/guide/managing-schemas.html#asynchronous-schema-loading) of referenced schemas during compilation - "All errors" validation mode with [option allErrors](https://ajv.js.org/options.html#allerrors) - [error messages with parameters](https://ajv.js.org/api.html#validation-errors) describing error reasons to allow error message generation - i18n error messages support with [ajv-i18n](https://github.com/ajv-validator/ajv-i18n) package - [removing-additional-properties](https://ajv.js.org/guide/modifying-data.html#removing-additional-properties) - [assigning defaults](https://ajv.js.org/guide/modifying-data.html#assigning-defaults) to missing properties and items - [coercing data](https://ajv.js.org/guide/modifying-data.html#coercing-data-types) to the types specified in `type` keywords - [user-defined keywords](https://ajv.js.org/guide/user-keywords.html) - additional extension keywords with [ajv-keywords](https://github.com/ajv-validator/ajv-keywords) package - [\$data reference](https://ajv.js.org/guide/combining-schemas.html#data-reference) to use values from the validated data as values for the schema keywords - [asynchronous validation](https://ajv.js.org/guide/async-validation.html) of user-defined formats and keywords ## Install To install version 8: ``` npm install ajv ``` ## <a name="usage"></a>Getting started Try it in the Node.js REPL: https://runkit.com/npm/ajv In JavaScript: ```javascript // or ESM/TypeScript import import Ajv from "ajv" // Node.js require: const Ajv = require("ajv") const ajv = new Ajv() // options can be passed, e.g. {allErrors: true} const schema = { type: "object", properties: { foo: {type: "integer"}, bar: {type: "string"} }, required: ["foo"], additionalProperties: false, } const data = { foo: 1, bar: "abc" } const validate = ajv.compile(schema) const valid = validate(data) if (!valid) console.log(validate.errors) ``` Learn how to use Ajv and see more examples in the [Guide: getting started](https://ajv.js.org/guide/getting-started.html) ## Changes history See [https://github.com/ajv-validator/ajv/releases](https://github.com/ajv-validator/ajv/releases) **Please note**: [Changes in version 8.0.0](https://github.com/ajv-validator/ajv/releases/tag/v8.0.0) [Version 7.0.0](https://github.com/ajv-validator/ajv/releases/tag/v7.0.0) [Version 6.0.0](https://github.com/ajv-validator/ajv/releases/tag/v6.0.0). ## Code of conduct Please review and follow the [Code of conduct](./CODE_OF_CONDUCT.md). Please report any unacceptable behaviour to ajv.validator@gmail.com - it will be reviewed by the project team. ## Security contact To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerabilities via GitHub issues. ## Open-source software support Ajv is a part of [Tidelift subscription](https://tidelift.com/subscription/pkg/npm-ajv?utm_source=npm-ajv&utm_medium=referral&utm_campaign=readme) - it provides a centralised support to open-source software users, in addition to the support provided by software maintainers. ## License [MIT](./LICENSE) # y18n [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![NPM version][npm-image]][npm-url] [![js-standard-style][standard-image]][standard-url] [](https://conventionalcommits.org) The bare-bones internationalization library used by yargs. Inspired by [i18n](https://www.npmjs.com/package/i18n). ## Examples _simple string translation:_ ```js var __ = require('y18n').__ console.log(__('my awesome string %s', 'foo')) ``` output: `my awesome string foo` _using tagged template literals_ ```js var __ = require('y18n').__ var str = 'foo' console.log(__`my awesome string ${str}`) ``` output: `my awesome string foo` _pluralization support:_ ```js var __n = require('y18n').__n console.log(__n('one fish %s', '%d fishes %s', 2, 'foo')) ``` output: `2 fishes foo` ## JSON Language Files The JSON language files should be stored in a `./locales` folder. File names correspond to locales, e.g., `en.json`, `pirate.json`. When strings are observed for the first time they will be added to the JSON file corresponding to the current locale. ## Methods ### require('y18n')(config) Create an instance of y18n with the config provided, options include: * `directory`: the locale directory, default `./locales`. * `updateFiles`: should newly observed strings be updated in file, default `true`. * `locale`: what locale should be used. * `fallbackToLanguage`: should fallback to a language-only file (e.g. `en.json`) be allowed if a file matching the locale does not exist (e.g. `en_US.json`), default `true`. ### y18n.\_\_(str, arg, arg, arg) Print a localized string, `%s` will be replaced with `arg`s. This function can also be used as a tag for a template literal. You can use it like this: <code>__&#96;hello ${'world'}&#96;</code>. This will be equivalent to `__('hello %s', 'world')`. ### y18n.\_\_n(singularString, pluralString, count, arg, arg, arg) Print a localized string with appropriate pluralization. If `%d` is provided in the string, the `count` will replace this placeholder. ### y18n.setLocale(str) Set the current locale being used. ### y18n.getLocale() What locale is currently being used? ### y18n.updateLocale(obj) Update the current locale with the key value pairs in `obj`. ## License ISC [travis-url]: https://travis-ci.org/yargs/y18n [travis-image]: https://img.shields.io/travis/yargs/y18n.svg [coveralls-url]: https://coveralls.io/github/yargs/y18n [coveralls-image]: https://img.shields.io/coveralls/yargs/y18n.svg [npm-url]: https://npmjs.org/package/y18n [npm-image]: https://img.shields.io/npm/v/y18n.svg [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [standard-url]: https://github.com/feross/standard # axios // helpers The modules found in `helpers/` should be generic modules that are _not_ specific to the domain logic of axios. These modules could theoretically be published to npm on their own and consumed by other modules or apps. Some examples of generic modules are things like: - Browser polyfills - Managing cookies - Parsing HTTP headers # is-glob [](https://www.npmjs.com/package/is-glob) [](https://npmjs.org/package/is-glob) [](https://npmjs.org/package/is-glob) [](https://github.com/micromatch/is-glob/actions) > Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a better user experience. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save is-glob ``` You might also be interested in [is-valid-glob](https://github.com/jonschlinkert/is-valid-glob) and [has-glob](https://github.com/jonschlinkert/has-glob). ## Usage ```js var isGlob = require('is-glob'); ``` ### Default behavior **True** Patterns that have glob characters or regex patterns will return `true`: ```js isGlob('!foo.js'); isGlob('*.js'); isGlob('**/abc.js'); isGlob('abc/*.js'); isGlob('abc/(aaa|bbb).js'); isGlob('abc/[a-z].js'); isGlob('abc/{a,b}.js'); //=> true ``` Extglobs ```js isGlob('abc/@(a).js'); isGlob('abc/!(a).js'); isGlob('abc/+(a).js'); isGlob('abc/*(a).js'); isGlob('abc/?(a).js'); //=> true ``` **False** Escaped globs or extglobs return `false`: ```js isGlob('abc/\\@(a).js'); isGlob('abc/\\!(a).js'); isGlob('abc/\\+(a).js'); isGlob('abc/\\*(a).js'); isGlob('abc/\\?(a).js'); isGlob('\\!foo.js'); isGlob('\\*.js'); isGlob('\\*\\*/abc.js'); isGlob('abc/\\*.js'); isGlob('abc/\\(aaa|bbb).js'); isGlob('abc/\\[a-z].js'); isGlob('abc/\\{a,b}.js'); //=> false ``` Patterns that do not have glob patterns return `false`: ```js isGlob('abc.js'); isGlob('abc/def/ghi.js'); isGlob('foo.js'); isGlob('abc/@.js'); isGlob('abc/+.js'); isGlob('abc/?.js'); isGlob(); isGlob(null); //=> false ``` Arrays are also `false` (If you want to check if an array has a glob pattern, use [has-glob](https://github.com/jonschlinkert/has-glob)): ```js isGlob(['**/*.js']); isGlob(['foo.js']); //=> false ``` ### Option strict When `options.strict === false` the behavior is less strict in determining if a pattern is a glob. Meaning that some patterns that would return `false` may return `true`. This is done so that matching libraries like [micromatch](https://github.com/micromatch/micromatch) have a chance at determining if the pattern is a glob or not. **True** Patterns that have glob characters or regex patterns will return `true`: ```js isGlob('!foo.js', {strict: false}); isGlob('*.js', {strict: false}); isGlob('**/abc.js', {strict: false}); isGlob('abc/*.js', {strict: false}); isGlob('abc/(aaa|bbb).js', {strict: false}); isGlob('abc/[a-z].js', {strict: false}); isGlob('abc/{a,b}.js', {strict: false}); //=> true ``` Extglobs ```js isGlob('abc/@(a).js', {strict: false}); isGlob('abc/!(a).js', {strict: false}); isGlob('abc/+(a).js', {strict: false}); isGlob('abc/*(a).js', {strict: false}); isGlob('abc/?(a).js', {strict: false}); //=> true ``` **False** Escaped globs or extglobs return `false`: ```js isGlob('\\!foo.js', {strict: false}); isGlob('\\*.js', {strict: false}); isGlob('\\*\\*/abc.js', {strict: false}); isGlob('abc/\\*.js', {strict: false}); isGlob('abc/\\(aaa|bbb).js', {strict: false}); isGlob('abc/\\[a-z].js', {strict: false}); isGlob('abc/\\{a,b}.js', {strict: false}); //=> false ``` ## About <details> <summary><strong>Contributing</strong></summary> Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). </details> <details> <summary><strong>Running Tests</strong></summary> Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ``` </details> <details> <summary><strong>Building docs</strong></summary> _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` </details> ### Related projects You might also be interested in these projects: * [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble "Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit") * [base](https://www.npmjs.com/package/base): Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks | [homepage](https://github.com/node-base/base "Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks") * [update](https://www.npmjs.com/package/update): Be scalable! Update is a new, open source developer framework and CLI for automating updates… [more](https://github.com/update/update) | [homepage](https://github.com/update/update "Be scalable! Update is a new, open source developer framework and CLI for automating updates of any kind in code projects.") * [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 47 | [jonschlinkert](https://github.com/jonschlinkert) | | 5 | [doowb](https://github.com/doowb) | | 1 | [phated](https://github.com/phated) | | 1 | [danhper](https://github.com/danhper) | | 1 | [paulmillr](https://github.com/paulmillr) | ### Author **Jon Schlinkert** * [GitHub Profile](https://github.com/jonschlinkert) * [Twitter Profile](https://twitter.com/jonschlinkert) * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) ### License Copyright © 2019, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on March 27, 2019._ <p align="center"> <img width="250" src="https://raw.githubusercontent.com/yargs/yargs/master/yargs-logo.png"> </p> <h1 align="center"> Yargs </h1> <p align="center"> <b >Yargs be a node.js library fer hearties tryin' ter parse optstrings</b> </p> <br>  [![NPM version][npm-image]][npm-url] [![js-standard-style][standard-image]][standard-url] [![Coverage][coverage-image]][coverage-url] [![Conventional Commits][conventional-commits-image]][conventional-commits-url] [![Slack][slack-image]][slack-url] ## Description Yargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface. It gives you: * commands and (grouped) options (`my-program.js serve --port=5000`). * a dynamically generated help menu based on your arguments: ``` mocha [spec..] Run tests with Mocha Commands mocha inspect [spec..] Run tests with Mocha [default] mocha init <path> create a client-side Mocha setup at <path> Rules & Behavior --allow-uncaught Allow uncaught errors to propagate [boolean] --async-only, -A Require all tests to use a callback (async) or return a Promise [boolean] ``` * bash-completion shortcuts for commands and options. * and [tons more](/docs/api.md). ## Installation Stable version: ```bash npm i yargs ``` Bleeding edge version with the most recent features: ```bash npm i yargs@next ``` ## Usage ### Simple Example ```javascript #!/usr/bin/env node const yargs = require('yargs/yargs') const { hideBin } = require('yargs/helpers') const argv = yargs(hideBin(process.argv)).argv if (argv.ships > 3 && argv.distance < 53.5) { console.log('Plunder more riffiwobbles!') } else { console.log('Retreat from the xupptumblers!') } ``` ```bash $ ./plunder.js --ships=4 --distance=22 Plunder more riffiwobbles! $ ./plunder.js --ships 12 --distance 98.7 Retreat from the xupptumblers! ``` ### Complex Example ```javascript #!/usr/bin/env node const yargs = require('yargs/yargs') const { hideBin } = require('yargs/helpers') yargs(hideBin(process.argv)) .command('serve [port]', 'start the server', (yargs) => { yargs .positional('port', { describe: 'port to bind on', default: 5000 }) }, (argv) => { if (argv.verbose) console.info(`start server on :${argv.port}`) serve(argv.port) }) .option('verbose', { alias: 'v', type: 'boolean', description: 'Run with verbose logging' }) .argv ``` Run the example above with `--help` to see the help for the application. ## Supported Platforms ### TypeScript yargs has type definitions at [@types/yargs][type-definitions]. ``` npm i @types/yargs --save-dev ``` See usage examples in [docs](/docs/typescript.md). ### Deno As of `v16`, `yargs` supports [Deno](https://github.com/denoland/deno): ```typescript import yargs from 'https://deno.land/x/yargs/deno.ts' import { Arguments } from 'https://deno.land/x/yargs/deno-types.ts' yargs(Deno.args) .command('download <files...>', 'download a list of files', (yargs: any) => { return yargs.positional('files', { describe: 'a list of files to do something with' }) }, (argv: Arguments) => { console.info(argv) }) .strictCommands() .demandCommand(1) .argv ``` ### ESM As of `v16`,`yargs` supports ESM imports: ```js import yargs from 'yargs' import { hideBin } from 'yargs/helpers' yargs(hideBin(process.argv)) .command('curl <url>', 'fetch the contents of the URL', () => {}, (argv) => { console.info(argv) }) .demandCommand(1) .argv ``` ### Usage in Browser See examples of using yargs in the browser in [docs](/docs/browser.md). ## Community Having problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com). ## Documentation ### Table of Contents * [Yargs' API](/docs/api.md) * [Examples](/docs/examples.md) * [Parsing Tricks](/docs/tricks.md) * [Stop the Parser](/docs/tricks.md#stop) * [Negating Boolean Arguments](/docs/tricks.md#negate) * [Numbers](/docs/tricks.md#numbers) * [Arrays](/docs/tricks.md#arrays) * [Objects](/docs/tricks.md#objects) * [Quotes](/docs/tricks.md#quotes) * [Advanced Topics](/docs/advanced.md) * [Composing Your App Using Commands](/docs/advanced.md#commands) * [Building Configurable CLI Apps](/docs/advanced.md#configuration) * [Customizing Yargs' Parser](/docs/advanced.md#customizing) * [Bundling yargs](/docs/bundling.md) * [Contributing](/contributing.md) ## Supported Node.js Versions Libraries in this ecosystem make a best effort to track [Node.js' release schedule](https://nodejs.org/en/about/releases/). Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a). [npm-url]: https://www.npmjs.com/package/yargs [npm-image]: https://img.shields.io/npm/v/yargs.svg [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [standard-url]: http://standardjs.com/ [conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg [conventional-commits-url]: https://conventionalcommits.org/ [slack-image]: http://devtoolscommunity.herokuapp.com/badge.svg [slack-url]: http://devtoolscommunity.herokuapp.com [type-definitions]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs [coverage-image]: https://img.shields.io/nycrc/yargs/yargs [coverage-url]: https://github.com/yargs/yargs/blob/master/.nycrc The AssemblyScript Runtime ========================== The runtime provides the functionality necessary to dynamically allocate and deallocate memory of objects, arrays and buffers, as well as collect garbage that is no longer used. The current implementation is either a Two-Color Mark & Sweep (TCMS) garbage collector that must be called manually when the execution stack is unwound or an Incremental Tri-Color Mark & Sweep (ITCMS) garbage collector that is fully automated with a shadow stack, implemented on top of a Two-Level Segregate Fit (TLSF) memory manager. It's not designed to be the fastest of its kind, but intentionally focuses on simplicity and ease of integration until we can replace it with the real deal, i.e. Wasm GC. Interface --------- ### Garbage collector / `--exportRuntime` * **__new**(size: `usize`, id: `u32` = 0): `usize`<br /> Dynamically allocates a GC object of at least the specified size and returns its address. Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally. GC-allocated objects cannot be used with `__realloc` and `__free`. * **__pin**(ptr: `usize`): `usize`<br /> Pins the object pointed to by `ptr` externally so it and its directly reachable members and indirectly reachable objects do not become garbage collected. * **__unpin**(ptr: `usize`): `void`<br /> Unpins the object pointed to by `ptr` externally so it can become garbage collected. * **__collect**(): `void`<br /> Performs a full garbage collection. ### Internals * **__alloc**(size: `usize`): `usize`<br /> Dynamically allocates a chunk of memory of at least the specified size and returns its address. Alignment is guaranteed to be 16 bytes to fit up to v128 values naturally. * **__realloc**(ptr: `usize`, size: `usize`): `usize`<br /> Dynamically changes the size of a chunk of memory, possibly moving it to a new address. * **__free**(ptr: `usize`): `void`<br /> Frees a dynamically allocated chunk of memory by its address. * **__renew**(ptr: `usize`, size: `usize`): `usize`<br /> Like `__realloc`, but for `__new`ed GC objects. * **__link**(parentPtr: `usize`, childPtr: `usize`, expectMultiple: `bool`): `void`<br /> Introduces a link from a parent object to a child object, i.e. upon `parent.field = child`. * **__visit**(ptr: `usize`, cookie: `u32`): `void`<br /> Concrete visitor implementation called during traversal. Cookie can be used to indicate one of multiple operations. * **__visit_globals**(cookie: `u32`): `void`<br /> Calls `__visit` on each global that is of a managed type. * **__visit_members**(ptr: `usize`, cookie: `u32`): `void`<br /> Calls `__visit` on each member of the object pointed to by `ptr`. * **__typeinfo**(id: `u32`): `RTTIFlags`<br /> Obtains the runtime type information for objects with the specified runtime id. Runtime type information is a set of flags indicating whether a type is managed, an array or similar, and what the relevant alignments when creating an instance externally are etc. * **__instanceof**(ptr: `usize`, classId: `u32`): `bool`<br /> Tests if the object pointed to by `ptr` is an instance of the specified class id. ITCMS / `--runtime incremental` ----- The Incremental Tri-Color Mark & Sweep garbage collector maintains a separate shadow stack of managed values in the background to achieve full automation. Maintaining another stack introduces some overhead compared to the simpler Two-Color Mark & Sweep garbage collector, but makes it independent of whether the execution stack is unwound or not when it is invoked, so the garbage collector can run interleaved with the program. There are several constants one can experiment with to tweak ITCMS's automation: * `--use ASC_GC_GRANULARITY=1024`<br /> How often to interrupt. The default of 1024 means "interrupt each 1024 bytes allocated". * `--use ASC_GC_STEPFACTOR=200`<br /> How long to interrupt. The default of 200% means "run at double the speed of allocations". * `--use ASC_GC_IDLEFACTOR=200`<br /> How long to idle. The default of 200% means "wait for memory to double before kicking in again". * `--use ASC_GC_MARKCOST=1`<br /> How costly it is to mark one object. Budget per interrupt is `GRANULARITY * STEPFACTOR / 100`. * `--use ASC_GC_SWEEPCOST=10`<br /> How costly it is to sweep one object. Budget per interrupt is `GRANULARITY * STEPFACTOR / 100`. TCMS / `--runtime minimal` ---- If automation and low pause times aren't strictly necessary, using the Two-Color Mark & Sweep garbage collector instead by invoking collection manually at appropriate times when the execution stack is unwound may be more performant as it simpler and has less overhead. The execution stack is typically unwound when invoking the collector externally, at a place that is not indirectly called from Wasm. STUB / `--runtime stub` ---- The stub is a maximally minimal runtime substitute, consisting of a simple and fast bump allocator with no means of freeing up memory again, except when freeing the respective most recently allocated object on top of the bump. Useful where memory is not a concern, and/or where it is sufficient to destroy the whole module including any potential garbage after execution. See also: [Garbage collection](https://www.assemblyscript.org/garbage-collection.html) # which Like the unix `which` utility. Finds the first instance of a specified executable in the PATH environment variable. Does not cache the results, so `hash -r` is not needed when the PATH changes. ## USAGE ```javascript var which = require('which') // async usage which('node', function (er, resolvedPath) { // er is returned if no "node" is found on the PATH // if it is found, then the absolute path to the exec is returned }) // or promise which('node').then(resolvedPath => { ... }).catch(er => { ... not found ... }) // sync usage // throws if not found var resolved = which.sync('node') // if nothrow option is used, returns null if not found resolved = which.sync('node', {nothrow: true}) // Pass options to override the PATH and PATHEXT environment vars. which('node', { path: someOtherPath }, function (er, resolved) { if (er) throw er console.log('found at %j', resolved) }) ``` ## CLI USAGE Same as the BSD `which(1)` binary. ``` usage: which [-as] program ... ``` ## OPTIONS You may pass an options object as the second argument. - `path`: Use instead of the `PATH` environment variable. - `pathExt`: Use instead of the `PATHEXT` environment variable. - `all`: Return all matches, instead of just the first one. Note that this means the function returns an array of strings instead of a single string. # color-convert [](https://travis-ci.org/Qix-/color-convert) Color-convert is a color conversion library for JavaScript and node. It converts all ways between `rgb`, `hsl`, `hsv`, `hwb`, `cmyk`, `ansi`, `ansi16`, `hex` strings, and CSS `keyword`s (will round to closest): ```js var convert = require('color-convert'); convert.rgb.hsl(140, 200, 100); // [96, 48, 59] convert.keyword.rgb('blue'); // [0, 0, 255] var rgbChannels = convert.rgb.channels; // 3 var cmykChannels = convert.cmyk.channels; // 4 var ansiChannels = convert.ansi16.channels; // 1 ``` # Install ```console $ npm install color-convert ``` # API Simply get the property of the _from_ and _to_ conversion that you're looking for. All functions have a rounded and unrounded variant. By default, return values are rounded. To get the unrounded (raw) results, simply tack on `.raw` to the function. All 'from' functions have a hidden property called `.channels` that indicates the number of channels the function expects (not including alpha). ```js var convert = require('color-convert'); // Hex to LAB convert.hex.lab('DEADBF'); // [ 76, 21, -2 ] convert.hex.lab.raw('DEADBF'); // [ 75.56213190997677, 20.653827952644754, -2.290532499330533 ] // RGB to CMYK convert.rgb.cmyk(167, 255, 4); // [ 35, 0, 98, 0 ] convert.rgb.cmyk.raw(167, 255, 4); // [ 34.509803921568626, 0, 98.43137254901961, 0 ] ``` ### Arrays All functions that accept multiple arguments also support passing an array. Note that this does **not** apply to functions that convert from a color that only requires one value (e.g. `keyword`, `ansi256`, `hex`, etc.) ```js var convert = require('color-convert'); convert.rgb.hex(123, 45, 67); // '7B2D43' convert.rgb.hex([123, 45, 67]); // '7B2D43' ``` ## Routing Conversions that don't have an _explicitly_ defined conversion (in [conversions.js](conversions.js)), but can be converted by means of sub-conversions (e.g. XYZ -> **RGB** -> CMYK), are automatically routed together. This allows just about any color model supported by `color-convert` to be converted to any other model, so long as a sub-conversion path exists. This is also true for conversions requiring more than one step in between (e.g. LCH -> **LAB** -> **XYZ** -> **RGB** -> Hex). Keep in mind that extensive conversions _may_ result in a loss of precision, and exist only to be complete. For a list of "direct" (single-step) conversions, see [conversions.js](conversions.js). # Contribute If there is a new model you would like to support, or want to add a direct conversion between two existing models, please send us a pull request. # License Copyright &copy; 2011-2016, Heather Arthur and Josh Junon. Licensed under the [MIT License](LICENSE). # whatwg-url whatwg-url is a full implementation of the WHATWG [URL Standard](https://url.spec.whatwg.org/). It can be used standalone, but it also exposes a lot of the internal algorithms that are useful for integrating a URL parser into a project like [jsdom](https://github.com/tmpvar/jsdom). ## Specification conformance whatwg-url is currently up to date with the URL spec up to commit [7ae1c69](https://github.com/whatwg/url/commit/7ae1c691c96f0d82fafa24c33aa1e8df9ffbf2bc). For `file:` URLs, whose [origin is left unspecified](https://url.spec.whatwg.org/#concept-url-origin), whatwg-url chooses to use a new opaque origin (which serializes to `"null"`). ## API ### The `URL` and `URLSearchParams` classes The main API is provided by the [`URL`](https://url.spec.whatwg.org/#url-class) and [`URLSearchParams`](https://url.spec.whatwg.org/#interface-urlsearchparams) exports, which follows the spec's behavior in all ways (including e.g. `USVString` conversion). Most consumers of this library will want to use these. ### Low-level URL Standard API The following methods are exported for use by places like jsdom that need to implement things like [`HTMLHyperlinkElementUtils`](https://html.spec.whatwg.org/#htmlhyperlinkelementutils). They mostly operate on or return an "internal URL" or ["URL record"](https://url.spec.whatwg.org/#concept-url) type. - [URL parser](https://url.spec.whatwg.org/#concept-url-parser): `parseURL(input, { baseURL, encodingOverride })` - [Basic URL parser](https://url.spec.whatwg.org/#concept-basic-url-parser): `basicURLParse(input, { baseURL, encodingOverride, url, stateOverride })` - [URL serializer](https://url.spec.whatwg.org/#concept-url-serializer): `serializeURL(urlRecord, excludeFragment)` - [Host serializer](https://url.spec.whatwg.org/#concept-host-serializer): `serializeHost(hostFromURLRecord)` - [Serialize an integer](https://url.spec.whatwg.org/#serialize-an-integer): `serializeInteger(number)` - [Origin](https://url.spec.whatwg.org/#concept-url-origin) [serializer](https://html.spec.whatwg.org/multipage/origin.html#ascii-serialisation-of-an-origin): `serializeURLOrigin(urlRecord)` - [Set the username](https://url.spec.whatwg.org/#set-the-username): `setTheUsername(urlRecord, usernameString)` - [Set the password](https://url.spec.whatwg.org/#set-the-password): `setThePassword(urlRecord, passwordString)` - [Cannot have a username/password/port](https://url.spec.whatwg.org/#cannot-have-a-username-password-port): `cannotHaveAUsernamePasswordPort(urlRecord)` - [Percent decode](https://url.spec.whatwg.org/#percent-decode): `percentDecode(buffer)` The `stateOverride` parameter is one of the following strings: - [`"scheme start"`](https://url.spec.whatwg.org/#scheme-start-state) - [`"scheme"`](https://url.spec.whatwg.org/#scheme-state) - [`"no scheme"`](https://url.spec.whatwg.org/#no-scheme-state) - [`"special relative or authority"`](https://url.spec.whatwg.org/#special-relative-or-authority-state) - [`"path or authority"`](https://url.spec.whatwg.org/#path-or-authority-state) - [`"relative"`](https://url.spec.whatwg.org/#relative-state) - [`"relative slash"`](https://url.spec.whatwg.org/#relative-slash-state) - [`"special authority slashes"`](https://url.spec.whatwg.org/#special-authority-slashes-state) - [`"special authority ignore slashes"`](https://url.spec.whatwg.org/#special-authority-ignore-slashes-state) - [`"authority"`](https://url.spec.whatwg.org/#authority-state) - [`"host"`](https://url.spec.whatwg.org/#host-state) - [`"hostname"`](https://url.spec.whatwg.org/#hostname-state) - [`"port"`](https://url.spec.whatwg.org/#port-state) - [`"file"`](https://url.spec.whatwg.org/#file-state) - [`"file slash"`](https://url.spec.whatwg.org/#file-slash-state) - [`"file host"`](https://url.spec.whatwg.org/#file-host-state) - [`"path start"`](https://url.spec.whatwg.org/#path-start-state) - [`"path"`](https://url.spec.whatwg.org/#path-state) - [`"cannot-be-a-base-URL path"`](https://url.spec.whatwg.org/#cannot-be-a-base-url-path-state) - [`"query"`](https://url.spec.whatwg.org/#query-state) - [`"fragment"`](https://url.spec.whatwg.org/#fragment-state) The URL record type has the following API: - [`scheme`](https://url.spec.whatwg.org/#concept-url-scheme) - [`username`](https://url.spec.whatwg.org/#concept-url-username) - [`password`](https://url.spec.whatwg.org/#concept-url-password) - [`host`](https://url.spec.whatwg.org/#concept-url-host) - [`port`](https://url.spec.whatwg.org/#concept-url-port) - [`path`](https://url.spec.whatwg.org/#concept-url-path) (as an array) - [`query`](https://url.spec.whatwg.org/#concept-url-query) - [`fragment`](https://url.spec.whatwg.org/#concept-url-fragment) - [`cannotBeABaseURL`](https://url.spec.whatwg.org/#url-cannot-be-a-base-url-flag) (as a boolean) These properties should be treated with care, as in general changing them will cause the URL record to be in an inconsistent state until the appropriate invocation of `basicURLParse` is used to fix it up. You can see examples of this in the URL Standard, where there are many step sequences like "4. Set context object’s url’s fragment to the empty string. 5. Basic URL parse _input_ with context object’s url as _url_ and fragment state as _state override_." In between those two steps, a URL record is in an unusable state. The return value of "failure" in the spec is represented by `null`. That is, functions like `parseURL` and `basicURLParse` can return _either_ a URL record _or_ `null`. ## Development instructions First, install [Node.js](https://nodejs.org/). Then, fetch the dependencies of whatwg-url, by running from this directory: npm install To run tests: npm test To generate a coverage report: npm run coverage To build and run the live viewer: npm run build npm run build-live-viewer Serve the contents of the `live-viewer` directory using any web server. ## Supporting whatwg-url The jsdom project (including whatwg-url) is a community-driven project maintained by a team of [volunteers](https://github.com/orgs/jsdom/people). You could support us by: - [Getting professional support for whatwg-url](https://tidelift.com/subscription/pkg/npm-whatwg-url?utm_source=npm-whatwg-url&utm_medium=referral&utm_campaign=readme) as part of a Tidelift subscription. Tidelift helps making open source sustainable for us while giving teams assurances for maintenance, licensing, and security. - Contributing directly to the project. # line-column [](https://travis-ci.org/io-monad/line-column) [](https://coveralls.io/github/io-monad/line-column?branch=master) [](https://badge.fury.io/js/line-column) Node module to convert efficiently index to/from line-column in a string. ## Install npm install line-column ## Usage ### lineColumn(str, options = {}) Returns a `LineColumnFinder` instance for given string `str`. #### Options | Key | Description | Default | | ------- | ----------- | ------- | | `origin` | The origin value of line number and column number | `1` | ### lineColumn(str, index) This is just a shorthand for `lineColumn(str).fromIndex(index)`. ### LineColumnFinder#fromIndex(index) Find line and column from index in the string. Parameters: - `index` - `number` Index in the string. (0-origin) Returns: - `{ line: x, col: y }` Found line number and column number. - `null` if the given index is out of range. ### LineColumnFinder#toIndex(line, column) Find index from line and column in the string. Parameters: - `line` - `number` Line number in the string. - `column` - `number` Column number in the string. or - `{ line: x, col: y }` - `Object` line and column numbers in the string.<br>A key name `column` can be used instead of `col`. or - `[ line, col ]` - `Array` line and column numbers in the string. Returns: - `number` Found index in the string. - `-1` if the given line or column is out of range. ## Example ```js var lineColumn = require("line-column"); var testString = [ "ABCDEFG\n", // line:0, index:0 "HIJKLMNOPQRSTU\n", // line:1, index:8 "VWXYZ\n", // line:2, index:23 "日本語の文字\n", // line:3, index:29 "English words" // line:4, index:36 ].join(""); // length:49 lineColumn(testString).fromIndex(3) // { line: 1, col: 4 } lineColumn(testString).fromIndex(33) // { line: 4, col: 5 } lineColumn(testString).toIndex(1, 4) // 3 lineColumn(testString).toIndex(4, 5) // 33 // Shorthand of .fromIndex (compatible with find-line-column) lineColumn(testString, 33) // { line:4, col: 5 } // Object or Array is also acceptable lineColumn(testString).toIndex({ line: 4, col: 5 }) // 33 lineColumn(testString).toIndex({ line: 4, column: 5 }) // 33 lineColumn(testString).toIndex([4, 5]) // 33 // You can cache it for the same string. It is so efficient. (See benchmark) var finder = lineColumn(testString); finder.fromIndex(33) // { line: 4, column: 5 } finder.toIndex(4, 5) // 33 // For 0-origin line and column numbers var oneOrigin = lineColumn(testString, { origin: 0 }); oneOrigin.fromIndex(33) // { line: 3, column: 4 } oneOrigin.toIndex(3, 4) // 33 ``` ## Testing npm test ## Benchmark The popular package [find-line-column](https://www.npmjs.com/package/find-line-column) provides the same "index to line-column" feature. Here is some benchmarking on `line-column` vs `find-line-column`. You can run this benchmark by `npm run benchmark`. See [benchmark/](benchmark/) for the source code. ``` long text + line-column (not cached) x 72,989 ops/sec ±0.83% (89 runs sampled) long text + line-column (cached) x 13,074,242 ops/sec ±0.32% (89 runs sampled) long text + find-line-column x 33,887 ops/sec ±0.54% (84 runs sampled) short text + line-column (not cached) x 1,636,766 ops/sec ±0.77% (82 runs sampled) short text + line-column (cached) x 21,699,686 ops/sec ±1.04% (82 runs sampled) short text + find-line-column x 382,145 ops/sec ±1.04% (85 runs sampled) ``` As you might have noticed, even not cached version of `line-column` is 2x - 4x faster than `find-line-column`, and cached version of `line-column` is remarkable 50x - 380x faster. ## Contributing 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` 3. Commit your changes: `git commit -am 'Add some feature'` 4. Push to the branch: `git push origin my-new-feature` 5. Submit a pull request :D ## License MIT (See LICENSE) ### Estraverse [](http://travis-ci.org/estools/estraverse) Estraverse ([estraverse](http://github.com/estools/estraverse)) is [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm) traversal functions from [esmangle project](http://github.com/estools/esmangle). ### Documentation You can find usage docs at [wiki page](https://github.com/estools/estraverse/wiki/Usage). ### Example Usage The following code will output all variables declared at the root of a file. ```javascript estraverse.traverse(ast, { enter: function (node, parent) { if (node.type == 'FunctionExpression' || node.type == 'FunctionDeclaration') return estraverse.VisitorOption.Skip; }, leave: function (node, parent) { if (node.type == 'VariableDeclarator') console.log(node.id.name); } }); ``` We can use `this.skip`, `this.remove` and `this.break` functions instead of using Skip, Remove and Break. ```javascript estraverse.traverse(ast, { enter: function (node) { this.break(); } }); ``` And estraverse provides `estraverse.replace` function. When returning node from `enter`/`leave`, current node is replaced with it. ```javascript result = estraverse.replace(tree, { enter: function (node) { // Replace it with replaced. if (node.type === 'Literal') return replaced; } }); ``` By passing `visitor.keys` mapping, we can extend estraverse traversing functionality. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Extending the existing traversing rules. keys: { // TargetNodeName: [ 'keys', 'containing', 'the', 'other', '**node**' ] TestExpression: ['argument'] } }); ``` By passing `visitor.fallback` option, we can control the behavior when encountering unknown nodes. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Iterating the child **nodes** of unknown nodes. fallback: 'iteration' }); ``` When `visitor.fallback` is a function, we can determine which keys to visit on each node. ```javascript // This tree contains a user-defined `TestExpression` node. var tree = { type: 'TestExpression', // This 'argument' is the property containing the other **node**. argument: { type: 'Literal', value: 20 }, // This 'extended' is the property not containing the other **node**. extended: true }; estraverse.traverse(tree, { enter: function (node) { }, // Skip the `argument` property of each node fallback: function(node) { return Object.keys(node).filter(function(key) { return key !== 'argument'; }); } }); ``` ### License Copyright (C) 2012-2016 [Yusuke Suzuki](http://github.com/Constellation) (twitter: [@Constellation](http://twitter.com/Constellation)) and other contributors. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ## assemblyscript-temporal An implementation of temporal within AssemblyScript, with an initial focus on non-timezone-aware classes and functionality. ### Why? AssemblyScript has minimal `Date` support, however, the JS Date API itself is terrible and people tend not to use it that often. As a result libraries like moment / luxon have become staple replacements. However, there is now a [relatively mature TC39 proposal](https://github.com/tc39/proposal-temporal) that adds greatly improved date support to JS. The goal of this project is to implement Temporal for AssemblyScript. ### Usage This library currently supports the following types: #### `PlainDateTime` A `PlainDateTime` represents a calendar date and wall-clock time that does not carry time zone information, e.g. December 7th, 1995 at 3:00 PM (in the Gregorian calendar). For detailed documentation see the [TC39 Temporal proposal website](https://tc39.es/proposal-temporal/docs/plaindatetime.html), this implementation follows the specification as closely as possible. You can create a `PlainDateTime` from individual components, a string or an object literal: ```javascript datetime = new PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789); datetime.year; // 2019; datetime.month; // 11; // ... datetime.nanosecond; // 789; datetime = PlainDateTime.from("1976-11-18T12:34:56"); datetime.toString(); // "1976-11-18T12:34:56" datetime = PlainDateTime.from({ year: 1966, month: 3, day: 3 }); datetime.toString(); // "1966-03-03T00:00:00" ``` There are various ways you can manipulate a date: ```javascript // use 'with' to copy a date but with various property values overriden datetime = new PlainDateTime(1976, 11, 18, 15, 23, 30, 123, 456, 789); datetime.with({ year: 2019 }).toString(); // "2019-11-18T15:23:30.123456789" // use 'add' or 'substract' to add / subtract a duration datetime = PlainDateTime.from("2020-01-12T15:00"); datetime.add({ months: 1 }).toString(); // "2020-02-12T15:00:00"); // add / subtract support Duration objects or object literals datetime.add(new Duration(1)).toString(); // "2021-01-12T15:00:00"); ``` You can compare dates and check for equality ```javascript dt1 = PlainDateTime.from("1976-11-18"); dt2 = PlainDateTime.from("2019-10-29"); PlainDateTime.compare(dt1, dt1); // 0 PlainDateTime.compare(dt1, dt2); // -1 dt1.equals(dt1); // true ``` Currently `PlainDateTime` only supports the ISO 8601 (Gregorian) calendar. #### `PlainDate` A `PlainDate` object represents a calendar date that is not associated with a particular time or time zone, e.g. August 24th, 2006. For detailed documentation see the [TC39 Temporal proposal website](https://tc39.es/proposal-temporal/docs/plaindate.html), this implementation follows the specification as closely as possible. The `PlainDate` API is almost identical to `PlainDateTime`, so see above for API usage examples. #### `PlainTime` A `PlainTime` object represents a wall-clock time that is not associated with a particular date or time zone, e.g. 7:39 PM. For detailed documentation see the [TC39 Temporal proposal website](https://tc39.es/proposal-temporal/docs/plaintime.html), this implementation follows the specification as closely as possible. The `PlainTime` API is almost identical to `PlainDateTime`, so see above for API usage examples. #### `PlainMonthDay` A date without a year component. This is useful to express things like "Bastille Day is on the 14th of July". For detailed documentation see the [TC39 Temporal proposal website](https://tc39.es/proposal-temporal/docs/plainmonthday.html) , this implementation follows the specification as closely as possible. ```javascript const monthDay = PlainMonthDay.from({ month: 7, day: 14 }); // => 07-14 const date = monthDay.toPlainDate({ year: 2030 }); // => 2030-07-14 date.dayOfWeek; // => 7 ``` The `PlainMonthDay` API is almost identical to `PlainDateTime`, so see above for more API usage examples. #### `PlainYearMonth` A date without a day component. This is useful to express things like "the October 2020 meeting". For detailed documentation see the [TC39 Temporal proposal website](https://tc39.es/proposal-temporal/docs/plainyearmonth.html) , this implementation follows the specification as closely as possible. The `PlainYearMonth` API is almost identical to `PlainDateTime`, so see above for API usage examples. #### `now` The `now` object has several methods which give information about the current time and date. ```javascript dateTime = now.plainDateTimeISO(); dateTime.toString(); // 2021-04-01T12:05:47.357 ``` ## Contributing This project is open source, MIT licensed and your contributions are very much welcomed. There is a [brief document that outlines implementation progress and priorities](./development.md). [](https://travis-ci.org/#!/adaltas/node-csv-stringify) [](https://www.npmjs.com/package/csv-stringify) [](https://www.npmjs.com/package/csv-stringify) This package is a stringifier converting records into a CSV text and implementing the Node.js [`stream.Transform` API](https://nodejs.org/api/stream.html). It also provides the easier synchronous and callback-based APIs for conveniency. It is both extremely easy to use and powerful. It was first released in 2010 and is tested against big data sets by a large community. ## Documentation * [Project homepage](http://csv.js.org/stringify/) * [API](http://csv.js.org/stringify/api/) * [Options](http://csv.js.org/stringify/options/) * [Examples](http://csv.js.org/stringify/examples/) ## Main features * Follow the Node.js streaming API * Simplicity with the optional callback API * Support for custom formatters, delimiters, quotes, escape characters and header * Support big datasets * Complete test coverage and samples for inspiration * Only 1 external dependency * to be used conjointly with `csv-generate`, `csv-parse` and `stream-transform` * MIT License ## Usage The module is built on the Node.js Stream API. For the sake of simplicity, a simple callback API is also provided. To give you a quick look, here's an example of the callback API: ```javascript const stringify = require('csv-stringify') const assert = require('assert') // import stringify from 'csv-stringify' // import assert from 'assert/strict' const input = [ [ '1', '2', '3', '4' ], [ 'a', 'b', 'c', 'd' ] ] stringify(input, function(err, output) { const expected = '1,2,3,4\na,b,c,d\n' assert.strictEqual(output, expected, `output.should.eql ${expected}`) console.log("Passed.", output) }) ``` ## Development Tests are executed with mocha. To install it, run `npm install` followed by `npm test`. It will install mocha and its dependencies in your project "node_modules" directory and run the test suite. The tests run against the CoffeeScript source files. To generate the JavaScript files, run `npm run build`. The test suite is run online with [Travis](https://travis-ci.org/#!/adaltas/node-csv-stringify). See the [Travis definition file](https://github.com/adaltas/node-csv-stringify/blob/master/.travis.yml) to view the tested Node.js version. ## Contributors * David Worms: <https://github.com/wdavidw> [csv_home]: https://github.com/adaltas/node-csv [stream_transform]: http://nodejs.org/api/stream.html#stream_class_stream_transform [examples]: http://csv.js.org/stringify/examples/ [csv]: https://github.com/adaltas/node-csv # Acorn A tiny, fast JavaScript parser written in JavaScript. ## Community Acorn is open source software released under an [MIT license](https://github.com/acornjs/acorn/blob/master/acorn/LICENSE). You are welcome to [report bugs](https://github.com/acornjs/acorn/issues) or create pull requests on [github](https://github.com/acornjs/acorn). For questions and discussion, please use the [Tern discussion forum](https://discuss.ternjs.net). ## Installation The easiest way to install acorn is from [`npm`](https://www.npmjs.com/): ```sh npm install acorn ``` Alternately, you can download the source and build acorn yourself: ```sh git clone https://github.com/acornjs/acorn.git cd acorn npm install ``` ## Interface **parse**`(input, options)` is the main interface to the library. The `input` parameter is a string, `options` can be undefined or an object setting some of the options listed below. The return value will be an abstract syntax tree object as specified by the [ESTree spec](https://github.com/estree/estree). ```javascript let acorn = require("acorn"); console.log(acorn.parse("1 + 1")); ``` When encountering a syntax error, the parser will raise a `SyntaxError` object with a meaningful message. The error object will have a `pos` property that indicates the string offset at which the error occurred, and a `loc` object that contains a `{line, column}` object referring to that same position. Options can be provided by passing a second argument, which should be an object containing any of these fields: - **ecmaVersion**: Indicates the ECMAScript version to parse. Must be either 3, 5, 6 (2015), 7 (2016), 8 (2017), 9 (2018), 10 (2019) or 11 (2020, partial support). This influences support for strict mode, the set of reserved words, and support for new syntax features. Default is 10. **NOTE**: Only 'stage 4' (finalized) ECMAScript features are being implemented by Acorn. Other proposed new features can be implemented through plugins. - **sourceType**: Indicate the mode the code should be parsed in. Can be either `"script"` or `"module"`. This influences global strict mode and parsing of `import` and `export` declarations. **NOTE**: If set to `"module"`, then static `import` / `export` syntax will be valid, even if `ecmaVersion` is less than 6. - **onInsertedSemicolon**: If given a callback, that callback will be called whenever a missing semicolon is inserted by the parser. The callback will be given the character offset of the point where the semicolon is inserted as argument, and if `locations` is on, also a `{line, column}` object representing this position. - **onTrailingComma**: Like `onInsertedSemicolon`, but for trailing commas. - **allowReserved**: If `false`, using a reserved word will generate an error. Defaults to `true` for `ecmaVersion` 3, `false` for higher versions. When given the value `"never"`, reserved words and keywords can also not be used as property names (as in Internet Explorer's old parser). - **allowReturnOutsideFunction**: By default, a return statement at the top level raises an error. Set this to `true` to accept such code. - **allowImportExportEverywhere**: By default, `import` and `export` declarations can only appear at a program's top level. Setting this option to `true` allows them anywhere where a statement is allowed. - **allowAwaitOutsideFunction**: By default, `await` expressions can only appear inside `async` functions. Setting this option to `true` allows to have top-level `await` expressions. They are still not allowed in non-`async` functions, though. - **allowHashBang**: When this is enabled (off by default), if the code starts with the characters `#!` (as in a shellscript), the first line will be treated as a comment. - **locations**: When `true`, each node has a `loc` object attached with `start` and `end` subobjects, each of which contains the one-based line and zero-based column numbers in `{line, column}` form. Default is `false`. - **onToken**: If a function is passed for this option, each found token will be passed in same format as tokens returned from `tokenizer().getToken()`. If array is passed, each found token is pushed to it. Note that you are not allowed to call the parser from the callback—that will corrupt its internal state. - **onComment**: If a function is passed for this option, whenever a comment is encountered the function will be called with the following parameters: - `block`: `true` if the comment is a block comment, false if it is a line comment. - `text`: The content of the comment. - `start`: Character offset of the start of the comment. - `end`: Character offset of the end of the comment. When the `locations` options is on, the `{line, column}` locations of the comment’s start and end are passed as two additional parameters. If array is passed for this option, each found comment is pushed to it as object in Esprima format: ```javascript { "type": "Line" | "Block", "value": "comment text", "start": Number, "end": Number, // If `locations` option is on: "loc": { "start": {line: Number, column: Number} "end": {line: Number, column: Number} }, // If `ranges` option is on: "range": [Number, Number] } ``` Note that you are not allowed to call the parser from the callback—that will corrupt its internal state. - **ranges**: Nodes have their start and end characters offsets recorded in `start` and `end` properties (directly on the node, rather than the `loc` object, which holds line/column data. To also add a [semi-standardized](https://bugzilla.mozilla.org/show_bug.cgi?id=745678) `range` property holding a `[start, end]` array with the same numbers, set the `ranges` option to `true`. - **program**: It is possible to parse multiple files into a single AST by passing the tree produced by parsing the first file as the `program` option in subsequent parses. This will add the toplevel forms of the parsed file to the "Program" (top) node of an existing parse tree. - **sourceFile**: When the `locations` option is `true`, you can pass this option to add a `source` attribute in every node’s `loc` object. Note that the contents of this option are not examined or processed in any way; you are free to use whatever format you choose. - **directSourceFile**: Like `sourceFile`, but a `sourceFile` property will be added (regardless of the `location` option) directly to the nodes, rather than the `loc` object. - **preserveParens**: If this option is `true`, parenthesized expressions are represented by (non-standard) `ParenthesizedExpression` nodes that have a single `expression` property containing the expression inside parentheses. **parseExpressionAt**`(input, offset, options)` will parse a single expression in a string, and return its AST. It will not complain if there is more of the string left after the expression. **tokenizer**`(input, options)` returns an object with a `getToken` method that can be called repeatedly to get the next token, a `{start, end, type, value}` object (with added `loc` property when the `locations` option is enabled and `range` property when the `ranges` option is enabled). When the token's type is `tokTypes.eof`, you should stop calling the method, since it will keep returning that same token forever. In ES6 environment, returned result can be used as any other protocol-compliant iterable: ```javascript for (let token of acorn.tokenizer(str)) { // iterate over the tokens } // transform code to array of tokens: var tokens = [...acorn.tokenizer(str)]; ``` **tokTypes** holds an object mapping names to the token type objects that end up in the `type` properties of tokens. **getLineInfo**`(input, offset)` can be used to get a `{line, column}` object for a given program string and offset. ### The `Parser` class Instances of the **`Parser`** class contain all the state and logic that drives a parse. It has static methods `parse`, `parseExpressionAt`, and `tokenizer` that match the top-level functions by the same name. When extending the parser with plugins, you need to call these methods on the extended version of the class. To extend a parser with plugins, you can use its static `extend` method. ```javascript var acorn = require("acorn"); var jsx = require("acorn-jsx"); var JSXParser = acorn.Parser.extend(jsx()); JSXParser.parse("foo(<bar/>)"); ``` The `extend` method takes any number of plugin values, and returns a new `Parser` class that includes the extra parser logic provided by the plugins. ## Command line interface The `bin/acorn` utility can be used to parse a file from the command line. It accepts as arguments its input file and the following options: - `--ecma3|--ecma5|--ecma6|--ecma7|--ecma8|--ecma9|--ecma10`: Sets the ECMAScript version to parse. Default is version 9. - `--module`: Sets the parsing mode to `"module"`. Is set to `"script"` otherwise. - `--locations`: Attaches a "loc" object to each node with "start" and "end" subobjects, each of which contains the one-based line and zero-based column numbers in `{line, column}` form. - `--allow-hash-bang`: If the code starts with the characters #! (as in a shellscript), the first line will be treated as a comment. - `--compact`: No whitespace is used in the AST output. - `--silent`: Do not output the AST, just return the exit status. - `--help`: Print the usage information and quit. The utility spits out the syntax tree as JSON data. ## Existing plugins - [`acorn-jsx`](https://github.com/RReverser/acorn-jsx): Parse [Facebook JSX syntax extensions](https://github.com/facebook/jsx) Plugins for ECMAScript proposals: - [`acorn-stage3`](https://github.com/acornjs/acorn-stage3): Parse most stage 3 proposals, bundling: - [`acorn-class-fields`](https://github.com/acornjs/acorn-class-fields): Parse [class fields proposal](https://github.com/tc39/proposal-class-fields) - [`acorn-import-meta`](https://github.com/acornjs/acorn-import-meta): Parse [import.meta proposal](https://github.com/tc39/proposal-import-meta) - [`acorn-private-methods`](https://github.com/acornjs/acorn-private-methods): parse [private methods, getters and setters proposal](https://github.com/tc39/proposal-private-methods)n # fast-deep-equal The fastest deep equal with ES6 Map, Set and Typed arrays support. [](https://travis-ci.org/epoberezkin/fast-deep-equal) [](https://www.npmjs.com/package/fast-deep-equal) [](https://coveralls.io/github/epoberezkin/fast-deep-equal?branch=master) ## Install ```bash npm install fast-deep-equal ``` ## Features - ES5 compatible - works in node.js (8+) and browsers (IE9+) - checks equality of Date and RegExp objects by value. ES6 equal (`require('fast-deep-equal/es6')`) also supports: - Maps - Sets - Typed arrays ## Usage ```javascript var equal = require('fast-deep-equal'); console.log(equal({foo: 'bar'}, {foo: 'bar'})); // true ``` To support ES6 Maps, Sets and Typed arrays equality use: ```javascript var equal = require('fast-deep-equal/es6'); console.log(equal(Int16Array([1, 2]), Int16Array([1, 2]))); // true ``` To use with React (avoiding the traversal of React elements' _owner property that contains circular references and is not needed when comparing the elements - borrowed from [react-fast-compare](https://github.com/FormidableLabs/react-fast-compare)): ```javascript var equal = require('fast-deep-equal/react'); var equal = require('fast-deep-equal/es6/react'); ``` ## Performance benchmark Node.js v12.6.0: ``` fast-deep-equal x 261,950 ops/sec ±0.52% (89 runs sampled) fast-deep-equal/es6 x 212,991 ops/sec ±0.34% (92 runs sampled) fast-equals x 230,957 ops/sec ±0.83% (85 runs sampled) nano-equal x 187,995 ops/sec ±0.53% (88 runs sampled) shallow-equal-fuzzy x 138,302 ops/sec ±0.49% (90 runs sampled) underscore.isEqual x 74,423 ops/sec ±0.38% (89 runs sampled) lodash.isEqual x 36,637 ops/sec ±0.72% (90 runs sampled) deep-equal x 2,310 ops/sec ±0.37% (90 runs sampled) deep-eql x 35,312 ops/sec ±0.67% (91 runs sampled) ramda.equals x 12,054 ops/sec ±0.40% (91 runs sampled) util.isDeepStrictEqual x 46,440 ops/sec ±0.43% (90 runs sampled) assert.deepStrictEqual x 456 ops/sec ±0.71% (88 runs sampled) The fastest is fast-deep-equal ``` To run benchmark (requires node.js 6+): ```bash npm run benchmark ``` __Please note__: this benchmark runs against the available test cases. To choose the most performant library for your application, it is recommended to benchmark against your data and to NOT expect this benchmark to reflect the performance difference in your application. ## Enterprise support fast-deep-equal package is a part of [Tidelift enterprise subscription](https://tidelift.com/subscription/pkg/npm-fast-deep-equal?utm_source=npm-fast-deep-equal&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) - it provides a centralised commercial support to open-source software users, in addition to the support provided by software maintainers. ## Security contact To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. Please do NOT report security vulnerability via GitHub issues. ## License [MIT](https://github.com/epoberezkin/fast-deep-equal/blob/master/LICENSE) # safe-buffer [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url] [travis-image]: https://img.shields.io/travis/feross/safe-buffer/master.svg [travis-url]: https://travis-ci.org/feross/safe-buffer [npm-image]: https://img.shields.io/npm/v/safe-buffer.svg [npm-url]: https://npmjs.org/package/safe-buffer [downloads-image]: https://img.shields.io/npm/dm/safe-buffer.svg [downloads-url]: https://npmjs.org/package/safe-buffer [standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg [standard-url]: https://standardjs.com #### Safer Node.js Buffer API **Use the new Node.js Buffer APIs (`Buffer.from`, `Buffer.alloc`, `Buffer.allocUnsafe`, `Buffer.allocUnsafeSlow`) in all versions of Node.js.** **Uses the built-in implementation when available.** ## install ``` npm install safe-buffer ``` ## usage The goal of this package is to provide a safe replacement for the node.js `Buffer`. It's a drop-in replacement for `Buffer`. You can use it by adding one `require` line to the top of your node.js modules: ```js var Buffer = require('safe-buffer').Buffer // Existing buffer code will continue to work without issues: new Buffer('hey', 'utf8') new Buffer([1, 2, 3], 'utf8') new Buffer(obj) new Buffer(16) // create an uninitialized buffer (potentially unsafe) // But you can use these new explicit APIs to make clear what you want: Buffer.from('hey', 'utf8') // convert from many types to a Buffer Buffer.alloc(16) // create a zero-filled buffer (safe) Buffer.allocUnsafe(16) // create an uninitialized buffer (potentially unsafe) ``` ## api ### Class Method: Buffer.from(array) <!-- YAML added: v3.0.0 --> * `array` {Array} Allocates a new `Buffer` using an `array` of octets. ```js const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]); // creates a new Buffer containing ASCII bytes // ['b','u','f','f','e','r'] ``` A `TypeError` will be thrown if `array` is not an `Array`. ### Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]]) <!-- YAML added: v5.10.0 --> * `arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()` * `byteOffset` {Number} Default: `0` * `length` {Number} Default: `arrayBuffer.length - byteOffset` When passed a reference to the `.buffer` property of a `TypedArray` instance, the newly created `Buffer` will share the same allocated memory as the TypedArray. ```js const arr = new Uint16Array(2); arr[0] = 5000; arr[1] = 4000; const buf = Buffer.from(arr.buffer); // shares the memory with arr; console.log(buf); // Prints: <Buffer 88 13 a0 0f> // changing the TypedArray changes the Buffer also arr[1] = 6000; console.log(buf); // Prints: <Buffer 88 13 70 17> ``` The optional `byteOffset` and `length` arguments specify a memory range within the `arrayBuffer` that will be shared by the `Buffer`. ```js const ab = new ArrayBuffer(10); const buf = Buffer.from(ab, 0, 2); console.log(buf.length); // Prints: 2 ``` A `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer`. ### Class Method: Buffer.from(buffer) <!-- YAML added: v3.0.0 --> * `buffer` {Buffer} Copies the passed `buffer` data onto a new `Buffer` instance. ```js const buf1 = Buffer.from('buffer'); const buf2 = Buffer.from(buf1); buf1[0] = 0x61; console.log(buf1.toString()); // 'auffer' console.log(buf2.toString()); // 'buffer' (copy is not changed) ``` A `TypeError` will be thrown if `buffer` is not a `Buffer`. ### Class Method: Buffer.from(str[, encoding]) <!-- YAML added: v5.10.0 --> * `str` {String} String to encode. * `encoding` {String} Encoding to use, Default: `'utf8'` Creates a new `Buffer` containing the given JavaScript string `str`. If provided, the `encoding` parameter identifies the character encoding. If not provided, `encoding` defaults to `'utf8'`. ```js const buf1 = Buffer.from('this is a tést'); console.log(buf1.toString()); // prints: this is a tést console.log(buf1.toString('ascii')); // prints: this is a tC)st const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex'); console.log(buf2.toString()); // prints: this is a tést ``` A `TypeError` will be thrown if `str` is not a string. ### Class Method: Buffer.alloc(size[, fill[, encoding]]) <!-- YAML added: v5.10.0 --> * `size` {Number} * `fill` {Value} Default: `undefined` * `encoding` {String} Default: `utf8` Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the `Buffer` will be *zero-filled*. ```js const buf = Buffer.alloc(5); console.log(buf); // <Buffer 00 00 00 00 00> ``` The `size` must be less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will be created if a `size` less than or equal to 0 is specified. If `fill` is specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill)`. See [`buf.fill()`][] for more information. ```js const buf = Buffer.alloc(5, 'a'); console.log(buf); // <Buffer 61 61 61 61 61> ``` If both `fill` and `encoding` are specified, the allocated `Buffer` will be initialized by calling `buf.fill(fill, encoding)`. For example: ```js const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64'); console.log(buf); // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64> ``` Calling `Buffer.alloc(size)` can be significantly slower than the alternative `Buffer.allocUnsafe(size)` but ensures that the newly created `Buffer` instance contents will *never contain sensitive data*. A `TypeError` will be thrown if `size` is not a number. ### Class Method: Buffer.allocUnsafe(size) <!-- YAML added: v5.10.0 --> * `size` {Number} Allocates a new *non-zero-filled* `Buffer` of `size` bytes. The `size` must be less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will be created if a `size` less than or equal to 0 is specified. The underlying memory for `Buffer` instances created in this way is *not initialized*. The contents of the newly created `Buffer` are unknown and *may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such `Buffer` instances to zeroes. ```js const buf = Buffer.allocUnsafe(5); console.log(buf); // <Buffer 78 e0 82 02 01> // (octets will be different, every time) buf.fill(0); console.log(buf); // <Buffer 00 00 00 00 00> ``` A `TypeError` will be thrown if `size` is not a number. Note that the `Buffer` module pre-allocates an internal `Buffer` instance of size `Buffer.poolSize` that is used as a pool for the fast allocation of new `Buffer` instances created using `Buffer.allocUnsafe(size)` (and the deprecated `new Buffer(size)` constructor) only when `size` is less than or equal to `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default value of `Buffer.poolSize` is `8192` but can be modified. Use of this pre-allocated internal memory pool is a key difference between calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`. Specifically, `Buffer.alloc(size, fill)` will *never* use the internal Buffer pool, while `Buffer.allocUnsafe(size).fill(fill)` *will* use the internal Buffer pool if `size` is less than or equal to half `Buffer.poolSize`. The difference is subtle but can be important when an application requires the additional performance that `Buffer.allocUnsafe(size)` provides. ### Class Method: Buffer.allocUnsafeSlow(size) <!-- YAML added: v5.10.0 --> * `size` {Number} Allocates a new *non-zero-filled* and non-pooled `Buffer` of `size` bytes. The `size` must be less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. A zero-length Buffer will be created if a `size` less than or equal to 0 is specified. The underlying memory for `Buffer` instances created in this way is *not initialized*. The contents of the newly created `Buffer` are unknown and *may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such `Buffer` instances to zeroes. When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances, allocations under 4KB are, by default, sliced from a single pre-allocated `Buffer`. This allows applications to avoid the garbage collection overhead of creating many individually allocated Buffers. This approach improves both performance and memory usage by eliminating the need to track and cleanup as many `Persistent` objects. However, in the case where a developer may need to retain a small chunk of memory from a pool for an indeterminate amount of time, it may be appropriate to create an un-pooled Buffer instance using `Buffer.allocUnsafeSlow()` then copy out the relevant bits. ```js // need to keep around a few small chunks of memory const store = []; socket.on('readable', () => { const data = socket.read(); // allocate for retained data const sb = Buffer.allocUnsafeSlow(10); // copy the data into the new allocation data.copy(sb, 0, 0, 10); store.push(sb); }); ``` Use of `Buffer.allocUnsafeSlow()` should be used only as a last resort *after* a developer has observed undue memory retention in their applications. A `TypeError` will be thrown if `size` is not a number. ### All the Rest The rest of the `Buffer` API is exactly the same as in node.js. [See the docs](https://nodejs.org/api/buffer.html). ## Related links - [Node.js issue: Buffer(number) is unsafe](https://github.com/nodejs/node/issues/4660) - [Node.js Enhancement Proposal: Buffer.from/Buffer.alloc/Buffer.zalloc/Buffer() soft-deprecate](https://github.com/nodejs/node-eps/pull/4) ## Why is `Buffer` unsafe? Today, the node.js `Buffer` constructor is overloaded to handle many different argument types like `String`, `Array`, `Object`, `TypedArrayView` (`Uint8Array`, etc.), `ArrayBuffer`, and also `Number`. The API is optimized for convenience: you can throw any type at it, and it will try to do what you want. Because the Buffer constructor is so powerful, you often see code like this: ```js // Convert UTF-8 strings to hex function toHex (str) { return new Buffer(str).toString('hex') } ``` ***But what happens if `toHex` is called with a `Number` argument?*** ### Remote Memory Disclosure If an attacker can make your program call the `Buffer` constructor with a `Number` argument, then they can make it allocate uninitialized memory from the node.js process. This could potentially disclose TLS private keys, user data, or database passwords. When the `Buffer` constructor is passed a `Number` argument, it returns an **UNINITIALIZED** block of memory of the specified `size`. When you create a `Buffer` like this, you **MUST** overwrite the contents before returning it to the user. From the [node.js docs](https://nodejs.org/api/buffer.html#buffer_new_buffer_size): > `new Buffer(size)` > > - `size` Number > > The underlying memory for `Buffer` instances created in this way is not initialized. > **The contents of a newly created `Buffer` are unknown and could contain sensitive > data.** Use `buf.fill(0)` to initialize a Buffer to zeroes. (Emphasis our own.) Whenever the programmer intended to create an uninitialized `Buffer` you often see code like this: ```js var buf = new Buffer(16) // Immediately overwrite the uninitialized buffer with data from another buffer for (var i = 0; i < buf.length; i++) { buf[i] = otherBuf[i] } ``` ### Would this ever be a problem in real code? Yes. It's surprisingly common to forget to check the type of your variables in a dynamically-typed language like JavaScript. Usually the consequences of assuming the wrong type is that your program crashes with an uncaught exception. But the failure mode for forgetting to check the type of arguments to the `Buffer` constructor is more catastrophic. Here's an example of a vulnerable service that takes a JSON payload and converts it to hex: ```js // Take a JSON payload {str: "some string"} and convert it to hex var server = http.createServer(function (req, res) { var data = '' req.setEncoding('utf8') req.on('data', function (chunk) { data += chunk }) req.on('end', function () { var body = JSON.parse(data) res.end(new Buffer(body.str).toString('hex')) }) }) server.listen(8080) ``` In this example, an http client just has to send: ```json { "str": 1000 } ``` and it will get back 1,000 bytes of uninitialized memory from the server. This is a very serious bug. It's similar in severity to the [the Heartbleed bug](http://heartbleed.com/) that allowed disclosure of OpenSSL process memory by remote attackers. ### Which real-world packages were vulnerable? #### [`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht) [Mathias Buus](https://github.com/mafintosh) and I ([Feross Aboukhadijeh](http://feross.org/)) found this issue in one of our own packages, [`bittorrent-dht`](https://www.npmjs.com/package/bittorrent-dht). The bug would allow anyone on the internet to send a series of messages to a user of `bittorrent-dht` and get them to reveal 20 bytes at a time of uninitialized memory from the node.js process. Here's [the commit](https://github.com/feross/bittorrent-dht/commit/6c7da04025d5633699800a99ec3fbadf70ad35b8) that fixed it. We released a new fixed version, created a [Node Security Project disclosure](https://nodesecurity.io/advisories/68), and deprecated all vulnerable versions on npm so users will get a warning to upgrade to a newer version. #### [`ws`](https://www.npmjs.com/package/ws) That got us wondering if there were other vulnerable packages. Sure enough, within a short period of time, we found the same issue in [`ws`](https://www.npmjs.com/package/ws), the most popular WebSocket implementation in node.js. If certain APIs were called with `Number` parameters instead of `String` or `Buffer` as expected, then uninitialized server memory would be disclosed to the remote peer. These were the vulnerable methods: ```js socket.send(number) socket.ping(number) socket.pong(number) ``` Here's a vulnerable socket server with some echo functionality: ```js server.on('connection', function (socket) { socket.on('message', function (message) { message = JSON.parse(message) if (message.type === 'echo') { socket.send(message.data) // send back the user's message } }) }) ``` `socket.send(number)` called on the server, will disclose server memory. Here's [the release](https://github.com/websockets/ws/releases/tag/1.0.1) where the issue was fixed, with a more detailed explanation. Props to [Arnout Kazemier](https://github.com/3rd-Eden) for the quick fix. Here's the [Node Security Project disclosure](https://nodesecurity.io/advisories/67). ### What's the solution? It's important that node.js offers a fast way to get memory otherwise performance-critical applications would needlessly get a lot slower. But we need a better way to *signal our intent* as programmers. **When we want uninitialized memory, we should request it explicitly.** Sensitive functionality should not be packed into a developer-friendly API that loosely accepts many different types. This type of API encourages the lazy practice of passing variables in without checking the type very carefully. #### A new API: `Buffer.allocUnsafe(number)` The functionality of creating buffers with uninitialized memory should be part of another API. We propose `Buffer.allocUnsafe(number)`. This way, it's not part of an API that frequently gets user input of all sorts of different types passed into it. ```js var buf = Buffer.allocUnsafe(16) // careful, uninitialized memory! // Immediately overwrite the uninitialized buffer with data from another buffer for (var i = 0; i < buf.length; i++) { buf[i] = otherBuf[i] } ``` ### How do we fix node.js core? We sent [a PR to node.js core](https://github.com/nodejs/node/pull/4514) (merged as `semver-major`) which defends against one case: ```js var str = 16 new Buffer(str, 'utf8') ``` In this situation, it's implied that the programmer intended the first argument to be a string, since they passed an encoding as a second argument. Today, node.js will allocate uninitialized memory in the case of `new Buffer(number, encoding)`, which is probably not what the programmer intended. But this is only a partial solution, since if the programmer does `new Buffer(variable)` (without an `encoding` parameter) there's no way to know what they intended. If `variable` is sometimes a number, then uninitialized memory will sometimes be returned. ### What's the real long-term fix? We could deprecate and remove `new Buffer(number)` and use `Buffer.allocUnsafe(number)` when we need uninitialized memory. But that would break 1000s of packages. ~~We believe the best solution is to:~~ ~~1. Change `new Buffer(number)` to return safe, zeroed-out memory~~ ~~2. Create a new API for creating uninitialized Buffers. We propose: `Buffer.allocUnsafe(number)`~~ #### Update We now support adding three new APIs: - `Buffer.from(value)` - convert from any type to a buffer - `Buffer.alloc(size)` - create a zero-filled buffer - `Buffer.allocUnsafe(size)` - create an uninitialized buffer with given size This solves the core problem that affected `ws` and `bittorrent-dht` which is `Buffer(variable)` getting tricked into taking a number argument. This way, existing code continues working and the impact on the npm ecosystem will be minimal. Over time, npm maintainers can migrate performance-critical code to use `Buffer.allocUnsafe(number)` instead of `new Buffer(number)`. ### Conclusion We think there's a serious design issue with the `Buffer` API as it exists today. It promotes insecure software by putting high-risk functionality into a convenient API with friendly "developer ergonomics". This wasn't merely a theoretical exercise because we found the issue in some of the most popular npm packages. Fortunately, there's an easy fix that can be applied today. Use `safe-buffer` in place of `buffer`. ```js var Buffer = require('safe-buffer').Buffer ``` Eventually, we hope that node.js core can switch to this new, safer behavior. We believe the impact on the ecosystem would be minimal since it's not a breaking change. Well-maintained, popular packages would be updated to use `Buffer.alloc` quickly, while older, insecure packages would magically become safe from this attack vector. ## links - [Node.js PR: buffer: throw if both length and enc are passed](https://github.com/nodejs/node/pull/4514) - [Node Security Project disclosure for `ws`](https://nodesecurity.io/advisories/67) - [Node Security Project disclosure for`bittorrent-dht`](https://nodesecurity.io/advisories/68) ## credit The original issues in `bittorrent-dht` ([disclosure](https://nodesecurity.io/advisories/68)) and `ws` ([disclosure](https://nodesecurity.io/advisories/67)) were discovered by [Mathias Buus](https://github.com/mafintosh) and [Feross Aboukhadijeh](http://feross.org/). Thanks to [Adam Baldwin](https://github.com/evilpacket) for helping disclose these issues and for his work running the [Node Security Project](https://nodesecurity.io/). Thanks to [John Hiesey](https://github.com/jhiesey) for proofreading this README and auditing the code. ## license MIT. Copyright (C) [Feross Aboukhadijeh](http://feross.org) # yallist Yet Another Linked List There are many doubly-linked list implementations like it, but this one is mine. For when an array would be too big, and a Map can't be iterated in reverse order. [](https://travis-ci.org/isaacs/yallist) [](https://coveralls.io/github/isaacs/yallist) ## basic usage ```javascript var yallist = require('yallist') var myList = yallist.create([1, 2, 3]) myList.push('foo') myList.unshift('bar') // of course pop() and shift() are there, too console.log(myList.toArray()) // ['bar', 1, 2, 3, 'foo'] myList.forEach(function (k) { // walk the list head to tail }) myList.forEachReverse(function (k, index, list) { // walk the list tail to head }) var myDoubledList = myList.map(function (k) { return k + k }) // now myDoubledList contains ['barbar', 2, 4, 6, 'foofoo'] // mapReverse is also a thing var myDoubledListReverse = myList.mapReverse(function (k) { return k + k }) // ['foofoo', 6, 4, 2, 'barbar'] var reduced = myList.reduce(function (set, entry) { set += entry return set }, 'start') console.log(reduced) // 'startfoo123bar' ``` ## api The whole API is considered "public". Functions with the same name as an Array method work more or less the same way. There's reverse versions of most things because that's the point. ### Yallist Default export, the class that holds and manages a list. Call it with either a forEach-able (like an array) or a set of arguments, to initialize the list. The Array-ish methods all act like you'd expect. No magic length, though, so if you change that it won't automatically prune or add empty spots. ### Yallist.create(..) Alias for Yallist function. Some people like factories. #### yallist.head The first node in the list #### yallist.tail The last node in the list #### yallist.length The number of nodes in the list. (Change this at your peril. It is not magic like Array length.) #### yallist.toArray() Convert the list to an array. #### yallist.forEach(fn, [thisp]) Call a function on each item in the list. #### yallist.forEachReverse(fn, [thisp]) Call a function on each item in the list, in reverse order. #### yallist.get(n) Get the data at position `n` in the list. If you use this a lot, probably better off just using an Array. #### yallist.getReverse(n) Get the data at position `n`, counting from the tail. #### yallist.map(fn, thisp) Create a new Yallist with the result of calling the function on each item. #### yallist.mapReverse(fn, thisp) Same as `map`, but in reverse. #### yallist.pop() Get the data from the list tail, and remove the tail from the list. #### yallist.push(item, ...) Insert one or more items to the tail of the list. #### yallist.reduce(fn, initialValue) Like Array.reduce. #### yallist.reduceReverse Like Array.reduce, but in reverse. #### yallist.reverse Reverse the list in place. #### yallist.shift() Get the data from the list head, and remove the head from the list. #### yallist.slice([from], [to]) Just like Array.slice, but returns a new Yallist. #### yallist.sliceReverse([from], [to]) Just like yallist.slice, but the result is returned in reverse. #### yallist.toArray() Create an array representation of the list. #### yallist.toArrayReverse() Create a reversed array representation of the list. #### yallist.unshift(item, ...) Insert one or more items to the head of the list. #### yallist.unshiftNode(node) Move a Node object to the front of the list. (That is, pull it out of wherever it lives, and make it the new head.) If the node belongs to a different list, then that list will remove it first. #### yallist.pushNode(node) Move a Node object to the end of the list. (That is, pull it out of wherever it lives, and make it the new tail.) If the node belongs to a list already, then that list will remove it first. #### yallist.removeNode(node) Remove a node from the list, preserving referential integrity of head and tail and other nodes. Will throw an error if you try to have a list remove a node that doesn't belong to it. ### Yallist.Node The class that holds the data and is actually the list. Call with `var n = new Node(value, previousNode, nextNode)` Note that if you do direct operations on Nodes themselves, it's very easy to get into weird states where the list is broken. Be careful :) #### node.next The next node in the list. #### node.prev The previous node in the list. #### node.value The data the node contains. #### node.list The list to which this node belongs. (Null if it does not belong to any list.) # axios // adapters The modules under `adapters/` are modules that handle dispatching a request and settling a returned `Promise` once a response is received. ## Example ```js var settle = require('./../core/settle'); module.exports = function myAdapter(config) { // At this point: // - config has been merged with defaults // - request transformers have already run // - request interceptors have already run // Make the request using config provided // Upon response settle the Promise return new Promise(function(resolve, reject) { var response = { data: responseData, status: request.status, statusText: request.statusText, headers: responseHeaders, config: config, request: request }; settle(resolve, reject, response); // From here: // - response transformers will run // - response interceptors will run }); } ``` <a name="table"></a> # Table > Produces a string that represents array data in a text table. [](https://github.com/gajus/table/actions) [](https://coveralls.io/github/gajus/table) [](https://www.npmjs.org/package/table) [](https://github.com/gajus/canonical) [](https://twitter.com/kuizinas) * [Table](#table) * [Features](#table-features) * [Install](#table-install) * [Usage](#table-usage) * [API](#table-api) * [table](#table-api-table-1) * [createStream](#table-api-createstream) * [getBorderCharacters](#table-api-getbordercharacters)  <a name="table-features"></a> ## Features * Works with strings containing [fullwidth](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) characters. * Works with strings containing [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code). * Configurable border characters. * Configurable content alignment per column. * Configurable content padding per column. * Configurable column width. * Text wrapping. <a name="table-install"></a> ## Install ```bash npm install table ``` [](https://www.buymeacoffee.com/gajus) [](https://www.patreon.com/gajus) <a name="table-usage"></a> ## Usage ```js import { table } from 'table'; // Using commonjs? // const { table } = require('table'); const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'] ]; console.log(table(data)); ``` ``` ╔════╤════╤════╗ ║ 0A │ 0B │ 0C ║ ╟────┼────┼────╢ ║ 1A │ 1B │ 1C ║ ╟────┼────┼────╢ ║ 2A │ 2B │ 2C ║ ╚════╧════╧════╝ ``` <a name="table-api"></a> ## API <a name="table-api-table-1"></a> ### table Returns the string in the table format **Parameters:** - **_data_:** The data to display - Type: `any[][]` - Required: `true` - **_config_:** Table configuration - Type: `object` - Required: `false` <a name="table-api-table-1-config-border"></a> ##### config.border Type: `{ [type: string]: string }`\ Default: `honeywell` [template](#getbordercharacters) Custom borders. The keys are any of: - `topLeft`, `topRight`, `topBody`,`topJoin` - `bottomLeft`, `bottomRight`, `bottomBody`, `bottomJoin` - `joinLeft`, `joinRight`, `joinBody`, `joinJoin` - `bodyLeft`, `bodyRight`, `bodyJoin` - `headerJoin` ```js const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'] ]; const config = { border: { topBody: `─`, topJoin: `┬`, topLeft: `┌`, topRight: `┐`, bottomBody: `─`, bottomJoin: `┴`, bottomLeft: `└`, bottomRight: `┘`, bodyLeft: `│`, bodyRight: `│`, bodyJoin: `│`, joinBody: `─`, joinLeft: `├`, joinRight: `┤`, joinJoin: `┼` } }; console.log(table(data, config)); ``` ``` ┌────┬────┬────┐ │ 0A │ 0B │ 0C │ ├────┼────┼────┤ │ 1A │ 1B │ 1C │ ├────┼────┼────┤ │ 2A │ 2B │ 2C │ └────┴────┴────┘ ``` <a name="table-api-table-1-config-drawverticalline"></a> ##### config.drawVerticalLine Type: `(lineIndex: number, columnCount: number) => boolean`\ Default: `() => true` It is used to tell whether to draw a vertical line. This callback is called for each vertical border of the table. If the table has `n` columns, then the `index` parameter is alternatively received all numbers in range `[0, n]` inclusively. ```js const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'], ['3A', '3B', '3C'], ['4A', '4B', '4C'] ]; const config = { drawVerticalLine: (lineIndex, columnCount) => { return lineIndex === 0 || lineIndex === columnCount; } }; console.log(table(data, config)); ``` ``` ╔════════════╗ ║ 0A 0B 0C ║ ╟────────────╢ ║ 1A 1B 1C ║ ╟────────────╢ ║ 2A 2B 2C ║ ╟────────────╢ ║ 3A 3B 3C ║ ╟────────────╢ ║ 4A 4B 4C ║ ╚════════════╝ ``` <a name="table-api-table-1-config-drawhorizontalline"></a> ##### config.drawHorizontalLine Type: `(lineIndex: number, rowCount: number) => boolean`\ Default: `() => true` It is used to tell whether to draw a horizontal line. This callback is called for each horizontal border of the table. If the table has `n` rows, then the `index` parameter is alternatively received all numbers in range `[0, n]` inclusively. If the table has `n` rows and contains the header, then the range will be `[0, n+1]` inclusively. ```js const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'], ['3A', '3B', '3C'], ['4A', '4B', '4C'] ]; const config = { drawHorizontalLine: (lineIndex, rowCount) => { return lineIndex === 0 || lineIndex === 1 || lineIndex === rowCount - 1 || lineIndex === rowCount; } }; console.log(table(data, config)); ``` ``` ╔════╤════╤════╗ ║ 0A │ 0B │ 0C ║ ╟────┼────┼────╢ ║ 1A │ 1B │ 1C ║ ║ 2A │ 2B │ 2C ║ ║ 3A │ 3B │ 3C ║ ╟────┼────┼────╢ ║ 4A │ 4B │ 4C ║ ╚════╧════╧════╝ ``` <a name="table-api-table-1-config-singleline"></a> ##### config.singleLine Type: `boolean`\ Default: `false` If `true`, horizontal lines inside the table are not drawn. This option also overrides the `config.drawHorizontalLine` if specified. ```js const data = [ ['-rw-r--r--', '1', 'pandorym', 'staff', '1529', 'May 23 11:25', 'LICENSE'], ['-rw-r--r--', '1', 'pandorym', 'staff', '16327', 'May 23 11:58', 'README.md'], ['drwxr-xr-x', '76', 'pandorym', 'staff', '2432', 'May 23 12:02', 'dist'], ['drwxr-xr-x', '634', 'pandorym', 'staff', '20288', 'May 23 11:54', 'node_modules'], ['-rw-r--r--', '1,', 'pandorym', 'staff', '525688', 'May 23 11:52', 'package-lock.json'], ['-rw-r--r--@', '1', 'pandorym', 'staff', '2440', 'May 23 11:25', 'package.json'], ['drwxr-xr-x', '27', 'pandorym', 'staff', '864', 'May 23 11:25', 'src'], ['drwxr-xr-x', '20', 'pandorym', 'staff', '640', 'May 23 11:25', 'test'], ]; const config = { singleLine: true }; console.log(table(data, config)); ``` ``` ╔═════════════╤═════╤══════════╤═══════╤════════╤══════════════╤═══════════════════╗ ║ -rw-r--r-- │ 1 │ pandorym │ staff │ 1529 │ May 23 11:25 │ LICENSE ║ ║ -rw-r--r-- │ 1 │ pandorym │ staff │ 16327 │ May 23 11:58 │ README.md ║ ║ drwxr-xr-x │ 76 │ pandorym │ staff │ 2432 │ May 23 12:02 │ dist ║ ║ drwxr-xr-x │ 634 │ pandorym │ staff │ 20288 │ May 23 11:54 │ node_modules ║ ║ -rw-r--r-- │ 1, │ pandorym │ staff │ 525688 │ May 23 11:52 │ package-lock.json ║ ║ -rw-r--r--@ │ 1 │ pandorym │ staff │ 2440 │ May 23 11:25 │ package.json ║ ║ drwxr-xr-x │ 27 │ pandorym │ staff │ 864 │ May 23 11:25 │ src ║ ║ drwxr-xr-x │ 20 │ pandorym │ staff │ 640 │ May 23 11:25 │ test ║ ╚═════════════╧═════╧══════════╧═══════╧════════╧══════════════╧═══════════════════╝ ``` <a name="table-api-table-1-config-columns"></a> ##### config.columns Type: `Column[] | { [columnIndex: number]: Column }` Column specific configurations. <a name="table-api-table-1-config-columns-config-columns-width"></a> ###### config.columns[*].width Type: `number`\ Default: the maximum cell widths of the column Column width (excluding the paddings). ```js const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'] ]; const config = { columns: { 1: { width: 10 } } }; console.log(table(data, config)); ``` ``` ╔════╤════════════╤════╗ ║ 0A │ 0B │ 0C ║ ╟────┼────────────┼────╢ ║ 1A │ 1B │ 1C ║ ╟────┼────────────┼────╢ ║ 2A │ 2B │ 2C ║ ╚════╧════════════╧════╝ ``` <a name="table-api-table-1-config-columns-config-columns-alignment"></a> ###### config.columns[*].alignment Type: `'center' | 'justify' | 'left' | 'right'`\ Default: `'left'` Cell content horizontal alignment ```js const data = [ ['0A', '0B', '0C', '0D 0E 0F'], ['1A', '1B', '1C', '1D 1E 1F'], ['2A', '2B', '2C', '2D 2E 2F'], ]; const config = { columnDefault: { width: 10, }, columns: [ { alignment: 'left' }, { alignment: 'center' }, { alignment: 'right' }, { alignment: 'justify' } ], }; console.log(table(data, config)); ``` ``` ╔════════════╤════════════╤════════════╤════════════╗ ║ 0A │ 0B │ 0C │ 0D 0E 0F ║ ╟────────────┼────────────┼────────────┼────────────╢ ║ 1A │ 1B │ 1C │ 1D 1E 1F ║ ╟────────────┼────────────┼────────────┼────────────╢ ║ 2A │ 2B │ 2C │ 2D 2E 2F ║ ╚════════════╧════════════╧════════════╧════════════╝ ``` <a name="table-api-table-1-config-columns-config-columns-verticalalignment"></a> ###### config.columns[*].verticalAlignment Type: `'top' | 'middle' | 'bottom'`\ Default: `'top'` Cell content vertical alignment ```js const data = [ ['A', 'B', 'C', 'DEF'], ]; const config = { columnDefault: { width: 1, }, columns: [ { verticalAlignment: 'top' }, { verticalAlignment: 'middle' }, { verticalAlignment: 'bottom' }, ], }; console.log(table(data, config)); ``` ``` ╔═══╤═══╤═══╤═══╗ ║ A │ │ │ D ║ ║ │ B │ │ E ║ ║ │ │ C │ F ║ ╚═══╧═══╧═══╧═══╝ ``` <a name="table-api-table-1-config-columns-config-columns-paddingleft"></a> ###### config.columns[*].paddingLeft Type: `number`\ Default: `1` The number of whitespaces used to pad the content on the left. <a name="table-api-table-1-config-columns-config-columns-paddingright"></a> ###### config.columns[*].paddingRight Type: `number`\ Default: `1` The number of whitespaces used to pad the content on the right. The `paddingLeft` and `paddingRight` options do not count on the column width. So the column has `width = 5`, `paddingLeft = 2` and `paddingRight = 2` will have the total width is `9`. ```js const data = [ ['0A', 'AABBCC', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'] ]; const config = { columns: [ { paddingLeft: 3 }, { width: 2, paddingRight: 3 } ] }; console.log(table(data, config)); ``` ``` ╔══════╤══════╤════╗ ║ 0A │ AA │ 0C ║ ║ │ BB │ ║ ║ │ CC │ ║ ╟──────┼──────┼────╢ ║ 1A │ 1B │ 1C ║ ╟──────┼──────┼────╢ ║ 2A │ 2B │ 2C ║ ╚══════╧══════╧════╝ ``` <a name="table-api-table-1-config-columns-config-columns-truncate"></a> ###### config.columns[*].truncate Type: `number`\ Default: `Infinity` The number of characters is which the content will be truncated. To handle a content that overflows the container width, `table` package implements [text wrapping](#config.columns[*].wrapWord). However, sometimes you may want to truncate content that is too long to be displayed in the table. ```js const data = [ ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pulvinar nibh sed mauris convallis dapibus. Nunc venenatis tempus nulla sit amet viverra.'] ]; const config = { columns: [ { width: 20, truncate: 100 } ] }; console.log(table(data, config)); ``` ``` ╔══════════════════════╗ ║ Lorem ipsum dolor si ║ ║ t amet, consectetur ║ ║ adipiscing elit. Pha ║ ║ sellus pulvinar nibh ║ ║ sed mauris convall… ║ ╚══════════════════════╝ ``` <a name="table-api-table-1-config-columns-config-columns-wrapword"></a> ###### config.columns[*].wrapWord Type: `boolean`\ Default: `false` The `table` package implements auto text wrapping, i.e., text that has the width greater than the container width will be separated into multiple lines at the nearest space or one of the special characters: `\|/_.,;-`. When `wrapWord` is `false`: ```js const data = [ ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pulvinar nibh sed mauris convallis dapibus. Nunc venenatis tempus nulla sit amet viverra.'] ]; const config = { columns: [ { width: 20 } ] }; console.log(table(data, config)); ``` ``` ╔══════════════════════╗ ║ Lorem ipsum dolor si ║ ║ t amet, consectetur ║ ║ adipiscing elit. Pha ║ ║ sellus pulvinar nibh ║ ║ sed mauris convallis ║ ║ dapibus. Nunc venena ║ ║ tis tempus nulla sit ║ ║ amet viverra. ║ ╚══════════════════════╝ ``` When `wrapWord` is `true`: ``` ╔══════════════════════╗ ║ Lorem ipsum dolor ║ ║ sit amet, ║ ║ consectetur ║ ║ adipiscing elit. ║ ║ Phasellus pulvinar ║ ║ nibh sed mauris ║ ║ convallis dapibus. ║ ║ Nunc venenatis ║ ║ tempus nulla sit ║ ║ amet viverra. ║ ╚══════════════════════╝ ``` <a name="table-api-table-1-config-columndefault"></a> ##### config.columnDefault Type: `Column`\ Default: `{}` The default configuration for all columns. Column-specific settings will overwrite the default values. <a name="table-api-table-1-config-header"></a> ##### config.header Type: `object` Header configuration. *Deprecated in favor of the new spanning cells API.* The header configuration inherits the most of the column's, except: - `content` **{string}**: the header content. - `width:` calculate based on the content width automatically. - `alignment:` `center` be default. - `verticalAlignment:` is not supported. - `config.border.topJoin` will be `config.border.topBody` for prettier. ```js const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'], ]; const config = { columnDefault: { width: 10, }, header: { alignment: 'center', content: 'THE HEADER\nThis is the table about something', }, } console.log(table(data, config)); ``` ``` ╔══════════════════════════════════════╗ ║ THE HEADER ║ ║ This is the table about something ║ ╟────────────┬────────────┬────────────╢ ║ 0A │ 0B │ 0C ║ ╟────────────┼────────────┼────────────╢ ║ 1A │ 1B │ 1C ║ ╟────────────┼────────────┼────────────╢ ║ 2A │ 2B │ 2C ║ ╚════════════╧════════════╧════════════╝ ``` <a name="table-api-table-1-config-spanningcells"></a> ##### config.spanningCells Type: `SpanningCellConfig[]` Spanning cells configuration. The configuration should be straightforward: just specify an array of minimal cell configurations including the position of top-left cell and the number of columns and/or rows will be expanded from it. The content of overlap cells will be ignored to make the `data` shape be consistent. By default, the configuration of column that the top-left cell belongs to will be applied to the whole spanning cell, except: * The `width` will be summed up of all spanning columns. * The `paddingRight` will be received from the right-most column intentionally. Advances customized column-like styles can be configurable to each spanning cell to overwrite the default behavior. ```js const data = [ ['Test Coverage Report', '', '', '', '', ''], ['Module', 'Component', 'Test Cases', 'Failures', 'Durations', 'Success Rate'], ['Services', 'User', '50', '30', '3m 7s', '60.0%'], ['', 'Payment', '100', '80', '7m 15s', '80.0%'], ['Subtotal', '', '150', '110', '10m 22s', '73.3%'], ['Controllers', 'User', '24', '18', '1m 30s', '75.0%'], ['', 'Payment', '30', '24', '50s', '80.0%'], ['Subtotal', '', '54', '42', '2m 20s', '77.8%'], ['Total', '', '204', '152', '12m 42s', '74.5%'], ]; const config = { columns: [ { alignment: 'center', width: 12 }, { alignment: 'center', width: 10 }, { alignment: 'right' }, { alignment: 'right' }, { alignment: 'right' }, { alignment: 'right' } ], spanningCells: [ { col: 0, row: 0, colSpan: 6 }, { col: 0, row: 2, rowSpan: 2, verticalAlignment: 'middle'}, { col: 0, row: 4, colSpan: 2, alignment: 'right'}, { col: 0, row: 5, rowSpan: 2, verticalAlignment: 'middle'}, { col: 0, row: 7, colSpan: 2, alignment: 'right' }, { col: 0, row: 8, colSpan: 2, alignment: 'right' } ], }; console.log(table(data, config)); ``` ``` ╔══════════════════════════════════════════════════════════════════════════════╗ ║ Test Coverage Report ║ ╟──────────────┬────────────┬────────────┬──────────┬───────────┬──────────────╢ ║ Module │ Component │ Test Cases │ Failures │ Durations │ Success Rate ║ ╟──────────────┼────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ │ User │ 50 │ 30 │ 3m 7s │ 60.0% ║ ║ Services ├────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ │ Payment │ 100 │ 80 │ 7m 15s │ 80.0% ║ ╟──────────────┴────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ Subtotal │ 150 │ 110 │ 10m 22s │ 73.3% ║ ╟──────────────┬────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ │ User │ 24 │ 18 │ 1m 30s │ 75.0% ║ ║ Controllers ├────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ │ Payment │ 30 │ 24 │ 50s │ 80.0% ║ ╟──────────────┴────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ Subtotal │ 54 │ 42 │ 2m 20s │ 77.8% ║ ╟───────────────────────────┼────────────┼──────────┼───────────┼──────────────╢ ║ Total │ 204 │ 152 │ 12m 42s │ 74.5% ║ ╚═══════════════════════════╧════════════╧══════════╧═══════════╧══════════════╝ ``` <a name="table-api-createstream"></a> ### createStream `table` package exports `createStream` function used to draw a table and append rows. **Parameter:** - _**config:**_ the same as `table`'s, except `config.columnDefault.width` and `config.columnCount` must be provided. ```js import { createStream } from 'table'; const config = { columnDefault: { width: 50 }, columnCount: 1 }; const stream = createStream(config); setInterval(() => { stream.write([new Date()]); }, 500); ```  `table` package uses ANSI escape codes to overwrite the output of the last line when a new row is printed. The underlying implementation is explained in this [Stack Overflow answer](http://stackoverflow.com/a/32938658/368691). Streaming supports all of the configuration properties and functionality of a static table (such as auto text wrapping, alignment and padding), e.g. ```js import { createStream } from 'table'; import _ from 'lodash'; const config = { columnDefault: { width: 50 }, columnCount: 3, columns: [ { width: 10, alignment: 'right' }, { alignment: 'center' }, { width: 10 } ] }; const stream = createStream(config); let i = 0; setInterval(() => { let random; random = _.sample('abcdefghijklmnopqrstuvwxyz', _.random(1, 30)).join(''); stream.write([i++, new Date(), random]); }, 500); ```  <a name="table-api-getbordercharacters"></a> ### getBorderCharacters **Parameter:** - **_template_** - Type: `'honeywell' | 'norc' | 'ramac' | 'void'` - Required: `true` You can load one of the predefined border templates using `getBorderCharacters` function. ```js import { table, getBorderCharacters } from 'table'; const data = [ ['0A', '0B', '0C'], ['1A', '1B', '1C'], ['2A', '2B', '2C'] ]; const config = { border: getBorderCharacters(`name of the template`) }; console.log(table(data, config)); ``` ``` # honeywell ╔════╤════╤════╗ ║ 0A │ 0B │ 0C ║ ╟────┼────┼────╢ ║ 1A │ 1B │ 1C ║ ╟────┼────┼────╢ ║ 2A │ 2B │ 2C ║ ╚════╧════╧════╝ # norc ┌────┬────┬────┐ │ 0A │ 0B │ 0C │ ├────┼────┼────┤ │ 1A │ 1B │ 1C │ ├────┼────┼────┤ │ 2A │ 2B │ 2C │ └────┴────┴────┘ # ramac (ASCII; for use in terminals that do not support Unicode characters) +----+----+----+ | 0A | 0B | 0C | |----|----|----| | 1A | 1B | 1C | |----|----|----| | 2A | 2B | 2C | +----+----+----+ # void (no borders; see "borderless table" section of the documentation) 0A 0B 0C 1A 1B 1C 2A 2B 2C ``` Raise [an issue](https://github.com/gajus/table/issues) if you'd like to contribute a new border template. <a name="table-api-getbordercharacters-borderless-table"></a> #### Borderless Table Simply using `void` border character template creates a table with a lot of unnecessary spacing. To create a more pleasant to the eye table, reset the padding and remove the joining rows, e.g. ```js const output = table(data, { border: getBorderCharacters('void'), columnDefault: { paddingLeft: 0, paddingRight: 1 }, drawHorizontalLine: () => false } ); console.log(output); ``` ``` 0A 0B 0C 1A 1B 1C 2A 2B 2C ``` # has > Object.prototype.hasOwnProperty.call shortcut ## Installation ```sh npm install --save has ``` ## Usage ```js var has = require('has'); has({}, 'hasOwnProperty'); // false has(Object.prototype, 'hasOwnProperty'); // true ``` JS-YAML - YAML 1.2 parser / writer for JavaScript ================================================= [](https://travis-ci.org/nodeca/js-yaml) [](https://www.npmjs.org/package/js-yaml) __[Online Demo](http://nodeca.github.com/js-yaml/)__ This is an implementation of [YAML](http://yaml.org/), a human-friendly data serialization language. Started as [PyYAML](http://pyyaml.org/) port, it was completely rewritten from scratch. Now it's very fast, and supports 1.2 spec. Installation ------------ ### YAML module for node.js ``` npm install js-yaml ``` ### CLI executable If you want to inspect your YAML files from CLI, install js-yaml globally: ``` npm install -g js-yaml ``` #### Usage ``` usage: js-yaml [-h] [-v] [-c] [-t] file Positional arguments: file File with YAML document(s) Optional arguments: -h, --help Show this help message and exit. -v, --version Show program's version number and exit. -c, --compact Display errors in compact mode -t, --trace Show stack trace on error ``` ### Bundled YAML library for browsers ``` html <!-- esprima required only for !!js/function --> <script src="esprima.js"></script> <script src="js-yaml.min.js"></script> <script type="text/javascript"> var doc = jsyaml.load('greeting: hello\nname: world'); </script> ``` Browser support was done mostly for the online demo. If you find any errors - feel free to send pull requests with fixes. Also note, that IE and other old browsers needs [es5-shims](https://github.com/kriskowal/es5-shim) to operate. Notes: 1. We have no resources to support browserified version. Don't expect it to be well tested. Don't expect fast fixes if something goes wrong there. 2. `!!js/function` in browser bundle will not work by default. If you really need it - load `esprima` parser first (via amd or directly). 3. `!!bin` in browser will return `Array`, because browsers do not support node.js `Buffer` and adding Buffer shims is completely useless on practice. API --- Here we cover the most 'useful' methods. If you need advanced details (creating your own tags), see [wiki](https://github.com/nodeca/js-yaml/wiki) and [examples](https://github.com/nodeca/js-yaml/tree/master/examples) for more info. ``` javascript const yaml = require('js-yaml'); const fs = require('fs'); // Get document, or throw exception on error try { const doc = yaml.safeLoad(fs.readFileSync('/home/ixti/example.yml', 'utf8')); console.log(doc); } catch (e) { console.log(e); } ``` ### safeLoad (string [ , options ]) **Recommended loading way.** Parses `string` as single YAML document. Returns either a plain object, a string or `undefined`, or throws `YAMLException` on error. By default, does not support regexps, functions and undefined. This method is safe for untrusted data. options: - `filename` _(default: null)_ - string to be used as a file path in error/warning messages. - `onWarning` _(default: null)_ - function to call on warning messages. Loader will call this function with an instance of `YAMLException` for each warning. - `schema` _(default: `DEFAULT_SAFE_SCHEMA`)_ - specifies a schema to use. - `FAILSAFE_SCHEMA` - only strings, arrays and plain objects: http://www.yaml.org/spec/1.2/spec.html#id2802346 - `JSON_SCHEMA` - all JSON-supported types: http://www.yaml.org/spec/1.2/spec.html#id2803231 - `CORE_SCHEMA` - same as `JSON_SCHEMA`: http://www.yaml.org/spec/1.2/spec.html#id2804923 - `DEFAULT_SAFE_SCHEMA` - all supported YAML types, without unsafe ones (`!!js/undefined`, `!!js/regexp` and `!!js/function`): http://yaml.org/type/ - `DEFAULT_FULL_SCHEMA` - all supported YAML types. - `json` _(default: false)_ - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error. NOTE: This function **does not** understand multi-document sources, it throws exception on those. NOTE: JS-YAML **does not** support schema-specific tag resolution restrictions. So, the JSON schema is not as strictly defined in the YAML specification. It allows numbers in any notation, use `Null` and `NULL` as `null`, etc. The core schema also has no such restrictions. It allows binary notation for integers. ### load (string [ , options ]) **Use with care with untrusted sources**. The same as `safeLoad()` but uses `DEFAULT_FULL_SCHEMA` by default - adds some JavaScript-specific types: `!!js/function`, `!!js/regexp` and `!!js/undefined`. For untrusted sources, you must additionally validate object structure to avoid injections: ``` javascript const untrusted_code = '"toString": !<tag:yaml.org,2002:js/function> "function (){very_evil_thing();}"'; // I'm just converting that string, what could possibly go wrong? require('js-yaml').load(untrusted_code) + '' ``` ### safeLoadAll (string [, iterator] [, options ]) Same as `safeLoad()`, but understands multi-document sources. Applies `iterator` to each document if specified, or returns array of documents. ``` javascript const yaml = require('js-yaml'); yaml.safeLoadAll(data, function (doc) { console.log(doc); }); ``` ### loadAll (string [, iterator] [ , options ]) Same as `safeLoadAll()` but uses `DEFAULT_FULL_SCHEMA` by default. ### safeDump (object [ , options ]) Serializes `object` as a YAML document. Uses `DEFAULT_SAFE_SCHEMA`, so it will throw an exception if you try to dump regexps or functions. However, you can disable exceptions by setting the `skipInvalid` option to `true`. options: - `indent` _(default: 2)_ - indentation width to use (in spaces). - `noArrayIndent` _(default: false)_ - when true, will not add an indentation level to array elements - `skipInvalid` _(default: false)_ - do not throw on invalid types (like function in the safe schema) and skip pairs and single values with such types. - `flowLevel` (default: -1) - specifies level of nesting, when to switch from block to flow style for collections. -1 means block style everwhere - `styles` - "tag" => "style" map. Each tag may have own set of styles. - `schema` _(default: `DEFAULT_SAFE_SCHEMA`)_ specifies a schema to use. - `sortKeys` _(default: `false`)_ - if `true`, sort keys when dumping YAML. If a function, use the function to sort the keys. - `lineWidth` _(default: `80`)_ - set max line width. - `noRefs` _(default: `false`)_ - if `true`, don't convert duplicate objects into references - `noCompatMode` _(default: `false`)_ - if `true` don't try to be compatible with older yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1 - `condenseFlow` _(default: `false`)_ - if `true` flow sequences will be condensed, omitting the space between `a, b`. Eg. `'[a,b]'`, and omitting the space between `key: value` and quoting the key. Eg. `'{"a":b}'` Can be useful when using yaml for pretty URL query params as spaces are %-encoded. The following table show availlable styles (e.g. "canonical", "binary"...) available for each tag (.e.g. !!null, !!int ...). Yaml output is shown on the right side after `=>` (default setting) or `->`: ``` none !!null "canonical" -> "~" "lowercase" => "null" "uppercase" -> "NULL" "camelcase" -> "Null" !!int "binary" -> "0b1", "0b101010", "0b1110001111010" "octal" -> "01", "052", "016172" "decimal" => "1", "42", "7290" "hexadecimal" -> "0x1", "0x2A", "0x1C7A" !!bool "lowercase" => "true", "false" "uppercase" -> "TRUE", "FALSE" "camelcase" -> "True", "False" !!float "lowercase" => ".nan", '.inf' "uppercase" -> ".NAN", '.INF' "camelcase" -> ".NaN", '.Inf' ``` Example: ``` javascript safeDump (object, { 'styles': { '!!null': 'canonical' // dump null as ~ }, 'sortKeys': true // sort object keys }); ``` ### dump (object [ , options ]) Same as `safeDump()` but without limits (uses `DEFAULT_FULL_SCHEMA` by default). Supported YAML types -------------------- The list of standard YAML tags and corresponding JavaScipt types. See also [YAML tag discussion](http://pyyaml.org/wiki/YAMLTagDiscussion) and [YAML types repository](http://yaml.org/type/). ``` !!null '' # null !!bool 'yes' # bool !!int '3...' # number !!float '3.14...' # number !!binary '...base64...' # buffer !!timestamp 'YYYY-...' # date !!omap [ ... ] # array of key-value pairs !!pairs [ ... ] # array or array pairs !!set { ... } # array of objects with given keys and null values !!str '...' # string !!seq [ ... ] # array !!map { ... } # object ``` **JavaScript-specific tags** ``` !!js/regexp /pattern/gim # RegExp !!js/undefined '' # Undefined !!js/function 'function () {...}' # Function ``` Caveats ------- Note, that you use arrays or objects as key in JS-YAML. JS does not allow objects or arrays as keys, and stringifies (by calling `toString()` method) them at the moment of adding them. ``` yaml --- ? [ foo, bar ] : - baz ? { foo: bar } : - baz - baz ``` ``` javascript { "foo,bar": ["baz"], "[object Object]": ["baz", "baz"] } ``` Also, reading of properties on implicit block mapping keys is not supported yet. So, the following YAML document cannot be loaded. ``` yaml &anchor foo: foo: bar *anchor: duplicate key baz: bat *anchor: duplicate key ``` js-yaml for enterprise ---------------------- Available as part of the Tidelift Subscription The maintainers of js-yaml and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-js-yaml?utm_source=npm-js-yaml&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) # Regular Expression Tokenizer Tokenizes strings that represent a regular expressions. [](http://travis-ci.org/fent/ret.js) [](https://david-dm.org/fent/ret.js) [](https://codecov.io/gh/fent/ret.js) # Usage ```js var ret = require('ret'); var tokens = ret(/foo|bar/.source); ``` `tokens` will contain the following object ```js { "type": ret.types.ROOT "options": [ [ { "type": ret.types.CHAR, "value", 102 }, { "type": ret.types.CHAR, "value", 111 }, { "type": ret.types.CHAR, "value", 111 } ], [ { "type": ret.types.CHAR, "value", 98 }, { "type": ret.types.CHAR, "value", 97 }, { "type": ret.types.CHAR, "value", 114 } ] ] } ``` # Token Types `ret.types` is a collection of the various token types exported by ret. ### ROOT Only used in the root of the regexp. This is needed due to the posibility of the root containing a pipe `|` character. In that case, the token will have an `options` key that will be an array of arrays of tokens. If not, it will contain a `stack` key that is an array of tokens. ```js { "type": ret.types.ROOT, "stack": [token1, token2...], } ``` ```js { "type": ret.types.ROOT, "options" [ [token1, token2...], [othertoken1, othertoken2...] ... ], } ``` ### GROUP Groups contain tokens that are inside of a parenthesis. If the group begins with `?` followed by another character, it's a special type of group. A ':' tells the group not to be remembered when `exec` is used. '=' means the previous token matches only if followed by this group, and '!' means the previous token matches only if NOT followed. Like root, it can contain an `options` key instead of `stack` if there is a pipe. ```js { "type": ret.types.GROUP, "remember" true, "followedBy": false, "notFollowedBy": false, "stack": [token1, token2...], } ``` ```js { "type": ret.types.GROUP, "remember" true, "followedBy": false, "notFollowedBy": false, "options" [ [token1, token2...], [othertoken1, othertoken2...] ... ], } ``` ### POSITION `\b`, `\B`, `^`, and `$` specify positions in the regexp. ```js { "type": ret.types.POSITION, "value": "^", } ``` ### SET Contains a key `set` specifying what tokens are allowed and a key `not` specifying if the set should be negated. A set can contain other sets, ranges, and characters. ```js { "type": ret.types.SET, "set": [token1, token2...], "not": false, } ``` ### RANGE Used in set tokens to specify a character range. `from` and `to` are character codes. ```js { "type": ret.types.RANGE, "from": 97, "to": 122, } ``` ### REPETITION ```js { "type": ret.types.REPETITION, "min": 0, "max": Infinity, "value": token, } ``` ### REFERENCE References a group token. `value` is 1-9. ```js { "type": ret.types.REFERENCE, "value": 1, } ``` ### CHAR Represents a single character token. `value` is the character code. This might seem a bit cluttering instead of concatenating characters together. But since repetition tokens only repeat the last token and not the last clause like the pipe, it's simpler to do it this way. ```js { "type": ret.types.CHAR, "value": 123, } ``` ## Errors ret.js will throw errors if given a string with an invalid regular expression. All possible errors are * Invalid group. When a group with an immediate `?` character is followed by an invalid character. It can only be followed by `!`, `=`, or `:`. Example: `/(?_abc)/` * Nothing to repeat. Thrown when a repetitional token is used as the first token in the current clause, as in right in the beginning of the regexp or group, or right after a pipe. Example: `/foo|?bar/`, `/{1,3}foo|bar/`, `/foo(+bar)/` * Unmatched ). A group was not opened, but was closed. Example: `/hello)2u/` * Unterminated group. A group was not closed. Example: `/(1(23)4/` * Unterminated character class. A custom character set was not closed. Example: `/[abc/` # Install npm install ret # Tests Tests are written with [vows](http://vowsjs.org/) ```bash npm test ``` # License MIT # jsdiff [](http://travis-ci.org/kpdecker/jsdiff) [](https://saucelabs.com/u/jsdiff) A javascript text differencing implementation. Based on the algorithm proposed in ["An O(ND) Difference Algorithm and its Variations" (Myers, 1986)](http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.4.6927). ## Installation ```bash npm install diff --save ``` ## API * `Diff.diffChars(oldStr, newStr[, options])` - diffs two blocks of text, comparing character by character. Returns a list of change objects (See below). Options * `ignoreCase`: `true` to ignore casing difference. Defaults to `false`. * `Diff.diffWords(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, ignoring whitespace. Returns a list of change objects (See below). Options * `ignoreCase`: Same as in `diffChars`. * `Diff.diffWordsWithSpace(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, treating whitespace as significant. Returns a list of change objects (See below). * `Diff.diffLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line. Options * `ignoreWhitespace`: `true` to ignore leading and trailing whitespace. This is the same as `diffTrimmedLines` * `newlineIsToken`: `true` to treat newline characters as separate tokens. This allows for changes to the newline structure to occur independently of the line content and to be treated as such. In general this is the more human friendly form of `diffLines` and `diffLines` is better suited for patches and other computer friendly output. Returns a list of change objects (See below). * `Diff.diffTrimmedLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace. Returns a list of change objects (See below). * `Diff.diffSentences(oldStr, newStr[, options])` - diffs two blocks of text, comparing sentence by sentence. Returns a list of change objects (See below). * `Diff.diffCss(oldStr, newStr[, options])` - diffs two blocks of text, comparing CSS tokens. Returns a list of change objects (See below). * `Diff.diffJson(oldObj, newObj[, options])` - diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison. Returns a list of change objects (See below). * `Diff.diffArrays(oldArr, newArr[, options])` - diffs two arrays, comparing each item for strict equality (===). Options * `comparator`: `function(left, right)` for custom equality checks Returns a list of change objects (See below). * `Diff.createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch. Parameters: * `oldFileName` : String to be output in the filename section of the patch for the removals * `newFileName` : String to be output in the filename section of the patch for the additions * `oldStr` : Original string value * `newStr` : New string value * `oldHeader` : Additional information to include in the old file header * `newHeader` : Additional information to include in the new file header * `options` : An object with options. Currently, only `context` is supported and describes how many lines of context should be included. * `Diff.createPatch(fileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch. Just like Diff.createTwoFilesPatch, but with oldFileName being equal to newFileName. * `Diff.structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options)` - returns an object with an array of hunk objects. This method is similar to createTwoFilesPatch, but returns a data structure suitable for further processing. Parameters are the same as createTwoFilesPatch. The data structure returned may look like this: ```js { oldFileName: 'oldfile', newFileName: 'newfile', oldHeader: 'header1', newHeader: 'header2', hunks: [{ oldStart: 1, oldLines: 3, newStart: 1, newLines: 3, lines: [' line2', ' line3', '-line4', '+line5', '\\ No newline at end of file'], }] } ``` * `Diff.applyPatch(source, patch[, options])` - applies a unified diff patch. Return a string containing new version of provided data. `patch` may be a string diff or the output from the `parsePatch` or `structuredPatch` methods. The optional `options` object may have the following keys: - `fuzzFactor`: Number of lines that are allowed to differ before rejecting a patch. Defaults to 0. - `compareLine(lineNumber, line, operation, patchContent)`: Callback used to compare to given lines to determine if they should be considered equal when patching. Defaults to strict equality but may be overridden to provide fuzzier comparison. Should return false if the lines should be rejected. * `Diff.applyPatches(patch, options)` - applies one or more patches. This method will iterate over the contents of the patch and apply to data provided through callbacks. The general flow for each patch index is: - `options.loadFile(index, callback)` is called. The caller should then load the contents of the file and then pass that to the `callback(err, data)` callback. Passing an `err` will terminate further patch execution. - `options.patched(index, content, callback)` is called once the patch has been applied. `content` will be the return value from `applyPatch`. When it's ready, the caller should call `callback(err)` callback. Passing an `err` will terminate further patch execution. Once all patches have been applied or an error occurs, the `options.complete(err)` callback is made. * `Diff.parsePatch(diffStr)` - Parses a patch into structured data Return a JSON object representation of the a patch, suitable for use with the `applyPatch` method. This parses to the same structure returned by `Diff.structuredPatch`. * `convertChangesToXML(changes)` - converts a list of changes to a serialized XML format All methods above which accept the optional `callback` method will run in sync mode when that parameter is omitted and in async mode when supplied. This allows for larger diffs without blocking the event loop. This may be passed either directly as the final parameter or as the `callback` field in the `options` object. ### Change Objects Many of the methods above return change objects. These objects consist of the following fields: * `value`: Text content * `added`: True if the value was inserted into the new string * `removed`: True if the value was removed from the old string Note that some cases may omit a particular flag field. Comparison on the flag fields should always be done in a truthy or falsy manner. ## Examples Basic example in Node ```js require('colors'); const Diff = require('diff'); const one = 'beep boop'; const other = 'beep boob blah'; const diff = Diff.diffChars(one, other); diff.forEach((part) => { // green for additions, red for deletions // grey for common parts const color = part.added ? 'green' : part.removed ? 'red' : 'grey'; process.stderr.write(part.value[color]); }); console.log(); ``` Running the above program should yield <img src="images/node_example.png" alt="Node Example"> Basic example in a web page ```html <pre id="display"></pre> <script src="diff.js"></script> <script> const one = 'beep boop', other = 'beep boob blah', color = ''; let span = null; const diff = Diff.diffChars(one, other), display = document.getElementById('display'), fragment = document.createDocumentFragment(); diff.forEach((part) => { // green for additions, red for deletions // grey for common parts const color = part.added ? 'green' : part.removed ? 'red' : 'grey'; span = document.createElement('span'); span.style.color = color; span.appendChild(document .createTextNode(part.value)); fragment.appendChild(span); }); display.appendChild(fragment); </script> ``` Open the above .html file in a browser and you should see <img src="images/web_example.png" alt="Node Example"> **[Full online demo](http://kpdecker.github.com/jsdiff)** ## Compatibility [](https://saucelabs.com/u/jsdiff) jsdiff supports all ES3 environments with some known issues on IE8 and below. Under these browsers some diff algorithms such as word diff and others may fail due to lack of support for capturing groups in the `split` operation. ## License See [LICENSE](https://github.com/kpdecker/jsdiff/blob/master/LICENSE). Railroad-diagram Generator ========================== This is a small js library for generating railroad diagrams (like what [JSON.org](http://json.org) uses) using SVG. Railroad diagrams are a way of visually representing a grammar in a form that is more readable than using regular expressions or BNF. I think (though I haven't given it a lot of thought yet) that if it's easy to write a context-free grammar for the language, the corresponding railroad diagram will be easy as well. There are several railroad-diagram generators out there, but none of them had the visual appeal I wanted. [Here's an example of how they look!](http://www.xanthir.com/etc/railroad-diagrams/example.html) And [here's an online generator for you to play with and get SVG code from!](http://www.xanthir.com/etc/railroad-diagrams/generator.html) The library now exists in a Python port as well! See the information further down. Details ------- To use the library, just include the js and css files, and then call the Diagram() function. Its arguments are the components of the diagram (Diagram is a special form of Sequence). An alternative to Diagram() is ComplexDiagram() which is used to describe a complex type diagram. Components are either leaves or containers. The leaves: * Terminal(text) or a bare string - represents literal text * NonTerminal(text) - represents an instruction or another production * Comment(text) - a comment * Skip() - an empty line The containers: * Sequence(children) - like simple concatenation in a regex * Choice(index, children) - like | in a regex. The index argument specifies which child is the "normal" choice and should go in the middle * Optional(child, skip) - like ? in a regex. A shorthand for `Choice(1, [Skip(), child])`. If the optional `skip` parameter has the value `"skip"`, it instead puts the Skip() in the straight-line path, for when the "normal" behavior is to omit the item. * OneOrMore(child, repeat) - like + in a regex. The 'repeat' argument is optional, and specifies something that must go between the repetitions. * ZeroOrMore(child, repeat, skip) - like * in a regex. A shorthand for `Optional(OneOrMore(child, repeat))`. The optional `skip` parameter is identical to Optional(). For convenience, each component can be called with or without `new`. If called without `new`, the container components become n-ary; that is, you can say either `new Sequence([A, B])` or just `Sequence(A,B)`. After constructing a Diagram, call `.format(...padding)` on it, specifying 0-4 padding values (just like CSS) for some additional "breathing space" around the diagram (the paddings default to 20px). The result can either be `.toString()`'d for the markup, or `.toSVG()`'d for an `<svg>` element, which can then be immediately inserted to the document. As a convenience, Diagram also has an `.addTo(element)` method, which immediately converts it to SVG and appends it to the referenced element with default paddings. `element` defaults to `document.body`. Options ------- There are a few options you can tweak, at the bottom of the file. Just tweak either until the diagram looks like what you want. You can also change the CSS file - feel free to tweak to your heart's content. Note, though, that if you change the text sizes in the CSS, you'll have to go adjust the metrics for the leaf nodes as well. * VERTICAL_SEPARATION - sets the minimum amount of vertical separation between two items. Note that the stroke width isn't counted when computing the separation; this shouldn't be relevant unless you have a very small separation or very large stroke width. * ARC_RADIUS - the radius of the arcs used in the branching containers like Choice. This has a relatively large effect on the size of non-trivial diagrams. Both tight and loose values look good, depending on what you're going for. * DIAGRAM_CLASS - the class set on the root `<svg>` element of each diagram, for use in the CSS stylesheet. * STROKE_ODD_PIXEL_LENGTH - the default stylesheet uses odd pixel lengths for 'stroke'. Due to rasterization artifacts, they look best when the item has been translated half a pixel in both directions. If you change the styling to use a stroke with even pixel lengths, you'll want to set this variable to `false`. * INTERNAL_ALIGNMENT - when some branches of a container are narrower than others, this determines how they're aligned in the extra space. Defaults to "center", but can be set to "left" or "right". Caveats ------- At this early stage, the generator is feature-complete and works as intended, but still has several TODOs: * The font-sizes are hard-coded right now, and the font handling in general is very dumb - I'm just guessing at some metrics that are probably "good enough" rather than measuring things properly. Python Port ----------- In addition to the canonical JS version, the library now exists as a Python library as well. Using it is basically identical. The config variables are globals in the file, and so may be adjusted either manually or via tweaking from inside your program. The main difference from the JS port is how you extract the string from the Diagram. You'll find a `writeSvg(writerFunc)` method on `Diagram`, which takes a callback of one argument and passes it the string form of the diagram. For example, it can be used like `Diagram(...).writeSvg(sys.stdout.write)` to write to stdout. **Note**: the callback will be called multiple times as it builds up the string, not just once with the whole thing. If you need it all at once, consider something like a `StringIO` as an easy way to collect it into a single string. License ------- This document and all associated files in the github project are licensed under [CC0](http://creativecommons.org/publicdomain/zero/1.0/) . This means you can reuse, remix, or otherwise appropriate this project for your own use **without restriction**. (The actual legal meaning can be found at the above link.) Don't ask me for permission to use any part of this project, **just use it**. I would appreciate attribution, but that is not required by the license. # URI.js URI.js is an [RFC 3986](http://www.ietf.org/rfc/rfc3986.txt) compliant, scheme extendable URI parsing/validating/resolving library for all JavaScript environments (browsers, Node.js, etc). It is also compliant with the IRI ([RFC 3987](http://www.ietf.org/rfc/rfc3987.txt)), IDNA ([RFC 5890](http://www.ietf.org/rfc/rfc5890.txt)), IPv6 Address ([RFC 5952](http://www.ietf.org/rfc/rfc5952.txt)), IPv6 Zone Identifier ([RFC 6874](http://www.ietf.org/rfc/rfc6874.txt)) specifications. URI.js has an extensive test suite, and works in all (Node.js, web) environments. It weighs in at 6.4kb (gzipped, 17kb deflated). ## API ### Parsing URI.parse("uri://user:pass@example.com:123/one/two.three?q1=a1&q2=a2#body"); //returns: //{ // scheme : "uri", // userinfo : "user:pass", // host : "example.com", // port : 123, // path : "/one/two.three", // query : "q1=a1&q2=a2", // fragment : "body" //} ### Serializing URI.serialize({scheme : "http", host : "example.com", fragment : "footer"}) === "http://example.com/#footer" ### Resolving URI.resolve("uri://a/b/c/d?q", "../../g") === "uri://a/g" ### Normalizing URI.normalize("HTTP://ABC.com:80/%7Esmith/home.html") === "http://abc.com/~smith/home.html" ### Comparison URI.equal("example://a/b/c/%7Bfoo%7D", "eXAMPLE://a/./b/../b/%63/%7bfoo%7d") === true ### IP Support //IPv4 normalization URI.normalize("//192.068.001.000") === "//192.68.1.0" //IPv6 normalization URI.normalize("//[2001:0:0DB8::0:0001]") === "//[2001:0:db8::1]" //IPv6 zone identifier support URI.parse("//[2001:db8::7%25en1]"); //returns: //{ // host : "2001:db8::7%en1" //} ### IRI Support //convert IRI to URI URI.serialize(URI.parse("http://examplé.org/rosé")) === "http://xn--exampl-gva.org/ros%C3%A9" //convert URI to IRI URI.serialize(URI.parse("http://xn--exampl-gva.org/ros%C3%A9"), {iri:true}) === "http://examplé.org/rosé" ### Options All of the above functions can accept an additional options argument that is an object that can contain one or more of the following properties: * `scheme` (string) Indicates the scheme that the URI should be treated as, overriding the URI's normal scheme parsing behavior. * `reference` (string) If set to `"suffix"`, it indicates that the URI is in the suffix format, and the validator will use the option's `scheme` property to determine the URI's scheme. * `tolerant` (boolean, false) If set to `true`, the parser will relax URI resolving rules. * `absolutePath` (boolean, false) If set to `true`, the serializer will not resolve a relative `path` component. * `iri` (boolean, false) If set to `true`, the serializer will unescape non-ASCII characters as per [RFC 3987](http://www.ietf.org/rfc/rfc3987.txt). * `unicodeSupport` (boolean, false) If set to `true`, the parser will unescape non-ASCII characters in the parsed output as per [RFC 3987](http://www.ietf.org/rfc/rfc3987.txt). * `domainHost` (boolean, false) If set to `true`, the library will treat the `host` component as a domain name, and convert IDNs (International Domain Names) as per [RFC 5891](http://www.ietf.org/rfc/rfc5891.txt). ## Scheme Extendable URI.js supports inserting custom [scheme](http://en.wikipedia.org/wiki/URI_scheme) dependent processing rules. Currently, URI.js has built in support for the following schemes: * http \[[RFC 2616](http://www.ietf.org/rfc/rfc2616.txt)\] * https \[[RFC 2818](http://www.ietf.org/rfc/rfc2818.txt)\] * ws \[[RFC 6455](http://www.ietf.org/rfc/rfc6455.txt)\] * wss \[[RFC 6455](http://www.ietf.org/rfc/rfc6455.txt)\] * mailto \[[RFC 6068](http://www.ietf.org/rfc/rfc6068.txt)\] * urn \[[RFC 2141](http://www.ietf.org/rfc/rfc2141.txt)\] * urn:uuid \[[RFC 4122](http://www.ietf.org/rfc/rfc4122.txt)\] ### HTTP/HTTPS Support URI.equal("HTTP://ABC.COM:80", "http://abc.com/") === true URI.equal("https://abc.com", "HTTPS://ABC.COM:443/") === true ### WS/WSS Support URI.parse("wss://example.com/foo?bar=baz"); //returns: //{ // scheme : "wss", // host: "example.com", // resourceName: "/foo?bar=baz", // secure: true, //} URI.equal("WS://ABC.COM:80/chat#one", "ws://abc.com/chat") === true ### Mailto Support URI.parse("mailto:alpha@example.com,bravo@example.com?subject=SUBSCRIBE&body=Sign%20me%20up!"); //returns: //{ // scheme : "mailto", // to : ["alpha@example.com", "bravo@example.com"], // subject : "SUBSCRIBE", // body : "Sign me up!" //} URI.serialize({ scheme : "mailto", to : ["alpha@example.com"], subject : "REMOVE", body : "Please remove me", headers : { cc : "charlie@example.com" } }) === "mailto:alpha@example.com?cc=charlie@example.com&subject=REMOVE&body=Please%20remove%20me" ### URN Support URI.parse("urn:example:foo"); //returns: //{ // scheme : "urn", // nid : "example", // nss : "foo", //} #### URN UUID Support URI.parse("urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6"); //returns: //{ // scheme : "urn", // nid : "uuid", // uuid : "f81d4fae-7dec-11d0-a765-00a0c91e6bf6", //} ## Usage To load in a browser, use the following tag: <script type="text/javascript" src="uri-js/dist/es5/uri.all.min.js"></script> To load in a CommonJS/Module environment, first install with npm/yarn by running on the command line: npm install uri-js # OR yarn add uri-js Then, in your code, load it using: const URI = require("uri-js"); If you are writing your code in ES6+ (ESNEXT) or TypeScript, you would load it using: import * as URI from "uri-js"; Or you can load just what you need using named exports: import { parse, serialize, resolve, resolveComponents, normalize, equal, removeDotSegments, pctEncChar, pctDecChars, escapeComponent, unescapeComponent } from "uri-js"; ## Breaking changes ### Breaking changes from 3.x URN parsing has been completely changed to better align with the specification. Scheme is now always `urn`, but has two new properties: `nid` which contains the Namspace Identifier, and `nss` which contains the Namespace Specific String. The `nss` property will be removed by higher order scheme handlers, such as the UUID URN scheme handler. The UUID of a URN can now be found in the `uuid` property. ### Breaking changes from 2.x URI validation has been removed as it was slow, exposed a vulnerabilty, and was generally not useful. ### Breaking changes from 1.x The `errors` array on parsed components is now an `error` string. # base-x [](https://www.npmjs.org/package/base-x) [](https://travis-ci.org/cryptocoinjs/base-x) [](https://github.com/feross/standard) Fast base encoding / decoding of any given alphabet using bitcoin style leading zero compression. **WARNING:** This module is **NOT RFC3548** compliant, it cannot be used for base16 (hex), base32, or base64 encoding in a standards compliant manner. ## Example Base58 ``` javascript var BASE58 = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz' var bs58 = require('base-x')(BASE58) var decoded = bs58.decode('5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr') console.log(decoded) // => <Buffer 80 ed db dc 11 68 f1 da ea db d3 e4 4c 1e 3f 8f 5a 28 4c 20 29 f7 8a d2 6a f9 85 83 a4 99 de 5b 19> console.log(bs58.encode(decoded)) // => 5Kd3NBUAdUnhyzenEwVLy9pBKxSwXvE9FMPyR4UKZvpe6E3AgLr ``` ### Alphabets See below for a list of commonly recognized alphabets, and their respective base. Base | Alphabet ------------- | ------------- 2 | `01` 8 | `01234567` 11 | `0123456789a` 16 | `0123456789abcdef` 32 | `0123456789ABCDEFGHJKMNPQRSTVWXYZ` 32 | `ybndrfg8ejkmcpqxot1uwisza345h769` (z-base-32) 36 | `0123456789abcdefghijklmnopqrstuvwxyz` 58 | `123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz` 62 | `0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ` 64 | `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/` 67 | `ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_.!~` ## How it works It encodes octet arrays by doing long divisions on all significant digits in the array, creating a representation of that number in the new base. Then for every leading zero in the input (not significant as a number) it will encode as a single leader character. This is the first in the alphabet and will decode as 8 bits. The other characters depend upon the base. For example, a base58 alphabet packs roughly 5.858 bits per character. This means the encoded string 000f (using a base16, 0-f alphabet) will actually decode to 4 bytes unlike a canonical hex encoding which uniformly packs 4 bits into each character. While unusual, this does mean that no padding is required and it works for bases like 43. ## LICENSE [MIT](LICENSE) A direct derivation of the base58 implementation from [`bitcoin/bitcoin`](https://github.com/bitcoin/bitcoin/blob/f1e2f2a85962c1664e4e55471061af0eaa798d40/src/base58.cpp), generalized for variable length alphabets. Overview [](https://travis-ci.org/lydell/js-tokens) ======== A regex that tokenizes JavaScript. ```js var jsTokens = require("js-tokens").default var jsString = "var foo=opts.foo;\n..." jsString.match(jsTokens) // ["var", " ", "foo", "=", "opts", ".", "foo", ";", "\n", ...] ``` Installation ============ `npm install js-tokens` ```js import jsTokens from "js-tokens" // or: var jsTokens = require("js-tokens").default ``` Usage ===== ### `jsTokens` ### A regex with the `g` flag that matches JavaScript tokens. The regex _always_ matches, even invalid JavaScript and the empty string. The next match is always directly after the previous. ### `var token = matchToToken(match)` ### ```js import {matchToToken} from "js-tokens" // or: var matchToToken = require("js-tokens").matchToToken ``` Takes a `match` returned by `jsTokens.exec(string)`, and returns a `{type: String, value: String}` object. The following types are available: - string - comment - regex - number - name - punctuator - whitespace - invalid Multi-line comments and strings also have a `closed` property indicating if the token was closed or not (see below). Comments and strings both come in several flavors. To distinguish them, check if the token starts with `//`, `/*`, `'`, `"` or `` ` ``. Names are ECMAScript IdentifierNames, that is, including both identifiers and keywords. You may use [is-keyword-js] to tell them apart. Whitespace includes both line terminators and other whitespace. [is-keyword-js]: https://github.com/crissdev/is-keyword-js ECMAScript support ================== The intention is to always support the latest ECMAScript version whose feature set has been finalized. If adding support for a newer version requires changes, a new version with a major verion bump will be released. Currently, ECMAScript 2018 is supported. Invalid code handling ===================== Unterminated strings are still matched as strings. JavaScript strings cannot contain (unescaped) newlines, so unterminated strings simply end at the end of the line. Unterminated template strings can contain unescaped newlines, though, so they go on to the end of input. Unterminated multi-line comments are also still matched as comments. They simply go on to the end of the input. Unterminated regex literals are likely matched as division and whatever is inside the regex. Invalid ASCII characters have their own capturing group. Invalid non-ASCII characters are treated as names, to simplify the matching of names (except unicode spaces which are treated as whitespace). Note: See also the [ES2018](#es2018) section. Regex literals may contain invalid regex syntax. They are still matched as regex literals. They may also contain repeated regex flags, to keep the regex simple. Strings may contain invalid escape sequences. Limitations =========== Tokenizing JavaScript using regexes—in fact, _one single regex_—won’t be perfect. But that’s not the point either. You may compare jsTokens with [esprima] by using `esprima-compare.js`. See `npm run esprima-compare`! [esprima]: http://esprima.org/ ### Template string interpolation ### Template strings are matched as single tokens, from the starting `` ` `` to the ending `` ` ``, including interpolations (whose tokens are not matched individually). Matching template string interpolations requires recursive balancing of `{` and `}`—something that JavaScript regexes cannot do. Only one level of nesting is supported. ### Division and regex literals collision ### Consider this example: ```js var g = 9.82 var number = bar / 2/g var regex = / 2/g ``` A human can easily understand that in the `number` line we’re dealing with division, and in the `regex` line we’re dealing with a regex literal. How come? Because humans can look at the whole code to put the `/` characters in context. A JavaScript regex cannot. It only sees forwards. (Well, ES2018 regexes can also look backwards. See the [ES2018](#es2018) section). When the `jsTokens` regex scans throught the above, it will see the following at the end of both the `number` and `regex` rows: ```js / 2/g ``` It is then impossible to know if that is a regex literal, or part of an expression dealing with division. Here is a similar case: ```js foo /= 2/g foo(/= 2/g) ``` The first line divides the `foo` variable with `2/g`. The second line calls the `foo` function with the regex literal `/= 2/g`. Again, since `jsTokens` only sees forwards, it cannot tell the two cases apart. There are some cases where we _can_ tell division and regex literals apart, though. First off, we have the simple cases where there’s only one slash in the line: ```js var foo = 2/g foo /= 2 ``` Regex literals cannot contain newlines, so the above cases are correctly identified as division. Things are only problematic when there are more than one non-comment slash in a single line. Secondly, not every character is a valid regex flag. ```js var number = bar / 2/e ``` The above example is also correctly identified as division, because `e` is not a valid regex flag. I initially wanted to future-proof by allowing `[a-zA-Z]*` (any letter) as flags, but it is not worth it since it increases the amount of ambigous cases. So only the standard `g`, `m`, `i`, `y` and `u` flags are allowed. This means that the above example will be identified as division as long as you don’t rename the `e` variable to some permutation of `gmiyus` 1 to 6 characters long. Lastly, we can look _forward_ for information. - If the token following what looks like a regex literal is not valid after a regex literal, but is valid in a division expression, then the regex literal is treated as division instead. For example, a flagless regex cannot be followed by a string, number or name, but all of those three can be the denominator of a division. - Generally, if what looks like a regex literal is followed by an operator, the regex literal is treated as division instead. This is because regexes are seldomly used with operators (such as `+`, `*`, `&&` and `==`), but division could likely be part of such an expression. Please consult the regex source and the test cases for precise information on when regex or division is matched (should you need to know). In short, you could sum it up as: If the end of a statement looks like a regex literal (even if it isn’t), it will be treated as one. Otherwise it should work as expected (if you write sane code). ### ES2018 ### ES2018 added some nice regex improvements to the language. - [Unicode property escapes] should allow telling names and invalid non-ASCII characters apart without blowing up the regex size. - [Lookbehind assertions] should allow matching telling division and regex literals apart in more cases. - [Named capture groups] might simplify some things. These things would be nice to do, but are not critical. They probably have to wait until the oldest maintained Node.js LTS release supports those features. [Unicode property escapes]: http://2ality.com/2017/07/regexp-unicode-property-escapes.html [Lookbehind assertions]: http://2ality.com/2017/05/regexp-lookbehind-assertions.html [Named capture groups]: http://2ality.com/2017/05/regexp-named-capture-groups.html License ======= [MIT](LICENSE). test ================== This [React] app was initialized with [create-near-app] Quick Start =========== To run this project locally: 1. Prerequisites: Make sure you've installed [Node.js] ≥ 12 2. Install dependencies: `yarn install` 3. Run the local development server: `yarn dev` (see `package.json` for a full list of `scripts` you can run with `yarn`) Now you'll have a local development environment backed by the NEAR TestNet! Go ahead and play with the app and the code. As you make code changes, the app will automatically reload. Exploring The Code ================== 1. The "backend" code lives in the `/contract` folder. See the README there for more info. 2. The frontend code lives in the `/src` folder. `/src/index.html` is a great place to start exploring. Note that it loads in `/src/index.js`, where you can learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `yarn run test`. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally: yarn install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `test.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `test.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account test.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: set contract name in code --------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'test.YOUR-NAME.testnet' Step 3: deploy! --------------- One command: yarn deploy As you can see in `package.json`, this does two things: 1. builds & deploys smart contract to NEAR TestNet 2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere. Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [React]: https://reactjs.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/docs/concepts/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages <p align="center"> <a href="https://assemblyscript.org" target="_blank" rel="noopener"><img width="100" src="https://avatars1.githubusercontent.com/u/28916798?s=200&v=4" alt="AssemblyScript logo"></a> </p> <p align="center"> <a href="https://github.com/AssemblyScript/assemblyscript/actions?query=workflow%3ATest"><img src="https://img.shields.io/github/workflow/status/AssemblyScript/assemblyscript/Test/master?label=test&logo=github" alt="Test status" /></a> <a href="https://github.com/AssemblyScript/assemblyscript/actions?query=workflow%3APublish"><img src="https://img.shields.io/github/workflow/status/AssemblyScript/assemblyscript/Publish/master?label=publish&logo=github" alt="Publish status" /></a> <a href="https://www.npmjs.com/package/assemblyscript"><img src="https://img.shields.io/npm/v/assemblyscript.svg?label=compiler&color=007acc&logo=npm" alt="npm compiler version" /></a> <a href="https://www.npmjs.com/package/@assemblyscript/loader"><img src="https://img.shields.io/npm/v/@assemblyscript/loader.svg?label=loader&color=007acc&logo=npm" alt="npm loader version" /></a> <a href="https://discord.gg/assemblyscript"><img src="https://img.shields.io/discord/721472913886281818.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2" alt="Discord online" /></a> </p> <p align="justify"><strong>AssemblyScript</strong> compiles a strict variant of <a href="http://www.typescriptlang.org">TypeScript</a> (basically JavaScript with types) to <a href="http://webassembly.org">WebAssembly</a> using <a href="https://github.com/WebAssembly/binaryen">Binaryen</a>. It generates lean and mean WebAssembly modules while being just an <code>npm install</code> away.</p> <h3 align="center"> <a href="https://assemblyscript.org">About</a> &nbsp;·&nbsp; <a href="https://assemblyscript.org/introduction.html">Introduction</a> &nbsp;·&nbsp; <a href="https://assemblyscript.org/quick-start.html">Quick&nbsp;start</a> &nbsp;·&nbsp; <a href="https://assemblyscript.org/examples.html">Examples</a> &nbsp;·&nbsp; <a href="https://assemblyscript.org/development.html">Development&nbsp;instructions</a> </h3> <br> <h2 align="center">Contributors</h2> <p align="center"> <a href="https://assemblyscript.org/#contributors"><img src="https://assemblyscript.org/contributors.svg" alt="Contributor logos" width="720" /></a> </p> <h2 align="center">Thanks to our sponsors!</h2> <p align="justify">Most of the core team members and most contributors do this open source work in their free time. If you use AssemblyScript for a serious task or plan to do so, and you'd like us to invest more time on it, <a href="https://opencollective.com/assemblyscript/donate" target="_blank" rel="noopener">please donate</a> to our <a href="https://opencollective.com/assemblyscript" target="_blank" rel="noopener">OpenCollective</a>. By sponsoring this project, your logo will show up below. Thank you so much for your support!</p> <p align="center"> <a href="https://assemblyscript.org/#sponsors"><img src="https://assemblyscript.org/sponsors.svg" alt="Sponsor logos" width="720" /></a> </p> # node-supports-preserve-symlinks-flag ^{[![Version Badge][npm-version-svg]][package-url]} [![github actions][actions-image]][actions-url] [![coverage][codecov-image]][codecov-url] [![dependency status][deps-svg]][deps-url] [![dev dependency status][dev-deps-svg]][dev-deps-url] [![License][license-image]][license-url] [![Downloads][downloads-image]][downloads-url] [![npm badge][npm-badge-png]][package-url] Determine if the current node version supports the `--preserve-symlinks` flag. ## Example ```js var supportsPreserveSymlinks = require('node-supports-preserve-symlinks-flag'); var assert = require('assert'); assert.equal(supportsPreserveSymlinks, null); // in a browser assert.equal(supportsPreserveSymlinks, false); // in node < v6.2 assert.equal(supportsPreserveSymlinks, true); // in node v6.2+ ``` ## Tests Simply clone the repo, `npm install`, and run `npm test` [package-url]: https://npmjs.org/package/node-supports-preserve-symlinks-flag [npm-version-svg]: https://versionbadg.es/inspect-js/node-supports-preserve-symlinks-flag.svg [deps-svg]: https://david-dm.org/inspect-js/node-supports-preserve-symlinks-flag.svg [deps-url]: https://david-dm.org/inspect-js/node-supports-preserve-symlinks-flag [dev-deps-svg]: https://david-dm.org/inspect-js/node-supports-preserve-symlinks-flag/dev-status.svg [dev-deps-url]: https://david-dm.org/inspect-js/node-supports-preserve-symlinks-flag#info=devDependencies [npm-badge-png]: https://nodei.co/npm/node-supports-preserve-symlinks-flag.png?downloads=true&stars=true [license-image]: https://img.shields.io/npm/l/node-supports-preserve-symlinks-flag.svg [license-url]: LICENSE [downloads-image]: https://img.shields.io/npm/dm/node-supports-preserve-symlinks-flag.svg [downloads-url]: https://npm-stat.com/charts.html?package=node-supports-preserve-symlinks-flag [codecov-image]: https://codecov.io/gh/inspect-js/node-supports-preserve-symlinks-flag/branch/main/graphs/badge.svg [codecov-url]: https://app.codecov.io/gh/inspect-js/node-supports-preserve-symlinks-flag/ [actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/inspect-js/node-supports-preserve-symlinks-flag [actions-url]: https://github.com/inspect-js/node-supports-preserve-symlinks-flag/actions # flat-cache > A stupidly simple key/value storage using files to persist the data [](https://npmjs.org/package/flat-cache) [](https://travis-ci.org/royriojas/flat-cache) ## install ```bash npm i --save flat-cache ``` ## Usage ```js var flatCache = require('flat-cache') // loads the cache, if one does not exists for the given // Id a new one will be prepared to be created var cache = flatCache.load('cacheId'); // sets a key on the cache cache.setKey('key', { foo: 'var' }); // get a key from the cache cache.getKey('key') // { foo: 'var' } // fetch the entire persisted object cache.all() // { 'key': { foo: 'var' } } // remove a key cache.removeKey('key'); // removes a key from the cache // save it to disk cache.save(); // very important, if you don't save no changes will be persisted. // cache.save( true /* noPrune */) // can be used to prevent the removal of non visited keys // loads the cache from a given directory, if one does // not exists for the given Id a new one will be prepared to be created var cache = flatCache.load('cacheId', path.resolve('./path/to/folder')); // The following methods are useful to clear the cache // delete a given cache flatCache.clearCacheById('cacheId') // removes the cacheId document if one exists. // delete all cache flatCache.clearAll(); // remove the cache directory ``` ## Motivation for this module I needed a super simple and dumb **in-memory cache** with optional disk persistance in order to make a script that will beutify files with `esformatter` only execute on the files that were changed since the last run. To make that possible we need to store the `fileSize` and `modificationTime` of the files. So a simple `key/value` storage was needed and Bam! this module was born. ## Important notes - If no directory is especified when the `load` method is called, a folder named `.cache` will be created inside the module directory when `cache.save` is called. If you're committing your `node_modules` to any vcs, you might want to ignore the default `.cache` folder, or specify a custom directory. - The values set on the keys of the cache should be `stringify-able` ones, meaning no circular references - All the changes to the cache state are done to memory - I could have used a timer or `Object.observe` to deliver the changes to disk, but I wanted to keep this module intentionally dumb and simple - Non visited keys are removed when `cache.save()` is called. If this is not desired, you can pass `true` to the save call like: `cache.save( true /* noPrune */ )`. ## License MIT ## Changelog [changelog](./changelog.md) # isexe Minimal module to check if a file is executable, and a normal file. Uses `fs.stat` and tests against the `PATHEXT` environment variable on Windows. ## USAGE ```javascript var isexe = require('isexe') isexe('some-file-name', function (err, isExe) { if (err) { console.error('probably file does not exist or something', err) } else if (isExe) { console.error('this thing can be run') } else { console.error('cannot be run') } }) // same thing but synchronous, throws errors var isExe = isexe.sync('some-file-name') // treat errors as just "not executable" isexe('maybe-missing-file', { ignoreErrors: true }, callback) var isExe = isexe.sync('maybe-missing-file', { ignoreErrors: true }) ``` ## API ### `isexe(path, [options], [callback])` Check if the path is executable. If no callback provided, and a global `Promise` object is available, then a Promise will be returned. Will raise whatever errors may be raised by `fs.stat`, unless `options.ignoreErrors` is set to true. ### `isexe.sync(path, [options])` Same as `isexe` but returns the value and throws any errors raised. ### Options * `ignoreErrors` Treat all errors as "no, this is not executable", but don't raise them. * `uid` Number to use as the user id * `gid` Number to use as the group id * `pathExt` List of path extensions to use instead of `PATHEXT` environment variable on Windows. # AssemblyScript Rtrace A tiny utility to sanitize the AssemblyScript runtime. Records allocations and frees performed by the runtime and emits an error if something is off. Also checks for leaks. Instructions ------------ Compile your module that uses the full or half runtime with `-use ASC_RTRACE=1 --explicitStart` and include an instance of this module as the import named `rtrace`. ```js const rtrace = new Rtrace({ onerror(err, info) { // handle error }, oninfo(msg) { // print message, optional }, getMemory() { // obtain the module's memory, // e.g. with --explicitStart: return instance.exports.memory; } }); const { module, instance } = await WebAssembly.instantiate(..., rtrace.install({ ...imports... }) ); instance.exports._start(); ... if (rtrace.active) { let leakCount = rtr.check(); if (leakCount) { // handle error } } ``` Note that references in globals which are not cleared before collection is performed appear as leaks, including their inner members. A TypedArray would leak itself and its backing ArrayBuffer in this case for example. This is perfectly normal and clearing all globals avoids this. # fast-levenshtein - Levenshtein algorithm in Javascript [](http://travis-ci.org/hiddentao/fast-levenshtein) [](https://badge.fury.io/js/fast-levenshtein) [](https://www.npmjs.com/package/fast-levenshtein) [](https://twitter.com/hiddentao) An efficient Javascript implementation of the [Levenshtein algorithm](http://en.wikipedia.org/wiki/Levenshtein_distance) with locale-specific collator support. ## Features * Works in node.js and in the browser. * Better performance than other implementations by not needing to store the whole matrix ([more info](http://www.codeproject.com/Articles/13525/Fast-memory-efficient-Levenshtein-algorithm)). * Locale-sensitive string comparisions if needed. * Comprehensive test suite and performance benchmark. * Small: <1 KB minified and gzipped ## Installation ### node.js Install using [npm](http://npmjs.org/): ```bash $ npm install fast-levenshtein ``` ### Browser Using bower: ```bash $ bower install fast-levenshtein ``` If you are not using any module loader system then the API will then be accessible via the `window.Levenshtein` object. ## Examples **Default usage** ```javascript var levenshtein = require('fast-levenshtein'); var distance = levenshtein.get('back', 'book'); // 2 var distance = levenshtein.get('我愛你', '我叫你'); // 1 ``` **Locale-sensitive string comparisons** It supports using [Intl.Collator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator) for locale-sensitive string comparisons: ```javascript var levenshtein = require('fast-levenshtein'); levenshtein.get('mikailovitch', 'Mikhaïlovitch', { useCollator: true}); // 1 ``` ## Building and Testing To build the code and run the tests: ```bash $ npm install -g grunt-cli $ npm install $ npm run build ``` ## Performance _Thanks to [Titus Wormer](https://github.com/wooorm) for [encouraging me](https://github.com/hiddentao/fast-levenshtein/issues/1) to do this._ Benchmarked against other node.js levenshtein distance modules (on Macbook Air 2012, Core i7, 8GB RAM): ```bash Running suite Implementation comparison [benchmark/speed.js]... >> levenshtein-edit-distance x 234 ops/sec ±3.02% (73 runs sampled) >> levenshtein-component x 422 ops/sec ±4.38% (83 runs sampled) >> levenshtein-deltas x 283 ops/sec ±3.83% (78 runs sampled) >> natural x 255 ops/sec ±0.76% (88 runs sampled) >> levenshtein x 180 ops/sec ±3.55% (86 runs sampled) >> fast-levenshtein x 1,792 ops/sec ±2.72% (95 runs sampled) Benchmark done. Fastest test is fast-levenshtein at 4.2x faster than levenshtein-component ``` You can run this benchmark yourself by doing: ```bash $ npm install $ npm run build $ npm run benchmark ``` ## Contributing If you wish to submit a pull request please update and/or create new tests for any changes you make and ensure the grunt build passes. See [CONTRIBUTING.md](https://github.com/hiddentao/fast-levenshtein/blob/master/CONTRIBUTING.md) for details. ## License MIT - see [LICENSE.md](https://github.com/hiddentao/fast-levenshtein/blob/master/LICENSE.md) # y18n [![NPM version][npm-image]][npm-url] [![js-standard-style][standard-image]][standard-url] [](https://conventionalcommits.org) The bare-bones internationalization library used by yargs. Inspired by [i18n](https://www.npmjs.com/package/i18n). ## Examples _simple string translation:_ ```js const __ = require('y18n')().__; console.log(__('my awesome string %s', 'foo')); ``` output: `my awesome string foo` _using tagged template literals_ ```js const __ = require('y18n')().__; const str = 'foo'; console.log(__`my awesome string ${str}`); ``` output: `my awesome string foo` _pluralization support:_ ```js const __n = require('y18n')().__n; console.log(__n('one fish %s', '%d fishes %s', 2, 'foo')); ``` output: `2 fishes foo` ## Deno Example As of `v5` `y18n` supports [Deno](https://github.com/denoland/deno): ```typescript import y18n from "https://deno.land/x/y18n/deno.ts"; const __ = y18n({ locale: 'pirate', directory: './test/locales' }).__ console.info(__`Hi, ${'Ben'} ${'Coe'}!`) ``` You will need to run with `--allow-read` to load alternative locales. ## JSON Language Files The JSON language files should be stored in a `./locales` folder. File names correspond to locales, e.g., `en.json`, `pirate.json`. When strings are observed for the first time they will be added to the JSON file corresponding to the current locale. ## Methods ### require('y18n')(config) Create an instance of y18n with the config provided, options include: * `directory`: the locale directory, default `./locales`. * `updateFiles`: should newly observed strings be updated in file, default `true`. * `locale`: what locale should be used. * `fallbackToLanguage`: should fallback to a language-only file (e.g. `en.json`) be allowed if a file matching the locale does not exist (e.g. `en_US.json`), default `true`. ### y18n.\_\_(str, arg, arg, arg) Print a localized string, `%s` will be replaced with `arg`s. This function can also be used as a tag for a template literal. You can use it like this: <code>__&#96;hello ${'world'}&#96;</code>. This will be equivalent to `__('hello %s', 'world')`. ### y18n.\_\_n(singularString, pluralString, count, arg, arg, arg) Print a localized string with appropriate pluralization. If `%d` is provided in the string, the `count` will replace this placeholder. ### y18n.setLocale(str) Set the current locale being used. ### y18n.getLocale() What locale is currently being used? ### y18n.updateLocale(obj) Update the current locale with the key value pairs in `obj`. ## Supported Node.js Versions Libraries in this ecosystem make a best effort to track [Node.js' release schedule](https://nodejs.org/en/about/releases/). Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a). ## License ISC [npm-url]: https://npmjs.org/package/y18n [npm-image]: https://img.shields.io/npm/v/y18n.svg [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [standard-url]: https://github.com/feross/standard # wrappy Callback wrapping utility ## USAGE ```javascript var wrappy = require("wrappy") // var wrapper = wrappy(wrapperFunction) // make sure a cb is called only once // See also: http://npm.im/once for this specific use case var once = wrappy(function (cb) { var called = false return function () { if (called) return called = true return cb.apply(this, arguments) } }) function printBoo () { console.log('boo') } // has some rando property printBoo.iAmBooPrinter = true var onlyPrintOnce = once(printBoo) onlyPrintOnce() // prints 'boo' onlyPrintOnce() // does nothing // random property is retained! assert.equal(onlyPrintOnce.iAmBooPrinter, true) ``` # brace-expansion [Brace expansion](https://www.gnu.org/software/bash/manual/html_node/Brace-Expansion.html), as known from sh/bash, in JavaScript. [](http://travis-ci.org/juliangruber/brace-expansion) [](https://www.npmjs.org/package/brace-expansion) [](https://greenkeeper.io/) [](https://ci.testling.com/juliangruber/brace-expansion) ## Example ```js var expand = require('brace-expansion'); expand('file-{a,b,c}.jpg') // => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg'] expand('-v{,,}') // => ['-v', '-v', '-v'] expand('file{0..2}.jpg') // => ['file0.jpg', 'file1.jpg', 'file2.jpg'] expand('file-{a..c}.jpg') // => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg'] expand('file{2..0}.jpg') // => ['file2.jpg', 'file1.jpg', 'file0.jpg'] expand('file{0..4..2}.jpg') // => ['file0.jpg', 'file2.jpg', 'file4.jpg'] expand('file-{a..e..2}.jpg') // => ['file-a.jpg', 'file-c.jpg', 'file-e.jpg'] expand('file{00..10..5}.jpg') // => ['file00.jpg', 'file05.jpg', 'file10.jpg'] expand('{{A..C},{a..c}}') // => ['A', 'B', 'C', 'a', 'b', 'c'] expand('ppp{,config,oe{,conf}}') // => ['ppp', 'pppconfig', 'pppoe', 'pppoeconf'] ``` ## API ```js var expand = require('brace-expansion'); ``` ### var expanded = expand(str) Return an array of all possible and valid expansions of `str`. If none are found, `[str]` is returned. Valid expansions are: ```js /^(.*,)+(.+)?$/ // {a,b,...} ``` A comma separated list of options, like `{a,b}` or `{a,{b,c}}` or `{,a,}`. ```js /^-?\d+\.\.-?\d+(\.\.-?\d+)?$/ // {x..y[..incr]} ``` A numeric sequence from `x` to `y` inclusive, with optional increment. If `x` or `y` start with a leading `0`, all the numbers will be padded to have equal length. Negative numbers and backwards iteration work too. ```js /^-?\d+\.\.-?\d+(\.\.-?\d+)?$/ // {x..y[..incr]} ``` An alphabetic sequence from `x` to `y` inclusive, with optional increment. `x` and `y` must be exactly one character, and if given, `incr` must be a number. For compatibility reasons, the string `${` is not eligible for brace expansion. ## Installation With [npm](https://npmjs.org) do: ```bash npm install brace-expansion ``` ## Contributors - [Julian Gruber](https://github.com/juliangruber) - [Isaac Z. Schlueter](https://github.com/isaacs) ## Sponsors This module is proudly supported by my [Sponsors](https://github.com/juliangruber/sponsors)! Do you want to support modules like this to improve their quality, stability and weigh in on new features? Then please consider donating to my [Patreon](https://www.patreon.com/juliangruber). Not sure how much of my modules you're using? Try [feross/thanks](https://github.com/feross/thanks)! ## License (MIT) Copyright (c) 2013 Julian Gruber &lt;julian@juliangruber.com&gt; 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. semver(1) -- The semantic versioner for npm =========================================== ## Install ```bash npm install semver ```` ## Usage As a node module: ```js const semver = require('semver') semver.valid('1.2.3') // '1.2.3' semver.valid('a.b.c') // null semver.clean(' =v1.2.3 ') // '1.2.3' semver.satisfies('1.2.3', '1.x || >=2.5.0 || 5.0.0 - 7.2.3') // true semver.gt('1.2.3', '9.8.7') // false semver.lt('1.2.3', '9.8.7') // true semver.minVersion('>=1.0.0') // '1.0.0' semver.valid(semver.coerce('v2')) // '2.0.0' semver.valid(semver.coerce('42.6.7.9.3-alpha')) // '42.6.7' ``` You can also just load the module for the function that you care about, if you'd like to minimize your footprint. ```js // load the whole API at once in a single object const semver = require('semver') // or just load the bits you need // all of them listed here, just pick and choose what you want // classes const SemVer = require('semver/classes/semver') const Comparator = require('semver/classes/comparator') const Range = require('semver/classes/range') // functions for working with versions const semverParse = require('semver/functions/parse') const semverValid = require('semver/functions/valid') const semverClean = require('semver/functions/clean') const semverInc = require('semver/functions/inc') const semverDiff = require('semver/functions/diff') const semverMajor = require('semver/functions/major') const semverMinor = require('semver/functions/minor') const semverPatch = require('semver/functions/patch') const semverPrerelease = require('semver/functions/prerelease') const semverCompare = require('semver/functions/compare') const semverRcompare = require('semver/functions/rcompare') const semverCompareLoose = require('semver/functions/compare-loose') const semverCompareBuild = require('semver/functions/compare-build') const semverSort = require('semver/functions/sort') const semverRsort = require('semver/functions/rsort') // low-level comparators between versions const semverGt = require('semver/functions/gt') const semverLt = require('semver/functions/lt') const semverEq = require('semver/functions/eq') const semverNeq = require('semver/functions/neq') const semverGte = require('semver/functions/gte') const semverLte = require('semver/functions/lte') const semverCmp = require('semver/functions/cmp') const semverCoerce = require('semver/functions/coerce') // working with ranges const semverSatisfies = require('semver/functions/satisfies') const semverMaxSatisfying = require('semver/ranges/max-satisfying') const semverMinSatisfying = require('semver/ranges/min-satisfying') const semverToComparators = require('semver/ranges/to-comparators') const semverMinVersion = require('semver/ranges/min-version') const semverValidRange = require('semver/ranges/valid') const semverOutside = require('semver/ranges/outside') const semverGtr = require('semver/ranges/gtr') const semverLtr = require('semver/ranges/ltr') const semverIntersects = require('semver/ranges/intersects') const simplifyRange = require('semver/ranges/simplify') const rangeSubset = require('semver/ranges/subset') ``` As a command-line utility: ``` $ semver -h A JavaScript implementation of the https://semver.org/ specification Copyright Isaac Z. Schlueter Usage: semver [options] <version> [<version> [...]] Prints valid versions sorted by SemVer precedence Options: -r --range <range> Print versions that match the specified range. -i --increment [<level>] Increment a version by the specified level. Level can be one of: major, minor, patch, premajor, preminor, prepatch, or prerelease. Default level is 'patch'. Only one version may be specified. --preid <identifier> Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments. -l --loose Interpret versions and ranges loosely -p --include-prerelease Always include prerelease versions in range matching -c --coerce Coerce a string into SemVer if possible (does not imply --loose) --rtl Coerce version strings right to left --ltr Coerce version strings left to right (default) Program exits successfully if any valid version satisfies all supplied ranges, and prints all satisfying versions. If no satisfying versions are found, then exits failure. Versions are printed in ascending order, so supplying multiple versions to the utility will just sort them. ``` ## Versions A "version" is described by the `v2.0.0` specification found at <https://semver.org/>. A leading `"="` or `"v"` character is stripped off and ignored. ## Ranges A `version range` is a set of `comparators` which specify versions that satisfy the range. A `comparator` is composed of an `operator` and a `version`. The set of primitive `operators` is: * `<` Less than * `<=` Less than or equal to * `>` Greater than * `>=` Greater than or equal to * `=` Equal. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included. For example, the comparator `>=1.2.7` would match the versions `1.2.7`, `1.2.8`, `2.5.3`, and `1.3.9`, but not the versions `1.2.6` or `1.1.0`. Comparators can be joined by whitespace to form a `comparator set`, which is satisfied by the **intersection** of all of the comparators it includes. A range is composed of one or more comparator sets, joined by `||`. A version matches a range if and only if every comparator in at least one of the `||`-separated comparator sets is satisfied by the version. For example, the range `>=1.2.7 <1.3.0` would match the versions `1.2.7`, `1.2.8`, and `1.2.99`, but not the versions `1.2.6`, `1.3.0`, or `1.1.0`. The range `1.2.7 || >=1.2.9 <2.0.0` would match the versions `1.2.7`, `1.2.9`, and `1.4.6`, but not the versions `1.2.8` or `2.0.0`. ### Prerelease Tags If a version has a prerelease tag (for example, `1.2.3-alpha.3`) then it will only be allowed to satisfy comparator sets if at least one comparator with the same `[major, minor, patch]` tuple also has a prerelease tag. For example, the range `>1.2.3-alpha.3` would be allowed to match the version `1.2.3-alpha.7`, but it would *not* be satisfied by `3.4.5-alpha.9`, even though `3.4.5-alpha.9` is technically "greater than" `1.2.3-alpha.3` according to the SemVer sort rules. The version range only accepts prerelease tags on the `1.2.3` version. The version `3.4.5` *would* satisfy the range, because it does not have a prerelease flag, and `3.4.5` is greater than `1.2.3-alpha.7`. The purpose for this behavior is twofold. First, prerelease versions frequently are updated very quickly, and contain many breaking changes that are (by the author's design) not yet fit for public consumption. Therefore, by default, they are excluded from range matching semantics. Second, a user who has opted into using a prerelease version has clearly indicated the intent to use *that specific* set of alpha/beta/rc versions. By including a prerelease tag in the range, the user is indicating that they are aware of the risk. However, it is still not appropriate to assume that they have opted into taking a similar risk on the *next* set of prerelease versions. Note that this behavior can be suppressed (treating all prerelease versions as if they were normal versions, for the purpose of range matching) by setting the `includePrerelease` flag on the options object to any [functions](https://github.com/npm/node-semver#functions) that do range matching. #### Prerelease Identifiers The method `.inc` takes an additional `identifier` string argument that will append the value of the string as a prerelease identifier: ```javascript semver.inc('1.2.3', 'prerelease', 'beta') // '1.2.4-beta.0' ``` command-line example: ```bash $ semver 1.2.3 -i prerelease --preid beta 1.2.4-beta.0 ``` Which then can be used to increment further: ```bash $ semver 1.2.4-beta.0 -i prerelease 1.2.4-beta.1 ``` ### Advanced Range Syntax Advanced range syntax desugars to primitive comparators in deterministic ways. Advanced ranges may be combined in the same way as primitive comparators using white space or `||`. #### Hyphen Ranges `X.Y.Z - A.B.C` Specifies an inclusive set. * `1.2.3 - 2.3.4` := `>=1.2.3 <=2.3.4` If a partial version is provided as the first version in the inclusive range, then the missing pieces are replaced with zeroes. * `1.2 - 2.3.4` := `>=1.2.0 <=2.3.4` If a partial version is provided as the second version in the inclusive range, then all versions that start with the supplied parts of the tuple are accepted, but nothing that would be greater than the provided tuple parts. * `1.2.3 - 2.3` := `>=1.2.3 <2.4.0-0` * `1.2.3 - 2` := `>=1.2.3 <3.0.0-0` #### X-Ranges `1.2.x` `1.X` `1.2.*` `*` Any of `X`, `x`, or `*` may be used to "stand in" for one of the numeric values in the `[major, minor, patch]` tuple. * `*` := `>=0.0.0` (Any version satisfies) * `1.x` := `>=1.0.0 <2.0.0-0` (Matching major version) * `1.2.x` := `>=1.2.0 <1.3.0-0` (Matching major and minor versions) A partial version range is treated as an X-Range, so the special character is in fact optional. * `""` (empty string) := `*` := `>=0.0.0` * `1` := `1.x.x` := `>=1.0.0 <2.0.0-0` * `1.2` := `1.2.x` := `>=1.2.0 <1.3.0-0` #### Tilde Ranges `~1.2.3` `~1.2` `~1` Allows patch-level changes if a minor version is specified on the comparator. Allows minor-level changes if not. * `~1.2.3` := `>=1.2.3 <1.(2+1).0` := `>=1.2.3 <1.3.0-0` * `~1.2` := `>=1.2.0 <1.(2+1).0` := `>=1.2.0 <1.3.0-0` (Same as `1.2.x`) * `~1` := `>=1.0.0 <(1+1).0.0` := `>=1.0.0 <2.0.0-0` (Same as `1.x`) * `~0.2.3` := `>=0.2.3 <0.(2+1).0` := `>=0.2.3 <0.3.0-0` * `~0.2` := `>=0.2.0 <0.(2+1).0` := `>=0.2.0 <0.3.0-0` (Same as `0.2.x`) * `~0` := `>=0.0.0 <(0+1).0.0` := `>=0.0.0 <1.0.0-0` (Same as `0.x`) * `~1.2.3-beta.2` := `>=1.2.3-beta.2 <1.3.0-0` Note that prereleases in the `1.2.3` version will be allowed, if they are greater than or equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not, because it is a prerelease of a different `[major, minor, patch]` tuple. #### Caret Ranges `^1.2.3` `^0.2.5` `^0.0.4` Allows changes that do not modify the left-most non-zero element in the `[major, minor, patch]` tuple. In other words, this allows patch and minor updates for versions `1.0.0` and above, patch updates for versions `0.X >=0.1.0`, and *no* updates for versions `0.0.X`. Many authors treat a `0.x` version as if the `x` were the major "breaking-change" indicator. Caret ranges are ideal when an author may make breaking changes between `0.2.4` and `0.3.0` releases, which is a common practice. However, it presumes that there will *not* be breaking changes between `0.2.4` and `0.2.5`. It allows for changes that are presumed to be additive (but non-breaking), according to commonly observed practices. * `^1.2.3` := `>=1.2.3 <2.0.0-0` * `^0.2.3` := `>=0.2.3 <0.3.0-0` * `^0.0.3` := `>=0.0.3 <0.0.4-0` * `^1.2.3-beta.2` := `>=1.2.3-beta.2 <2.0.0-0` Note that prereleases in the `1.2.3` version will be allowed, if they are greater than or equal to `beta.2`. So, `1.2.3-beta.4` would be allowed, but `1.2.4-beta.2` would not, because it is a prerelease of a different `[major, minor, patch]` tuple. * `^0.0.3-beta` := `>=0.0.3-beta <0.0.4-0` Note that prereleases in the `0.0.3` version *only* will be allowed, if they are greater than or equal to `beta`. So, `0.0.3-pr.2` would be allowed. When parsing caret ranges, a missing `patch` value desugars to the number `0`, but will allow flexibility within that value, even if the major and minor versions are both `0`. * `^1.2.x` := `>=1.2.0 <2.0.0-0` * `^0.0.x` := `>=0.0.0 <0.1.0-0` * `^0.0` := `>=0.0.0 <0.1.0-0` A missing `minor` and `patch` values will desugar to zero, but also allow flexibility within those values, even if the major version is zero. * `^1.x` := `>=1.0.0 <2.0.0-0` * `^0.x` := `>=0.0.0 <1.0.0-0` ### Range Grammar Putting all this together, here is a Backus-Naur grammar for ranges, for the benefit of parser authors: ```bnf range-set ::= range ( logical-or range ) * logical-or ::= ( ' ' ) * '||' ( ' ' ) * range ::= hyphen | simple ( ' ' simple ) * | '' hyphen ::= partial ' - ' partial simple ::= primitive | partial | tilde | caret primitive ::= ( '<' | '>' | '>=' | '<=' | '=' ) partial partial ::= xr ( '.' xr ( '.' xr qualifier ? )? )? xr ::= 'x' | 'X' | '*' | nr nr ::= '0' | ['1'-'9'] ( ['0'-'9'] ) * tilde ::= '~' partial caret ::= '^' partial qualifier ::= ( '-' pre )? ( '+' build )? pre ::= parts build ::= parts parts ::= part ( '.' part ) * part ::= nr | [-0-9A-Za-z]+ ``` ## Functions All methods and classes take a final `options` object argument. All options in this object are `false` by default. The options supported are: - `loose` Be more forgiving about not-quite-valid semver strings. (Any resulting output will always be 100% strict compliant, of course.) For backwards compatibility reasons, if the `options` argument is a boolean value instead of an object, it is interpreted to be the `loose` param. - `includePrerelease` Set to suppress the [default behavior](https://github.com/npm/node-semver#prerelease-tags) of excluding prerelease tagged versions from ranges unless they are explicitly opted into. Strict-mode Comparators and Ranges will be strict about the SemVer strings that they parse. * `valid(v)`: Return the parsed version, or null if it's not valid. * `inc(v, release)`: Return the version incremented by the release type (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), or null if it's not valid * `premajor` in one call will bump the version up to the next major version and down to a prerelease of that major version. `preminor`, and `prepatch` work the same way. * If called from a non-prerelease version, the `prerelease` will work the same as `prepatch`. It increments the patch version, then makes a prerelease. If the input version is already a prerelease it simply increments it. * `prerelease(v)`: Returns an array of prerelease components, or null if none exist. Example: `prerelease('1.2.3-alpha.1') -> ['alpha', 1]` * `major(v)`: Return the major version number. * `minor(v)`: Return the minor version number. * `patch(v)`: Return the patch version number. * `intersects(r1, r2, loose)`: Return true if the two supplied ranges or comparators intersect. * `parse(v)`: Attempt to parse a string as a semantic version, returning either a `SemVer` object or `null`. ### Comparison * `gt(v1, v2)`: `v1 > v2` * `gte(v1, v2)`: `v1 >= v2` * `lt(v1, v2)`: `v1 < v2` * `lte(v1, v2)`: `v1 <= v2` * `eq(v1, v2)`: `v1 == v2` This is true if they're logically equivalent, even if they're not the exact same string. You already know how to compare strings. * `neq(v1, v2)`: `v1 != v2` The opposite of `eq`. * `cmp(v1, comparator, v2)`: Pass in a comparison string, and it'll call the corresponding function above. `"==="` and `"!=="` do simple string comparison, but are included for completeness. Throws if an invalid comparison string is provided. * `compare(v1, v2)`: Return `0` if `v1 == v2`, or `1` if `v1` is greater, or `-1` if `v2` is greater. Sorts in ascending order if passed to `Array.sort()`. * `rcompare(v1, v2)`: The reverse of compare. Sorts an array of versions in descending order when passed to `Array.sort()`. * `compareBuild(v1, v2)`: The same as `compare` but considers `build` when two versions are equal. Sorts in ascending order if passed to `Array.sort()`. `v2` is greater. Sorts in ascending order if passed to `Array.sort()`. * `diff(v1, v2)`: Returns difference between two versions by the release type (`major`, `premajor`, `minor`, `preminor`, `patch`, `prepatch`, or `prerelease`), or null if the versions are the same. ### Comparators * `intersects(comparator)`: Return true if the comparators intersect ### Ranges * `validRange(range)`: Return the valid range or null if it's not valid * `satisfies(version, range)`: Return true if the version satisfies the range. * `maxSatisfying(versions, range)`: Return the highest version in the list that satisfies the range, or `null` if none of them do. * `minSatisfying(versions, range)`: Return the lowest version in the list that satisfies the range, or `null` if none of them do. * `minVersion(range)`: Return the lowest version that can possibly match the given range. * `gtr(version, range)`: Return `true` if version is greater than all the versions possible in the range. * `ltr(version, range)`: Return `true` if version is less than all the versions possible in the range. * `outside(version, range, hilo)`: Return true if the version is outside the bounds of the range in either the high or low direction. The `hilo` argument must be either the string `'>'` or `'<'`. (This is the function called by `gtr` and `ltr`.) * `intersects(range)`: Return true if any of the ranges comparators intersect * `simplifyRange(versions, range)`: Return a "simplified" range that matches the same items in `versions` list as the range specified. Note that it does *not* guarantee that it would match the same versions in all cases, only for the set of versions provided. This is useful when generating ranges by joining together multiple versions with `||` programmatically, to provide the user with something a bit more ergonomic. If the provided range is shorter in string-length than the generated range, then that is returned. * `subset(subRange, superRange)`: Return `true` if the `subRange` range is entirely contained by the `superRange` range. Note that, since ranges may be non-contiguous, a version might not be greater than a range, less than a range, *or* satisfy a range! For example, the range `1.2 <1.2.9 || >2.0.0` would have a hole from `1.2.9` until `2.0.0`, so the version `1.2.10` would not be greater than the range (because `2.0.1` satisfies, which is higher), nor less than the range (since `1.2.8` satisfies, which is lower), and it also does not satisfy the range. If you want to know if a version satisfies or does not satisfy a range, use the `satisfies(version, range)` function. ### Coercion * `coerce(version, options)`: Coerces a string to semver if possible This aims to provide a very forgiving translation of a non-semver string to semver. It looks for the first digit in a string, and consumes all remaining characters which satisfy at least a partial semver (e.g., `1`, `1.2`, `1.2.3`) up to the max permitted length (256 characters). Longer versions are simply truncated (`4.6.3.9.2-alpha2` becomes `4.6.3`). All surrounding text is simply ignored (`v3.4 replaces v3.3.1` becomes `3.4.0`). Only text which lacks digits will fail coercion (`version one` is not valid). The maximum length for any semver component considered for coercion is 16 characters; longer components will be ignored (`10000000000000000.4.7.4` becomes `4.7.4`). The maximum value for any semver component is `Number.MAX_SAFE_INTEGER || (2**53 - 1)`; higher value components are invalid (`9999999999999999.4.7.4` is likely invalid). If the `options.rtl` flag is set, then `coerce` will return the right-most coercible tuple that does not share an ending index with a longer coercible tuple. For example, `1.2.3.4` will return `2.3.4` in rtl mode, not `4.0.0`. `1.2.3/4` will return `4.0.0`, because the `4` is not a part of any other overlapping SemVer tuple. ### Clean * `clean(version)`: Clean a string to be a valid semver if possible This will return a cleaned and trimmed semver version. If the provided version is not valid a null will be returned. This does not work for ranges. ex. * `s.clean(' = v 2.1.5foo')`: `null` * `s.clean(' = v 2.1.5foo', { loose: true })`: `'2.1.5-foo'` * `s.clean(' = v 2.1.5-foo')`: `null` * `s.clean(' = v 2.1.5-foo', { loose: true })`: `'2.1.5-foo'` * `s.clean('=v2.1.5')`: `'2.1.5'` * `s.clean(' =v2.1.5')`: `2.1.5` * `s.clean(' 2.1.5 ')`: `'2.1.5'` * `s.clean('~1.0.0')`: `null` ## Exported Modules <!-- TODO: Make sure that all of these items are documented (classes aren't, eg), and then pull the module name into the documentation for that specific thing. --> You may pull in just the part of this semver utility that you need, if you are sensitive to packing and tree-shaking concerns. The main `require('semver')` export uses getter functions to lazily load the parts of the API that are used. The following modules are available: * `require('semver')` * `require('semver/classes')` * `require('semver/classes/comparator')` * `require('semver/classes/range')` * `require('semver/classes/semver')` * `require('semver/functions/clean')` * `require('semver/functions/cmp')` * `require('semver/functions/coerce')` * `require('semver/functions/compare')` * `require('semver/functions/compare-build')` * `require('semver/functions/compare-loose')` * `require('semver/functions/diff')` * `require('semver/functions/eq')` * `require('semver/functions/gt')` * `require('semver/functions/gte')` * `require('semver/functions/inc')` * `require('semver/functions/lt')` * `require('semver/functions/lte')` * `require('semver/functions/major')` * `require('semver/functions/minor')` * `require('semver/functions/neq')` * `require('semver/functions/parse')` * `require('semver/functions/patch')` * `require('semver/functions/prerelease')` * `require('semver/functions/rcompare')` * `require('semver/functions/rsort')` * `require('semver/functions/satisfies')` * `require('semver/functions/sort')` * `require('semver/functions/valid')` * `require('semver/ranges/gtr')` * `require('semver/ranges/intersects')` * `require('semver/ranges/ltr')` * `require('semver/ranges/max-satisfying')` * `require('semver/ranges/min-satisfying')` * `require('semver/ranges/min-version')` * `require('semver/ranges/outside')` * `require('semver/ranges/to-comparators')` * `require('semver/ranges/valid')` # eslint-visitor-keys [](https://www.npmjs.com/package/eslint-visitor-keys) [](http://www.npmtrends.com/eslint-visitor-keys) [](https://travis-ci.org/eslint/eslint-visitor-keys) [](https://david-dm.org/eslint/eslint-visitor-keys) Constants and utilities about visitor keys to traverse AST. ## 💿 Installation Use [npm] to install. ```bash $ npm install eslint-visitor-keys ``` ### Requirements - [Node.js] 4.0.0 or later. ## 📖 Usage ```js const evk = require("eslint-visitor-keys") ``` ### evk.KEYS > type: `{ [type: string]: string[] | undefined }` Visitor keys. This keys are frozen. This is an object. Keys are the type of [ESTree] nodes. Their values are an array of property names which have child nodes. For example: ``` console.log(evk.KEYS.AssignmentExpression) // → ["left", "right"] ``` ### evk.getKeys(node) > type: `(node: object) => string[]` Get the visitor keys of a given AST node. This is similar to `Object.keys(node)` of ES Standard, but some keys are excluded: `parent`, `leadingComments`, `trailingComments`, and names which start with `_`. This will be used to traverse unknown nodes. For example: ``` const node = { type: "AssignmentExpression", left: { type: "Identifier", name: "foo" }, right: { type: "Literal", value: 0 } } console.log(evk.getKeys(node)) // → ["type", "left", "right"] ``` ### evk.unionWith(additionalKeys) > type: `(additionalKeys: object) => { [type: string]: string[] | undefined }` Make the union set with `evk.KEYS` and the given keys. - The order of keys is, `additionalKeys` is at first, then `evk.KEYS` is concatenated after that. - It removes duplicated keys as keeping the first one. For example: ``` console.log(evk.unionWith({ MethodDefinition: ["decorators"] })) // → { ..., MethodDefinition: ["decorators", "key", "value"], ... } ``` ## 📰 Change log See [GitHub releases](https://github.com/eslint/eslint-visitor-keys/releases). ## 🍻 Contributing Welcome. See [ESLint contribution guidelines](https://eslint.org/docs/developer-guide/contributing/). ### Development commands - `npm test` runs tests and measures code coverage. - `npm run lint` checks source codes with ESLint. - `npm run coverage` opens the code coverage report of the previous test with your default browser. - `npm run release` publishes this package to [npm] registory. [npm]: https://www.npmjs.com/ [Node.js]: https://nodejs.org/en/ [ESTree]: https://github.com/estree/estree <p align="center"> <img width="250" src="/yargs-logo.png"> </p> <h1 align="center"> Yargs </h1> <p align="center"> <b >Yargs be a node.js library fer hearties tryin' ter parse optstrings</b> </p> <br> [![Build Status][travis-image]][travis-url] [![NPM version][npm-image]][npm-url] [![js-standard-style][standard-image]][standard-url] [![Coverage][coverage-image]][coverage-url] [![Conventional Commits][conventional-commits-image]][conventional-commits-url] [![Slack][slack-image]][slack-url] ## Description : Yargs helps you build interactive command line tools, by parsing arguments and generating an elegant user interface. It gives you: * commands and (grouped) options (`my-program.js serve --port=5000`). * a dynamically generated help menu based on your arguments. > <img width="400" src="/screen.png"> * bash-completion shortcuts for commands and options. * and [tons more](/docs/api.md). ## Installation Stable version: ```bash npm i yargs ``` Bleeding edge version with the most recent features: ```bash npm i yargs@next ``` ## Usage : ### Simple Example ```javascript #!/usr/bin/env node const {argv} = require('yargs') if (argv.ships > 3 && argv.distance < 53.5) { console.log('Plunder more riffiwobbles!') } else { console.log('Retreat from the xupptumblers!') } ``` ```bash $ ./plunder.js --ships=4 --distance=22 Plunder more riffiwobbles! $ ./plunder.js --ships 12 --distance 98.7 Retreat from the xupptumblers! ``` ### Complex Example ```javascript #!/usr/bin/env node require('yargs') // eslint-disable-line .command('serve [port]', 'start the server', (yargs) => { yargs .positional('port', { describe: 'port to bind on', default: 5000 }) }, (argv) => { if (argv.verbose) console.info(`start server on :${argv.port}`) serve(argv.port) }) .option('verbose', { alias: 'v', type: 'boolean', description: 'Run with verbose logging' }) .argv ``` Run the example above with `--help` to see the help for the application. ## TypeScript yargs has type definitions at [@types/yargs][type-definitions]. ``` npm i @types/yargs --save-dev ``` See usage examples in [docs](/docs/typescript.md). ## Webpack See usage examples of yargs with webpack in [docs](/docs/webpack.md). ## Community : Having problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com). ## Documentation : ### Table of Contents * [Yargs' API](/docs/api.md) * [Examples](/docs/examples.md) * [Parsing Tricks](/docs/tricks.md) * [Stop the Parser](/docs/tricks.md#stop) * [Negating Boolean Arguments](/docs/tricks.md#negate) * [Numbers](/docs/tricks.md#numbers) * [Arrays](/docs/tricks.md#arrays) * [Objects](/docs/tricks.md#objects) * [Quotes](/docs/tricks.md#quotes) * [Advanced Topics](/docs/advanced.md) * [Composing Your App Using Commands](/docs/advanced.md#commands) * [Building Configurable CLI Apps](/docs/advanced.md#configuration) * [Customizing Yargs' Parser](/docs/advanced.md#customizing) * [Contributing](/contributing.md) [travis-url]: https://travis-ci.org/yargs/yargs [travis-image]: https://img.shields.io/travis/yargs/yargs/master.svg [npm-url]: https://www.npmjs.com/package/yargs [npm-image]: https://img.shields.io/npm/v/yargs.svg [standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg [standard-url]: http://standardjs.com/ [conventional-commits-image]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg [conventional-commits-url]: https://conventionalcommits.org/ [slack-image]: http://devtoolscommunity.herokuapp.com/badge.svg [slack-url]: http://devtoolscommunity.herokuapp.com [type-definitions]: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/yargs [coverage-image]: https://img.shields.io/nycrc/yargs/yargs [coverage-url]: https://github.com/yargs/yargs/blob/master/.nycrc # emoji-regex [](https://travis-ci.org/mathiasbynens/emoji-regex) _emoji-regex_ offers a regular expression to match all emoji symbols (including textual representations of emoji) as per the Unicode Standard. This repository contains a script that generates this regular expression based on [the data from Unicode v12](https://github.com/mathiasbynens/unicode-12.0.0). Because of this, the regular expression can easily be updated whenever new emoji are added to the Unicode standard. ## Installation Via [npm](https://www.npmjs.com/): ```bash npm install emoji-regex ``` In [Node.js](https://nodejs.org/): ```js const emojiRegex = require('emoji-regex'); // Note: because the regular expression has the global flag set, this module // exports a function that returns the regex rather than exporting the regular // expression itself, to make it impossible to (accidentally) mutate the // original regular expression. const text = ` \u{231A}: ⌚ default emoji presentation character (Emoji_Presentation) \u{2194}\u{FE0F}: ↔️ default text presentation character rendered as emoji \u{1F469}: 👩 emoji modifier base (Emoji_Modifier_Base) \u{1F469}\u{1F3FF}: 👩🏿 emoji modifier base followed by a modifier `; const regex = emojiRegex(); let match; while (match = regex.exec(text)) { const emoji = match[0]; console.log(`Matched sequence ${ emoji } — code points: ${ [...emoji].length }`); } ``` Console output: ``` Matched sequence ⌚ — code points: 1 Matched sequence ⌚ — code points: 1 Matched sequence ↔️ — code points: 2 Matched sequence ↔️ — code points: 2 Matched sequence 👩 — code points: 1 Matched sequence 👩 — code points: 1 Matched sequence 👩🏿 — code points: 2 Matched sequence 👩🏿 — code points: 2 ``` To match emoji in their textual representation as well (i.e. emoji that are not `Emoji_Presentation` symbols and that aren’t forced to render as emoji by a variation selector), `require` the other regex: ```js const emojiRegex = require('emoji-regex/text.js'); ``` Additionally, in environments which support ES2015 Unicode escapes, you may `require` ES2015-style versions of the regexes: ```js const emojiRegex = require('emoji-regex/es2015/index.js'); const emojiRegexText = require('emoji-regex/es2015/text.js'); ``` ## Author | [](https://twitter.com/mathias "Follow @mathias on Twitter") | |---| | [Mathias Bynens](https://mathiasbynens.be/) | ## License _emoji-regex_ is available under the [MIT](https://mths.be/mit) license. # universal-url [![NPM Version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Monitor][greenkeeper-image]][greenkeeper-url] > WHATWG [`URL`](https://developer.mozilla.org/en/docs/Web/API/URL) for Node & Browser. * For Node.js versions `>= 8`, the native implementation will be used. * For Node.js versions `< 8`, a [shim](https://npmjs.com/whatwg-url) will be used. * For web browsers without a native implementation, the same shim will be used. ## Installation [Node.js](http://nodejs.org/) `>= 6` is required. To install, type this at the command line: ```shell npm install universal-url ``` ## Usage ```js const {URL, URLSearchParams} = require('universal-url'); const url = new URL('http://domain/'); const params = new URLSearchParams('?param=value'); ``` Global shim: ```js require('universal-url').shim(); const url = new URL('http://domain/'); const params = new URLSearchParams('?param=value'); ``` ## Browserify/etc The bundled file size of this library can be large for a web browser. If this is a problem, try using [universal-url-lite](https://npmjs.com/universal-url-lite) in your build as an alias for this module. [npm-image]: https://img.shields.io/npm/v/universal-url.svg [npm-url]: https://npmjs.org/package/universal-url [travis-image]: https://img.shields.io/travis/stevenvachon/universal-url.svg [travis-url]: https://travis-ci.org/stevenvachon/universal-url [greenkeeper-image]: https://badges.greenkeeper.io/stevenvachon/universal-url.svg [greenkeeper-url]: https://greenkeeper.io/ <h1 align="center">Enquirer</h1> <p align="center"> <a href="https://npmjs.org/package/enquirer"> <img src="https://img.shields.io/npm/v/enquirer.svg" alt="version"> </a> <a href="https://travis-ci.org/enquirer/enquirer"> <img src="https://img.shields.io/travis/enquirer/enquirer.svg" alt="travis"> </a> <a href="https://npmjs.org/package/enquirer"> <img src="https://img.shields.io/npm/dm/enquirer.svg" alt="downloads"> </a> </p> <br> <br> <p align="center"> <b>Stylish CLI prompts that are user-friendly, intuitive and easy to create.</b><br> <sub>>_ Prompts should be more like conversations than inquisitions▌</sub> </p> <br> <p align="center"> <sub>(Example shows Enquirer's <a href="#survey-prompt">Survey Prompt</a>)</a></sub> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/survey-prompt.gif" alt="Enquirer Survey Prompt" width="750"><br> <sub>The terminal in all examples is <a href="https://hyper.is/">Hyper</a>, theme is <a href="https://github.com/jonschlinkert/hyper-monokai-extended">hyper-monokai-extended</a>.</sub><br><br> <a href="#built-in-prompts"><strong>See more prompt examples</strong></a> </p> <br> <br> Created by [jonschlinkert](https://github.com/jonschlinkert) and [doowb](https://github.com/doowb), Enquirer is fast, easy to use, and lightweight enough for small projects, while also being powerful and customizable enough for the most advanced use cases. * **Fast** - [Loads in ~4ms](#-performance) (that's about _3-4 times faster than a [single frame of a HD movie](http://www.endmemo.com/sconvert/framespersecondframespermillisecond.php) at 60fps_) * **Lightweight** - Only one dependency, the excellent [ansi-colors](https://github.com/doowb/ansi-colors) by [Brian Woodward](https://github.com/doowb). * **Easy to implement** - Uses promises and async/await and sensible defaults to make prompts easy to create and implement. * **Easy to use** - Thrill your users with a better experience! Navigating around input and choices is a breeze. You can even create [quizzes](examples/fun/countdown.js), or [record](examples/fun/record.js) and [playback](examples/fun/play.js) key bindings to aid with tutorials and videos. * **Intuitive** - Keypress combos are available to simplify usage. * **Flexible** - All prompts can be used standalone or chained together. * **Stylish** - Easily override semantic styles and symbols for any part of the prompt. * **Extensible** - Easily create and use custom prompts by extending Enquirer's built-in [prompts](#-prompts). * **Pluggable** - Add advanced features to Enquirer using plugins. * **Validation** - Optionally validate user input with any prompt. * **Well tested** - All prompts are well-tested, and tests are easy to create without having to use brittle, hacky solutions to spy on prompts or "inject" values. * **Examples** - There are numerous [examples](examples) available to help you get started. If you like Enquirer, please consider starring or tweeting about this project to show your support. Thanks! <br> <p align="center"> <b>>_ Ready to start making prompts your users will love? ▌</b><br> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/heartbeat.gif" alt="Enquirer Select Prompt with heartbeat example" width="750"> </p> <br> <br> ## ❯ Getting started Get started with Enquirer, the most powerful and easy-to-use Node.js library for creating interactive CLI prompts. * [Install](#-install) * [Usage](#-usage) * [Enquirer](#-enquirer) * [Prompts](#-prompts) - [Built-in Prompts](#-prompts) - [Custom Prompts](#-custom-prompts) * [Key Bindings](#-key-bindings) * [Options](#-options) * [Release History](#-release-history) * [Performance](#-performance) * [About](#-about) <br> ## ❯ Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install enquirer --save ``` Install with [yarn](https://yarnpkg.com/en/): ```sh $ yarn add enquirer ``` <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/npm-install.gif" alt="Install Enquirer with NPM" width="750"> </p> _(Requires Node.js 8.6 or higher. Please let us know if you need support for an earlier version by creating an [issue](../../issues/new).)_ <br> ## ❯ Usage ### Single prompt The easiest way to get started with enquirer is to pass a [question object](#prompt-options) to the `prompt` method. ```js const { prompt } = require('enquirer'); const response = await prompt({ type: 'input', name: 'username', message: 'What is your username?' }); console.log(response); // { username: 'jonschlinkert' } ``` _(Examples with `await` need to be run inside an `async` function)_ ### Multiple prompts Pass an array of ["question" objects](#prompt-options) to run a series of prompts. ```js const response = await prompt([ { type: 'input', name: 'name', message: 'What is your name?' }, { type: 'input', name: 'username', message: 'What is your username?' } ]); console.log(response); // { name: 'Edward Chan', username: 'edwardmchan' } ``` ### Different ways to run enquirer #### 1. By importing the specific `built-in prompt` ```js const { Confirm } = require('enquirer'); const prompt = new Confirm({ name: 'question', message: 'Did you like enquirer?' }); prompt.run() .then(answer => console.log('Answer:', answer)); ``` #### 2. By passing the options to `prompt` ```js const { prompt } = require('enquirer'); prompt({ type: 'confirm', name: 'question', message: 'Did you like enquirer?' }) .then(answer => console.log('Answer:', answer)); ``` **Jump to**: [Getting Started](#-getting-started) · [Prompts](#-prompts) · [Options](#-options) · [Key Bindings](#-key-bindings) <br> ## ❯ Enquirer **Enquirer is a prompt runner** Add Enquirer to your JavaScript project with following line of code. ```js const Enquirer = require('enquirer'); ``` The main export of this library is the `Enquirer` class, which has methods and features designed to simplify running prompts. ```js const { prompt } = require('enquirer'); const question = [ { type: 'input', name: 'username', message: 'What is your username?' }, { type: 'password', name: 'password', message: 'What is your password?' } ]; let answers = await prompt(question); console.log(answers); ``` **Prompts control how values are rendered and returned** Each individual prompt is a class with special features and functionality for rendering the types of values you want to show users in the terminal, and subsequently returning the types of values you need to use in your application. **How can I customize prompts?** Below in this guide you will find information about creating [custom prompts](#-custom-prompts). For now, we'll focus on how to customize an existing prompt. All of the individual [prompt classes](#built-in-prompts) in this library are exposed as static properties on Enquirer. This allows them to be used directly without using `enquirer.prompt()`. Use this approach if you need to modify a prompt instance, or listen for events on the prompt. **Example** ```js const { Input } = require('enquirer'); const prompt = new Input({ name: 'username', message: 'What is your username?' }); prompt.run() .then(answer => console.log('Username:', answer)) .catch(console.error); ``` ### [Enquirer](index.js#L20) Create an instance of `Enquirer`. **Params** * `options` **{Object}**: (optional) Options to use with all prompts. * `answers` **{Object}**: (optional) Answers object to initialize with. **Example** ```js const Enquirer = require('enquirer'); const enquirer = new Enquirer(); ``` ### [register()](index.js#L42) Register a custom prompt type. **Params** * `type` **{String}** * `fn` **{Function|Prompt}**: `Prompt` class, or a function that returns a `Prompt` class. * `returns` **{Object}**: Returns the Enquirer instance **Example** ```js const Enquirer = require('enquirer'); const enquirer = new Enquirer(); enquirer.register('customType', require('./custom-prompt')); ``` ### [prompt()](index.js#L78) Prompt function that takes a "question" object or array of question objects, and returns an object with responses from the user. **Params** * `questions` **{Array|Object}**: Options objects for one or more prompts to run. * `returns` **{Promise}**: Promise that returns an "answers" object with the user's responses. **Example** ```js const Enquirer = require('enquirer'); const enquirer = new Enquirer(); const response = await enquirer.prompt({ type: 'input', name: 'username', message: 'What is your username?' }); console.log(response); ``` ### [use()](index.js#L160) Use an enquirer plugin. **Params** * `plugin` **{Function}**: Plugin function that takes an instance of Enquirer. * `returns` **{Object}**: Returns the Enquirer instance. **Example** ```js const Enquirer = require('enquirer'); const enquirer = new Enquirer(); const plugin = enquirer => { // do stuff to enquire instance }; enquirer.use(plugin); ``` ### [Enquirer#prompt](index.js#L210) Prompt function that takes a "question" object or array of question objects, and returns an object with responses from the user. **Params** * `questions` **{Array|Object}**: Options objects for one or more prompts to run. * `returns` **{Promise}**: Promise that returns an "answers" object with the user's responses. **Example** ```js const { prompt } = require('enquirer'); const response = await prompt({ type: 'input', name: 'username', message: 'What is your username?' }); console.log(response); ``` <br> ## ❯ Prompts This section is about Enquirer's prompts: what they look like, how they work, how to run them, available options, and how to customize the prompts or create your own prompt concept. **Getting started with Enquirer's prompts** * [Prompt](#prompt) - The base `Prompt` class used by other prompts - [Prompt Options](#prompt-options) * [Built-in prompts](#built-in-prompts) * [Prompt Types](#prompt-types) - The base `Prompt` class used by other prompts * [Custom prompts](#%E2%9D%AF-custom-prompts) - Enquirer 2.0 introduced the concept of prompt "types", with the goal of making custom prompts easier than ever to create and use. ### Prompt The base `Prompt` class is used to create all other prompts. ```js const { Prompt } = require('enquirer'); class MyCustomPrompt extends Prompt {} ``` See the documentation for [creating custom prompts](#-custom-prompts) to learn more about how this works. #### Prompt Options Each prompt takes an options object (aka "question" object), that implements the following interface: ```js { // required type: string | function, name: string | function, message: string | function | async function, // optional skip: boolean | function | async function, initial: string | function | async function, format: function | async function, result: function | async function, validate: function | async function, } ``` Each property of the options object is described below: | **Property** | **Required?** | **Type** | **Description** | | ------------ | ------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` | yes | `string\|function` | Enquirer uses this value to determine the type of prompt to run, but it's optional when prompts are run directly. | | `name` | yes | `string\|function` | Used as the key for the answer on the returned values (answers) object. | | `message` | yes | `string\|function` | The message to display when the prompt is rendered in the terminal. | | `skip` | no | `boolean\|function` | If `true` it will not ask that prompt. | | `initial` | no | `string\|function` | The default value to return if the user does not supply a value. | | `format` | no | `function` | Function to format user input in the terminal. | | `result` | no | `function` | Function to format the final submitted value before it's returned. | | `validate` | no | `function` | Function to validate the submitted value before it's returned. This function may return a boolean or a string. If a string is returned it will be used as the validation error message. | **Example usage** ```js const { prompt } = require('enquirer'); const question = { type: 'input', name: 'username', message: 'What is your username?' }; prompt(question) .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` <br> ### Built-in prompts * [AutoComplete Prompt](#autocomplete-prompt) * [BasicAuth Prompt](#basicauth-prompt) * [Confirm Prompt](#confirm-prompt) * [Form Prompt](#form-prompt) * [Input Prompt](#input-prompt) * [Invisible Prompt](#invisible-prompt) * [List Prompt](#list-prompt) * [MultiSelect Prompt](#multiselect-prompt) * [Numeral Prompt](#numeral-prompt) * [Password Prompt](#password-prompt) * [Quiz Prompt](#quiz-prompt) * [Survey Prompt](#survey-prompt) * [Scale Prompt](#scale-prompt) * [Select Prompt](#select-prompt) * [Sort Prompt](#sort-prompt) * [Snippet Prompt](#snippet-prompt) * [Toggle Prompt](#toggle-prompt) ### AutoComplete Prompt Prompt that auto-completes as the user types, and returns the selected value as a string. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/autocomplete-prompt.gif" alt="Enquirer AutoComplete Prompt" width="750"> </p> **Example Usage** ```js const { AutoComplete } = require('enquirer'); const prompt = new AutoComplete({ name: 'flavor', message: 'Pick your favorite flavor', limit: 10, initial: 2, choices: [ 'Almond', 'Apple', 'Banana', 'Blackberry', 'Blueberry', 'Cherry', 'Chocolate', 'Cinnamon', 'Coconut', 'Cranberry', 'Grape', 'Nougat', 'Orange', 'Pear', 'Pineapple', 'Raspberry', 'Strawberry', 'Vanilla', 'Watermelon', 'Wintergreen' ] }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **AutoComplete Options** | Option | Type | Default | Description | | ----------- | ---------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | `highlight` | `function` | `dim` version of primary style | The color to use when "highlighting" characters in the list that match user input. | | `multiple` | `boolean` | `false` | Allow multiple choices to be selected. | | `suggest` | `function` | Greedy match, returns true if choice message contains input string. | Function that filters choices. Takes user input and a choices array, and returns a list of matching choices. | | `initial` | `number` | 0 | Preselected item in the list of choices. | | `footer` | `function` | None | Function that displays [footer text](https://github.com/enquirer/enquirer/blob/6c2819518a1e2ed284242a99a685655fbaabfa28/examples/autocomplete/option-footer.js#L10) | **Related prompts** * [Select](#select-prompt) * [MultiSelect](#multiselect-prompt) * [Survey](#survey-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### BasicAuth Prompt Prompt that asks for username and password to authenticate the user. The default implementation of `authenticate` function in `BasicAuth` prompt is to compare the username and password with the values supplied while running the prompt. The implementer is expected to override the `authenticate` function with a custom logic such as making an API request to a server to authenticate the username and password entered and expect a token back. <p align="center"> <img src="https://user-images.githubusercontent.com/13731210/61570485-7ffd9c00-aaaa-11e9-857a-d47dc7008284.gif" alt="Enquirer BasicAuth Prompt" width="750"> </p> **Example Usage** ```js const { BasicAuth } = require('enquirer'); const prompt = new BasicAuth({ name: 'password', message: 'Please enter your password', username: 'rajat-sr', password: '123', showPassword: true }); prompt .run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Confirm Prompt Prompt that returns `true` or `false`. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/confirm-prompt.gif" alt="Enquirer Confirm Prompt" width="750"> </p> **Example Usage** ```js const { Confirm } = require('enquirer'); const prompt = new Confirm({ name: 'question', message: 'Want to answer?' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [Input](#input-prompt) * [Numeral](#numeral-prompt) * [Password](#password-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Form Prompt Prompt that allows the user to enter and submit multiple values on a single terminal screen. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/form-prompt.gif" alt="Enquirer Form Prompt" width="750"> </p> **Example Usage** ```js const { Form } = require('enquirer'); const prompt = new Form({ name: 'user', message: 'Please provide the following information:', choices: [ { name: 'firstname', message: 'First Name', initial: 'Jon' }, { name: 'lastname', message: 'Last Name', initial: 'Schlinkert' }, { name: 'username', message: 'GitHub username', initial: 'jonschlinkert' } ] }); prompt.run() .then(value => console.log('Answer:', value)) .catch(console.error); ``` **Related prompts** * [Input](#input-prompt) * [Survey](#survey-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Input Prompt Prompt that takes user input and returns a string. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/input-prompt.gif" alt="Enquirer Input Prompt" width="750"> </p> **Example Usage** ```js const { Input } = require('enquirer'); const prompt = new Input({ message: 'What is your username?', initial: 'jonschlinkert' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.log); ``` You can use [data-store](https://github.com/jonschlinkert/data-store) to store [input history](https://github.com/enquirer/enquirer/blob/master/examples/input/option-history.js) that the user can cycle through (see [source](https://github.com/enquirer/enquirer/blob/8407dc3579123df5e6e20215078e33bb605b0c37/lib/prompts/input.js)). **Related prompts** * [Confirm](#confirm-prompt) * [Numeral](#numeral-prompt) * [Password](#password-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Invisible Prompt Prompt that takes user input, hides it from the terminal, and returns a string. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/invisible-prompt.gif" alt="Enquirer Invisible Prompt" width="750"> </p> **Example Usage** ```js const { Invisible } = require('enquirer'); const prompt = new Invisible({ name: 'secret', message: 'What is your secret?' }); prompt.run() .then(answer => console.log('Answer:', { secret: answer })) .catch(console.error); ``` **Related prompts** * [Password](#password-prompt) * [Input](#input-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### List Prompt Prompt that returns a list of values, created by splitting the user input. The default split character is `,` with optional trailing whitespace. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/list-prompt.gif" alt="Enquirer List Prompt" width="750"> </p> **Example Usage** ```js const { List } = require('enquirer'); const prompt = new List({ name: 'keywords', message: 'Type comma-separated keywords' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [Sort](#sort-prompt) * [Select](#select-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### MultiSelect Prompt Prompt that allows the user to select multiple items from a list of options. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/multiselect-prompt.gif" alt="Enquirer MultiSelect Prompt" width="750"> </p> **Example Usage** ```js const { MultiSelect } = require('enquirer'); const prompt = new MultiSelect({ name: 'value', message: 'Pick your favorite colors', limit: 7, choices: [ { name: 'aqua', value: '#00ffff' }, { name: 'black', value: '#000000' }, { name: 'blue', value: '#0000ff' }, { name: 'fuchsia', value: '#ff00ff' }, { name: 'gray', value: '#808080' }, { name: 'green', value: '#008000' }, { name: 'lime', value: '#00ff00' }, { name: 'maroon', value: '#800000' }, { name: 'navy', value: '#000080' }, { name: 'olive', value: '#808000' }, { name: 'purple', value: '#800080' }, { name: 'red', value: '#ff0000' }, { name: 'silver', value: '#c0c0c0' }, { name: 'teal', value: '#008080' }, { name: 'white', value: '#ffffff' }, { name: 'yellow', value: '#ffff00' } ] }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); // Answer: ['aqua', 'blue', 'fuchsia'] ``` **Example key-value pairs** Optionally, pass a `result` function and use the `.map` method to return an object of key-value pairs of the selected names and values: [example](./examples/multiselect/option-result.js) ```js const { MultiSelect } = require('enquirer'); const prompt = new MultiSelect({ name: 'value', message: 'Pick your favorite colors', limit: 7, choices: [ { name: 'aqua', value: '#00ffff' }, { name: 'black', value: '#000000' }, { name: 'blue', value: '#0000ff' }, { name: 'fuchsia', value: '#ff00ff' }, { name: 'gray', value: '#808080' }, { name: 'green', value: '#008000' }, { name: 'lime', value: '#00ff00' }, { name: 'maroon', value: '#800000' }, { name: 'navy', value: '#000080' }, { name: 'olive', value: '#808000' }, { name: 'purple', value: '#800080' }, { name: 'red', value: '#ff0000' }, { name: 'silver', value: '#c0c0c0' }, { name: 'teal', value: '#008080' }, { name: 'white', value: '#ffffff' }, { name: 'yellow', value: '#ffff00' } ], result(names) { return this.map(names); } }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); // Answer: { aqua: '#00ffff', blue: '#0000ff', fuchsia: '#ff00ff' } ``` **Related prompts** * [AutoComplete](#autocomplete-prompt) * [Select](#select-prompt) * [Survey](#survey-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Numeral Prompt Prompt that takes a number as input. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/numeral-prompt.gif" alt="Enquirer Numeral Prompt" width="750"> </p> **Example Usage** ```js const { NumberPrompt } = require('enquirer'); const prompt = new NumberPrompt({ name: 'number', message: 'Please enter a number' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [Input](#input-prompt) * [Confirm](#confirm-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Password Prompt Prompt that takes user input and masks it in the terminal. Also see the [invisible prompt](#invisible-prompt) <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/password-prompt.gif" alt="Enquirer Password Prompt" width="750"> </p> **Example Usage** ```js const { Password } = require('enquirer'); const prompt = new Password({ name: 'password', message: 'What is your password?' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [Input](#input-prompt) * [Invisible](#invisible-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Quiz Prompt Prompt that allows the user to play multiple-choice quiz questions. <p align="center"> <img src="https://user-images.githubusercontent.com/13731210/61567561-891d4780-aa6f-11e9-9b09-3d504abd24ed.gif" alt="Enquirer Quiz Prompt" width="750"> </p> **Example Usage** ```js const { Quiz } = require('enquirer'); const prompt = new Quiz({ name: 'countries', message: 'How many countries are there in the world?', choices: ['165', '175', '185', '195', '205'], correctChoice: 3 }); prompt .run() .then(answer => { if (answer.correct) { console.log('Correct!'); } else { console.log(`Wrong! Correct answer is ${answer.correctAnswer}`); } }) .catch(console.error); ``` **Quiz Options** | Option | Type | Required | Description | | ----------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------ | | `choices` | `array` | Yes | The list of possible answers to the quiz question. | | `correctChoice`| `number` | Yes | Index of the correct choice from the `choices` array. | **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Survey Prompt Prompt that allows the user to provide feedback for a list of questions. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/survey-prompt.gif" alt="Enquirer Survey Prompt" width="750"> </p> **Example Usage** ```js const { Survey } = require('enquirer'); const prompt = new Survey({ name: 'experience', message: 'Please rate your experience', scale: [ { name: '1', message: 'Strongly Disagree' }, { name: '2', message: 'Disagree' }, { name: '3', message: 'Neutral' }, { name: '4', message: 'Agree' }, { name: '5', message: 'Strongly Agree' } ], margin: [0, 0, 2, 1], choices: [ { name: 'interface', message: 'The website has a friendly interface.' }, { name: 'navigation', message: 'The website is easy to navigate.' }, { name: 'images', message: 'The website usually has good images.' }, { name: 'upload', message: 'The website makes it easy to upload images.' }, { name: 'colors', message: 'The website has a pleasing color palette.' } ] }); prompt.run() .then(value => console.log('ANSWERS:', value)) .catch(console.error); ``` **Related prompts** * [Scale](#scale-prompt) * [Snippet](#snippet-prompt) * [Select](#select-prompt) *** ### Scale Prompt A more compact version of the [Survey prompt](#survey-prompt), the Scale prompt allows the user to quickly provide feedback using a [Likert Scale](https://en.wikipedia.org/wiki/Likert_scale). <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/scale-prompt.gif" alt="Enquirer Scale Prompt" width="750"> </p> **Example Usage** ```js const { Scale } = require('enquirer'); const prompt = new Scale({ name: 'experience', message: 'Please rate your experience', scale: [ { name: '1', message: 'Strongly Disagree' }, { name: '2', message: 'Disagree' }, { name: '3', message: 'Neutral' }, { name: '4', message: 'Agree' }, { name: '5', message: 'Strongly Agree' } ], margin: [0, 0, 2, 1], choices: [ { name: 'interface', message: 'The website has a friendly interface.', initial: 2 }, { name: 'navigation', message: 'The website is easy to navigate.', initial: 2 }, { name: 'images', message: 'The website usually has good images.', initial: 2 }, { name: 'upload', message: 'The website makes it easy to upload images.', initial: 2 }, { name: 'colors', message: 'The website has a pleasing color palette.', initial: 2 } ] }); prompt.run() .then(value => console.log('ANSWERS:', value)) .catch(console.error); ``` **Related prompts** * [AutoComplete](#autocomplete-prompt) * [Select](#select-prompt) * [Survey](#survey-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Select Prompt Prompt that allows the user to select from a list of options. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/select-prompt.gif" alt="Enquirer Select Prompt" width="750"> </p> **Example Usage** ```js const { Select } = require('enquirer'); const prompt = new Select({ name: 'color', message: 'Pick a flavor', choices: ['apple', 'grape', 'watermelon', 'cherry', 'orange'] }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [AutoComplete](#autocomplete-prompt) * [MultiSelect](#multiselect-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Sort Prompt Prompt that allows the user to sort items in a list. **Example** In this [example](https://github.com/enquirer/enquirer/raw/master/examples/sort/prompt.js), custom styling is applied to the returned values to make it easier to see what's happening. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/sort-prompt.gif" alt="Enquirer Sort Prompt" width="750"> </p> **Example Usage** ```js const colors = require('ansi-colors'); const { Sort } = require('enquirer'); const prompt = new Sort({ name: 'colors', message: 'Sort the colors in order of preference', hint: 'Top is best, bottom is worst', numbered: true, choices: ['red', 'white', 'green', 'cyan', 'yellow'].map(n => ({ name: n, message: colors[n](n) })) }); prompt.run() .then(function(answer = []) { console.log(answer); console.log('Your preferred order of colors is:'); console.log(answer.map(key => colors[key](key)).join('\n')); }) .catch(console.error); ``` **Related prompts** * [List](#list-prompt) * [Select](#select-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Snippet Prompt Prompt that allows the user to replace placeholders in a snippet of code or text. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/snippet-prompt.gif" alt="Prompts" width="750"> </p> **Example Usage** ```js const semver = require('semver'); const { Snippet } = require('enquirer'); const prompt = new Snippet({ name: 'username', message: 'Fill out the fields in package.json', required: true, fields: [ { name: 'author_name', message: 'Author Name' }, { name: 'version', validate(value, state, item, index) { if (item && item.name === 'version' && !semver.valid(value)) { return prompt.styles.danger('version should be a valid semver value'); } return true; } } ], template: `{ "name": "\${name}", "description": "\${description}", "version": "\${version}", "homepage": "https://github.com/\${username}/\${name}", "author": "\${author_name} (https://github.com/\${username})", "repository": "\${username}/\${name}", "license": "\${license:ISC}" } ` }); prompt.run() .then(answer => console.log('Answer:', answer.result)) .catch(console.error); ``` **Related prompts** * [Survey](#survey-prompt) * [AutoComplete](#autocomplete-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Toggle Prompt Prompt that allows the user to toggle between two values then returns `true` or `false`. <p align="center"> <img src="https://raw.githubusercontent.com/enquirer/enquirer/master/media/toggle-prompt.gif" alt="Enquirer Toggle Prompt" width="750"> </p> **Example Usage** ```js const { Toggle } = require('enquirer'); const prompt = new Toggle({ message: 'Want to answer?', enabled: 'Yep', disabled: 'Nope' }); prompt.run() .then(answer => console.log('Answer:', answer)) .catch(console.error); ``` **Related prompts** * [Confirm](#confirm-prompt) * [Input](#input-prompt) * [Sort](#sort-prompt) **↑ back to:** [Getting Started](#-getting-started) · [Prompts](#-prompts) *** ### Prompt Types There are 5 (soon to be 6!) type classes: * [ArrayPrompt](#arrayprompt) - [Options](#options) - [Properties](#properties) - [Methods](#methods) - [Choices](#choices) - [Defining choices](#defining-choices) - [Choice properties](#choice-properties) - [Related prompts](#related-prompts) * [AuthPrompt](#authprompt) * [BooleanPrompt](#booleanprompt) * DatePrompt (Coming Soon!) * [NumberPrompt](#numberprompt) * [StringPrompt](#stringprompt) Each type is a low-level class that may be used as a starting point for creating higher level prompts. Continue reading to learn how. ### ArrayPrompt The `ArrayPrompt` class is used for creating prompts that display a list of choices in the terminal. For example, Enquirer uses this class as the basis for the [Select](#select) and [Survey](#survey) prompts. #### Options In addition to the [options](#options) available to all prompts, Array prompts also support the following options. | **Option** | **Required?** | **Type** | **Description** | | ----------- | ------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------- | | `autofocus` | `no` | `string\|number` | The index or name of the choice that should have focus when the prompt loads. Only one choice may have focus at a time. | | | `stdin` | `no` | `stream` | The input stream to use for emitting keypress events. Defaults to `process.stdin`. | | `stdout` | `no` | `stream` | The output stream to use for writing the prompt to the terminal. Defaults to `process.stdout`. | | | #### Properties Array prompts have the following instance properties and getters. | **Property name** | **Type** | **Description** | | ----------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `choices` | `array` | Array of choices that have been normalized from choices passed on the prompt options. | | `cursor` | `number` | Position of the cursor relative to the _user input (string)_. | | `enabled` | `array` | Returns an array of enabled choices. | | `focused` | `array` | Returns the currently selected choice in the visible list of choices. This is similar to the concept of focus in HTML and CSS. Focused choices are always visible (on-screen). When a list of choices is longer than the list of visible choices, and an off-screen choice is _focused_, the list will scroll to the focused choice and re-render. | | `focused` | Gets the currently selected choice. Equivalent to `prompt.choices[prompt.index]`. | | `index` | `number` | Position of the pointer in the _visible list (array) of choices_. | | `limit` | `number` | The number of choices to display on-screen. | | `selected` | `array` | Either a list of enabled choices (when `options.multiple` is true) or the currently focused choice. | | `visible` | `string` | | #### Methods | **Method** | **Description** | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `pointer()` | Returns the visual symbol to use to identify the choice that currently has focus. The `❯` symbol is often used for this. The pointer is not always visible, as with the `autocomplete` prompt. | | `indicator()` | Returns the visual symbol that indicates whether or not a choice is checked/enabled. | | `focus()` | Sets focus on a choice, if it can be focused. | #### Choices Array prompts support the `choices` option, which is the array of choices users will be able to select from when rendered in the terminal. **Type**: `string|object` **Example** ```js const { prompt } = require('enquirer'); const questions = [{ type: 'select', name: 'color', message: 'Favorite color?', initial: 1, choices: [ { name: 'red', message: 'Red', value: '#ff0000' }, //<= choice object { name: 'green', message: 'Green', value: '#00ff00' }, //<= choice object { name: 'blue', message: 'Blue', value: '#0000ff' } //<= choice object ] }]; let answers = await prompt(questions); console.log('Answer:', answers.color); ``` #### Defining choices Whether defined as a string or object, choices are normalized to the following interface: ```js { name: string; message: string | undefined; value: string | undefined; hint: string | undefined; disabled: boolean | string | undefined; } ``` **Example** ```js const question = { name: 'fruit', message: 'Favorite fruit?', choices: ['Apple', 'Orange', 'Raspberry'] }; ``` Normalizes to the following when the prompt is run: ```js const question = { name: 'fruit', message: 'Favorite fruit?', choices: [ { name: 'Apple', message: 'Apple', value: 'Apple' }, { name: 'Orange', message: 'Orange', value: 'Orange' }, { name: 'Raspberry', message: 'Raspberry', value: 'Raspberry' } ] }; ``` #### Choice properties The following properties are supported on `choice` objects. | **Option** | **Type** | **Description** | | ----------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | `string` | The unique key to identify a choice | | `message` | `string` | The message to display in the terminal. `name` is used when this is undefined. | | `value` | `string` | Value to associate with the choice. Useful for creating key-value pairs from user choices. `name` is used when this is undefined. | | `choices` | `array` | Array of "child" choices. | | `hint` | `string` | Help message to display next to a choice. | | `role` | `string` | Determines how the choice will be displayed. Currently the only role supported is `separator`. Additional roles may be added in the future (like `heading`, etc). Please create a [feature request] | | `enabled` | `boolean` | Enabled a choice by default. This is only supported when `options.multiple` is true or on prompts that support multiple choices, like [MultiSelect](#-multiselect). | | `disabled` | `boolean\|string` | Disable a choice so that it cannot be selected. This value may either be `true`, `false`, or a message to display. | | `indicator` | `string\|function` | Custom indicator to render for a choice (like a check or radio button). | #### Related prompts * [AutoComplete](#autocomplete-prompt) * [Form](#form-prompt) * [MultiSelect](#multiselect-prompt) * [Select](#select-prompt) * [Survey](#survey-prompt) *** ### AuthPrompt The `AuthPrompt` is used to create prompts to log in user using any authentication method. For example, Enquirer uses this class as the basis for the [BasicAuth Prompt](#basicauth-prompt). You can also find prompt examples in `examples/auth/` folder that utilizes `AuthPrompt` to create OAuth based authentication prompt or a prompt that authenticates using time-based OTP, among others. `AuthPrompt` has a factory function that creates an instance of `AuthPrompt` class and it expects an `authenticate` function, as an argument, which overrides the `authenticate` function of the `AuthPrompt` class. #### Methods | **Method** | **Description** | | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `authenticate()` | Contain all the authentication logic. This function should be overridden to implement custom authentication logic. The default `authenticate` function throws an error if no other function is provided. | #### Choices Auth prompt supports the `choices` option, which is the similar to the choices used in [Form Prompt](#form-prompt). **Example** ```js const { AuthPrompt } = require('enquirer'); function authenticate(value, state) { if (value.username === this.options.username && value.password === this.options.password) { return true; } return false; } const CustomAuthPrompt = AuthPrompt.create(authenticate); const prompt = new CustomAuthPrompt({ name: 'password', message: 'Please enter your password', username: 'rajat-sr', password: '1234567', choices: [ { name: 'username', message: 'username' }, { name: 'password', message: 'password' } ] }); prompt .run() .then(answer => console.log('Authenticated?', answer)) .catch(console.error); ``` #### Related prompts * [BasicAuth Prompt](#basicauth-prompt) *** ### BooleanPrompt The `BooleanPrompt` class is used for creating prompts that display and return a boolean value. ```js const { BooleanPrompt } = require('enquirer'); const prompt = new BooleanPrompt({ header: '========================', message: 'Do you love enquirer?', footer: '========================', }); prompt.run() .then(answer => console.log('Selected:', answer)) .catch(console.error); ``` **Returns**: `boolean` *** ### NumberPrompt The `NumberPrompt` class is used for creating prompts that display and return a numerical value. ```js const { NumberPrompt } = require('enquirer'); const prompt = new NumberPrompt({ header: '************************', message: 'Input the Numbers:', footer: '************************', }); prompt.run() .then(answer => console.log('Numbers are:', answer)) .catch(console.error); ``` **Returns**: `string|number` (number, or number formatted as a string) *** ### StringPrompt The `StringPrompt` class is used for creating prompts that display and return a string value. ```js const { StringPrompt } = require('enquirer'); const prompt = new StringPrompt({ header: '************************', message: 'Input the String:', footer: '************************' }); prompt.run() .then(answer => console.log('String is:', answer)) .catch(console.error); ``` **Returns**: `string` <br> ## ❯ Custom prompts With Enquirer 2.0, custom prompts are easier than ever to create and use. **How do I create a custom prompt?** Custom prompts are created by extending either: * Enquirer's `Prompt` class * one of the built-in [prompts](#-prompts), or * low-level [types](#-types). <!-- Example: HaiKarate Custom Prompt --> ```js const { Prompt } = require('enquirer'); class HaiKarate extends Prompt { constructor(options = {}) { super(options); this.value = options.initial || 0; this.cursorHide(); } up() { this.value++; this.render(); } down() { this.value--; this.render(); } render() { this.clear(); // clear previously rendered prompt from the terminal this.write(`${this.state.message}: ${this.value}`); } } // Use the prompt by creating an instance of your custom prompt class. const prompt = new HaiKarate({ message: 'How many sprays do you want?', initial: 10 }); prompt.run() .then(answer => console.log('Sprays:', answer)) .catch(console.error); ``` If you want to be able to specify your prompt by `type` so that it may be used alongside other prompts, you will need to first create an instance of `Enquirer`. ```js const Enquirer = require('enquirer'); const enquirer = new Enquirer(); ``` Then use the `.register()` method to add your custom prompt. ```js enquirer.register('haikarate', HaiKarate); ``` Now you can do the following when defining "questions". ```js let spritzer = require('cologne-drone'); let answers = await enquirer.prompt([ { type: 'haikarate', name: 'cologne', message: 'How many sprays do you need?', initial: 10, async onSubmit(name, value) { await spritzer.activate(value); //<= activate drone return value; } } ]); ``` <br> ## ❯ Key Bindings ### All prompts These key combinations may be used with all prompts. | **command** | **description** | | -------------------------------- | -------------------------------------- | | <kbd>ctrl</kbd> + <kbd>c</kbd> | Cancel the prompt. | | <kbd>ctrl</kbd> + <kbd>g</kbd> | Reset the prompt to its initial state. | <br> ### Move cursor These combinations may be used on prompts that support user input (eg. [input prompt](#input-prompt), [password prompt](#password-prompt), and [invisible prompt](#invisible-prompt)). | **command** | **description** | | ------------------------------ | ---------------------------------------- | | <kbd>left</kbd> | Move the cursor back one character. | | <kbd>right</kbd> | Move the cursor forward one character. | | <kbd>ctrl</kbd> + <kbd>a</kbd> | Move cursor to the start of the line | | <kbd>ctrl</kbd> + <kbd>e</kbd> | Move cursor to the end of the line | | <kbd>ctrl</kbd> + <kbd>b</kbd> | Move cursor back one character | | <kbd>ctrl</kbd> + <kbd>f</kbd> | Move cursor forward one character | | <kbd>ctrl</kbd> + <kbd>x</kbd> | Toggle between first and cursor position | <br> ### Edit Input These key combinations may be used on prompts that support user input (eg. [input prompt](#input-prompt), [password prompt](#password-prompt), and [invisible prompt](#invisible-prompt)). | **command** | **description** | | ------------------------------ | ---------------------------------------- | | <kbd>ctrl</kbd> + <kbd>a</kbd> | Move cursor to the start of the line | | <kbd>ctrl</kbd> + <kbd>e</kbd> | Move cursor to the end of the line | | <kbd>ctrl</kbd> + <kbd>b</kbd> | Move cursor back one character | | <kbd>ctrl</kbd> + <kbd>f</kbd> | Move cursor forward one character | | <kbd>ctrl</kbd> + <kbd>x</kbd> | Toggle between first and cursor position | <br> | **command (Mac)** | **command (Windows)** | **description** | | ----------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | <kbd>delete</kbd> | <kbd>backspace</kbd> | Delete one character to the left. | | <kbd>fn</kbd> + <kbd>delete</kbd> | <kbd>delete</kbd> | Delete one character to the right. | | <kbd>option</kbd> + <kbd>up</kbd> | <kbd>alt</kbd> + <kbd>up</kbd> | Scroll to the previous item in history ([Input prompt](#input-prompt) only, when [history is enabled](examples/input/option-history.js)). | | <kbd>option</kbd> + <kbd>down</kbd> | <kbd>alt</kbd> + <kbd>down</kbd> | Scroll to the next item in history ([Input prompt](#input-prompt) only, when [history is enabled](examples/input/option-history.js)). | ### Select choices These key combinations may be used on prompts that support _multiple_ choices, such as the [multiselect prompt](#multiselect-prompt), or the [select prompt](#select-prompt) when the `multiple` options is true. | **command** | **description** | | ----------------- | -------------------------------------------------------------------------------------------------------------------- | | <kbd>space</kbd> | Toggle the currently selected choice when `options.multiple` is true. | | <kbd>number</kbd> | Move the pointer to the choice at the given index. Also toggles the selected choice when `options.multiple` is true. | | <kbd>a</kbd> | Toggle all choices to be enabled or disabled. | | <kbd>i</kbd> | Invert the current selection of choices. | | <kbd>g</kbd> | Toggle the current choice group. | <br> ### Hide/show choices | **command** | **description** | | ------------------------------- | ---------------------------------------------- | | <kbd>fn</kbd> + <kbd>up</kbd> | Decrease the number of visible choices by one. | | <kbd>fn</kbd> + <kbd>down</kbd> | Increase the number of visible choices by one. | <br> ### Move/lock Pointer | **command** | **description** | | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | <kbd>number</kbd> | Move the pointer to the choice at the given index. Also toggles the selected choice when `options.multiple` is true. | | <kbd>up</kbd> | Move the pointer up. | | <kbd>down</kbd> | Move the pointer down. | | <kbd>ctrl</kbd> + <kbd>a</kbd> | Move the pointer to the first _visible_ choice. | | <kbd>ctrl</kbd> + <kbd>e</kbd> | Move the pointer to the last _visible_ choice. | | <kbd>shift</kbd> + <kbd>up</kbd> | Scroll up one choice without changing pointer position (locks the pointer while scrolling). | | <kbd>shift</kbd> + <kbd>down</kbd> | Scroll down one choice without changing pointer position (locks the pointer while scrolling). | <br> | **command (Mac)** | **command (Windows)** | **description** | | -------------------------------- | --------------------- | ---------------------------------------------------------- | | <kbd>fn</kbd> + <kbd>left</kbd> | <kbd>home</kbd> | Move the pointer to the first choice in the choices array. | | <kbd>fn</kbd> + <kbd>right</kbd> | <kbd>end</kbd> | Move the pointer to the last choice in the choices array. | <br> ## ❯ Release History Please see [CHANGELOG.md](CHANGELOG.md). ## ❯ Performance ### System specs MacBook Pro, Intel Core i7, 2.5 GHz, 16 GB. ### Load time Time it takes for the module to load the first time (average of 3 runs): ``` enquirer: 4.013ms inquirer: 286.717ms ``` <br> ## ❯ About <details> <summary><strong>Contributing</strong></summary> Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Todo We're currently working on documentation for the following items. Please star and watch the repository for updates! * [ ] Customizing symbols * [ ] Customizing styles (palette) * [ ] Customizing rendered input * [ ] Customizing returned values * [ ] Customizing key bindings * [ ] Question validation * [ ] Choice validation * [ ] Skipping questions * [ ] Async choices * [ ] Async timers: loaders, spinners and other animations * [ ] Links to examples </details> <details> <summary><strong>Running Tests</strong></summary> Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ``` ```sh $ yarn && yarn test ``` </details> <details> <summary><strong>Building docs</strong></summary> _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` </details> #### Contributors | **Commits** | **Contributor** | | --- | --- | | 283 | [jonschlinkert](https://github.com/jonschlinkert) | | 82 | [doowb](https://github.com/doowb) | | 32 | [rajat-sr](https://github.com/rajat-sr) | | 20 | [318097](https://github.com/318097) | | 15 | [g-plane](https://github.com/g-plane) | | 12 | [pixelass](https://github.com/pixelass) | | 5 | [adityavyas611](https://github.com/adityavyas611) | | 5 | [satotake](https://github.com/satotake) | | 3 | [tunnckoCore](https://github.com/tunnckoCore) | | 3 | [Ovyerus](https://github.com/Ovyerus) | | 3 | [sw-yx](https://github.com/sw-yx) | | 2 | [DanielRuf](https://github.com/DanielRuf) | | 2 | [GabeL7r](https://github.com/GabeL7r) | | 1 | [AlCalzone](https://github.com/AlCalzone) | | 1 | [hipstersmoothie](https://github.com/hipstersmoothie) | | 1 | [danieldelcore](https://github.com/danieldelcore) | | 1 | [ImgBotApp](https://github.com/ImgBotApp) | | 1 | [jsonkao](https://github.com/jsonkao) | | 1 | [knpwrs](https://github.com/knpwrs) | | 1 | [yeskunall](https://github.com/yeskunall) | | 1 | [mischah](https://github.com/mischah) | | 1 | [renarsvilnis](https://github.com/renarsvilnis) | | 1 | [sbugert](https://github.com/sbugert) | | 1 | [stephencweiss](https://github.com/stephencweiss) | | 1 | [skellock](https://github.com/skellock) | | 1 | [whxaxes](https://github.com/whxaxes) | #### Author **Jon Schlinkert** * [GitHub Profile](https://github.com/jonschlinkert) * [Twitter Profile](https://twitter.com/jonschlinkert) * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) #### Credit Thanks to [derhuerst](https://github.com/derhuerst), creator of prompt libraries such as [prompt-skeleton](https://github.com/derhuerst/prompt-skeleton), which influenced some of the concepts we used in our prompts. #### License Copyright © 2018-present, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). # minizlib A fast zlib stream built on [minipass](http://npm.im/minipass) and Node.js's zlib binding. This module was created to serve the needs of [node-tar](http://npm.im/tar) and [minipass-fetch](http://npm.im/minipass-fetch). Brotli is supported in versions of node with a Brotli binding. ## How does this differ from the streams in `require('zlib')`? First, there are no convenience methods to compress or decompress a buffer. If you want those, use the built-in `zlib` module. This is only streams. That being said, Minipass streams to make it fairly easy to use as one-liners: `new zlib.Deflate().end(data).read()` will return the deflate compressed result. This module compresses and decompresses the data as fast as you feed it in. It is synchronous, and runs on the main process thread. Zlib and Brotli operations can be high CPU, but they're very fast, and doing it this way means much less bookkeeping and artificial deferral. Node's built in zlib streams are built on top of `stream.Transform`. They do the maximally safe thing with respect to consistent asynchrony, buffering, and backpressure. See [Minipass](http://npm.im/minipass) for more on the differences between Node.js core streams and Minipass streams, and the convenience methods provided by that class. ## Classes - Deflate - Inflate - Gzip - Gunzip - DeflateRaw - InflateRaw - Unzip - BrotliCompress (Node v10 and higher) - BrotliDecompress (Node v10 and higher) ## USAGE ```js const zlib = require('minizlib') const input = sourceOfCompressedData() const decode = new zlib.BrotliDecompress() const output = whereToWriteTheDecodedData() input.pipe(decode).pipe(output) ``` ## REPRODUCIBLE BUILDS To create reproducible gzip compressed files across different operating systems, set `portable: true` in the options. This causes minizlib to set the `OS` indicator in byte 9 of the extended gzip header to `0xFF` for 'unknown'. argparse ======== [](http://travis-ci.org/nodeca/argparse) [](https://www.npmjs.org/package/argparse) CLI arguments parser for node.js. Javascript port of python's [argparse](http://docs.python.org/dev/library/argparse.html) module (original version 3.2). That's a full port, except some very rare options, recorded in issue tracker. **NB. Difference with original.** - Method names changed to camelCase. See [generated docs](http://nodeca.github.com/argparse/). - Use `defaultValue` instead of `default`. - Use `argparse.Const.REMAINDER` instead of `argparse.REMAINDER`, and similarly for constant values `OPTIONAL`, `ZERO_OR_MORE`, and `ONE_OR_MORE` (aliases for `nargs` values `'?'`, `'*'`, `'+'`, respectively), and `SUPPRESS`. Example ======= test.js file: ```javascript #!/usr/bin/env node 'use strict'; var ArgumentParser = require('../lib/argparse').ArgumentParser; var parser = new ArgumentParser({ version: '0.0.1', addHelp:true, description: 'Argparse example' }); parser.addArgument( [ '-f', '--foo' ], { help: 'foo bar' } ); parser.addArgument( [ '-b', '--bar' ], { help: 'bar foo' } ); parser.addArgument( '--baz', { help: 'baz bar' } ); var args = parser.parseArgs(); console.dir(args); ``` Display help: ``` $ ./test.js -h usage: example.js [-h] [-v] [-f FOO] [-b BAR] [--baz BAZ] Argparse example Optional arguments: -h, --help Show this help message and exit. -v, --version Show program's version number and exit. -f FOO, --foo FOO foo bar -b BAR, --bar BAR bar foo --baz BAZ baz bar ``` Parse arguments: ``` $ ./test.js -f=3 --bar=4 --baz 5 { foo: '3', bar: '4', baz: '5' } ``` More [examples](https://github.com/nodeca/argparse/tree/master/examples). ArgumentParser objects ====================== ``` new ArgumentParser({parameters hash}); ``` Creates a new ArgumentParser object. **Supported params:** - ```description``` - Text to display before the argument help. - ```epilog``` - Text to display after the argument help. - ```addHelp``` - Add a -h/–help option to the parser. (default: true) - ```argumentDefault``` - Set the global default value for arguments. (default: null) - ```parents``` - A list of ArgumentParser objects whose arguments should also be included. - ```prefixChars``` - The set of characters that prefix optional arguments. (default: ‘-‘) - ```formatterClass``` - A class for customizing the help output. - ```prog``` - The name of the program (default: `path.basename(process.argv[1])`) - ```usage``` - The string describing the program usage (default: generated) - ```conflictHandler``` - Usually unnecessary, defines strategy for resolving conflicting optionals. **Not supported yet** - ```fromfilePrefixChars``` - The set of characters that prefix files from which additional arguments should be read. Details in [original ArgumentParser guide](http://docs.python.org/dev/library/argparse.html#argumentparser-objects) addArgument() method ==================== ``` ArgumentParser.addArgument(name or flag or [name] or [flags...], {options}) ``` Defines how a single command-line argument should be parsed. - ```name or flag or [name] or [flags...]``` - Either a positional name (e.g., `'foo'`), a single option (e.g., `'-f'` or `'--foo'`), an array of a single positional name (e.g., `['foo']`), or an array of options (e.g., `['-f', '--foo']`). Options: - ```action``` - The basic type of action to be taken when this argument is encountered at the command line. - ```nargs```- The number of command-line arguments that should be consumed. - ```constant``` - A constant value required by some action and nargs selections. - ```defaultValue``` - The value produced if the argument is absent from the command line. - ```type``` - The type to which the command-line argument should be converted. - ```choices``` - A container of the allowable values for the argument. - ```required``` - Whether or not the command-line option may be omitted (optionals only). - ```help``` - A brief description of what the argument does. - ```metavar``` - A name for the argument in usage messages. - ```dest``` - The name of the attribute to be added to the object returned by parseArgs(). Details in [original add_argument guide](http://docs.python.org/dev/library/argparse.html#the-add-argument-method) Action (some details) ================ ArgumentParser objects associate command-line arguments with actions. These actions can do just about anything with the command-line arguments associated with them, though most actions simply add an attribute to the object returned by parseArgs(). The action keyword argument specifies how the command-line arguments should be handled. The supported actions are: - ```store``` - Just stores the argument’s value. This is the default action. - ```storeConst``` - Stores value, specified by the const keyword argument. (Note that the const keyword argument defaults to the rather unhelpful None.) The 'storeConst' action is most commonly used with optional arguments, that specify some sort of flag. - ```storeTrue``` and ```storeFalse``` - Stores values True and False respectively. These are special cases of 'storeConst'. - ```append``` - Stores a list, and appends each argument value to the list. This is useful to allow an option to be specified multiple times. - ```appendConst``` - Stores a list, and appends value, specified by the const keyword argument to the list. (Note, that the const keyword argument defaults is None.) The 'appendConst' action is typically used when multiple arguments need to store constants to the same list. - ```count``` - Counts the number of times a keyword argument occurs. For example, used for increasing verbosity levels. - ```help``` - Prints a complete help message for all the options in the current parser and then exits. By default a help action is automatically added to the parser. See ArgumentParser for details of how the output is created. - ```version``` - Prints version information and exit. Expects a `version=` keyword argument in the addArgument() call. Details in [original action guide](http://docs.python.org/dev/library/argparse.html#action) Sub-commands ============ ArgumentParser.addSubparsers() Many programs split their functionality into a number of sub-commands, for example, the svn program can invoke sub-commands like `svn checkout`, `svn update`, and `svn commit`. Splitting up functionality this way can be a particularly good idea when a program performs several different functions which require different kinds of command-line arguments. `ArgumentParser` supports creation of such sub-commands with `addSubparsers()` method. The `addSubparsers()` method is normally called with no arguments and returns an special action object. This object has a single method `addParser()`, which takes a command name and any `ArgumentParser` constructor arguments, and returns an `ArgumentParser` object that can be modified as usual. Example: sub_commands.js ```javascript #!/usr/bin/env node 'use strict'; var ArgumentParser = require('../lib/argparse').ArgumentParser; var parser = new ArgumentParser({ version: '0.0.1', addHelp:true, description: 'Argparse examples: sub-commands', }); var subparsers = parser.addSubparsers({ title:'subcommands', dest:"subcommand_name" }); var bar = subparsers.addParser('c1', {addHelp:true}); bar.addArgument( [ '-f', '--foo' ], { action: 'store', help: 'foo3 bar3' } ); var bar = subparsers.addParser( 'c2', {aliases:['co'], addHelp:true} ); bar.addArgument( [ '-b', '--bar' ], { action: 'store', type: 'int', help: 'foo3 bar3' } ); var args = parser.parseArgs(); console.dir(args); ``` Details in [original sub-commands guide](http://docs.python.org/dev/library/argparse.html#sub-commands) Contributors ============ - [Eugene Shkuropat](https://github.com/shkuropat) - [Paul Jacobson](https://github.com/hpaulj) [others](https://github.com/nodeca/argparse/graphs/contributors) License ======= Copyright (c) 2012 [Vitaly Puzrin](https://github.com/puzrin). Released under the MIT license. See [LICENSE](https://github.com/nodeca/argparse/blob/master/LICENSE) for details. [](https://travis-ci.org/isaacs/rimraf) [](https://david-dm.org/isaacs/rimraf) [](https://david-dm.org/isaacs/rimraf#info=devDependencies) The [UNIX command](http://en.wikipedia.org/wiki/Rm_(Unix)) `rm -rf` for node. Install with `npm install rimraf`, or just drop rimraf.js somewhere. ## API `rimraf(f, [opts], callback)` The first parameter will be interpreted as a globbing pattern for files. If you want to disable globbing you can do so with `opts.disableGlob` (defaults to `false`). This might be handy, for instance, if you have filenames that contain globbing wildcard characters. The callback will be called with an error if there is one. Certain errors are handled for you: * Windows: `EBUSY` and `ENOTEMPTY` - rimraf will back off a maximum of `opts.maxBusyTries` times before giving up, adding 100ms of wait between each attempt. The default `maxBusyTries` is 3. * `ENOENT` - If the file doesn't exist, rimraf will return successfully, since your desired outcome is already the case. * `EMFILE` - Since `readdir` requires opening a file descriptor, it's possible to hit `EMFILE` if too many file descriptors are in use. In the sync case, there's nothing to be done for this. But in the async case, rimraf will gradually back off with timeouts up to `opts.emfileWait` ms, which defaults to 1000. ## options * unlink, chmod, stat, lstat, rmdir, readdir, unlinkSync, chmodSync, statSync, lstatSync, rmdirSync, readdirSync In order to use a custom file system library, you can override specific fs functions on the options object. If any of these functions are present on the options object, then the supplied function will be used instead of the default fs method. Sync methods are only relevant for `rimraf.sync()`, of course. For example: ```javascript var myCustomFS = require('some-custom-fs') rimraf('some-thing', myCustomFS, callback) ``` * maxBusyTries If an `EBUSY`, `ENOTEMPTY`, or `EPERM` error code is encountered on Windows systems, then rimraf will retry with a linear backoff wait of 100ms longer on each try. The default maxBusyTries is 3. Only relevant for async usage. * emfileWait If an `EMFILE` error is encountered, then rimraf will retry repeatedly with a linear backoff of 1ms longer on each try, until the timeout counter hits this max. The default limit is 1000. If you repeatedly encounter `EMFILE` errors, then consider using [graceful-fs](http://npm.im/graceful-fs) in your program. Only relevant for async usage. * glob Set to `false` to disable [glob](http://npm.im/glob) pattern matching. Set to an object to pass options to the glob module. The default glob options are `{ nosort: true, silent: true }`. Glob version 6 is used in this module. Relevant for both sync and async usage. * disableGlob Set to any non-falsey value to disable globbing entirely. (Equivalent to setting `glob: false`.) ## rimraf.sync It can remove stuff synchronously, too. But that's not so good. Use the async API. It's better. ## CLI If installed with `npm install rimraf -g` it can be used as a global command `rimraf <path> [<path> ...]` which is useful for cross platform support. ## mkdirp If you need to create a directory recursively, check out [mkdirp](https://github.com/substack/node-mkdirp). # yargs-parser [](https://travis-ci.org/yargs/yargs-parser) [](https://www.npmjs.com/package/yargs-parser) [](https://github.com/conventional-changelog/standard-version) The mighty option parser used by [yargs](https://github.com/yargs/yargs). visit the [yargs website](http://yargs.js.org/) for more examples, and thorough usage instructions. <img width="250" src="https://raw.githubusercontent.com/yargs/yargs-parser/master/yargs-logo.png"> ## Example ```sh npm i yargs-parser --save ``` ```js var argv = require('yargs-parser')(process.argv.slice(2)) console.log(argv) ``` ```sh node example.js --foo=33 --bar hello { _: [], foo: 33, bar: 'hello' } ``` _or parse a string!_ ```js var argv = require('yargs-parser')('--foo=99 --bar=33') console.log(argv) ``` ```sh { _: [], foo: 99, bar: 33 } ``` Convert an array of mixed types before passing to `yargs-parser`: ```js var parse = require('yargs-parser') parse(['-f', 11, '--zoom', 55].join(' ')) // <-- array to string parse(['-f', 11, '--zoom', 55].map(String)) // <-- array of strings ``` ## API ### require('yargs-parser')(args, opts={}) Parses command line arguments returning a simple mapping of keys and values. **expects:** * `args`: a string or array of strings representing the options to parse. * `opts`: provide a set of hints indicating how `args` should be parsed: * `opts.alias`: an object representing the set of aliases for a key: `{alias: {foo: ['f']}}`. * `opts.array`: indicate that keys should be parsed as an array: `{array: ['foo', 'bar']}`.<br> Indicate that keys should be parsed as an array and coerced to booleans / numbers:<br> `{array: [{ key: 'foo', boolean: true }, {key: 'bar', number: true}]}`. * `opts.boolean`: arguments should be parsed as booleans: `{boolean: ['x', 'y']}`. * `opts.coerce`: provide a custom synchronous function that returns a coerced value from the argument provided (or throws an error). For arrays the function is called only once for the entire array:<br> `{coerce: {foo: function (arg) {return modifiedArg}}}`. * `opts.config`: indicate a key that represents a path to a configuration file (this file will be loaded and parsed). * `opts.configObjects`: configuration objects to parse, their properties will be set as arguments:<br> `{configObjects: [{'x': 5, 'y': 33}, {'z': 44}]}`. * `opts.configuration`: provide configuration options to the yargs-parser (see: [configuration](#configuration)). * `opts.count`: indicate a key that should be used as a counter, e.g., `-vvv` = `{v: 3}`. * `opts.default`: provide default values for keys: `{default: {x: 33, y: 'hello world!'}}`. * `opts.envPrefix`: environment variables (`process.env`) with the prefix provided should be parsed. * `opts.narg`: specify that a key requires `n` arguments: `{narg: {x: 2}}`. * `opts.normalize`: `path.normalize()` will be applied to values set to this key. * `opts.number`: keys should be treated as numbers. * `opts.string`: keys should be treated as strings (even if they resemble a number `-x 33`). **returns:** * `obj`: an object representing the parsed value of `args` * `key/value`: key value pairs for each argument and their aliases. * `_`: an array representing the positional arguments. * [optional] `--`: an array with arguments after the end-of-options flag `--`. ### require('yargs-parser').detailed(args, opts={}) Parses a command line string, returning detailed information required by the yargs engine. **expects:** * `args`: a string or array of strings representing options to parse. * `opts`: provide a set of hints indicating how `args`, inputs are identical to `require('yargs-parser')(args, opts={})`. **returns:** * `argv`: an object representing the parsed value of `args` * `key/value`: key value pairs for each argument and their aliases. * `_`: an array representing the positional arguments. * [optional] `--`: an array with arguments after the end-of-options flag `--`. * `error`: populated with an error object if an exception occurred during parsing. * `aliases`: the inferred list of aliases built by combining lists in `opts.alias`. * `newAliases`: any new aliases added via camel-case expansion: * `boolean`: `{ fooBar: true }` * `defaulted`: any new argument created by `opts.default`, no aliases included. * `boolean`: `{ foo: true }` * `configuration`: given by default settings and `opts.configuration`. <a name="configuration"></a> ### Configuration The yargs-parser applies several automated transformations on the keys provided in `args`. These features can be turned on and off using the `configuration` field of `opts`. ```js var parsed = parser(['--no-dice'], { configuration: { 'boolean-negation': false } }) ``` ### short option groups * default: `true`. * key: `short-option-groups`. Should a group of short-options be treated as boolean flags? ```sh node example.js -abc { _: [], a: true, b: true, c: true } ``` _if disabled:_ ```sh node example.js -abc { _: [], abc: true } ``` ### camel-case expansion * default: `true`. * key: `camel-case-expansion`. Should hyphenated arguments be expanded into camel-case aliases? ```sh node example.js --foo-bar { _: [], 'foo-bar': true, fooBar: true } ``` _if disabled:_ ```sh node example.js --foo-bar { _: [], 'foo-bar': true } ``` ### dot-notation * default: `true` * key: `dot-notation` Should keys that contain `.` be treated as objects? ```sh node example.js --foo.bar { _: [], foo: { bar: true } } ``` _if disabled:_ ```sh node example.js --foo.bar { _: [], "foo.bar": true } ``` ### parse numbers * default: `true` * key: `parse-numbers` Should keys that look like numbers be treated as such? ```sh node example.js --foo=99.3 { _: [], foo: 99.3 } ``` _if disabled:_ ```sh node example.js --foo=99.3 { _: [], foo: "99.3" } ``` ### boolean negation * default: `true` * key: `boolean-negation` Should variables prefixed with `--no` be treated as negations? ```sh node example.js --no-foo { _: [], foo: false } ``` _if disabled:_ ```sh node example.js --no-foo { _: [], "no-foo": true } ``` ### combine arrays * default: `false` * key: `combine-arrays` Should arrays be combined when provided by both command line arguments and a configuration file. ### duplicate arguments array * default: `true` * key: `duplicate-arguments-array` Should arguments be coerced into an array when duplicated: ```sh node example.js -x 1 -x 2 { _: [], x: [1, 2] } ``` _if disabled:_ ```sh node example.js -x 1 -x 2 { _: [], x: 2 } ``` ### flatten duplicate arrays * default: `true` * key: `flatten-duplicate-arrays` Should array arguments be coerced into a single array when duplicated: ```sh node example.js -x 1 2 -x 3 4 { _: [], x: [1, 2, 3, 4] } ``` _if disabled:_ ```sh node example.js -x 1 2 -x 3 4 { _: [], x: [[1, 2], [3, 4]] } ``` ### greedy arrays * default: `true` * key: `greedy-arrays` Should arrays consume more than one positional argument following their flag. ```sh node example --arr 1 2 { _[], arr: [1, 2] } ``` _if disabled:_ ```sh node example --arr 1 2 { _[2], arr: [1] } ``` **Note: in `v18.0.0` we are considering defaulting greedy arrays to `false`.** ### nargs eats options * default: `false` * key: `nargs-eats-options` Should nargs consume dash options as well as positional arguments. ### negation prefix * default: `no-` * key: `negation-prefix` The prefix to use for negated boolean variables. ```sh node example.js --no-foo { _: [], foo: false } ``` _if set to `quux`:_ ```sh node example.js --quuxfoo { _: [], foo: false } ``` ### populate -- * default: `false`. * key: `populate--` Should unparsed flags be stored in `--` or `_`. _If disabled:_ ```sh node example.js a -b -- x y { _: [ 'a', 'x', 'y' ], b: true } ``` _If enabled:_ ```sh node example.js a -b -- x y { _: [ 'a' ], '--': [ 'x', 'y' ], b: true } ``` ### set placeholder key * default: `false`. * key: `set-placeholder-key`. Should a placeholder be added for keys not set via the corresponding CLI argument? _If disabled:_ ```sh node example.js -a 1 -c 2 { _: [], a: 1, c: 2 } ``` _If enabled:_ ```sh node example.js -a 1 -c 2 { _: [], a: 1, b: undefined, c: 2 } ``` ### halt at non-option * default: `false`. * key: `halt-at-non-option`. Should parsing stop at the first positional argument? This is similar to how e.g. `ssh` parses its command line. _If disabled:_ ```sh node example.js -a run b -x y { _: [ 'b' ], a: 'run', x: 'y' } ``` _If enabled:_ ```sh node example.js -a run b -x y { _: [ 'b', '-x', 'y' ], a: 'run' } ``` ### strip aliased * default: `false` * key: `strip-aliased` Should aliases be removed before returning results? _If disabled:_ ```sh node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1, 'test-alias': 1, testAlias: 1 } ``` _If enabled:_ ```sh node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1 } ``` ### strip dashed * default: `false` * key: `strip-dashed` Should dashed keys be removed before returning results? This option has no effect if `camel-case-expansion` is disabled. _If disabled:_ ```sh node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1 } ``` _If enabled:_ ```sh node example.js --test-field 1 { _: [], testField: 1 } ``` ### unknown options as args * default: `false` * key: `unknown-options-as-args` Should unknown options be treated like regular arguments? An unknown option is one that is not configured in `opts`. _If disabled_ ```sh node example.js --unknown-option --known-option 2 --string-option --unknown-option2 { _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true } ``` _If enabled_ ```sh node example.js --unknown-option --known-option 2 --string-option --unknown-option2 { _: ['--unknown-option'], knownOption: 2, stringOption: '--unknown-option2' } ``` ## Special Thanks The yargs project evolves from optimist and minimist. It owes its existence to a lot of James Halliday's hard work. Thanks [substack](https://github.com/substack) **beep** **boop** \o/ ## License ISC Browser-friendly inheritance fully compatible with standard node.js [inherits](http://nodejs.org/api/util.html#util_util_inherits_constructor_superconstructor). This package exports standard `inherits` from node.js `util` module in node environment, but also provides alternative browser-friendly implementation through [browser field](https://gist.github.com/shtylman/4339901). Alternative implementation is a literal copy of standard one located in standalone module to avoid requiring of `util`. It also has a shim for old browsers with no `Object.create` support. While keeping you sure you are using standard `inherits` implementation in node.js environment, it allows bundlers such as [browserify](https://github.com/substack/node-browserify) to not include full `util` package to your client code if all you need is just `inherits` function. It worth, because browser shim for `util` package is large and `inherits` is often the single function you need from it. It's recommended to use this package instead of `require('util').inherits` for any code that has chances to be used not only in node.js but in browser too. ## usage ```js var inherits = require('inherits'); // then use exactly as the standard one ``` ## note on version ~1.0 Version ~1.0 had completely different motivation and is not compatible neither with 2.0 nor with standard node.js `inherits`. If you are using version ~1.0 and planning to switch to ~2.0, be careful: * new version uses `super_` instead of `super` for referencing superclass * new version overwrites current prototype while old one preserves any existing fields on it # yargs-parser  [](https://www.npmjs.com/package/yargs-parser) [](https://conventionalcommits.org)  The mighty option parser used by [yargs](https://github.com/yargs/yargs). visit the [yargs website](http://yargs.js.org/) for more examples, and thorough usage instructions. <img width="250" src="https://raw.githubusercontent.com/yargs/yargs-parser/main/yargs-logo.png"> ## Example ```sh npm i yargs-parser --save ``` ```js const argv = require('yargs-parser')(process.argv.slice(2)) console.log(argv) ``` ```console $ node example.js --foo=33 --bar hello { _: [], foo: 33, bar: 'hello' } ``` _or parse a string!_ ```js const argv = require('yargs-parser')('--foo=99 --bar=33') console.log(argv) ``` ```console { _: [], foo: 99, bar: 33 } ``` Convert an array of mixed types before passing to `yargs-parser`: ```js const parse = require('yargs-parser') parse(['-f', 11, '--zoom', 55].join(' ')) // <-- array to string parse(['-f', 11, '--zoom', 55].map(String)) // <-- array of strings ``` ## Deno Example As of `v19` `yargs-parser` supports [Deno](https://github.com/denoland/deno): ```typescript import parser from "https://deno.land/x/yargs_parser/deno.ts"; const argv = parser('--foo=99 --bar=9987930', { string: ['bar'] }) console.log(argv) ``` ## ESM Example As of `v19` `yargs-parser` supports ESM (_both in Node.js and in the browser_): **Node.js:** ```js import parser from 'yargs-parser' const argv = parser('--foo=99 --bar=9987930', { string: ['bar'] }) console.log(argv) ``` **Browsers:** ```html <!doctype html> <body> <script type="module"> import parser from "https://unpkg.com/yargs-parser@19.0.0/browser.js"; const argv = parser('--foo=99 --bar=9987930', { string: ['bar'] }) console.log(argv) </script> </body> ``` ## API ### parser(args, opts={}) Parses command line arguments returning a simple mapping of keys and values. **expects:** * `args`: a string or array of strings representing the options to parse. * `opts`: provide a set of hints indicating how `args` should be parsed: * `opts.alias`: an object representing the set of aliases for a key: `{alias: {foo: ['f']}}`. * `opts.array`: indicate that keys should be parsed as an array: `{array: ['foo', 'bar']}`.<br> Indicate that keys should be parsed as an array and coerced to booleans / numbers:<br> `{array: [{ key: 'foo', boolean: true }, {key: 'bar', number: true}]}`. * `opts.boolean`: arguments should be parsed as booleans: `{boolean: ['x', 'y']}`. * `opts.coerce`: provide a custom synchronous function that returns a coerced value from the argument provided (or throws an error). For arrays the function is called only once for the entire array:<br> `{coerce: {foo: function (arg) {return modifiedArg}}}`. * `opts.config`: indicate a key that represents a path to a configuration file (this file will be loaded and parsed). * `opts.configObjects`: configuration objects to parse, their properties will be set as arguments:<br> `{configObjects: [{'x': 5, 'y': 33}, {'z': 44}]}`. * `opts.configuration`: provide configuration options to the yargs-parser (see: [configuration](#configuration)). * `opts.count`: indicate a key that should be used as a counter, e.g., `-vvv` = `{v: 3}`. * `opts.default`: provide default values for keys: `{default: {x: 33, y: 'hello world!'}}`. * `opts.envPrefix`: environment variables (`process.env`) with the prefix provided should be parsed. * `opts.narg`: specify that a key requires `n` arguments: `{narg: {x: 2}}`. * `opts.normalize`: `path.normalize()` will be applied to values set to this key. * `opts.number`: keys should be treated as numbers. * `opts.string`: keys should be treated as strings (even if they resemble a number `-x 33`). **returns:** * `obj`: an object representing the parsed value of `args` * `key/value`: key value pairs for each argument and their aliases. * `_`: an array representing the positional arguments. * [optional] `--`: an array with arguments after the end-of-options flag `--`. ### require('yargs-parser').detailed(args, opts={}) Parses a command line string, returning detailed information required by the yargs engine. **expects:** * `args`: a string or array of strings representing options to parse. * `opts`: provide a set of hints indicating how `args`, inputs are identical to `require('yargs-parser')(args, opts={})`. **returns:** * `argv`: an object representing the parsed value of `args` * `key/value`: key value pairs for each argument and their aliases. * `_`: an array representing the positional arguments. * [optional] `--`: an array with arguments after the end-of-options flag `--`. * `error`: populated with an error object if an exception occurred during parsing. * `aliases`: the inferred list of aliases built by combining lists in `opts.alias`. * `newAliases`: any new aliases added via camel-case expansion: * `boolean`: `{ fooBar: true }` * `defaulted`: any new argument created by `opts.default`, no aliases included. * `boolean`: `{ foo: true }` * `configuration`: given by default settings and `opts.configuration`. <a name="configuration"></a> ### Configuration The yargs-parser applies several automated transformations on the keys provided in `args`. These features can be turned on and off using the `configuration` field of `opts`. ```js var parsed = parser(['--no-dice'], { configuration: { 'boolean-negation': false } }) ``` ### short option groups * default: `true`. * key: `short-option-groups`. Should a group of short-options be treated as boolean flags? ```console $ node example.js -abc { _: [], a: true, b: true, c: true } ``` _if disabled:_ ```console $ node example.js -abc { _: [], abc: true } ``` ### camel-case expansion * default: `true`. * key: `camel-case-expansion`. Should hyphenated arguments be expanded into camel-case aliases? ```console $ node example.js --foo-bar { _: [], 'foo-bar': true, fooBar: true } ``` _if disabled:_ ```console $ node example.js --foo-bar { _: [], 'foo-bar': true } ``` ### dot-notation * default: `true` * key: `dot-notation` Should keys that contain `.` be treated as objects? ```console $ node example.js --foo.bar { _: [], foo: { bar: true } } ``` _if disabled:_ ```console $ node example.js --foo.bar { _: [], "foo.bar": true } ``` ### parse numbers * default: `true` * key: `parse-numbers` Should keys that look like numbers be treated as such? ```console $ node example.js --foo=99.3 { _: [], foo: 99.3 } ``` _if disabled:_ ```console $ node example.js --foo=99.3 { _: [], foo: "99.3" } ``` ### parse positional numbers * default: `true` * key: `parse-positional-numbers` Should positional keys that look like numbers be treated as such. ```console $ node example.js 99.3 { _: [99.3] } ``` _if disabled:_ ```console $ node example.js 99.3 { _: ['99.3'] } ``` ### boolean negation * default: `true` * key: `boolean-negation` Should variables prefixed with `--no` be treated as negations? ```console $ node example.js --no-foo { _: [], foo: false } ``` _if disabled:_ ```console $ node example.js --no-foo { _: [], "no-foo": true } ``` ### combine arrays * default: `false` * key: `combine-arrays` Should arrays be combined when provided by both command line arguments and a configuration file. ### duplicate arguments array * default: `true` * key: `duplicate-arguments-array` Should arguments be coerced into an array when duplicated: ```console $ node example.js -x 1 -x 2 { _: [], x: [1, 2] } ``` _if disabled:_ ```console $ node example.js -x 1 -x 2 { _: [], x: 2 } ``` ### flatten duplicate arrays * default: `true` * key: `flatten-duplicate-arrays` Should array arguments be coerced into a single array when duplicated: ```console $ node example.js -x 1 2 -x 3 4 { _: [], x: [1, 2, 3, 4] } ``` _if disabled:_ ```console $ node example.js -x 1 2 -x 3 4 { _: [], x: [[1, 2], [3, 4]] } ``` ### greedy arrays * default: `true` * key: `greedy-arrays` Should arrays consume more than one positional argument following their flag. ```console $ node example --arr 1 2 { _: [], arr: [1, 2] } ``` _if disabled:_ ```console $ node example --arr 1 2 { _: [2], arr: [1] } ``` **Note: in `v18.0.0` we are considering defaulting greedy arrays to `false`.** ### nargs eats options * default: `false` * key: `nargs-eats-options` Should nargs consume dash options as well as positional arguments. ### negation prefix * default: `no-` * key: `negation-prefix` The prefix to use for negated boolean variables. ```console $ node example.js --no-foo { _: [], foo: false } ``` _if set to `quux`:_ ```console $ node example.js --quuxfoo { _: [], foo: false } ``` ### populate -- * default: `false`. * key: `populate--` Should unparsed flags be stored in `--` or `_`. _If disabled:_ ```console $ node example.js a -b -- x y { _: [ 'a', 'x', 'y' ], b: true } ``` _If enabled:_ ```console $ node example.js a -b -- x y { _: [ 'a' ], '--': [ 'x', 'y' ], b: true } ``` ### set placeholder key * default: `false`. * key: `set-placeholder-key`. Should a placeholder be added for keys not set via the corresponding CLI argument? _If disabled:_ ```console $ node example.js -a 1 -c 2 { _: [], a: 1, c: 2 } ``` _If enabled:_ ```console $ node example.js -a 1 -c 2 { _: [], a: 1, b: undefined, c: 2 } ``` ### halt at non-option * default: `false`. * key: `halt-at-non-option`. Should parsing stop at the first positional argument? This is similar to how e.g. `ssh` parses its command line. _If disabled:_ ```console $ node example.js -a run b -x y { _: [ 'b' ], a: 'run', x: 'y' } ``` _If enabled:_ ```console $ node example.js -a run b -x y { _: [ 'b', '-x', 'y' ], a: 'run' } ``` ### strip aliased * default: `false` * key: `strip-aliased` Should aliases be removed before returning results? _If disabled:_ ```console $ node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1, 'test-alias': 1, testAlias: 1 } ``` _If enabled:_ ```console $ node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1 } ``` ### strip dashed * default: `false` * key: `strip-dashed` Should dashed keys be removed before returning results? This option has no effect if `camel-case-expansion` is disabled. _If disabled:_ ```console $ node example.js --test-field 1 { _: [], 'test-field': 1, testField: 1 } ``` _If enabled:_ ```console $ node example.js --test-field 1 { _: [], testField: 1 } ``` ### unknown options as args * default: `false` * key: `unknown-options-as-args` Should unknown options be treated like regular arguments? An unknown option is one that is not configured in `opts`. _If disabled_ ```console $ node example.js --unknown-option --known-option 2 --string-option --unknown-option2 { _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true } ``` _If enabled_ ```console $ node example.js --unknown-option --known-option 2 --string-option --unknown-option2 { _: ['--unknown-option'], knownOption: 2, stringOption: '--unknown-option2' } ``` ## Supported Node.js Versions Libraries in this ecosystem make a best effort to track [Node.js' release schedule](https://nodejs.org/en/about/releases/). Here's [a post on why we think this is important](https://medium.com/the-node-js-collection/maintainers-should-consider-following-node-js-release-schedule-ab08ed4de71a). ## Special Thanks The yargs project evolves from optimist and minimist. It owes its existence to a lot of James Halliday's hard work. Thanks [substack](https://github.com/substack) **beep** **boop** \o/ ## License ISC # cross-spawn [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [npm-url]:https://npmjs.org/package/cross-spawn [downloads-image]:https://img.shields.io/npm/dm/cross-spawn.svg [npm-image]:https://img.shields.io/npm/v/cross-spawn.svg [travis-url]:https://travis-ci.org/moxystudio/node-cross-spawn [travis-image]:https://img.shields.io/travis/moxystudio/node-cross-spawn/master.svg [appveyor-url]:https://ci.appveyor.com/project/satazor/node-cross-spawn [appveyor-image]:https://img.shields.io/appveyor/ci/satazor/node-cross-spawn/master.svg [codecov-url]:https://codecov.io/gh/moxystudio/node-cross-spawn [codecov-image]:https://img.shields.io/codecov/c/github/moxystudio/node-cross-spawn/master.svg [david-dm-url]:https://david-dm.org/moxystudio/node-cross-spawn [david-dm-image]:https://img.shields.io/david/moxystudio/node-cross-spawn.svg [david-dm-dev-url]:https://david-dm.org/moxystudio/node-cross-spawn?type=dev [david-dm-dev-image]:https://img.shields.io/david/dev/moxystudio/node-cross-spawn.svg A cross platform solution to node's spawn and spawnSync. ## Installation Node.js version 8 and up: `$ npm install cross-spawn` Node.js version 7 and under: `$ npm install cross-spawn@6` ## Why Node has issues when using spawn on Windows: - It ignores [PATHEXT](https://github.com/joyent/node/issues/2318) - It does not support [shebangs](https://en.wikipedia.org/wiki/Shebang_(Unix)) - Has problems running commands with [spaces](https://github.com/nodejs/node/issues/7367) - Has problems running commands with posix relative paths (e.g.: `./my-folder/my-executable`) - Has an [issue](https://github.com/moxystudio/node-cross-spawn/issues/82) with command shims (files in `node_modules/.bin/`), where arguments with quotes and parenthesis would result in [invalid syntax error](https://github.com/moxystudio/node-cross-spawn/blob/e77b8f22a416db46b6196767bcd35601d7e11d54/test/index.test.js#L149) - No `options.shell` support on node `<v4.8` All these issues are handled correctly by `cross-spawn`. There are some known modules, such as [win-spawn](https://github.com/ForbesLindesay/win-spawn), that try to solve this but they are either broken or provide faulty escaping of shell arguments. ## Usage Exactly the same way as node's [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) or [`spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options), so it's a drop in replacement. ```js const spawn = require('cross-spawn'); // Spawn NPM asynchronously const child = spawn('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' }); // Spawn NPM synchronously const result = spawn.sync('npm', ['list', '-g', '-depth', '0'], { stdio: 'inherit' }); ``` ## Caveats ### Using `options.shell` as an alternative to `cross-spawn` Starting from node `v4.8`, `spawn` has a `shell` option that allows you run commands from within a shell. This new option solves the [PATHEXT](https://github.com/joyent/node/issues/2318) issue but: - It's not supported in node `<v4.8` - You must manually escape the command and arguments which is very error prone, specially when passing user input - There are a lot of other unresolved issues from the [Why](#why) section that you must take into account If you are using the `shell` option to spawn a command in a cross platform way, consider using `cross-spawn` instead. You have been warned. ### `options.shell` support While `cross-spawn` adds support for `options.shell` in node `<v4.8`, all of its enhancements are disabled. This mimics the Node.js behavior. More specifically, the command and its arguments will not be automatically escaped nor shebang support will be offered. This is by design because if you are using `options.shell` you are probably targeting a specific platform anyway and you don't want things to get into your way. ### Shebangs support While `cross-spawn` handles shebangs on Windows, its support is limited. More specifically, it just supports `#!/usr/bin/env <program>` where `<program>` must not contain any arguments. If you would like to have the shebang support improved, feel free to contribute via a pull-request. Remember to always test your code on Windows! ## Tests `$ npm test` `$ npm test -- --watch` during development ## License Released under the [MIT License](https://www.opensource.org/licenses/mit-license.php). # lodash.clonedeep v4.5.0 The [lodash](https://lodash.com/) method `_.cloneDeep` exported as a [Node.js](https://nodejs.org/) module. ## Installation Using npm: ```bash $ {sudo -H} npm i -g npm $ npm i --save lodash.clonedeep ``` In Node.js: ```js var cloneDeep = require('lodash.clonedeep'); ``` See the [documentation](https://lodash.com/docs#cloneDeep) or [package source](https://github.com/lodash/lodash/blob/4.5.0-npm-packages/lodash.clonedeep) for more details. # axios // core The modules found in `core/` should be modules that are specific to the domain logic of axios. These modules would most likely not make sense to be consumed outside of the axios module, as their logic is too specific. Some examples of core modules are: - Dispatching requests - Managing interceptors - Handling config

Muzikanto_nestjs-near

.prettierrc.json README.md example .eslintrc.js README.md nest-cli.json package-lock.json package.json src app.module.ts main.ts test test.controller.ts test.module.ts test.service.ts test.utils.ts tsconfig.build.json tsconfig.json package-lock.json package.json src nest-ipfs nest-ipfs.module.ts nest-ipfs.utils.ts nest-near-contract nest-near-contract.module.ts nest-near-contract.utils.ts nest-near nest-near.module.ts nest-near.utils.ts tsconfig.json

<p align="center"> <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> </p> [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 [circleci-url]: https://circleci.com/gh/nestjs/nest <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> <p align="center"> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> </p> <!--[](https://opencollective.com/nest#backer) [](https://opencollective.com/nest#sponsor)--> ## Description [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. ## Installation ```bash $ npm install ``` ## Running the app ```bash # development $ npm run start # watch mode $ npm run start:dev # production mode $ npm run start:prod ``` ## Test ```bash # unit tests $ npm run test # e2e tests $ npm run test:e2e # test coverage $ npm run test:cov ``` ## Support Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). ## Stay in touch - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) - Website - [https://nestjs.com](https://nestjs.com/) - Twitter - [@nestframework](https://twitter.com/nestframework) ## License Nest is [MIT licensed](LICENSE). <h1 align="center">nestjs-near</h1> <div align="center"> <p align="center"> <a aria-label="NPM version" href="https://www.npmjs.com/package/nestjs-near"> <img alt="" src="https://img.shields.io/npm/v/nestjs-near.svg?style=for-the-badge&labelColor=000000"> </a> <a aria-label="github issues" href="https://www.npmjs.com/package/nestjs-near"> <img alt="github issues" src="https://img.shields.io/github/issues-closed/muzikanto/nestjs-near?style=for-the-badge&labelColor=000000"> </a> <a aria-label="Package size" href="https://www.npmjs.com/package/nestjs-near"> <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/nestjs-near?style=for-the-badge&labelColor=000000"> </a> <a aria-label="Downloads" href="https://www.npmjs.com/package/nestjs-near"> <img alt="npm" src="https://img.shields.io/npm/dm/nestjs-near?style=for-the-badge&labelColor=000000"> </a> <a aria-label="Prettier" href="https://www.npmjs.com/package/nestjs-near"> <img alt="npm" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=for-the-badge&labelColor=000000"> </a> <a aria-label="Prettier" href="https://www.npmjs.com/package/nestjs-near"> <img alt="npm" src="https://img.shields.io/badge/types-included-32715f.svg?style=for-the-badge&labelColor=000000"> </a> <a aria-label="License" href="https://github.com/Muzikanto/nestjs-near/blob/master/LICENSE.md"> <img alt="" src="https://img.shields.io/npm/l/next.svg?style=for-the-badge&labelColor=000000"> </a> </p> </div> ## Introduction Quick implementation of near in your application. Generation of typed smart contract methods. Including ready for use typed methods in popular smart contract [Standards](https://github.com/Muzikanto/nestjs-near/tree/master/src/standards). ## Navigation - [install](#setup) - [example](#quick-example) Quick example ## Setup You'll need to install the package from npm `npm i nestjs-near near-api-js`. ## Quick Example ```typescript jsx // app.module.ts @Module({ imports: [ NestNearModule.forRootAsync({ networkId: 'testnet', keyStore, nodeUrl: 'https://rpc.testnet.near.org', walletUrl: 'https://wallet.testnet.near.org', helperUrl: 'https://helper.testnet.near.org', }), NestNearContractModule.forRoot({ accountId: TEST_CONTRACT_ID, contractId: TEST_CONTRACT_ID, viewMethods: ['ft_balance_of'], changeMethods: [], }), TestModule, ], controllers: [], providers: [], }) export class AppModule {} // test.service.ts @Injectable({}) export class TestService { constructor( @InjectNestNear() public near: NestNear, @InjectNestNearContract(TEST_CONTRACT_ID) public contract: NestNearContract & { ft_balance_of: any }, ) {} public async test(): Promise<any> { const account = await this.near.account('muzikant.testnet'); const nearBalance = await account.getAccountBalance(); const ftBalance = await this.contract.ft_balance_of({ account_id: 'muzikant.testnet' }); return Promise.resolve({ nearBalance, ftBalance }); } } ``` ## Authors - Maksim Schiriy [@maksim-schiriy](https://www.linkedin.com/in/maksim-schiriy/?locale=en_US)

kevinmugiira_Mugiira_smart_contract_test

Cargo.toml README.md build.bat build.sh src lib.rs test.sh

# Rust Smart Contract Template ## Getting started To get started with this template: 1. Click the "Use this template" button to create a new repo based on this template 2. Update line 2 of `Cargo.toml` with your project name 3. Update line 4 of `Cargo.toml` with your project author names 4. Set up the [prerequisites](https://github.com/near/near-sdk-rs#pre-requisites) 5. Begin writing your smart contract in `src/lib.rs` 6. Test the contract `cargo test -- --nocapture` 8. Build the contract `RUSTFLAGS='-C link-arg=-s' cargo build --target wasm32-unknown-unknown --release` **Get more info at:** * [Rust Smart Contract Quick Start](https://docs.near.org/docs/develop/contracts/rust/intro) * [Rust SDK Book](https://www.near-sdk.io/)

hiba-machfej_crypTourist

README.md as-pect.config.js asconfig.json frontend index.html index.js package.json scripts 1.dev-deploy.sh 2.addPlace-getPlace.sh 2.say-thanks.sh README.md o-report.sh o-transfer.sh x-deploy.sh x-remove.sh src as-pect.d.ts as_types.d.ts crypTourist __tests__ README.md index.unit.spec.ts asconfig.json assembly index.ts models.ts tsconfig.json utils.ts

# Thanks Say "thanks!" to other students of the NCD by calling _their_ instance of this contract. You can optionally attach tokens to your message, or even leave an anonymous tip. Of course keep in mind that your signing account will be visible on the blockchain via NEAR Explorer even if you send an anonymous message. ## Contract ```ts // ------------------------------------ // contract initialization // ------------------------------------ /** * initialize contract with owner ID and other config data * * (note: this method is called "constructor" in the singleton contract code) */ function init(owner: AccountId, allow_anonymous: bool = true): void // ------------------------------------ // public methods // ------------------------------------ /** * give thanks to the owner of the contract * and optionally attach tokens */ function say(message: string, anonymous: bool): bool // ------------------------------------ // owner methods // ------------------------------------ /** * show all messages and users */ function list(): Array<Message> /** * generate a summary report */ function summarize(): Contract /** * transfer received funds to owner account */ function transfer(): void ``` ## Usage ### Development To deploy the contract for development, follow these steps: 1. clone this repo locally 2. run `./scripts/1.dev-deploy.sh` to deploy the contract (this uses `near dev-deploy`) **Your contract is now ready to use.** To use the contract you can do any of the following: _Public scripts_ ```sh 2.say-thanks.sh # post a message saying thank you, optionally attaching NEAR tokens 2.say-anon-thanks.sh # post an anonymous message (otherwise same as above) ``` _Owner scripts_ ```sh o-report.sh # generate a summary report of the contract state o-transfer.sh # transfer received funds to the owner account ``` ### Production It is recommended that you deploy the contract to a subaccount under your MainNet account to make it easier to identify you as the owner 1. clone this repo locally 2. run `./scripts/x-deploy.sh` to rebuild, deploy and initialize the contract to a target account requires the following environment variables - `NEAR_ENV`: Either `testnet` or `mainnet` - `OWNER`: The owner of the contract and the parent account. The contract will be deployed to `thanks.$OWNER` 3. run `./scripts/x-remove.sh` to delete the account requires the following environment variables - `NEAR_ENV`: Either `testnet` or `mainnet` - `OWNER`: The owner of the contract and the parent account. The contract will be deployed to `thanks.$OWNER` ## Setting up your terminal The scripts in this folder support a simple demonstration of the contract. It uses the following setup: ```txt ┌───────────────────────────────────────┬───────────────────────────────────────┐ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ └───────────────────────────────────────┴───────────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1615190770786-2702449 # export OWNER=sherif.testnet ``` - Commands _Owner scripts_ ```sh 1.dev-deploy.sh # cleanup, compile and deploy contract o-report.sh # generate a summary report of the contract state o-transfer.sh # transfer received funds to the owner account ``` _Public scripts_ ```sh 2.say-thanks.sh # post a message saying thank you, optionally attaching NEAR tokens 2.say-anon-thanks.sh # post an anonymous message (otherwise same as above) ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1615190770786-2702449 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068) ## Unit tests Unit tests can be run from the top level folder using the following command: ``` yarn test:unit ```

etulutas_near-protocol

README.md as-pect.config.js asconfig.json package.json scripts 1.dev-deploy.sh 2.use-contract.sh 3.cleanup.sh README.md src as_types.d.ts simple __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts singleton __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts tsconfig.json utils.ts

# `near-sdk-as` Starter Kit This is a good project to use as a starting point for your AssemblyScript project. ## Samples This repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform. The example here is very basic. It's a simple contract demonstrating the following concepts: - a single contract - the difference between `view` vs. `change` methods - basic contract storage There are 2 AssemblyScript contracts in this project, each in their own folder: - **simple** in the `src/simple` folder - **singleton** in the `src/singleton` folder ### Simple We say that an AssemblyScript contract is written in the "simple style" when the `index.ts` file (the contract entry point) includes a series of exported functions. In this case, all exported functions become public contract methods. ```ts // return the string 'hello world' export function helloWorld(): string {} // read the given key from account (contract) storage export function read(key: string): string {} // write the given value at the given key to account (contract) storage export function write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} ``` ### Singleton We say that an AssemblyScript contract is written in the "singleton style" when the `index.ts` file (the contract entry point) has a single exported class (the name of the class doesn't matter) that is decorated with `@nearBindgen`. In this case, all methods on the class become public contract methods unless marked `private`. Also, all instance variables are stored as a serialized instance of the class under a special storage key named `STATE`. AssemblyScript uses JSON for storage serialization (as opposed to Rust contracts which use a custom binary serialization format called borsh). ```ts @nearBindgen export class Contract { // return the string 'hello world' helloWorld(): string {} // read the given key from account (contract) storage read(key: string): string {} // write the given value at the given key to account (contract) storage @mutateState() write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} } ``` ## Usage ### Getting started (see below for video recordings of each of the following steps) INSTALL `NEAR CLI` first like this: `npm i -g near-cli` 1. clone this repo to a local folder 2. run `yarn` 3. run `./scripts/1.dev-deploy.sh` 3. run `./scripts/2.use-contract.sh` 4. run `./scripts/2.use-contract.sh` (yes, run it to see changes) 5. run `./scripts/3.cleanup.sh` ### Videos **`1.dev-deploy.sh`** This video shows the build and deployment of the contract. [](https://asciinema.org/a/409575) **`2.use-contract.sh`** This video shows contract methods being called. You should run the script twice to see the effect it has on contract state. [](https://asciinema.org/a/409577) **`3.cleanup.sh`** This video shows the cleanup script running. Make sure you add the `BENEFICIARY` environment variable. The script will remind you if you forget. ```sh export BENEFICIARY=<your-account-here> # this account receives contract account balance ``` [](https://asciinema.org/a/409580) ### Other documentation - See `./scripts/README.md` for documentation about the scripts - Watch this video where Willem Wyndham walks us through refactoring a simple example of a NEAR smart contract written in AssemblyScript https://youtu.be/QP7aveSqRPo ``` There are 2 "styles" of implementing AssemblyScript NEAR contracts: - the contract interface can either be a collection of exported functions - or the contract interface can be the methods of a an exported class We call the second style "Singleton" because there is only one instance of the class which is serialized to the blockchain storage. Rust contracts written for NEAR do this by default with the contract struct. 0:00 noise (to cut) 0:10 Welcome 0:59 Create project starting with "npm init" 2:20 Customize the project for AssemblyScript development 9:25 Import the Counter example and get unit tests passing 18:30 Adapt the Counter example to a Singleton style contract 21:49 Refactoring unit tests to access the new methods 24:45 Review and summary ``` ## The file system ```sh ├── README.md # this file ├── as-pect.config.js # configuration for as-pect (AssemblyScript unit testing) ├── asconfig.json # configuration for AssemblyScript compiler (supports multiple contracts) ├── package.json # NodeJS project manifest ├── scripts │   ├── 1.dev-deploy.sh # helper: build and deploy contracts │   ├── 2.use-contract.sh # helper: call methods on ContractPromise │   ├── 3.cleanup.sh # helper: delete build and deploy artifacts │   └── README.md # documentation for helper scripts ├── src │   ├── as_types.d.ts # AssemblyScript headers for type hints │   ├── simple # Contract 1: "Simple example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 1 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 1 │   ├── singleton # Contract 2: "Singleton-style example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 2 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 2 │   ├── tsconfig.json # Typescript configuration │   └── utils.ts # common contract utility functions └── yarn.lock # project manifest version lock ``` You may clone this repo to get started OR create everything from scratch. Please note that, in order to create the AssemblyScript and tests folder structure, you may use the command `asp --init` which will create the following folders and files: ``` ./assembly/ ./assembly/tests/ ./assembly/tests/example.spec.ts ./assembly/tests/as-pect.d.ts ``` ## Setting up your terminal The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project. It uses the following setup: ```sh # set your terminal up to have 2 windows, A and B like this: ┌─────────────────────────────────┬─────────────────────────────────┐ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ └─────────────────────────────────┴─────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1615190770786-2702449 # export OWNER=sherif.testnet ``` - Commands _helper scripts_ ```sh 1.dev-deploy.sh # helper: build and deploy contracts 2.use-contract.sh # helper: call methods on ContractPromise 3.cleanup.sh # helper: delete build and deploy artifacts ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1615190770786-2702449 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068)

ledevthang_W3C-NFT-Marketplace_NEAR

.github dependabot.yml scripts readme.sh workflows readme.yml tests.yml .gitpod.yml .travis.yml Cargo.toml README-Gitpod.md README-Windows.md README.md borsh.js frontend App.js config.js index.html index.js integration-tests rs Cargo.toml src tests.rs ts main.ava.ts package.json src external.rs internal.rs lib.rs nft_callback.rs sale_views.rs test.rs

Status Message ============== [](https://gitpod.io/#https://github.com/near-examples/rust-status-message) <!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page --> This smart contract saves and records the status messages of NEAR accounts that call it. Windows users: please visit the [Windows-specific README file](README-Windows.md). ## Prerequisites Ensure `near-cli` is installed by running: ``` near --version ``` If needed, install `near-cli`: ``` npm install near-cli -g ``` Ensure `Rust` is installed by running: ``` rustc --version ``` If needed, install `Rust`: ``` curl https://sh.rustup.rs -sSf | sh ``` Install dependencies ``` npm install ``` ## Quick Start To run this project locally: 1. Prerequisites: Make sure you have Node.js ≥ 12 installed (https://nodejs.org), then use it to install yarn: `npm install --global yarn` (or just `npm i -g yarn`) 2. Run the local development server: `yarn && yarn dev` (see package.json for a full list of scripts you can run with yarn) Now you'll have a local development environment backed by the NEAR TestNet! Running yarn dev will tell you the URL you can visit in your browser to see the app. ## Building this contract To make the build process compatible with multiple operating systems, the build process exists as a script in `package.json`. There are a number of special flags used to compile the smart contract into the wasm file. Run this command to build and place the wasm file in the `res` directory: ```bash npm run build ``` **Note**: Instead of `npm`, users of [yarn](https://yarnpkg.com) may run: ```bash yarn build ``` ### Important If you encounter an error similar to: >note: the `wasm32-unknown-unknown` target may not be installed Then run: ```bash rustup target add wasm32-unknown-unknown ``` ## Using this contract ### Web app Deploy the smart contract to a specific account created with the NEAR Wallet. Then interact with the smart contract using near-api-js on the frontend. If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org). Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command: ``` near login ``` Deploy the contract to your NEAR account: ```bash near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME ``` Build the frontend: ```bash npm start ``` If all is successful the app should be live at `localhost:1234`! ### Quickest deploy Build and deploy this smart contract to an development account. This development account will be created automatically and is not intended to be permanent. Please see the "Standard deploy" section for creating a more personalized account to deploy to. ```bash near dev-deploy --wasmFile res/status_message.wasm --helperUrl https://near-contract-helper.onrender.com ``` Behind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like: >Done deploying to dev-1234567890123 In this instance, the account is `dev-1234567890123`. A file has been created containing the key to the account, located at `neardev/dev-account`. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands. Run this command to the environment variable: ```bash source neardev/dev-account.env ``` You can tell if the environment variable is set correctly if your command line prints the account name after this command: ```bash echo $CONTRACT_NAME ``` The next command will call the contract's `set_status` method: ```bash near call $CONTRACT_NAME set_status '{"message": "aloha!"}' --accountId $CONTRACT_NAME ``` To retrieve the message from the contract, call `get_status` with the following: ```bash near view $CONTRACT_NAME get_status '{"account_id": "'$CONTRACT_NAME'"}' ``` ### Standard deploy In this option, the smart contract will get deployed to a specific account created with the NEAR Wallet. If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org). Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command: ``` near login ``` Deploy the contract: ```bash near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME ``` Set a status for your account: ```bash near call YOUR_ACCOUNT_NAME set_status '{"message": "aloha friend"}' --accountId YOUR_ACCOUNT_NAME ``` Get the status: ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}' ``` Note that these status messages are stored per account in a `HashMap`. See `src/lib.rs` for the code. We can try the same steps with another account to verify. **Note**: we're adding `NEW_ACCOUNT_NAME` for the next couple steps. There are two ways to create a new account: - the NEAR Wallet (as we did before) - `near create_account NEW_ACCOUNT_NAME --masterAccount YOUR_ACCOUNT_NAME` Now call the contract on the first account (where it's deployed): ```bash near call YOUR_ACCOUNT_NAME set_status '{"message": "bonjour"}' --accountId NEW_ACCOUNT_NAME ``` ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "NEW_ACCOUNT_NAME"}' ``` Returns `bonjour`. Make sure the original status remains: ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}' ``` ## Testing To test run: ```bash cargo test --package status-message -- --nocapture ```

NearDeFi_near-is-aurora

Cargo.toml README.md build.sh contract Cargo.toml src aurora.rs lib.rs engine-types Cargo.toml src account_id.rs lib.rs types.rs tests main.rs

TEST

Glitch-Hackaton_Glitch-Moody

.gitpod.yml README.md contract README.md build.sh build builder.c code.h contract.js methods.h deploy.sh neardev dev-account.env package-lock.json package.json src contract.ts model.ts utils.ts tsconfig.json frontend .env .eslintrc.json assets logo-black.svg logo-white.svg components near-interface.js near-wallet.js test.js next.config.js package-lock.json package.json pages api hello.ts public vercel.svg start.sh styles Home.module.css globals.css react-calendar.css temp App.js index.html index.js tsconfig.json integration-tests package-lock.json package.json src main.ava.ts package-lock.json package.json

near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```ts @NearBindgen({}) class HelloNear { greeting: string = "Hello"; @view // This method is read-only and can be called for free get_greeting(): string { return this.greeting; } @call // This method changes the state, for which it cost gas set_greeting({ greeting }: { greeting: string }): void { // Record a log permanently to the blockchain! near.log(`Saving greeting ${greeting}`); this.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [node.js](https://nodejs.org/en/download/package-manager/) >= 16. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash npm run deploy ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `call` method. `Call` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"greeting":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.

howmarketing_vault-contract

Cargo.toml README.md account_deposit.rs build.sh neardev dev-account.env run.sh src account_deposit.rs errors.rs lib.rs storage_impl.rs token_receiver.rs

# Vault_Contract This repository has the smart-contract code of the vault project.

LorisC_hackhaton-near

.idea vcs.xml README.md contract-rs README.md track_contract Cargo.toml package.json src lib.rs tracker_factory Cargo.toml package.json src lib.rs frontend .eslintrc.js README.md babel.config.js package-lock.json package.json public index.html src constants Constants.js colorPalette.js mapSetting.js main.js plugins element.js router index.js store index.js

Context No Trash Alliance NTA in short is a project for The Global Hack Bounty. The aim of this project is to create the foundation for an association of garbage collector / processor company to track recyclable waste around the world. In 1997, the American oceanographer Charles Moore discovered the first vortex of waste in the sea: an area of 3.4 million square kilometers contaminated by floating plastic waste. Part of this plastic waste is due to garbage collector/ processor “losing” a part of the waste while transiting them from a processing site to another. With an association like NTA where every member agreed to tracker their waste until their waste is totally recycled can help reduce the amount of waste lost and create a new economy for the trashes. Indeed, with the global warming and green gas more and more companies a trying to find a way to reduce their waste and/or recycled it. https://www.youtube.com/watch?v=97D4jq3tbdg http://gumdropltd.com/gumdrop-bin/ https://www.businessinsider.com/companies-using-recycled-plastic-in-products?IR=T#parley-x-adidas-1 Improvement: Add possibility to buy only a part of the payload trash Use near token to make the transaction between user. Use real location so the trash can be view on google map Add a system to see previous state of a tracker contract # frontend ## Project setup ``` npm install ``` ### Compiles and hot-reloads for development ``` Change the value of CONTRACT_NAME in config.js with the account_id of the factory npm run serve ``` ### Compiles and minifies for production ``` npm run build ``` ### Lints and fixes files ``` npm run lint ``` ### Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/). Change the near account used in the script part of the package.json of the tracker-factory and run npm run init to deploy and initialize the contract

phoenix-token_bond_pnx

Cargo.toml README.md package-lock.json package.json src constants.rs errors.rs lib.rs state.rs utils.rs error Action View target .rustc_info.json debug .fingerprint Inflector-d2148e4a37c14682 lib-inflector.json ahash-d65fcef89a4d232e lib-ahash.json ahash-e48ca6696c531141 lib-ahash.json aho-corasick-4814d8e10bca2401 lib-aho_corasick.json aho-corasick-a0937382ff8ed835 lib-aho_corasick.json autocfg-e3e3fa18282d92e3 lib-autocfg.json base64-1d1fa0a77822fd50 lib-base64.json base64-33f73ae567a16c19 lib-base64.json block-buffer-926e958c9ca14572 lib-block-buffer.json block-buffer-9a86c169c28aa746 lib-block-buffer.json block-padding-835a1d826697cd1a lib-block-padding.json block-padding-88cdfec2d062b79f lib-block-padding.json borsh-172f55070885e3ed lib-borsh.json borsh-cbe247b820451179 lib-borsh.json borsh-derive-38597ce61522308d lib-borsh-derive.json borsh-derive-internal-27359216778bfbb1 lib-borsh-derive-internal.json borsh-schema-derive-internal-40d07ef60f46a592 lib-borsh-schema-derive-internal.json bs58-7c02f0245922d07d lib-bs58.json bs58-edb79d29363168f0 lib-bs58.json byteorder-a8009d40ace471f8 lib-byteorder.json byteorder-f49457a38753d563 lib-byteorder.json cfg-if-5b9b3cb1bf3d00dc lib-cfg-if.json cfg-if-b5167c67a271ba5c lib-cfg-if.json cfg-if-c3580a45fb38904f lib-cfg-if.json cfg-if-d79d4230b67dff33 lib-cfg-if.json convert_case-82ddf0742915dbc2 lib-convert_case.json cpufeatures-73ca1b41945b5e9c lib-cpufeatures.json cpufeatures-976ecce42899b7ae lib-cpufeatures.json derive_more-31536f792cc1bba9 lib-derive_more.json digest-26920ea2be9bdf8d lib-digest.json digest-8a7e21b8ab925d62 lib-digest.json generic-array-555cf76d40225b69 lib-generic_array.json generic-array-8f511ee942ee3faf run-build-script-build-script-build.json generic-array-9f420af43724f360 lib-generic_array.json generic-array-fdd115df1579780f build-script-build-script-build.json hashbrown-8a40706889e5a369 lib-hashbrown.json hashbrown-a0751d02fb4b8484 lib-hashbrown.json hashbrown-b300a7d0fe31bfa6 lib-hashbrown.json hex-1370f99b551c04ee lib-hex.json hex-c1bceeff1683446c lib-hex.json indexmap-161c5a672f633d51 lib-indexmap.json indexmap-4d0734029afd1012 run-build-script-build-script-build.json indexmap-a1e5c78203d7ae4d build-script-build-script-build.json itoa-4d5d7f7e186c0f94 lib-itoa.json itoa-cfa4024c9bdc9940 lib-itoa.json keccak-4adafa28f298be01 lib-keccak.json keccak-95902e7fa835e531 lib-keccak.json lazy_static-54f0ec464d8b1ca3 lib-lazy_static.json lazy_static-bc2f47adaad103e9 lib-lazy_static.json libc-54efb337ac82c463 lib-libc.json libc-653d85e13f7f56c5 run-build-script-build-script-build.json libc-af5ccdb0c4b1e8a8 lib-libc.json libc-d6efd6de7f1db008 build-script-build-script-build.json memchr-58968f99e2942a99 run-build-script-build-script-build.json memchr-5af045cbff601e05 lib-memchr.json memchr-7a85b35aceb91ef0 lib-memchr.json memchr-e91501c3225c1377 build-script-build-script-build.json memory_units-4514568d388b0353 lib-memory_units.json memory_units-f62e7862f8968c91 lib-memory_units.json near-contract-standards-342329e09ee9df6c lib-near-contract-standards.json near-contract-standards-447c49a991dfd075 lib-near-contract-standards.json near-primitives-core-aab55ba6895e69e5 lib-near-primitives-core.json near-primitives-core-bf788859566dd7aa lib-near-primitives-core.json near-rpc-error-core-2a88f9e5853142c4 lib-near-rpc-error-core.json near-rpc-error-macro-832b78bb0941ecb9 lib-near-rpc-error-macro.json near-runtime-utils-473bca9262479918 lib-near-runtime-utils.json near-runtime-utils-b256469e1d458d8e lib-near-runtime-utils.json near-sdk-core-b78606d0d7cf3770 lib-near-sdk-core.json near-sdk-d38b0cd54539f278 lib-near-sdk.json near-sdk-dfc38ff9d457441b lib-near-sdk.json near-sdk-macros-9ba44f85c3a43d3f lib-near-sdk-macros.json near-vm-errors-8eb31c16a8b19288 lib-near-vm-errors.json near-vm-errors-c3eca1555f127354 lib-near-vm-errors.json near-vm-logic-5e38983e42dcd696 lib-near-vm-logic.json near-vm-logic-645dd9aa1a0e4d11 lib-near-vm-logic.json num-bigint-101aef2716dad5ee lib-num-bigint.json num-bigint-938bc37a47123fc3 build-script-build-script-build.json num-bigint-a4a25dceb60a6853 lib-num-bigint.json num-bigint-ec107ef8a4cf9153 run-build-script-build-script-build.json num-integer-41fd79b62aab9f0b run-build-script-build-script-build.json num-integer-5a0bb3acc13cb585 build-script-build-script-build.json num-integer-608e849467a16cb2 lib-num-integer.json num-integer-c593d2c37ca0a010 lib-num-integer.json num-rational-986f111fafd2978a run-build-script-build-script-build.json num-rational-bdced73fb01c8e5f lib-num-rational.json num-rational-c5ce5f8f936c3d71 lib-num-rational.json num-rational-dd2d1147d204ab3b build-script-build-script-build.json num-traits-3c47a0ba9679ff1b lib-num-traits.json num-traits-3d83e71a22558e2d build-script-build-script-build.json num-traits-90303ab66257ddd1 lib-num-traits.json num-traits-90d8d8116c45a755 run-build-script-build-script-build.json opaque-debug-0d7e2328cebd6cca lib-opaque-debug.json opaque-debug-535f570a2b9e895f lib-opaque-debug.json phoenix_bond-09572461cf1e7929 test-lib-phoenix_bond.json phoenix_bond-60b63885be27f54d test-lib-phoenix_bond.json phoenix_bond-805ec330439288f7 test-lib-phoenix_bond.json phoenix_bond-87f22eadb26cb3ca lib-phoenix_bond.json phoenix_bond-a1837900dc7c91c2 test-lib-phoenix_bond.json phoenix_bond-dde7fac73f14cd5a test-lib-phoenix_bond.json phoenix_bond-e22423fdba4d06c3 test-lib-phoenix_bond.json phoenix_bond-e9220dc47bc5f34b lib-phoenix_bond.json phoenix_bond-f6ada4fc0ce7fbca lib-phoenix_bond.json phoenix_bond-ffcedc73c5827063 lib-phoenix_bond.json proc-macro-crate-3698f2278bc06923 lib-proc-macro-crate.json proc-macro2-0687e631b58b584a run-build-script-build-script-build.json proc-macro2-a43938dac13af6ab build-script-build-script-build.json proc-macro2-f8441f330c6f5955 lib-proc-macro2.json quote-0241397e45631a95 lib-quote.json regex-567d3bb5e25ff96b lib-regex.json regex-d0fa6d6ad1ccfd8c lib-regex.json regex-syntax-218be71617600397 lib-regex-syntax.json regex-syntax-256a0851c3b5d35e lib-regex-syntax.json ryu-050e098a2dda45ef lib-ryu.json ryu-64132e495642f4c7 lib-ryu.json serde-264b2ef6a13b611e lib-serde.json serde-30b2c95a2593f43b lib-serde.json serde-b102d1ea1a7f59e2 build-script-build-script-build.json serde-e0bd6cf9ad2bdf0f run-build-script-build-script-build.json serde_derive-0bb40d09e1e36c41 build-script-build-script-build.json serde_derive-2d8841a8192883ce run-build-script-build-script-build.json serde_derive-6b1a8a3ea7e1055b lib-serde_derive.json serde_json-019e647cd6b03427 build-script-build-script-build.json serde_json-06707e2b285c336f lib-serde_json.json serde_json-71d1f3bc3988a942 lib-serde_json.json serde_json-8e2d1ab8bbd8a0f9 build-script-build-script-build.json serde_json-a5b81e5ce2978c4c run-build-script-build-script-build.json serde_json-a8576ec18a312005 lib-serde_json.json serde_json-b57afd483cee349d run-build-script-build-script-build.json sha2-b47be6867c72bc4d lib-sha2.json sha2-b94118c7d0a64ef5 lib-sha2.json sha3-566c0976f168a288 lib-sha3.json sha3-6e27d347bc0a5009 lib-sha3.json syn-6bde7c3493323213 run-build-script-build-script-build.json syn-9af385bdbff15c52 lib-syn.json syn-d6cbdee0883f2c5c build-script-build-script-build.json toml-0d6f4ee19cc46595 lib-toml.json typenum-30844e8a3a841e5c lib-typenum.json typenum-35a6aa278c267896 lib-typenum.json typenum-c5f92657527e1b97 build-script-build-script-main.json typenum-e8acf6f6539df927 run-build-script-build-script-main.json unicode-xid-49139481c474d2cb lib-unicode-xid.json version_check-69ef4aa67c5ca43a lib-version_check.json wee_alloc-2a043c5a3b82fa5a run-build-script-build-script-build.json wee_alloc-3c5de2d60bf3159f lib-wee_alloc.json wee_alloc-57a318be28717cee build-script-build-script-build.json wee_alloc-bb0fb8a695a7ee51 lib-wee_alloc.json build num-bigint-ec107ef8a4cf9153 out radix_bases.rs typenum-e8acf6f6539df927 out consts.rs op.rs tests.rs wee_alloc-2a043c5a3b82fa5a out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint Inflector-5afbffc1f381f40a lib-inflector.json autocfg-e66a3272e8863782 lib-autocfg.json borsh-derive-78286670f1a0be09 lib-borsh-derive.json borsh-derive-internal-6f60ca7758a3ddd3 lib-borsh-derive-internal.json borsh-schema-derive-internal-4bd1087e81981677 lib-borsh-schema-derive-internal.json convert_case-7f94ef861a302c67 lib-convert_case.json derive_more-eabc45b0a37bbc1b lib-derive_more.json generic-array-3a7d11350224ae59 build-script-build-script-build.json hashbrown-8267c32e04fc0c06 lib-hashbrown.json indexmap-519b73da2ab05f39 lib-indexmap.json indexmap-aca81439a52c1ea8 build-script-build-script-build.json indexmap-e6f09245bbe9d316 run-build-script-build-script-build.json itoa-3682fffdd9bb8f05 lib-itoa.json memchr-222d0228aa2c8875 build-script-build-script-build.json near-rpc-error-core-d181e1744139f6f4 lib-near-rpc-error-core.json near-rpc-error-macro-66b4714688114fc7 lib-near-rpc-error-macro.json near-sdk-core-80f33ea35bf4610b lib-near-sdk-core.json near-sdk-macros-39c59b66db2a686c lib-near-sdk-macros.json num-bigint-f348f049baf378a6 build-script-build-script-build.json num-integer-258dfb06f7c8a0ae build-script-build-script-build.json num-rational-5e7b375c66f17a37 build-script-build-script-build.json num-traits-05305a644fd460f0 build-script-build-script-build.json proc-macro-crate-8deb2a0d6bacfd15 lib-proc-macro-crate.json proc-macro2-27b28193f6ef90f3 build-script-build-script-build.json proc-macro2-9b93eb184bb6ce4d lib-proc-macro2.json proc-macro2-eaa7213a5bbcbd8c run-build-script-build-script-build.json quote-7acd614d88a56742 lib-quote.json ryu-e8661800fc1c0a3a lib-ryu.json serde-207b3833f8c327b7 build-script-build-script-build.json serde-5ebb67f94275e0ab lib-serde.json serde-d449afb1c95c565e run-build-script-build-script-build.json serde_derive-4ad457bdb875e6a9 build-script-build-script-build.json serde_derive-b6a9f242a150de35 run-build-script-build-script-build.json serde_derive-c7860836b298e753 lib-serde_derive.json serde_json-13be051c2c6269fa lib-serde_json.json serde_json-79ba061e1bd804cb build-script-build-script-build.json serde_json-bd7d8132d686a257 build-script-build-script-build.json serde_json-e44b2fa82d8e9150 run-build-script-build-script-build.json syn-233b180dd090846f lib-syn.json syn-b38151015e4608a2 build-script-build-script-build.json syn-e0177b2227736eae run-build-script-build-script-build.json toml-c2c35641a1408f72 lib-toml.json typenum-f94bfce3f66f9366 build-script-build-script-main.json unicode-xid-04bf0a324076e980 lib-unicode-xid.json version_check-e99ac1345353eecd lib-version_check.json wee_alloc-313ada6273a678f7 build-script-build-script-build.json rls .rustc_info.json debug .fingerprint Inflector-d2148e4a37c14682 lib-inflector.json ahash-d65fcef89a4d232e lib-ahash.json aho-corasick-4814d8e10bca2401 lib-aho_corasick.json autocfg-e3e3fa18282d92e3 lib-autocfg.json base64-1d1fa0a77822fd50 lib-base64.json block-buffer-9a86c169c28aa746 lib-block-buffer.json block-padding-88cdfec2d062b79f lib-block-padding.json borsh-172f55070885e3ed lib-borsh.json borsh-derive-38597ce61522308d lib-borsh-derive.json borsh-derive-internal-27359216778bfbb1 lib-borsh-derive-internal.json borsh-schema-derive-internal-40d07ef60f46a592 lib-borsh-schema-derive-internal.json bs58-7c02f0245922d07d lib-bs58.json byteorder-f49457a38753d563 lib-byteorder.json cfg-if-5b9b3cb1bf3d00dc lib-cfg-if.json cfg-if-b5167c67a271ba5c lib-cfg-if.json convert_case-82ddf0742915dbc2 lib-convert_case.json cpufeatures-976ecce42899b7ae lib-cpufeatures.json derive_more-31536f792cc1bba9 lib-derive_more.json digest-26920ea2be9bdf8d lib-digest.json generic-array-555cf76d40225b69 lib-generic_array.json generic-array-8f511ee942ee3faf run-build-script-build-script-build.json generic-array-fdd115df1579780f build-script-build-script-build.json hashbrown-a0751d02fb4b8484 lib-hashbrown.json hashbrown-b300a7d0fe31bfa6 lib-hashbrown.json hex-1370f99b551c04ee lib-hex.json indexmap-161c5a672f633d51 lib-indexmap.json indexmap-4d0734029afd1012 run-build-script-build-script-build.json indexmap-a1e5c78203d7ae4d build-script-build-script-build.json itoa-4d5d7f7e186c0f94 lib-itoa.json itoa-cfa4024c9bdc9940 lib-itoa.json keccak-95902e7fa835e531 lib-keccak.json lazy_static-bc2f47adaad103e9 lib-lazy_static.json libc-54efb337ac82c463 lib-libc.json libc-653d85e13f7f56c5 run-build-script-build-script-build.json libc-d6efd6de7f1db008 build-script-build-script-build.json memchr-58968f99e2942a99 run-build-script-build-script-build.json memchr-5af045cbff601e05 lib-memchr.json memchr-e91501c3225c1377 build-script-build-script-build.json memory_units-f62e7862f8968c91 lib-memory_units.json near-contract-standards-342329e09ee9df6c lib-near-contract-standards.json near-primitives-core-aab55ba6895e69e5 lib-near-primitives-core.json near-rpc-error-core-2a88f9e5853142c4 lib-near-rpc-error-core.json near-rpc-error-macro-832b78bb0941ecb9 lib-near-rpc-error-macro.json near-runtime-utils-473bca9262479918 lib-near-runtime-utils.json near-sdk-core-b78606d0d7cf3770 lib-near-sdk-core.json near-sdk-dfc38ff9d457441b lib-near-sdk.json near-sdk-macros-9ba44f85c3a43d3f lib-near-sdk-macros.json near-vm-errors-c3eca1555f127354 lib-near-vm-errors.json near-vm-logic-5e38983e42dcd696 lib-near-vm-logic.json num-bigint-938bc37a47123fc3 build-script-build-script-build.json num-bigint-a4a25dceb60a6853 lib-num-bigint.json num-bigint-ec107ef8a4cf9153 run-build-script-build-script-build.json num-integer-41fd79b62aab9f0b run-build-script-build-script-build.json num-integer-5a0bb3acc13cb585 build-script-build-script-build.json num-integer-c593d2c37ca0a010 lib-num-integer.json num-rational-986f111fafd2978a run-build-script-build-script-build.json num-rational-bdced73fb01c8e5f lib-num-rational.json num-rational-dd2d1147d204ab3b build-script-build-script-build.json num-traits-3d83e71a22558e2d build-script-build-script-build.json num-traits-90303ab66257ddd1 lib-num-traits.json num-traits-90d8d8116c45a755 run-build-script-build-script-build.json opaque-debug-535f570a2b9e895f lib-opaque-debug.json phoenix_bond-805ec330439288f7 test-lib-phoenix_bond.json phoenix_bond-87f22eadb26cb3ca lib-phoenix_bond.json phoenix_bond-a1837900dc7c91c2 test-lib-phoenix_bond.json phoenix_bond-dde7fac73f14cd5a test-lib-phoenix_bond.json phoenix_bond-f6ada4fc0ce7fbca lib-phoenix_bond.json phoenix_bond-ffcedc73c5827063 lib-phoenix_bond.json proc-macro-crate-3698f2278bc06923 lib-proc-macro-crate.json proc-macro2-0687e631b58b584a run-build-script-build-script-build.json proc-macro2-a43938dac13af6ab build-script-build-script-build.json proc-macro2-f8441f330c6f5955 lib-proc-macro2.json quote-0241397e45631a95 lib-quote.json regex-567d3bb5e25ff96b lib-regex.json regex-syntax-256a0851c3b5d35e lib-regex-syntax.json ryu-050e098a2dda45ef lib-ryu.json ryu-64132e495642f4c7 lib-ryu.json serde-264b2ef6a13b611e lib-serde.json serde-30b2c95a2593f43b lib-serde.json serde-b102d1ea1a7f59e2 build-script-build-script-build.json serde-e0bd6cf9ad2bdf0f run-build-script-build-script-build.json serde_derive-0bb40d09e1e36c41 build-script-build-script-build.json serde_derive-2d8841a8192883ce run-build-script-build-script-build.json serde_derive-6b1a8a3ea7e1055b lib-serde_derive.json serde_json-019e647cd6b03427 build-script-build-script-build.json serde_json-06707e2b285c336f lib-serde_json.json serde_json-8e2d1ab8bbd8a0f9 build-script-build-script-build.json serde_json-a5b81e5ce2978c4c run-build-script-build-script-build.json serde_json-a8576ec18a312005 lib-serde_json.json serde_json-b57afd483cee349d run-build-script-build-script-build.json sha2-b94118c7d0a64ef5 lib-sha2.json sha3-6e27d347bc0a5009 lib-sha3.json syn-6bde7c3493323213 run-build-script-build-script-build.json syn-9af385bdbff15c52 lib-syn.json syn-d6cbdee0883f2c5c build-script-build-script-build.json toml-0d6f4ee19cc46595 lib-toml.json typenum-30844e8a3a841e5c lib-typenum.json typenum-c5f92657527e1b97 build-script-build-script-main.json typenum-e8acf6f6539df927 run-build-script-build-script-main.json unicode-xid-49139481c474d2cb lib-unicode-xid.json version_check-69ef4aa67c5ca43a lib-version_check.json wee_alloc-2a043c5a3b82fa5a run-build-script-build-script-build.json wee_alloc-3c5de2d60bf3159f lib-wee_alloc.json wee_alloc-57a318be28717cee build-script-build-script-build.json build generic-array-fdd115df1579780f save-analysis build_script_build-fdd115df1579780f.json indexmap-a1e5c78203d7ae4d save-analysis build_script_build-a1e5c78203d7ae4d.json libc-d6efd6de7f1db008 save-analysis build_script_build-d6efd6de7f1db008.json memchr-e91501c3225c1377 save-analysis build_script_build-e91501c3225c1377.json num-bigint-938bc37a47123fc3 save-analysis build_script_build-938bc37a47123fc3.json num-bigint-ec107ef8a4cf9153 out radix_bases.rs num-integer-5a0bb3acc13cb585 save-analysis build_script_build-5a0bb3acc13cb585.json num-rational-dd2d1147d204ab3b save-analysis build_script_build-dd2d1147d204ab3b.json num-traits-3d83e71a22558e2d save-analysis build_script_build-3d83e71a22558e2d.json proc-macro2-a43938dac13af6ab save-analysis build_script_build-a43938dac13af6ab.json serde-b102d1ea1a7f59e2 save-analysis build_script_build-b102d1ea1a7f59e2.json serde_derive-0bb40d09e1e36c41 save-analysis build_script_build-0bb40d09e1e36c41.json serde_json-019e647cd6b03427 save-analysis build_script_build-019e647cd6b03427.json serde_json-8e2d1ab8bbd8a0f9 save-analysis build_script_build-8e2d1ab8bbd8a0f9.json syn-d6cbdee0883f2c5c save-analysis build_script_build-d6cbdee0883f2c5c.json typenum-c5f92657527e1b97 save-analysis build_script_main-c5f92657527e1b97.json typenum-e8acf6f6539df927 out consts.rs op.rs tests.rs wee_alloc-2a043c5a3b82fa5a out wee_alloc_static_array_backend_size_bytes.txt wee_alloc-57a318be28717cee save-analysis build_script_build-57a318be28717cee.json deps save-analysis libahash-d65fcef89a4d232e.json libaho_corasick-4814d8e10bca2401.json libautocfg-e3e3fa18282d92e3.json libbase64-1d1fa0a77822fd50.json libblock_buffer-9a86c169c28aa746.json libblock_padding-88cdfec2d062b79f.json libborsh-172f55070885e3ed.json libbs58-7c02f0245922d07d.json libbyteorder-f49457a38753d563.json libderive_more-31536f792cc1bba9.json libdigest-26920ea2be9bdf8d.json libgeneric_array-555cf76d40225b69.json libhashbrown-b300a7d0fe31bfa6.json libhex-1370f99b551c04ee.json libindexmap-161c5a672f633d51.json libinflector-d2148e4a37c14682.json libitoa-cfa4024c9bdc9940.json libkeccak-95902e7fa835e531.json liblazy_static-bc2f47adaad103e9.json libmemchr-5af045cbff601e05.json libmemory_units-f62e7862f8968c91.json libnear_contract_standards-342329e09ee9df6c.json libnear_primitives_core-aab55ba6895e69e5.json libnear_rpc_error_core-2a88f9e5853142c4.json libnear_rpc_error_macro-832b78bb0941ecb9.json libnear_runtime_utils-473bca9262479918.json libnear_sdk-dfc38ff9d457441b.json libnear_vm_errors-c3eca1555f127354.json libnear_vm_logic-5e38983e42dcd696.json libnum_bigint-a4a25dceb60a6853.json libnum_integer-c593d2c37ca0a010.json libnum_rational-bdced73fb01c8e5f.json libnum_traits-90303ab66257ddd1.json libopaque_debug-535f570a2b9e895f.json libphoenix_bond-f6ada4fc0ce7fbca.json libproc_macro2-f8441f330c6f5955.json libproc_macro_crate-3698f2278bc06923.json libquote-0241397e45631a95.json libregex-567d3bb5e25ff96b.json libryu-64132e495642f4c7.json libsha2-b94118c7d0a64ef5.json libsha3-6e27d347bc0a5009.json libtoml-0d6f4ee19cc46595.json libunicode_xid-49139481c474d2cb.json libversion_check-69ef4aa67c5ca43a.json libwee_alloc-3c5de2d60bf3159f.json phoenix_bond-805ec330439288f7.json wasm32-unknown-unknown release .fingerprint ahash-a666a18ce4bdc94b lib-ahash.json aho-corasick-b60cece53a5d0c71 lib-aho_corasick.json base64-1ed1d53a0bb4ede3 lib-base64.json block-buffer-7b201f30eb8ab539 lib-block-buffer.json block-padding-fbfb1849312bc35d lib-block-padding.json borsh-af19d11567e666be lib-borsh.json bs58-fb56fd8419b90e44 lib-bs58.json byteorder-9978f81a254f5ad1 lib-byteorder.json cfg-if-965cb580b6e327c6 lib-cfg-if.json cfg-if-dd960ab89cfbd5f8 lib-cfg-if.json digest-3ee3fb2210fdb978 lib-digest.json generic-array-0fb87adbace3f08f lib-generic_array.json generic-array-28ebe296c1e51ebf run-build-script-build-script-build.json hashbrown-5fad88fbb676dcdb lib-hashbrown.json hex-e8010e7430859208 lib-hex.json itoa-f45533cd88df806a lib-itoa.json keccak-2c7663c170113ae4 lib-keccak.json lazy_static-372bc09852785a7d lib-lazy_static.json memchr-130a85cfd1e4f5a2 lib-memchr.json memchr-4e15eb501438cef2 run-build-script-build-script-build.json memory_units-10d989eac0bc614d lib-memory_units.json near-contract-standards-e01d92a4eb8ce978 lib-near-contract-standards.json near-primitives-core-3d77935597efd18e lib-near-primitives-core.json near-runtime-utils-35db7d7c242eecc1 lib-near-runtime-utils.json near-sdk-d1cba7403278dbfe lib-near-sdk.json near-vm-errors-237685543d68de18 lib-near-vm-errors.json near-vm-logic-3deca9777e4d8906 lib-near-vm-logic.json num-bigint-cb5fc921aa95736e lib-num-bigint.json num-bigint-df6c8e0171ff679d run-build-script-build-script-build.json num-integer-3740d725b305c218 run-build-script-build-script-build.json num-integer-9f0a9cbb111e8a13 lib-num-integer.json num-rational-725db5b0f294a25c run-build-script-build-script-build.json num-rational-9f2abb8cecc6ec2d lib-num-rational.json num-traits-825e327a77bf7e38 lib-num-traits.json num-traits-f71666a5df00344c run-build-script-build-script-build.json opaque-debug-2866a454c38da7ba lib-opaque-debug.json phoenix_bond-e9220dc47bc5f34b lib-phoenix_bond.json regex-d56b11e75f52b1b4 lib-regex.json regex-syntax-7bfeac37d907494b lib-regex-syntax.json ryu-3725e29d92786a91 lib-ryu.json serde-503a705e7ff3f259 run-build-script-build-script-build.json serde-8bdf836b388962bb lib-serde.json serde_json-18cc3323926ec9b0 run-build-script-build-script-build.json serde_json-e2dc3e93a073a4c9 lib-serde_json.json sha2-c358cd978b12d117 lib-sha2.json sha3-4ed72efa76b204e1 lib-sha3.json typenum-619a1395bffcb487 run-build-script-build-script-main.json typenum-71e1d470f1eb9c71 lib-typenum.json wee_alloc-03630b35ebe68bb6 lib-wee_alloc.json wee_alloc-3004284b32418a0d run-build-script-build-script-build.json build num-bigint-df6c8e0171ff679d out radix_bases.rs typenum-619a1395bffcb487 out consts.rs op.rs tests.rs wee_alloc-3004284b32418a0d out wee_alloc_static_array_backend_size_bytes.txt | |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1038,"byte_end":1133,"line_start":22,"line_end":22,"column_start":1,"column_end":96}},{"value":" | `encode` | Returns a new `String` | Always |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1134,"byte_end":1229,"line_start":23,"line_end":23,"column_start":1,"column_end":96}},{"value":" | `encode_config` | Returns a new `String` | Always |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1230,"byte_end":1325,"line_start":24,"line_end":24,"column_start":1,"column_end":96}},{"value":" | `encode_config_buf` | Appends to provided `String` | Only if `String` needs to grow |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1326,"byte_end":1421,"line_start":25,"line_end":25,"column_start":1,"column_end":96}},{"value":" | `encode_config_slice` | Writes to provided `&[u8]` | Never |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1422,"byte_end":1517,"line_start":26,"line_end":26,"column_start":1,"column_end":96}},{"value":" ","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1518,"byte_end":1521,"line_start":27,"line_end":27,"column_start":1,"column_end":4}},{"value":" All of the encoding functions that take a `Config` will pad as per the config.","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1522,"byte_end":1604,"line_start":28,"line_end":28,"column_start":1,"column_end":83}},{"value":" ","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1605,"byte_end":1608,"line_start":29,"line_end":29,"column_start":1,"column_end":4}},{"value":" # Decoding","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1609,"byte_end":1623,"line_start":30,"line_end":30,"column_start":1,"column_end":15}},{"value":" ","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1624,"byte_end":1627,"line_start":31,"line_end":31,"column_start":1,"column_end":4}},{"value":" Just as for encoding, there are different decoding functions available.","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1628,"byte_end":1703,"line_start":32,"line_end":32,"column_start":1,"column_end":76}},{"value":" ","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1704,"byte_end":1707,"line_start":33,"line_end":33,"column_start":1,"column_end":4}},{"value":" | Function | Output | Allocates |","span":{"file_name":" home ken .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1708,"byte_end":1804,"line_start":34,"line_end":34,"column_start":1,"column_end":97}},{"value":" |

# bond_pnx bond_pnx demo

happydev0_kotal_kubernetes

README.md | apis aptos v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go bitcoin v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go chainlink v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go ethereum v1alpha1 defaults.go genesis.go genesis_defaulting.go genesis_validation.go genesis_validation_test.go groupversion_info.go network.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go ethereum2 v1alpha1 beacon_node.go beacon_node_defaulting_webhook.go beacon_node_defaulting_webhook_test.go beacon_node_validation_webhook.go beacon_node_validation_webhook_test.go beacon_node_webhook.go client.go defaults.go groupversion_info.go suite_test.go validator.go validator_defaulting_webhook.go validator_defaulting_webhook_test.go validator_validation_webhook.go validator_validation_webhook_test.go validator_webhook.go zz_generated.deepcopy.go filecoin v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go graph v1alpha1 defaults.go groupversion_info.go node.go zz_generated.deepcopy.go ipfs v1alpha1 cluster_peer.go cluster_peer_defaulting_webhook.go cluster_peer_defaulting_webhook_test.go cluster_peer_validation_webhook.go cluster_peer_validation_webhook_test.go cluster_peer_webhook.go defaults.go groupversion_info.go peer.go peer_defaulting_webhook.go peer_defaulting_webhook_test.go peer_validation_webhook.go peer_validation_webhook_test.go peer_webhook.go suite_test.go zz_generated.deepcopy.go near v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go polkadot v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go shared logging.go resources.go resources_test.go suite_test.go types.go utils.go zz_generated.deepcopy.go stacks v1alpha1 defaults.go groupversion_info.go node.go node_defaulting_webhook.go node_defaulting_webhook_test.go node_validation_webhook.go node_validation_webhook_test.go node_webhook.go suite_test.go zz_generated.deepcopy.go clients aptos aptos_core_client.go aptos_core_client_test.go client.go suite_test.go types.go bitcoin bitcoin_core_client.go bitcoin_core_client_test.go client.go suite_test.go types.go chainlink chainlink_client.go chainlink_client_test.go client.go suite_test.go types.go ethereum accounts.go besu_client.go besu_client_test.go client.go client_test.go extradata.go geth_client.go geth_client_test.go nethermind_client.go nethermind_client_test.go parity_genesis.go suite_test.go types.go ethereum2 client.go lighthouse_beacon_node.go lighthouse_beacon_node_test.go lighthouse_validator_client.go lighthouse_validator_client_test.go nimbus_beacon_node.go nimbus_beacon_node_test.go nimbus_validator_client.go nimbus_validator_client_test.go prysm_beacon_node.go prysm_beacon_node_test.go prysm_validator_client.go prysm_validator_client_test.go suite_test.go teku_beacon_node.go teku_beacon_node_test.go teku_validator_client.go teku_validator_client_test.go types.go filecoin client.go lotus_client.go lotus_client_test.go suite_test.go types.go graph client.go graph_node_client.go graph_node_client_test.go suite_test.go types.go interface.go ipfs client.go go_ipfs_cluster_client.go go_ipfs_cluster_client_test.go kubo_client.go kubo_client_test.go suite_test.go types.go near client.go near_client.go near_client_test.go suite_test.go types.go polkadot client.go polkadot_client.go polkadot_client_test.go suite_test.go types.go stacks client.go stacks_node_client.go stacks_node_client_test.go suite_test.go types.go controllers aptos config.go node_controller.go suite_test.go bitcoin node_controller.go node_controller_test.go suite_test.go chainlink copy_api_credentials.sh node_controller.go node_controller_test.go suite_test.go ethereum geth_import_account.sh geth_init_genesis.sh keystore.go nethermind_convert_enode_privatekey.sh nethermind_copy_keystore.sh node_controller.go node_controller_test.go suite_test.go types.go ethereum2 beacon_node_controller.go beacon_node_controller_test.go lighthouse_import_keystore.sh nimbus_copy_validators.sh prysm_import_keystore.sh suite_test.go validator_controller.go validator_controller_test.go filecoin config.go copy_config_toml.sh node_controller.go node_controller_test.go suite_test.go types.go graph node_controller.go suite_test.go ipfs cluster_peer_controller.go cluster_peer_controller_test.go config_ipfs.sh copy_swarm_key.sh init_ipfs_cluster_config.sh init_ipfs_config.sh peer_controller.go peer_controller_test.go suite_test.go near copy_node_key.sh copy_validator_key.sh init_near_node.sh node_controller.go node_controller_test.go suite_test.go types.go polkadot convert_node_private_key.sh node_controller.go node_controller_test.go suite_test.go types.go shared env.go errors.go host.go host_test.go labels.go labels_test.go path.go path_test.go secret.go security_context.go security_context_test.go types.go webhook.go webhook_test.go stacks config.go node_controller.go node_controller_test.go suite_test.go hack boilerplate.go.txt helpers node.go main.go multi.sh

# Kotal Operator Kotal operator is a **cloud agnostic blockchain deployer** that makes it super easy to deploy highly-available, self-managing, self-healing blockchain infrastructure (networks, nodes, storage clusters ...) on any cloud. ## What can I do with Kotal Operator ? - Deploy Bitcoin rpc nodes - Deploy ipfs peers and cluster peers - Deploy ipfs swarms - Deploy Ethereum transaction and mining nodes - Deploy Ethereum 2 beacon and validation nodes - Deploy private Ethereum networks - Deploy NEAR rpc, archive, and validator nodes - Deploy Polkadot rpc and validator nodes - Deploy Chainlink nodes - Deploy Filecoin nodes - Deploy Filecoin backed pinning services (FPS) - Deploy Stacks rpc and api nodes - Deploy Aptos full and validator nodes ## Kubernetes Custom Resources Kotal extended kubernetes with custom resources in different API groups. | Protocol | Description | API Group | Status | | ---------------- | ------------------------------------------------ | --------------------------- | ------ | | **Aptos** | Deploy Aptos full and validator nodes | aptos.kotal.io/v1alpha1 | alpha | | **Bitcoin** | Deploy Bitcoin nodes | bitcoin.kotal.io/v1alpha1 | alpha | | **Chainlink** | Deploy Chainlink nodes | chainlink.kotal.io/v1alpha1 | alpha | | **Ethereum** | Deploy private and public network Ethereum nodes | ethereum.kotal.io/v1alpha1 | alpha | | **Ethereum 2.0** | Deploy validator and beacon chain nodes | ethereum2.kotal.io/v1alpha1 | alpha | | **Filecoin** | Deploy Filecoin nodes | filecoin.kotal.io/v1alpha1 | alpha | | **Graph** | Deploy graph nodes | graph.kotal.io/v1alpha1 | alpha | | **IPFS** | Deploy IPFS peers, cluster peers, and swarms | ipfs.kotal.io/v1alpha1 | alpha | | **NEAR** | Deploy NEAR rpc, archive and validator nodes | near.kotal.io/v1alpha1 | alpha | | **Polkadot** | Deploy Polkadot nodes and validator nodes | polkadot.kotal.io/v1alpha1 | alpha | | **Stacks** | Deploy Stacks rpc and api nodes | stacks.kotal.io/v1alpha1 | alpha | ## Client support For each protocol, kotal supports at least 1 client (reference client): | Protocol | Client(s) | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **Aptos** | [Aptos Core](https://github.com/aptos-labs/aptos-core) | | **Bitcoin** | [Bitcoin Core](https://github.com/bitcoin/bitcoin) | | **Chainlink** | [Chainlink](https://github.com/smartcontractkit/chainlink) | | **Ethereum** | [Hyperledger Besu](https://github.com/hyperledger/besu), [Go-Ethereum](https://github.com/ethereum/go-ethereum), [Nethermind](https://github.com/NethermindEth/nethermind) | | **Ethereum 2.0** | [Teku](https://github.com/ConsenSys/teku), [Prysm](https://github.com/prysmaticlabs/prysm), [Lighthouse](https://github.com/sigp/lighthouse), [Nimbus](https://github.com/status-im/nimbus-eth2) | | **Filecoin** | [Lotus](https://github.com/filecoin-project/lotus) | | **Graph** | [graph-node](https://github.com/graphprotocol/graph-node) | | **IPFS** | [kubo](https://github.com/ipfs/kubo), [ipfs-cluster-service](https://github.com/ipfs/ipfs-cluster) | | **NEAR** | [nearcore](https://github.com/near/nearcore) | | **Polkadot** | [Parity Polkadot](https://github.com/paritytech/polkadot) | | **Stacks** | [Stacks Node](https://github.com/stacks-network/stacks-blockchain) | ## Install Kotal Kotal requires access to Kubernetes cluster with cert-manager installed. For development purposes, we recommend [KinD](https://kind.sigs.k8s.io/) (Kubernetes in Docker) to create kubernetes clusters and tear down kubernetes clusters in seconds: ```bash kind create cluster ``` After the cluster is up and running, [install](https://cert-manager.io/docs/installation/kubernetes/) cert-manager: ```bash kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.5.3/cert-manager.yaml ``` Install kotal custom resources and controllers: ```bash kubectl apply -f https://github.com/kotalco/kotal/releases/download/v0.1.0/kotal.yaml ``` ## Example Ethereum node using Hyperleger Besu client, joining goerli network, and enabling RPC HTTP server: ```yaml # ethereum-node.yaml apiVersion: ethereum.kotal.io/v1alpha1 kind: Node metadata: name: ethereum-node spec: client: besu network: goerli rpc: true ``` ```bash kubectl apply -f ethereum-node.yaml ``` ## Documentation Kotal documentation is available [here](https://docs.kotal.co) ## Get in touch - [Discord](https://discord.com/invite/kTxy4SA) - [website](https://kotal.co) - [@kotalco](https://twitter.com/kotalco) - [mostafa@kotal.co](mailto:mostafa@kotal.co) ## Contriubuting TODO ## Licensing Kotal Blockchain Kubernetes operator is free and open-source software licensed under the [Apache 2.0](LICENSE) License

phamthainb_spk-stream

README.md docs deploy.md note (3) copy.txt note (3).txt note.md smart-contract-v1 app Cargo.toml neardev dev-account.env src external.rs lib.rs stake Cargo.toml neardev dev-account.env src external.rs lib.rs token Cargo.toml neardev dev-account.env src events.rs ft_core.rs internal.rs lib.rs metadata.rs storage.rs

# SPK-STREAM # Smart Contract ## Require ➜ rustc --V rustc 1.65.0 (897e37553 2022-11-02) or higher ➜ cargo --version cargo 1.65.0 (4bc8f24d3 2022-10-20) or higher ## Build ➜ cargo build --target wasm32-unknown-unknown --release ➜ near dev-deploy ./target/wasm32-unknown-unknown/release/\*\*\*.wasm # BackEnd

ninjadev0706_terraspace-near

.eslintrc.json README.md contracts nft-staking Cargo.toml README.md build.sh src external.rs internal.rs lib.rs nft_callbacks.rs staking.rs staking_views.rs token.rs nft Cargo.toml build.sh src approval.rs enumeration.rs events.rs internal.rs lib.rs metadata.rs mint.rs nft_core.rs royalty.rs deploy.md json_update.js next-env.d.ts next.config.js package.json pages api hello.ts public assets css all.min.css bootstrap.min.css default.css jquery.counterup.min.js magnific-popup.min.css owl.carousel.min.css owl.theme.default.min.css responsive.css style.css wow.min.js img dashbaord chart.svg icons Explore.svg Wallet1.svg account.svg ca-down.svg ca-up.svg chain.svg checked.svg compass.svg dots.svg down-c.svg eye-off.svg eye-on.svg plus.svg server.svg star-d.svg star-f.svg varified1.svg verified.svg vol1.svg vol2.svg vol3.svg volume.svg walllet.svg js bootstrap.min.js jquery-3.6.0.min.js jquery.counterup.min.js magnific-popup.min.js main.js owl.carousel.min.js popper.min.js wow.min.js vercel.svg script.js styles globals.css tsconfig.json

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). ## Getting Started First, run the development server: ```bash npm run dev # or yarn dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. [API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. ## Learn More To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! ## Deploy on Vercel The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. # TBD

Jeremicarose_Fruitful_Near_Blockchain

.history README_19851026111459.md README_20220906181917.md contract README_20220906180849.md README_20220906181336.md scripts call_20220706193605.sh call_20220714162059.sh call_20220714162220.sh call_20220719165643.sh call_20220719173022.sh call_20220719173629.sh call_20220719174137.sh call_20220719174257.sh call_20220719174450.sh call_20220719174629.sh call_20220720193727.sh call_20220720194735.sh call_20220720200039.sh call_20220720200533.sh call_20220720200630.sh call_20220720200720.sh call_20220720200816.sh call_20220720200957.sh call_20220721151033.sh call_20220721151218.sh call_20220721153700.sh call_20220721153747.sh call_20220722143928.sh call_20220722145506.sh call_20220722145732.sh call_20220722145844.sh call_20220722150036.sh call_20220722151942.sh call_20220722152039.sh call_20220722152726.sh call_20220722152834.sh call_20220722153911.sh call_20220803145847.sh call_20220803145945.sh call_20220803145952.sh call_20220803150104.sh call_20220803150433.sh call_20220803152900.sh call_20220803152903.sh call_20220803153003.sh call_20220803153111.sh deploy_20220705225850.sh deploy_20220720200121.sh deploy_20220720200420.sh deploy_20220720200952.sh src avocado_product_20220706142848.rs avocado_product_20220720193921.rs avocado_product_20220720194100.rs avocado_product_20220721153229.rs avocado_product_20220721153441.rs avocado_product_20220803145001.rs lib_20220707105203.rs lib_20220718153433.rs lib_20220718153939.rs lib_20220719155323.rs lib_20220719175236.rs lib_20220719175723.rs lib_20220720193736.rs lib_20220720193948.rs lib_20220720194011.rs lib_20220720194100.rs lib_20220720195316.rs lib_20220720195552.rs lib_20220720195657.rs lib_20220720195750.rs lib_20220720200135.rs lib_20220721150130.rs lib_20220721153428.rs lib_20220722145441.rs lib_20220722152252.rs lib_20220722152513.rs lib_20220722153715.rs lib_20220722153814.rs lib_20220722154028.rs lib_20220722154034.rs lib_20220803144946.rs lib_20220803144953.rs lib_20220803145104.rs lib_20220803145107.rs lib_20220803150720.rs lib_20220803151316.rs lib_20220803151836.rs lib_20220803151840.rs lib_20220803152332.rs lib_20220803152618.rs lib_20220803152622.rs package_20220713230934.json package_20220713231608.json public index_19851026111459.html index_20220714084203.html index_20220716155027.html index_20220716155109.html src App_19851026111459.js App_20220713184525.js App_20220713204318.js App_20220713204514.js App_20220713205323.js App_20220713205553.js App_20220713205559.js App_20220713205601.js App_20220713205953.js App_20220713215653.js App_20220713215741.js App_20220713222129.js App_20220713225303.js App_20220713225432.js App_20220713225612.js App_20220713225842.js App_20220714080330.js App_20220714083711.js App_20220714103347.js App_20220714113815.js App_20220714114439.js App_20220714114506.js App_20220714114553.js App_20220714144335.js App_20220714144645.js App_20220714163618.js App_20220716123342.js App_20220716123407.js App_20220716125744.js App_20220716125918.js App_20220719122912.js components Addova_20220714112249.js Addova_20220714112317.js Addova_20220714112623.js Addova_20220714112832.js Addova_20220714113039.js Addova_20220714114028.js Addova_20220716114756.js Addova_20220716120453.js Addova_20220716120652.js Addova_20220716123102.js Addova_20220716162331.js Addova_20220718145455.js Addova_20220719112444.js Addova_20220719112628.js Addova_20220719113129.js Addova_20220719113213.js Addova_20220719113859.js Addova_20220719210635.js Addova_20220719210700.js Addova_20220721152944.js Addova_20220721161313.js Addova_20220803160203.js Addova_20220803160206.js Navigation_20220714082602.js Navigation_20220714082656.js Navigation_20220714083947.js Navigation_20220714084320.js Navigation_20220714103045.js PrimaryButton_20220714082934.js PrimaryButton_20220714082951.js PrimaryButton_20220714083036.js PrimaryButton_20220714103014.js Product_20220714163344.js Product_20220714163406.js Product_20220718145456.js Product_20220718150118.js Product_20220718150331.js Product_20220718150635.js Product_20220718151700.js Product_20220718151813.js Products_20220714162650.js Products_20220714162742.js Products_20220714162901.js Products_20220714163008.js Products_20220714163058.js Products_20220714163200.js Products_20220714164328.js Products_20220714164512.js Products_20220716121256.js Products_20220716121606.js Products_20220716121759.js Products_20220716121855.js Products_20220716122003.js Products_20220716125827.js Products_20220716161537.js Products_20220716161710.js Products_20220716161802.js Products_20220716161858.js Products_20220718152639.js Products_20220718152933.js Products_20220718153030.js Products_20220718155027.js Products_20220718155136.ts Products_20220718155137.js Products_20220718202930.ts Products_20220718203534.ts Products_20220718203602.ts Products_20220718203719.js Products_20220718203751.js Products_20220718203958.js Products_20220718204426.js Products_20220718204604.js Products_20220718210417.js Products_20220718210556.js Products_20220718210709.js Products_20220718223806.js Products_20220718223951.js Products_20220718223957.js Products_20220718224009.js Products_20220718224120.js Products_20220718224204.js Products_20220718230719.js Products_20220718231248.js Products_20220718231520.js Products_20220719112444.js Products_20220719113849.js Products_20220719114344.js Products_20220719114501.js Products_20220719120320.js Products_20220719120533.js Products_20220719120658.js Products_20220719121137.js Products_20220719121737.js Products_20220719122858.js Products_20220719155315.js Products_20220719163420.js Products_20220719163912.js Products_20220721161307.js Products_20220721224705.js Products_20220721224726.js Products_20220721224926.js Products_20220721225300.js Products_20220722081433.js Products_20220722082025.js Products_20220722135846.js index_19851026111459.css index_19851026111459.js index_20220713184657.js index_20220713212709.js index_20220713212739.js index_20220716133014.css index_20220716133018.css index_20220716133019.css index_20220716154942.css util Cover_20220713224959.js Cover_20220713225028.js Cover_20220714073916.js Cover_20220714073956.js Cover_20220716114757.js Cover_20220716131943.js Cover_20220716131948.js Cover_20220716131958.js Cover_20220716132000.js Cover_20220716132007.js Cover_20220716132338.js Cover_20220716132441.js Cover_20220716132626.js Cover_20220716133028.js Cover_20220716133410.js Cover_20220716133440.js Cover_20220716140608.js Cover_20220716140907.js Cover_20220716141115.js Cover_20220716154115.js Cover_20220716154157.js Cover_20220716154449.js Cover_20220716154556.js Cover_20220716154631.js Cover_20220716155411.js Cover_20220716155515.js Cover_20220716155659.js Cover_20220716155917.js Cover_20220716160143.js Cover_20220716160514.js Cover_20220721211802.js Cover_20220721213510.js Cover_20220721213602.js Cover_20220721213909.js Cover_20220721214110.js Cover_20220721214346.js Cover_20220721214602.js Cover_20220721214613.js Cover_20220721214713.js Cover_20220721214835.js Cover_20220721215612.js Cover_20220721220055.js Cover_20220721220334.js Cover_20220721220929.js Cover_20220721221254.js Cover_20220721221358.js Cover_20220721221605.js Cover_20220721221904.js Cover_20220721222112.js Cover_20220721222602.js Cover_20220721222650.js Cover_20220721222711.js Cover_20220721222804.js Cover_20220721222946.js Cover_20220721223542.js Cover_20220721223612.js Cover_20220721224155.js Cover_20220721224215.js Cover_20220721224338.js Cover_20220721225254.js Cover_20220721225441.js Cover_20220721225755.js Cover_20220721225919.js Cover_20220721230128.js Cover_20220721230344.js Cover_20220721231007.js Cover_20220721231120.js Loder_20220713224123.js Loder_20220713224142.js Notification_20220713224245.js Notification_20220713224312.js Notification_20220713224656.js Notification_20220713230253.js Notification_20220713230409.js Notification_20220713230415.js Notification_20220713232054.js Notification_20220713232115.js Notification_20220714073809.js Notification_20220714073847.js Notification_20220714074052.js Notification_20220714074419.js Notification_20220714075830.js Notification_20220714075856.js Notification_20220714075926.js Notification_20220714075945.js Notification_20220714080003.js Notification_20220714080136.js Notification_20220714080435.js cover_20220716131607.css cover_20220716132012.css cover_20220716133403.css cover_20220716133404.css cover_20220716133627.css cover_20220716133705.css cover_20220716134024.css cover_20220716134041.css cover_20220716134101.css cover_20220716134236.css cover_20220716134604.css cover_20220716134751.css cover_20220716135057.css cover_20220716135400.css cover_20220716135721.css cover_20220716135940.css cover_20220716140044.css cover_20220716140137.css cover_20220716140609.css cover_20220716141115.css cover_20220716155418.css wallet_20220713204731.js wallet_20220713204804.js wallet_20220713205031.js wallet_20220713205609.js wallet_20220713205610.js wallet_20220713210133.js wallet_20220721225458.js utils config_20220713183030.js config_20220713183310.js config_20220713183434.js config_20220713190650.js config_20220713191020.js marketplace_20220713184239.js marketplace_20220713184249.js marketplace_20220718153938.ts marketplace_20220718153939.js marketplace_20220718154347.ts marketplace_20220718210803.ts marketplace_20220718224850.js marketplace_20220718225949.js marketplace_20220718230342.js marketplace_20220718230419.js marketplace_20220721155130.js marketplace_20220721155140.js marketplace_20220721155538.js marketplace_20220721161542.js marketplace_20220721161547.js marketplace_20220803155541.js near_20220713183626.js near_20220713183711.js near_20220713183839.js near_20220713184114.js near_20220713185039.js near_20220713185143.js near_20220713191232.js near_20220713203712.js near_20220719141417.js near_20220719141504.js README.md contract Cargo.toml README.md scripts build.sh call.sh deploy.sh src avocado_product.rs lib.rs target .rustc_info.json release .fingerprint Inflector-22f9d3d66d01b83a lib-inflector.json ahash-22bd81b1bcf15b44 build-script-build-script-build.json borsh-derive-5a7a12b3e06f3b99 lib-borsh-derive.json borsh-derive-internal-a6d3e1f96a3be1ec lib-borsh-derive-internal.json borsh-schema-derive-internal-11ceac5f86e8ee07 lib-borsh-schema-derive-internal.json crunchy-27f192bc106f2930 build-script-build-script-build.json near-sdk-macros-a94f5c3d75b33343 lib-near-sdk-macros.json proc-macro-crate-614f8acdd597a6ce lib-proc-macro-crate.json proc-macro2-58e0f8a1cbd002c9 build-script-build-script-build.json proc-macro2-978c02b076823284 run-build-script-build-script-build.json proc-macro2-b84463297b652ae0 lib-proc-macro2.json quote-1d94438de6db281c run-build-script-build-script-build.json quote-a8e7b76fce8733c2 lib-quote.json quote-dd8b016aadae5d19 build-script-build-script-build.json serde-945f30eb307b3da9 lib-serde.json serde-9cd72590c29a82d0 build-script-build-script-build.json serde-b471d4d945dace55 build-script-build-script-build.json serde-f80db75b9d914c8e run-build-script-build-script-build.json serde_derive-6dd012f28f01c12e build-script-build-script-build.json serde_derive-e36cf4ce988ddfd2 run-build-script-build-script-build.json serde_derive-f7826db7dca725e2 lib-serde_derive.json serde_json-bee7f920bc90263c build-script-build-script-build.json syn-0a0af29e14963f73 run-build-script-build-script-build.json syn-11f6564052528ba7 lib-syn.json syn-5aaad2ad73d169d7 build-script-build-script-build.json toml-311f69999193789f lib-toml.json unicode-ident-b0c9c974cfad974d lib-unicode-ident.json version_check-8cf53cf3b71c836c lib-version_check.json wee_alloc-5ac3c69ca47e0fe7 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-090daeba5cf65e17 lib-ahash.json ahash-b1a40a14f893324e run-build-script-build-script-build.json base64-9adaaa094efe1e31 lib-base64.json borsh-fde72558eba5ccda lib-borsh.json bs58-285535bc3ac54b0a lib-bs58.json byteorder-2a2ecfa3adde7854 lib-byteorder.json cfg-if-2dd57157fa136f19 lib-cfg-if.json crunchy-1275cfc76e46def3 lib-crunchy.json crunchy-fee699d89f9fee2b run-build-script-build-script-build.json greeter-d5cbb7d1e1b2873c lib-greeter.json hashbrown-a0287a2b87cf1b95 lib-hashbrown.json hex-a82b3d198b8dbe7a lib-hex.json itoa-9273e939f344576a lib-itoa.json memory_units-0384fb5abc05abbc lib-memory_units.json near-sdk-3c1587151f81d9a1 lib-near-sdk.json near-sys-71cc4b4f823990c6 lib-near-sys.json once_cell-b7f52d71e3a33d2e lib-once_cell.json ryu-ce51b8f991ea300f lib-ryu.json serde-35ea379bbe6259b5 lib-serde.json serde-b443451f17d80d90 run-build-script-build-script-build.json serde_json-23a4bc3cfed665d2 run-build-script-build-script-build.json serde_json-97f6ad3a4acf6860 lib-serde_json.json static_assertions-13eac0dacca0a66c lib-static_assertions.json uint-c7e7f2f670b51dc0 lib-uint.json wee_alloc-c8460eb1b0e30f18 lib-wee_alloc.json wee_alloc-ff0e1f30233cf401 run-build-script-build-script-build.json build crunchy-fee699d89f9fee2b out lib.rs wee_alloc-ff0e1f30233cf401 out wee_alloc_static_array_backend_size_bytes.txt neardev dev-account.env shared-test test.near.json package.json public index.html manifest.json robots.txt src App.css App.js App.test.js components Addova.js Navigation.js PrimaryButton.js Product.js Products.js index.css index.js logo.svg reportWebVitals.js setupTests.js util Cover.js Loder.js Notification.js cover.css wallet.js utils config.js marketplace.js near.js

## Inspiration 💡 Most of the time, Farmers sells there product at a throwing price because of For that they will lose a lot of money feeling discourage and this will force them to venture to any othe bussiness. As a result, there is the need for a secure and efficient system to help farmers and buyers link without any middlemen. ## ❓ What it does 💡 Fruitfull is a decentralized and secure farming marketplace system. Its built on the Near blockchain and securely stores all farm product transaction records. The avocado products and transaction are securely stored in the ledger and can be accessed by the farmer or the buyer. First, on the app, either the farmer or the buy will connect their near wallet to the fruitfull app. If this is the farmer he or she is require to post her product unlike the buyer who can not post. On the other hand the buyer can purchase any ovacados. ## ⚙ How it was built - React for the frontend - Near, Rust Web3 for the Blockchain and smart contracts - Near for building the smart contracts in Rust programming language - Near blockchain for the ledger ## 🚧 Challenges 🚧 - Implementing the smart contracts in Rust programming language was a challenge. - Ran into bugs while building the smart contracts especially while building the smart contract. near-blank-project Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html # Getting Started with Create React App This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts In the project directory, you can run: ### `npm start` Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in your browser. The page will reload when you make changes.\ You may also see any lint errors in the console. ### `npm test` Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `npm run build` Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. ### `npm run eject` **Note: this is a one-way operation. Once you `eject`, you can't go back!** If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own. You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it. ## Inspiration 💡 Most of the time, Farmers sells there product at a throwing price because of For that they will lose a lot of money feeling discourage and this will force them to venture to any othe bussiness. As a result, there is the need for a secure and efficient system to help farmers and buyers link without any middlemen. ## ❓ What it does 💡 Fruitfull is a decentralized and secure farming marketplace system. Its built on the Near blockchain and securely stores all farm product transaction records. The avocado products and transaction are securely stored in the ledger and can be accessed by the farmer or the buyer. First, on the app, either the farmer or the buy will connect their near wallet to the fruitfull app. If this is the farmer he or she is require to post her product unlike the buyer who can not post. On the other hand the buyer can purchase any ovacados. ## ⚙ How it was built - React for the frontend - Near, Rust Web3 for the Blockchain and smart contracts - Near for building the smart contracts in Rust programming language - Near blockchain for the ledger ## 🚧 Challenges 🚧 - Implementing the smart contracts in Rust programming language was a challenge. - Ran into bugs while building the smart contracts especially while building the smart contract. near-blank-project Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html

parkdao_multi-ownable

Cargo.toml README.md build.sh flags.sh multi-ownable Cargo.toml README.md src lib.rs macros.rs out README.md test-contract Cargo.toml src lib.rs tests test_multi_ownable.rs

# Folder that contains wasm files # multi-ownable A NEAR plugin enables multiple Accounts to share ownership of a contract. Calls are stored in hashed form, so storage requirements are very low. ### test cargo test -- --nocapture ### usage `multi-ownable` can be addeded to your contract via a macro: ```rust // Arguments: // 1. name of your contract // 2. name of the field where the multi ownable state is stored // 3. enum type for possible multisig calls // 4. callback function to process completed multisig calls crate::impl_multi_ownable!(Contract, multi_ownable, MultiOwnableCall, on_call); ``` Here is a full working example of how to use `multi-ownable` ```rust // import "impl_multi_ownable" and "MultiOwnableData" use multi_ownable::{impl_multi_ownable, MultiOwnableData}; use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize}; use near_sdk::{env, near_bindgen, require, AccountId, BorshStorageKey, PanicOnDefault}; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)] pub struct Contract { multi_ownable: MultiOwnableData, // add this to the Contract number: u64, } #[derive(BorshSerialize, BorshStorageKey)] enum StorageKey { Owners, MultiOwnableCalls, } #[near_bindgen] impl Contract { #[init] pub fn new(owner_id: AccountId) -> Self { let mut this = Self { number: 0, multi_ownable: MultiOwnableData::new(StorageKey::Owners, StorageKey::MultiOwnableCalls), }; // initialize multi_ownable in the "new" func of your Contract this.init_multi_ownable(vec![owner_id.clone()], 1); this } pub fn get_number(&self) -> u64 { self.number } // arguments are received as a json string fn on_call(&mut self, call_name: MultiOwnableCall, arguments: &str) { match call_name { MultiOwnableCall::UpdateNumber => self._update_number(arguments), MultiOwnableCall::DoSomethingElse => self._do_something_else(arguments), } } #[private] fn _update_number(&mut self, args: &str) { // first, deserialize your arguments let UpdateNumberArgs { number } = near_sdk::serde_json::from_str(&args).expect("Invalid SetRewardRateArgs"); self.number = number; } #[private] fn _do_something_else(&self, _args: &str) { // do something else } } // an argument struct for "update_number" call #[derive(Serialize, Deserialize, Clone)] #[serde(crate = "near_sdk::serde")] pub struct UpdateNumberArgs { pub number: u64, } // create an enum to match possible multisig calls // make sure to both "rename" and "alias" your fields to be snake_case #[derive(BorshDeserialize, BorshSerialize, Serialize, Deserialize, Clone)] #[serde(crate = "near_sdk::serde")] pub enum MultiOwnableCall { #[serde(rename = "update_number", alias = "update_number")] UpdateNumber, #[serde(rename = "do_something_else", alias = "do_something_else")] DoSomethingElse, } crate::impl_multi_ownable!(Contract, multi_ownable, MultiOwnableCall, on_call); ``` # multi-ownable A NEAR plugin enables multiple Accounts to share ownership of a contract. Calls are stored in hashed form, so storage requirements are very low. ### test cargo test -- --nocapture ### usage `multi-ownable` can be addeded to your contract via a macro: ```rust // Arguments: // 1. name of your contract // 2. name of the field where the multi ownable state is stored // 3. enum type for possible multisig calls // 4. callback function to process completed multisig calls crate::impl_multi_ownable!(Contract, multi_ownable, MultiOwnableCall, on_call); ``` Here is a full working example of how to use `multi-ownable` ```rust // import "impl_multi_ownable" and "MultiOwnableData" use multi_ownable::{impl_multi_ownable, MultiOwnableData}; use near_sdk::borsh::{self, BorshDeserialize, BorshSerialize}; use near_sdk::{env, near_bindgen, require, AccountId, BorshStorageKey, PanicOnDefault}; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize, PanicOnDefault)] pub struct Contract { multi_ownable: MultiOwnableData, // add this to the Contract number: u64, } #[derive(BorshSerialize, BorshStorageKey)] enum StorageKey { Owners, MultiOwnableCalls, } #[near_bindgen] impl Contract { #[init] pub fn new(owner_id: AccountId) -> Self { let mut this = Self { number: 0, multi_ownable: MultiOwnableData::new(StorageKey::Owners, StorageKey::MultiOwnableCalls), }; // initialize multi_ownable in the "new" func of your Contract this.init_multi_ownable(vec![owner_id.clone()], 1); this } pub fn get_number(&self) -> u64 { self.number } // arguments are received as a json string fn on_call(&mut self, call_name: MultiOwnableCall, arguments: &str) { match call_name { MultiOwnableCall::UpdateNumber => self._update_number(arguments), MultiOwnableCall::DoSomethingElse => self._do_something_else(arguments), } } #[private] fn _update_number(&mut self, args: &str) { // first, deserialize your arguments let UpdateNumberArgs { number } = near_sdk::serde_json::from_str(&args).expect("Invalid SetRewardRateArgs"); self.number = number; } #[private] fn _do_something_else(&self, _args: &str) { // do something else } } // an argument struct for "update_number" call #[derive(Serialize, Deserialize, Clone)] #[serde(crate = "near_sdk::serde")] pub struct UpdateNumberArgs { pub number: u64, } // create an enum to match possible multisig calls // make sure to both "rename" and "alias" your fields to be snake_case #[derive(BorshDeserialize, BorshSerialize, Serialize, Deserialize, Clone)] #[serde(crate = "near_sdk::serde")] pub enum MultiOwnableCall { #[serde(rename = "update_number", alias = "update_number")] UpdateNumber, #[serde(rename = "do_something_else", alias = "do_something_else")] DoSomethingElse, } crate::impl_multi_ownable!(Contract, multi_ownable, MultiOwnableCall, on_call); ```

Learn-NEAR-Hispano_NCD1--NEARLancers

README.md as-pect.config.js asconfig.json assembly __test__ as-pect.d.ts index.unit.spec.ts as_types.d.ts index.ts models.ts tsconfig.json USUARIOS SERVICIOS COMENTARIOS VALORACIONES Métodos del smart contract de USUARIOS Métodos del smart contract de SERVICIOS Métodos del smart contract de COMENTARIOS Métodos del smart contract de VALORACIONES neardev dev-account.env package-lock.json package.json

# `NEARLancers` 📄 Descripción ================== NEARLancers es un contrato inteligente en el que puede crear un usuario y si lo desea puede ofrecer servicios para los demás usuarios, se podrán almacenar diversos servicios y consultar todos en general o de un usuario en específico utilizando el protocolo NEAR. Las siguientes son las principales funcionalidades de este contrato inteligente: 1. Crear un usuario. 2. Consultar un usuario por su id. 3. Registrar un servicio. 4. Consultar todos los servicios. 5. Consultar todos los servicios de un usuario. 6. Consultar un servicio por su id. 7. Agregar comentarios a un servicio. 8. Consultar los comentarios que tiene un servicio. 9. Agregar valoración a un servicio. 10. Consultar las valoraciones que tiene un servicio. 📦 Instalación ================ Para ejecutar este proyecto localmente, debe seguir los siguientes pasos: Paso 1: Prerequisitos ------------------------------ 1. Asegúrese de haber instalado [Node.js] ≥ 12 (recomendamos usar [nvm]) 2. Asegúrese de haber instalado yarn: `npm install -g yarn` 3. Instalar dependencias: `yarn install` 4. Cree una cuenta de prueba NEAR [https://wallet.testnet.near.org/] 5. Instale NEAR CLI globalmente: [near-cli] es una interfaz de línea de comandos (CLI) para interactuar con NEAR blockchain yarn install --global near-cli Step 2: Configuración de NEAR CLI ------------------------------- Configure su near-cli para autorizar su cuenta de prueba creada recientemente: near login Paso 3: Cree y realice una implementación de desarrollo de contrato inteligente -------------------------------- Cree el código del contrato inteligente de NEARLancers e implemente el servidor de desarrollo local: `yarn buil` (consulte` package.json` para obtener una lista completa de `scripts` que puede ejecutar con` yarn`). Este script le devuelve un contrato inteligente provisional implementado (guárdelo para usarlo más tarde). Para desplegar el contrato generado con `yarn buil` en testnet [https://wallet.testnet.near.org/], ejecutar el comando `yarn deploy` el cual nos regresará el id del contrato desplegado el cuál usaremos para ejecutar cada uno de los métodos que contiene el contrato. 📑 Explorando los métodos de contrato inteligente NEARLancers ================== Los siguientes comandos le permiten interactuar con los métodos del contrato inteligente utilizando NEAR CLI (para esto, debe tener implementado un contrato inteligente provisional). Comando para crear usuario: -------------------------------------------- near call $CONTRACT registrarUsuario '{ "idCuenta":"string", "nombre":"string", "telefono":"string", "correo":"string", "password":"string"}' --account-id <your test account> Comando para consultar todos los usuarios: -------------------------------------------- near view $CONTRACT consultarUsuarios Comando para consultar un usuario por id: -------------------------------------------- near view $CONTRACT consultarUsuario '{"idCuenta":"cuenta.testnet"}' Comando para guardar un servicio: -------------------------------------------- near call $CONTRACT registrarServicio '{ "nombre":"string", "descripción":"string", "costo":"u64", "idUsuario":"string"}' --account-id <your test account> Comando para consultar todos los servicios: -------------------------------------------- near view $CONTRACT consultarServicios Comando para consultar todos los servicios de un usuario: -------------------------------------------- near view $CONTRACT consultarServiciosUsuario '{"idUsuario":"string"}' Comando para consultar un servicio por su id: -------------------------------------------- near view $CONTRACT consultarServicio '{"idServicio":"string"}' Comando para agregar un comentario a un servicio: -------------------------------------------- near call $CONTRACT agregarComentario '{"idServicio":"u64", "idUsuario":"string", "comentario":"string"}' --account-id <your test account> Comando para consultar todos los comentarios de un servicio: -------------------------------------------- near view $CONTRACT consultarComentarios '{"idServicio":"u64"}' Comando para agregar una valoracion a un servicio: -------------------------------------------- near call $CONTRACT agregarValoracion '{"idServicio":"u64", "idUsuario":"string", "valoracion":"u64"}' --account-id <your test account> Comando para consultar todas las valoraciones de un servicio: -------------------------------------------- near view $CONTRACT consultarValoracion '{"idServicio":"u64"}' 🤖 Pruebas -------------------------------- Utilice el siguiente comando para ejecutar las pruebas: yarn test 🖥️ Interfáz gráfica de usuario -------------------------------- https://www.figma.com/team_invite/redeem/Yzf4HvEJIRSqPXOGI2aUDZ

gmihov001_Popskl-wNearLogin

.expo-shared assets.json .vscode settings.json App.js GenerateQR.js Main.js ReadQR.js SignIn.js app.json asconfig.json assembly __tests__ as-pect.d.ts main.spec.ts as_types.d.ts index.ts tsconfig.json babel.config.js config.js initContract.js package.json tsconfig.json

ottpeter_FonoRoot

.gitpod.yml README.md babel.config.js backend app.js package-lock.json package.json routes index.html upload.js utils ipfs.js uploadHandler.js contract Cargo.toml README.md compile.js src approval.rs buy.rs crust.rs enumeration.rs events.rs guestbook.rs internal.rs lib.rs metadata.rs mint.rs nft_core.rs royalty.rs tests.rs transfer.rs withdraw.rs target debug .fingerprint Inflector-7f11766183d673c9 lib-inflector.json autocfg-4868950ed995ae79 lib-autocfg.json borsh-derive-755aed635907bc37 lib-borsh-derive.json borsh-derive-f2cb8e4586f80996 lib-borsh-derive.json borsh-derive-internal-ae73587343fb7c1c lib-borsh-derive-internal.json borsh-schema-derive-internal-8bb7383474528abd lib-borsh-schema-derive-internal.json byteorder-37492c730dc0a1d9 run-build-script-build-script-build.json byteorder-f763f4493883f6dc build-script-build-script-build.json convert_case-83c6bc93ff1e7612 lib-convert_case.json derive_more-b9d518d57adc2924 lib-derive_more.json generic-array-4facbe9337b8efd8 run-build-script-build-script-build.json generic-array-77ed6d442240e5fd build-script-build-script-build.json hashbrown-0d9a7ae03e07277f run-build-script-build-script-build.json hashbrown-47a81bb761c7bceb build-script-build-script-build.json hashbrown-dc1bb8b0226524d5 lib-hashbrown.json indexmap-1481ac16426ea685 lib-indexmap.json indexmap-e4636fb8ede6bb7f build-script-build-script-build.json indexmap-e770da50b9f4668d run-build-script-build-script-build.json itoa-b9c9923249b96f05 lib-itoa.json libc-990e32dbfe044015 build-script-build-script-build.json libc-e8c87c12b9827a12 run-build-script-build-script-build.json memchr-d0151323308c62e3 build-script-build-script-build.json memchr-e3616a8e96b851af run-build-script-build-script-build.json near-rpc-error-core-9012d1e877742002 lib-near-rpc-error-core.json near-rpc-error-macro-6d9e50eac7f60f94 lib-near-rpc-error-macro.json near-sdk-macros-58f8a44c5dd16737 lib-near-sdk-macros.json num-bigint-5e3752ee05bb4b74 build-script-build-script-build.json num-bigint-9a3ccb37e352275a run-build-script-build-script-build.json num-integer-50dfc40640e3a0a1 build-script-build-script-build.json num-integer-8729ed8db497f61f run-build-script-build-script-build.json num-rational-235f12f11660d64f run-build-script-build-script-build.json num-rational-e75dfc547d9285f4 build-script-build-script-build.json num-traits-2675922ffd091538 build-script-build-script-build.json num-traits-ed897d8db50728c0 run-build-script-build-script-build.json proc-macro-crate-5ff025178bb1dcbc lib-proc-macro-crate.json proc-macro-crate-8305b02575cf5a25 lib-proc-macro-crate.json proc-macro2-7f21221b51fe4fcc build-script-build-script-build.json proc-macro2-cd19530e7b414953 run-build-script-build-script-build.json proc-macro2-daee687dbd4d3435 lib-proc-macro2.json quote-7c769b2ca1be15ad lib-quote.json ryu-285d29b8d1ba7b08 run-build-script-build-script-build.json ryu-74cd4ef70b4eb3e4 build-script-build-script-build.json ryu-d32d5304187421fd lib-ryu.json serde-2c0667bbdef82b99 run-build-script-build-script-build.json serde-4104ed868f1fc77d build-script-build-script-build.json serde-9ca644c0957e3bfa build-script-build-script-build.json serde-a261d06769b94a06 lib-serde.json serde-c199887d23806051 lib-serde.json serde-d59cec748c58c49b run-build-script-build-script-build.json serde_derive-131d0377946b95a9 run-build-script-build-script-build.json serde_derive-c4a6f5bffd700064 lib-serde_derive.json serde_derive-f94066e1ce411d05 build-script-build-script-build.json serde_json-8185363bdf840d0d build-script-build-script-build.json serde_json-83618ac928a735f4 run-build-script-build-script-build.json serde_json-e5a82784fbddcda8 build-script-build-script-build.json serde_json-fb9ba8085d53e23b lib-serde_json.json syn-3b3985fa485a9aff run-build-script-build-script-build.json syn-7a49b47aa91093fe lib-syn.json syn-98d32306676519be build-script-build-script-build.json toml-67bdb142f471c86a lib-toml.json toml-ca550489162fea88 lib-toml.json typenum-a1dbb12abbdd33a1 build-script-build-script-main.json typenum-a5652ec6ecb993a5 run-build-script-build-script-main.json unicode-xid-236d3ec23eae9de0 lib-unicode-xid.json version_check-8bdd99506f0720fc lib-version_check.json wee_alloc-686e101bbb6ee05d run-build-script-build-script-build.json wee_alloc-fc45ef44b5e07840 build-script-build-script-build.json build num-bigint-9a3ccb37e352275a out radix_bases.rs typenum-a5652ec6ecb993a5 out consts.rs op.rs tests.rs wee_alloc-686e101bbb6ee05d out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint Inflector-588817c319db2a1d lib-inflector.json autocfg-61826db88f3632f6 lib-autocfg.json borsh-derive-a997037a2f67f40e lib-borsh-derive.json borsh-derive-bf193b42725c407f lib-borsh-derive.json borsh-derive-internal-8664a3af582deb02 lib-borsh-derive-internal.json borsh-schema-derive-internal-05e0cf007bc3d77e lib-borsh-schema-derive-internal.json byteorder-ee2da3d02b0661a6 build-script-build-script-build.json convert_case-720248a5c9b2e881 lib-convert_case.json derive_more-39a84aaeaf4e02c6 lib-derive_more.json generic-array-c19cd737b3e144bd build-script-build-script-build.json hashbrown-27ee970e02f50d66 run-build-script-build-script-build.json hashbrown-e225c71977330bca build-script-build-script-build.json hashbrown-ebdb889675958763 lib-hashbrown.json indexmap-7ae27f9bbda4f6d8 build-script-build-script-build.json indexmap-bb5902379f5a46c3 run-build-script-build-script-build.json indexmap-dbd4756e055be715 lib-indexmap.json itoa-4a5c0027cec6a144 lib-itoa.json memchr-0e22e013504f3831 build-script-build-script-build.json near-rpc-error-core-7f8d267c45527ee7 lib-near-rpc-error-core.json near-rpc-error-macro-587072dab75eeb98 lib-near-rpc-error-macro.json near-sdk-core-03f3f7de02dcef5a lib-near-sdk-core.json near-sdk-macros-3f6c47e710f48385 lib-near-sdk-macros.json near-sdk-macros-b464e6b1387f1c1e lib-near-sdk-macros.json num-bigint-94fedadb2d00ba57 build-script-build-script-build.json num-integer-e6086320aaf56232 build-script-build-script-build.json num-rational-59b729ad8a30bf4a build-script-build-script-build.json num-traits-2d5759e95c85d7bf build-script-build-script-build.json proc-macro-crate-430bcd9e5fd7f128 lib-proc-macro-crate.json proc-macro-crate-b7eaf13608e96966 lib-proc-macro-crate.json proc-macro2-1d7846d4de90c94b lib-proc-macro2.json proc-macro2-430b1731c69f15da run-build-script-build-script-build.json proc-macro2-f8d9d074d9046153 build-script-build-script-build.json quote-369f4ba3bafc3b09 lib-quote.json ryu-3c8dee93f9648fd6 run-build-script-build-script-build.json ryu-85ec51b9ef05c602 lib-ryu.json ryu-a41f78afa35d7962 build-script-build-script-build.json serde-0c0882a63508c844 build-script-build-script-build.json serde-2e4b34b817179aa9 lib-serde.json serde-317e5bb3deb92d91 lib-serde.json serde-3df8aca05367462e build-script-build-script-build.json serde-4d003cb35a5bbffb run-build-script-build-script-build.json serde-d3575cc3d25cdf56 run-build-script-build-script-build.json serde_derive-6a6a0f30b11d3955 lib-serde_derive.json serde_derive-f2c0ea9828c0b70a build-script-build-script-build.json serde_derive-f7ce52819536990f run-build-script-build-script-build.json serde_json-0c13604bb789d470 lib-serde_json.json serde_json-0da1350541265233 run-build-script-build-script-build.json serde_json-87391e21346ac66e build-script-build-script-build.json serde_json-fb1bab8726bcbe41 build-script-build-script-build.json syn-25ff66f57bc2743f run-build-script-build-script-build.json syn-3b29c666a2194a0a build-script-build-script-build.json syn-5b79dd92db5135f9 lib-syn.json toml-30fcee6fccd82b2e lib-toml.json toml-5d0354c6626f45ff lib-toml.json typenum-1cd579a1cad4d8b2 build-script-build-script-main.json unicode-xid-0f08e5476f90a38f lib-unicode-xid.json version_check-091ba2a2a66b35fb lib-version_check.json wee_alloc-06e9471ba5baa60b build-script-build-script-build.json wasm32-unknown-unknown debug .fingerprint ahash-89131c87ecc1666f lib-ahash.json aho-corasick-a48c1371e9bc7ecf lib-aho_corasick.json base64-d414381c9968826c lib-base64.json block-buffer-6e47356bdb5bb073 lib-block-buffer.json block-buffer-8cfecbd92ea60b58 lib-block-buffer.json block-padding-de37df25d7b34d92 lib-block-padding.json borsh-04908e705fca4190 lib-borsh.json borsh-6f7af8f611cb98f8 lib-borsh.json bs58-ac0c46b0df1ae71d lib-bs58.json byte-tools-238d553a6bc3e224 lib-byte-tools.json byteorder-34439d78322f6a1e lib-byteorder.json byteorder-b3df131454c3620e run-build-script-build-script-build.json cfg-if-51d7c24562d8036c lib-cfg-if.json cfg-if-dff5b60a5d0a6e11 lib-cfg-if.json digest-8f129aff61adb070 lib-digest.json digest-d218595199ac3287 lib-digest.json fono_root-ef944e53d9f48541 lib-fono_root.json generic-array-173e25c9c8d1d3ff lib-generic_array.json generic-array-70cd198b7bb1b08b run-build-script-build-script-build.json generic-array-78cc2404eaa3172f lib-generic_array.json greeter-98ace302c5fafa12 lib-greeter.json hashbrown-0dfc383e1fbd030e lib-hashbrown.json hashbrown-c5c5dc903e3995b5 lib-hashbrown.json hashbrown-f8229dd88be984c1 run-build-script-build-script-build.json hex-27dd5cabdb076e2a lib-hex.json indexmap-3fccbe3ae14dd53a run-build-script-build-script-build.json indexmap-a8f2420a6406bbf3 lib-indexmap.json itoa-7c01163e41fe654c lib-itoa.json keccak-45aa0dfbc7c6cb16 lib-keccak.json lazy_static-549b954d42eff8d3 lib-lazy_static.json memchr-c33208f2ce411331 run-build-script-build-script-build.json memchr-c4d872591e588496 lib-memchr.json memory_units-9fd76585833ffc54 lib-memory_units.json near-contract-standards-0a360105cb27cb0c lib-near-contract-standards.json near-primitives-core-57141f0db131e6d5 lib-near-primitives-core.json near-runtime-utils-617c1ca2f5c7ebeb lib-near-runtime-utils.json near-sdk-2c39606e5cd7f130 lib-near-sdk.json near-sdk-2e140ee67b63c5f4 lib-near-sdk.json near-sys-46561e33e10920e1 lib-near-sys.json near-vm-errors-0c83654c4f53098e lib-near-vm-errors.json near-vm-logic-0854c2202a03cb30 lib-near-vm-logic.json nft_simple-322841616f66c026 lib-nft_simple.json num-bigint-1dc534ab71c22d05 lib-num-bigint.json num-bigint-516294c106242ac2 run-build-script-build-script-build.json num-integer-0a5767623de35cdd run-build-script-build-script-build.json num-integer-f08ec93c23fffcfd lib-num-integer.json num-rational-a2f0fc5372723001 run-build-script-build-script-build.json num-rational-b2a03734ff8dc4d2 lib-num-rational.json num-traits-2658f0d537e65b0d run-build-script-build-script-build.json num-traits-ae26014c636cac04 lib-num-traits.json opaque-debug-874128522f797d23 lib-opaque-debug.json opaque-debug-d907dce79870026d lib-opaque-debug.json regex-6892f1c711caeaca lib-regex.json regex-syntax-c37be88a36d27b5c lib-regex-syntax.json ryu-deafa2dbe380e809 lib-ryu.json ryu-ff8d57a0d80431e7 run-build-script-build-script-build.json serde-89e56e6f5bd71f1a run-build-script-build-script-build.json serde-f8b33348871ef9c1 lib-serde.json serde_json-23b688e74a9df521 run-build-script-build-script-build.json serde_json-35793784d3624f4d run-build-script-build-script-build.json serde_json-98d453d599c060ee lib-serde_json.json serde_json-ce866958aa01f11c lib-serde_json.json sha2-53d105fd0aabc868 lib-sha2.json sha3-d849f3cdf41f3aa3 lib-sha3.json typenum-4cbb8733d11e73bb run-build-script-build-script-main.json typenum-ad84c210c5b2737c lib-typenum.json wee_alloc-310588e8e9326adc run-build-script-build-script-build.json wee_alloc-3922182d88fc62e5 lib-wee_alloc.json build num-bigint-516294c106242ac2 out radix_bases.rs typenum-4cbb8733d11e73bb out consts.rs op.rs tests.rs wee_alloc-310588e8e9326adc out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint ahash-9676ca1636e38649 lib-ahash.json aho-corasick-fe889d939c192e46 lib-aho_corasick.json base64-f5bedd030624a797 lib-base64.json block-buffer-0c1802f48da2c365 lib-block-buffer.json block-buffer-2023242e67116f3f lib-block-buffer.json block-padding-e9ff840688d7e4df lib-block-padding.json borsh-00d78954c00f25a8 lib-borsh.json borsh-2241dc2b89efba83 lib-borsh.json bs58-1f524a1451dc57fd lib-bs58.json byte-tools-7fb8d7d4616972ce lib-byte-tools.json byteorder-b93454a68c5391d5 run-build-script-build-script-build.json byteorder-e030c821bfae7fb8 lib-byteorder.json cfg-if-0b562e2518fa250f lib-cfg-if.json cfg-if-69d480b82ec95d13 lib-cfg-if.json digest-140389394a6f10d6 lib-digest.json digest-75ad28e8c3072a6a lib-digest.json generic-array-78d31f943e6c8951 lib-generic_array.json generic-array-7e2f1ff87aef6091 lib-generic_array.json generic-array-dd38051dfea5a9af run-build-script-build-script-build.json hashbrown-19bba3ec0fe307ff run-build-script-build-script-build.json hashbrown-2e8c581a0ff3cf9f lib-hashbrown.json hashbrown-b197d68b125adf66 lib-hashbrown.json hex-b927e2586309a048 lib-hex.json indexmap-9bfe77cfd3434b55 run-build-script-build-script-build.json indexmap-d22cdef8b0b9f097 lib-indexmap.json itoa-21d954639a94b41c lib-itoa.json keccak-b4cbb2aea186c453 lib-keccak.json lazy_static-cbefe401bb7758b0 lib-lazy_static.json memchr-16f5f8123b6ceae0 run-build-script-build-script-build.json memchr-ec738bd085f5ebab lib-memchr.json memory_units-1573ec26c5323d3b lib-memory_units.json near-contract-standards-e15aeb7cbfa0bc9d lib-near-contract-standards.json near-primitives-core-b6f2471e2cf60f2c lib-near-primitives-core.json near-runtime-utils-5e13bd4ab3c64bc2 lib-near-runtime-utils.json near-sdk-47bdd0bb35f96d44 lib-near-sdk.json near-sdk-bde5ccb36b1b3b24 lib-near-sdk.json near-sys-b3afa7dfe20f8c6f lib-near-sys.json near-vm-errors-2ba850f67aed7ad4 lib-near-vm-errors.json near-vm-logic-34ca3546742104ba lib-near-vm-logic.json nft_simple-322841616f66c026 lib-nft_simple.json num-bigint-aa040e80b14e8e2c run-build-script-build-script-build.json num-bigint-f8b33ae287d19bb7 lib-num-bigint.json num-integer-ca17b90c6c266515 lib-num-integer.json num-integer-e61c820b8def45ee run-build-script-build-script-build.json num-rational-55251464385f90c7 lib-num-rational.json num-rational-6dad994ef5c215a0 run-build-script-build-script-build.json num-traits-2f3a9cb0d65885f8 run-build-script-build-script-build.json num-traits-af275448576eb438 lib-num-traits.json opaque-debug-930f7905f0b6468a lib-opaque-debug.json opaque-debug-9529297a89d9a514 lib-opaque-debug.json regex-569f5303d1fc0a8c lib-regex.json regex-syntax-afd90b94d699a675 lib-regex-syntax.json ryu-8e8a07b08c4a706b lib-ryu.json ryu-b1b48567ede7bfff run-build-script-build-script-build.json serde-a57fd566a9723445 lib-serde.json serde-ef94ed53722488b6 run-build-script-build-script-build.json serde_json-1d75ca0c6652c27e run-build-script-build-script-build.json serde_json-3d31d291371594dc run-build-script-build-script-build.json serde_json-627fed1d2019c251 lib-serde_json.json serde_json-ba3e86ce10b32203 lib-serde_json.json sha2-8a9ff41dc6b7a45a lib-sha2.json sha3-225a8cd907205926 lib-sha3.json typenum-88130a0d9e348dc4 run-build-script-build-script-main.json typenum-b3ddf5bbc493609f lib-typenum.json wee_alloc-208b86f032cb9fbf run-build-script-build-script-build.json wee_alloc-b82b84ed0129c3d4 lib-wee_alloc.json build num-bigint-aa040e80b14e8e2c out radix_bases.rs typenum-88130a0d9e348dc4 out consts.rs op.rs tests.rs wee_alloc-208b86f032cb9fbf out wee_alloc_static_array_backend_size_bytes.txt package.json src Activity Err.js Message.js Notifications.js Ok.js Pending.js Admin Admin.js ConnectWallet.js Footer.js Loading.js Logo.js MediaDropzone.js PreviewBox.js SmallUploader.js TopMenu.js Wallet.js Withdraw.js App.js Common AudioPlayer.js Price.js FrameElements Discord.js GitHub.js Help.js Insta.js Logo.js Settings.js Telegram.js Twitter.js Main Footer.js GuestBook.js Main.js MyNFTs.js TokenModal.js TopMenu.js TransferModal.js Wallet.js __mocks__ fileMock.js assets Question-circle.svg Settings.svg Telegram.svg Twitter.svg Upload.svg Uploader.svg bell_with_dot.svg buy.svg buyHover.svg chasing_arrows.svg close.svg connect_frame.svg countries.json disconnect.svg disconnect_hover.svg discord.svg github.svg info.svg insta.svg logo-black.svg logo-white.svg near.svg config.js global.css index.html index.js jest.init.js main.test.js projectConfig.json utils.js wallet login index.html

fono-root Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html # FonoRoot Audio NFT with a tree-like minting process __Live version:__ [rarevandal.com](http://rarevandal.com) ## Description The admin user can create new root NFTs on the admin page. The admin page can be reached by appending `?admin` to the url. The front-end is coming from the IPFS network, so the URL will contain the CID. [rarevandal.com](http://rarevandal.com) will redirect to an ipfs gateway (ipfs.io). Normal routing would cause problems, that's why we are using url params instead. These are the possible routes: * ?admin: The person who is set as `admin` in the smart contract can create new root NFTs here * ?my-nfts: List of NFTs the user owns. Possible to transfer NFT, but we are not verifying yet if the account name is a valid and existing account * ?init: Here is a button that will initialize the contract. It will set `admin` according to `projectConfig.json` * ?withdraw: It is possible to withdraw funds from the contract (Vault), only admin can call the function. In the future we will have a royalty system and withdrawal will be redesigned as well The IDs of the NFTs will be of format `fono-root-X-Y`, where `X` is root nonce and `Y` is child nonce. For root NFTs, there is no Y number. For example, `fono-root-0` or `fono-root-2`. When a root NFT is created, the root NFT will be transfered to admin, and 2 children will be created, they will be owned by the contract (Vault). When an NFT is bought from the Vault, 2 new children will be created. The user has to buy the NFT that is higher in the tree, only that one will be presented to the user. These NFTs, that can be bought, will have an ID like `fono-root-0-0`, `fono-root-0-5` (these would all be the same music and picture, root is `fono-root-0`. `projectConfig.json` has fields: * `contractName`: name of the contract instance the site should use. `.env` wouldn't work in our situation, because we don't have a backend server * `admin`: used at initialization If site cloning would work, it would change the `projectConfig.json` for the new site. The IPFS part of this works, but we haven't been able to create a new contract instance from front-end. ## Prerequisites NodeJS version should be `v16.13.2` ## Start locally `npm run dev` ## Deploying to IPFS 1. After running `npm run dev`, copy `CONTRACT_NAME` from `neardev/dev-account.env` to `src/projectConfig.json` under `contractName`. The `admin` field should be a NEAR account id, that account will be able to create new root NFTs. 2. Run `npm run build`. 3. The dist folder can be added to IPFS. If we are running an IPFS node, we can run `ipfs add -r dist/`, or we can upload the dist folder to Pinata. 4. Open `https://ipfs.io/ipfs/<CID>?init` (For example, [https://ipfs.io/ipfs/Qmc693kKZx6YnEFwL7zzqbrJ8TKvFg7h8t3hRa1RR5oHam/?init](https://ipfs.io/ipfs/Qmc693kKZx6YnEFwL7zzqbrJ8TKvFg7h8t3hRa1RR5oHam/?init) 5. Click on `INIT` Now admin will be able to set a Crust key and start uploading new content. __Designer__: Lena ([website](https://www.lenamarakova.com/), [LinkedIn](https://www.linkedin.com/in/elenamarakova/)) __Idea and Project Owner__: Vandal ([website](https://linktr.ee/vandigital), [Twitter](https://twitter.com/vandigital), [LinkedIn](https://www.linkedin.com/in/vandigital/))

M-Rb3_store-deploy

.devcontainer devcontainer.json .eslintrc.json README.md next.config.js package.json public browserconfig.xml next.svg vercel.svg src assets images near_social_combo.svg near_social_icon.svg vs_code_icon.svg components lib Spinner index.ts Toast README.md api.ts index.ts store.ts styles.ts navigation icons close.svg near-icon.svg near-logo.svg return.svg search.svg navigation-categories.ts data bos-components.ts links.ts web3.ts hooks useBosComponents.ts useBosLoaderInitializer.ts useClearCurrentComponent.ts useFlags.ts useHashUrlBackwardsCompatibility.ts useSignInRedirect.ts index.d.ts lib selector setup.js wallet.js stores auth.ts bos-loader.ts current-component.ts vm.ts styles globals.css theme.css utils auth.js config.ts firebase.ts form-validation.ts keypom-options.ts navigation.ts notifications.ts notificationsHelpers.ts notificationsLocalStorage.ts types.ts zendesk.ts tsconfig.json

# Toast Implemented via Radix primitives: https://www.radix-ui.com/docs/primitives/components/toast _If the current props and Stitches style overrides aren't enough to cover your use case, feel free to implement your own component using the Radix primitives directly._ ## Example Using the `openToast` API allows you to easily open a toast from any context: ```tsx import { openToast } from '@/components/lib/Toast'; ... <Button onClick={() => openToast({ type: 'ERROR', title: 'Toast Title', description: 'This is a great toast description.', }) } > Open a Toast </Button> ``` You can pass other options too: ```tsx <Button onClick={() => openToast({ type: 'SUCCESS', // SUCCESS | INFO | ERROR title: 'Toast Title', description: 'This is a great toast description.', icon: 'ph-bold ph-pizza', // https://phosphoricons.com/ duration: 20000, // milliseconds (pass Infinity to disable auto close) }) } > Open a Toast </Button> ``` ## Deduplicate If you need to ensure only a single instance of a toast is ever displayed at once, you can deduplicate by passing a unique `id` key. If a toast with the passed `id` is currently open, a new toast will not be opened: ```tsx <Button onClick={() => openToast({ id: 'my-unique-toast', title: 'Toast Title', description: 'This is a great toast description.', }) } > Deduplicated Toast </Button> ``` ## Custom Toast If you need something more custom, you can render a custom toast using `lib/Toast/Toaster.tsx` as an example like so: ```tsx import * as Toast from '@/components/lib/Toast'; ... <Toast.Provider duration={5000}> <Toast.Root open={isOpen} onOpenChange={setIsOpen}> <Toast.Title>My Title</Toast.Title> <Toast.Description>My Description</Toast.Description> <Toast.CloseButton /> </Toast.Root> <Toast.Viewport /> </Toast.Provider> ``` Easily deploy a Store of your Mintbase ContractId - updates when you add information from any gateway [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FM-Rb3%2Fstore-deploy&build-command=pnpm%20run%20build&env=NEXT_PUBLIC_NETWORK_ID,NEXT_PUBLIC_HOSTNAME,NEXT_PUBLIC_CONTRACT_ID&envDescription=mainnet-near.org-themecanbeanything&envLink=https%3A%2F%2Fgithub.com%2FM-Rb3%2Fstore-deploy%2Fblob%2Fmain%2F.env.example) Demo https://www.youtube.com/watch?v=4uXFo5nZry0 To setup a custom domain on vercel https://vercel.com/docs/concepts/projects/domains/add-a-domain ## Widget Props | Props | Type | Default | Description | | ----------------- | :-----: | :------------------------: | :---------------------------------------------------: | | accountId | string | wallet signed in accountId | - | | store | string | "" | Mintbase Contract Id | | customStyle | string | "" | - | | description | string | "" | Store's custom description | | showHeader | boolean | true | Show contractId as title | | header | string | contractId | Store's custom title | | perPage | int | 48 | Number of NFTs displayed on each page | | AFFILIATE_ACCOUNT | string | baam25.near | https://docs.mintbase.xyz/market/selling-as-affiliate | ## Setup & Development Initialize repo: ```bash pnpm i ``` Start development version: ```bash cp .env.example .env pnpm dev ``` ``` // .env NEXT_PUBLIC_NETWORK_ID=mainnet NEXT_PUBLIC_HOSTNAME=https://near.org NEXT_PUBLIC_CONTRACT_ID={{cotractId}} // EX: mint.yearofchef.near NEXT_PUBLIC_THEME=default ``` The entry component is `Mintbase Store Template` and it's located at `/src/components/store/index.tsx` It loads the `baam25.near/widget/store` & `baam25.near/widget/store` BOS components. - https://near.org/near/widget/ComponentDetailsPage?src=baam25.near/widget/storeActivities - https://near.org/near/widget/ComponentDetailsPage?src=baam25.near/widget/store EX: https://near.social/baam25.near/widget/store?store=spin-nft-contract.near  EX: https://near.social/baam25.near/widget/storeActivities?contractId=spin-nft-contract.near  ## Deployment This is a [Next.js](https://github.com/vercel/next.js/) app and a fork of [NEAR Discovery](https://github.com/near/near-discovery) gateway app. For static exports just run `next build` and upload the build files to your hosting provider. More info [here](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports). For Vercel, Cloudflare or others that supports a Next app just connect the repo and follow the deploy steps from the dashboards. More info on Next.js deployments [here](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports). ## Running with docker ```bash docker build -t store-deploy . docker run -p 3000:3000 store-deploy ```

near_binaryen

.github ISSUE_TEMPLATE BOUNTY.yml workflows ci.yml release-artifacts.yml CHANGELOG.md CMakeLists.txt Contributing.md README.md auto_update_tests.py check.py requirements-dev.txt scripts __init__.py clang-format-diff.sh clang-tidy-diff.sh embedwat.py emcc-tests.sh foreach.py fuzz_opt.py fuzz_passes.py fuzz_passes_wast.py fuzz_relooper.py fuzz_shell.js gen-s-parser.py not.py port_passes_tests_to_lit.py storage.py strip_local_names.py test __init__.py binaryenjs.py env.js generate_lld_tests.py lld.py mod.ule.js shared.py spectest.js support.py wasm2js.py wasm_opt.py update_lit_checks.py validation_shell.js wasm2js.js src abi js.h asm_v_wasm.h asmjs CMakeLists.txt asm_v_wasm.cpp asmangle.cpp asmangle.h shared-constants.cpp shared-constants.h binaryen-c.cpp binaryen-c.h cfg CMakeLists.txt Relooper.cpp Relooper.h cfg-traversal.h domtree.h liveness-traversal.h compiler-support.h dataflow graph.h node.h users.h utils.h emscripten-optimizer CMakeLists.txt istring.h optimizer-shared.cpp optimizer.h parser.cpp parser.h simple_ast.cpp simple_ast.h snprintf.h ir CMakeLists.txt ExpressionAnalyzer.cpp ExpressionManipulator.cpp LocalGraph.cpp ReFinalize.cpp abstract.h bits.h block-utils.h branch-utils.h cost.h debug.h effects.h eh-utils.cpp eh-utils.h element-utils.h equivalent_sets.h features.h find_all.h flat.h function-utils.h gc-type-utils.h global-utils.h hashed.h import-utils.h intrinsics.cpp intrinsics.h iteration.h label-utils.h linear-execution.h literal-utils.h load-utils.h local-graph.h local-utils.h localize.h lubs.cpp lubs.h manipulation.h match.h memory-utils.h module-splitting.cpp module-splitting.h module-utils.h names.cpp names.h numbering.h ordering.h parents.h properties.cpp properties.h stack-utils.cpp stack-utils.h struct-utils.h subtypes.h table-utils.cpp table-utils.h trapping.h type-updating.cpp type-updating.h utils.h js binaryen.js-extern-pre.js binaryen.js-post.js literal.h mixed_arena.h parsing.h pass.h passes AlignmentLowering.cpp Asyncify.cpp AvoidReinterprets.cpp CMakeLists.txt CoalesceLocals.cpp CodeFolding.cpp CodePushing.cpp ConstHoisting.cpp ConstantFieldPropagation.cpp DWARF.cpp DataFlowOpts.cpp DeAlign.cpp DeNaN.cpp DeadArgumentElimination.cpp DeadCodeElimination.cpp Directize.cpp DuplicateFunctionElimination.cpp DuplicateImportElimination.cpp ExtractFunction.cpp Flatten.cpp FuncCastEmulation.cpp GenerateDynCalls.cpp GlobalRefining.cpp GlobalTypeOptimization.cpp Heap2Local.cpp I64ToI32Lowering.cpp Inlining.cpp InstrumentLocals.cpp InstrumentMemory.cpp Intrinsics.cpp LegalizeJSInterface.cpp LimitSegments.cpp LocalCSE.cpp LocalSubtyping.cpp LogExecution.cpp LoopInvariantCodeMotion.cpp Memory64Lowering.cpp MemoryPacking.cpp MergeBlocks.cpp MergeLocals.cpp Metrics.cpp MinifyImportsAndExports.cpp NameList.cpp NameTypes.cpp NoExitRuntime.cpp OnceReduction.cpp OptimizeAddedConstants.cpp OptimizeForJS.cpp OptimizeInstructions.cpp PickLoadSigns.cpp Poppify.cpp PostEmscripten.cpp Precompute.cpp Print.cpp PrintCallGraph.cpp PrintFeatures.cpp PrintFunctionMap.cpp ReReloop.cpp RedundantSetElimination.cpp RemoveImports.cpp RemoveMemory.cpp RemoveNonJSOps.cpp RemoveUnusedBrs.cpp RemoveUnusedModuleElements.cpp RemoveUnusedNames.cpp ReorderFunctions.cpp ReorderLocals.cpp RoundTrip.cpp SSAify.cpp SafeHeap.cpp SetGlobals.cpp SignatureRefining.cpp SimplifyGlobals.cpp SimplifyLocals.cpp Souperify.cpp StackCheck.cpp StackIR.cpp Strip.cpp StripTargetFeatures.cpp TrapMode.cpp TypeRefining.cpp Untee.cpp Vacuum.cpp intrinsics-module.h opt-utils.h pass.cpp passes.h test_passes.cpp pretty_printing.h shared-constants.h shell-interface.h support CMakeLists.txt alloc.h archive.cpp archive.h base64.h bits.cpp bits.h colors.cpp colors.h command-line.cpp command-line.h debug.cpp debug.h file.cpp file.h hash.h insert_ordered.h json.h learning.h name.h path.cpp path.h permutations.h safe_integer.cpp safe_integer.h small_set.h small_vector.h sorted_vector.h space.h string.h threads.cpp threads.h timing.h unique_deferring_queue.h utilities.cpp utilities.h templates normal.js wasm.js tools CMakeLists.txt execution-results.h fuzzing.h fuzzing fuzzing.cpp heap-types.cpp heap-types.h parameters.h random.cpp random.h js-wrapper.h optimization-options.h spec-wrapper.h tool-options.h tool-utils.h wasm-as.cpp wasm-ctor-eval.cpp wasm-dis.cpp wasm-emscripten-finalize.cpp wasm-fuzz-types.cpp wasm-metadce.cpp wasm-opt.cpp wasm-reduce.cpp wasm-shell.cpp wasm-split CMakeLists.txt instrumenter.cpp instrumenter.h split-options.cpp split-options.h wasm-split.cpp wasm2c-wrapper.h wasm2js.cpp wasm-binary.h wasm-builder.h wasm-debug.h wasm-emscripten.h wasm-features.h wasm-interpreter.h wasm-io.h wasm-module-building.h wasm-s-parser.h wasm-stack.h wasm-traversal.h wasm-type.h wasm-validator.h wasm.h wasm CMakeLists.txt literal.cpp parsing.cpp wasm-binary.cpp wasm-debug.cpp wasm-emscripten.cpp wasm-interpreter.cpp wasm-io.cpp wasm-s-parser.cpp wasm-stack.cpp wasm-type.cpp wasm-validator.cpp wasm.cpp wasm2js.h test __init__.py bigswitch.cpp bigswitch.txt binaryen.js atomics.js atomics.js.txt copy-expression.js copy-expression.js.txt custom-section.js custom-section.js.txt debug-info.js debug-info.js.txt debug-names.js debug-names.js.txt emit_asmjs.js emit_asmjs.js.txt exception-handling.js exception-handling.js.txt expressionrunner.js expressionrunner.js.txt expressions.js expressions.js.txt fast-math.js fast-math.js.txt functions.js functions.js.txt global.js global.js.txt hello-world.js hello-world.js.txt inlining-options.js inlining-options.js.txt kitchen-sink.js kitchen-sink.js.txt low-memory-unused.js low-memory-unused.js.txt optimize-levels.js optimize-levels.js.txt pass-arguments.js pass-arguments.js.txt reloc.js reloc.js.txt sideffects.js sideffects.js.txt sieve.js sieve.js.txt simd.js simd.js.txt sourcemap.js sourcemap.js.txt stackir.js stackir.js.txt tag.js tag.js.txt tail_calls.js tail_calls.js.txt validation_errors.js validation_errors.js.txt zero-filled-memory.js zero-filled-memory.js.txt calls.cpp calls.post.js calls.txt control_flow.cpp control_flow.post.js control_flow.txt example c-api-hello-world.c c-api-hello-world.txt c-api-kitchen-sink.c c-api-kitchen-sink.txt c-api-multiple-tables.c c-api-multiple-tables.txt c-api-relooper-unreachable-if.cpp c-api-relooper-unreachable-if.txt c-api-unused-mem.cpp c-api-unused-mem.txt cpp-threads.cpp cpp-threads.txt cpp-unit.cpp cpp-unit.txt domtree.cpp domtree.txt hash.cpp hash.txt local-graph.cpp local-graph.txt match.cpp match.txt module-splitting.cpp module-splitting.txt relooper-fuzz.c relooper-fuzz.txt relooper-fuzz1.c relooper-fuzz1.txt relooper-fuzz2.c relooper-fuzz2.txt relooper-merge1.c relooper-merge1.txt relooper-merge2.c relooper-merge2.txt relooper-merge3.c relooper-merge3.txt relooper-merge4.c relooper-merge4.txt relooper-merge5.c relooper-merge5.txt relooper-merge6.c relooper-merge6.txt relooper-merge7.c relooper-merge7.txt small_set.cpp small_set.txt small_vector.cpp small_vector.txt space.cpp space.txt stack-utils.cpp stack-utils.txt type-builder-nominal-new.cpp type-builder-nominal-new.txt type-builder-nominal.cpp type-builder-nominal.txt type-builder.cpp type-builder.txt typeinfo.cpp typeinfo.txt fannkuch.cpp fannkuch.txt fasta.cpp fasta.txt float_ops.cpp float_ops.post.js float_ops.txt grow_memory.cpp grow_memory.txt hello_libcxx.cpp hello_libcxx.txt hello_world.c hello_world.txt int_ops.c int_ops.post.js int_ops.txt let.txt linker bar.c baz.c foo.c main.c quux.c lit CMakeLists.txt lit.cfg.py wasm-split bar.txt both.txt foo.txt none.txt lld em_asm.cpp em_asm64.cpp em_asm_O0.c em_asm_pthread.cpp em_asm_shared.cpp hello_world.c init.c longjmp.c recursive.c reserved_func_ptr.cpp shared.cpp shared_longjmp.c mem.cpp mem.post.js mem.txt metadce all-outside.wast.graph.txt corners.wast.graph.txt no-outside.wast.graph.txt outside.wast.graph.txt rooted-export.wast.graph.txt spanning_cycle.wast.graph.txt spanning_cycle_unrooted.wast.graph.txt tag.wast.graph.txt threaded.wast.graph.txt threaded_cycle.wast.graph.txt threaded_unrooted.wast.graph.txt threaded_unrooted_cycle.wast.graph.txt multi-table.minified.txt passes O.bin.txt O1_print-stack-ir.txt O2_precompute-propagate_print-stack-ir.txt O2_print-stack-ir.txt O3_low-memory-unused_metrics.txt O3_print-stack-ir.txt Os_print-stack-ir_all-features_disable-gc.txt Oz_fuzz-exec_all-features.txt class_with_dwarf_noprint.bin.txt converge_O3_metrics.bin.txt dce_vacuum_remove-unused-names.bin.txt duplicate-function-elimination_all-features.txt duplicate-function-elimination_optimize-level=1.txt duplicate-function-elimination_optimize-level=2.txt duplicate-import-elimination.txt dwarf-local-order.bin.txt dwarf_unit_with_no_abbrevs_noprint.bin.txt dwarf_with_exceptions.bin.txt dwarf_with_exceptions.cpp dwarfdump.bin.txt dwarfdump_roundtrip_dwarfdump.bin.txt emit-js-wrapper=a.js.txt emit-js-wrapper=a.js.wast.js emit-spec-wrapper=a.wat.txt fannkuch0_dwarf.bin.txt fannkuch3_dwarf.bin.txt fannkuch3_manyopts_dwarf.bin.txt fib2_dwarf.bin.txt fib2_emptylocspan_dwarf.bin.txt fib_nonzero-low-pc_dwarf.bin.txt flatten.bin.txt fpcast-emu_pass-arg=max-func-params@5.txt func-metrics.txt fuzz-exec_O.txt fuzz-exec_all-features.txt fuzz_metrics_noprint.bin.txt generate-stack-ir_optimize-stack-ir_print-stack-ir_optimize-level=3.txt ignore_missing_func_dwarf.bin.txt inlined_to_start_dwarf.bin.txt interesting-pass-mix.txt legalize-js-interface-minimally.txt legalize-js-interface_all-features.txt legalize-js-interface_pass-arg=legalize-js-interface-export-originals.txt licm.txt log-execution.txt memory-packing_all-features.txt memory-packing_all-features_zero-filled-memory.txt memory64-lowering_enable-memory64_enable-bulk-memory_enable-threads.txt merge-blocks.txt merge-blocks_remove-unused-brs.txt merge-locals_all-features.txt metrics_all-features.txt metrics_strip-debug_metrics.bin.txt metrics_strip-producers_metrics.bin.txt minify-imports-and-exports-and-modules.txt minify-imports-and-exports_all-features.txt minify-imports_all-features.txt multi_line_table_dwarf.bin.txt multi_unit_abbrev_noprint.bin.txt nm.txt no-exit-runtime.txt optimize-added-constants-propagate_low-memory-unused.txt optimize-added-constants_low-memory-unused.txt optimize-instructions_fuzz-exec.txt pick-load-signs.txt pick-load-signs_all-features.txt post-emscripten.txt precompute-propagate_all-features.txt precompute_all-features.txt precompute_coalesce-locals_vacuum.txt print-call-graph.txt print-function-map.txt print.bin.txt print_g.bin.txt print_g_metrics.bin.txt print_g_strip-dwarf.bin.txt remove-imports.txt remove-memory.txt remove-non-js-ops.txt remove-unused-brs_all-features.txt remove-unused-brs_enable-multivalue.txt remove-unused-brs_generate-stack-ir_print-stack-ir.txt remove-unused-brs_precompute_vacuum_remove-unused-brs.txt remove-unused-brs_shrink-level=1.txt remove-unused-brs_shrink-level=1_ignore-implicit-traps.txt remove-unused-module-elements_all-features.txt remove-unused-names.txt remove-unused-names_code-folding.txt remove-unused-names_merge-blocks_all-features.txt remove-unused-names_precompute.txt remove-unused-names_remove-unused-brs_vacuum.txt remove-unused-names_vacuum.txt remove-unused-names_vacuum_ignore-implicit-traps.txt remove-unused-nonfunction-module-elements_all-features.txt reorder-functions.txt reorder-locals.txt reorder-locals_print_roundtrip.txt reverse_dwarf_abbrevs.bin.txt roundtrip.txt roundtrip_signed.bin.txt roundtrip_typenames_features.txt rse_all-features.txt safe-heap_disable-simd.txt safe-heap_enable-threads_enable-simd.txt safe-heap_enable-threads_enable-simd64.txt safe-heap_low-memory-unused_enable-threads_enable-simd.txt safe-heap_start-function.txt set-globals.txt simplify-globals-optimizing_enable-mutable-globals.txt simplify-globals_all-features.txt simplify-globals_all-features_fuzz-exec.txt simplify-locals-nonesting.txt simplify-locals-nostructure.txt simplify-locals-notee-nostructure.txt simplify-locals-notee.txt simplify-locals.txt simplify-locals_all-features.txt simplify-locals_all-features_disable-exception-handling.txt souperify.txt ssa-nomerge_enable-simd.txt ssa_enable-threads.txt ssa_fuzz-exec_enable-threads.txt stack-check_enable-mutable-globals.txt strip-debug.bin.txt strip-dwarf.bin.txt strip-producers.bin.txt strip-target-features.bin.txt strip-target-features_roundtrip_print-features_all-features.txt stub-unsupported-js.txt too_much_for_liveness.bin.txt translate-to-fuzz_all-features_metrics_noprint.txt trap-mode-clamp.txt trap-mode-js.txt vacuum_all-features.txt vacuum_ignore-implicit-traps.txt vacuum_remove-unused-names_merge-blocks.txt print memory-import-shared.minified.txt memory-import-shared.txt memory-shared.minified.txt memory-shared.txt min.minified.txt min.txt printf.c printf.txt reduce atomics-and-bulk-memory.wast.txt destructive.wast.txt imports.wast.txt memory_table.wast.txt simple.wast.txt spec Contributing.md README.md run.py unit __init__.py input asyncify-pure.txt asyncify.js random_data.txt update.sh test_asyncify.py test_datacount.py test_dwarf.py test_features.py test_finalize.py test_initial_fuzz.py test_memory_packing.py test_poppy_validation.py test_reduce.py test_stack_ir.py test_symbolmap.py test_tail_call_type.py test_warnings.py test_wasm2c.py utils.py wasm2asm.asserts.js wasm2asm.traps.js wasm2js.asserts.js wasm2js.traps.js wasm2js add_div.2asm.js atomic_fence.2asm.js atomics_32.2asm.js base64.2asm.js br.2asm.js br_table.2asm.js br_table_hoisting.2asm.js br_table_temp.2asm.js br_table_to_loop.2asm.js break-drop.2asm.js bulk-memory.2asm.js comments.2asm.js conversions-modified.2asm.js deterministic.2asm.js dot_import.2asm.js dynamicLibrary.2asm.js empty_export.2asm.js empty_imported_table.2asm.js empty_table.2asm.js emscripten-grow-no.2asm.js emscripten-grow-yes.2asm.js emscripten.2asm.js endianness.2asm.js excess_fallthrough.2asm.js f32.2asm.js f32_cmp.2asm.js f64_cmp.2asm.js fac.2asm.js float-ops.2asm.js float_literals-modified.2asm.js float_misc.2asm.js forward.2asm.js func-ptr-offset.2asm.js func_ptrs.2asm.js get-set-local.2asm.js get_local.2asm.js global_i64.2asm.js grow-memory-tricky.2asm.js grow_memory.2asm.js i32.2asm.js i64-add-sub.2asm.js i64-ctz.2asm.js i64-lowering.2asm.js i64-rotate.2asm.js i64-select.2asm.js i64-shifts.2asm.js if_unreachable.2asm.js indirect-select.2asm.js int_exprs.2asm.js labels.2asm.js left-to-right.2asm.js minified-memory.2asm.js minus_minus.2asm.js nested-selects.2asm.js ordering.2asm.js reinterpret.2asm.js reinterpret_scratch.2asm.js set_local.2asm.js sign_ext.2asm.js stack-modified.2asm.js start_func.2asm.js switch.2asm.js tee_local.2asm.js traps.2asm.js unaligned.2asm.js unary-ops.2asm.js unreachable-get-cycle.2asm.js unreachable-insts.2asm.js unreachable-later.2asm.js GL_VERSION_1_5 GL_VERSION_2_0 GL_VERSION_2_1 GL_VERSION_3_0 GL_VERSION_3_1 GL_VERSION_3_2 GL_VERSION_3_3 GL_VERSION_4_0 GL_VERSION_4_2 GL_VERSION_4_3 GL_3DFX_multisample GL_3DFX_tbuffer GL_3DFX_texture_compression_FXT1 GL_AMD_blend_minmax_factor GL_AMD_conservative_depth GL_AMD_debug_output GL_AMD_depth_clamp_separate GL_AMD_draw_buffers_blend GL_AMD_multi_draw_indirect GL_AMD_name_gen_delete GL_AMD_performance_monitor GL_AMD_pinned_memory GL_AMD_query_buffer_object GL_AMD_sample_positions GL_AMD_seamless_cubemap_per_texture GL_AMD_shader_stencil_export GL_AMD_stencil_operation_extended GL_AMD_texture_texture4 GL_AMD_transform_feedback3_lines_triangles GL_AMD_vertex_shader_layer GL_AMD_vertex_shader_tessellator GL_AMD_vertex_shader_viewport_index GL_APPLE_aux_depth_stencil GL_APPLE_client_storage GL_APPLE_element_array GL_APPLE_fence GL_APPLE_float_pixels GL_APPLE_flush_buffer_range GL_APPLE_object_purgeable GL_APPLE_pixel_buffer GL_APPLE_rgb_422 GL_APPLE_row_bytes GL_APPLE_specular_vector GL_APPLE_texture_range GL_APPLE_transform_hint GL_APPLE_vertex_array_object GL_APPLE_vertex_array_range GL_APPLE_vertex_program_evaluators GL_APPLE_ycbcr_422 GL_ARB_ES2_compatibility GL_ARB_ES3_compatibility GL_ARB_arrays_of_arrays GL_ARB_base_instance GL_ARB_blend_func_extended GL_ARB_cl_event GL_ARB_clear_buffer_object GL_ARB_color_buffer_float GL_ARB_compatibility GL_ARB_compressed_texture_pixel_storage GL_ARB_compute_shader GL_ARB_conservative_depth GL_ARB_copy_buffer GL_ARB_copy_image GL_ARB_debug_output GL_ARB_depth_buffer_float GL_ARB_depth_clamp GL_ARB_depth_texture GL_ARB_draw_buffers GL_ARB_draw_buffers_blend GL_ARB_draw_elements_base_vertex GL_ARB_draw_indirect GL_ARB_draw_instanced GL_ARB_explicit_attrib_location GL_ARB_explicit_uniform_location GL_ARB_fragment_coord_conventions GL_ARB_fragment_layer_viewport GL_ARB_fragment_program GL_ARB_fragment_program_shadow GL_ARB_fragment_shader GL_ARB_framebuffer_no_attachments GL_ARB_framebuffer_object GL_ARB_framebuffer_sRGB GL_ARB_geometry_shader4 GL_ARB_get_program_binary GL_ARB_gpu_shader5 GL_ARB_gpu_shader_fp64 GL_ARB_half_float_pixel GL_ARB_half_float_vertex GL_ARB_imaging GL_ARB_instanced_arrays GL_ARB_internalformat_query GL_ARB_internalformat_query2 GL_ARB_invalidate_subdata GL_ARB_map_buffer_alignment GL_ARB_map_buffer_range GL_ARB_matrix_palette GL_ARB_multi_draw_indirect GL_ARB_multisample GL_ARB_multitexture GL_ARB_occlusion_query GL_ARB_occlusion_query2 GL_ARB_pixel_buffer_object GL_ARB_point_parameters GL_ARB_point_sprite GL_ARB_program_interface_query GL_ARB_provoking_vertex GL_ARB_robust_buffer_access_behavior GL_ARB_robustness GL_ARB_robustness_application_isolation GL_ARB_robustness_share_group_isolation GL_ARB_sample_shading GL_ARB_sampler_objects GL_ARB_seamless_cube_map GL_ARB_separate_shader_objects GL_ARB_shader_atomic_counters GL_ARB_shader_bit_encoding GL_ARB_shader_image_load_store GL_ARB_shader_image_size GL_ARB_shader_objects GL_ARB_shader_precision GL_ARB_shader_stencil_export GL_ARB_shader_storage_buffer_object GL_ARB_shader_subroutine GL_ARB_shader_texture_lod GL_ARB_shading_language_100 GL_ARB_shading_language_420pack GL_ARB_shading_language_include GL_ARB_shading_language_packing GL_ARB_shadow GL_ARB_shadow_ambient GL_ARB_stencil_texturing GL_ARB_sync GL_ARB_tessellation_shader GL_ARB_texture_border_clamp GL_ARB_texture_buffer_object GL_ARB_texture_buffer_object_rgb32 GL_ARB_texture_buffer_range GL_ARB_texture_compression GL_ARB_texture_compression_bptc GL_ARB_texture_compression_rgtc GL_ARB_texture_cube_map GL_ARB_texture_cube_map_array GL_ARB_texture_env_add GL_ARB_texture_env_combine GL_ARB_texture_env_crossbar GL_ARB_texture_env_dot3 GL_ARB_texture_float GL_ARB_texture_gather GL_ARB_texture_mirrored_repeat GL_ARB_texture_multisample GL_ARB_texture_non_power_of_two GL_ARB_texture_query_levels GL_ARB_texture_query_lod GL_ARB_texture_rectangle GL_ARB_texture_rg GL_ARB_texture_rgb10_a2ui GL_ARB_texture_storage GL_ARB_texture_storage_multisample GL_ARB_texture_swizzle GL_ARB_texture_view GL_ARB_timer_query GL_ARB_transform_feedback2 GL_ARB_transform_feedback3 GL_ARB_transform_feedback_instanced GL_ARB_transpose_matrix GL_ARB_uniform_buffer_object GL_ARB_vertex_array_bgra GL_ARB_vertex_array_object GL_ARB_vertex_attrib_64bit GL_ARB_vertex_attrib_binding GL_ARB_vertex_blend GL_ARB_vertex_buffer_object GL_ARB_vertex_program GL_ARB_vertex_shader GL_ARB_vertex_type_2_10_10_10_rev GL_ARB_viewport_array GL_ARB_window_pos GL_ATIX_point_sprites GL_ATIX_texture_env_combine3 GL_ATIX_texture_env_route GL_ATIX_vertex_shader_output_point_size GL_ATI_draw_buffers GL_ATI_element_array GL_ATI_envmap_bumpmap GL_ATI_fragment_shader GL_ATI_map_object_buffer GL_ATI_meminfo GL_ATI_pn_triangles GL_ATI_separate_stencil GL_ATI_shader_texture_lod GL_ATI_text_fragment_shader GL_ATI_texture_compression_3dc GL_ATI_texture_env_combine3 GL_ATI_texture_float GL_ATI_texture_mirror_once GL_ATI_vertex_array_object GL_ATI_vertex_attrib_array_object GL_ATI_vertex_streams GL_EXT_422_pixels GL_EXT_Cg_shader GL_EXT_abgr GL_EXT_bgra GL_EXT_bindable_uniform GL_EXT_blend_color GL_EXT_blend_equation_separate GL_EXT_blend_func_separate GL_EXT_blend_logic_op GL_EXT_blend_minmax GL_EXT_blend_subtract GL_EXT_clip_volume_hint GL_EXT_cmyka GL_EXT_color_subtable GL_EXT_compiled_vertex_array GL_EXT_convolution GL_EXT_coordinate_frame GL_EXT_copy_texture GL_EXT_cull_vertex GL_EXT_debug_marker GL_EXT_depth_bounds_test GL_EXT_direct_state_access GL_EXT_draw_buffers2 GL_EXT_draw_instanced GL_EXT_draw_range_elements GL_EXT_fog_coord GL_EXT_fragment_lighting GL_EXT_framebuffer_blit GL_EXT_framebuffer_multisample GL_EXT_framebuffer_multisample_blit_scaled GL_EXT_framebuffer_object GL_EXT_framebuffer_sRGB GL_EXT_geometry_shader4 GL_EXT_gpu_program_parameters GL_EXT_gpu_shader4 GL_EXT_histogram GL_EXT_index_array_formats GL_EXT_index_func GL_EXT_index_material GL_EXT_index_texture GL_EXT_light_texture GL_EXT_misc_attribute GL_EXT_multi_draw_arrays GL_EXT_multisample GL_EXT_packed_depth_stencil GL_EXT_packed_float GL_EXT_packed_pixels GL_EXT_paletted_texture GL_EXT_pixel_buffer_object GL_EXT_pixel_transform GL_EXT_pixel_transform_color_table GL_EXT_point_parameters GL_EXT_polygon_offset GL_EXT_provoking_vertex GL_EXT_rescale_normal GL_EXT_scene_marker GL_EXT_secondary_color GL_EXT_separate_shader_objects GL_EXT_separate_specular_color GL_EXT_shader_image_load_store GL_EXT_shadow_funcs GL_EXT_shared_texture_palette GL_EXT_stencil_clear_tag GL_EXT_stencil_two_side GL_EXT_stencil_wrap GL_EXT_subtexture GL_EXT_texture GL_EXT_texture3D GL_EXT_texture_array GL_EXT_texture_buffer_object GL_EXT_texture_compression_dxt1 GL_EXT_texture_compression_latc GL_EXT_texture_compression_rgtc GL_EXT_texture_compression_s3tc GL_EXT_texture_cube_map GL_EXT_texture_edge_clamp GL_EXT_texture_env GL_EXT_texture_env_add GL_EXT_texture_env_combine GL_EXT_texture_env_dot3 GL_EXT_texture_filter_anisotropic GL_EXT_texture_integer GL_EXT_texture_lod_bias GL_EXT_texture_mirror_clamp GL_EXT_texture_object GL_EXT_texture_perturb_normal GL_EXT_texture_rectangle GL_EXT_texture_sRGB GL_EXT_texture_sRGB_decode GL_EXT_texture_shared_exponent GL_EXT_texture_snorm GL_EXT_texture_swizzle GL_EXT_timer_query GL_EXT_transform_feedback GL_EXT_vertex_array GL_EXT_vertex_array_bgra GL_EXT_vertex_attrib_64bit GL_EXT_vertex_shader GL_EXT_vertex_weighting GL_EXT_x11_sync_object GL_GREMEDY_frame_terminator GL_GREMEDY_string_marker GL_HP_convolution_border_modes GL_HP_image_transform GL_HP_occlusion_test GL_HP_texture_lighting GL_IBM_cull_vertex GL_IBM_multimode_draw_arrays GL_IBM_rasterpos_clip GL_IBM_static_data GL_IBM_texture_mirrored_repeat GL_IBM_vertex_array_lists GL_INGR_color_clamp GL_INGR_interlace_read GL_INTEL_parallel_arrays GL_INTEL_texture_scissor GL_KHR_debug GL_KHR_texture_compression_astc_ldr GL_KTX_buffer_region GL_MESAX_texture_stack GL_MESA_pack_invert GL_MESA_resize_buffers GL_MESA_window_pos GL_MESA_ycbcr_texture GL_NVX_gpu_memory_info GL_NV_bindless_texture GL_NV_blend_square GL_NV_conditional_render GL_NV_copy_depth_to_color GL_NV_copy_image GL_NV_depth_buffer_float GL_NV_depth_clamp GL_NV_depth_range_unclamped GL_NV_evaluators GL_NV_explicit_multisample GL_NV_fence GL_NV_float_buffer GL_NV_fog_distance GL_NV_fragment_program GL_NV_fragment_program2 GL_NV_fragment_program4 GL_NV_fragment_program_option GL_NV_framebuffer_multisample_coverage GL_NV_geometry_program4 GL_NV_geometry_shader4 GL_NV_gpu_program4 GL_NV_gpu_program5 GL_NV_gpu_program_fp64 GL_NV_gpu_shader5 GL_NV_half_float GL_NV_light_max_exponent GL_NV_multisample_coverage GL_NV_multisample_filter_hint GL_NV_occlusion_query GL_NV_packed_depth_stencil GL_NV_parameter_buffer_object GL_NV_parameter_buffer_object2 GL_NV_path_rendering GL_NV_pixel_data_range GL_NV_point_sprite GL_NV_present_video GL_NV_primitive_restart GL_NV_register_combiners GL_NV_register_combiners2 GL_NV_shader_atomic_float GL_NV_shader_buffer_load GL_NV_tessellation_program5 GL_NV_texgen_emboss GL_NV_texgen_reflection GL_NV_texture_barrier GL_NV_texture_compression_vtc GL_NV_texture_env_combine4 GL_NV_texture_expand_normal GL_NV_texture_multisample GL_NV_texture_rectangle GL_NV_texture_shader GL_NV_texture_shader2 GL_NV_texture_shader3 GL_NV_transform_feedback GL_NV_transform_feedback2 GL_NV_vdpau_interop GL_NV_vertex_array_range GL_NV_vertex_array_range2 GL_NV_vertex_attrib_integer_64bit GL_NV_vertex_buffer_unified_memory GL_NV_vertex_program GL_NV_vertex_program1_1 GL_NV_vertex_program2 GL_NV_vertex_program2_option GL_NV_vertex_program3 GL_NV_vertex_program4 GL_NV_video_capture GL_OES_byte_coordinates GL_OES_compressed_paletted_texture GL_OES_read_format GL_OES_single_precision GL_OML_interlace GL_OML_resample GL_OML_subsample GL_PGI_misc_hints * * GL_PGI_vertex_hints GL_REGAL_error_string GL_REGAL_extension_query GL_REGAL_log GL_REND_screen_coordinates GL_S3_s3tc GL_SGIS_color_range GL_SGIS_detail_texture GL_SGIS_fog_function GL_SGIS_generate_mipmap GL_SGIS_multisample GL_SGIS_pixel_texture GL_SGIS_point_line_texgen GL_SGIS_sharpen_texture GL_SGIS_texture4D GL_SGIS_texture_border_clamp GL_SGIS_texture_edge_clamp GL_SGIS_texture_filter4 GL_SGIS_texture_lod GL_SGIS_texture_select GL_SGIX_async GL_SGIX_async_histogram GL_SGIX_async_pixel GL_SGIX_blend_alpha_minmax GL_SGIX_clipmap GL_SGIX_convolution_accuracy GL_SGIX_depth_texture GL_SGIX_flush_raster GL_SGIX_fog_offset GL_SGIX_fog_texture GL_SGIX_fragment_specular_lighting GL_SGIX_framezoom GL_SGIX_interlace GL_SGIX_ir_instrument1 GL_SGIX_list_priority GL_SGIX_pixel_texture GL_SGIX_pixel_texture_bits GL_SGIX_reference_plane GL_SGIX_resample GL_SGIX_shadow GL_SGIX_shadow_ambient GL_SGIX_sprite GL_SGIX_tag_sample_buffer GL_SGIX_texture_add_env GL_SGIX_texture_coordinate_clamp GL_SGIX_texture_lod_bias GL_SGIX_texture_multi_buffer GL_SGIX_texture_range GL_SGIX_texture_scale_bias GL_SGIX_vertex_preclip GL_SGIX_vertex_preclip_hint GL_SGIX_ycrcb GL_SGI_color_matrix GL_SGI_color_table GL_SGI_texture_color_table GL_SUNX_constant_data GL_SUN_convolution_border_modes GL_SUN_global_alpha GL_SUN_mesh_array GL_SUN_read_video_pixels GL_SUN_slice_accum GL_SUN_triangle_list GL_SUN_vertex GL_WIN_phong_shading GL_WIN_specular_fog third_party CMakeLists.txt llvm-project Binary.cpp CMakeLists.txt ConvertUTF.cpp DJB.cpp DWARFAbbreviationDeclaration.cpp DWARFAcceleratorTable.cpp DWARFAddressRange.cpp DWARFCompileUnit.cpp DWARFContext.cpp DWARFDataExtractor.cpp DWARFDebugAbbrev.cpp DWARFDebugAddr.cpp DWARFDebugArangeSet.cpp DWARFDebugAranges.cpp DWARFDebugFrame.cpp DWARFDebugInfoEntry.cpp DWARFDebugLine.cpp DWARFDebugLoc.cpp DWARFDebugMacro.cpp DWARFDebugPubTable.cpp DWARFDebugRangeList.cpp DWARFDebugRnglists.cpp DWARFDie.cpp DWARFEmitter.cpp DWARFExpression.cpp DWARFFormValue.cpp DWARFGdbIndex.cpp DWARFListTable.cpp DWARFTypeUnit.cpp DWARFUnit.cpp DWARFUnitIndex.cpp DWARFVerifier.cpp DWARFVisitor.cpp DWARFVisitor.h DWARFYAML.cpp DataExtractor.cpp Debug.cpp Dwarf.cpp Error.cpp Error.h ErrorHandling.cpp FormatVariadic.cpp Hashing.cpp LEB128.cpp LineIterator.cpp MCRegisterInfo.cpp MD5.cpp MemoryBuffer.cpp NativeFormatting.cpp ObjectFile.cpp Optional.cpp Path.cpp ScopedPrinter.cpp SmallVector.cpp SourceMgr.cpp StringMap.cpp StringRef.cpp SymbolicFile.cpp Twine.cpp UnicodeCaseFold.cpp Unix Unix.h WithColor.cpp YAMLParser.cpp YAMLTraits.cpp dwarf2yaml.cpp include llvm-c DataTypes.h DisassemblerTypes.h Error.h ErrorHandling.h Types.h llvm ADT APFloat.h APInt.h APSInt.h AllocatorList.h ArrayRef.h BitmaskEnum.h DenseMap.h DenseMapInfo.h DenseSet.h EpochTracker.h FoldingSet.h FunctionExtras.h Hashing.h MapVector.h None.h Optional.h PointerIntPair.h PointerUnion.h STLExtras.h SmallPtrSet.h SmallSet.h SmallString.h SmallVector.h StringExtras.h StringMap.h StringRef.h StringSet.h StringSwitch.h Triple.h Twine.h bit.h edit_distance.h fallible_iterator.h ilist_base.h ilist_iterator.h ilist_node.h ilist_node_base.h ilist_node_options.h iterator.h iterator_range.h simple_ilist.h BinaryFormat COFF.h Dwarf.h ELF.h MachO.h Magic.h Wasm.h Config abi-breaking.h config.h llvm-config.h DebugInfo DIContext.h DWARF DWARFAbbreviationDeclaration.h DWARFAcceleratorTable.h DWARFAddressRange.h DWARFAttribute.h DWARFCompileUnit.h DWARFContext.h DWARFDataExtractor.h DWARFDebugAbbrev.h DWARFDebugAddr.h DWARFDebugArangeSet.h DWARFDebugAranges.h DWARFDebugFrame.h DWARFDebugInfoEntry.h DWARFDebugLine.h DWARFDebugLoc.h DWARFDebugMacro.h DWARFDebugPubTable.h DWARFDebugRangeList.h DWARFDebugRnglists.h DWARFDie.h DWARFExpression.h DWARFFormValue.h DWARFGdbIndex.h DWARFListTable.h DWARFObject.h DWARFRelocMap.h DWARFSection.h DWARFTypeUnit.h DWARFUnit.h DWARFUnitIndex.h DWARFVerifier.h MC LaneBitmask.h MCExpr.h MCFixup.h MCFragment.h MCInst.h MCRegister.h MCRegisterInfo.h MCSymbol.h MCSymbolWasm.h SubtargetFeature.h Object Archive.h Binary.h COFF.h CVDebugRecord.h Decompressor.h ELF.h ELFObjectFile.h ELFTypes.h Error.h MachO.h Minidump.h ObjectFile.h RelocationResolver.h SymbolicFile.h Wasm.h ObjectYAML DWARFEmitter.h DWARFYAML.h ObjectYAML.h Support AArch64TargetParser.h ARMAttributeParser.h ARMBuildAttributes.h ARMTargetParser.h AlignOf.h Alignment.h Allocator.h BinaryByteStream.h BinaryStream.h BinaryStreamError.h CBindingWrapping.h Casting.h Chrono.h CodeGen.h CommandLine.h Compiler.h ConvertUTF.h DJB.h DataExtractor.h DataTypes.h Debug.h Endian.h Errc.h Errno.h Error.h ErrorHandling.h ErrorOr.h FileOutputBuffer.h FileSystem.h Format.h FormatAdapters.h FormatCommon.h FormatProviders.h FormatVariadic.h FormatVariadicDetails.h FormattedStream.h Host.h LEB128.h LineIterator.h Locale.h MD5.h ManagedStatic.h MathExtras.h MemAlloc.h MemoryBuffer.h NativeFormatting.h Path.h PointerLikeTypeTraits.h Printable.h Process.h Program.h Regex.h ReverseIteration.h SMLoc.h ScopedPrinter.h Signals.h SmallVectorMemoryBuffer.h SourceMgr.h SwapByteOrder.h TargetParser.h TargetRegistry.h Threading.h TypeSize.h Unicode.h UnicodeCharRanges.h WindowsError.h WithColor.h YAMLParser.h YAMLTraits.h circular_raw_ostream.h raw_ostream.h type_traits.h include llvm DebugInfo DWARFContext.h readme.txt obj2yaml_Error.cpp raw_ostream.cpp readme.txt setup.py wabt wasm2c README.md wasm-rt-impl.c wasm-rt-impl.h wasm-rt.h ConvertUTF.c - Universal Character Names conversions ------ DWARFVisitor.cpp DWARFVisitor.h lib Support Error.cpp - Error and associated utilities Hashing.cpp MemoryBuffer.cpp - Memory Buffer implementation StringMap.cpp - String Hash table map implementation Support UnicodeCaseFold.cpp dwarf2yaml.cpp - obj2yaml conversion tool llvm-c Error.h - llvm::Error class C Interface StringSwitch.h - Switch-on-literal-string Construct fallible_iterator.h - Wrapper for fallible iterators DWARFExpression.h - DWARF Expression handling DWARFEmitter.h - ARMAttributeParser.h - ARM Attribute Information Printer AlignOf.h - Portable calculation of type alignment ConvertUTF.h - Universal Character Names conversions MemoryBuffer.h - Memory Buffer Interface Printable.h - Print function helpers UnicodeCharRanges.h - Types and functions for character ranges raw_ostream.h - Raw output stream raw_ostream.cpp - Implement the raw_ostream classes wasi-stub README.md build.sh run.sh wasi-stub.c

# WASI-STUB This tool takes a wasm file, replace all `wasi_snapshot_preview1` import to (stub) functions defines in the same module. This is useful when executing wasm in sandbox enviroment where wasi is not available. ## Build First build binaryen with `cmake . && make -j`. Then: ``` ./build.sh ``` ## Use ``` ./run.sh file.wasm ``` The tool will write file.wasm inplace. [](https://github.com/WebAssembly/binaryen/actions?query=workflow%3ACI) # Binaryen Binaryen is a compiler and toolchain infrastructure library for WebAssembly, written in C++. It aims to make [compiling to WebAssembly] **easy, fast, and effective**: * **Easy**: Binaryen has a simple [C API] in a single header, and can also be [used from JavaScript][JS_API]. It accepts input in [WebAssembly-like form][compile_to_wasm] but also accepts a general [control flow graph] for compilers that prefer that. * **Fast**: Binaryen's internal IR uses compact data structures and is designed for completely parallel codegen and optimization, using all available CPU cores. Binaryen's IR also compiles down to WebAssembly extremely easily and quickly because it is essentially a subset of WebAssembly. * **Effective**: Binaryen's optimizer has many passes (see an overview later down) that can improve code size and speed. These optimizations aim to make Binaryen powerful enough to be used as a [compiler backend][backend] by itself. One specific area of focus is on WebAssembly-specific optimizations (that general-purpose compilers might not do), which you can think of as wasm [minification], similar to minification for JavaScript, CSS, etc., all of which are language-specific. Compilers using Binaryen include: * [`AssemblyScript`](https://github.com/AssemblyScript/assemblyscript) which compiles a variant of TypeScript to WebAssembly * [`wasm2js`](https://github.com/WebAssembly/binaryen/blob/main/src/wasm2js.h) which compiles WebAssembly to JS * [`Asterius`](https://github.com/tweag/asterius) which compiles Haskell to WebAssembly * [`Grain`](https://github.com/grain-lang/grain) which compiles Grain to WebAssembly Binaryen also provides a set of **toolchain utilities** that can * **Parse** and **emit** WebAssembly. In particular this lets you load WebAssembly, optimize it using Binaryen, and re-emit it, thus implementing a wasm-to-wasm optimizer in a single command. * **Interpret** WebAssembly as well as run the WebAssembly spec tests. * Integrate with **[Emscripten](http://emscripten.org)** in order to provide a complete compiler toolchain from C and C++ to WebAssembly. * **Polyfill** WebAssembly by running it in the interpreter compiled to JavaScript, if the browser does not yet have native support (useful for testing). Consult the [contributing instructions](Contributing.md) if you're interested in participating. ## Binaryen IR Binaryen's internal IR is designed to be * **Flexible and fast** for optimization. * **As close as possible to WebAssembly** so it is simple and fast to convert it to and from WebAssembly. There are a few differences between Binaryen IR and the WebAssembly language: * Tree structure * Binaryen IR [is a tree][binaryen_ir], i.e., it has hierarchical structure, for convenience of optimization. This differs from the WebAssembly binary format which is a stack machine. * Consequently Binaryen's text format allows only s-expressions. WebAssembly's official text format is primarily a linear instruction list (with s-expression extensions). Binaryen can't read the linear style, but it can read a wasm text file if it contains only s-expressions. * Binaryen uses Stack IR to optimize "stacky" code (that can't be represented in structured form). * When stacky code must be represented in Binaryen IR, such as with multivalue instructions and blocks, it is represented with tuple types that do not exist in the WebAssembly language. In addition to multivalue instructions, locals and globals can also have tuple types in Binaryen IR but not in WebAssembly. Experiments show that better support for multivalue could enable useful but small code size savings of 1-3%, so it has not been worth changing the core IR structure to support it better. * Block input values (currently only supported in `catch` blocks in the exception handling feature) are represented as `pop` subexpressions. * Types and unreachable code * WebAssembly limits block/if/loop types to none and the concrete value types (i32, i64, f32, f64). Binaryen IR has an unreachable type, and it allows block/if/loop to take it, allowing [local transforms that don't need to know the global context][unreachable]. As a result, Binaryen's default text output is not necessarily valid wasm text. (To get valid wasm text, you can do `--generate-stack-ir --print-stack-ir`, which prints Stack IR, this is guaranteed to be valid for wasm parsers.) * Binaryen ignores unreachable code when reading WebAssembly binaries. That means that if you read a wasm file with unreachable code, that code will be discarded as if it were optimized out (often this is what you want anyhow, and optimized programs have no unreachable code anyway, but if you write an unoptimized file and then read it, it may look different). The reason for this behavior is that unreachable code in WebAssembly has corner cases that are tricky to handle in Binaryen IR (it can be very unstructured, and Binaryen IR is more structured than WebAssembly as noted earlier). Note that Binaryen does support unreachable code in .wat text files, since as we saw Binaryen only supports s-expressions there, which are structured. * Blocks * Binaryen IR has only one node that contains a variable-length list of operands: the block. WebAssembly on the other hand allows lists in loops, if arms, and the top level of a function. Binaryen's IR has a single operand for all non-block nodes; this operand may of course be a block. The motivation for this property is that many passes need special code for iterating on lists, so having a single IR node with a list simplifies them. * As in wasm, blocks and loops may have names. Branch targets in the IR are resolved by name (as opposed to nesting depth). This has 2 consequences: * Blocks without names may not be branch targets. * Names are required to be unique. (Reading .wat files with duplicate names is supported; the names are modified when the IR is constructed). * As an optimization, a block that is the child of a loop (or if arm, or function toplevel) and which has no branches targeting it will not be emitted when generating wasm. Instead its list of operands will be directly used in the containing node. Such a block is sometimes called an "implicit block". * Reference Types * The wasm text and binary formats require that a function whose address is taken by `ref.func` must be either in the table, or declared via an `(elem declare func $..)`. Binaryen will emit that data when necessary, but it does not represent it in IR. That is, IR can be worked on without needing to think about declaring function references. As a result, you might notice that round-trip conversions (wasm => Binaryen IR => wasm) change code a little in some corner cases. * When optimizing Binaryen uses an additional IR, Stack IR (see `src/wasm-stack.h`). Stack IR allows a bunch of optimizations that are tailored for the stack machine form of WebAssembly's binary format (but Stack IR is less efficient for general optimizations than the main Binaryen IR). If you have a wasm file that has been particularly well-optimized, a simple round-trip conversion (just read and write, without optimization) may cause more noticeable differences, as Binaryen fits it into Binaryen IR's more structured format. If you also optimize during the round-trip conversion then Stack IR opts will be run and the final wasm will be better optimized. Notes when working with Binaryen IR: * As mentioned above, Binaryen IR has a tree structure. As a result, each expression should have exactly one parent - you should not "reuse" a node by having it appear more than once in the tree. The motivation for this limitation is that when we optimize we modify nodes, so if they appear more than once in the tree, a change in one place can appear in another incorrectly. * For similar reasons, nodes should not appear in more than one functions. ### Intrinsics Binaryen intrinsic functions look like calls to imports, e.g., ```wat (import "binaryen-intrinsics" "foo" (func $foo)) ``` Implementing them that way allows them to be read and written by other tools, and it avoids confusing errors on a binary format error that could happen in those tools if we had a custom binary format extension. An intrinsic method may be optimized away by the optimizer. If it is not, it must be **lowered** before shipping the wasm, as otherwise it will look like a call to an import that does not exist (and VMs will show an error on not having a proper value for that import). That final lowering is *not* done automatically. A user of intrinsics must run the pass for that explicitly, because the tools do not know when the user intends to finish optimizing, as the user may have a pipeline of multiple optimization steps, or may be doing local experimentation, or fuzzing/reducing, etc. Only the user knows when the final optimization happens before the wasm is "final" and ready to be shipped. Note that, in general, some additional optimizations may be possible after the final lowering, and so a useful pattern is to optimize once normally with intrinsics, then lower them away, then optimize after that, e.g.: ``` wasm-opt input.wasm -o output.wasm -O --intrinsic-lowering -O ``` Each intrinsic defines its semantics, which includes what the optimizer is allowed to do with it and what the final lowering will turn it to. See [intrinsics.h](https://github.com/WebAssembly/binaryen/blob/main/src/ir/intrinsics.h) for the detailed definitions. A quick summary appears here: * `call.without.effects`: Similar to a `call_ref` in that it receives parameters, and a reference to a function to call, and calls that function with those parameters, except that the optimizer can assume the call has no side effects, and may be able to optimize it out (if it does not have a result that is used, generally). ## Tools This repository contains code that builds the following tools in `bin/`: * **wasm-opt**: Loads WebAssembly and runs Binaryen IR passes on it. * **wasm-as**: Assembles WebAssembly in text format (currently S-Expression format) into binary format (going through Binaryen IR). * **wasm-dis**: Un-assembles WebAssembly in binary format into text format (going through Binaryen IR). * **wasm2js**: A WebAssembly-to-JS compiler. This is used by Emscripten to generate JavaScript as an alternative to WebAssembly. * **wasm-reduce**: A testcase reducer for WebAssembly files. Given a wasm file that is interesting for some reason (say, it crashes a specific VM), wasm-reduce can find a smaller wasm file that has the same property, which is often easier to debug. See the [docs](https://github.com/WebAssembly/binaryen/wiki/Fuzzing#reducing) for more details. * **wasm-shell**: A shell that can load and interpret WebAssembly code. It can also run the spec test suite. * **wasm-emscripten-finalize**: Takes a wasm binary produced by llvm+lld and performs emscripten-specific passes over it. * **wasm-ctor-eval**: A tool that can execute C++ global constructors ahead of time. Used by Emscripten. * **binaryen.js**: A standalone JavaScript library that exposes Binaryen methods for [creating and optimizing WASM modules](https://github.com/WebAssembly/binaryen/blob/main/test/binaryen.js/hello-world.js). For builds, see [binaryen.js on npm](https://www.npmjs.com/package/binaryen) (or download it directly from [github](https://raw.githubusercontent.com/AssemblyScript/binaryen.js/master/index.js), [rawgit](https://cdn.rawgit.com/AssemblyScript/binaryen.js/master/index.js), or [unpkg](https://unpkg.com/binaryen@latest/index.js)). Usage instructions for each are below. ## Binaryen Optimizations Binaryen contains [a lot of optimization passes](https://github.com/WebAssembly/binaryen/tree/main/src/passes) to make WebAssembly smaller and faster. You can run the Binaryen optimizer by using ``wasm-opt``, but also they can be run while using other tools, like ``wasm2js`` and ``wasm-metadce``. * The default optimization pipeline is set up by functions like [`addDefaultFunctionOptimizationPasses`](https://github.com/WebAssembly/binaryen/blob/369b8bdd3d9d49e4d9e0edf62e14881c14d9e352/src/passes/pass.cpp#L396). * There are various [pass options](https://github.com/WebAssembly/binaryen/blob/369b8bdd3d9d49e4d9e0edf62e14881c14d9e352/src/pass.h#L85) that you can set, to adjust the optimization and shrink levels, whether to ignore unlikely traps, inlining heuristics, fast-math, and so forth. See ``wasm-opt --help`` for how to set them and other details. See each optimization pass for details of what it does, but here is a quick overview of some of the relevant ones: * **CoalesceLocals** - Key “register allocation” pass. Does a live range analysis and then reuses locals in order to minimize their number, as well as to remove copies between them. * **CodeFolding** - Avoids duplicate code by merging it (e.g. if two `if` arms have some shared instructions at their end). * **CodePushing** - “Pushes” code forward past branch operations, potentially allowing the code to not be run if the branch is taken. * **DeadArgumentElimination** - LTO pass to remove arguments to a function if it is always called with the same constants. * **DeadCodeElimination** * **Directize** - Turn an indirect call into a normal call, when the table index is constant. * **DuplicateFunctionElimination** - LTO pass. * **Inlining** - LTO pass. * **LocalCSE** - Simple local common subexpression elimination. * **LoopInvariantCodeMotion** * **MemoryPacking** - Key "optimize data segments" pass that combines segments, removes unneeded parts, etc. * **MergeBlocks** - Merge a `block` to an outer one where possible, reducing their number. * **MergeLocals** - When two locals have the same value in part of their overlap, pick in a way to help CoalesceLocals do better later (split off from CoalesceLocals to keep the latter simple). * **MinifyImportsAndExports** - Minifies them to “a”, “b”, etc. * **OptimizeAddedConstants** - Optimize a load/store with an added constant into a constant offset. * **OptimizeInstructions** - Key peephole optimization pass with a constantly increasing list of patterns. * **PickLoadSigns** - Adjust whether a load is signed or unsigned in order to avoid sign/unsign operations later. * **Precompute** - Calculates constant expressions at compile time, using the built-in interpreter (which is guaranteed to be able to handle any constant expression). * **ReReloop** - Transforms wasm structured control flow to a CFG and then goes back to structured form using the Relooper algorithm, which may find more optimal shapes. * **RedundantSetElimination** - Removes a `local.set` of a value that is already present in a local. (Overlaps with CoalesceLocals; this achieves the specific operation just mentioned without all the other work CoalesceLocals does, and therefore is useful in other places in the optimization pipeline.) * **RemoveUnsedBrs** - Key “minor control flow optimizations” pass, including jump threading and various transforms that can get rid of a `br` or `br_table` (like turning a `block` with a `br` in the middle into an `if` when possible). * **RemoveUnusedModuleElements** - “Global DCE”, an LTO pass that removes imports, functions, globals, etc., when they are not used. * **ReorderFunctions** - Put more-called functions first, potentially allowing the LEB emitted to call them to be smaller (in a very large program). * **ReorderLocals** - Put more-used locals first, potentially allowing the LEB emitted to use them to be smaller (in a very large function). After the sorting, it also removes locals not used at all. * **SimplifyGlobals** - Optimizes globals in various ways, for example, coalescing them, removing mutability from a global never modified, applying a constant value from an immutable global, etc. * **SimplifyLocals** - Key “`local.get/set/tee`” optimization pass, doing things like replacing a set and a get with moving the set’s value to the get (and creating a tee) where possible. Also creates `block/if/loop` return values instead of using a local to pass the value. * **Vacuum** - Key “remove silly unneeded code” pass, doing things like removing an `if` arm that has no contents, a drop of a constant value with no side effects, a `block` with a single child, etc. “LTO” in the above means an optimization is Link Time Optimization-like in that it works across multiple functions, but in a sense Binaryen is always “LTO” as it usually is run on the final linked wasm. Advanced optimization techniques in the Binaryen optimizer include [SSAification](https://github.com/WebAssembly/binaryen/blob/main/src/passes/SSAify.cpp), [Flat IR](https://github.com/WebAssembly/binaryen/blob/main/src/ir/flat.h), and [Stack/Poppy IR](https://github.com/WebAssembly/binaryen/blob/main/src/ir/stack-utils.h). Binaryen also contains various passes that do other things than optimizations, like [legalization for JavaScript](https://github.com/WebAssembly/binaryen/blob/main/src/passes/LegalizeJSInterface.cpp), [Asyncify](https://github.com/WebAssembly/binaryen/blob/main/src/passes/Asyncify.cpp), etc. ## Building ``` cmake . && make ``` A C++14 compiler is required. Note that you can also use `ninja` as your generator: `cmake -G Ninja . && ninja`. Binaryen.js can be built using Emscripten, which can be installed via [the SDK](http://kripken.github.io/emscripten-site/docs/getting_started/downloads.html)). ``` emcmake cmake . && emmake make binaryen_js ``` ### Visual C++ 1. Using the Microsoft Visual Studio Installer, install the "Visual C++ tools for CMake" component. 1. Generate the projects: ``` mkdir build cd build "%VISUAL_STUDIO_ROOT%\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" .. ``` Substitute VISUAL_STUDIO_ROOT with the path to your Visual Studio installation. In case you are using the Visual Studio Build Tools, the path will be "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools". 1. From the Developer Command Prompt, build the desired projects: ``` msbuild binaryen.vcxproj ``` CMake generates a project named "ALL_BUILD.vcxproj" for conveniently building all the projects. ## Running ### wasm-opt Run ```` bin/wasm-opt [.wasm or .wat file] [options] [passes, see --help] [--help] ```` The wasm optimizer receives WebAssembly as input, and can run transformation passes on it, as well as print it (before and/or after the transformations). For example, try ```` bin/wasm-opt test/passes/lower-if-else.wat --print ```` That will pretty-print out one of the test cases in the test suite. To run a transformation pass on it, try ```` bin/wasm-opt test/passes/lower-if-else.wat --print --lower-if-else ```` The `lower-if-else` pass lowers if-else into a block and a break. You can see the change the transformation causes by comparing the output of the two print commands. It's easy to add your own transformation passes to the shell, just add `.cpp` files into `src/passes`, and rebuild the shell. For example code, take a look at the [`lower-if-else` pass](https://github.com/WebAssembly/binaryen/blob/main/src/passes/LowerIfElse.cpp). Some more notes: * See `bin/wasm-opt --help` for the full list of options and passes. * Passing `--debug` will emit some debugging info. ### wasm2js Run ``` bin/wasm2js [input.wasm file] ``` This will print out JavaScript to the console. For example, try ``` $ bin/wasm2js test/hello_world.wat ``` That output contains ``` function add(x, y) { x = x | 0; y = y | 0; return x + y | 0 | 0; } ``` as a translation of ``` (func $add (; 0 ;) (type $0) (param $x i32) (param $y i32) (result i32) (i32.add (local.get $x) (local.get $y) ) ) ``` wasm2js's output is in ES6 module format - basically, it converts a wasm module into an ES6 module (to run on older browsers and Node.js versions you can use Babel etc. to convert it to ES5). Let's look at a full example of calling that hello world wat; first, create the main JS file: ```javascript // main.mjs import { add } from "./hello_world.mjs"; console.log('the sum of 1 and 2 is:', add(1, 2)); ``` The run this (note that you need a new enough Node.js with ES6 module support): ```shell $ bin/wasm2js test/hello_world.wat -o hello_world.mjs $ node --experimental-modules main.mjs the sum of 1 and 2 is: 3 ``` Things keep to in mind with wasm2js's output: * You should run wasm2js with optimizations for release builds, using `-O` or another optimization level. That will optimize along the entire pipeline (wasm and JS). It won't do everything a JS minifer would, though, like minify whitespace, so you should still run a normal JS minifer afterwards. * It is not possible to match WebAssembly semantics 100% precisely with fast JavaScript code. For example, every load and store may trap, and to make JavaScript do the same we'd need to add checks everywhere, which would be large and slow. Instead, wasm2js assumes loads and stores do not trap, that int/float conversions do not trap, and so forth. There may also be slight differences in corner cases of conversions, like non-trapping float to int. ## Testing ``` ./check.py ``` (or `python check.py`) will run `wasm-shell`, `wasm-opt`, etc. on the testcases in `test/`, and verify their outputs. The `check.py` script supports some options: ``` ./check.py [--interpreter=/path/to/interpreter] [TEST1] [TEST2].. ``` * If an interpreter is provided, we run the output through it, checking for parse errors. * If tests are provided, we run exactly those. If none are provided, we run them all. To see what tests are available, run `./check.py --list-suites`. * Some tests require `emcc` or `nodejs` in the path. They will not run if the tool cannot be found, and you'll see a warning. * We have tests from upstream in `tests/spec`, in git submodules. Running `./check.py` should update those. ### Setting up dependencies ``` ./third_party/setup.py [mozjs|v8|wabt|all] ``` (or `python third_party/setup.py`) installs required dependencies like the SpiderMonkey JS shell, the V8 JS shell and WABT in `third_party/`. Other scripts automatically pick these up when installed. Run `pip3 install -r requirements-dev.txt` to get the requirements for the `lit` tests. Note that you need to have the location `pip` installs to in your `$PATH` (on linux, `~/.local/bin`). ### Fuzzing ``` ./scripts/fuzz_opt.py [--binaryen-bin=build/bin] ``` (or `python scripts/fuzz_opt.py`) will run various fuzzing modes on random inputs with random passes until it finds a possible bug. See [the wiki page](https://github.com/WebAssembly/binaryen/wiki/Fuzzing) for all the details. ## Design Principles * **Interned strings for names**: It's very convenient to have names on nodes, instead of just numeric indices etc. To avoid most of the performance difference between strings and numeric indices, all strings are interned, which means there is a single copy of each string in memory, string comparisons are just a pointer comparison, etc. * **Allocate in arenas**: Based on experience with other optimizing/transformating toolchains, it's not worth the overhead to carefully track memory of individual nodes. Instead, we allocate all elements of a module in an arena, and the entire arena can be freed when the module is no longer needed. ## FAQ * Why the weird name for the project? "Binaryen" is a combination of **binary** - since WebAssembly is a binary format for the web - and **Emscripten** - with which it can integrate in order to compile C and C++ all the way to WebAssembly, via asm.js. Binaryen began as Emscripten's WebAssembly processing library (`wasm-emscripten`). "Binaryen" is pronounced [in the same manner](http://www.makinggameofthrones.com/production-diary/2011/2/11/official-pronunciation-guide-for-game-of-thrones.html) as "[Targaryen](https://en.wikipedia.org/wiki/List_of_A_Song_of_Ice_and_Fire_characters#House_Targaryen)": *bi-NAIR-ee-in*. Or something like that? Anyhow, however Targaryen is correctly pronounced, they should rhyme. Aside from pronunciation, the Targaryen house words, "Fire and Blood", have also inspired Binaryen's: "Code and Bugs." * Does it compile under Windows and/or Visual Studio? Yes, it does. Here's a step-by-step [tutorial][win32] on how to compile it under **Windows 10 x64** with with **CMake** and **Visual Studio 2015**. However, Visual Studio 2017 may now be required. Help would be appreciated on Windows and OS X as most of the core devs are on Linux. [compiling to WebAssembly]: https://github.com/WebAssembly/binaryen/wiki/Compiling-to-WebAssembly-with-Binaryen [win32]: https://github.com/brakmic/bazaar/blob/master/webassembly/COMPILING_WIN32.md [C API]: https://github.com/WebAssembly/binaryen/wiki/Compiling-to-WebAssembly-with-Binaryen#c-api-1 [control flow graph]: https://github.com/WebAssembly/binaryen/wiki/Compiling-to-WebAssembly-with-Binaryen#cfg-api [JS_API]: https://github.com/WebAssembly/binaryen/wiki/binaryen.js-API [compile_to_wasm]: https://github.com/WebAssembly/binaryen/wiki/Compiling-to-WebAssembly-with-Binaryen#what-do-i-need-to-have-in-order-to-use-binaryen-to-compile-to-webassembly [backend]: https://kripken.github.io/talks/binaryen.html#/9 [minification]: https://kripken.github.io/talks/binaryen.html#/2 [unreachable]: https://github.com/WebAssembly/binaryen/issues/903 [binaryen_ir]: https://github.com/WebAssembly/binaryen/issues/663 This directory contains tests for the core WebAssembly semantics, as described in [Semantics.md](https://github.com/WebAssembly/design/blob/master/Semantics.md) and specified by the [spec interpreter](https://github.com/WebAssembly/spec/blob/master/interpreter). Tests are written in the [S-Expression script format](https://github.com/WebAssembly/spec/blob/master/interpreter/README.md#s-expression-syntax) defined by the interpreter. The test suite can be run with the spec interpreter as follows: ``` ./run.py --wasm <path-to-wasm-interpreter> ``` where the path points to the spec interpreter executable (or a tool that understands similar options). If the binary is in the working directory, this option can be omitted. In addition, the option `--js <path-to-js-interpreter>` can be given to point to a stand-alone JavaScript interpreter supporting the WebAssembly API. If provided, all tests are also executed in JavaScript. These files are part of WABT, but are currently not present in releases, so the directory is included as a fallback in Binaryen in a way that the files will be overwritten in case WABT contains them in the future. Original README: https://github.com/WebAssembly/wabt/blob/master/wasm2c/README.md

Mykhail_enthusiasm

Dev_Instructions README.md README.md bot config.js events.js nearComms.js contract Cargo.toml build.bat build.sh reload_contract.sh src lib.rs test.sh dist index.html src.afe7f6a4.js elements aboutbot.json botoptions.json botoptions_loggedin.json networkselect.json nomination_new.json nominations_menu.json userrewards.json index.js package.json src index.html index.js

# near-slack-bot redirector testing: .env file example content: NODE_ENV=development SLACK_SIGNING_SECRET=12345 SLACK_BOT_TOKEN=54321 PORT=3000 APIHOST=http://localhost:3000 CONTRACT_NAME=sub.chokobear.testnet PRIVATE_KEY=[your contract's private key from .near-credentials/contract.json. otherwise a file from user .near-credentials] dev runtime initialization: npm i npm run build:js npm run start wallet auth endpoint http://localhost:3000/getAccountId/SLACKID send money endpoint http://localhost:3000/sendMoney/SLACKID/targetNearAccountId/0.3 Vote for SLACKID endpoint http://localhost:3000/voteForSlackId/OWNER_SLACKID/VOTED_FOR_SLACKID Create nomination endpoint http://localhost:3000/createNomination/OWNER_SLACKID/nominationTitle/depositNearAmount Smart contract deploy cd contract ./reload_contract AccountId ParentAccountId Call contract via CLI near state contract.sbot.testnet near view contract.sbot.testnet get_wallet '{"slack_account_id": "test"}' near call contract.sbot.testnet associate_wallet_with_slack '{"slack_account_id": "test", "near_account_id": "recipient.testnet"}' --accountId sbot.testnet near view contract.sbot.testnet get_rewards '{"slack_account_id":"test"}' near call contract.sbot.testnet send_reward '{"slack_account_id": "test"}' --accountId sbot.testnet --deposit 1 near call contract.sbot.testnet withdraw_rewards '{"slack_account_id": "test"}' --accountId sergey_shpota.testnet --gas=75000000000000 near generate-key near add-key sergey_shpota.testnet ed25519:4n9Kv6UnMfWx5syzgBPQyUz3dFM6WCQ4yNz4JLZWFAbe --contract-id contract.sbot.testnet --allowance 30000000000 near add-key somix11.testnet ed25519:RTE93uLVJLAr8Kj1v5E5r3wib81WSbVydKpqj93c3nz --contract-id sub.somix11.testnet --allowance 30000000000 near call sub.somix11.testnet create_nomination '{"owner":"U02TH9USH6H", "title":"Test nomination"}' --accountId somix11.testnet --deposit 1 near view sub.somix11.testnet get_nomination '{"owner":"U02TH9USH6H"}' near call sub.somix11.testnet add_vote '{"owner":"test_owner", "vote":"second_user"}' --accountId somix11.testnet near call contract.sbot.testnet finish_nomination '{"owner":"test_owner"}' --accountId sergey_shpota.testnet --gas=75000000000000 near call sub.somix11.testnet create_nomination '{"owner":"U02TH9USH6H", "title":"The MVP player of March"}' --accountId somix11.testnet --deposit 1 near view sub.somix11.testnet get_nomination '{"owner":"U02TH9USH6H"}' near call sub.somix11.testnet add_vote '{"owner":"U02TH9USH6H", "vote":"U02TH9USH6H"}' --accountId somix11.testnet near call sub.somix11.testnet finish_nomination '{"owner":"U02TH9USH6H"}' --accountId somix11.testnet --gas=75000000000000 # Getting Started with ENTHUSIASM ## Available Scripts In the project directory, you can run: ### `npm run start` Runs the app server to process slack requests. ### `npm run build:js` Builds client-side code which will handle transaction confirmations and wallet communications on behalf of the user. Will use `./src` as source and put a built version in the `./dist` folder ## Environment variables NODE\_ENV=`development` SLACK\_SIGNING\_SECRET=`SECRET` SLACK\_BOT\_TOKEN=`TOKEN` PORT=`3000` APIHOST=`http://localhost:3000` CONTRACT\_NAME=`your contract name` PRIVATE\_KEY=`your contract's private key from .near-credentials/contract.json. otherwise a file from user .near-credentials will be used` ### Smart contract deployment ### `cd contract` ### `./reload_contract [AccountId] [ParentAccountId]` Where AccountId is your target near account to host the contract. ParentAccountId is a parent account, see [https://docs.near.org/docs/concepts/account](<https://docs.near.org/docs/concepts/account>) for more details

le-thanh-nghi_bet-system

README.md babel.config.js contract Cargo.toml README.md build.sh compile.js src lib.rs package.json src __mocks__ fileMock.js assets logo-black.svg logo-white.svg css global.css jquery-ui.css style.css index.html jest.init.js js config.js index.js utils.js main.test.js wallet login index.html

# Bet System ================== A Demo project of NEAR Smart Contract. This [React] app was initialized with [create-near-app] Quick Start =========== To run this project locally: 1. Prerequisites: Make sure you've installed [Node.js] ≥ 12 2. Install dependencies: `yarn install` 3. Run the local development server: `yarn dev` (see `package.json` for a full list of `scripts` you can run with `yarn`) Now you'll have a local development environment backed by the NEAR TestNet! Go ahead and play with the app and the code. As you make code changes, the app will automatically reload. Exploring The Code ================== 1. The "backend" code lives in the `/contract` folder. See the README there for more info. 2. The frontend code lives in the `/src` folder. `/src/index.html` is a great place to start exploring. Note that it loads in `/src/index.js`, where you can learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `yarn run test`. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally: yarn install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `betsystem.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `betsystem.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account betsystem.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: set contract name in code --------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'betsystem.YOUR-NAME.testnet' Step 3: deploy! --------------- One command: yarn deploy As you can see in `package.json`, this does two things: 1. builds & deploys smart contract to NEAR TestNet 2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere. Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [React]: https://reactjs.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/docs/concepts/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages Bet system Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html Description ================== Nhiều người chơi sẽ thực hiện cá cược bóng đá Thông tin mỗi user cá cược : - accountId - tỷ số - Số tiền

nticket_nticket-dapp

.eslintrc.js .github workflows pages.yml .stylelintrc.json README.md babel.config.js jsconfig.json package-lock.json package.json public index.html src app index.ts router.ts constants.ts entities events events.types.ts eventsStore.ts nearStore.ts main.ts shims-vue.d.ts tsconfig.json vue.config.js

# nticket-dapp ## Project setup ``` npm install ``` ### Compiles and hot-reloads for development ``` npm run serve ``` ### Compiles and minifies for production ``` npm run build ``` ### Lints and fixes files ``` npm run lint ``` ### Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/).

nearnautnft_nearnaut-nft-contract

Cargo.toml README.md build.sh src approval.rs enumeration.rs events.rs internal.rs lib.rs metadata.rs mint.rs nft_core.rs royalty.rs

# TBD

Learn-NEAR-Hispano_NCD1--NearTip

Cargo.toml src lib.rs main.rs

MaxNEAR_NCD.computer-shop

README.md as-pect.config.js asconfig.json package.json scripts 1.dev-deploy.sh 2.use-contract.sh 3.cleanup.sh README.md src as_types.d.ts project __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts tsconfig.json utils.ts

## Setting up your terminal The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project. It uses the following setup: ```sh # set your terminal up to have 2 windows, A and B like this: ┌─────────────────────────────────┬─────────────────────────────────┐ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ └─────────────────────────────────┴─────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1644945903363-79757305293203 # export OWNER=maxnear.testnet ``` - Commands _helper scripts_ ```sh 1.dev-deploy.sh # helper: build and deploy contracts 2.use-contract.sh # helper: call methods on ContractPromise 3.cleanup.sh # helper: delete build and deploy artifacts ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1644945903363-79757305293203 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068) # NCD.computer-shop This is project was created for NCD qualification. ## Overview This repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform. The project contains: - a single contract with name ComputerShopContract - unit tests for contract - basic scripts to deploy and use contract ## Project requirements This project required: - NodeJS version 14.* - installed yarn (npm i -g yarn) - installed near-cli (npm i -g near-cli) ## Getting started (see below for video recordings of each of the following steps) 1) clone this repo to a local folder 2) run "yarn" 3) run "yarn build" 4) run tests "yarn test". Check that all tests are passed. Next steps should be run only in bash 5) run "./scripts/1.dev-deploy.sh" 6) run "./scripts/2.use-contract.sh" 7) run "./scripts/3.cleanup.sh" ### Project structure Project contains main folders: - scripts: Contain scripts for deploying and running smart contracts. Additionally contain README.md file which describe how to work with scripts. - src: Contain source files of contracts and related logic. ComputerShopContract located in src/project/assembly/index.ts ### Videos **`1.dev-deploy.sh`** This video shows the build and deployment of the contract. https://www.loom.com/share/657a3b11a7f14d58ab6243aa75349f7a **`2.use-contract.sh`** This video shows contract methods being called. https://www.loom.com/share/12d49bd09a41435cbb600daacd544d4b **`3.cleanup.sh`** This video shows the cleanup script running. Make sure you add the `BENEFICIARY` environment variable. The script will remind you if you forget. https://www.loom.com/share/4daf307c024c4040ac458a05764899da ```sh export BENEFICIARY=<your-account-here> # this account receives contract account balance ```

prasad-kumkar_cypher-kids-server

.eslintrc.js README.md contracts Cargo.toml README.md build.sh src lib.rs package.json server app.js middleware near.js package.json utils near-utils.js src App.js components Contract.js Gallery.js Keys.js Wallet.js config.js img ethkats.svg index.html index.js state app.js near.js utils near-utils.js state.js storage.js test app.test.js near-utils.js server.test.js test-utils.js utils patch-config.js

# Live App Review 6 - Progressive Onboarding This repo is a companion to the "NFT Example Progressive Onboarding" video series: [](https://youtu.be/Y-HYCcYVmz8) [](https://youtu.be/W29QmxiJh84) [](https://youtu.be/8kbxBqDSe_A) # Notes on this Example This example is not an NFT Standard and should be considered "experimental". However, it does work and is deployable to testnet. Prior to deploying to mainnet, please join our [Discord](https://near.chat) and check with NEAR **#dev-support** if there are any security concerns. ## Quickstart ```js yarn // see installation notes for Rust yarn test:unit // 1 test will fail due to bug in mocked blockchain yarn test:deploy // runs /test/app.test.js (all passing) yarn start ``` WIP Server Tests incomplete e.g. `yarn test:server` will not work. Despite server tests being incomplete, you still need to run the server (see notes below) `yarn && yarn start`. After running `yarn start` you'll have an app running (localhost:1234). The app has 2 types of logins for the user. 1. Connect Wallet 2. Sign In As Guest Connect Wallet is a standard NEAR App flow (think allow this app to view my account from MetaMask). Sign In As Guest creates a temporary keypair on the dev account where the contract is deployed. This gives the guest 3 free mints. When a guest mints, the owner_id of the TokenData is going to be the implicit account of the guest. See video "Part 1 Contract" for a detailed explanation of this. The guest can earn NEAR tokens from sales (other users with NEAR purchase their artwork) and then decide how to use their sale proceeds. Typically they will fund an account. ## NEAR Wallet Testnet has no "Funding Account Flow" In the video "Part 2 App and Testing" I am running the NEAR Wallet on localhost. On testnet NEAR Wallet funds accounts on behalf of users and developers to make the experience easy. If you'd like to test the funding account flow yourself, clone the [NEAR Wallet](https://github.com/near/near-wallet) and run it with a `.env` file in the root with the following entry `DISABLE_CREATE_ACCOUNT=true`. ## Installation Beyond having npm and node (latest versions), you should have Rust installed. I recommend nightly because living on the edge is fun. https://rustup.rs/ Also recommend installing near-cli globally `npm i -g near-cli` Everything else can be installed via: `yarn` `cd server && yarn` ## NEAR Config There is only one config.js file found in `src/config.js`, this is also used for running tests. Using `src/config.js` you can set up your different environments. Use `REACT_APP_ENV` to switch environments e.g. in `package.json` script `deploy`. ## Running Tests You can run unit tests in the Rust contracts themselves, but it may be more useful to JS tests against testnet itself. Note: to run the app and server tests make sure you install and start the server. - cd server - yarn && yarn start Commands: - `test` will simply run app tests against the contract already deployed. You can mess around with `app.test.js` and try different frontend stuff - `test:deploy` - will deploy a new dev account (`/neardev`) and deploy a new contract to this account, then run `test` - `test:server` - will test the server, make sure you start it (see "Note" above) - `test:unit` - runs the rust unit tests If you've changed your contract or your dev account has run out of funds use `test:deploy`, if you're updating your JS tests only then use `test`. ## Test Utils There are helpers in `test/test-utils.js` that take care of: 1. creating a near connection and establishing a keystore for the dev account 2. creating test accounts each time a test is run 3. establishing a contract instance so you can call methods You can change the default funding amount for test accounts in `src/config.js` ## Using the NEAR Config in your app In `src/state/near.js` you will see that `src/config.js` is loaded as a function. This is to satisfy the jest/node test runner. You can destructure any properies of the config easily in any module you import it in like this: ``` // example file app.js import getConfig from '../config'; export const { GAS, networkId, nodeUrl, walletUrl, nameSuffix, contractName, } = getConfig(); ``` Note the export const in the destructuring? Now you can import these like so: ``` //example file Component.js import { GAS } from '../app.js' ... await contract.withdraw({ amount: parseNearAmount('1') }, GAS) ... ``` # Notes on React 17, Parcel with useContext and useReducer - Bundled with Parcel 2.0 (@next) && eslint - *Minimal all-in-one state management with async/await support* ## Getting Started: State Store & useContext >The following steps describe how to use `src/utils/state` to create and use your own `store` and `StateProvider`. 1. Create a file e.g. `/state/app.js` and add the following code ```js import { State } from '../utils/state'; // example const initialState = { app: { mounted: false } }; export const { store, Provider } = State(initialState); ``` 2. Now in your `index.js` wrap your `App` component with the `StateProvider` ```js import { Provider } from './state/app'; ReactDOM.render( <Provider> <App /> </Provider>, document.getElementById('root') ); ``` 3. Finally in `App.js` you can `useContext(store)` ```js const { state, dispatch, update } = useContext(store); ``` ## Usage in Components ### Print out state values ```js <p>Hello {state.foo && state.foo.bar.hello}</p> ``` ### Update state directly in component functions ```js const handleClick = () => { update('clicked', !state.clicked); }; ``` ### Dispatch a state update function (action listener) ```js const onMount = () => { dispatch(onAppMount('world')); }; useEffect(onMount, []); ``` ## Dispatched Functions with context (update, getState, dispatch) When a function is called using dispatch, it expects arguments passed in to the outer function and the inner function returned to be async with the following json args: `{ update, getState, dispatch }` Example of a call: ```js dispatch(onAppMount('world')); ``` All dispatched methods **and** update calls are async and can be awaited. It also doesn't matter what file/module the functions are in, since the json args provide all the context needed for updates to state. For example: ```js import { helloWorld } from './hello'; export const onAppMount = (message) => async ({ update, getState, dispatch }) => { update('app', { mounted: true }); update('clicked', false); update('data', { mounted: true }); await update('', { data: { mounted: false } }); console.log('getState', getState()); update('foo.bar', { hello: true }); update('foo.bar', { hello: false, goodbye: true }); update('foo', { bar: { hello: true, goodbye: false } }); update('foo.bar.goodbye', true); await new Promise((resolve) => setTimeout(() => { console.log('getState', getState()); resolve(); }, 2000)); dispatch(helloWorld(message)); }; ``` ## Prefixing store and Provider The default names the `State` factory method returns are `store` and `Provider`. However, if you want multiple stores and provider contexts you can pass an additional `prefix` argument to disambiguate. ```js export const { appStore, AppProvider } = State(initialState, 'app'); ``` ## Performance and memo The updating of a single store, even several levels down, is quite quick. If you're worried about components re-rendering, use `memo`: ```js import React, { memo } from 'react'; const HelloMessage = memo(({ message }) => { console.log('rendered message'); return <p>Hello { message }</p>; }); export default HelloMessage; ``` Higher up the component hierarchy you might have: ```js const App = () => { const { state, dispatch, update } = useContext(appStore); ... const handleClick = () => { update('clicked', !state.clicked); }; return ( <div className="root"> <HelloMessage message={state.foo && state.foo.bar.hello} /> <p>clicked: {JSON.stringify(state.clicked)}</p> <button onClick={handleClick}>Click Me</button> </div> ); }; ``` When the button is clicked, the component HelloMessage will not re-render, it's value has been memoized (cached). Using this method you can easily prevent performance intensive state updates in further down components until they are neccessary. Reference: - https://reactjs.org/docs/context.html - https://dmitripavlutin.com/use-react-memo-wisely/ Minimal NEP#4 Implementation ============================ This contract implements bare-minimum functionality to satisfy the [NEP#4](https://github.com/nearprotocol/NEPs/pull/4) specification Notable limitations of this implementation ========================================== * Only the token owner can mint tokens. * You cannot give another account escrow access to a limited set of your tokens; an escrow must be trusted with all of your tokens or none at all * No functions to return the maximum or current supply of tokens * No functions to return metadata such as the name or symbol of this NFT * No functions (or storage primitives) to find all tokens belonging to a given account * Usability issues: some functions (e.g. `revoke_access`, `transfer`, `get_token_owner`) do not verify that they were given sensible inputs; if given non-existent keys, the errors they throw will not be very useful Still, if you track some of this information in an off-chain database, these limitations may be acceptable for your needs. In that case, this implementation may help reduce gas and storage costs. Notable additions that go beyond the specification of NEP#4 =========================================================== `mint_token`: the spec gives no guidance or requirements on how tokens are minted/created/assigned. This specific implementation only allows the contract owner to mint new tokens. If this implementation of `mint_token` is close to matching your needs, feel free to ship your NFT with only minor modifications. If you'd rather go with a strategy such as minting the whole supply of tokens upon deploy of the contract, or something else entirely, you may want to drastically change this behavior.

near_pm2-promise

.travis.yml README.md __tests__ index.js index.js package.json

# pm2-promise [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] pm2-promise is a tiny library that adds promise awareness to pm2 ## Installation ```sh npm install pm2-promise ``` [downloads-image]: https://img.shields.io/npm/dm/pm2-promise.svg [npm-url]: https://www.npmjs.com/package/pm2-promise [npm-image]: https://img.shields.io/npm/v/pm2-promise.svg [travis-url]: https://travis-ci.org/3axap4eHko/pm2-promise [travis-image]: https://img.shields.io/travis/3axap4eHko/pm2-promise/master.svg

medvedNick_MarketContract

README.md build.sh deploy.sh market Cargo.toml build.sh src lib.rs test.sh test.sh token Cargo.toml build.sh src lib.rs test.sh

# Market Contract Simple Rust market contract for token exchange. ## Description There are two contracts - `market` and `token_holder` (one per token). The first one acts as an exchange and contains the business logic, while the last ones simply store the tokens with the ability to transfer them with the command from the market contract. You can add as many tokens as you want, while exchanging between any of them. The main flow is as follows: 1. Deploy contract (for example, to `market.medvednick.testnet`) 2. Add tokens with appropriate balance - use `add_token` method with parameter `{"token": <TOKEN_NAME>}` - minumum deposit is 0.02 Ⓝ 3. Contract creates sub-account (i.e. `token1.market.medvednick.testnet`) and deploys the `token_holder` contract to it 3. Execute market orders between any tokens with automatic rate as X * Y = K - use `execute_order` method with parameter ``` { "sell": <TOKEN_YOU_WANT_TO_SELL>, "buy": <TOKEN_YOU_WANT_TO_BUY, "token_id": <WHERE_TO_TRANSFER_BUY_TOKEN> } ``` - minumum deposit is 0.01 Ⓝ 4. You can remove also remove token from market which will also delete token subaccount - use `remove_token` with parameter `{"token": <TOKEN_NAME>}` ## Unit Tests You can run unit tests from root folder with: `./test.sh` or for each contract from its directory with the same command. ## Deploy and Test Run You'll need near cli and other tools to build and deploy the contract. You can deploy and run automatic testing the contract on **TESTNET** with script with: `./deploy.sh <TESTNET_ACC_WUTHOUT_SUFFIX>` For example: `./deploy.sh medvednick` will deploy contract to `market.medvednick.testnet` using `medvednick.testnet` as master account. The script will first try to delete current market.* account and then to add 2 tokens to market sending 2 Near to each. Tokens would be added into `<TOKEN>.market.medvednick.testnet` accounts. The last step will exchange 0.25 Near between tokens. You can look into `deploy.sh` and comment/modify any commands. ## Thoughts on bugs There are multiple bugs and possible vulnerabilities within the contract, but due to the test nature of the task they are not fixed. Although they are mentioned in the list below, to show the awareness of them. - Remove token does not work properly because of some errors with ownership, need to find out why - Not sure if it's good to use `cd` in build scripts, but it's not working from other directory due to `.toml` absence - Fees and gas calculation probably should be made more dynamic - Probably it's also worth to move fees into class variables to be able to override them inside tests - No checks for success of `Promise`s, must-have but it will require a lot of additional code :( - K = X * Y results in overflow, changing formulae allows to avoid it, but still we have accuracy losses - Not sure how to unit test returned `Promise`s, can we? - Function `new::` on `token_holder` may be changed to `function_call`. Should check if there is any difference - Deploying contract in two different calls (`deploy` and call `new`) is a bad practice

esaminu_someNewProject

.eslintrc.yml .github ISSUE_TEMPLATE 01_BUG_REPORT.md 02_FEATURE_REQUEST.md 03_CODEBASE_IMPROVEMENT.md 04_SUPPORT_QUESTION.md config.yml PULL_REQUEST_TEMPLATE.md labels.yml workflows codeql.yml deploy-to-console.yml labels.yml lock.yml pr-labels.yml stale.yml .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs docs CODE_OF_CONDUCT.md CONTRIBUTING.md SECURITY.md frontend App.js assets global.css logo-black.svg logo-white.svg index.html index.js near-interface.js near-wallet.js package.json start.sh ui-components.js integration-tests Cargo.toml src tests.rs package.json

<h1 align="center"> <a href="https://github.com/near/boilerplate-template-rs"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_light.png"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_dark.png"> <img alt="" src="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_dark.png"> </picture> </a> </h1> <div align="center"> Rust Boilerplate Template <br /> <br /> <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> · <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> . <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+">Ask a Question</a> </div> <div align="center"> <br /> [](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [](https://github.com/near) </div> <details open="open"> <summary>Table of Contents</summary> - [About](#about) - [Built With](#built-with) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors & contributors](#authors--contributors) - [Security](#security) </details> --- ## About This project is created for easy-to-start as a React + Rust skeleton template in the Pagoda Gallery. It was initialized with [create-near-app]. Clone it and start to build your own gallery project! ### Built With [create-near-app], [amazing-github-template](https://github.com/dec0dOS/amazing-github-template) Getting Started ================== ### Prerequisites Make sure you have a [current version of Node.js](https://nodejs.org/en/about/releases/) installed – we are targeting versions `16+`. Read about other [prerequisites](https://docs.near.org/develop/prerequisites) in our docs. ### Installation Install all dependencies: npm install Build your contract: npm run build Deploy your contract to TestNet with a temporary dev account: npm run deploy Usage ===== Test your contract: npm test Start your frontend: npm start Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages ## Roadmap See the [open issues](https://github.com/near/boilerplate-template-rs/issues) for a list of proposed features (and known issues). - [Top Feature Requests](https://github.com/near/boilerplate-template-rs/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction) - [Top Bugs](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction) - [Newest Bugs](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aopen+is%3Aissue+label%3Abug) ## Support Reach out to the maintainer: - [GitHub issues](https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+) ## Project assistance If you want to say **thank you** or/and support active development of Rust Boilerplate Template: - Add a [GitHub Star](https://github.com/near/boilerplate-template-rs) to the project. - Tweet about the Rust Boilerplate Template. - Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog. Together, we can make Rust Boilerplate Template **better**! ## Contributing First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**. Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved! ## Authors & contributors The original setup of this repository is by [Dmitriy Sheleg](https://github.com/shelegdmitriy). For a full list of all authors and contributors, see [the contributors page](https://github.com/near/boilerplate-template-rs/contributors). ## Security Rust Boilerplate Template follows good practices of security, but 100% security cannot be assured. Rust Boilerplate Template is provided **"as is"** without any **warranty**. Use at your own risk. _For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._ # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.

near_dataplatform

.github ISSUE_TEMPLATE bug_report.md epic-template-.md feature-request-.md secondary-focus-area-.md workflows block-streamer-ci.yml close-completed-issues.yml coordinator-ci.yml deploy-dev-widgets.yml deploy-prod-widgets.yml deploy-widgets.yml runner-ci.yml README.md block-server handler.js serverless.yml block-streamer Cargo.toml build.rs data 000093085141 block.json shard_0.json shard_1.json shard_2.json shard_3.json 000107503704 block.json list_objects.xml shard_0.json shard_1.json shard_2.json shard_3.json 000107503705 block.json list_objects.xml shard_0.json shard_1.json shard_2.json shard_3.json invalid block.json list_objects.xml examples list_streams.rs start_stream.rs stop_stream.rs src block_stream.rs delta_lake_client.rs indexer_config.rs lake_s3_client.rs lib.rs main.rs metrics.rs redis.rs rules matcher.rs mod.rs outcomes_reducer.rs types.rs s3_client.rs server block_streamer_service.rs mod.rs test_utils.rs utils.rs coordinator Cargo.toml build.rs src block_streams handler.rs mod.rs synchronise.rs executors handler.rs mod.rs synchronise.rs indexer_config.rs indexer_state.rs main.rs redis.rs registry.rs server indexer_manager_service.rs mod.rs utils.rs docker-compose.yml frontend .eslintrc.json README.md jest.config.js next.config.js package-lock.json package.json postcss.config.js primitives.d.ts replacement.dev.json replacement.local.json replacement.mainnet.json src classes ValidationError.js components CreateNewIndexer CreateNewIndexer.js index.js Editor GlyphContainer.js __tests__ Editor.test.js validator.test.js block_details.js index.js Playground index.js constants RegexExp.js Strings.js contexts IndexerDetailsContext.js ModalContext.js pages create-new-indexer index.js global.css query-api-editor index.js utils debounce.js fetchBlock.js formatters.js formatters.test.js getLatestBlockHeight.js indexerRunner.js pgSchemaTypeGen.js queryIndexerFunction.js resize.js validators.js tailwind.config.js tsconfig.json widgets src NearQueryApi.metadata.json QueryApi.App.metadata.json QueryApi.Dashboard.metadata.json QueryApi.Editor.metadata.json QueryApi.IndexerStatus.metadata.json props.json hasura-authentication-service Cargo.toml src main.rs services.rs hasura migrations default 1691364619300_init down.sql up.sql postgres init.sql prometheus.yml registry contract Cargo.toml README.md build.sh deploy-dev.sh deploy-local-testing.sh deploy-prod.sh src lib.rs types Cargo.toml src lib.rs runner-client Cargo.toml build.rs examples list_executors.rs start_executor.rs stop_executor.rs src lib.rs runner .eslintrc.js examples list-executors.ts start-executor.ts stop-executor.ts jest.config.js package-lock.json package.json src dml-handler dml-handler.test.ts dml-handler.ts index.ts globals.d.ts hasura-client hasura-client.test.ts hasura-client.ts index.ts index.ts indexer-config index.ts indexer-config.test.ts indexer-config.ts indexer-meta index.ts indexer-meta.test.ts indexer-meta.ts log-entry.test.ts log-entry.ts indexer index.ts indexer.test.ts indexer.ts instrumentation index.ts tracer.ts lake-client index.ts lake-client.test.ts lake-client.ts logger.ts metrics.ts pg-client.ts provisioner index.ts provisioner.test.ts provisioner.ts schemas logs-table.ts metadata-table.ts redis-client index.ts redis-client.test.ts redis-client.ts server index.ts runner-client.ts runner-server.ts runner-service.test.ts runner-service.ts stream-handler index.ts stream-handler.ts worker.ts utility.ts tests blocks 00115185109 streamer_message.json integration.test.ts testcontainers hasura.ts postgres.ts utils.ts tsconfig.build.json tsconfig.json scripts wipe-database.sh

## What is this repo? Frontend for Near QueryAPI that allows users to create, manage, and explore indexers stored on-chain. You can visit the app [here](https://near.org/dataplatform.near/widget/QueryApi.App) BOS widgets are stored in the `widgets/` folder while the main NextJS application lives in the root. ## Getting Started First, download the bos-loader cli by following this guide [here](https://docs.near.org/bos/dev/bos-loader). From the root of QueryAPI Frontend repo, run the following command ```bash yarn serve:widgets:local // for running local enviornment yarn serve:widgets:dev // for running dev enviornment yarn serve:widgets:prod // for running prod enviornment ``` > Near.org or any other BOS gateway queries the blockchain state to pull the latest widgets code and renders it. If we would like to test our BOS widgets, we need to override the path at which the gateway (near.org) queries for the widget code. We do this using the Bos-loader tool (the underlying CLI tool used in the `yarn serve:widgets:dev` command) which allows us to serve out widgets locally (http://127.0.0.1:3030 by default). ** This command replaces all keys found in `replacement.dev.json` object with the their values in the widgets directory when serving the widgets **. At this point, we have served our widgets locally but have not yet told the BOS gateway (near.org) where to load our local widgets from. **Then, Head to `near.org/flags` and enter `http://127.0.0.1:3030`** > In order to tell our BOS gateway (near.org), where to load the local widgets from, we head to `near.org/flags` and enter the local path we got from running the previous command. If you have not changed any configurations then the default should be `http://127.0.0.1:3030` **Finally**, run the following to serve the local NextJS frontend ```bash yarn dev ``` **Now, head to the path where the widgets are served on the BOS.** - Prod App: `https://near.org/dataplatform.near/widget/QueryApi.App` ### ENV variables The React app does not use the replacement files. Instead, we need to provide an `.env` file to make sure we are accessing the right enviornment By default, the React app will use the `dev` enviornment vars ``` Prod: NEXT_PUBLIC_HASURA_ENDPOINT=https://near-queryapi.api.pagoda.co NEXT_PUBLIC_REGISTRY_CONTRACT_ID=queryapi.dataplatform.near ``` ``` Dev: NEXT_PUBLIC_HASURA_ENDPOINT=https://near-queryapi.dev.api.pagoda.co NEXT_PUBLIC_REGISTRY_CONTRACT_ID=dev-queryapi.dataplatform.near # IndexerFunction Registry A registry of indexer functions that are run by QueryAPI <br /> When an IndexerFunction is added to the registry the calling user's account is prepended to the name of the function. Example: `developer.near` calls `register_indexer_function("index_all_the_things", "bunch of code here" })` the function will be registered as `developer.near/index_all_the_things`. It can then be read by calling `read_indexer_function("developer.near/index_all_the_things")`. ## Methods ``` register_indexer_function({ function_name, code }) // Note that the name will be prefixed with the calling account read_indexer_function({ function_name }) remove_indexer_function({ function_name }) // Note that the name will be prefixed with the calling account list_indexer_functions() ``` <br/> ### Example Calls ```bash near view registry.queryapi.testnet read_indexer_function '{"function_name":"developer.testnet/log"}' near view registry.queryapi.testnet list_indexer_functions near call registry.queryapi.testnet register_indexer_function '{"function_name":"log", "code": "console.log(`Block #${streamerMessage.block.header.height});"}' --accountId <ACCOUNT_ID> near call registry.queryapi.testnet remove_indexer_function '{"function_name":"log"}' --accountId <ACCOUNT_ID> ``` TODO: Add multisig deployment administration for Data team and SREs (DAO?). ## Deployment commands ```bash ./build.sh near deploy --wasmFile ./target/wasm32-unknown-unknown/release/registry.wasm --accountId registry.queryapi.testnet ``` # QueryApi With QueryApi you can * Write your own custom indexer function at https://near.org/dataplatform.near/widget/QueryApi.Dashboard; * Specify the schema for your own custom hosted database and write to it with your indexer function; * Retrieve that data through a GraphQL API. ## 🧩 Components 1. [Coordinator](./coordinator) Continuously reads latest registry and attempts to synchronise that configuration across the system, i.e. starting relevant Block Streams and Executors. 1. [Runner](./runner) Manages "Executors" which, retrieves messages from Redis Streams, fetches matching blocks, and executes Indexer code against that block. Retrieves messages from Redis Stream, fetching matching block and executes the IndexerFunction. 1. [Block Streamer](./block-streamer) Manages "Block Streams" which, use the configured contract filter to fetch relevant blocks from S3 and publish those blocks to Redis Streams. 1. [IndexerFunction Editor UI](./frontend) Serves the editor UI within the dashboard widget and mediates some communication with the GraphQL DB and block server. 1. [Hasura Authentication Service](./hasura-authentication-service) Provides authentication for the Hasura GraphQL server. 1. [IndexerFunction Registry Contract](./registry) Stores IndexerFunctions, their schemas and execution parameters like start block height. 1. [Lake Block server](./block-server) Serves blocks from the S3 lake for in browser testing of IndexerFunctions. ## 🚀 Getting Started The majority of the QueryApi components can be set up locally using Docker. For this purpose, a [Docker Compose file](./docker-compose.yml) has been provided. However, the local system still relies on the NEAR Mainnet, rather than running on a localnet. ### Requirements - [Docker](https://docs.docker.com/engine/install/) - [Docker Compose](https://docs.docker.com/compose/install/) - [Hasura CLI](https://hasura.io/docs/latest/hasura-cli/install-hasura-cli/) - AWS Access Keys ### AWS Credentials Setup QueryApi requires AWS credentials to stream blocks from [NEAR Lake](https://github.com/near/near-lake-indexer). Credentials are exposed via the following environment variables, which can be found in the Docker Compose file: Runner: - `AWS_ACCESS_KEY_ID` - `AWS_SECRET_ACCESS_KEY` Coordinator: - `LAKE_AWS_ACCESS_KEY` - `LAKE_AWS_SECRET_ACCESS_KEY` - `QUEUE_AWS_ACCESS_KEY` - `QUEUE_AWS_SECRET_ACCESS_KEY` These should be populated with your credentials. In most cases, the same key pair can be used for all 3 sets of credentials. Just ensure the keys have permissions to access S3 for handling [Requestor Pays](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html) in Near Lake. ### Hasura Configuration Hasura contains shared tables for e.g. logging and setting arbitrary state. These tables must be configured prior to running the entire QueryApi application. Configuration is stored in the `hasura/` directory and deployed through the Hasura CLI. To configure Hasura, first start it with: ```sh docker compose up hasura-graphql --detach ``` And apply the configuration with: ```sh cd ./hasura && hasura deploy ``` ### Running QueryApi With everything configured correctly, we can now start all components of QueryApi with: ```sh docker compose up ``` ### Local Configuration - Coordinator watches the dev registry contract by default (`dev-queryapi.dataplatform.near`). To use a different contract, you can update the `REGISTRY_CONTRACT_ID` environment variable. ### Known Issues It is expected to see some provisioning errors from `Runner` when starting QueryAPI for the first time. These occur when multiple indexers under the same account attempt to provision the same shared infrastructure. These should self resolve after a few seconds.

huykgit98_react-assignment

.vscode launch.json README.md contract build.sh build builder.c code.h contract.js methods.h deploy.sh neardev dev-account.env package-lock.json package.json src contract.ts model.ts tsconfig.json frontend .cypress cypress.config.js e2e guest-book.cy.ts tsconfig.json App.js index.html index.js near-interface.js near-wallet.js package.json start.sh integration-tests package-lock.json package.json src main.ava.ts package-lock.json package.json

# A social media app using nearjs & reactjs

NguyenVanThanhNha_counter_learnnear

.dependabot config.yml .github workflows tests.yml .gitpod.yml .travis.yml README-Gitpod.md README.md as-pect.config.js asconfig.js assembly __tests__ as-pect.d.ts context.json main.spec.ts as_types.d.ts main.ts tsconfig.json neardev shared-test-staging test.near.json shared-test test.near.json package.json src config.js index.html loader.html main.js test-setup.js test.js

Counter example in AssemblyScript ================================= [](https://gitpod.io/#https://github.com/near-examples/counter) <!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page --> ## Description This contract implements simple counter backed by storage on blockchain. Contract in `assembly/main.ts` provides methods to increment / decrement counter and get it's current value or reset. Plus and minus buttons increase and decrease value correspondingly. When button L is toggled, counter will add or minus 10 a time. RS button is for reset. LE and RE buttons to let the robot wink to you. ## To Run Open in the Gitpod link above or clone the repository. ``` git clone https://github.com/near-examples/counter ``` ## Setup [Or skip to Login if in Gitpod](#login) Install dependencies: ``` yarn --frozen-lockfile ``` Make sure you have `near-cli` by running: ``` near --version ``` If you need to install `near-cli`: ``` npm install near-cli -g ``` ## Login If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.nearprotocol.com). In the project root, login with `near-cli` by following the instructions after this command: ``` near login ``` Modify the top of `src/config.js`, changing the `CONTRACT_NAME` to be the NEAR account name in the file `neardev/dev-account`. It starts with `dev-`. ```javascript … const CONTRACT_NAME = 'neardev/dev-account ACCOUNT ID'; /* TODO: fill this in! */ … ``` Start the example! ``` yarn start ``` ## To Test ``` yarn asp # as-pect tests NODE_ENV=ci yarn jest # jest tests NODE_ENV=ci yarn test # both ``` ## To Explore - `assembly/main.ts` for the contract code - `src/index.html` for the front-end HTML - `src/main.js` for the JavaScript front-end code and how to integrate contracts - `src/test.js` for the JS tests for the contract

microchipgnu_some-market-contract

.gitpod.yml DOCS.md README.md contract README.md build.sh build builder.c code.h hello_near.js methods.h deploy.sh neardev dev-account.env package-lock.json package.json scripts accept-offer.sh create-offer.sh exchange.sh get-offer.sh init.sh wrap-near.sh src contract.ts tsconfig.json integration-tests package-lock.json package.json src main.ava.ts package-lock.json package.json

# Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```ts @NearBindgen({}) class HelloNear { greeting: string = "Hello"; @view // This method is read-only and can be called for free get_greeting(): string { return this.greeting; } @call // This method changes the state, for which it cost gas set_greeting({ greeting }: { greeting: string }): void { // Record a log permanently to the blockchain! near.log(`Saving greeting ${greeting}`); this.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [node.js](https://nodejs.org/en/download/package-manager/) >= 16. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash npm run deploy ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `call` method. `Call` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"greeting":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. SOME Marketplace ⚠️ ================== SOME (Simply Offer MarketplacE) is a contract that facilitates the exchange of Non-fungible Tokens (NFTs) and NEAR. The contract leverages NEAR Social as a notification system to keep both parties informed throughout the exchange process. - [Near Social Live Demo](https://test.near.social/#/luisf.testnet/widget/some-market) - [Live Contract](https://testnet.nearblocks.io/address/dev-1676391043857-14814706623603) ## Features 1. Leverages Near Social notification system to notify involved parties. 2. Implements Mintbase AffiliateDirect standard. ## Process The exchange process is divided into three steps: creating an offer, accepting an offer, and exchanging NEAR for NFT. The first step involves the offerer (A) creating an offer in the market contract (MC) and notifying the NFT token owner (B) of the offer via the NEAR Social contract (NSC). In the second step, the NFT token owner (B) approves the offer and the MC writes a notification to the offerer (A) via NSC. Finally, in the third step, the offerer (A) transfers NEAR to the market contract (MC), which then attempts to transfer the NFT to the offerer (A) and the NEAR to the NFT token owner (B). ### Creating an offer 1. **A** calls `make_offer` to create an offer in **MC**. 2. **MC** calls `XXX` to write a notification in **NSC**. This notifies **B** that an offer was created. ### Accepting an offer 1. **B** calls `nft_approve` on **NFT** targetting **MC**. This triggers `nft_on_approve` on **MC**. 2. **MC** calls `XXX` to write a notification on **NSC** notifying **A** that the offer was accepted. ```sh near call nft nft_approve '{ "token_id": "1", "account_id": "market", "msg": "{\"offer_id\": \"XYZ\"}" }' --accountId A --depositYocto 1 ``` ### Exchanging the NFT 1. **A** calls `buy` on **MC** ```sh near call market buy '{ "offer_id": "XYZ" }' --accountId B --depositYocto offer_amount ``` ## Future - [ ] Implement storage staking when creating offers to avoid spam / running out of storage. - [ ] CI/CD workflow similar to [DevGigsBoard](https://github.com/near/devgigsboard-widgets/blob/main/.github/workflows/release.yml) for Near Social widgets - [ ] Implement Near Social Notifications contract or methods within this contract - [ ] Implement AffiliateDirect event logs (Mintbase Standard)

Mariesnlk_near-sc-course

README.md project_16 counter-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh neardev dev-account.env src lib.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-fc1fd79288c57701 lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bdb15f3bf6791f99 lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-ea8b6cb6c6fa541c lib-near-abi.json near-sdk-f4692abfcce871e0 lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json schemars-bc17eb802c5e50d5 lib-schemars.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-ca7b78331195cd27 lib-serde.json serde_json-628554486f2e4b1f lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json project_17 chat-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-fc1fd79288c57701 lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bdb15f3bf6791f99 lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-ea8b6cb6c6fa541c lib-near-abi.json near-sdk-f4692abfcce871e0 lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json schemars-bc17eb802c5e50d5 lib-schemars.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-ca7b78331195cd27 lib-serde.json serde_json-628554486f2e4b1f lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json project_18 fungible-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-fc1fd79288c57701 lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bdb15f3bf6791f99 lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-ea8b6cb6c6fa541c lib-near-abi.json near-sdk-f4692abfcce871e0 lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json schemars-bc17eb802c5e50d5 lib-schemars.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-ca7b78331195cd27 lib-serde.json serde_json-628554486f2e4b1f lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json project_19 nft-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-fc1fd79288c57701 lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bdb15f3bf6791f99 lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-ea8b6cb6c6fa541c lib-near-abi.json near-sdk-f4692abfcce871e0 lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json schemars-bc17eb802c5e50d5 lib-schemars.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-ca7b78331195cd27 lib-serde.json serde_json-628554486f2e4b1f lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json project_20 discussion-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-fc1fd79288c57701 lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bdb15f3bf6791f99 lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-ea8b6cb6c6fa541c lib-near-abi.json near-sdk-f4692abfcce871e0 lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json schemars-bc17eb802c5e50d5 lib-schemars.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-ca7b78331195cd27 lib-serde.json serde_json-628554486f2e4b1f lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json project_21 post-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json debug .fingerprint Inflector-e80133f0d873a89e lib-inflector.json ahash-0ea456d44955ceb2 build-script-build-script-build.json ahash-5c0bb4db4e529d3a lib-ahash.json ahash-75de2a8567409b0a run-build-script-build-script-build.json arrayref-c13f4daf9141ff10 lib-arrayref.json arrayvec-5ed8e9a0f838a07f lib-arrayvec.json arrayvec-942cc1cbf82b694f lib-arrayvec.json autocfg-3936825b0293837c lib-autocfg.json base64-0c3f16fadc1da635 lib-base64.json base64-7f77bc7365859151 lib-base64.json bitvec-83ca9af5df3aa113 lib-bitvec.json blake2-3042a9a886fcdf87 lib-blake2.json block-buffer-102429723281fa2e lib-block-buffer.json block-buffer-20b3646e53e662e8 lib-block-buffer.json borsh-9aa7c1f4a8eb7543 lib-borsh.json borsh-derive-f34d322c70f50c10 lib-borsh-derive.json borsh-derive-internal-1209d56ccd7cdfc4 lib-borsh-derive-internal.json borsh-schema-derive-internal-caba8d0f6e15e2db lib-borsh-schema-derive-internal.json bs58-a1ee981bf5fa2a05 lib-bs58.json byte-slice-cast-e98726a35bb6c61f lib-byte-slice-cast.json byteorder-c1f379e1522f1ef6 lib-byteorder.json bytesize-e9bb087e1eaabb72 lib-bytesize.json c2-chacha-f22e8ea2f9962c5e lib-c2-chacha.json cc-7f8e6df7ed2cade2 lib-cc.json cfg-if-1cc4882d2e315207 lib-cfg-if.json cfg-if-30d7f2d28beeeb1b lib-cfg-if.json cfg-if-7372481e614c58dd lib-cfg-if.json chrono-c99d893683020736 lib-chrono.json cipher-3fdc9af8c4abdfb9 lib-cipher.json convert_case-5edeb42cc79bfdbf lib-convert_case.json core-foundation-sys-0ae7d9beeb7d3b58 lib-core-foundation-sys.json cpufeatures-0a1169d2cfb3d107 lib-cpufeatures.json crunchy-0322e332b3ec8289 lib-crunchy.json crunchy-1e4810b237e7579b build-script-build-script-build.json crunchy-6050ff8e1cd01d84 run-build-script-build-script-build.json crypto-common-fbd876bb7100e04c lib-crypto-common.json crypto-mac-2ec09d725d6bdcbd lib-crypto-mac.json curve25519-dalek-23d15e40dd0aa23f lib-curve25519-dalek.json derive_more-1e43d3c0dddd77f8 lib-derive_more.json digest-4fedda34bb2d75d0 lib-digest.json digest-c73558d2412c90b0 lib-digest.json dyn-clone-d2e27b301c705649 lib-dyn-clone.json easy-ext-7a928631cacd1e93 lib-easy-ext.json ed25519-961d1528f0b9cbc5 lib-ed25519.json ed25519-dalek-4dba1d44c132d130 lib-ed25519-dalek.json fixed-hash-58623cefd879e1d3 lib-fixed-hash.json funty-5c293ef059cd9097 lib-funty.json generic-array-14d371e49e7d702d build-script-build-script-build.json generic-array-46aa735c1d9d8d90 run-build-script-build-script-build.json generic-array-d7bfb0603b875341 lib-generic_array.json getrandom-5bcf59f5fb305c3e lib-getrandom.json getrandom-6a73bb18c9683d61 build-script-build-script-build.json getrandom-a020d3a53d85421e run-build-script-build-script-build.json getrandom-d0bedf9a30e9749b lib-getrandom.json hashbrown-82b65bbc63072bc0 lib-hashbrown.json hashbrown-c939c80dd7bbf67f lib-hashbrown.json heck-f53c7857da10975a lib-heck.json hello_near-0183755a0bc7791e test-lib-hello_near.json hello_near-3d37de2639b6d0d7 lib-hello_near.json hex-fb12a001e1673ece lib-hex.json iana-time-zone-7d9558b69228fb10 lib-iana-time-zone.json impl-codec-32ef23cf2350e217 lib-impl-codec.json impl-trait-for-tuples-6e97175d3c2ec1ab lib-impl-trait-for-tuples.json indexmap-4ae1151602a0ebfa build-script-build-script-build.json indexmap-af8d9f20abf8274e lib-indexmap.json indexmap-de8683ebf1b221f8 run-build-script-build-script-build.json itoa-48345fbcae012e71 lib-itoa.json keccak-daa65ade954ce5c1 lib-keccak.json lazy_static-f922ee928b4d529a lib-lazy_static.json libc-09cf525f9378b0b1 build-script-build-script-build.json libc-2dcd5cb00080e9f2 run-build-script-build-script-build.json libc-f23871325ead10a5 lib-libc.json memory_units-65568a0325aa157f lib-memory_units.json near-abi-ecf68a9dc556d893 lib-near-abi.json near-account-id-3de322dadf8fec31 lib-near-account-id.json near-crypto-eb886acb45e191df lib-near-crypto.json near-primitives-c87639442aa5cce6 lib-near-primitives.json near-primitives-core-1cc1031ed7e53211 lib-near-primitives-core.json near-rpc-error-core-e125b94c693bc5dd lib-near-rpc-error-core.json near-rpc-error-macro-efe93f7ce320eb63 lib-near-rpc-error-macro.json near-sdk-784258717c9ec07d lib-near-sdk.json near-sdk-macros-dee39ef00999a63b lib-near-sdk-macros.json near-sys-fe41686c1c2c82f0 lib-near-sys.json near-vm-errors-9773a98c0112ab7f lib-near-vm-errors.json near-vm-logic-61353255cc8e550f lib-near-vm-logic.json num-bigint-10cada73a2856123 run-build-script-build-script-build.json num-bigint-ba46fa44fc1222cd build-script-build-script-build.json num-bigint-da03afbaff77d9c6 lib-num-bigint.json num-integer-51afd3190b5476b7 build-script-build-script-build.json num-integer-bc3d41f9e551238c run-build-script-build-script-build.json num-integer-eff989353409442e lib-num-integer.json num-rational-47ca0984fed0294d build-script-build-script-build.json num-rational-5d04d09459d47128 lib-num-rational.json num-rational-62e125b49c275883 run-build-script-build-script-build.json num-traits-1274095eb20247e7 build-script-build-script-build.json num-traits-67c608e60482db69 run-build-script-build-script-build.json num-traits-de7bfecb7da142b4 lib-num-traits.json once_cell-1d41aa4850c22953 lib-once_cell.json once_cell-499ce9c50fdb2373 lib-once_cell.json opaque-debug-a3337a4b35c8c00e lib-opaque-debug.json parity-scale-codec-259df2034c319857 lib-parity-scale-codec.json parity-scale-codec-derive-3ea2009ca37dbfb9 lib-parity-scale-codec-derive.json parity-secp256k1-51329ce022143282 run-build-script-build-script-build.json parity-secp256k1-7b9f7592437e7b25 build-script-build-script-build.json parity-secp256k1-be4a6b111dd56ac5 lib-secp256k1.json ppv-lite86-acd224a756fd208c lib-ppv-lite86.json primitive-types-97d77677dace5fc4 lib-primitive-types.json proc-macro-crate-08f4cc54b3762812 lib-proc-macro-crate.json proc-macro-crate-acf2489186e8ee50 lib-proc-macro-crate.json proc-macro2-8350f9d6b4d19055 lib-proc-macro2.json proc-macro2-865bb1b3068f8f65 build-script-build-script-build.json proc-macro2-f1805ff4ead2ec83 run-build-script-build-script-build.json quote-1aea8d08d433227e run-build-script-build-script-build.json quote-b0d5ece008a7439b build-script-build-script-build.json quote-e4b58074deba86e0 lib-quote.json radium-6dd089b3862f651e run-build-script-build-script-build.json radium-83d04fdd0665788c lib-radium.json radium-f89e6679aacd06d2 build-script-build-script-build.json rand-3d71180115d4bbec lib-rand.json rand-62bf48561efb117e lib-rand.json rand_chacha-49d234eb2ab7d978 lib-rand_chacha.json rand_chacha-e98e043695b741c6 lib-rand_chacha.json rand_core-1db78943a2e294d1 lib-rand_core.json rand_core-c1712831696859c5 lib-rand_core.json reed-solomon-erasure-7053241e968cb1b9 lib-reed-solomon-erasure.json reed-solomon-erasure-88fcd5d11b5cbe2b run-build-script-build-script-build.json reed-solomon-erasure-efe9a6831b061980 build-script-build-script-build.json ripemd-6f34b4d0df9f5022 lib-ripemd.json rustc-hex-7cde8fc5dbf5ad74 lib-rustc-hex.json rustversion-b3a61a41f09e36a6 run-build-script-build-script-build.json rustversion-c5bbcbc909b16387 build-script-build-script-build.json rustversion-e89fbe7185e070ac lib-rustversion.json ryu-6537036c019955a8 lib-ryu.json schemars-4727cd3071821eb6 lib-schemars.json schemars-60d408c2179e5ff1 build-script-build-script-build.json schemars-a738730651ae1951 run-build-script-build-script-build.json schemars_derive-c5bcd0be69d923e8 lib-schemars_derive.json semver-058cc4b94d2e30e6 run-build-script-build-script-build.json semver-0b5402e1103ab6ad build-script-build-script-build.json semver-5774ecc6d1c897d6 lib-semver.json serde-151a675f37de803d run-build-script-build-script-build.json serde-1a12892f2dc80948 run-build-script-build-script-build.json serde-59c4188c62f280b1 build-script-build-script-build.json serde-b63b511d36497849 build-script-build-script-build.json serde-d200d1d3849f8ce8 lib-serde.json serde-edcbb5573c46bb32 lib-serde.json serde_derive-de5cdc6ac5f98fc5 lib-serde_derive.json serde_derive_internals-e19d044d49d04263 lib-serde_derive_internals.json serde_json-7f934e5fff530ad4 lib-serde_json.json serde_json-a2a51b2f9075b029 build-script-build-script-build.json serde_json-be0b930d626419bf run-build-script-build-script-build.json sha2-77f6e245d374dce5 lib-sha2.json sha2-fa85d2c58677d093 lib-sha2.json sha3-379ba519360f2bba lib-sha3.json signature-3b44bc0765318baf lib-signature.json smallvec-cf249ee32454c859 lib-smallvec.json smart-default-7848465808d0bc75 lib-smart-default.json spin-1eada6c21182491e lib-spin.json static_assertions-a6e951094df62b70 lib-static_assertions.json strum-d0c9c6d4bc4bf606 lib-strum.json strum_macros-d50fb375bfb0e8f2 lib-strum_macros.json subtle-705566a687a5fcaa lib-subtle.json syn-239286cdeabdb889 run-build-script-build-script-build.json syn-7a8dc973d4ce2cb6 build-script-build-script-build.json syn-7aaecec1e42eed72 lib-syn.json syn-de40a09aba19ca96 lib-syn.json tap-eaedd486a44964e7 lib-tap.json thiserror-2edee1b7d05273f7 build-script-build-script-build.json thiserror-d70f0c6d16a46703 run-build-script-build-script-build.json thiserror-e7c77083c924884c lib-thiserror.json thiserror-impl-ca73ac90561c7bd3 lib-thiserror-impl.json time-2db548b7f2f882a3 lib-time.json toml-87e3291718f635c1 lib-toml.json toml_datetime-9eb7af51d5644087 lib-toml_datetime.json toml_edit-5f892f63ec032dcf lib-toml_edit.json typenum-4c28b1aa938baf81 run-build-script-build-script-main.json typenum-6a8b853b5be3561d lib-typenum.json typenum-7c52df23ac9e694f build-script-build-script-main.json uint-5f5583b2a7345354 lib-uint.json unicode-ident-bab0c279e5eefcef lib-unicode-ident.json version_check-9f5b1902f3f8fdcd lib-version_check.json wee_alloc-8edfc0e4af906ee2 build-script-build-script-build.json wee_alloc-a1f06f2e6d53e5c7 lib-wee_alloc.json wee_alloc-b939c7b00afe81d3 run-build-script-build-script-build.json winnow-2d4fb8a6a6b34459 lib-winnow.json wyz-65fe601d21da6e6a lib-wyz.json zeroize-77c92b98b82169e6 lib-zeroize.json zeroize_derive-0aaaf3902412ca14 lib-zeroize_derive.json zeropool-bn-0ec55c80d78bb24d lib-zeropool-bn.json build crunchy-6050ff8e1cd01d84 out lib.rs num-bigint-10cada73a2856123 out radix_bases.rs parity-secp256k1-51329ce022143282 out flag_check.c reed-solomon-erasure-88fcd5d11b5cbe2b out table.rs thiserror-d70f0c6d16a46703 out probe.rs typenum-4c28b1aa938baf81 out consts.rs op.rs tests.rs wee_alloc-b939c7b00afe81d3 out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1ff83547db619c37 lib-borsh-derive.json borsh-derive-internal-0af7ecbbb56fc1de lib-borsh-derive-internal.json borsh-schema-derive-internal-40ee328eeaeff907 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-005de526782dea52 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-389067e0d17a886b lib-proc-macro2.json proc-macro2-91552d7284842dc5 run-build-script-build-script-build.json proc-macro2-9dd393023f0cd24b build-script-build-script-build.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-ba8ca2479ff9f03a lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-e99d75bc54c34a60 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-077bff5663e2b2d2 lib-serde_derive.json serde_derive_internals-24d6994983c07d88 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7a78de6f1f3f7005 lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json syn-bcccba9a7233ecda lib-syn.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-bf0358cd3adb8701 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-926bc4efb52aff36 lib-near-abi.json near-sdk-9a0cbbcc34ce56ba lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-0d2628256228e0df lib-schemars.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-a45d055115045e62 lib-serde.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde_json-2620b23e6f3239e9 lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs target .rustc_info.json debug .fingerprint addr2line-a7a2a6dc9c4d2738 lib-addr2line.json addr2line-b3bbf1ace01ab7ba lib-addr2line.json adler-66193f2f1cc48360 lib-adler.json adler-98adad4089b45387 lib-adler.json ahash-0ea456d44955ceb2 build-script-build-script-build.json ahash-5d7c94838520bc2f lib-ahash.json ahash-75de2a8567409b0a run-build-script-build-script-build.json aho-corasick-12457abaa8ac5451 lib-aho_corasick.json aho-corasick-d0317bbe394ba286 lib-aho_corasick.json anyhow-6b50e972e942aecd lib-anyhow.json anyhow-9fc851a2747459fb build-script-build-script-build.json anyhow-b0af997bccfbb732 run-build-script-build-script-build.json anyhow-df1f512dc23f6450 lib-anyhow.json arrayref-c13f4daf9141ff10 lib-arrayref.json arrayvec-32bfcefdbeb35525 lib-arrayvec.json arrayvec-70d595e39d07782b lib-arrayvec.json async-io-3f47d426c2d4ec1f run-build-script-build-script-build.json async-io-681552e0d4203477 lib-async-io.json async-io-d7932282d5f87a7d build-script-build-script-build.json async-io-f5f3c72209b39ef3 lib-async-io.json async-lock-6f80493d81d5555f lib-async-lock.json async-lock-d05b8589f404b6b8 lib-async-lock.json async-process-1278924fed7da356 build-script-build-script-build.json async-process-4b59c6aa77ec7bae lib-async-process.json async-process-a6f51c0e65053963 lib-async-process.json async-process-bd10c9888b8c6595 run-build-script-build-script-build.json async-trait-60d04065e81522e1 build-script-build-script-build.json async-trait-727189819593c2e5 lib-async-trait.json async-trait-f1de86bf2eadce40 run-build-script-build-script-build.json autocfg-3936825b0293837c lib-autocfg.json backtrace-0eaade4a6ed3a88d run-build-script-build-script-build.json backtrace-204645ae98a82982 lib-backtrace.json backtrace-e62e44dc7f74ae8a build-script-build-script-build.json backtrace-f42701c566ade7f2 lib-backtrace.json base64-7235a7b0e0997069 lib-base64.json base64-7f77bc7365859151 lib-base64.json binary-install-1d272d8b2d4bc231 lib-binary-install.json binary-install-acf3ee5e8caf6ede lib-binary-install.json bitflags-3fe1f0658207a730 lib-bitflags.json bitflags-a542dd06e64d0ed9 lib-bitflags.json blake2-3042a9a886fcdf87 lib-blake2.json block-buffer-102429723281fa2e lib-block-buffer.json block-buffer-20b3646e53e662e8 lib-block-buffer.json borsh-daaedce752b24254 lib-borsh.json borsh-derive-55a2b07dee72fab6 lib-borsh-derive.json borsh-derive-internal-1209d56ccd7cdfc4 lib-borsh-derive-internal.json borsh-schema-derive-internal-caba8d0f6e15e2db lib-borsh-schema-derive-internal.json bs58-a1ee981bf5fa2a05 lib-bs58.json byteorder-0acae06796085ffc lib-byteorder.json byteorder-c1f379e1522f1ef6 lib-byteorder.json bytes-81a87e13c19a7ce0 lib-bytes.json bytesize-e9bb087e1eaabb72 lib-bytesize.json bzip2-8e2a4955bf395c23 lib-bzip2.json bzip2-93c85d53b6dd4335 lib-bzip2.json bzip2-sys-09189714ac0fc6a2 build-script-build-script-build.json bzip2-sys-3e9aed9be2077d23 lib-bzip2_sys.json bzip2-sys-7ae66f80d6e0441a lib-bzip2_sys.json bzip2-sys-ce923082910ba798 run-build-script-build-script-build.json c2-chacha-f22e8ea2f9962c5e lib-c2-chacha.json cc-7f8e6df7ed2cade2 lib-cc.json cfg-if-30d7f2d28beeeb1b lib-cfg-if.json cfg-if-6efb9ad8354586a5 lib-cfg-if.json chrono-3fa85fd2f9370be6 lib-chrono.json chrono-f0b9037e45754f9b lib-chrono.json cipher-3fdc9af8c4abdfb9 lib-cipher.json concurrent-queue-e546bce5b3236302 lib-concurrent-queue.json concurrent-queue-fffc805349cd4084 lib-concurrent-queue.json convert_case-5edeb42cc79bfdbf lib-convert_case.json core-foundation-148c346af204ff5f lib-core-foundation.json core-foundation-sys-0ae7d9beeb7d3b58 lib-core-foundation-sys.json core-foundation-sys-f959c7bc0fbd4cb9 lib-core-foundation-sys.json cpufeatures-44b883175d990b02 lib-cpufeatures.json crc32fast-10a03ee41073431b lib-crc32fast.json crc32fast-17338316b03ecb72 build-script-build-script-build.json crc32fast-782cfa6aad633efc run-build-script-build-script-build.json crc32fast-83d6232eb7aa42a6 lib-crc32fast.json crossbeam-utils-2404759ffeaba164 run-build-script-build-script-build.json crossbeam-utils-be435154c5594bdc build-script-build-script-build.json crossbeam-utils-d6b3382c2de6983a lib-crossbeam-utils.json crossbeam-utils-fa4c892122cac595 lib-crossbeam-utils.json crunchy-03d172c79f89a522 build-script-build-script-build.json crunchy-8dbbd6b9b02b7472 run-build-script-build-script-build.json crunchy-db16729146e29a71 lib-crunchy.json crypto-common-fbd876bb7100e04c lib-crypto-common.json crypto-mac-2ec09d725d6bdcbd lib-crypto-mac.json curl-52419df742fcc2a7 run-build-script-build-script-build.json curl-56c57e781911d953 build-script-build-script-build.json curl-e6cd3638ccd7963c lib-curl.json curl-fde4d210f83bfe92 lib-curl.json curl-sys-2387c9ae84fad443 build-script-build-script-build.json curl-sys-675df156689eaf5a run-build-script-build-script-build.json curl-sys-a48cc69d411a797f lib-curl_sys.json curl-sys-a5b10ab6e407c661 lib-curl_sys.json curve25519-dalek-a6b44507d297ac33 lib-curve25519-dalek.json derive_more-1e43d3c0dddd77f8 lib-derive_more.json digest-4fedda34bb2d75d0 lib-digest.json digest-c73558d2412c90b0 lib-digest.json dirs-5289953f82f304c3 lib-dirs.json dirs-b2332399c008c77a lib-dirs.json dirs-d246d9e387c9d626 lib-dirs.json dirs-sys-4f07dfced413197c lib-dirs-sys.json easy-ext-7a928631cacd1e93 lib-easy-ext.json ed25519-961d1528f0b9cbc5 lib-ed25519.json ed25519-dalek-daf37eddec02b561 lib-ed25519-dalek.json encoding_rs-97253278da980b8b lib-encoding_rs.json errno-55d430bb49b11c86 lib-errno.json errno-6f1ceb392ec11201 lib-errno.json event-listener-3e834e082d699603 lib-event-listener.json event-listener-d2cc4070f21411f0 lib-event-listener.json failure-2e0704c8917e9334 lib-failure.json failure-57630223f56b67fc lib-failure.json failure_derive-2ccff6cf1903096b lib-failure_derive.json failure_derive-2dfd370069013b86 build-script-build-script-build.json failure_derive-ed2cc0fe8815306d run-build-script-build-script-build.json fastrand-21945042000b8614 lib-fastrand.json fastrand-61a884ea707936bd lib-fastrand.json filetime-514f708e7c28092d lib-filetime.json filetime-6acff76d79cf732a lib-filetime.json fixed-hash-a1bc7c00d0777795 lib-fixed-hash.json flate2-09bb716f2e78f33a lib-flate2.json flate2-84238466655ac48e lib-flate2.json fnv-61f369bd67026d2b lib-fnv.json form_urlencoded-9f95a545239a55fb lib-form_urlencoded.json fs2-551c9d96e49ef9ea lib-fs2.json fs2-eec132b17f0a4dbd lib-fs2.json futures-channel-70457b04096087ed lib-futures-channel.json futures-channel-8161ece3bff88309 build-script-build-script-build.json futures-channel-b5e74c9a2a8882f4 run-build-script-build-script-build.json futures-core-4880069ce6d7d4fe lib-futures-core.json futures-core-637c51fa7738753a lib-futures-core.json futures-core-7c62d1d43bacbe45 build-script-build-script-build.json futures-core-81425588a6104a34 run-build-script-build-script-build.json futures-io-0fdc36943930b64b lib-futures-io.json futures-io-56451cde08e0ccff lib-futures-io.json futures-lite-90a9b897bd1e4cd8 lib-futures-lite.json futures-lite-a978c6deacd9ddad lib-futures-lite.json futures-sink-cd7d3aba91022df2 lib-futures-sink.json futures-task-aae8e209a725c401 run-build-script-build-script-build.json futures-task-bcfae45115869535 lib-futures-task.json futures-task-f0f27193821c3471 build-script-build-script-build.json futures-util-05e45ae54b89b7e3 run-build-script-build-script-build.json futures-util-af8690ab43e2415f build-script-build-script-build.json futures-util-b451cd1a1d3fb189 lib-futures-util.json generic-array-14d371e49e7d702d build-script-build-script-build.json generic-array-46aa735c1d9d8d90 run-build-script-build-script-build.json generic-array-d7bfb0603b875341 lib-generic_array.json getrandom-6a73bb18c9683d61 build-script-build-script-build.json getrandom-9e4c916d47c23723 lib-getrandom.json getrandom-a020d3a53d85421e run-build-script-build-script-build.json getrandom-ba7cbda627d55e8d lib-getrandom.json gimli-540b90df25d3f7af lib-gimli.json gimli-905f4730b76c496d lib-gimli.json h2-ede3199589a75eb4 lib-h2.json hashbrown-6fde390b68c63702 lib-hashbrown.json hashbrown-acfc5120b61a2adb lib-hashbrown.json heck-f53c7857da10975a lib-heck.json hex-1e9d13052eba1fd3 lib-hex.json hex-7014142ddea3146a lib-hex.json hex-fb12a001e1673ece lib-hex.json home-70e79bf1e208cc0a lib-home.json home-dd9a2860658d53c2 lib-home.json http-3e2ff62397f376f1 lib-http.json http-body-828cd44c1e5b0683 lib-http-body.json httparse-5122b3ae9aa0cf66 build-script-build-script-build.json httparse-894fa19cc89748d7 lib-httparse.json httparse-a7971dc50238fa36 run-build-script-build-script-build.json httpdate-602c619955e29851 lib-httpdate.json hyper-eebbd5c7fd129a0d lib-hyper.json hyper-tls-9c64591e1d2eda48 lib-hyper-tls.json iana-time-zone-5410d081c355c052 lib-iana-time-zone.json iana-time-zone-7d9558b69228fb10 lib-iana-time-zone.json idna-607883d9de28b856 lib-idna.json indexmap-4ae1151602a0ebfa build-script-build-script-build.json indexmap-ac4d8e3fa78af6be run-build-script-build-script-build.json indexmap-c335e7b46797ce04 lib-indexmap.json integration-tests-a86f16a4710107d2 example-integration-tests.json io-lifetimes-137789e6c0cef531 lib-io-lifetimes.json io-lifetimes-2297924ef2da24f3 build-script-build-script-build.json io-lifetimes-87d3c94807387512 lib-io-lifetimes.json io-lifetimes-aaf689d4c531a5e7 run-build-script-build-script-build.json ipnet-49d2b817ae078a81 lib-ipnet.json is_executable-8be1ae0c9df28565 lib-is_executable.json is_executable-8e53c7fb157bcf35 lib-is_executable.json itoa-4593d874606d8289 lib-itoa.json itoa-48345fbcae012e71 lib-itoa.json lazy_static-09734c73690c4008 lib-lazy_static.json libc-214a2bac7c11d0dc run-build-script-build-script-build.json libc-32488cd1ec938c0f lib-libc.json libc-676b2d3d03a96867 lib-libc.json libc-9b3dc823f7a9bab5 build-script-build-script-build.json libz-sys-0e615782a065d3e9 build-script-build-script-build.json libz-sys-349f197e2651a175 lib-libz-sys.json libz-sys-56a4b32739940d1f lib-libz-sys.json libz-sys-66eac23cdd080393 run-build-script-build-script-build.json lock_api-93c90a2d7d25232f lib-lock_api.json lock_api-9cd2566b088626b4 build-script-build-script-build.json lock_api-e69674ae45f236b7 run-build-script-build-script-build.json log-338a6a0d65babef3 lib-log.json log-56fbc51c6e37f2ca lib-log.json log-6d757c3576f144c9 build-script-build-script-build.json log-98002b1feec29620 run-build-script-build-script-build.json maplit-371a64dd914ac8f0 lib-maplit.json matchers-12f0d1fa1954ad16 lib-matchers.json memchr-11c18f62d730473f lib-memchr.json memchr-389910b57cbe4335 run-build-script-build-script-build.json memchr-4714c8b042f8b5f6 lib-memchr.json memchr-4af38ee6d103dcca build-script-build-script-build.json mime-9022810023c94fbd lib-mime.json miniz_oxide-4d9edb5f3cb74720 lib-miniz_oxide.json miniz_oxide-bc05e65c351dd466 lib-miniz_oxide.json miniz_oxide-f28fec6f3fb54095 lib-miniz_oxide.json miniz_oxide-f916ceccba1f0e8b lib-miniz_oxide.json mio-d32ac66cc0b73b77 lib-mio.json native-tls-2de273d0b20c8e1f run-build-script-build-script-build.json native-tls-a9a1e4ec6aa4dc49 lib-native-tls.json native-tls-ab79808a8da0a2d7 build-script-build-script-build.json near-account-id-a2fae00e8e5e5f25 lib-near-account-id.json near-chain-configs-e931afa403f2a1a9 lib-near-chain-configs.json near-crypto-ccfea3312ce1cd54 lib-near-crypto.json near-jsonrpc-client-2de1d13fd025eebe lib-near-jsonrpc-client.json near-jsonrpc-primitives-9f43293f8f6036fc lib-near-jsonrpc-primitives.json near-primitives-b7fe26aee88ca1ee lib-near-primitives.json near-primitives-core-2330edc71ce2f169 lib-near-primitives-core.json near-rpc-error-core-98e48afa2bbbd26d lib-near-rpc-error-core.json near-rpc-error-macro-4b39aec4741d72b3 lib-near-rpc-error-macro.json near-sandbox-utils-5bab78bceae790c2 lib-near-sandbox-utils.json near-sandbox-utils-a1097adba4bbf8a2 lib-near-sandbox-utils.json near-sandbox-utils-bad4fe0ebdec387e run-build-script-build-script-build.json near-sandbox-utils-e3f5aec3ef3a0c53 build-script-build-script-build.json near-units-2cae3de9389dcef5 lib-near-units.json near-units-core-18e6bff084dbd50a lib-near-units-core.json near-units-core-d017a9e5a8e269b5 lib-near-units-core.json near-units-macro-d595c250470fc3d5 lib-near-units-macro.json near-vm-errors-c68f6b0446e4f3ec lib-near-vm-errors.json nu-ansi-term-601a6a37bdddbd67 lib-nu-ansi-term.json num-bigint-10cada73a2856123 run-build-script-build-script-build.json num-bigint-ba46fa44fc1222cd build-script-build-script-build.json num-bigint-da03afbaff77d9c6 lib-num-bigint.json num-format-2068cf0ebdab7a9e lib-num-format.json num-format-f201d1ffae585654 lib-num-format.json num-integer-51afd3190b5476b7 build-script-build-script-build.json num-integer-56b736468c268bec lib-num-integer.json num-integer-bc3d41f9e551238c run-build-script-build-script-build.json num-integer-eff989353409442e lib-num-integer.json num-rational-41153e954eac8535 lib-num-rational.json num-rational-47ca0984fed0294d build-script-build-script-build.json num-rational-62e125b49c275883 run-build-script-build-script-build.json num-traits-1274095eb20247e7 build-script-build-script-build.json num-traits-67c608e60482db69 run-build-script-build-script-build.json num-traits-de7bfecb7da142b4 lib-num-traits.json num-traits-fa625c9252dddae1 lib-num-traits.json num_cpus-6f79b6c544fceb64 lib-num_cpus.json object-0f1802d79ba6814c lib-object.json object-f8923dc04437cdf5 lib-object.json once_cell-1d41aa4850c22953 lib-once_cell.json opaque-debug-a3337a4b35c8c00e lib-opaque-debug.json overload-7c98fc36f4b035aa lib-overload.json parking-d5f8f76f516a9cf2 lib-parking.json parking-e9db5325c29091eb lib-parking.json parking_lot-961f2851d3b9589c lib-parking_lot.json parking_lot_core-633dbeb51b60dbe6 lib-parking_lot_core.json parking_lot_core-8ae36ccf7c92f2a7 build-script-build-script-build.json parking_lot_core-d040a26a72d81002 run-build-script-build-script-build.json percent-encoding-90ec4037eaea3b59 lib-percent-encoding.json pin-project-7fbe076c33d77d0d lib-pin-project.json pin-project-internal-cdf7088c8128000b lib-pin-project-internal.json pin-project-lite-79635e1903c1c91f lib-pin-project-lite.json pin-project-lite-8fa643e714b4b979 lib-pin-project-lite.json pin-utils-0a5a1ee2f9186e73 lib-pin-utils.json pkg-config-57585fb7da087cf4 lib-pkg-config.json pkg-config-d63d5e5c4a522236 lib-pkg-config.json polling-2bd212e8fc1565da lib-polling.json polling-6a94869a402341f1 build-script-build-script-build.json polling-8b000b3059dce5f7 lib-polling.json polling-ca9b628a51192cfa run-build-script-build-script-build.json portpicker-ce3cf92fd368e50a lib-portpicker.json ppv-lite86-acd224a756fd208c lib-ppv-lite86.json primitive-types-4c017159e08ef253 lib-primitive-types.json proc-macro-crate-5185cda8265a3ce1 lib-proc-macro-crate.json proc-macro2-8350f9d6b4d19055 lib-proc-macro2.json proc-macro2-865bb1b3068f8f65 build-script-build-script-build.json proc-macro2-f1805ff4ead2ec83 run-build-script-build-script-build.json quote-1aea8d08d433227e run-build-script-build-script-build.json quote-b0d5ece008a7439b build-script-build-script-build.json quote-e4b58074deba86e0 lib-quote.json rand-41ef5234d8cdeb3c lib-rand.json rand-bb163950193cd8a9 lib-rand.json rand_chacha-1b8f8cafa880590f lib-rand_chacha.json rand_chacha-6d21d410286ed84c lib-rand_chacha.json rand_core-1d723a717488172e lib-rand_core.json rand_core-a35f7813fd695da0 lib-rand_core.json reed-solomon-erasure-7053241e968cb1b9 lib-reed-solomon-erasure.json reed-solomon-erasure-88fcd5d11b5cbe2b run-build-script-build-script-build.json reed-solomon-erasure-efe9a6831b061980 build-script-build-script-build.json regex-1639457a00df3103 lib-regex.json regex-6357e151cd871297 lib-regex.json regex-automata-17a1c66780e5c98c lib-regex-automata.json regex-syntax-088d9b7348bf3e4b lib-regex-syntax.json regex-syntax-2a233facf2f58ea0 lib-regex-syntax.json regex-syntax-4d92745b520fd554 lib-regex-syntax.json reqwest-3778b749393248bb lib-reqwest.json rustc-demangle-53bc639f98aacbc8 lib-rustc-demangle.json rustc-demangle-9133ab2dd80cfcc5 lib-rustc-demangle.json rustix-3f302f2ffb3eae31 lib-rustix.json rustix-a16d0770dc3b1fdf build-script-build-script-build.json rustix-eaf8eb7945fd11c0 run-build-script-build-script-build.json rustix-f9efe465378bfae9 lib-rustix.json rustversion-b3a61a41f09e36a6 run-build-script-build-script-build.json rustversion-c5bbcbc909b16387 build-script-build-script-build.json rustversion-e89fbe7185e070ac lib-rustversion.json ryu-6537036c019955a8 lib-ryu.json scopeguard-e9d909a8cd94b938 lib-scopeguard.json secp256k1-e69300941b67fd00 lib-secp256k1.json secp256k1-sys-05f2b7f38dd49186 build-script-build-script-build.json secp256k1-sys-a526daeaac6f02b5 run-build-script-build-script-build.json secp256k1-sys-b3550751b21c3152 lib-secp256k1-sys.json security-framework-d21d70e6f0cab9bb lib-security-framework.json security-framework-sys-95dcdbf9e0996565 lib-security-framework-sys.json serde-151a675f37de803d run-build-script-build-script-build.json serde-59c4188c62f280b1 build-script-build-script-build.json serde-788e9131ecdca829 lib-serde.json serde-ab8c2eca993e0330 lib-serde.json serde_derive-8703fcf8d636af3c lib-serde_derive.json serde_json-015de5968b740c43 build-script-build-script-build.json serde_json-30edeb08625446f6 run-build-script-build-script-build.json serde_json-3e93a60c21d26188 lib-serde_json.json serde_repr-ba725e542efff57b lib-serde_repr.json serde_urlencoded-d473d9b8b65972ed lib-serde_urlencoded.json sha2-2e6d2023b91ed87f lib-sha2.json sha2-30eb6b61fdfd35cb lib-sha2.json sharded-slab-624d5f6e8e0a9139 lib-sharded-slab.json signal-hook-87dfcee9beb85280 lib-signal-hook.json signal-hook-c51ccaabc7416cfb run-build-script-build-script-build.json signal-hook-cbb035faf3c07c47 lib-signal-hook.json signal-hook-f9fdc5f6668f84f7 build-script-build-script-build.json signal-hook-registry-92ee5ddc67cfb0c0 lib-signal-hook-registry.json signal-hook-registry-ca6088e2903b128f lib-signal-hook-registry.json signature-3b44bc0765318baf lib-signature.json siphasher-2899cc570f94de75 lib-siphasher.json siphasher-2cf2c88ef1e9ea48 lib-siphasher.json slab-27cf62088f284ba9 build-script-build-script-build.json slab-51f479c2c2238687 run-build-script-build-script-build.json slab-61ac6de220dc97e8 lib-slab.json slab-7209ae6f6caccadc lib-slab.json smallvec-cf249ee32454c859 lib-smallvec.json smart-default-7848465808d0bc75 lib-smart-default.json socket2-4ae22c56be93224e lib-socket2.json socket2-b51c9b68d238fd78 lib-socket2.json static_assertions-a6e951094df62b70 lib-static_assertions.json strum-d0c9c6d4bc4bf606 lib-strum.json strum_macros-d50fb375bfb0e8f2 lib-strum_macros.json subtle-705566a687a5fcaa lib-subtle.json syn-239286cdeabdb889 run-build-script-build-script-build.json syn-7a8dc973d4ce2cb6 build-script-build-script-build.json syn-7aaecec1e42eed72 lib-syn.json syn-cea191552b88af81 lib-syn.json synstructure-637792b200cfee60 lib-synstructure.json tar-c6d1a7ddc840a48d lib-tar.json tar-ea55a2fcd3371409 lib-tar.json tempfile-0936b3a4802eab19 lib-tempfile.json thiserror-08770b88f941b304 lib-thiserror.json thiserror-2edee1b7d05273f7 build-script-build-script-build.json thiserror-ba5e4b372efc4236 lib-thiserror.json thiserror-d70f0c6d16a46703 run-build-script-build-script-build.json thiserror-impl-c1ce48694dc697f7 lib-thiserror-impl.json thread_local-596e5f8ecb0fcda9 lib-thread_local.json time-3a2c84368f969fb9 lib-time.json time-8cc8ffdfea52c836 lib-time.json tinyvec-797be810e63f83dd lib-tinyvec.json tinyvec_macros-b2dbe02aa2b4a810 lib-tinyvec_macros.json tokio-0f6fddae34d3f237 build-script-build-script-build.json tokio-991383fca4dc792c run-build-script-build-script-build.json tokio-e972df057b97ed43 lib-tokio.json tokio-macros-de7e2248d6a48722 lib-tokio-macros.json tokio-native-tls-66c5ec4d1c8ec276 lib-tokio-native-tls.json tokio-retry-facf30bbf4cc2361 lib-tokio-retry.json tokio-util-d0ba0c8985c91dd1 lib-tokio-util.json toml-63e147c2075fb15c lib-toml.json tower-service-0e67c1e9ceaf62ca lib-tower-service.json tracing-50afdc4a56c55f9b lib-tracing.json tracing-attributes-acf8a08d7d5f9b24 lib-tracing-attributes.json tracing-core-e90d0a1943a86cbe lib-tracing-core.json tracing-log-9d4ef2d6acb96b42 lib-tracing-log.json tracing-subscriber-7920797aee01c9bf lib-tracing-subscriber.json try-lock-8993eefa2d7dc67c lib-try-lock.json typenum-4c28b1aa938baf81 run-build-script-build-script-main.json typenum-6a8b853b5be3561d lib-typenum.json typenum-7c52df23ac9e694f build-script-build-script-main.json uint-b35f602fa4629d3e lib-uint.json unicode-bidi-fc458b63059ef645 lib-unicode_bidi.json unicode-ident-bab0c279e5eefcef lib-unicode-ident.json unicode-normalization-d54d753ae8a421a8 lib-unicode-normalization.json unicode-xid-067c8bb269fa28cf lib-unicode-xid.json url-47875ca6d6cda754 lib-url.json uuid-d9bd3a1165ed3397 lib-uuid.json version_check-9f5b1902f3f8fdcd lib-version_check.json waker-fn-49e97223dc2b8697 lib-waker-fn.json waker-fn-fa148d811ea4d97e lib-waker-fn.json want-e5295b633014344e lib-want.json workspaces-082e1a3385ae8e56 lib-workspaces.json workspaces-4123d8dc2c3e3531 build-script-build-script-build.json workspaces-eddc0bb278b7097d run-build-script-build-script-build.json xattr-317661bea84078ac lib-xattr.json xattr-9aa55c0f362cf62b lib-xattr.json zeroize-a532bd69787bcee0 lib-zeroize.json zeroize_derive-3f55ccfd683d3f17 lib-zeroize_derive.json zip-7de3b6a6c342ed8f lib-zip.json zip-8805db79eef91ed9 lib-zip.json build anyhow-b0af997bccfbb732 out probe.rs bzip2-sys-ce923082910ba798 out include bzlib.h crunchy-8dbbd6b9b02b7472 out lib.rs num-bigint-10cada73a2856123 out radix_bases.rs reed-solomon-erasure-88fcd5d11b5cbe2b out table.rs secp256k1-sys-a526daeaac6f02b5 out flag_check.c thiserror-d70f0c6d16a46703 out probe.rs typenum-4c28b1aa938baf81 out consts.rs op.rs tests.rs package-lock.json package.json Public header file for the library. bzlib.h end bzlib.h project_6 fundraising-rust .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh neardev dev-account.env src lib.rs pledge.rs target .rustc_info.json release .fingerprint Inflector-8730f6d2663827d3 lib-inflector.json ahash-cac777993e9d965b build-script-build-script-build.json borsh-derive-1aa786d306c5c1c8 lib-borsh-derive.json borsh-derive-internal-fdd6b9a52af27294 lib-borsh-derive-internal.json borsh-schema-derive-internal-c8b97be7cb704584 lib-borsh-schema-derive-internal.json crunchy-3339cb12d15199e4 build-script-build-script-build.json near-sdk-macros-4382e9a1eebb1cc7 lib-near-sdk-macros.json proc-macro-crate-c6dd1555da6b03fc lib-proc-macro-crate.json proc-macro2-27d2bae9db49061e build-script-build-script-build.json proc-macro2-ed17d0b3dcdfa88c run-build-script-build-script-build.json proc-macro2-f8bf2d1b6e068167 lib-proc-macro2.json quote-1c9d4012b7d995ff build-script-build-script-build.json quote-bc3318684efb1de5 lib-quote.json quote-ccf14e1162ce40e7 run-build-script-build-script-build.json schemars-ef4569c068cfb633 build-script-build-script-build.json schemars_derive-d1f8d4751079b444 lib-schemars_derive.json semver-e337236863347403 build-script-build-script-build.json serde-08ea4795966cfb2b lib-serde.json serde-2768ab2a6a35a2d8 build-script-build-script-build.json serde-8183b21c56801ed0 run-build-script-build-script-build.json serde-93908ebf4d7fcd1c build-script-build-script-build.json serde_derive-2420c1ca2682249a lib-serde_derive.json serde_derive_internals-2d17e30327be0f24 lib-serde_derive_internals.json serde_json-c3b51e66a5a3d9ce build-script-build-script-build.json syn-29433870d1ccb981 run-build-script-build-script-build.json syn-7283f6c9e745af34 lib-syn.json syn-94fd4fbd11db8e1d lib-syn.json syn-b11f3a4c8a91c25e build-script-build-script-build.json toml-11dad0dc68f8e1fa lib-toml.json unicode-ident-75a2c99ab9ec1e09 lib-unicode-ident.json version_check-b7ff8418c2dc4925 lib-version_check.json wee_alloc-24f9416131d108e3 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-40506a191ef80a0e run-build-script-build-script-build.json ahash-f88edf06403bab6c lib-ahash.json base64-3a99eed7a9268149 lib-base64.json borsh-eb91121ed9edf3e9 lib-borsh.json bs58-4f1b6e0ff102d7f2 lib-bs58.json byteorder-eb41bec153969a32 lib-byteorder.json cfg-if-3f7952137123a122 lib-cfg-if.json crunchy-311b67a66b4c2826 run-build-script-build-script-build.json crunchy-31dac8e678b5b485 lib-crunchy.json dyn-clone-c06aba3734b0e373 lib-dyn-clone.json hashbrown-8d94d5cdc2d2a506 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-20dcbdc5088fc2a5 lib-hex.json itoa-ec94d6d6050b0dcc lib-itoa.json memory_units-971ef23693b4110f lib-memory_units.json near-abi-8d7e04b18eb1d7c8 lib-near-abi.json near-sdk-58f5c8f45c1f26da lib-near-sdk.json near-sys-65beade36621089a lib-near-sys.json once_cell-f00204abfdcb6096 lib-once_cell.json ryu-cec7f7c12bdfe87e lib-ryu.json schemars-2fa8d3fb7e8d66ab lib-schemars.json schemars-84731f19bc2e6b72 run-build-script-build-script-build.json semver-749ffc970013b30e run-build-script-build-script-build.json semver-80dbb4369fe2db7d lib-semver.json serde-b2aa3c3ab8226628 run-build-script-build-script-build.json serde-c5578f7d4b69ce9f lib-serde.json serde_json-e837853a86072bb9 lib-serde_json.json serde_json-f61ea741b26464b2 run-build-script-build-script-build.json static_assertions-15f93c7087a7be5b lib-static_assertions.json uint-d2bef8280e5a9385 lib-uint.json wee_alloc-47195bf10498e96b lib-wee_alloc.json wee_alloc-5d54e60acef54b29 run-build-script-build-script-build.json build crunchy-311b67a66b4c2826 out lib.rs wee_alloc-5d54e60acef54b29 out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs package-lock.json package.json

# Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # near-sc-course near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`. near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages

NEAR-DevHub_badges-contract

README.md integration-tests rs Cargo.toml src helpers.rs tests.rs ts package.json src main.ava.ts utils.ts nft-series Cargo.toml README.md build.sh misc devhub.json generalCommands.md neardev dev-account.env src approval.rs enumeration.rs events.rs internal.rs lib.rs metadata.rs nft_core.rs owner.rs royalty.rs samplecommmands.sh series.rs series_open.rs package.json

# TBD ## DevHub Badges - NFT Series Contract This project is a NEP-171 compliant Non-Fungible Token (NFT) contract that introduces the concept of a "series". A series is a collection of NFTs that share the same metadata and are owned by the same account. When a new NFT is minted, it is added to a specific series and inherits the metadata of that series. Features - Minting NFTs as part of a series - Updating series metadata - Setting allowed addresses for transfers - Transferring non-transferable tokens ### Usage #### Prerequisites - Install and configure near-cli #### Creating a Series To create a series with all the correct metadata, use the create_series function: ``` near call YOUR_CONTRACT_ID create_series '{ "id": 1, "metadata": { "title": "Series Title", "description": "Series Description", ... } }' --accountId YOUR_ACCOUNT_ID --amount 1 ``` #### Minting NFTs To mint a new NFT that is part of a series, use the nft_mint function: ```near call YOUR_CONTRACT_ID nft_mint '{"id": 1, "receiver_id": "RECEIVER_ACCOUNT_ID"}' --accountId YOUR_ACCOUNT_ID --amount 1``` #### Setting Allowed Addresses To add an address to set_allowed_addresses, use the set_allowed_addresses function: ``` near call YOUR_CONTRACT_ID set_allowed_addresses '{ "addresses": ["address1", "address2", "address3"] }' --accountId YOUR_ACCOUNT_ID ``` *Note: The set_allowed_addresses function will overwrite the existing list of allowed addresses each time it's called. It does not append to the existing list. If you want to add new addresses without removing the existing ones, you would need to include all addresses (both old and new) every time you call the function. Contributing* Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. #### License MIT

nearprotocol_wp-bounties

README.md functions.php index.php style.css

# WP Bounties Import and display GitHub bounties within a WordPress site. ## Install 1. Copy contents of `functions.php` to your theme's `functions.php` file. 2. Change repository API URL in `wpb_get_bounties_data()` function (line 8 `functions.php`). 3. Enqueue Alpine.js in your theme. 4. Add to CSS: `[x-cloak] { display: none; }` (required by Alpine) 5. Copy `bounties()` JS function to your scripts. 6. Modify markup and add styles to suit your needs. ## Notes 1. The GitHub returns up to 100 issues by default. If you need to do more you will need to update `wpb_get_bounties_data()` to get all pages of data. 2. Title format for bounty issues should be `[issue title] | Bounty: [bounty value]`. We split the string with `| Bounty:`.

hnq90_learn-web3-dapp-1

.prettierrc.json README.md components protocols avalanche components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts celo components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts near components Steps index.ts context index.ts hooks index.ts lib index.ts types index.ts polkadot components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts secret components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts solana components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts tezos components steps index.ts context index.ts hooks index.ts lib index.ts types index.ts contracts celo HelloWorld.json near Cargo.toml README.md compile.js src lib.rs polygon SimpleStorage README.md build contracts Migrations.json SimpleStorage.json migrations 1_initial_migration.js 2_deploy_contracts.js package-lock.json package.json truffle-config.js solana program Cargo.toml Xargo.toml src lib.rs tests lib.rs tezos counter.js hooks steps-hooks.ts lib constants.ts next-env.d.ts next.config.js package.json pages api avalanche account.ts balance.ts connect.ts export.ts import.ts transfer.ts celo account.ts balance.ts connect.ts deploy.ts getter.ts setter.ts swap.ts transfer.ts near balance.ts check-account.ts connect.ts create-account.ts deploy.ts getter.ts keypair.ts setter.ts transfer.ts polkadot account.ts balance.ts connect.ts deposit.ts estimate.ts restore.ts stacking.ts transfer.ts polygon query.ts secret account.ts balance.ts connect.ts deploy.ts getter.ts setter.ts transfer.ts solana balance.ts connect.ts deploy.ts fund.ts getter.ts greeter.ts keypair.ts setter.ts transfer.ts tezos account.ts balance.ts connect.ts deploy.ts getter.ts setter.ts transfer.ts public figment-learn-compact.svg vercel.svg tsconfig.json types index.ts polygon-types.ts utils avalanche-utils.ts colors-utils.ts datahub-utils.ts polygon-utils.ts tracking-utils.ts

# Pathway Smart Contract A [smart contract] written in [Rust] for [figment pathway] # Quick Start Before you compile this code, you will need to install Rust with [correct target] # Exploring The Code 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [rust]: https://www.rust-lang.org/ [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html # 🤔 What is `learn-web3-dapp`? We made this decentralized application (dApp) to help developers learn about Web 3 protocols. It uses TypeScript, React, and various smart contract languages. Following along with the [Figment Learn Pathways](https://learn.figment.io/pathways/), you will build up a simple web client using various JavaScript APIs to interact with different blockchain networks. Each protocol is slightly different, but we have attempted to standardize the workflow so that you can quickly get up to speed on networks like Solana, NEAR, Secret and Polygon! Learn more about [Figment](https://figment.io/). # 🧑‍💻 How to use this repo Clone the repo and install the dependencies with `yarn`: ``` git clone https://github.com/figment-networks/learn-web3-dapp.git cd learn-web3-dapp yarn ``` If you encounter any errors during this process, please join our [Discord]() for help. # 🧩 DataHub API keys To make use of the Pathway content, you will require a DataHub account and a valid API key for the protocol you wish to access via DataHub's infrastructure. [Sign up for a DataHub account](https://auth.figment.io/sign_up) and verify your email address, then visit the [DataHub Services Dashboard](https://datahub.figment.io/) and select the protocol you want to access. You will then be able to copy your personal API key. You will need to create a new file in the project root directory `~/learn-web3-dapp/.env.local`, copying the contents of the existing `.env.example` file. Your API key needs to be pasted into `.env.local` so that you can authenticate your connections with DataHub. # 💻 Running the development server Start the Next.js development server on the default port 3000 with: ``` yarn dev ``` If your setup requires a specific port to allow inbound requests, or if you already have a service running on port 3000 - you can also specify a port with the `--port` flag: ``` yarn dev --port 3001 ``` Once the server is running, you should see similar output: ``` yarn run v1.22.10 $ next dev ready - started server on 0.0.0.0:3000, url: http://localhost:3000 info - Loaded env from ~/learn-web3-dapp/.env.local info - Using webpack 5. Reason: Enabled by default https://nextjs.org/docs/messages/webpack5 event - compiled successfully ``` You can now view the running application at [http://localhost:3000](http://localhost:3000) (or whichever port you specified)! We sincerely hope you enjoy the Pathway content and thank you for using `learn-web3-dapp` to learn about blockchain protocols 🚀 -- The Figment Learn Team Based on: MetaCoin tutorial from Truffle docs https://www.trufflesuite.com/docs/truffle/quickstart SimpleStorage example contract from Solidity docs https://docs.soliditylang.org/en/v0.4.24/introduction-to-smart-contracts.html#storage 1. Install truffle (https://www.trufflesuite.com/docs/truffle/getting-started/installation) `npm install -g truffle` 2. Navigate to this directory (/contracts/polygon/SimpleStorage) 3. Install dependencies `yarn` 4. Test contract `truffle test ./test/TestSimpleStorage.sol` **Possible issue:** "Something went wrong while attempting to connect to the network. Check your network configuration. Could not connect to your Ethereum client with the following parameters:" **Solution:** run `truffle develop` and make sure port matches the one in truffle-config.js under development and test networks 5. Run locally via `truffle develop` $ truffle develop ``` migrate let instance = await SimpleStorage.deployed(); let storedDataBefore = await instance.get(); storedDataBefore.toNumber() // Should print 0 instance.set(50); let storedDataAfter = await instance.get(); storedDataAfter.toNumber() // Should print 50 ``` 6. Create Polygon testnet account - Install MetaMask (https://chrome.google.com/webstore/detail/metamask/nkbihfbeogaeaoehlefnkodbefgpgknn?hl=en) - Add a custom network with the following params: Network Name: "Polygon Mumbai" RPC URL: https://rpc-mumbai.maticvigil.com/ Chain ID: 80001 Currency Symbol: MATIC Block Explorer URL: https://mumbai.polygonscan.com 7. Fund your account from the Matic Faucet https://faucet.matic.network Select MATIC Token, Mumbai Network Enter your account address from MetaMask Wait until time limit is up, requests tokens 3-4 times so you have enough to deploy your contract 8. Add a `.secret` file in this directory with your account's seed phrase or mnemonic (you should be required to write this down or store it securely when creating your account in MetaMask). In `truffle-config.js`, uncomment the three constant declarations at the top, along with the matic section of the networks section of the configuration object. 9. Deploy contract `truffle migrate --network matic` 10. Interact via web3.js ```js const {ethers} = require('ethers'); const fs = require('fs'); const mnemonic = fs.readFileSync('.secret').toString().trim(); const signer = new ethers.Wallet.fromMnemonic(mnemonic); const provider = new ethers.providers.JsonRpcProvider( 'https://matic-mumbai.chainstacklabs.com', ); const json = JSON.parse( fs.readFileSync('build/contracts/SimpleStorage.json').toString(), ); const contract = new ethers.Contract( json.networks['80001'].address, json.abi, signer.connect(provider), ); contract.get().then((val) => console.log(val.toNumber())); // should log 0 contract.set(50).then((receipt) => console.log(receipt)); contract.get().then((val) => console.log(val.toNumber())); // should log 50 ```

AndreIglesias_Nauction

Contract Cargo.toml src lib.rs README.md

# Nauction Near Card Auction for the community

ilyar_near-lab

contract upload .rustfmt.toml Cargo.toml README.md src lib.rs package.json readme.md report concurrency lab001.md lab002.md lab003.md readme.md contract lab001.md script concurrency create-accounts.js delete-accounts.js deploy.js setup test-env.js util.js

# Near upload ```shell cargo install cargo-run-script cargo run-script build # or build-in-docker near dev-deploy source neardev/dev-account.env near --accountId $CONTRACT_NAME call $CONTRACT_NAME upload "$(printf '{"data": "%s"}' "$(head -c 98292 </dev/urandom | base64 -w0)")" --gas 300000000000000 near delete $CONTRACT_NAME $NEAR_DEV_ACCOUNT ```

khanhhuy-bkdn_staking-contract-rust

Cargo.toml build.sh src account.rs config.rs core_impl.rs internal.rs lib.rs util.rs

NguyenTrongTin1107_dMart_fe

README.md apis account.api.ts balance.api.ts index.ts nft.api.ts order.api.ts assets logos DMartIcon.svg cache index.ts components header-account header-account.module.css index.ts constants cache-prefix-keys.ts index.ts storage-keys.ts core blockchain blockchain.connector.ts index.ts near index.ts near.connector.ts components editor editor.module.css index.ts useQuillEditor.ts index.ts container.ts contants index.ts hooks index.ts useBlockchain.ts useWallet.ts useWalletAccountId.ts index.ts store blockchain.state.ts index.ts types index.ts utils cache.ts index.ts quill blots image.js quill.imageUploader.css quill.imageUploader.js db index.ts dtos account.dto.ts balance.dto.ts index.ts nft.dto.ts order.dto.ts hooks atoms index.ts use-account-list.ts use-account.ts use-app.ts use-bookmark.ts use-is-register.ts index.ts use-account-page.ts use-header.ts use-initalize.ts use-marketplace-page.ts use-mint-nft-modal.ts use-order-card.ts use-sell-nft-modal.ts use-storage-deposit-modal.ts use-storage-deposit.ts use-storage-withdraw-modal.ts use-storage-withdraw.ts layouts index.ts next-env.d.ts next.config.js package.json repos account.repo.ts balance.repo.ts index.ts nft.repo.ts order.repo.ts store account.state.ts app.state.ts index.ts styles global.css index.ts theme components button.ts index.ts index.ts tsconfig.json utils auth.utils.ts index.ts ipfs.utils.ts modal.utils.ts

This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). ## Getting Started First, run the development server: ```bash npm run dev # or yarn dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. [API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. ## Learn More To learn more about Next.js, take a look at the following resources: - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! ## Deploy on Vercel The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

hashcloak_NEAR-Vulnerabilities

Million_Small_Deposits Cargo.toml README.md src lib.rs README.md UnsafeCall Cargo.toml README.md src lib.rs error_prone_pattern Bug_1 Cargo.toml src lib.rs Bug_2 Cargo.toml src lib.rs README.md overflow Cargo.toml README.md src lib.rs phishing Cargo.toml README.md attack Cargo.toml src lib.rs src lib.rs reentrancy Cargo.toml README.md src external.rs lib.rs

# Error Prone Patterns ## **Status:** Incomplete ## [Bug 1](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/error_prone_pattern/Bug_1): ### Vulnerability: We should not replace any collections without clearing state, this will reset any metadata, such as the number of elements, leading to bugs. If you replace the collection with something with a different prefix, it will be functional, but you will lose any previous data and the old values will not be removed from storage. ## [Bug 2](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/error_prone_pattern/Bug_2): ### Vulnerability: We should not use the same prefix as another collection or there will be unexpected side effects. ### Blocker: Whenever using same prefix the contracts state are changed in a state that's it will not work any more and will show some issues regarding contracts state. # Unchecked Return Value ## **Status:** Complete ## Vulnerability: The return value of external function call is not checked. If the call fails accidentally or an attacker forces the call to fail, this may cause unexpected behaviour in the subsequent program logic. # Getting Started - Follow this [instructions](https://doc.rust-lang.org/book/ch01-01-installation.html#installation) to install rust. - Add the WASM (WebAssembly) target to our toolchain ```shell rustup target add wasm32-unknown-unknown ``` - Move to the specific directory of specific vulnerability and Compile the contract: ```bash cargo build --target wasm32-unknown-unknown --release ``` - Follow below to steps to deploy the contract on chain: - First Login your Account ```bash near login ``` - Giving Our Contract a Name ```bash near create-account CONTRACT_NAME.ACCOUNT_ID --masterAccount ACCOUNT_ID ``` - Deploy the contract ```Shell near deploy --wasmFile target/wasm32-unknown-unknown/release/<filename>.wasm --accountId CONTRACT_ID --initFunction init_function_name --initArgs '{"key": "value", "key": value}' ``` - Interacting with the contract - Calling a function ```bash near call CONTRACT_ID function_name_to_call '{"key": "value", "key": value}' --accountId ACCOUNT_ID ``` **Now you can play with the function to reproduce the issues.** # List of vulnerabilities ### [Re-Entrancy](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/reentrancy) **Status:** Incomplete ### [Overflow](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/overflow) **Status:** Complete ### [signer_account_id - phishing](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/phishing) **Status:** Complete ### [Million Small Deposits](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/Million_Small_Deposits) **Status:** Complete ### [Error Prone Patterns](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/error_prone_pattern) **Status:** Incomplete - **[Bug 1](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/error_prone_pattern/Bug_1)** - **[Bug 2](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/error_prone_pattern/Bug_2)** ### [Unchecked Return Value](https://github.com/hashcloak/NEAR-Vulnerabilities/tree/main/UnsafeCall) **Status:** Complete # signer_account_id - phishing ## **Status:** Complete ## What's the difference between predecessor_account_id and signer_account_id ? If contract A calls B, and B calls C, in C predecessor_account_id is B and signer_account_id is A. ## Vulnerability A malicious contract can deceive the owner of a contract into calling a function that only the owner should be able to call. # Re-Entrancy ## **Status:** Incomplete ## Vulnerability: Between a cross-contract call and its callback any method of your contract can be executed. Not taking this into account anyone can result in exploits. ## Reference: [re-entrancy](https://docs.near.org/develop/contracts/security/callbacks) ### Blocker: Unable to call withdraw function in between deposit and it's callback function's call to reproduce the re-entrancy bug. Need to figure out a way if the code's logic have some mistake or there is any other requirement to call the withdraw function on time. # Arithmetic Overflow ## **Status:** Complete ## Vulnerability Integers in Rust overflow / underflow without any errors, If we don't use `overflow-checks = true` in `Cargo.toml`. # Million Small Deposits Attack ## **Status:** Complete ## Vulnerability On NEAR, your contract pays for the storage it uses. This means that the more data you store, the more balance you need to cover for storage. If you don't handle these costs correctly (e.g. asking the user to cover their storage usage), then a million little deposits can drain your contract of its funds. Currently it costs ~1 Ⓝ to store 100kb. ## Reference: [Million Small Deposits](https://docs.near.org/develop/contracts/security/storage)

kikiritonk_admilogic

README.md as-pect.config.js asconfig.json assembly __test__ as-pect.d.ts index.unit.spec.ts as_types.d.ts index.ts models.ts tsconfig.json Clientes Proveedores Productos Trabajadores package-lock.json package.json

# AdmiLogic Logistica Administrativa, DeFI administrativo para gestion empresarial y venta de productos online // Nombre // Registro de Proveedores, Trabajadores, Productos y Clientes. Funciones en este contrato: ////// Proveedores ////// 1. Registro de un Proveedor. 2. Listado de proveedores 3. Buscar un proveedor por ID 4. Buscar a un proveedor por su empresa 5. Buscar a un proveedor por articulos 6. Buscar a un proveedor por su direccion 7. Buscar a un proveedor por su telefono 8. Buscar a un proveedor por su ID juridico ////// Clientes ////// 1. Registro de un Cliente 2. Listar todos los clientes 3. Buscar a cliente por su ID 4. Buscar a cliente por su direccion 5. Buscar a cliente por su nombre 6. Buscar a cliente por su telefono 7. Buscar a cliente por DNI ////// Productos ////// 1. Registro de un Producto 2. Listado de todos los productos 3. Consulta de Producto por el id 4. Consulta a producto por nombre 5. Consulta de producto por lote 6. Consulta de producto por fecha de caducidad 7. Consulta de producto por peso 8. Consulta de producto por volumen ////// Trabajadores ////// 1. Registro de trabajador 2. Listado de todos los Trabajadores 3. Consulta de trabajador por id 4. Buscar un trabajador por nombre 5. Buscar a trabajador por Numero de Seguro 6. Buscar un trabajador por puesto 7. Buscar un trabajador por el inicio de su contrato 8. Buscar un trabajador por el fin de su contrato ////// Instalacion ////// Paso 1: Prerequisitos 1. [Node.js] recomendamos v12 usar [nvm]) 2. Instalar yarn: `npm install -g yarn` 3. Instalar dependencias: `yarn install` 4. Cree una cuenta de prueba NEAR [https://wallet.testnet.near.org/] 5. Instale NEAR CLI globalmente: [near-cli] yarn install --global near-cli Paso 2: Configura NEAR CLI Configure su near-cli para autorizar su cuenta de prueba creada: near login Paso 3: Cree y realice una implementacion de desarrollo de contrato inteligente Cree el codigo del contrato inteligente de AdminLogic e implemente el servidor de desarrollo local: `yarn build` (consulte` package.json` para obtener una lista completa de `scripts` que puede ejecutar con` yarn`). Este script le devuelve un contrato inteligente provisional implementado (guardelo para usarlo mas tarde). Para desplegar el contrato generado con `yarn build` en testnet [https://wallet.testnet.near.org/], ejecutar el comando `yarn deploy` el cual nos regresa el id del contrato desplegado que usaremos para ejecutar cada uno de los metodos que contiene el contrato. /// Métodos del contrato /// Estos son algunos metodos del contrato y los siguientes comandos le permiten interactuar con los métodos del contrato inteligente utilizando NEAR CLI (para esto, debe tener implementado un contrato inteligente provisional). // Proveedores // Comando para crear Proveedores: near call $NOMBRE_DE_CONTRATO set_proveedor '{ "id_proveedor": "string", "empresa": "string", "articulos": "string", "direccion_proveedor": "string", "contacto_proveedor": "string", "rif": "string" }' --account-id <tu cuenta de testnet> Comando para consultar todos los proveedores que se registran near view $NOMBRE_DE_CONTRATO get_proveedor Comando para consultar proveedor por id: near view $NOMBRE_DE_CONTRATO get_id_proveedor '{"id_proveedor":"string"}' Comando para consultar proveedor por empresa: near view $NOMBRE_DE_CONTRATO get_empresa_proveedor '{"empresa":"string"}' Comando para consultar proveedor por articulos: near view $NOMBRE_DE_CONTRATO get_articulos_proveedor '{"articulos":"string"}' Comando para consultar proveedor por direccion: near view $NOMBRE_DE_CONTRATO get_direccion_proveedor '{"direccion_proveedor":"string"}' Comando para consultar proveedor por contacto: near view $NOMBRE_DE_CONTRATO get_contacto_proveedor '{"contacto_proveedor":"string"}' Comando para consultar proveedor por Id Juridico near view $NOMBRE_DE_CONTRATO get_rif_proveedor '{"rif":"string"}' /// Clientes /// Comando para crear un cliente: near call $NOMBRE_DE_CONTRATO set_cliente '{ "id_cliente": "string", "direccion_cliente": "string", "nombre_cliente": "string", "contacto_cliente": "string", "dni":"string" }' --account-id <tu cuenta de testnet> Comando para consultar todos los clientes near view $NOMBRE_DE_CONTRATO get_clientes Comando para consultar un cliente por su id: near view $NOMBRE_DE_CONTRATO get_id_cliente '{"id_cliente":"string"}' Comando para consultar proveedor por empresa: near view $NOMBRE_DE_CONTRATO get_direccion_cliente '{"direccion_cliente":"string"}' Comando para consultar proveedor por articulos: near view $NOMBRE_DE_CONTRATO get_nombre_cliente '{"nombre_cliente":"string"}' Comando para consultar proveedor por direccion: near view $NOMBRE_DE_CONTRATO get_contacto_cliente '{"contacto_cliente":"string"}' Comando para consultar proveedor por contacto: near view $NOMBRE_DE_CONTRATO get_dni_cliente '{"dni":"string"}' /// Productos /// Comando para registrar un producto: near call $NOMBRE_DE_CONTRATO setProducto '{ "id_producto": "string", "detalle_producto": "string", "precio": "string", "fecha_cad": "string", "lote": "string", "peso": "string", "metraje_cubico": "string" }' --account-id <tu cuenta de testnet> Comando para consultar todos los productos registrados near view $NOMBRE_DE_CONTRATO getProductos Comando para consultar un producto por id: near view $NOMBRE_DE_CONTRATO get_id_producto '{"id_producto":"string"}' Comando para consultar un producto por precio: near view $NOMBRE_DE_CONTRATO get_id_producto '{"precio":"string"}' Comando para consultar un producto por fecha de caducidad: near view $NOMBRE_DE_CONTRATO get_cad_producto '{"fecha_cad":"string"}' Comando para consultar un producto por fecha de caducidad: near view $NOMBRE_DE_CONTRATO get_lote_producto '{"lote":"string"}' Comando para consultar un producto por medidas,volumen: near view $NOMBRE_DE_CONTRATO get_metraje_producto '{"metraje_cubico":"string"}' Comando para consultar un producto por peso: near view $NOMBRE_DE_CONTRATO get_peso_producto '{"peso":"string"}' /// Trabajadores /// Comando para registrar trabajador near call $NOMBRE_DE_CONTRATO setTrabajador '{ "id_trabajador":"string", "nombre_trabajador": "string", "numero_seguro": "string", "puesto_trabajador": "string", "inicio_contrato": "string", "fin_contrato": "string" }' --account-id <tu cuenta de testnet> Comando para consultar todos los trabajadores near view $NOMBRE_DE_CONTRATO getTrabajadores Comando para consultar un trabajador por ID: near view $NOMBRE_DE_CONTRATO get_trabajador_id '{"id_trabajador":"string"}' Comando para consultar un trabajador por su nombre: near view $NOMBRE_DE_CONTRATO get_trabajador_nombre '{"nombre_trabajador":"string"}' Comando para consultar un trabajador por su numero de seguro: near view $NOMBRE_DE_CONTRATO get_trabajador_seguro '{"numero_seguro":"string"}' Comando para consultar un trabajador por puesto de trabajo: near view $NOMBRE_DE_CONTRATO get_trabajador_puesto '{"puesto_trabajador":"string"}' Comando para consultar un trabajador por inicio de contrato: near view $NOMBRE_DE_CONTRATO get_trabajador_inicio_contrato '{"inicio_contrato":"string"}' Comando para consultar un trabajador por fin de contrato: near view $NOMBRE_DE_CONTRATO get_trabajador_fin_contrato '{"fin_contrato":"string"}' /// Pruebas /// comando para ejecutar las pruebas: yarn test Mockup https://docs.google.com/document/d/1oECfD3Eo6Qpq0srWcCt5YhG-BQElFFiSYDtj2UQ62nE/edit?usp=sharing

microchipgnu_open-secret

README.md open-secret-chat .eslintrc.json README.md app api chat route.ts text-to-speech route.ts globals.css components.json lib constants.ts data fetch.ts get-blocked-nfts.ts graphql-service.ts near-rpc-functions.ts network.ts posts-graphql.ts use-graphql-query.ts fonts.ts functions schemas.ts hooks use-blocked-nfts.ts use-is-client-mounted.ts use-profile.ts types.ts utils.ts next.config.js package.json postcss.config.js public next.svg vercel.svg tailwind.config.ts tsconfig.json open-secret-contract Cargo.toml README.md neardev dev-account.env scripts calls add-metadata.sh build.sh deploy.sh init.sh mint.sh views get-metadata.sh get-public-keys.sh get-tokens-by-public-key.sh src lib.rs open-secret-dashboard .eslintrc.json README.md app globals.css components.json lib constants.ts data fetch.ts get-blocked-nfts.ts graphql-service.ts hash.ts near-rpc-functions.ts network.ts posts-graphql.ts use-graphql-query.ts fonts.ts functions schemas.ts hooks use-blocked-nfts.ts use-is-client-mounted.ts use-profile.ts types.ts utils.ts next.config.js package.json postcss.config.js public next.svg vercel.svg tailwind.config.ts tsconfig.json

# Open Secret <img width="946" alt="image" src="https://github.com/microchipgnu/open-secret/assets/12901349/0d5c50d6-0269-49f2-b793-405c66c06ced"> [YouTube Demo](https://www.youtube.com/watch?v=VawBqiXaiAg) Open Secret allows you to chat with NEAR Social accounts. We allow users to mint dynamic NFTs that control that reference on-chain private metadata. By owning an NFT, you are able to attach encrypted pieces of data and then give access to other accounts to decrypt this data. ## NEAR Protocol: Handling Private Data ### Storing Private Data in Tokens To mint a token that contains encrypted private data, the following steps are proposed: 1. **Encryption**: Used a library such as [NEAR JavaScript Encryption Box](https://github.com/NEARFoundation/near-js-encryption-box/tree/main) to encrypt the data before minting the token. 2. **Key Management**: Implemented smart contract functionality to manage encryption keys. - The contract allows adding or removing keys associated with the current owner of the token, enabling them to encrypt and decrypt the data. As a bonus we thought of adding ability for tokens to carry proof elements (using ZK), such as links to data stored on Arweave, to ensure data integrity and authenticity. ## Giving access to Private Data ### Minting and Storing Private Data Process The following process allows for the secure minting and transferring of private data through NFTs: 1. **Minter's Actions**: - The **Minter** (M) encrypts the data using their keypair (KP1) and includes a reference to this encrypted data (ED1) within the NFT, possibly pointing to an Arweave storage location. - When giving access to specific private data bits, they owner needs to decrypt and encrypt again with the viewer's public key. - Optionally, the minter may include Zero-Knowledge proofs (e.g., ZK-SNARKs) to validate certain claims about the data, like confirming it matches an Arweave hash pattern through regex verification or that the content was not changed (sha-256). ## To Do - [] Indexer (subgraph?) - [] Dashboard - [] Marketplace - [] Cont - Use-cases - [] Chat # Open Secret Mintbase template with to generate Stability.ai images and mint them to Near instantly. <img width="900" alt="image" src="https://github.com/Markeljan/open-secret/assets/12901349/eb061e45-04b6-4cd6-bb1e-7f5c1f7f39ac"> ## Getting Started First, add necessary environment variables. Next, create a contract on testnet.mintbase.xyz Deploy a proxy minter contract using this repo: [mintbase/minsta-contract](https://github.com/Mintbase/minsta-contract) Finally, add the proxy contract as a minter on your Mintbase dashboard. **Note if deploying to prod this requires pro or higher on vercel to support serverless functions > 15 seconds Run the development server: ```bash pnpm dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. ## Deploy on Vercel The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - make sure to add your environment variables Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. . # Minsta Proxy Minter NEAR Contract This smart contract on the NEAR network is designed to handle minting functionality through proxy minters. It provides a way to mint Non-Fungible Tokens (NFTs) through specified minters while keeping track of the latest minter for each NFT contract. ## Contract Structure ### MinstaProxyMinter - `latest_minters`: Lookup map that keeps track of the latest minter for each NFT contract ID. - `mint`: A method that takes metadata and NFT contract ID to mint NFTs, payable and callable. - `cb_mint`: A private callback method for handling successful minting. - `get_latest_minter`: A view method to get the latest minter for a given NFT contract ID. # Quickstart 1. Make sure you Rust installed. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract Compile and deploy the contract in the NEAR testnet by running: ```bash sh ./scripts/build # cargo build --target wasm32-unknown-unknown --release ``` Check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Minting an NFT To mint an NFT, you will need to call the `mint` method. Make sure to specify the metadata and NFT contract ID: ```bash # Use near-cli to mint an NFT near call <dev-account> mint '{"metadata":"<metadata>","nft_contract_id":"<nft_contract_id>"}' --accountId <dev-account> --amount <amount> ``` <br /> ## 3. Retrieve the Latest Minter You can get the latest minter for a given NFT contract ID: ```bash # Use near-cli to get the latest minter near view <dev-account> get_latest_minter '{"nft_contract_id":"<nft_contract_id>"}' ``` <br /> ## Note Please replace `<dev-account>`, `<metadata>`, `<nft_contract_id>`, and `<amount>` with appropriate values as needed. Ensure that the account calling the `mint` method has the necessary funds to cover the associated costs, as this is a payable function. --- # Open Secret Mintbase template with to generate Stability.ai images and mint them to Near instantly. <img width="900" alt="image" src="https://github.com/Markeljan/open-secret/assets/12901349/eb061e45-04b6-4cd6-bb1e-7f5c1f7f39ac"> ## Getting Started First, add necessary environment variables. Next, create a contract on testnet.mintbase.xyz Deploy a proxy minter contract using this repo: [mintbase/minsta-contract](https://github.com/Mintbase/minsta-contract) Finally, add the proxy contract as a minter on your Mintbase dashboard. **Note if deploying to prod this requires pro or higher on vercel to support serverless functions > 15 seconds Run the development server: ```bash pnpm dev ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. ## Deploy on Vercel The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - make sure to add your environment variables Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. .

NEAR-Edu_near-snippets

.github workflows add-snippets.yml README.md babel.config.js examples.json package.json postcss.config.js public index.html snippets basic-number-types.md boolean-basic-type.md fungibletoken-metadata-struct.md i8-basic-type.md increment-storage-with-if-let.md lookupmap-insert.md match-with-promiseresult.md multiple-vector-pushes.md processing-transactions-and-sending-receipts.md src composables examples.js near.js topics.js main.js router.js services db.js examples.js near.js topics.js utils markdown.js store-snippets.js tailwind.config.js

# NEAR Snippets NEAR Snippets is a project to teach people Rust through an exploration of NEAR smart contracts. You can see it live at [near-snippets.com](https://near-snippets.com). ## Adding Snippets To create a new snippet add a markdown file under the snippets directory. Each snippet must include yaml front matter: ```yaml --- title: YOUR TITLE tags: [tag1, tag2, tag3] topics: [topic1, topic2] repo: GITHUB REPO sdk: language: rust version: near-sdk-rs@SDK_VERSION difficulty: near: 1-3 language: 1-3 --- ``` Under the front matter write markdown blocks to explain snippets. Code snippets can be imported using a markdown code black followed by a github permalink url. ## Development To get started: * `yarn install` * `yarn server` * navigate to [localhost:8080](http://localhost:8080)

MintCulture_MinCulture_FrontEnd

App.js assets global.css logo-black.svg logo-white.svg components Header.js Main.js Nav.js NavBtn.js mains Home.js Profile.js Streaming.js fonts Noto_Sans_KR OFL.txt index.html index.js near-wallet.js package-lock.json package.json proxy.js recoil recoilState.js start.sh styles Button.js Div.js GlobalStyle.js H1.js Img.js P.js style.js ui-components.js

h-4vok_ubiquity-mint-live-monitor

README.md build_npmrc.sh docker-compose.yml package.json public index.html manifest.json robots.txt src background.css components atoms CircularProgressIcon.css pages Errors 404.test.js gradientShadow.css index.css index.js lib constants index.js pages index.js delay.js distiller.js formatting numberFormat.js global globalState.js index.js observer.js monitor index.js monitor.js monitorContext.js useMonitor.js withMonitor.js nftDiscovery.js nftHandler index.js nftHandler.js nftHandlerContext.js useNFTHandler.js withNFTHandler.js logo.svg reportWebVitals.js setupTests.js

# Ubiquity Mint Live Monitor - Proof of Concept Link to deployed demo: https://ubiquity-mint-monitor-poc.netlify.app/ - Check last section for a guide on testing We are always looking for ways to produce innovative tools for the NFT space in the Solana blockchain, and we have been researching ERC20 blockchains for a while. We have been planning to build a cross-chain NFT monitor and fraud analyzer that would not require you to connect your wallet. Ubiquity API has now appeared. It's functionality support is still under development, especially for Solana, so we depend on other third party APIs until Ubiquity API can expand its support. However, this prototype of our platform idea is a good first example to show how easy it would be to use Ubiquity API in conjunction to other market APIs to build very fast, concrete and reliable solutions for the NFT space. # Hackathon participants ### Nathaniel Acton Marketing and Business Lead - Twitter: https://twitter.com/nateacton - Telegram: @nateacton ### Christian Guzman Product design and software engineer - Github: https://github.com/h-4vok - Telegram: @h_4vok ### German Dario Software engineering lead - Github: https://github.com/germangp088 - Telegram: @germangp088 # About the team Our team is also comprised of 4 additional developers, 2 marketing associates, 2 content managers and an array of freelance providers. However, for this particular project only the three of us have participated as the team is busy building other products. # Technologies used We developed by PoC for Solana where we have the most experience. We used the following technologies. ## List of technologies ### Frontend - ReactJS - Material UI - Axios ### APIs - Ubiquity API for Solana - Solscan API ## How is technology used We are using the Material UI layout library to quickly build layouts that are mobile responsive while also utilizing the very known styling of Material UI which is also known to end users. ReactJS is obviously the underlaying library supporting all the rendering and instrumentation of all of our pages. But this project would not be complete without interacting with the APIs. For Ubiquity API we are using the official @ubiquity/ubiquity-ts-client library from the official ubiquity npm registry (you will need to build the .npmrc file for this to work locally). We are using AXIOS to interact with the Solscan API in order to obtain the owner of an NFT, the metadata and the image. This could be easily achieved with Ubiquity API but the NFT APIs currently are not supporting Solana. ## Specific places where @ubiquity/ubiquity-ts-client is used Please head to the monitor.js file under src/lib/monitor - Line 65 - Where we use Ubiquity API to understand which is the latest block number in the solana blockchain - Line 80 - Most importantly, we use the Ubiquity API to obtain all the transactions within a specific block number ## How our application works and leverages Ubiquity API Now that we understand where all the tech stack and where Ubiquity API is used, its time to understand how this prototype of a mint monitor work. We say prototype, as in a real life scenario more complexity and features would be taken into consideration. When the user types a block number in the home page, or leaves the textbox blank, and clicks on GO, we will determinate which block number the user wants to start scanning from. Here our live monitor starts and an algorithm can be observed in line 19 of the monitor.js file. Here we define in which block we will begin our search and then we will obtain such block. This block contains all of its transactions but it does not have all the data. However, we do not want to query the transaction data of every single transaction in this block as this would consume enormous resources. Once the data is obtained, we send the block to the Distiller which is in the distiller.js file under src/lib. Distiller loops quickly through the data and analyzes its contents. This is a very short and simple version of what the distiller would be, but it is good enough for the prototype. In this particular case we have identified a pattern where all NFT mints in Solana have exactly 6 events and the type of the second event is "create_account". When a transaction fulfills this criteria it does not immediatelly mean that this is an NFT mint, but all NFT mints have to succeed this criteria. All transactions like this are marked as transaction candidates and sent over to the NftDiscovery. NftDiscovery is in nftDiscovery.js under src/lib. This object receives these transaction candidates and now, having a reduced subset of the block's transactions, it uses the Solscan API to retrieve this element as if it were an NFT. To do this, we have identified that the NFT token address is in the destination field of the second even of the transaction (which is, if you remember, the "create_account" event). Using the Solscan API we obtain the data of the NFT in JSON format. If this were to be a valid NFT then we will be able to find the location of the json metadata of this NFT under data.data.metadata.data.uri Using this URL, we run a simple GET with Axios and retrieve this JSON metadata. This contains, among other things, the name and the visual resource's uri of the NFT. Finally we want to know who is the current owner of the token. We leverage Solscan again and use their specific API for this. Once all is done, the data is put into a model and sent to the Observer. The Observer can be found in observer.js under src/lib/global. The Observer lives globally within the application regardless of which route you started the application at, and will emit events every time it receives an NFT. These events are being listened to by the NFTHandler (you will see in this prototype that the Observer knows the NFTHandler. In a real life application there would be a complete decoupling) which in turn takes care of drawing every NFT information on the screen, allowing the user to interact with it as soon as possible. Our algorithm goes back to the Monitor which will now work on the next block until all blocks have been checked, at which point it will retrieve the information of what is the newest latest block using the Ubiquity API, and proceed to loop again. # About the coding practices This was a quick prototype so please do not expect the best practices, nor SOLID principles nor Atomic Design, which are partially concepts we always use in non-prototype projects. As we have mentioned in other sections, a real life application would require better attention to detail. # This is not Solana exclusive Our algorithm and design patterns using the Monitor, Distiller, NftDiscovery, Observer and NFTHandler are quite generic. We would need to build an abstract family interface of these and then potentially have specific implementations for ERC20 compatible blockchains, Solana and NEAR, which are all of the important players in the NFT space. While implementation will change between blockchains, the algorithm is likely to stay untouched. Potentially classes like Monitor, Observer and NFTHandler will be the same. We would also have to build our own data model for representing NFTs as every blockchain has a different way of structuring this data. This is something the users and the UI should not care about. # Recommended block numbers for testing: The live monitor will pick anything from the current block if you input nothing on the home page. However, it's possible that there are no mintings happening at the time of monitoring. Here are a couple of block numbers where we now there have been several active mints at the same time. - 119798911 - 119798937 # Testing our application Please go to https://ubiquity-mint-monitor-poc.netlify.app/ for a deployed version of this prototype. ## Home page In the home page you will be asked to type the block number you wish to start monitoring from. _This is not something the real users would be doing_ but it is a way for us to have a quick testing scenario. Real users would be accesing our data live without the need to worry about block numbers or other blockchain intrisicancies. We recommend using the block numbers we have quoted above which have been very active. However, you are welcome to try not typing anything which will start monitoring the blockchain at the current moment. Once you click GO the monitor will begin ## Monitoring The monitor will be exploring the blockchain in search of NFTs. Soon, NFTs will start popping up and have its information displayed for you. If you click on the NFT anywhere you will have a popup with more detailed info of this NFT, who is the current owner, what is the metadata of the element and an option to share this NFT in Twitter. - Note: A lot more can and will be done. The idea is to identify trends, identify frauds, be able to catch a mint that is going to be successful while its happening, etc. Our business presentation includes a myriad of features that be built around this. ## Restarting Since this is a prototype, we did not put a lot of effort in making it easy to restart the monitor. This would not be a functionality that users will need anyway. We recommend you navigate again to the home page at https://ubiquity-mint-monitor-poc.netlify.app/#/ and then click F5 (otherwise it won't really reset as we are using ReactJS).

lunarpulse_near_status_contract_rs

.github dependabot.yml workflows tests.yml .gitpod.yml .travis.yml Cargo.toml README-Gitpod.md README-Windows.md README.md borsh.js frontend App.js config.js index.html index.js integration-tests rs Cargo.toml src tests.rs ts main.ava.ts package.json src lib.rs

Status Message ============== [](https://gitpod.io/#https://github.com/near-examples/rust-status-message) <!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page --> This smart contract saves and records the status messages of NEAR accounts that call it. Windows users: please visit the [Windows-specific README file](README-Windows.md). ## Prerequisites Ensure `near-cli` is installed by running: ``` near --version ``` If needed, install `near-cli`: ``` npm install near-cli -g ``` Ensure `Rust` is installed by running: ``` rustc --version ``` If needed, install `Rust`: ``` curl https://sh.rustup.rs -sSf | sh ``` Install dependencies ``` npm install ``` ## Quick Start To run this project locally: 1. Prerequisites: Make sure you have Node.js ≥ 12 installed (https://nodejs.org), then use it to install yarn: `npm install --global yarn` (or just `npm i -g yarn`) 2. Run the local development server: `yarn && yarn dev` (see package.json for a full list of scripts you can run with yarn) Now you'll have a local development environment backed by the NEAR TestNet! Running yarn dev will tell you the URL you can visit in your browser to see the app. ## Building this contract To make the build process compatible with multiple operating systems, the build process exists as a script in `package.json`. There are a number of special flags used to compile the smart contract into the wasm file. Run this command to build and place the wasm file in the `res` directory: ```bash npm run build ``` **Note**: Instead of `npm`, users of [yarn](https://yarnpkg.com) may run: ```bash yarn build ``` ### Important If you encounter an error similar to: >note: the `wasm32-unknown-unknown` target may not be installed Then run: ```bash rustup target add wasm32-unknown-unknown ``` ## Using this contract ### Web app Deploy the smart contract to a specific account created with the NEAR Wallet. Then interact with the smart contract using near-api-js on the frontend. If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org). Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command: ``` near login ``` Deploy the contract to your NEAR account: ```bash near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME ``` Build the frontend: ```bash npm start ``` If all is successful the app should be live at `localhost:1234`! ### Quickest deploy Build and deploy this smart contract to an development account. This development account will be created automatically and is not intended to be permanent. Please see the "Standard deploy" section for creating a more personalized account to deploy to. ```bash near dev-deploy --wasmFile res/status_message.wasm --helperUrl https://near-contract-helper.onrender.com ``` Behind the scenes, this is creating an account and deploying a contract to it. On the console, notice a message like: >Done deploying to dev-1234567890123 In this instance, the account is `dev-1234567890123`. A file has been created containing the key to the account, located at `neardev/dev-account`. To make the next few steps easier, we're going to set an environment variable containing this development account id and use that when copy/pasting commands. Run this command to the environment variable: ```bash source neardev/dev-account.env ``` You can tell if the environment variable is set correctly if your command line prints the account name after this command: ```bash echo $CONTRACT_NAME ``` The next command will call the contract's `set_status` method: ```bash near call $CONTRACT_NAME set_status '{"message": "aloha!"}' --accountId $CONTRACT_NAME ``` To retrieve the message from the contract, call `get_status` with the following: ```bash near view $CONTRACT_NAME get_status '{"account_id": "'$CONTRACT_NAME'"}' ``` ### Standard deploy In this option, the smart contract will get deployed to a specific account created with the NEAR Wallet. If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.testnet.near.org). Make sure you have credentials saved locally for the account you want to deploy the contract to. To perform this run the following `near-cli` command: ``` near login ``` Deploy the contract: ```bash near deploy --wasmFile res/status_message.wasm --accountId YOUR_ACCOUNT_NAME ``` Set a status for your account: ```bash near call YOUR_ACCOUNT_NAME set_status '{"message": "aloha friend"}' --accountId YOUR_ACCOUNT_NAME ``` Get the status: ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}' ``` Note that these status messages are stored per account in a `HashMap`. See `src/lib.rs` for the code. We can try the same steps with another account to verify. **Note**: we're adding `NEW_ACCOUNT_NAME` for the next couple steps. There are two ways to create a new account: - the NEAR Wallet (as we did before) - `near create_account NEW_ACCOUNT_NAME --masterAccount YOUR_ACCOUNT_NAME` Now call the contract on the first account (where it's deployed): ```bash near call YOUR_ACCOUNT_NAME set_status '{"message": "bonjour"}' --accountId NEW_ACCOUNT_NAME ``` ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "NEW_ACCOUNT_NAME"}' ``` Returns `bonjour`. Make sure the original status remains: ```bash near view YOUR_ACCOUNT_NAME get_status '{"account_id": "YOUR_ACCOUNT_NAME"}' ``` ## Testing To test run: ```bash cargo test --package status-message -- --nocapture ```

leanhtoanqsb_near-frontend-2

README.md index.html next-env.d.ts next.config.js package-lock.json package.json public vite.svg src assets react.svg lib dbConnect.ts type.d.ts model Kyc.ts pages api kyc [id].ts index.ts utils colors.ts near.interface.ts wallet.ts tsconfig.json

# near-frontend-2

Peersyst_xrp-evm-safe-transaction-service

.github ISSUE_TEMPLATE bug_report.md feature_request.md PULL_REQUEST_TEMPLATE.md dependabot.yml workflows cla.yml python.yml .vscode launch.json settings.json CONTRIBUTORS.txt README.md config __init__.py celery_app.py settings __init__.py base.py local.py production.py test.py urls.py wsgi.py docker-compose.dev.yml docker-compose.yml docker db 00-init.sql 01-add-genesis-safe.sql web celery flower run.sh scheduler run.sh worker run.sh run_web.sh docker_instructions.txt docs __init__.py conf.py gunicorn.conf.py manage.py requirements-dev.txt requirements-test.txt requirements.txt run_tests.sh safe_transaction_service __init__.py analytics __init__.py apps.py serializers.py services __init__.py analytics_service.py tasks.py tests __init__.py test_tasks.py test_views.py test_views_v2.py urls.py urls_v2.py views.py views_v2.py contracts __init__.py admin.py apps.py decoder_abis __init__.py aave.py admin_upgradeability_proxy.py balancer.py chainlink.py compound.py gnosis_protocol.py gnosis_safe.py idle.py maker_dao.py open_zeppelin.py request.py sablier.py sight.py snapshot.py timelock.py management __init__.py commands __init__.py index_contracts_with_metadata.py migrations 0001_initial.py 0002_auto_20210119_1136.py 0003_auto_20210122_1352.py 0004_auto_20210125_0925.py 0005_alter_contractabi_id.py 0006_contractabi_abi_hash.py 0007_contract_trusted_for_delegate_call.py 0008_ethereum_address_field_v2.py 0009_alter_contractabi_abi_hash.py 0010_alter_contract_logo.py __init__.py models.py pagination.py serializers.py signals.py tasks.py tests __init__.py factories.py test_admin.py test_commands.py test_models.py test_tasks.py test_tx_decoder.py test_views.py tx_decoder.py urls.py views.py history __init__.py admin.py apps.py clients __init__.py ens_client.py exceptions.py filters.py helpers.py indexers __init__.py abis __init__.py gnosis.py erc20_events_indexer.py ethereum_indexer.py events_indexer.py internal_tx_indexer.py proxy_factory_indexer.py safe_events_indexer.py tx_processor.py management __init__.py commands __init__.py add_webhook.py bind_confirmations.py check_index_problems.py decode_txs_again.py export_multisig_tx_data.py fix_ethereum_logs.py fix_ethereum_txs.py index_erc20.py process_txs_again.py reindex_erc20.py reindex_master_copies.py send_slack_notification.py setup_service.py migrations 0001_initial.py 0002_auto_20190725_0857.py 0003_auto_20191107_1459.py 0004_auto_20191118_1001.py 0005_multisigtransaction_failed.py 0006_auto_20200113_1204.py 0007_auto_20200122_1305.py 0008_ethereumtx_logs.py 0009_multisigtransaction_origin.py 0010_auto_20200226_1508.py 0011_auto_20200303_0956.py 0012_moduletransaction.py 0013_multisigtransaction_fix_failed.py 0014_auto_20200327_0954.py 0015_auto_20200327_1233.py 0016_multisigconfirmation_signature_type.py 0017_safecontractdelegate.py 0018_multisigtransaction_trusted.py 0019_transactions_data_none.py 0020_safemastercopy_version.py 0021_moduletransaction_failed.py 0022_auto_20200903_1045.py 0023_auto_20200924_0841.py 0024_auto_20201014_1523.py 0025_auto_20201015_1147.py 0026_auto_20201030_1355.py 0027_remove_errored_internal_txs_20201112_1547.py 0028_auto_20201112_1613.py 0029_auto_20201118_1015.py 0030_auto_20210203_1541.py 0031_webhook_new_safe.py 0032_webhook_new_module_transaction.py 0033_auto_20210318_1654.py 0034_webhook_new_outgoing_transaction.py 0035_safemastercopy_deployer.py 0036_fix_exec_from_module.py 0037_fix_failed_module_transactions.py 0038_safestatus_guard.py 0039_safel2mastercopy_20210519.py 0040_auto_20210607_1007.py 0041_auto_20210729_0916.py 0042_safestatus_history_saf_address_1c362b_idx.py 0043_auto_20210927_1515.py 0044_reprocess_module_txs.py 0045_erc20transfer_erc721transfer.py 0046_delete_ethereumevent.py 0047_auto_20211102_1659.py 0048_block_number_token_transfers_20211126_1443.py 0049_block_number_internaltx_20211129_1111.py 0050_ethereum_address_field_v2_20211201_1507.py 0051_ethereum_address_field_v2_update.py 0052_keccak256_field_20211209_1628.py 0053_alter_webhook_address.py 0054_webhook_authorization.py 0055_alter_multisigtransaction_options.py 0056_alter_multisigconfirmation_signature.py 0057_alter_webhook_authorization.py 0058_alter_webhook_url.py 0059_auto_20220408_1020.py 0060_add_eip1559_fields_20220419_0955.py 0061_alter_internaltx_block_number.py 0062_add_safe_last_status_20220429_0922.py 0063_alter_internaltx__from.py 0064_auto_20220523_0919.py 0065_safelaststatus_history_saf_enabled_020fea_gin.py 0066_auto_20220628_1125.py 0067_auto_20220705_1545.py 0068_alter_multisigtransaction_origin.py 0069_indexingstatus_and_more.py __init__.py models.py pagination.py serializers.py services __init__.py balance_service.py collectibles_service.py index_service.py reorg_service.py safe_service.py transaction_service.py webhooks.py signals.py tasks.py tests __init__.py clients __init__.py test_ens_client.py factories.py mocks __init__.py mocks_ethereum_tx.py mocks_internal_tx_indexer.py traces.py test_balance_service.py test_collectibles_service.py test_commands.py test_delegate_signature_helper.py test_erc20_events_indexer.py test_index_service.py test_internal_tx_indexer.py test_migrations.py test_models.py test_proxy_factory_indexer.py test_reorg_service.py test_safe_events_indexer.py test_safe_service.py test_signals.py test_tasks.py test_transaction_service.py test_tx_processor.py test_views.py test_views_v2.py utils.py urls.py urls_v2.py utils.py views.py views_v2.py notifications __init__.py admin.py apps.py clients __init__.py firebase_client.py migrations 0001_initial.py 0002_auto_20200806_1534.py 0003_firebasedeviceowner.py 0004_alter_firebasedeviceowner_id.py 0005_ethereum_address_field_v2.py __init__.py models.py serializers.py tasks.py tests __init__.py factories.py test_firebase_client.py test_models.py test_tasks.py test_views.py urls.py utils.py views.py safe_messages __init__.py admin.py apps.py management __init__.py commands __init__.py migrations 0001_initial.py __init__.py models.py pagination.py serializers.py signals.py tasks.py tests __init__.py factories.py mocks.py test_models.py test_views.py urls.py utils.py views.py static safe logo.svg templates drf-yasg swagger-ui.html tokens __init__.py admin.py apps.py clients __init__.py binance_client.py coingecko_client.py coinmarketcap_client.py exceptions.py kleros_abi.py kleros_client.py kraken_client.py kucoin_client.py zerion_client.py constants.py filters.py management __init__.py commands __init__.py add_token.py update_tokens_from_coinmarketcap.py migrations 0001_initial.py 0002_auto_20200903_1045.py 0003_auto_20201222_1053.py 0004_ethereum_address_field_v2_20211201_1512.py 0005_add_logo_file_20220201_1335.py 0006_auto_20220214_1629.py 0007_alter_token_logo.py 0008_alter_token_copy_price.py 0009_token_token_spam_idx.py __init__.py models.py serializers.py services __init__.py price_service.py signals.py tasks.py tests __init__.py clients __init__.py test_clients.py test_coingecko_client.py test_coinmarketcap_client.py test_kleros_client.py test_zerion_client.py factories.py test_admin.py test_commands.py test_models.py test_price_service.py test_tasks.py test_views.py urls.py views.py utils __init__.py admin.py auth.py celery.py ethereum.py loggers.py redis.py serializers.py tasks.py tests __init__.py test_loggers.py test_tasks.py utils.py scripts autodeploy.sh benchmark_keccak.py benchmark_node.py deploy_docker.sh

 [](https://coveralls.io/github/safe-global/safe-transaction-service?branch=master) [](https://github.com/pre-commit/pre-commit)   [](https://hub.docker.com/r/safeglobal/safe-transaction-service) # Safe Transaction Service Keeps track of transactions sent via Safe contracts. It uses events and [tracing](https://openethereum.github.io/JSONRPC-trace-module) to index the txs. Transactions are detected in an automatic way, so there is no need of informing the service about the transactions as in previous versions of the *Transaction Service*. Transactions can also be sent to the service to allow offchain collecting of signatures or informing the owners about a transaction that is pending to be sent to the blockchain. [Swagger (Mainnet version)](https://safe-transaction-mainnet.safe.global/) [Swagger (Göerli version)](https://safe-transaction-goerli.safe.global/) ## Index of contents - [Docs]( https://docs.gnosis-safe.io/backend/service-architecture) ## Setup for development Use a virtualenv if possible: ```bash python -m venv venv ``` Then enter the virtualenv and install the dependencies: ```bash source venv/bin/activate pip install -r requirements-dev.txt pre-commit install -f cp .env.dev .env ./run_tests.sh ``` ## Setup for development using docker ```bash docker-compose -f docker-compose.yml -f docker-compose.dev.yml up ``` ## Setup for production (event indexing) Since **version 3.0.0** transaction service can be configured to rely on **event indexing** when [SafeL2 version](https://github.com/safe-global/safe-contracts/blob/v1.3.0/contracts/GnosisSafeL2.sol) is used. **Only contracts from v1.3.0 onwards with L2 events will be indexed.** An example environment file can be used for the L2 setup: ```bash cp .env.l2.sample .env ``` Edit `.env` file to add `ETHEREUM_NODE_URL` (on the example a `Polygon` public node is used) and remember to modify `DJANGO_SECRET_KEY` to **use a strong key**. The rest of the configuration does not need to be modified. Then: ```bash docker-compose build --force-rm docker-compose up ``` If the network is not supported yet [contracts can be deployed using the deployment instructions ](https://github.com/safe-global/safe-contracts/tree/v1.3.0/contracts) and then a PR should be provided to this service [adding the deployment block number and the address (address will be the same for every network)](safe_transaction_service/history/management/commands/setup_service.py). Only `ProxyFactory` and `GnosisSafeL2` must be configured. `+L2` must be added to the Safe contract versions, so the service knows the contract can be indexed using events. For more parameters check [base.py](config/settings/base.py) file. ## Setup for production (tracing mode) This is the recommended configuration for running a production Transaction service. `docker-compose` is required for running the project. ``bash cp .env.tracing.sample .env `` Configure the parameters needed on `.env`. These parameters **need to be changed**: - `DJANGO_SECRET_KEY`: Use a **strong key**. - `ETHEREUM_NODE_URL`: Http/s address of a ethereum node. It can be the same than `ETHEREUM_TRACING_NODE_URL`. - `ETHEREUM_TRACING_NODE_URL`: Http/s address of an OpenEthereum node with [tracing enabled](https://openethereum.github.io/JSONRPC-trace-module). If you don't want to use `trace_filter` for the internal tx indexing and just rely on `trace_block`, set: - `ETH_INTERNAL_NO_FILTER=1` For more parameters check [base.py](config/settings/base.py) file. Then: ```bash docker-compose build --force-rm docker-compose up ``` The service should be running in `localhost:8000`. You can test everything is set up: ```bash curl 'http://localhost:8000/api/v1/about/' ``` You can go to http://localhost:5555/ to check the status of the task queue, also you can configure [prometheus metrics](https://flower.readthedocs.io/en/latest/prometheus-integration.html). For example, to set up a Göerli node: Run an OpenEthereum node in your local computer: ```bash openethereum --chain goerli --tracing on --db-path=/media/ethereum/openethereum --unsafe-expose ``` Edit `.env` so docker points to the host OpenEthereum node: ``` ETHEREUM_NODE_URL=http://172.17.0.1:8545 ETHEREUM_TRACING_NODE_URL=http://172.17.0.1:8545 ``` Then: ```bash docker-compose build --force-rm docker-compose up ``` ## Setup for private network Instructions for production still apply, but some additional steps are required: - Deploy the last version of the [Safe Contracts](https://github.com/safe-global/safe-contracts) on your private network. - [Add their addresses and the number of the block they were deployed ](safe_transaction_service/history/management/commands/setup_service.py) (to optimize initial indexing). Service is currently configured to support _Mainnet_, _Rinkeby_, _Goerli_, _Kovan_, _xDai_, _Polygon_, _EWC_... - If you have a custom `network id` you can change this line `ethereum_network = ethereum_client.get_network()` to `ethereum_network_id = ethereum_client.w3.net.version` and use the `network id` instead of the `Enum`. - Only contracts that need to be configured are the **ProxyFactory** that will be used to deploy the contracts and the **GnosisSafe/GnosisSafeL2**. ## Use admin interface Services come with a basic administration web ui (provided by Django) by default on http://localhost:8000/admin/ A user must be created to get access: ```bash docker exec -it safe-transaction-service-web-1 python manage.py createsuperuser ``` ## Safe Contract ABIs and addresses - [v1.3.0](https://github.com/safe-global/safe-deployments/blob/main/src/assets/v1.3.0/gnosis_safe.json) - [v1.3.0 L2](https://github.com/safe-global/safe-deployments/blob/main/src/assets/v1.3.0/gnosis_safe_l2.json) - [Other related contracts and previous Safe versions](https://github.com/safe-global/safe-deployments/blob/main/src/assets) ## Troubleshooting ### Issues installing grpc on a Mac M1 If you face issues installing the `grpc` dependency locally (required by this project) on a M1 chip, set `GRPC_PYTHON_BUILD_SYSTEM_OPENSSL=1` and `GRPC_PYTHON_BUILD_SYSTEM_ZLIB=1` and then try to install the dependency again. ## Contributors [See contributors](https://github.com/safe-global/safe-transaction-service/graphs/contributors)

near-examples_FT-JS

.github workflows tests.yml CONTRIBUTING.md README.md babel.config.json build builder.c code.h contract.js fungible-token-helper.js fungible-token.js methods.h jsconfig.json package-lock.json package.json src ft-helper.js index.js tests main.ava.js

# FT-JS Example implementation of a [Fungible Token](https://docs.near.org/develop/relevant-contracts/ft) contract which implements storage management and testing. This is a contract-only example. ## Pre-requisites - [Node.js](https://nodejs.org/en/download/) = 16 ### Operating Systems Currently this example is only supported on Linux and Mac OS. Windows is not supported. ## Setup 1. Install dependencies ```bash npm install ``` 2. Build the contract ```bash npm run build ``` 3. Run tests ```bash npm test ``` ## Contribute If you have any questions, please [join our community on Discord](https://discord.gg/near) and ask in the `#dev-support` channel. Also make sure to read CONTRIBUTING.md before contributing.

JuEnPeHa_near-spring-third

.gitpod.yml README.md babel.config.js contract Cargo.toml README.md compile.js src approval.rs enumeration.rs events.rs internal.rs lib.rs metadata.rs mint.rs nft_core.rs royalty.rs target .rustc_info.json debug .fingerprint Inflector-a8f4e37dd556cf0f lib-inflector.json ahash-72a5e59fd1526b7d build-script-build-script-build.json autocfg-e8d96e7f2b762b9c lib-autocfg.json borsh-derive-85c0e78848d8db8d lib-borsh-derive.json borsh-derive-internal-7e897898232626f7 lib-borsh-derive-internal.json borsh-schema-derive-internal-fa8b090b13337b31 lib-borsh-schema-derive-internal.json hashbrown-29e2d33e445a3fe8 build-script-build-script-build.json indexmap-7dfb354d589d374d build-script-build-script-build.json near-sdk-macros-35c9dd0100ae2628 lib-near-sdk-macros.json proc-macro-crate-fef0bd5867d83bf5 lib-proc-macro-crate.json proc-macro2-49dd073150bc1e8a build-script-build-script-build.json proc-macro2-4e8d526cdba69d52 run-build-script-build-script-build.json proc-macro2-755220030b6adeba lib-proc-macro2.json quote-7404cf61f39c038f lib-quote.json ryu-779cb093985a02e5 build-script-build-script-build.json serde-1e16a45c3d4eae62 build-script-build-script-build.json serde-7743d3c53e8a31a9 lib-serde.json serde-ee9efa9b92557c0f run-build-script-build-script-build.json serde_derive-6a1ba2f754e150b4 lib-serde_derive.json serde_derive-d7f1afee7646f1c5 build-script-build-script-build.json serde_derive-ed6268f28ec92d28 run-build-script-build-script-build.json serde_json-a9fb65022ffa8dcc build-script-build-script-build.json syn-20c381101c96c377 lib-syn.json syn-7ed442754f82fc5a run-build-script-build-script-build.json syn-e70214b5c99efffe build-script-build-script-build.json toml-cc5bd535e6f6b53d lib-toml.json unicode-xid-745589536fdb3b82 lib-unicode-xid.json version_check-0e39a7d855ce105c lib-version_check.json wee_alloc-f4e7c3437706fb20 build-script-build-script-build.json release .fingerprint Inflector-b54742fedffdcfae lib-inflector.json ahash-bb91afde2e237338 build-script-build-script-build.json autocfg-85cf1d5be0b8d76c lib-autocfg.json borsh-derive-b8739c38d3dc7d6a lib-borsh-derive.json borsh-derive-internal-6418f5f8d4cf4b45 lib-borsh-derive-internal.json borsh-schema-derive-internal-6e1144e39705f1e7 lib-borsh-schema-derive-internal.json hashbrown-c8d9549b789ac6b2 build-script-build-script-build.json indexmap-d0cb0090b30f53a4 build-script-build-script-build.json near-sdk-macros-3e6d10cd36ce6474 lib-near-sdk-macros.json proc-macro-crate-ce9d4d5dacab2c81 lib-proc-macro-crate.json proc-macro2-1be57e94c3994a51 build-script-build-script-build.json proc-macro2-2dfa396d5217e15b lib-proc-macro2.json proc-macro2-47c9c2dbb158f654 run-build-script-build-script-build.json quote-b7926a42453023bb lib-quote.json ryu-658ac46b23b995e8 build-script-build-script-build.json serde-1eecc00d14b4110e run-build-script-build-script-build.json serde-dc15588501ffafea lib-serde.json serde-ff36856f64dbfa10 build-script-build-script-build.json serde_derive-22ba64b828a98345 lib-serde_derive.json serde_derive-940fee2ab9c58234 run-build-script-build-script-build.json serde_derive-be413dfccbc9dae4 build-script-build-script-build.json serde_json-d439f7199c5879ff build-script-build-script-build.json syn-6450f802446d8a49 lib-syn.json syn-68a9a9a93a8683bb build-script-build-script-build.json syn-8c8cb8140f06eb64 run-build-script-build-script-build.json toml-e94abd720c884a51 lib-toml.json unicode-xid-7b5e9c406f5dde09 lib-unicode-xid.json version_check-0bf72125f9f4b9d5 lib-version_check.json wee_alloc-41448b425edbd6c2 build-script-build-script-build.json rls .rustc_info.json debug .fingerprint Inflector-a8f4e37dd556cf0f lib-inflector.json ahash-1903d24a93df9150 run-build-script-build-script-build.json ahash-72a5e59fd1526b7d build-script-build-script-build.json ahash-a136cd55d53ec5cc lib-ahash.json aho-corasick-fa0b503eb5376403 lib-aho_corasick.json arrayref-92b779883f4a839c lib-arrayref.json arrayvec-ad52f33d0c083dff lib-arrayvec.json arrayvec-bd4283f6dc8cb6ea lib-arrayvec.json autocfg-e8d96e7f2b762b9c lib-autocfg.json base64-d5643b15903575b6 lib-base64.json base64-f91e443953601d03 lib-base64.json bitvec-5841f7734cfd7137 lib-bitvec.json blake2-0d83a3f19867f204 lib-blake2.json block-buffer-220d02b4d2929421 lib-block-buffer.json block-buffer-6107ca8aec6f3100 lib-block-buffer.json block-padding-8a834015f89aca37 lib-block-padding.json borsh-affc9c4c56d7cdbf lib-borsh.json borsh-derive-85c0e78848d8db8d lib-borsh-derive.json borsh-derive-internal-7e897898232626f7 lib-borsh-derive-internal.json borsh-schema-derive-internal-fa8b090b13337b31 lib-borsh-schema-derive-internal.json bs58-11dcc6dd2dbacc0e lib-bs58.json byte-slice-cast-2f731fe6454ad76e lib-byte-slice-cast.json byte-tools-57e6e74fdcb17b5e lib-byte-tools.json byteorder-0374979f24472d24 lib-byteorder.json bytesize-2c69f8d5b6c1a32a lib-bytesize.json c2-chacha-376080e85de6fc01 lib-c2-chacha.json cc-3eb0892724177b75 lib-cc.json cfg-if-2120cfe954d0c3f5 lib-cfg-if.json cfg-if-3e93dce105ba1ecd lib-cfg-if.json cfg-if-a432aff33201fefa lib-cfg-if.json chrono-d9eff9d2a3727410 lib-chrono.json cipher-19d2d24265566ba1 lib-cipher.json convert_case-a25c4144c68d7d73 lib-convert_case.json cpuid-bool-3c02b0f582f5474f lib-cpuid-bool.json crunchy-6c44371ee36a7cf9 lib-crunchy.json crunchy-74a400335b9a1a23 build-script-build-script-build.json crunchy-faf69dbf78739f0e run-build-script-build-script-build.json crypto-mac-4db669e914682f2a lib-crypto-mac.json curve25519-dalek-3d7060a424b21f27 lib-curve25519-dalek.json derive_more-c3d2ec1b6c44a8b4 lib-derive_more.json digest-578fce6a87d6ca3a lib-digest.json digest-fa76758f1fc5a2e2 lib-digest.json easy-ext-3ad30aa7aaa95a72 lib-easy-ext.json ed25519-dalek-da941b5a711ae209 lib-ed25519-dalek.json ed25519-fd34faf47084d708 lib-ed25519.json fixed-hash-d8fbe6cc0cf2ced5 lib-fixed-hash.json form_urlencoded-d1236e044f4824a8 lib-form_urlencoded.json funty-fb468bb2dda2baca lib-funty.json generic-array-329168eb2d8951e9 run-build-script-build-script-build.json generic-array-a18da0180972dfd0 lib-generic_array.json generic-array-b3a15bae3bd7dcb8 build-script-build-script-build.json generic-array-c51d244cd9a9bfcf lib-generic_array.json getrandom-1f059f9abd470400 build-script-build-script-build.json getrandom-54cac5e5dc4c6c26 lib-getrandom.json getrandom-89ae1781663ea40c run-build-script-build-script-build.json getrandom-95128205d0caa92b lib-getrandom.json greeter-0f554b11b224c376 lib-greeter.json greeter-2d8f763f60aa7923 test-lib-greeter.json greeter-a7adb2f48de6d8d9 lib-greeter.json greeter-fc676d93ab2c8942 test-lib-greeter.json hashbrown-1e175333f35d2300 lib-hashbrown.json hashbrown-29e2d33e445a3fe8 build-script-build-script-build.json hashbrown-3b862f5ff2ac6f18 run-build-script-build-script-build.json hashbrown-8a0eae45c5c8fe28 lib-hashbrown.json hashbrown-e89b22b6662d4130 lib-hashbrown.json hex-cdae7c35cd6cecda lib-hex.json idna-4a84ec5df51540bc lib-idna.json impl-codec-f85c27205dd026fd lib-impl-codec.json impl-trait-for-tuples-45c1f32913168005 lib-impl-trait-for-tuples.json indexmap-3c776aed40346d47 lib-indexmap.json indexmap-3fe13978a1dc9b3f run-build-script-build-script-build.json indexmap-7dfb354d589d374d build-script-build-script-build.json indexmap-df8cb351f7c33f76 lib-indexmap.json itoa-0b1cf39c674d78d9 lib-itoa.json itoa-331611d2ec6ae993 lib-itoa.json keccak-67af69d5aac668a1 lib-keccak.json lazy_static-ae46812994b3b675 lib-lazy_static.json libc-0f7291e603968559 run-build-script-build-script-build.json libc-bb37b703bb9d350a build-script-build-script-build.json libc-fd2b5df20b220e2b lib-libc.json matches-44e3646f69900caa lib-matches.json memchr-1474f4f283fb642a run-build-script-build-script-build.json memchr-a50d6597a861a8f7 build-script-build-script-build.json memchr-d18a1b854a1694f3 lib-memchr.json memory_units-49e26755483b9a5c lib-memory_units.json near-account-id-1f43b281daf9cc0c lib-near-account-id.json near-crypto-a57b7f27d9dec348 lib-near-crypto.json near-primitives-core-2533c29180303419 lib-near-primitives-core.json near-primitives-f133fb52433bb48b lib-near-primitives.json near-rpc-error-core-23ea6a14a5f7b2ad lib-near-rpc-error-core.json near-rpc-error-macro-85ef5ecb5206c3af lib-near-rpc-error-macro.json near-sdk-f14813d5766d275b lib-near-sdk.json near-sdk-macros-35c9dd0100ae2628 lib-near-sdk-macros.json near-sys-c59a9c53b2343855 lib-near-sys.json near-vm-errors-682c2679d6bbfa01 lib-near-vm-errors.json near-vm-logic-3273fa853b08ac2b lib-near-vm-logic.json num-bigint-44f241c9115d4d72 lib-num-bigint.json num-bigint-5e61d9ce118517c2 run-build-script-build-script-build.json num-bigint-80833f2f9084448e build-script-build-script-build.json num-integer-2c344f4afebee132 lib-num-integer.json num-integer-3776b4476f44c81d run-build-script-build-script-build.json num-integer-7cbcc6a07cabe7e8 build-script-build-script-build.json num-rational-38b9457885132cea run-build-script-build-script-build.json num-rational-3d953bb81bf635e5 lib-num-rational.json num-rational-56b5aa6f0fda1b90 build-script-build-script-build.json num-traits-6b11e7e494784fe9 build-script-build-script-build.json num-traits-81d9768e1c8ae44c lib-num-traits.json num-traits-ab2c80941df0683b run-build-script-build-script-build.json once_cell-facf0f83bcaa4546 lib-once_cell.json opaque-debug-5182e0ede88825cd lib-opaque-debug.json opaque-debug-b83c154d25f5cfde lib-opaque-debug.json parity-scale-codec-derive-73904975108c2a5a lib-parity-scale-codec-derive.json parity-scale-codec-ebd669db58234034 lib-parity-scale-codec.json parity-secp256k1-3260a035208c9f7a build-script-build-script-build.json parity-secp256k1-40c70cb61545fdea run-build-script-build-script-build.json parity-secp256k1-5891597dc9185b9a lib-secp256k1.json percent-encoding-5f48eccb12382397 lib-percent-encoding.json ppv-lite86-b170e395a41f89b2 lib-ppv-lite86.json primitive-types-b5d79a7dbd9eecf0 lib-primitive-types.json proc-macro-crate-df9a208fa5d48416 lib-proc-macro-crate.json proc-macro-crate-fef0bd5867d83bf5 lib-proc-macro-crate.json proc-macro2-49dd073150bc1e8a build-script-build-script-build.json proc-macro2-4e8d526cdba69d52 run-build-script-build-script-build.json proc-macro2-755220030b6adeba lib-proc-macro2.json quote-7404cf61f39c038f lib-quote.json radium-1dcbc182f92af18f run-build-script-build-script-build.json radium-3edb5213d09f6e74 build-script-build-script-build.json radium-9b0eeb36e4ef73e2 lib-radium.json rand-6b2c7fcb84234030 lib-rand.json rand-8e156bcc00671e13 lib-rand.json rand_chacha-0532a58671fc2d3d lib-rand_chacha.json rand_chacha-286a3d6fc5fa452e lib-rand_chacha.json rand_core-78909417bbd52461 lib-rand_core.json rand_core-ee293dbe522af122 lib-rand_core.json reed-solomon-erasure-4e8f214dae7be0a9 run-build-script-build-script-build.json reed-solomon-erasure-503eae0d36dd1137 build-script-build-script-build.json reed-solomon-erasure-645e459ffa670266 lib-reed-solomon-erasure.json regex-8d657624a671934a lib-regex.json regex-syntax-cb4d087fa88d5b9e lib-regex-syntax.json ripemd160-3541f8ada334fe47 lib-ripemd160.json rustc-hex-ae09c6e0dd92ff3f lib-rustc-hex.json ryu-1b2f9606b802eb11 lib-ryu.json ryu-66ec2dbd0b00d1f7 lib-ryu.json ryu-779cb093985a02e5 build-script-build-script-build.json ryu-8773db53b69c0f30 run-build-script-build-script-build.json serde-1e16a45c3d4eae62 build-script-build-script-build.json serde-64a19df914071b9b lib-serde.json serde-7743d3c53e8a31a9 lib-serde.json serde-ee9efa9b92557c0f run-build-script-build-script-build.json serde_derive-6a1ba2f754e150b4 lib-serde_derive.json serde_derive-d7f1afee7646f1c5 build-script-build-script-build.json serde_derive-ed6268f28ec92d28 run-build-script-build-script-build.json serde_json-10dfe92f71347515 lib-serde_json.json serde_json-185ddd35f392fdc6 run-build-script-build-script-build.json serde_json-8acf2d2cde070bc0 lib-serde_json.json serde_json-a9fb65022ffa8dcc build-script-build-script-build.json sha2-b2d037478f8b3e64 lib-sha2.json sha3-6aba860791fbee91 lib-sha3.json signature-c35d94a5110b7dc2 lib-signature.json smallvec-e96f9622858fa1e9 lib-smallvec.json smart-default-da87aaf428990259 lib-smart-default.json static_assertions-f339204121470167 lib-static_assertions.json subtle-25e768a66d16735b lib-subtle.json syn-20c381101c96c377 lib-syn.json syn-7ed442754f82fc5a run-build-script-build-script-build.json syn-e70214b5c99efffe build-script-build-script-build.json synstructure-0ce19551e87a635a lib-synstructure.json tap-f7cd40facb6f739a lib-tap.json thiserror-357ec91d8529ee6b lib-thiserror.json thiserror-e0fdb5f79df0a30c lib-thiserror.json thiserror-impl-5ebd97883eeffd84 lib-thiserror-impl.json time-d83be0f32265f86a lib-time.json tinyvec-0b1689170370b87c lib-tinyvec.json tinyvec_macros-521b0bf5d853da6d lib-tinyvec_macros.json toml-cc5bd535e6f6b53d lib-toml.json typenum-cc4336038336ce03 run-build-script-build-script-main.json typenum-dc3fb195d987f045 lib-typenum.json typenum-e70c9dd60c60cb4a build-script-build-script-main.json uint-9608de2af7ecf45b lib-uint.json unicode-bidi-537fdc5119343f92 lib-unicode_bidi.json unicode-normalization-952f0412cb1076e5 lib-unicode-normalization.json unicode-xid-745589536fdb3b82 lib-unicode-xid.json url-1c37cf9fde31b678 lib-url.json validator-dd28d81549cd97bc lib-validator.json validator_types-af155d27352e80c6 lib-validator_types.json version_check-0e39a7d855ce105c lib-version_check.json wee_alloc-b92e0cbd43fbe331 run-build-script-build-script-build.json wee_alloc-d9d04d4135d136fe lib-wee_alloc.json wee_alloc-f4e7c3437706fb20 build-script-build-script-build.json wyz-e5f82338595dda9f lib-wyz.json zeroize-56513b8052717601 lib-zeroize.json zeroize_derive-4cc828bf0f29cf91 lib-zeroize_derive.json build ahash-72a5e59fd1526b7d save-analysis build_script_build-72a5e59fd1526b7d.json crunchy-74a400335b9a1a23 save-analysis build_script_build-74a400335b9a1a23.json crunchy-faf69dbf78739f0e out lib.rs generic-array-b3a15bae3bd7dcb8 save-analysis build_script_build-b3a15bae3bd7dcb8.json getrandom-1f059f9abd470400 save-analysis build_script_build-1f059f9abd470400.json hashbrown-29e2d33e445a3fe8 save-analysis build_script_build-29e2d33e445a3fe8.json indexmap-7dfb354d589d374d save-analysis build_script_build-7dfb354d589d374d.json libc-bb37b703bb9d350a save-analysis build_script_build-bb37b703bb9d350a.json memchr-a50d6597a861a8f7 save-analysis build_script_build-a50d6597a861a8f7.json num-bigint-5e61d9ce118517c2 out radix_bases.rs num-bigint-80833f2f9084448e save-analysis build_script_build-80833f2f9084448e.json num-integer-7cbcc6a07cabe7e8 save-analysis build_script_build-7cbcc6a07cabe7e8.json num-rational-56b5aa6f0fda1b90 save-analysis build_script_build-56b5aa6f0fda1b90.json num-traits-6b11e7e494784fe9 save-analysis build_script_build-6b11e7e494784fe9.json parity-secp256k1-3260a035208c9f7a save-analysis build_script_build-3260a035208c9f7a.json parity-secp256k1-40c70cb61545fdea out flag_check.c proc-macro2-49dd073150bc1e8a save-analysis build_script_build-49dd073150bc1e8a.json radium-3edb5213d09f6e74 save-analysis build_script_build-3edb5213d09f6e74.json reed-solomon-erasure-4e8f214dae7be0a9 out table.rs reed-solomon-erasure-503eae0d36dd1137 save-analysis build_script_build-503eae0d36dd1137.json ryu-779cb093985a02e5 save-analysis build_script_build-779cb093985a02e5.json serde-1e16a45c3d4eae62 save-analysis build_script_build-1e16a45c3d4eae62.json serde_derive-d7f1afee7646f1c5 save-analysis build_script_build-d7f1afee7646f1c5.json serde_json-a9fb65022ffa8dcc save-analysis build_script_build-a9fb65022ffa8dcc.json syn-e70214b5c99efffe save-analysis build_script_build-e70214b5c99efffe.json typenum-cc4336038336ce03 out consts.rs op.rs tests.rs typenum-e70c9dd60c60cb4a save-analysis build_script_main-e70c9dd60c60cb4a.json wee_alloc-b92e0cbd43fbe331 out wee_alloc_static_array_backend_size_bytes.txt wee_alloc-f4e7c3437706fb20 save-analysis build_script_build-f4e7c3437706fb20.json deps save-analysis greeter-fc676d93ab2c8942.json libahash-a136cd55d53ec5cc.json libaho_corasick-fa0b503eb5376403.json libarrayref-92b779883f4a839c.json libarrayvec-ad52f33d0c083dff.json libautocfg-e8d96e7f2b762b9c.json libbase64-d5643b15903575b6.json libbase64-f91e443953601d03.json libblake2-0d83a3f19867f204.json libblock_buffer-220d02b4d2929421.json libblock_padding-8a834015f89aca37.json libborsh-affc9c4c56d7cdbf.json libbs58-11dcc6dd2dbacc0e.json libbyte_slice_cast-2f731fe6454ad76e.json libbyte_tools-57e6e74fdcb17b5e.json libbyteorder-0374979f24472d24.json libbytesize-2c69f8d5b6c1a32a.json libc2_chacha-376080e85de6fc01.json libcipher-19d2d24265566ba1.json libcrypto_mac-4db669e914682f2a.json libcurve25519_dalek-3d7060a424b21f27.json libderive_more-c3d2ec1b6c44a8b4.json libdigest-fa76758f1fc5a2e2.json libeasy_ext-3ad30aa7aaa95a72.json libed25519-fd34faf47084d708.json libed25519_dalek-da941b5a711ae209.json libfixed_hash-d8fbe6cc0cf2ced5.json libform_urlencoded-d1236e044f4824a8.json libfunty-fb468bb2dda2baca.json libgeneric_array-a18da0180972dfd0.json libgeneric_array-c51d244cd9a9bfcf.json libgetrandom-54cac5e5dc4c6c26.json libgetrandom-95128205d0caa92b.json libgreeter-0f554b11b224c376.json libhashbrown-e89b22b6662d4130.json libhex-cdae7c35cd6cecda.json libimpl_codec-f85c27205dd026fd.json libimpl_trait_for_tuples-45c1f32913168005.json libindexmap-3c776aed40346d47.json libindexmap-df8cb351f7c33f76.json libinflector-a8f4e37dd556cf0f.json libitoa-0b1cf39c674d78d9.json libitoa-331611d2ec6ae993.json libkeccak-67af69d5aac668a1.json liblazy_static-ae46812994b3b675.json libmatches-44e3646f69900caa.json libmemchr-d18a1b854a1694f3.json libmemory_units-49e26755483b9a5c.json libnear_account_id-1f43b281daf9cc0c.json libnear_crypto-a57b7f27d9dec348.json libnear_rpc_error_core-23ea6a14a5f7b2ad.json libnear_rpc_error_macro-85ef5ecb5206c3af.json libnear_sdk-f14813d5766d275b.json libnear_sys-c59a9c53b2343855.json libnear_vm_errors-682c2679d6bbfa01.json libnear_vm_logic-3273fa853b08ac2b.json libnum_bigint-44f241c9115d4d72.json libnum_integer-2c344f4afebee132.json libnum_rational-3d953bb81bf635e5.json libnum_traits-81d9768e1c8ae44c.json libonce_cell-facf0f83bcaa4546.json libopaque_debug-b83c154d25f5cfde.json libparity_scale_codec-ebd669db58234034.json libpercent_encoding-5f48eccb12382397.json libppv_lite86-b170e395a41f89b2.json libprimitive_types-b5d79a7dbd9eecf0.json libproc_macro2-755220030b6adeba.json libproc_macro_crate-df9a208fa5d48416.json libproc_macro_crate-fef0bd5867d83bf5.json libquote-7404cf61f39c038f.json libradium-9b0eeb36e4ef73e2.json librand-6b2c7fcb84234030.json librand-8e156bcc00671e13.json libreed_solomon_erasure-645e459ffa670266.json libregex-8d657624a671934a.json libripemd160-3541f8ada334fe47.json librustc_hex-ae09c6e0dd92ff3f.json libryu-1b2f9606b802eb11.json libryu-66ec2dbd0b00d1f7.json libsecp256k1-5891597dc9185b9a.json libsha2-b2d037478f8b3e64.json libsha3-6aba860791fbee91.json libsignature-c35d94a5110b7dc2.json libsmallvec-e96f9622858fa1e9.json libsmart_default-da87aaf428990259.json libstatic_assertions-f339204121470167.json libsubtle-25e768a66d16735b.json libsynstructure-0ce19551e87a635a.json libtap-f7cd40facb6f739a.json libthiserror-357ec91d8529ee6b.json libthiserror-e0fdb5f79df0a30c.json libtime-d83be0f32265f86a.json libtinyvec-0b1689170370b87c.json libtoml-cc5bd535e6f6b53d.json libuint-9608de2af7ecf45b.json libunicode_bidi-537fdc5119343f92.json libunicode_xid-745589536fdb3b82.json liburl-1c37cf9fde31b678.json libvalidator-dd28d81549cd97bc.json libversion_check-0e39a7d855ce105c.json libwee_alloc-d9d04d4135d136fe.json libwyz-e5f82338595dda9f.json libzeroize-56513b8052717601.json wasm32-unknown-unknown debug .fingerprint ahash-05a5712471d8c67f lib-ahash.json ahash-665abf667ec8de2f run-build-script-build-script-build.json base64-723a5f30cf4b1d9f lib-base64.json borsh-27eb2822906cc821 lib-borsh.json bs58-2bb05e0df8f22591 lib-bs58.json cfg-if-f98e23c88f079db2 lib-cfg-if.json greeter-98ace302c5fafa12 lib-greeter.json hashbrown-263146f50e5146bb run-build-script-build-script-build.json hashbrown-277befcdd0227b9c lib-hashbrown.json hashbrown-49542153239af762 lib-hashbrown.json indexmap-92571100829cca1e lib-indexmap.json indexmap-e35bb55c8d49c201 run-build-script-build-script-build.json itoa-a83116eed5dc3ffc lib-itoa.json memory_units-a2806337a5fb87f2 lib-memory_units.json near-sdk-de355fb200587b9d lib-near-sdk.json near-sys-1f676b9d171415c3 lib-near-sys.json once_cell-b935000a29488360 lib-once_cell.json ryu-afb7a552e02812a9 run-build-script-build-script-build.json ryu-c4ab5e492da7b9f0 lib-ryu.json serde-08dc023feab17e62 lib-serde.json serde-3d4674782f854b47 run-build-script-build-script-build.json serde_json-9a1f521e6ef58477 lib-serde_json.json serde_json-e49471fbd0d48f00 run-build-script-build-script-build.json wee_alloc-10300a9e987d1da4 lib-wee_alloc.json wee_alloc-efe42a590f64ca87 run-build-script-build-script-build.json build wee_alloc-efe42a590f64ca87 out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint ahash-47ee50cb71d0eff1 lib-ahash.json ahash-ccd52173384eb628 run-build-script-build-script-build.json base64-f231845924e8f1ff lib-base64.json borsh-b931ef9c796e2698 lib-borsh.json bs58-2bdb25cba5c89e14 lib-bs58.json cfg-if-940574005e4db99b lib-cfg-if.json greeter-98ace302c5fafa12 lib-greeter.json hashbrown-3df8ace2fe55dc05 run-build-script-build-script-build.json hashbrown-4a25e338e1f5a6c0 lib-hashbrown.json hashbrown-78e93de50469c7e6 lib-hashbrown.json indexmap-76e8d01d789d10fc lib-indexmap.json indexmap-f873a8bd9cca059a run-build-script-build-script-build.json itoa-306721d891ad3e91 lib-itoa.json memory_units-5c3768a43ade0382 lib-memory_units.json near-sdk-9fec745ef1f9fbb7 lib-near-sdk.json near-sys-01d22aefd9fac1b0 lib-near-sys.json once_cell-cc032ad311daf46f lib-once_cell.json ryu-b8eb55c5c859da39 run-build-script-build-script-build.json ryu-ca23251ad4e1dfb1 lib-ryu.json serde-8fcb13d451abb053 run-build-script-build-script-build.json serde-9da935f22931012d lib-serde.json serde_json-20efdbbaabc3dfaa lib-serde_json.json serde_json-bc420afa42575908 run-build-script-build-script-build.json wee_alloc-c76c2a1ca0de8351 run-build-script-build-script-build.json wee_alloc-f576437e4b1646f1 lib-wee_alloc.json build wee_alloc-c76c2a1ca0de8351 out wee_alloc_static_array_backend_size_bytes.txt | |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1038,"byte_end":1133,"line_start":22,"line_end":22,"column_start":1,"column_end":96}},{"value":" | `encode` | Returns a new `String` | Always |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1134,"byte_end":1229,"line_start":23,"line_end":23,"column_start":1,"column_end":96}},{"value":" | `encode_config` | Returns a new `String` | Always |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1230,"byte_end":1325,"line_start":24,"line_end":24,"column_start":1,"column_end":96}},{"value":" | `encode_config_buf` | Appends to provided `String` | Only if `String` needs to grow |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1326,"byte_end":1421,"line_start":25,"line_end":25,"column_start":1,"column_end":96}},{"value":" | `encode_config_slice` | Writes to provided `&[u8]` | Never |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1422,"byte_end":1517,"line_start":26,"line_end":26,"column_start":1,"column_end":96}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1518,"byte_end":1521,"line_start":27,"line_end":27,"column_start":1,"column_end":4}},{"value":" All of the encoding functions that take a `Config` will pad as per the config.","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1522,"byte_end":1604,"line_start":28,"line_end":28,"column_start":1,"column_end":83}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1605,"byte_end":1608,"line_start":29,"line_end":29,"column_start":1,"column_end":4}},{"value":" # Decoding","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1609,"byte_end":1623,"line_start":30,"line_end":30,"column_start":1,"column_end":15}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1624,"byte_end":1627,"line_start":31,"line_end":31,"column_start":1,"column_end":4}},{"value":" Just as for encoding, there are different decoding functions available.","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1628,"byte_end":1703,"line_start":32,"line_end":32,"column_start":1,"column_end":76}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1704,"byte_end":1707,"line_start":33,"line_end":33,"column_start":1,"column_end":4}},{"value":" | Function | Output | Allocates |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.11.0 src lib.rs","byte_start":1708,"byte_end":1804,"line_start":34,"line_end":34,"column_start":1,"column_end":97}},{"value":" | base64-0.13.0 src lib.rs","byte_start":1038,"byte_end":1133,"line_start":22,"line_end":22,"column_start":1,"column_end":96}},{"value":" | `encode` | Returns a new `String` | Always |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1134,"byte_end":1229,"line_start":23,"line_end":23,"column_start":1,"column_end":96}},{"value":" | `encode_config` | Returns a new `String` | Always |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1230,"byte_end":1325,"line_start":24,"line_end":24,"column_start":1,"column_end":96}},{"value":" | `encode_config_buf` | Appends to provided `String` | Only if `String` needs to grow |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1326,"byte_end":1421,"line_start":25,"line_end":25,"column_start":1,"column_end":96}},{"value":" | `encode_config_slice` | Writes to provided `&[u8]` | Never |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1422,"byte_end":1517,"line_start":26,"line_end":26,"column_start":1,"column_end":96}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1518,"byte_end":1521,"line_start":27,"line_end":27,"column_start":1,"column_end":4}},{"value":" All of the encoding functions that take a `Config` will pad as per the config.","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1522,"byte_end":1604,"line_start":28,"line_end":28,"column_start":1,"column_end":83}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1605,"byte_end":1608,"line_start":29,"line_end":29,"column_start":1,"column_end":4}},{"value":" # Decoding","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1609,"byte_end":1623,"line_start":30,"line_end":30,"column_start":1,"column_end":15}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1624,"byte_end":1627,"line_start":31,"line_end":31,"column_start":1,"column_end":4}},{"value":" Just as for encoding, there are different decoding functions available.","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1628,"byte_end":1703,"line_start":32,"line_end":32,"column_start":1,"column_end":76}},{"value":" ","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1704,"byte_end":1707,"line_start":33,"line_end":33,"column_start":1,"column_end":4}},{"value":" | Function | Output | Allocates |","span":{"file_name":" home john .cargo registry src github.com-1ecc6299db9ec823 base64-0.13.0 src lib.rs","byte_start":1708,"byte_end":1804,"line_start":34,"line_end":34,"column_start":1,"column_end":97}},{"value":" | dist index.html logo-black.3916bf24.svg logo-black.eab7a939.svg logo-white.7fec831f.svg logo-white.c927fc35.svg src.6ba24133.js src.85094310.js src.e31bb0bc.css src.eca22910.css package.json src App.js __mocks__ fileMock.js assets logo-black.svg logo-white.svg config.js global.css index.html index.js jest.init.js main.test.js utils.js wallet login index.html

near-spring-third ================== This [React] app was initialized with [create-near-app] Quick Start =========== To run this project locally: 1. Prerequisites: Make sure you've installed [Node.js] ≥ 12 2. Install dependencies: `yarn install` 3. Run the local development server: `yarn dev` (see `package.json` for a full list of `scripts` you can run with `yarn`) Now you'll have a local development environment backed by the NEAR TestNet! Go ahead and play with the app and the code. As you make code changes, the app will automatically reload. Exploring The Code ================== 1. The "backend" code lives in the `/contract` folder. See the README there for more info. 2. The frontend code lives in the `/src` folder. `/src/index.html` is a great place to start exploring. Note that it loads in `/src/index.js`, where you can learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `yarn run test`. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally: yarn install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-spring-third.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-spring-third.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-spring-third.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: set contract name in code --------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-spring-third.YOUR-NAME.testnet' Step 3: deploy! --------------- One command: yarn deploy As you can see in `package.json`, this does two things: 1. builds & deploys smart contract to NEAR TestNet 2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere. Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [React]: https://reactjs.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/docs/concepts/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # near-spring-third # near-spring-third near-spring-third Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html

NEAR-P2P_walletp2p_front

.eslintrc.js .github workflows ci.yml .vscode settings.json README.md assets sources avatars avatar-female.svg avatar-male.svg countries arg.svg eur.svg ngn.svg rub.svg try.svg usa.svg vnzla.svg drawer account.svg close.svg explore.svg language.svg security.svg staking.svg support.svg wallet.svg icons account-icon.svg account-mobile.svg account.svg arrow-down.svg arrow-right.svg arrow-up.svg arrow.svg chats copy.svg chats-active.svg chats.svg checked.svg circle.svg close.svg copy.svg double-chevron-right.svg error.svg eye-off.svg faq copy.svg faq-active.svg faq.svg icon-access-key.svg icon-new-account.svg icon-recieved.svg icon-sent.svg info-white.svg info.svg instagram.svg language-blue.svg link.svg live-chat.svg lupa.svg magnify.svg market-active.svg market.svg menu-active copy.svg menu-active-sidebar copy.svg menu-active-sidebar.svg menu-active.svg menu.svg options.svg plus.svg reloj.svg ring-icon.svg scroll-down.svg settings copy.svg settings-active.svg settings.svg stats copy.svg stats-active.svg stats.svg success.svg swap-vertical.svg swap.svg twitch.svg twitter.svg unchecked.svg warning-blue.svg warning.svg images bg-clock.svg bg-drawer.svg circle-bubbles.svg circle-main.svg circle-person.svg circle-v2.svg circle.svg person-checked.svg logos astro-dao.svg burrow.svg discord.svg gmail.svg instagram.svg logo-qr.svg logo.svg meta-pool.svg my-near-wallet-icon.svg near-icon.svg near-wallet-icon.svg near.svg paras.svg qr-code.svg rainbow-bridge.svg ref-finance.svg sender-icon.svg twitter.svg youtube.svg styled-tokens usdt.svg tokens btc.svg dai.svg eth.svg klay.svg matic.svg shib.svg snx.svg sol.svg usdc.svg usdt.svg i18n en.js es.js jsconfig.json middleware authenticated-create-import.js authenticated.js execute.js route-validator.js mixins computeds.js customeDrag.js isMobile.js models message_model.js p2p_room_model.js p2p_user_model.js nuxt.config.js package.json plugins apexchart.js axios.js dictionary.js directives.js functions.js google-maps.js injects.js mixinsImport.js polyfills.js unlock-wallet.js vue-debounce.js services encryp.js local-storage-user.js near-api.js nearConfig.js tokens.js utils.js wallet.js store README.md index.js utils walletError.js

# STORE **This directory is not required, you can delete it if you don't want to use it.** This directory contains your Vuex Store files. Vuex Store option is implemented in the Nuxt.js framework. Creating a file in this directory automatically activates the option in the framework. More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/vuex-store). # detextre4-nuxt2 ## Build Setup ```bash # install dependencies $ npm install # serve with hot reload at localhost:3000 $ npm run dev # build for production and launch server $ npm run build $ npm run start # generate static project $ npm run generate ``` For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org). ## Special Directories You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality. ### `assets` The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets). ### `components` The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components). ### `layouts` Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts). ### `pages` This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing). ### `plugins` The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins). ### `static` This directory contains your static files. Each file inside this directory is mapped to `/`. Example: `/static/robots.txt` is mapped as `/robots.txt`. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static). ### `store` This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex. More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).

longvuit18_pnc-contract

Cargo.toml build.sh neardev dev-account.env note.sh protocol-substrate-fixtures README.md builder Cargo.toml src main.rs src lib.rs lib2.rs merkle.rs mixer_verifier.rs poseidon.rs util.rs zero.rs vcc.py

# protocol-substrate-fixtures

mylearnverse_LearnVerseBackends

README.md near-api-rest-server README.md api.js app.js blockchain.js examples nft_deploy deploy_tokens.js token_types.js near-api-ui README.md package.json public index.html manifest.json robots.txt src App.css App.js App.test.js assets explorer-bg.svg icon-network-right.svg logo-black.svg logo-white.svg logo.svg config.js index.css index.html index.js logo.svg reportWebVitals.js setupTests.js utils.js package.json token.js user.js |

# NEAR REST API SERVER > Interact with the NEAR blockchain using a simple REST API. ###### Live Demo: * [REST API Endpoint for NEAR Testnet](https://rest.nearapi.org) * [Web Console for `view`/`call` requests](https://web.nearapi.org) --- ## Overview _Click on a route for more information and examples_ | Route | Method | Description | | ------------------------------------------ | ------ | --------------------------------------------------------------------------------------------------------------------------- | | **CONTRACTS** | | | | [`/deploy`](#deploy) | POST | Deploys a smart contract on NEAR. | | [`/view`](#view) | POST | Performs a smart contract **view** call with no gas burnt. | | [`/call`](#call) | POST | Performs a smart contract **change** call that burns gas. | | | | | | **UTILS** | | | | [`/init`](#init) | POST | Initializes the master account and updates `near-api-server-config.json` | | [`/create_user`](#create_user) | POST | Creates a NEAR [sub-account](https://docs.near.org/docs/concepts/account#subaccounts) and stores credentials in `/storage`. | | [`/parse_seed_phrase`](#parse_seed_phrase) | POST | Displays public and private key pair from a given seed phrase. | | [`/balance`](#balance) | GET | Displays account balance. | | [`/keypair`](#keypair) | GET | Generates Ed25519 key pair. | | [`/explorer`](#explorer) | POST | Run SELECT query in NEAR explorer database. | | | | | | **NFT EXAMPLE** | | | | [`/mint_nft`](#mint_nft) | POST | Mints an NFT for a given contract. | | [`/transfer_nft`](#transfer_nft) | POST | Transfers NFT ownership to a specified account. | | [`/view_nft`](#view_nft) | POST | Returns owner, metadata, and approved account IDs for a given token ID. | --- ## Requirements - [NEAR Account](https://docs.near.org/docs/develop/basics/create-account) _(with access to private key or seed phrase)_ - [Node.js](https://nodejs.org/en/download/package-manager/) - [npm](https://www.npmjs.com/get-npm) or [Yarn](https://yarnpkg.com/getting-started/install) - API request tool such as [Postman](https://www.postman.com/downloads/) --- ## Setup 1. Clone repository ```bash git clone git@github.com:near-examples/near-api-server.git ``` 2. Install dependencies ```bash npm install ``` 3. Configure `near-api-server.config.json` Default settings: ```json { "server_host": "localhost", "server_port": 3000, "rpc_node": "https://rpc.testnet.near.org", "init_disabled": true } ``` _**Note:** `init_disabled` determines if params can be changed via `/init` route._ 4. Start server ```bash node app ``` --- # Contracts ## `/deploy` > _Deploys a smart contract to the NEAR blockchain based on the wasm file located in `/contracts` folder._ **Method:** **`POST`** | Param | Description | | -------------------------------- | ------------------------------------------------------------------------------------ | | `account_id` | _Account id that you will be deploying the contract to._ | | `seed_phrase` _OR_ `private_key` | _Seed phrase OR private key of the account id above._ | | `contract` | _wasm file of compiled contract located in the `/contracts` folder of this project._ | _**Note:** Use [`near login`](https://docs.near.org/docs/tools/near-cli#near-login) to save your key pair to your local machine._ Example: ```json { "account_id": "example.testnet", "seed_phrase": "witch collapse practice feed shame open despair creek road again ice least", "contract": "nft_simple.wasm" } ``` <details> <summary><strong>Example Response:</strong> </summary> <p> ```json { "status": { "SuccessValue": "" }, "transaction": { "signer_id": "example.testnet", "public_key": "ed25519:Cgg4i7ciid8uG4K5Vnjzy5N4PXLst5aeH9ApRAUA3y8U", "nonce": 5, "receiver_id": "example.testnet", "actions": [ { "DeployContract": { "code": "hT9saWV3aok50F8JundSIWAW+lxOcBOns1zenB2fB4E=" } } ], "signature": "ed25519:3VrppDV8zMMRXErdBJVU9MMbbKZ4SK1pBZqXoyw3oSSiXTeyR2W7upNhhZPdFJ1tNBr9h9SnsTVeBm5W9Bhaemis", "hash": "HbokHoCGcjGQZrz8yU8QDqBeAm5BN8iPjaSMXu7Yp2KY" }, "transaction_outcome": { "proof": [ { "hash": "Dfjn2ro1dXrPqgzd5zU7eJpCMKnATm295ceocX73Qiqn", "direction": "Right" }, { "hash": "9raAgMrEmLpL6uiynMAi9rykJrXPEZN4WSxLJUJXbipY", "direction": "Right" } ], "block_hash": "B64cQPDNkwiCcN3SGXU2U5Jz5M9EKF1hC6uDi4S15Fb3", "id": "HbokHoCGcjGQZrz8yU8QDqBeAm5BN8iPjaSMXu7Yp2KY", "outcome": { "logs": [], "receipt_ids": ["D94GcZVXE2WgPGuaJPJq8MdeEUidrN1FPkuU75NXWm7X"], "gas_burnt": 1733951676474, "tokens_burnt": "173395167647400000000", "executor_id": "example.testnet", "status": { "SuccessReceiptId": "D94GcZVXE2WgPGuaJPJq8MdeEUidrN1FPkuU75NXWm7X" } } }, "receipts_outcome": [ { "proof": [ { "hash": "3HLkv7KrQ9LPptX658QiwkFagv8NwjcxF6ti15Een4uh", "direction": "Left" }, { "hash": "9raAgMrEmLpL6uiynMAi9rykJrXPEZN4WSxLJUJXbipY", "direction": "Right" } ], "block_hash": "B64cQPDNkwiCcN3SGXU2U5Jz5M9EKF1hC6uDi4S15Fb3", "id": "D94GcZVXE2WgPGuaJPJq8MdeEUidrN1FPkuU75NXWm7X", "outcome": { "logs": [], "receipt_ids": [], "gas_burnt": 1733951676474, "tokens_burnt": "173395167647400000000", "executor_id": "example.testnet", "status": { "SuccessValue": "" } } } ] } ``` </p> </details> --- ## `/view` > _Performs a smart contract view call that is free of charge (no gas burnt)._ **Method:** **`POST`** | Param | Description | | ---------- | ----------------------------------------------------------------------------------------- | | `contract` | _Account id of the smart contract you are calling._ | | `method` | _Name of the public method on the contract you are calling._ | | `params` | _Arguments the method of the contract takes. Pass an empty object if no args are needed._ | Example: ```json { "contract": "inotel.pool.f863973.m0", "method": "get_accounts", "params": { "from_index": 0, "limit": 5 } } ``` <details> <summary><strong>Example Response:</strong> </summary> <p> ```json [ { "account_id": "ino.lockup.m0", "unstaked_balance": "0", "staked_balance": "2719843984800963837328608365424", "can_withdraw": true }, { "account_id": "ino.testnet", "unstaked_balance": "2", "staked_balance": "3044983795632859169857527919579", "can_withdraw": true }, { "account_id": "ino.stakewars.testnet", "unstaked_balance": "2", "staked_balance": "21704174266817478470830456026", "can_withdraw": true }, { "account_id": "ds4.testnet", "unstaked_balance": "3", "staked_balance": "10891355794195012441764921", "can_withdraw": true }, { "account_id": "32oijafsiodjfas.testnet", "unstaked_balance": "3", "staked_balance": "383757424103247547511904666", "can_withdraw": true } ] ``` </p> </details> --- ## `/call` > _Performs a smart contract call that changes state and burns gas._ **Method:** **`POST`** | Param | Description | | -------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `account_id` | _Account id that will be performing the call and will be charged for gas and attached tokens / deposit._ | | `seed_phrase` _OR_ `private_key` | _Seed phrase OR private key of the account id above._ | | `contract` | _Account id of the smart contract you will be calling._ | | `method` | _Public method on the smart contract that you will be calling._ | | `params` | _Arguments the method of the contract takes. Pass an empty object if no args are needed._ | | `attached_gas` | _Amount of gas you will be attaching to the call in [TGas](https://docs.near.org/docs/concepts/gas#thinking-in-gas)._ | | `attached_tokens` | _Amount of tokens to be sent to the contract you are calling in yoctoNEAR (10^-24 NEAR)._ | _**Note:** Use [`near login`](https://docs.near.org/docs/tools/near-cli#near-login) to save your key pair to your local machine._ Example: ```json { "account_id": "example.testnet", "private_key": "2Kh6PJjxH5PTTsVnYqtgnnwXHeafvVGczDXoCb33ws8reyq8J4oBYix1KP2ugRQ7q9NQUyPcVFTtbSG3ARVKETfK", "contract": "guest-book.testnet", "method": "addMessage", "params": { "text": "Hello World" }, "attached_gas": "100000000000000", "attached_tokens": "0" } ``` <details> <summary><strong>Example Response:</strong> </summary> <p> ```json { "status": { "SuccessValue": "" }, "transaction": { "signer_id": "example.testnet", "public_key": "ed25519:ASZEids5Qa8XMHX2S7LRL4bQRczi4YuMWXSM7S1HE5b", "nonce": 4, "receiver_id": "guest-book.testnet", "actions": [ { "FunctionCall": { "method_name": "addMessage", "args": "eyJ0ZXh0IjoiSGVsbG8gV29ybGQifQ==", "gas": 100000000000000, "deposit": "0" } } ], "signature": "ed25519:4T9FqsjYBxcitjd5GgHrv3i3hcdcJSNcwwG3jBUgs7zZCZ3uShAK44Hi3oYFefhr8e5UW3LLD49ofRpGXKwGqqot", "hash": "CniHtfQVzcyVWJaUrQibJyGdhLi5axsjsoSRvvFbJ1jv" }, "transaction_outcome": { "proof": [ { "hash": "EkzDGbbBHSAuJcCPmhKSqbnBKyLrMgXkrTEZZZQudHeH", "direction": "Right" }, { "hash": "36j4PK6fsLChiVTBQnXS1ywVSgJgHo7FtWzd5y5jkK1B", "direction": "Right" } ], "block_hash": "CUAu2deED8UX4vkerCbsTMR7YkeKt8RQXknYMNrVvM7C", "id": "CniHtfQVzcyVWJaUrQibJyGdhLi5axsjsoSRvvFbJ1jv", "outcome": { "logs": [], "receipt_ids": ["B7xAYoga5vrKERK7wY7EHa2Z74LaRJwqPsh4esLrKeQF"], "gas_burnt": 2427992549888, "tokens_burnt": "242799254988800000000", "executor_id": "example.testnet", "status": { "SuccessReceiptId": "B7xAYoga5vrKERK7wY7EHa2Z74LaRJwqPsh4esLrKeQF" } } }, "receipts_outcome": [ { "proof": [ { "hash": "6Uo6BajpAxiraJEv69RwhjYnC86u56cw29vRDB1SV4dv", "direction": "Right" } ], "block_hash": "Ecq6pK74uiJFKxPTaasYuQcsEznnQjdzMAfsyrBpDo2u", "id": "B7xAYoga5vrKERK7wY7EHa2Z74LaRJwqPsh4esLrKeQF", "outcome": { "logs": [], "receipt_ids": ["6S6m1TYuVPYovLu9FHGV5oLRnDXeNQ8NhXxYjcr91xAN"], "gas_burnt": 3766420707221, "tokens_burnt": "376642070722100000000", "executor_id": "guest-book.testnet", "status": { "SuccessValue": "" } } }, { "proof": [ { "hash": "2za2YKUhyMfWbeEL7UKZxZcQbAqEmSPgPoYh9QDdeJQi", "direction": "Left" }, { "hash": "61aHEiTBBbPU8UEXgSQh42TujFkHXQQMSuTh13PLPwbG", "direction": "Right" } ], "block_hash": "6LfpzvCBkqq7h5uG9VjAHMwSpC3HMMBSAGNGhbrAJzKP", "id": "6S6m1TYuVPYovLu9FHGV5oLRnDXeNQ8NhXxYjcr91xAN", "outcome": { "logs": [], "receipt_ids": [], "gas_burnt": 0, "tokens_burnt": "0", "executor_id": "example.testnet", "status": { "SuccessValue": "" } } } ] } ``` </p> </details> --- # Utils --- ## `/init` > _Configures `near-api-server.config.json` and creates a master account that stores credentials in this file. This allows for "simple methods" to be called where you won't have to pass as many parameters, primarily the master account id and private key or seed phrase._ **ATTN: SERVER MUST BE RESTARTED AFTER CALLING THIS ENDPOINT** **Method:** **`POST`** | Param | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `master_account_id` | _Master account that has full access to the NFT contract below_ | | `seed_phrase` _OR_ `private_key` | _Seed phrase OR private key of the account id above._ | | `nft_contract` | _Contract account that has NFT contract deployed to it_ | | `server_host` | _Public IP address for your API server (localhost is default)_ | | `server_port` | _(Port your API server will listen on)_ | | `rpc_node` | _[Network](https://docs.near.org/docs/concepts/networks) your server will be running on (testnet, mainnet, or betanet)_ | _**Note:** Use [`near login`](https://docs.near.org/docs/tools/near-cli#near-login) to save your key pair to your local machine._ Example: ```json { "master_account_id": "example.testnet", "seed_phrase": "seed phrase for master_account_id goes here", "nft_contract": "nft-contract.example.testnet", "server_host": "localhost", "server_port": 3000, "rpc_node": "https://rpc.testnet.near.org" } ``` Example Response: ```json { "text": "Settings updated." } ``` --- ## `/sign_url` > _Generates a link to NEAR Wallet with provided transaction details. May be used to redirect user to the wallet and perform a transaction without generation application-specific keys and granting access._ **Method:** **`POST`** | Param | Description | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | `account_id` | _Signer Account_ | | `receiver_id` | _Recipient contract account, may be dApp contract or personal account_ | | `method` | _Contract method to call. Use `!transfer` to transfer NEAR tokens_ | | `params` | _Transaction arguments_ | | `deposit` | _Attached deposit in NEAR_ | | `gas` | _Attached gas in yoctoNEAR_ | | `meta` | _Transaction meta. May be empty_ | | `callback_url` | _URL to redirect user after the transaction. May be empty_ | | `network` | _Your network: mainnet/testnet_ | Example: ``` { "account_id": "zavodil.testnet", "receiver_id": "inotel.pool.f863973.m0", "method": "ping", "params": {}, "deposit": 0, "gas": 30000000000000, "meta": "", "callback_url": "", "network": "testnet" } ``` Example Response: ``` https://wallet.testnet.near.org/sign?transactions=DwAAAHphdm9kaWwudGVzdG5ldADKei8CC%2BlhIM9GNPitr87eHXpqdnQsCdLD%2B0ADdTJbqwEAAAAAAAAAFgAAAGlub3RlbC5wb29sLmY4NjM5NzMubTCfZPsioMcZCQRg4Uy7rOu4ERg10QV9c415FuXE0VDRRAEAAAACBAAAAHBpbmcCAAAAe30A4FfrSBsAAAAAAAAAAAAAAAAAAAAAAAA%3D&callbackUrl= ``` Approving this url performed a transaction [143c9MNaqXFXuiobjUaQ8FPSBR2ukYbCMzGdPe6HqXEq](https://explorer.testnet.near.org/transactions/143c9MNaqXFXuiobjUaQ8FPSBR2ukYbCMzGdPe6HqXEq) ## `/create_user` > _Creates a NEAR [sub-account](https://docs.near.org/docs/concepts/account#subaccounts) using initialized master account and saves credentials to `/storage` directory. Requires [`/init`](#init) configuration with master account._ **Note:** _Only letters, digits, and - or \_ separators are allowed._ **Method:** **`POST`** Example: ``` { "name" : "satoshi" } ``` Example Response: ```json { "text": "Account satoshi.example.testnet created. Public key: ed25519:HW4koiHqLi5WdVHWy9fqBWHbLRrzfmvCiRAUVhMa14T2" } ``` --- ## `/parse_seed_phrase` > _Converts seed phrase into public / private key pair._ **Method:** **`POST`** Example: ``` { "seed_phrase" : "witch collapse practice feed shame open despair creek road again ice least" } ``` Example Response: ``` { "seedPhrase": "witch collapse practice feed shame open despair creek road again ice least", "secretKey": "ed25519:41oHMLtYygTsgwDzaMdjWRq48Sy9xJsitJGmMxgA9A7nvd65aT8vQwAvRdHi1nruPP47B6pNhW5T5TK8SsqCZmjn", "publicKey": "ed25519:Cgg4i7ciid8uG4K5Vnjzy5N4PXLst5aeH9ApRAUA3y8U" } ``` --- ## `/balance` > _Displays account balance in yoctoNEAR (10^-24 NEAR)._ **Method:** **`GET`** Example: ``` http://localhost:3000/balance/name.testnet ``` Example Response: ``` 199999959035075000000000000 ``` --- ## `/keypair` > _Generates Ed25519 key pair._ **Method:** **`GET`** Example: ``` http://localhost:3000/keypair ``` Example Response: ``` { "public_key": "ed25519:3pNJK3fwP14UEbPjQqgDASwWR4XmbAEQBeNsyThhtNKY", "private_key": "3s9nVrCU4MER3w9cxXcJM58RGRzFNJnLzo9vgQiNrkuGW3Xp7Up6cYnY4JKQZ7Qp3GhmXckrApRyDPAfzo2oCm8a" } ``` ## `/explorer` > _Run SELECT query in NEAR explorer database._ **Method:** **`POST`** | Param | Description | | -------------------------------- | ----------------------------------------------------------- | | `user` | _Public account, `public_readonly`_ | | `host` | _NEAR indexer host, `testnet.db.explorer.indexer.near.dev`_ | | `database` | _Name of the database, `testnet_explorer`_ | | `password` | _Password, `nearprotocol`_ | | `port` | _Port, `5432`_ | | `parameters` | _Array of query parameters, `[]`_ | | `query` | _Query without tabs, linebreaks and special characters_ | Check indexer server credentials on a [github](https://github.com/near/near-indexer-for-explorer/#shared-public-access). Example: ```json { "user": "public_readonly", "host": "35.184.214.98", "database": "testnet_explorer", "password": "nearprotocol", "port": 5432, "parameters": ["testnet", 1], "query": "SELECT * FROM action_receipt_actions WHERE receipt_receiver_account_id = $1 LIMIT $2" } ``` <details> <summary><strong>Example Response:</strong> </summary> <p> ```json [ { "receipt_id": "GZMyzjDWPJLjrCuQG82uHj3xRVHwdDnWHH1gCnSBejkR", "index_in_action_receipt": 0, "action_kind": "TRANSFER", "args": { "deposit": "1273665187500000000" }, "receipt_predecessor_account_id": "system", "receipt_receiver_account_id": "testnet", "receipt_included_in_block_timestamp": "1619207391172257749" } ] ``` </p> </details> --- # NFTs --- ## `/mint_nft` > _Mints a new NFT on a specified contract._ **Method:** **`POST`** ### Standard NFT Minting | Param | Description | | -------------------------------- | ------------------------------------------------------ | | `token_id` | _ID for new token you are minting_ | | `metadata` | _Metadata for the new token as a string._ | | `account_id` | _Account ID for the new token owner._ | | `seed_phrase` _OR_ `private_key` | _Seed phrase OR private key for the NFT contract._ | | `nft_contract` | _Account ID for the NFT contract your are minting on._ | _**Note:** Use [`near login`](https://docs.near.org/docs/tools/near-cli#near-login) to save your key pair to your local machine._ Example: ``` { "token_id": "EXAMPLE-TOKEN", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "account_id": "example.testnet", "private_key": "41oHMLtYygTsgwDzaMdjWRq48Sy9xJsitJGmMxgA9A7nvd65aT8vQwAvRdHi1nruPP47B6pNhW5T5TK8SsqCZmjn", "contract": "nft.example.near", } ``` ### Simple NFT Minting _Requires [`/init`](#init) configuration with master account._ Example: ```json { "token_id": "EXAMPLE_TOKEN", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu" } ``` <details> <summary><strong>Example Response:</strong> </summary> <p> ```json [ { "token": { "owner_id": "example.testnet", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "approved_account_ids": [], "token_id": "EXAMPLE_TOKEN" }, "tx": "Be7tV1h2dvhg53S2rartojeSUbNfQTB7ypuprmb6xRhw" } ] ``` </p> </details> _(`tx` is the transaction hash that can be queried in [NEAR Explorer](http://explorer.testnet.near.org))_ --- ### Batch NFT minting (simple) _Requires [`/init`](#init) configuration with master account._ Example: ```json { "token_id": "EXAMPLE_TOKEN_{inc}", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "min": 31, "max": 33 } ``` _(This creates `EXAMPLE_TOKEN_31`, `EXAMPLE_TOKEN_32`, & `EXAMPLE_TOKEN_33`)_ <details> <summary><strong>Example Response:</strong> </summary> <p> ```json [ { "tx": "mAL92gb6g6hhubZBRewJk5vSwmmzm2SXmwdAfYqfWcG" }, { "tx": "Dv9h8nWJLujkKpmw58ZR4QwAgPVprb4j5QarDUumoGEX" }, { "tx": "J48F3vALJBbbUguKXp6e16g5vKVwzC2LtVBpsfEVFpYa" } ] ``` </p> </details> _(Above response are transaction hashes that can be queried in [NEAR Explorer](http://explorer.testnet.near.org))_ --- ## `/transfer_nft` > _Transfers ownership of NFT from specified contract on behalf of provided `enforce_owner_id` signed with `owner_private_key`._ **Method:** **`POST`** ### Standard Transfer NFT | Param | Description | | ------------------- | --------------------------------------------------------- | | `token_id` | _Token ID of the token being transferred_ | | `receiver_id` | _Account ID taking ownership of the NFT_ | | `enforce_owner_id` | _Account ID for the account that currently owns the NFT._ | | `memo` | _Optional message to the new token holder._ | | `owner_private_key` | _Private key of the `enforce_owner_id`._ | | `nft_contract` | _NFT contract that the token being transferred is on._ | _**Note:** Use [`near login`](https://docs.near.org/docs/tools/near-cli#near-login) to save your key pair to your local machine._ Example: ```json { "token_id": "EXAMPLE-TOKEN", "receiver_id": "receiver.testnet", "enforce_owner_id": "example.testnet", "memo": "Here's a token I thought you might like! :)", "owner_private_key": "YOUR_PRIVATE_KEY", "contract": "nft.example.near" } ``` Example Response: ```json { "owner_id": "receiver.testnet", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "approved_account_ids": [], "tx": "5WdNgmNeA5UNpSMDRXemwJc95MB6J22LcvAaimuN5YzF" } ``` _(`tx` is the transaction hash that can be queried in [NEAR Explorer](http://explorer.testnet.near.org))_ --- ### Simple Transfer NFTs > _Requires [`/init`](#init) configuration with master account._ | Param | Description | | ------------------ | --------------------------------------------------------- | | `token_id` | _Token ID of the token being transferred_ | | `receiver_id` | _Account ID taking ownership of the NFT_ | | `enforce_owner_id` | _Account ID for the account that currently owns the NFT._ | | `memo` | _Optional message to new token holder._ | Example: ```json { "token_id": "EXAMPLE-TOKEN", "receiver_id": "receiver.testnet", "enforce_owner_id": "example.testnet", "memo": "Here's a token I thought you might like! :)" } ``` Example Response: ```json { "owner_id": "receiver.testnet", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "approved_account_ids": [], "tx": "5WdNgmNeA5UNpSMDRXemwJc95MB6J22LcvAaimuN5YzF" } ``` _(`tx` is the transaction hash that can be queried in [NEAR Explorer](http://explorer.testnet.near.org))_ --- ## `view_nft` ### Standard View NFT > _Returns owner, metadata, and approved account IDs for a given token ID._ **Method:** **`POST`** Example: ```json { "token_id": "EXAMPLE-TOKEN", "contract": "nft.example.testnet" } ``` Example response: ```json { "owner_id": "example.testnet", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "approved_account_ids": [] } ``` --- ### Simple View NFT > _Receive detailed information about NFT using URL params. Requires [`/init`](#init) configuration with master account._ **Method:** **`GET`** Example: `http://localhost:3000/view_nft/EXAMPLE-TOKEN` Example Response: ```json { "owner_id": "example.testnet", "metadata": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu", "approved_account_ids": [] } ``` --- ## Faker data > Use the following tags below to use random data for testing purposes. - `{username}` - `{number}` - `{word}` - `{words}` - `{image}` - `{color}` ## Video Presentation [](https://youtu.be/d71OscmH4cA) # LearnVerseBackends Backend code repo and microservices for LearnVerse. ## REST API Interact with NEAR blockchain and smart contracts via http requests For deployment and usage view: `near-api-rest-server/README.md` Smart Contracts are stored in: `/contracts` # Getting Started with Create React App This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Available Scripts In the project directory, you can run: ### `yarn start` Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.\ You will also see any lint errors in the console. ### `yarn test` Launches the test runner in the interactive watch mode.\ See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. ### `yarn build` Builds the app for production to the `build` folder.\ It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.\ Your app is ready to be deployed! See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. ### `yarn eject` **Note: this is a one-way operation. Once you `eject`, you can’t go back!** If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. ## Learn More You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). To learn React, check out the [React documentation](https://reactjs.org/). ### Code Splitting This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) ### Analyzing the Bundle Size This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) ### Making a Progressive Web App This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) ### Advanced Configuration This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) ### Deployment This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) ### `yarn build` fails to minify This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)

kursaderduhan_Project_Book

README.md as-pect.config.js asconfig.json package.json scripts 1.dev-deploy.sh 2.run.sh src as_types.d.ts simple __tests__ as-pect.d.ts index.unit.spec.ts assembly index.ts singleton __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts model.ts tsconfig.json utils.ts

# Near-Project-Book This project is a simple projectstore on Near blockchain. Users can post their ideas, review ideas and donate to the owner if they want. <br/> You can watch this video for use. [loom video](https://www.loom.com/share/f279ccd9fe6d4022b80cb66c85ce7980) ## Installation ```bash git clone https://github.com/kursaderduhan/Project_Book.git cd Project_Book yarn ``` ## How to Use Projectbook Smart Contract First login to your account using near cli. ```bash near login ``` Build and deploy the smart contract. ```bash yarn build:release near dev-deploy ./build/release/singleton.wasm ```` Export the development account to the $CONTRACT ```bash export CONTRACT=<YOUR_DEV_ACCOUNT_HERE> ``` --- Create a Idea. ```bash near call $CONTRACT addIdea '{"idea": "Car_Rental"}' --accountId <Your_Testnet_Account_Here> ``` List All Ideas. ```bash near view $CONTRACT getIdeas ``` Call Idea With Id. ```bash near view $CONTRACT getIdea '{"id": "<Project_ID_here>"}' ``` Donate To The Owner Of The Idea. ```bash near call $CONTRACT donation '{"idea": "<project_id_here>"}' --accountId <your_testnet_account_here> --amount 2

pas1ko_idk.finance

.gitpod.yml README.md contract README.md babel.config.json build.sh build builder.c code.h methods.h prediction_market.js deploy.sh package-lock.json package.json src BetInfo.ts Oracle.ts PredictionMarket.ts Round.ts tsconfig.json frontend assets global.css logo-black.svg logo-white.svg chart chart-data.ts icons index.ts idk-state.ts index.html index.js near-wallet.js package-lock.json package.json start.sh ui-components.js integration-tests package-lock.json package.json src main.ava.ts package-lock.json package.json reveal-bot config.js index.js package-lock.json package.json

# 🍬 [idk.finance](https://idk.finance) - I DONT KNOW Finance This app was initialized with [create-near-app] Quick Start ``` npm install ``` Build and deploy contract to TestNet with a temporary dev account: ``` npm run deploy ``` Start app. This will run a dev server with frontend: ``` npm start ``` Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```ts @NearBindgen({}) class HelloNear { greeting: string = "Hello"; @view // This method is read-only and can be called for free get_greeting(): string { return this.greeting; } @call // This method changes the state, for which it cost gas set_greeting({ greeting }: { greeting: string }): void { // Record a log permanently to the blockchain! near.log(`Saving greeting ${greeting}`); this.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [node.js](https://nodejs.org/en/download/package-manager/) >= 16. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash npm run deploy ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `call` method. `Call` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"greeting":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.

noopponent18_nearprajtice-I

README.md asconfig.json index.ts

# `near-sdk-as` Starter Kit This is a good project to use as a starting point for your AssemblyScript project. ## Samples This repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform. The example here is very basic. It's a simple contract demonstrating the following concepts: - a single contract - the difference between `view` vs. `change` methods - basic contract storage There are 2 AssemblyScript contracts in this project, each in their own folder: - **simple** in the `src/simple` folder - **singleton** in the `src/singleton` folder ### Simple We say that an AssemblyScript contract is written in the "simple style" when the `index.ts` file (the contract entry point) includes a series of exported functions. In this case, all exported functions become public contract methods. ```ts // return the string 'hello world' export function helloWorld(): string {} // read the given key from account (contract) storage export function read(key: string): string {} // write the given value at the given key to account (contract) storage export function write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} ``` ### Singleton We say that an AssemblyScript contract is written in the "singleton style" when the `index.ts` file (the contract entry point) has a single exported class (the name of the class doesn't matter) that is decorated with `@nearBindgen`. In this case, all methods on the class become public contract methods unless marked `private`. Also, all instance variables are stored as a serialized instance of the class under a special storage key named `STATE`. AssemblyScript uses JSON for storage serialization (as opposed to Rust contracts which use a custom binary serialization format called borsh). ```ts @nearBindgen export class Contract { // return the string 'hello world' helloWorld(): string {} // read the given key from account (contract) storage read(key: string): string {} // write the given value at the given key to account (contract) storage @mutateState() write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} } ``` ## Usage ### Getting started (see below for video recordings of each of the following steps) INSTALL `NEAR CLI` first like this: `npm i -g near-cli` 1. clone this repo to a local folder 2. run `yarn` 3. run `./scripts/1.dev-deploy.sh` 3. run `./scripts/2.use-contract.sh` 4. run `./scripts/2.use-contract.sh` (yes, run it to see changes) 5. run `./scripts/3.cleanup.sh` ### Videos **`1.dev-deploy.sh`** This video shows the build and deployment of the contract. [](https://asciinema.org/a/409575) **`2.use-contract.sh`** This video shows contract methods being called. You should run the script twice to see the effect it has on contract state. [](https://asciinema.org/a/409577) **`3.cleanup.sh`** This video shows the cleanup script running. Make sure you add the `BENEFICIARY` environment variable. The script will remind you if you forget. ```sh export BENEFICIARY=<your-account-here> # this account receives contract account balance ``` [](https://asciinema.org/a/409580) ### Other documentation - See `./scripts/README.md` for documentation about the scripts - Watch this video where Willem Wyndham walks us through refactoring a simple example of a NEAR smart contract written in AssemblyScript https://youtu.be/QP7aveSqRPo ``` There are 2 "styles" of implementing AssemblyScript NEAR contracts: - the contract interface can either be a collection of exported functions - or the contract interface can be the methods of a an exported class We call the second style "Singleton" because there is only one instance of the class which is serialized to the blockchain storage. Rust contracts written for NEAR do this by default with the contract struct. 0:00 noise (to cut) 0:10 Welcome 0:59 Create project starting with "npm init" 2:20 Customize the project for AssemblyScript development 9:25 Import the Counter example and get unit tests passing 18:30 Adapt the Counter example to a Singleton style contract 21:49 Refactoring unit tests to access the new methods 24:45 Review and summary ``` ## The file system ```sh ├── README.md # this file ├── as-pect.config.js # configuration for as-pect (AssemblyScript unit testing) ├── asconfig.json # configuration for AssemblyScript compiler (supports multiple contracts) ├── package.json # NodeJS project manifest ├── scripts │   ├── 1.dev-deploy.sh # helper: build and deploy contracts │   ├── 2.use-contract.sh # helper: call methods on ContractPromise │   ├── 3.cleanup.sh # helper: delete build and deploy artifacts │   └── README.md # documentation for helper scripts ├── src │   ├── as_types.d.ts # AssemblyScript headers for type hints │   ├── simple # Contract 1: "Simple example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 1 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 1 │   ├── singleton # Contract 2: "Singleton-style example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 2 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 2 │   ├── tsconfig.json # Typescript configuration │   └── utils.ts # common contract utility functions └── yarn.lock # project manifest version lock ``` You may clone this repo to get started OR create everything from scratch. Please note that, in order to create the AssemblyScript and tests folder structure, you may use the command `asp --init` which will create the following folders and files: ``` ./assembly/ ./assembly/tests/ ./assembly/tests/example.spec.ts ./assembly/tests/as-pect.d.ts ```

hoangtrung18_near_nft_deal_otc

.gitpod.yml .vscode settings.json README.md integration-tests package-lock.json package.json src main.ava.ts nft-contract README.md babel.config.json build.sh deploy.sh package-lock.json package.json src approval.ts enumeration.ts index.ts internal.ts metadata.ts mint.ts nft_core.ts royalty.ts tsconfig.json package-lock.json package.json swap-contract README.md babel.config.json build.sh deploy.sh package-lock.json package.json src index.ts internal.ts nft_callbacks.ts takedeal.ts tsconfig.json

# Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```ts @NearBindgen({}) class HelloNear { greeting: string = "Hello"; @view // This method is read-only and can be called for free get_greeting(): string { return this.greeting; } @call // This method changes the state, for which it cost gas set_greeting({ greeting }: { greeting: string }): void { // Record a log permanently to the blockchain! near.log(`Saving greeting ${greeting}`); this.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [node.js](https://nodejs.org/en/download/package-manager/) >= 16. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract 1. Build ```bash npm run build ``` 2. Create account for contract to deploy on near testnet ```bash near create-account swap-contract.YOUR_WALLET_ID.testnet --masterAccount YOUR_WALLET_ID.testnet --initialBalance 10 ``` 3. Deploy your contract has build to testnet You can deploy the contract has build in the NEAR testnet by running: ```bash near deploy --accountId swap-contract.YOUR_WALLET_ID.testnet --wasmFile build/swap.wasm ``` Once finished, check the `swap-contract.YOUR_WALLET_ID.testnet` address in which the contract was deployed: <br /> ## 2. Init contract test Before use contract, we need to init to assign storage address and owner ```bash # Init address near call swap-contract.YOUR_WALLET_ID.testnet init '{"owner_id": "swap-contract.YOUR_WALLET_ID.testnet"}' --accountId swap-contract.YOUR_WALLET_ID.testnet ``` <br /> ## 3.Review and try some test ```bash # Create deal near call swap-contract.YOUR_WALLET_ID.testnet create_deal '{"taker_address": "YOUR_WALLET_ID2.testnet", "zero_for_maker": true, "amount": 0, "maker_nfts": {"tokenId":"token-1", "nftAddress": "nft-contract.YOUR_WALLET_ID.testnet"}, "taker_nfts": {"tokenId":"token-2", "nftAddress": "nft-contract.YOUR_WALLET_ID.testnet"} }' --accountId YOUR_WALLET_ID.testnet --amount 0.1 ``` ```bash # Get deal near view swap-contract.YOUR_WALLET_ID.testnet get_deal '{"deal_id":1}' ``` ```bash # Take deal near call swap-contract.YOUR_WALLET_ID.testnet take_deal '{"deal_id":1}' --accountId YOUR_WALLET_ID.testnet --amount $amount_need_to_pay ``` # NFT Contract ## Quickstart 1. Make sure you have installed [node.js](https://nodejs.org/en/download/package-manager/) >= 16. 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract 1. Build ```bash npm run build ``` 2. Create account for contract to deploy on near testnet ```bash near create-account nft-contract.YOUR_WALLET_ID.testnet --masterAccount YOUR_WALLET_ID.testnet --initialBalance 10 ``` 3. Deploy your contract has build to testnet You can deploy the contract has build in the NEAR testnet by running: ```bash near deploy --accountId nft-contract.YOUR_WALLET_ID.testnet --wasmFile build/nft.wasm ``` Once finished, check the `nft-contract.YOUR_WALLET_ID.testnet` address in which the contract was deployed: <br /> ## 2. Init contract test Before use contract, we need to init to assign storage address and owner ```bash # Init address near call nft-contract.YOUR_WALLET_ID.testnet init '{"owner_id": "nft-contract.YOUR_WALLET_ID.testnet"}' --accountId nft-contract.YOUR_WALLET_ID.testnet ``` <br /> ## 3.Review and try some test ```bash # Min nft near call nft-contract.YOUR_WALLET_ID.testnet nft_mint '{"token_id": "token-1", "metadata": {"title": "My Non Fungible Team Token", "description": "The Team Most Certainly Goes :)", "media": "https://bafybeiftczwrtyr3k7a2k4vutd3amkwsmaqyhrdzlhvpt33dyjivufqusq.ipfs.dweb.link/goteam-gif.gif"}, "receiver_id": "YOUR_WALLET_ID.testnet"}' --accountId YOUR_WALLET_ID.testnet --amount 0.1 ``` ```bash # Check nft near view nft-contract.YOUR_WALLET_ID.testnet nft_token '{"token_id":"token-1"}' ``` ```bash # Transfer nft near call nft-contract.YOUR_WALLET_ID.testnet nft_transfer '{"token_id": "token-2", "receiver_id": "YOUR_WALLET_ID2.testnet", "approval_id": "YOUR_WALLET_ID.testnet" }' --accountId YOUR_WALLET_ID.testnet --depositYocto 1 ``` ```bash # assign approve nft near call nft-example.testnet nft_approve '{"token_id": "token-3", "account_id":"swap-example.tny.testnet", "msg":""}' --accountId tny.testnet --depositYocto 1 ``` near-blank-project ================== This app was initialized with [create-near-app] npx create-near-app Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login

esaminu123_console-boilerplate-template-rs-local-copy-91

.eslintrc.yml .github ISSUE_TEMPLATE 01_BUG_REPORT.md 02_FEATURE_REQUEST.md 03_CODEBASE_IMPROVEMENT.md 04_SUPPORT_QUESTION.md config.yml PULL_REQUEST_TEMPLATE.md labels.yml workflows codeql.yml deploy-to-console.yml labels.yml lock.yml pr-labels.yml stale.yml .gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs docs CODE_OF_CONDUCT.md CONTRIBUTING.md SECURITY.md frontend App.js assets global.css logo-black.svg logo-white.svg index.html index.js near-interface.js near-wallet.js package.json start.sh ui-components.js integration-tests Cargo.toml src tests.rs package.json

<h1 align="center"> <a href="https://github.com/near/boilerplate-template-rs"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_light.png"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_dark.png"> <img alt="" src="https://raw.githubusercontent.com/near/boilerplate-template-rs/main/docs/images/pagoda_logo_dark.png"> </picture> </a> </h1> <div align="center"> Rust Boilerplate Template <br /> <br /> <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> · <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> . <a href="https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+">Ask a Question</a> </div> <div align="center"> <br /> [](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) [](https://github.com/near) </div> <details open="open"> <summary>Table of Contents</summary> - [About](#about) - [Built With](#built-with) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors & contributors](#authors--contributors) - [Security](#security) </details> --- ## About This project is created for easy-to-start as a React + Rust skeleton template in the Pagoda Gallery. It was initialized with [create-near-app]. Clone it and start to build your own gallery project! ### Built With [create-near-app], [amazing-github-template](https://github.com/dec0dOS/amazing-github-template) Getting Started ================== ### Prerequisites Make sure you have a [current version of Node.js](https://nodejs.org/en/about/releases/) installed – we are targeting versions `16+`. Read about other [prerequisites](https://docs.near.org/develop/prerequisites) in our docs. ### Installation Install all dependencies: npm install Build your contract: npm run build Deploy your contract to TestNet with a temporary dev account: npm run deploy Usage ===== Test your contract: npm test Start your frontend: npm start Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages ## Roadmap See the [open issues](https://github.com/near/boilerplate-template-rs/issues) for a list of proposed features (and known issues). - [Top Feature Requests](https://github.com/near/boilerplate-template-rs/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction) - [Top Bugs](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction) - [Newest Bugs](https://github.com/near/boilerplate-template-rs/issues?q=is%3Aopen+is%3Aissue+label%3Abug) ## Support Reach out to the maintainer: - [GitHub issues](https://github.com/near/boilerplate-template-rs/issues/new?assignees=&labels=question&template=04_SUPPORT_QUESTION.md&title=support%3A+) ## Project assistance If you want to say **thank you** or/and support active development of Rust Boilerplate Template: - Add a [GitHub Star](https://github.com/near/boilerplate-template-rs) to the project. - Tweet about the Rust Boilerplate Template. - Write interesting articles about the project on [Dev.to](https://dev.to/), [Medium](https://medium.com/) or your personal blog. Together, we can make Rust Boilerplate Template **better**! ## Contributing First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**. Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you for being involved! ## Authors & contributors The original setup of this repository is by [Dmitriy Sheleg](https://github.com/shelegdmitriy). For a full list of all authors and contributors, see [the contributors page](https://github.com/near/boilerplate-template-rs/contributors). ## Security Rust Boilerplate Template follows good practices of security, but 100% security cannot be assured. Rust Boilerplate Template is provided **"as is"** without any **warranty**. Use at your own risk. _For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._ # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.

immhrmwn_realitychain-monorepo

lerna.json package.json packages realitychain-contracts erc20 .eslintrc.js .solhint.json README.md hardhat.config.ts package.json scripts deploy-and-transfer.ts deploy.ts test index.ts tsconfig.json nft-parcels Cargo.toml build.sh package.json src core.rs event.rs lib.rs metadata.rs mint.rs nft-vouchers Cargo.toml build.sh package.json src core.rs event.rs lib.rs metadata.rs mint.rs mock.rs receiver.rs realitychain-sdk-js babel.config.js example index.ts package.json src auth.ts change-methods.ts constant.ts index.ts interfaces.ts near-api.ts view-methods.ts test index.spec.ts jest.json mock mock-parameters.ts tsconfig.json tslint.json realitychain-webapp README.md package.json public index.html manifest.json robots.txt src App.css App.js App.test.js assets logo-rc.svg logo.svg wallets ethereum.svg metamask.svg near.svg near24.svg polygon.svg components ConnectWallet.js Create Create.js Render IconButtonUpload.js create.style.js CreateNFT CreateNFT.js create.style.js Discover Discover.js Render Tables.js discover.style.js Header.js HomePage.js ModalConnect.js NFTDetail NftDetail.js nft-detail.style.js Navbar Navbar.js navbar.style.js Parcel Parcel.js ParcelList.js Profile Profile.js Render Modal.js Nft Nft.js nft.style.js modal.style.js profile.style.js Project Project.js project.style.js ProjectDetail ProjectDetail.js Render NftParcels.js nft-parcels.style.js project-detail.style.js Series.css Series.js Tabs TabList.js TabList.styles.js TabPanel.js Tabs.js Tabs.styles.js World.css World.js config.js index.css index.js logo.svg reportWebVitals.js setupTests.js themes dark-theme.js utils.js

# Advanced Sample Hardhat Project This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem. The project comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts. It also comes with a variety of other tools, preconfigured to work with the project code. Try running some of the following tasks: ```shell npx hardhat accounts npx hardhat compile npx hardhat clean npx hardhat test npx hardhat node npx hardhat help REPORT_GAS=true npx hardhat test npx hardhat coverage npx hardhat run scripts/deploy.ts TS_NODE_FILES=true npx ts-node scripts/deploy.ts npx eslint '**/*.{js,ts}' npx eslint '**/*.{js,ts}' --fix npx prettier '**/*.{json,sol,md}' --check npx prettier '**/*.{json,sol,md}' --write npx solhint 'contracts/**/*.sol' npx solhint 'contracts/**/*.sol' --fix ``` # Etherscan verification To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Ropsten. In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Ropsten node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract: ```shell hardhat run --network ropsten scripts/deploy.ts ``` Then, copy the deployment address and paste it in to replace `DEPLOYED_CONTRACT_ADDRESS` in this command: ```shell npx hardhat verify --network ropsten DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!" ``` # Performance optimizations For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [the documentation](https://hardhat.org/guides/typescript.html#performance-optimizations). This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). ## Install dependencies By default, dependencies were installed when this application was generated. Whenever dependencies in `package.json` are changed, run the following command: ```sh yarn install ``` ## Run the application ```sh yarn start ``` Runs the app in the development mode.\ Open [http://localhost:3000](http://localhost:3000) to view it in your browser. The page will reload when you make changes.\ You may also see any lint errors in the console.

nearprotocol_SwiftyCam

CHANGELOG.md DemoSwiftyCam DemoSwiftyCam AppDelegate.swift Assets.xcassets AppIcon.appiconset Contents.json Contents.json cancel.imageset Contents.json flash.imageset Contents.json flashOutline.imageset Contents.json flashauto.imageset Contents.json flipCamera.imageset Contents.json focus.imageset Contents.json PhotoViewController.swift SwiftyRecordButton.swift VideoViewController.swift ViewController.swift SwiftyCam-iOS SwiftyCam-iOS.h Package.swift README.md | Source Orientation.swift PreviewView.swift SwiftyCamButton.swift SwiftyCamViewController.swift SwiftyCamViewControllerDelegate.swift

<img src="SwiftyCamBanner.jpg" align="center"> <p align="center"> <img src="https://img.shields.io/badge/platform-iOS%208%2B-blue.svg?style=flat" alt="Platform: iOS 8+"/> <a href="https://developer.apple.com/swift"><img src="https://img.shields.io/badge/language-swift%204.2-4BC51D.svg?style=flat" alt="Language: Swift 4.2" /></a> <a href="https://cocoapods.org/pods/SwiftyCam"><img src="https://img.shields.io/cocoapods/v/SwiftyCam.svg?style=flat" alt="CocoaPods compatible" /></a> <img src="http://img.shields.io/badge/license-BSD-lightgrey.svg?style=flat" alt="License: BSD" /> <br><br> </p> ## Overview SwiftyCam is a a simple, Snapchat-style iOS Camera framework for easy photo and video capture. SwiftyCam allows users to capture both photos and videos from the same session with very little configuration. Configuring a Camera View Controller in AVFoundation can be tedious and time consuming. SwiftyCam is a drop in View Controller which gives complete control of the AVSession. ### For Swift 4 support, see Swift4 branch ## Features | | SwiftyCam | ------------------------------------- | --------------------- | :sunglasses: | Snapchat-style media capture | :+1: | Support iOS8+ | :camera: | Image capture | :movie_camera: | Video capture | :chart_with_upwards_trend: | Manual image quality settings | :tada: | Front and rear camera support | :flashlight: | Front and rear flash | :sunny: | Retina flash support | :mag_right: | Supports manual zoom | :lock: | Supports manual focus | :last_quarter_moon_with_face: | Low light setting | :speaker: | Background audio support ## Requirements * iOS 8.0+ * Swift 4.2+ ## License SwiftyCam is available under the BSD license. See the LICENSE file for more info. ## Installation ### Cocoapods: SwiftyCam is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile: ```ruby pod "SwiftyCam" ``` ### [Carthage](https://github.com/Carthage/Carthage) Add this to `Cartfile` ``` github "Awalz/SwiftyCam" ~> 2.2.1 ``` ``` $ carthage update SwiftyCam ``` ### Manual Installation: Simply copy the contents of the Source folder into your project. ## Usage Using SwiftyCam is very simple. ### Prerequisites: As of iOS 10, Apple requires the additon of the `NSCameraUsageDescription` and `NSMicrophoneUsageDescription` strings to the info.plist of your application. Example: ```xml <key>NSCameraUsageDescription</key> <string>To Take Photos and Video</string> <key>NSMicrophoneUsageDescription</key> <string>To Record Audio With Video</string> ``` ### Getting Started: If you install SwiftyCam from Cocoapods, be sure to import the module into your View Controller: ```swift import SwiftyCam ``` SwiftyCam is a drop-in convenience framework. To create a Camera instance, create a new UIViewController subclass. Replace the UIViewController subclass declaration with `SwiftyCamViewController`: ```swift class MyCameraViewController : SwiftyCamViewController ``` That is all that is required to setup the AVSession for photo and video capture. SwiftyCam will prompt the user for permission to use the camera/microphone, and configure both the device inputs and outputs. ## Capture ### SwiftyCamButton: SwiftyCam comes with a very convenient method of capturing media. SwiftyCamButton captures photos with a `UITapGestureRecognizer` and captures video with a `UILongPressGestureRecognizer` To use a SwiftyCamButton, simply create one and assign the delegate to your SwiftyCamViewController: ```swift let captureButton = SwiftyCamButton(frame: buttonFrame) captureButton.delegate = self ``` ### Manual: Capturing media with SwiftyCam is very simple. To capture a photo, simply call the `takePhoto` function: ```swift takePhoto() ``` Capturing Video is just as easy. To begin recording video, call the `startVideoRecording` function: ```swift startVideoRecording() ``` To end the capture of a video, call the `stopVideoRecording` function: ```swift stopVideoRecording() ``` ### Delegate In order to acquire the photos and videos taken by either the SwiftyCamButton or manually, you must implement the `SwiftyCamViewControllerDelegate` and set the `cameraDelegate` to your view controller instance: ```swift class MyCameraViewController : SwiftyCamViewController, SwiftyCamViewControllerDelegate { override func viewDidLoad() { super.viewDidLoad() cameraDelegate = self } ... } ``` #### Delegate methods: ```swift func swiftyCam(_ swiftyCam: SwiftyCamViewController, didTake photo: UIImage) { // Called when takePhoto() is called or if a SwiftyCamButton initiates a tap gesture // Returns a UIImage captured from the current session } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didBeginRecordingVideo camera: SwiftyCamViewController.CameraSelection) { // Called when startVideoRecording() is called // Called if a SwiftyCamButton begins a long press gesture } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didFinishRecordingVideo camera: SwiftyCamViewController.CameraSelection) { // Called when stopVideoRecording() is called // Called if a SwiftyCamButton ends a long press gesture } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didFinishProcessVideoAt url: URL) { // Called when stopVideoRecording() is called and the video is finished processing // Returns a URL in the temporary directory where video is stored } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didFocusAtPoint point: CGPoint) { // Called when a user initiates a tap gesture on the preview layer // Will only be called if tapToFocus = true // Returns a CGPoint of the tap location on the preview layer } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didChangeZoomLevel zoom: CGFloat) { // Called when a user initiates a pinch gesture on the preview layer // Will only be called if pinchToZoomn = true // Returns a CGFloat of the current zoom level } func swiftyCam(_ swiftyCam: SwiftyCamViewController, didSwitchCameras camera: SwiftyCamViewController.CameraSelection) { // Called when user switches between cameras // Returns current camera selection } ``` ## Flash The flash(torch) can be enabled by changing the `flashEnabled` property: ```swift flashEnabled = true ``` Flash is now supported for front and rear facing cameras. ### Rear Camera For photos, the camera will flash much like the stock iOS camera. For video, the torch(flash) will enable for the duration of the video capture. ### Front Camera For models that support [Retina Flash](https://developer.apple.com/library/content/documentation/DeviceInformation/Reference/iOSDeviceCompatibility/Cameras/Cameras.html#//apple_ref/doc/uid/TP40013599-CH107-SW7), the front camera will use the default flash for image capture. If Retina Flash is not supported, a faux Retina Flash is used similar to Snapchat. For front facing videos, a white, 85% opaque view will be placed over the video feed for the duration of the video capture. ## Switching Camera By default, SwiftyCam will launch to the rear facing camera. This can be changed by changing the `defaultCamera` property in `viewDidLoad`: ```swift override func viewDidLoad() { super.viewDidLoad() defaultCamera = .front ... } ``` SwiftyCam supports capture from both the front and back cameras. To switch cameras, call the function: ```swift switchCamera() ``` Tap-to-focus, pinch-to-zoom and camera flash are not supported when the front facing camera is selected. *Switching video while video is being recorded is not currently supported* SwiftyCam also enables switching between cameras with a double tap gesture. To disable this feature, use the `doubleTapCameraSwitch` property: ```swift doubleTapCameraSwitch = false ``` ## Configuration SwiftyCam has several options for configurating the functionality of the capture: ### Video Quality Video quality can be set by the **videoQuality** property of SwiftyCamViewController. The choices available correspond to the matching **AVCaptureSessionPreset**: | VideoQuality | AVCaptureSessionPreset | ------------------------------------- | --------------------- | `.high` | **AVCapturePresetHigh** | `.medium` | **AVCapturePresetMedium** | `.low` | **AVCapturePresetLow** | `.resolution352x288` | **AVCaptureSessionPreset352x288** | `.resolution640x480` | **AVCaptureSessionPreset640x480** | `.resolution1280x720` | **AVCaptureSessionPreset1280x720** | `.resolution1920x1080` | **AVCaptureSessionPreset1920x1080** | `.resolution3840x2160` | **AVCaptureSessionPreset3840x2160** | `.iframe960x540` | **AVCaptureSessionPresetiFrame960x540** | `.iframe1280x720` | **AVCaptureSessionPresetiFrame1280x720** The default value is **.high**. For use with the front-facing camera, **.high** will always be used. ### Maximum Video Duration If using a SwiftyCamButton, you can set a maximum video duration for the length of video. The video recording will me automatically stopped once the time limit has been reached and the delegate method `SwiftyCamDidFinishRecordingVideo` will be called. To set this value, simply change the `maximumVideoDuration` value: ```swift maximumVideoDuration = 10.0 ``` A value of **0.0** will allow for unlimited video recording via the SwiftyCamButton. The default value is **0.0**. ## Camera Zoom SwiftyCam supports digital zoom of the camera session via pinch and pan gestures. The gestures work similar to the default iOS app and will zoom to the maximum supported zoom level. Camera zoom is only supported on the rear facing camera. AVFoundation does not currently support front facing camera zoom. To disable this feature, change the `pinchToZoom` property: ```swift pinchToZoom = false ``` By default, ```pinchToZoom``` is enabled. SwiftyCam also supports the ability to zoom the rear facing camera with vertical pan gestures. To disable this feature, change the `swipeToZoom` property: ```swift swipeToZoom = false ``` By default, ```swipeToZoom``` is enabled. The default gestures zoom in the capture session with a downward swipe, and zoom out with an upward swipe. This can be reversed by changing the ```swipeToZoomInverted``` property: ```swift swipeToZoomInverted = true ``` You can also restrict the amount that the rear facing camera can zoom. To do this, use the `maxZoomScale` property: ```swift maxZoomScale = 2.0 ``` By default, `maxZoomScale` is set to **infinite**. The actual maximum zoom level is determined by the device's [videoMaxZoomFactor](https://developer.apple.com/reference/avfoundation/avcapturedeviceformat/1624635-videomaxzoomfactor). ## Camera Focus SwiftyCam, by default, support tap to focus on the video preview. SwiftyCam will set the focus and exposure levels of the session to the tapped point. While tap to set exposure is supported on both cameras, tap to focus is only supported on rear facing cameras. Autofocus and autoexposure will be resumed once SwiftyCam detects significant movement from the tapped point. To disable this feature, change the `tapToFocus` property: ```swift tapToFocus = false ``` By default, `tapToFocus` is enabled. If you wish to show a on screen animation when a tap to focus is initiated, you can use the `SwiftyCamDidFocusAtPoint(focusPoint:)` to get the coordinates of tap and provide your own tap animation ## Device Orientation By default, SwiftyCam will set the photo orientation to be portrait. If you wish to preserve the orientation of the capture photos to allow support for landscape images, use the `shouldUseDeviceOrientation` property: ```swift shouldUseDeviceOrientation = true ``` ## Background Audio SwiftyCam has the ability to allow background audio to continue playing within the session, and to be captured by the video recording. By default, this is enabled. If you wish to disable this feature, change the `allowBackgroundAudio` property: ```swift allowBackgroundAudio = false ``` ## Low Light Boost For supported models (iPhone 5 and 5C), AVCaptureDevice supports a low light boost when it is detected that the capture session is in a low light area. By default, this is set to true. It can be modified with the `lowLightBoost` variable: ```swift lowLightBoost = false ``` ## Privacy When a user firsts launch SwiftyCamViewController, they will be prompted for permission for access to the cameras and microphones. By default, if a user declines access to the hardware, SwiftyCam will provide a prompt to the App privacy settings inside the iOS settings application. ## Miscellaneous Other properties: * `isCameraFlashOn` - **Boolean** * `isVideoRecording` - **Boolean** * `isSessionRunning` - **Boolean** * `currentCamera` - **CameraSelection** ### Contact If you have any questions, requests, or enhancements, feel free to submit a pull request, create an issue, or contact me in person: **Andrew Walz** **andrewjwalz@gmail.com**

nearprotocol_near-e2e-tests

.gitlab-ci.yml README.md nightwatch.conf.js package.json run_ci.sh tests guest-book.js

# near-e2e-tests  End-to-end tests for NEAR apps ## Install dependencies ``` yarn ``` ## Running locally ``` yarn test ``` ## Running on cloud Need to have environment variables or `.env` file: ``` ELENIUM_USERNAME=<username> SELENIUM_ACCESS_KEY=<password/access key> ``` ``` NODE_ENV=ci yarn test:ci ``` ## Useful links - [GitLab project](https://gitlab.com/near-protocol/near-e2e-tests) - [CBT results](https://app.crossbrowsertesting.com/selenium/results)

gadillacer_nft141-marketplace

.eslintrc.js .prettierrc.js .solhint.json .storybook main.js preview.js DEVS-RUN-ME-FIRST.sh README.md compile.sh deploy.sh hardhat.config.ts libraries blockchain chains.ts near config.ts types.d.ts utils.ts signatures.ts types.ts utilities.ts walletConnector.ts next-env.d.ts next.config.js package.json pages api buyNft.ts hello.ts loadNfts.ts loadVaults.ts singleVault.ts postcss.config.js public vercel.svg scripts deploy.ts start.sh stop.sh styles Footer.module.css Header.module.css Layout.module.css Nav.module.css globals.css tailwind.config.js test.sh test marketplace.ts tsconfig.json typechain-types ERC165.ts ERC721.ts ERC721URIStorage.ts Greeter.ts IERC165.ts IERC721.ts IERC721Metadata.ts IERC721Receiver.ts Market.ts NFT.ts NFTMarket.ts common.ts factories ERC165__factory.ts ERC721URIStorage__factory.ts ERC721__factory.ts Greeter__factory.ts IERC165__factory.ts IERC721Metadata__factory.ts IERC721Receiver__factory.ts IERC721__factory.ts Market__factory.ts NFTMarket__factory.ts NFT__factory.ts hardhat.d.ts index.ts

# Demo NFT Marketplace ### Goals: - Concise code - Well typed - Modern react code using hooks + functional features - Code can be easily refactored - Easy for other developers to contribute and leverage the code - Fast. Server side rendering as much as possible - Extensible. Code in this project is useful in many dapps or as providing inspiration ### Tech stack: *code* - Typescript (default is JS [any type / untyped], typed where possible. Aiming for fully typed code a.k.a proper Typescript code) *content frameworks* - NextJs (React fairy dust. More is more. NextJs makes make aspects of react development a lot easier) *styles* - Tailwind CSS + PostCSS (Tailwind supplies CSS, postCSS is the preprocessor) *ethereum dev tools* - Hardhat (Based smart contracts dev suite) - Ethers (Because it's the standard library to interact with blockchain and is a well trodden library many developers have already navigated) - Web3Modal (It's nice yeah.. I'm not happy with the wallet integration code yet. It's a mess **WIP**) # DEVS START HERE *the 2 steps to success* 1. install `tmux` on your local machine if not installed already 2. run `source DEVS-RUN-ME-FIRST.sh` ### Starting the servers 1. run `start` *or ./start.sh if you chose not to set up this projects aliases* ### Stopping the servers 1. run `stop` *or ./stop.sh if you chose not to set up this projects aliases* # Preview 

iceshap7_crxl_tientd.near

.gitpod.yml README.md babel.config.js contract Cargo.toml README.md compile.js src lib.rs target .rustc_info.json debug .fingerprint Inflector-dc1b0cb91bf9902c lib-inflector.json autocfg-e366de0db4ad4473 lib-autocfg.json borsh-derive-e81c7585006eb27d lib-borsh-derive.json borsh-derive-internal-5f1af634f480b60d lib-borsh-derive-internal.json borsh-schema-derive-internal-48ebb6db851f3cfc lib-borsh-schema-derive-internal.json byteorder-cfcfd33819aaeb82 build-script-build-script-build.json convert_case-be5b393bbc5dc5be lib-convert_case.json derive_more-ee7a47101f4f8024 lib-derive_more.json generic-array-40945ed54f16fa02 build-script-build-script-build.json hashbrown-4cb24befe9eb1d6e run-build-script-build-script-build.json hashbrown-513b8ca527e8ed1d build-script-build-script-build.json hashbrown-a818d1b2e673f2a3 lib-hashbrown.json indexmap-38a528cbba01ce7f lib-indexmap.json indexmap-b75640b3605a8083 build-script-build-script-build.json indexmap-db19b19aa9c93102 run-build-script-build-script-build.json itoa-3892e76fc43758bc lib-itoa.json memchr-576ce00a364867af build-script-build-script-build.json near-rpc-error-core-d902dc7a846fdc9c lib-near-rpc-error-core.json near-rpc-error-macro-a2da856d5be2da2e lib-near-rpc-error-macro.json near-sdk-core-516403a2c9ad9aac lib-near-sdk-core.json near-sdk-macros-f26fbf5b025fd581 lib-near-sdk-macros.json num-bigint-d0f9239166665034 build-script-build-script-build.json num-integer-1ce2d13d9d668473 build-script-build-script-build.json num-rational-4bdd53761ac11fd2 build-script-build-script-build.json num-traits-c629969f86a877a0 build-script-build-script-build.json proc-macro-crate-49741cb4a6f3aca9 lib-proc-macro-crate.json proc-macro2-656033417d34c488 lib-proc-macro2.json proc-macro2-68644979a1fe8677 build-script-build-script-build.json proc-macro2-e60295e92141322c run-build-script-build-script-build.json quote-9e882fc5da02c355 lib-quote.json ryu-8606a6542969bd33 run-build-script-build-script-build.json ryu-8f3b5e399d1b8c7f build-script-build-script-build.json ryu-fe4db1858bc26aa1 lib-ryu.json serde-65be8d96a18c8bf9 run-build-script-build-script-build.json serde-86246f3458be55de lib-serde.json serde-9234efb8daa3d677 build-script-build-script-build.json serde_derive-7c324d9a953d0f5e lib-serde_derive.json serde_derive-c812a5ce7a8050ec run-build-script-build-script-build.json serde_derive-ed2d7488d0e3294f build-script-build-script-build.json serde_json-28c7aaf2493380d2 lib-serde_json.json serde_json-c85e50f94b1eedb8 run-build-script-build-script-build.json serde_json-ff31285f57d88877 build-script-build-script-build.json syn-219eebaa4cf0c74d run-build-script-build-script-build.json syn-5bfbb3ac02110a17 build-script-build-script-build.json syn-e3b38f053516482f lib-syn.json toml-428ac06aa140e34e lib-toml.json typenum-7b445c416c9e01e7 build-script-build-script-main.json unicode-xid-537d6349edbccd46 lib-unicode-xid.json version_check-0c089fbd7293b81e lib-version_check.json wee_alloc-c84c360b765943bb build-script-build-script-build.json wasm32-unknown-unknown debug .fingerprint ahash-2045e0abf161c316 lib-ahash.json aho-corasick-681c6c7a03960ae4 lib-aho_corasick.json base64-0f44fecfd27ded86 lib-base64.json block-buffer-c888edcc8750c317 lib-block-buffer.json block-buffer-ea33d34b4a764006 lib-block-buffer.json block-padding-1ecc478612152074 lib-block-padding.json borsh-8a7378cdcc27a391 lib-borsh.json bs58-13ddf32e06b865a8 lib-bs58.json byte-tools-bee3ebc590b66f0c lib-byte-tools.json byteorder-99625f2ead1ffdb2 run-build-script-build-script-build.json byteorder-9b1dbd4ba7f7a5dd lib-byteorder.json cfg-if-406b774a9f5585db lib-cfg-if.json cfg-if-d6c4b0fe3f1a7032 lib-cfg-if.json digest-19447d01276afefa lib-digest.json digest-7420152e70576f89 lib-digest.json generic-array-1e352f3d9b2a9b63 run-build-script-build-script-build.json generic-array-a7c117179bedb425 lib-generic_array.json generic-array-eb30cc461ecce1a0 lib-generic_array.json greeter-98ace302c5fafa12 lib-greeter.json hashbrown-5b954e3dc0e468a4 run-build-script-build-script-build.json hashbrown-787ef66030b4297c lib-hashbrown.json hashbrown-87d440e9a0527564 lib-hashbrown.json hex-2ead8561e5ebec3c lib-hex.json indexmap-6824f4debd0bb7bf lib-indexmap.json indexmap-ae763997c59bebd6 run-build-script-build-script-build.json itoa-e7b9b850f03874ed lib-itoa.json keccak-29fc0c8280c8645c lib-keccak.json lazy_static-9957d1fa279a8193 lib-lazy_static.json memchr-2e214dc990a9a6f7 run-build-script-build-script-build.json memchr-436a3744be3760a0 lib-memchr.json memory_units-8defb40d13822931 lib-memory_units.json near-primitives-core-18e6d762d289914b lib-near-primitives-core.json near-runtime-utils-20fda7014eb2bb28 lib-near-runtime-utils.json near-sdk-a332ba19e5be98a6 lib-near-sdk.json near-vm-errors-af75e63bca5cfb15 lib-near-vm-errors.json near-vm-logic-784329b1092bf88e lib-near-vm-logic.json num-bigint-2f2cb7e9e802a522 run-build-script-build-script-build.json num-bigint-4be5f5f46e515779 lib-num-bigint.json num-integer-1c2edf84b4b17e7e run-build-script-build-script-build.json num-integer-f6d70f37c6c01c58 lib-num-integer.json num-rational-9803732d88cbd585 run-build-script-build-script-build.json num-rational-997ff24679c92f18 lib-num-rational.json num-traits-83a3442673781e60 run-build-script-build-script-build.json num-traits-ae81cdbf11740891 lib-num-traits.json opaque-debug-45db8bc03f758a50 lib-opaque-debug.json opaque-debug-54e69003260d421c lib-opaque-debug.json regex-3c74cf2c2311c782 lib-regex.json regex-syntax-575403b816d0b11e lib-regex-syntax.json ryu-cd66b80b67f6789e run-build-script-build-script-build.json ryu-e5c64ba4038231cf lib-ryu.json serde-7a6eea569cb33f90 run-build-script-build-script-build.json serde-b72675913e13924f lib-serde.json serde_json-137257aafbeba870 lib-serde_json.json serde_json-40defe876a3e29ac run-build-script-build-script-build.json sha2-127d5e4de240fd55 lib-sha2.json sha3-e41411c861b6a593 lib-sha3.json typenum-11aa8bef3f3b3f6f run-build-script-build-script-main.json typenum-7999214b8e6d95ca lib-typenum.json wee_alloc-4aff0af8240b3ea6 run-build-script-build-script-build.json wee_alloc-88c01dc54fdc7ef9 lib-wee_alloc.json build num-bigint-2f2cb7e9e802a522 out radix_bases.rs typenum-11aa8bef3f3b3f6f out consts.rs op.rs tests.rs wee_alloc-4aff0af8240b3ea6 out wee_alloc_static_array_backend_size_bytes.txt package.json src App.js __mocks__ fileMock.js assets logo-black.svg logo-white.svg config.js global.css index.html index.js jest.init.js main.test.js utils.js wallet login index.html

company_review ================== This [React] app was initialized with [create-near-app] Quick Start =========== To run this project locally: 1. Prerequisites: Make sure you've installed [Node.js] ≥ 12 2. Install dependencies: `yarn install` 3. Run the local development server: `yarn dev` (see `package.json` for a full list of `scripts` you can run with `yarn`) Now you'll have a local development environment backed by the NEAR TestNet! Go ahead and play with the app and the code. As you make code changes, the app will automatically reload. Exploring The Code ================== 1. The "backend" code lives in the `/contract` folder. See the README there for more info. 2. The frontend code lives in the `/src` folder. `/src/index.html` is a great place to start exploring. Note that it loads in `/src/index.js`, where you can learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and the smart contract. See `contract/README` for info about how it's tested. The frontend code gets tested with [jest]. You can run both of these at once with `yarn run test`. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `yarn dev`, your smart contract gets deployed to the live NEAR TestNet with a throwaway account. When you're ready to make it permanent, here's how. Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `yarn install`, but for best ergonomics you may want to install it globally: yarn install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `company_review.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `company_review.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account company_review.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: set contract name in code --------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'company_review.YOUR-NAME.testnet' Step 3: deploy! --------------- One command: yarn deploy As you can see in `package.json`, this does two things: 1. builds & deploys smart contract to NEAR TestNet 2. builds & deploys frontend code to GitHub using [gh-pages]. This will only work if the project already has a repository set up on GitHub. Feel free to modify the `deploy` script in `package.json` to deploy elsewhere. Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [React]: https://reactjs.org/ [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/docs/concepts/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages company_review Smart Contract ================== A [smart contract] written in [Rust] for an app initialized with [create-near-app] Quick Start =========== Before you compile this code, you will need to install Rust with [correct target] Exploring The Code ================== 1. The main smart contract code lives in `src/lib.rs`. You can compile it with the `./compile` script. 2. Tests: You can run smart contract tests with the `./test` script. This runs standard Rust tests using [cargo] with a `--nocapture` flag so that you can see any debug info you print to the console. [smart contract]: https://docs.near.org/docs/develop/contracts/overview [Rust]: https://www.rust-lang.org/ [create-near-app]: https://github.com/near/create-near-app [correct target]: https://github.com/near/near-sdk-rs#pre-requisites [cargo]: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html

near_devrel

.github ISSUE_TEMPLATE BOUNTY.yml devrel-resource-request-process.md proposal-template.md workflows main.yml README.md

# devrel Developer Relations @NEARProtocol # Kanban Board https://github.com/orgs/near/projects/14 Epics (composed of many tasks) 1. Add an issue (this enables GH comments on your Epic) 2. Link to gov.near.org (devrel category) post if you want community ideas and input - recommended 3. Add notes for sub-tasks to the same board 4. Done when all tasks are done Tasks 1. Use notes and add to board 2. Edit notes to update on task progress 3. Move through board as progress is made ## Notes Minimal Process Goals 1. Work in public 2. Self document 3. Everyone can see what everyone is doing in one place

here-wallet_instant_wallet_appclip

Resources Assets.xcassets AppIcon.appiconset Contents.json Contents.json Sources AppDelegate.swift AppInfo.swift AppViewController.swift Core AccountState.swift BIP70.swift CancelBag.swift Deeplink.swift ErrorMessage.swift ErrorPresentation.swift Extensions.swift NearNickname.swift Person.swift Repositories FtOverviewToken.swift HereKeychain.swift PhoneLinkWebRepository.swift Remote BackendApi.swift Base HTTPHeader.swift HTTPMethod.swift BaseWebRepository.swift UserSessionRepository.swift WalletUserSessionRepository.swift UserProfile.swift UserSession.swift HereCryptoConverter.swift MoneyFromLink MoneyFromLink.swift MoneyFromLinkView.swift MoneyFromLinkViewController.swift Nickname NicknameAction.swift NicknameGiftVC.swift NicknameRemoteRepository.swift NicknameViewModel.swift NicknamegiftView.swift PressedWalletButton.swift SignedViewController.swift

NEARBuilders_minterest

.eslintrc.json README.md generate-css.js next.config.js package.json postcss.config.js public images MB_logo.svg arrow_back.svg cameraswitch.svg file_arrow_up.svg gift.svg link_arrow.svg near_logo.svg photo_camera-2.svg photo_camera.svg trophy.svg styles.css src app globals.css constants.ts data fallback.ts fetch.ts getBlockedNfts.ts graphqlService.ts network.ts queries feed.graphl.ts useGraphQlQuery.ts hooks useBlockedNfts.ts useCamera.ts useFeed.ts useFirstToken.ts useInfiniteScroll.ts useLeaderboard.ts style global.css utils base64ToFile.ts cachedImage.ts generateRandomId.ts tailwind.config.ts tsconfig.json

# Minsta This repository hosts the primary codebase for the [Minsta App](https://minsta.me), originally created and developed by [@microchipgnu](https://github.com/microchipgnu). All new Minsta instances should be derived from this repository. ## Demo Check out the live demo here: [minsta demo](https://minsta-app.vercel.app/). ## One-Click Deploy Deploy this project using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme): [](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FMintbase%2Fminsta) ## Getting Started To start with this project: 1. Clone the repository. 2. If you don't have `pnpm` installed, run: ```bash npm install -g pnpm ``` 3. Then, install the required dependencies: ```bash pnpm install ``` ## Environment Variables Refer to the **.env.example** file for the environment variables used in this project. If you don't set up a `.env` file or environment variables with your provider, the project will retrieve values from the following files: 1. For CSS generation during build: `generate-css.js` 2. For configuration variables: `src/constants.ts` 3. For fallback metadata and text values: `src/fallback.ts` ## Local Development To run the project locally, use: ```bash pnpm dev ``` ## Updating Environment Variables ### Running Locally If you're running your project locally, follow these steps to update your environment variables: 1. Save your changes in the `.env` file. 2. Run `pnpm dev` again to apply the updated environment variables. 3. Reload the page to reflect the changes. ### Deployed on Vercel If you have deployed your project on Vercel, follow these steps to update your environment variables: 1. Log in to your Vercel account. 2. Navigate to the project settings for your deployed app. 3. Update the environment variables in the Vercel dashboard. 4. Trigger a redeployment of your app to apply the changes. By following these steps, you can ensure that your project uses the updated environment variables.

mehtaphysical_stripe-pay-sandbox

README.md components balance Balance.js checkout Checkout.js Checkout.module.css layout Layout.js Layout.module.css loading Loading.js Loading.module.css contract Cargo.toml src lib.rs deploy.sh package.json pages [accountId] index.js success [transactionHash].js _app.js api [accountId] complete.js pay.js public vercel.svg services contacts.js near.js stripe.js styles Home.module.css globals.css

# Setup the contract use the deploy script `./deploy.sh` It will do the following: * build the contract with `cargo build --all --target wasm32-unknown-unknown --release` * create the contract account `near create-account $CONTRACT_ID --masterAccount SOME_MASTER_ACCOUNT --initialBalance INITIAL_BALANCE` * then deploy the contract `near deploy $CONTRACT_ID target/wasm32-unknown-unknown/release/contract.wasm` * setup the contract so only transfers are allowed to the marketplace `near call $CONTRACT_ID new '{"marketplace_id":"MARKETPLACE_ID"}' --accountId $CONTRACT_ID` * pay for marketplace storage `near call $CONTRACT_ID storage_deposit "{\"account_id\":\"$MARKETPLACE_ID\",\"registration_only\": true}" --accountId $CONTRACT_ID --amount 0.00125`

Learn-NEAR-Hispano_NCD2--CovidVaccinationNear

README.md as-pect.config.js asconfig.json assembly __test__ as-pect.d.ts index.unit.spec.ts as_types.d.ts index.ts models.ts tsconfig.json PERSONAS CERTIFICADOS DE VACUNACIÓN CONTAGIOS Métodos del smart contract de Vacunas Métodos del smart contract de Personas Métodos del smart contract de Certificados de Vacunación Métodos del smart contract de Certificados de Contagios package-lock.json package.json

# `CovidVaccination` 📄 Descripción ================== CovidVaccination Es un contrato inteligente que puede crear vacunas, personas a vacunar, certificados de vacunación, y contagios entre personas vacunadas y registradas, todos lo sdatos son almacenados mediante el protocolo de NEAR. El listado siguiente estan las principales funcionalidades de este contrato inteligente. Listado: VACUNAS ============= 1. Crear vacunas. 2. Listado de Vacunas. 3. Buscar vacuna por ID. PERSONAS ============= 1. Crear personas. 2. Listar todas las personas. 3. Buscar persona por ID. CERTIFICADOS DE VACUNACIÓN ============= 1. Crear certificado de vacunación. 2. Listar todos los certificados de vacunación. 3. Buscar certificado de vacunación por ID. 4. Buscar certificado de vacunación por persona_id. 5. Buscar certificado de vacunación por vacuna_id. 6. Buscar certificado de vacunación por país. CONTAGIOS COVID ============= 1. Crear contagios COVID. 2. Listar todos los contagios COVID. 3. Buscar contagio por ID. 4. Buscar contagio por persona_id. 5. Buscar contagio por nivel de infección. 📦 Instalación ================ Para ejecutar este proyecto localmente, debe seguir los siguientes pasos: Paso 1: Prerequisitos ------------------------------ 1. Asegúrese de haber instalado [Node.js] ≥ 12 (recomendamos usar [nvm]) 2. Asegúrese de haber instalado yarn: `npm install -g yarn` 3. Instalar dependencias: `yarn install` 4. Cree una cuenta de prueba NEAR [https://wallet.testnet.near.org/] 5. Instale NEAR CLI globalmente: [near-cli] es una interfaz de línea de comandos (CLI) para interactuar con NEAR blockchain yarn install --global near-cli Step 2: Configuración de NEAR CLI ------------------------------- Configure su near-cli para autorizar su cuenta de prueba creada recientemente: near login Paso 3: Cree y realice una implementación de desarrollo de contrato inteligente -------------------------------- Cree el código del contrato inteligente de CovidVaccination e implemente el servidor de desarrollo local: `yarn buil` (consulte` package.json` para obtener una lista completa de `scripts` que puede ejecutar con` yarn`). Este script le devuelve un contrato inteligente provisional implementado (guárdelo para usarlo más tarde). Para desplegar el contrato generado con `yarn buil` en testnet [https://wallet.testnet.near.org/], ejecutar el comando `yarn deploy` el cual nos regresará el id del contrato desplegado el cuál usaremos para ejecutar cada uno de los métodos que contiene el contrato. 📑 Explorando los métodos de contrato inteligente CovidVaccination ================== Los siguientes comandos le permiten interactuar con los métodos del contrato inteligente utilizando NEAR CLI (para esto, debe tener implementado un contrato inteligente provisional). VACUNAS ================= Comando para crear Vacuna: -------------------------------------------- near call $CONTRACT setVacuna '{ "id": "string", "nombre": "string", "fabricante": "string", "tipo": "string", "administracion": "string", "dosis": "string" }' --account-id <your test account> Comando para consultar todas las vacunas: -------------------------------------------- near view $CONTRACT getVacunas Comando para consultar una vacuna por id: -------------------------------------------- near view $CONTRACT getVacuna '{"id":"id"}' PERSONAS ================= Comando para crear una Persona: -------------------------------------------- near call $CONTRACT setPersona '{ "id": "string", "nacionalidad": "string", "nombre": "string", "foto": "string", "fecha_nacimiento":"string" }' --account-id <your test account> Comando para consultar todas las pesonas: -------------------------------------------- near view $CONTRACT getPersonas Comando para consultar una persona por id: -------------------------------------------- near view $CONTRACT getPersona '{"id":"id"}' CERTIFICADOS DE VACUNACIÓN ================= Comando para crear una Certificado de Vacunación: -------------------------------------------- near call $CONTRACT setCertificado '{ "id": "string", "vacuna_id": "string", "persona_id": "string", "pais": "string", "fecha_aplicacion": "string", "lote_vacuna": "string", "sello_digital": "u64" }' --account-id <your test account> Comando para consultar todos los Certificados de Vacunación: -------------------------------------------- near view $CONTRACT getCertificados Comando para consultar una persona por id: -------------------------------------------- near view $CONTRACT getCertificado '{"id":"id"}' CONTAGIOS DE COVID ================= Comando para crear Contagios de Covid: -------------------------------------------- near call $CONTRACT setContagio '{ "id":"string", "persona_id": "string", "certificado_id": "string", "fecha_contagio": "string", "fecha_recuperacion": "string", "nivel_infeccion": "string" }' --account-id <your test account> Comando para consultar todos los Certificados de Vacunación: -------------------------------------------- near view $CONTRACT getContagios Comando para consultar una persona por id: -------------------------------------------- near view $CONTRACT getContagio '{"id":"id"}' 🤖 Pruebas -------------------------------- Utilice el siguiente comando para ejecutar las pruebas: yarn test 🖥️ Mokups -------------------------------- https://www.figma.com/file/8Q2xrTtygnwgQsy9YcVcqH/CovidVaccination?node-id=0%3A1 🎬 Video -------------------------------- https://www.loom.com/share/0de6381903034e7ba5148744f60cd0fb?sharedAppSource=personal_library

jrapbit_token-contracts

.dependabot config.yml .gitpod.yml .travis.yml LICENSE-APACHE.txt LICENSE-MIT.txt README-Gitpod.md README.md as-pect.config.js asconfig.json assembly __tests__ as-pect.d.ts example.spec.ts token.spec.ts as_types.d.ts index.ts tsconfig.json neardev shared-test-staging test.near.json shared-test test.near.json package-lock.json package.json src config.js index.html loader.html main.js test.js

Token Contract in AssemblyScript ================================ [](https://gitpod.io/#https://github.com/near-examples/token-contract-as) <!-- MAGIC COMMENT: DO NOT DELETE! Everything above this line is hidden on NEAR Examples page --> This project contains an implementation of a token contract similar to [ERC20](https://theethereum.wiki/w/index.php/ERC20_Token_Standard) but simpler. We'll visit a page, sign in and use your browser's console to run commands to initialize, send, and get the balance of a custom token. **Note**: this example uses a basic version of a token. It is not the supported token contract laid out in the [NEAR Enhancement Proposal for non-fungible tokens](https://github.com/nearprotocol/NEPs/pull/4). Visit [this example](https://github.com/near-examples/NFT) illustrating implementations of the non-fungible token in Rust and AssemblyScript. It is not recommended to deploy non-fungible tokens written in AssemblyScript for financial use cases. Getting started =============== There's a button at the top of this file that says "Open in Gitpod." If you want to try out this project as fast as possible, that's what you want. It will open the project in your browser with a complete integrated development environment configured for you. If you want to run the project yourself locally, read on. There are two ways to run this project locally. The first is quick, and a good way to instantly become familiar with this example. Once familiar, the next step is to create your own NEAR account and deploy the contract to testnet. Quick option --------------- 1. Install dependencies: yarn 2. Build and deploy this smart contract to a development account. This development account will be created automatically and is not intended for reuse: yarn dev Standard deploy option ---------------------- In this second option, the smart contract will get deployed to a specific account created with the NEAR Wallet. 1. Ensure `near-cli` is installed by running: near --version If needed, install `near-cli`: npm install near-cli -g 2. If you do not have a NEAR account, please create one with [NEAR Wallet](https://wallet.nearprotocol.com). Then, in the project root, login with `near-cli` by following the instructions after this command: near login 3. Modify the top of `src/config.js`, changing the `CONTRACT_NAME` to be the NEAR account that you just used to log in. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'YOUR_ACCOUNT_NAME_HERE'; /* TODO: fill this in! */ 4. Start the example! yarn start Exploring The Code ================== 1. The backend code lives in the `/assembly` folder. This code gets deployed to the NEAR blockchain when you run `yarn deploy:contract`. This sort of code-that-runs-on-a-blockchain is called a "smart contract" – [learn more about NEAR smart contracts][smart contract docs]. 2. The frontend code lives in the `/src` folder. [/src/index.html](/src/index.html) is a great place to start exploring. Note that it loads in `/src/main.js`, where you can learn how the frontend connects to the NEAR blockchain. 3. Tests: there are different kinds of tests for the frontend and backend. The backend code gets tested with the [asp] command for running the backend AssemblyScript tests, and [jest] for running frontend tests. You can run both of these at once with `yarn test`. Both contract and client-side code will auto-reload as you change source files. [smart contract docs]: https://docs.nearprotocol.com/docs/roles/developer/contracts/assemblyscript [asp]: https://www.npmjs.com/package/@as-pect/cli [jest]: https://jestjs.io/

mucahittanacioglu_near-starter2

README.md as-pect.config.js asconfig.json package.json scripts 1.dev-deploy.sh 2.use-contract.sh 3.cleanup.sh README.md src as_types.d.ts simple __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts singleton __tests__ as-pect.d.ts index.unit.spec.ts asconfig.json assembly index.ts tsconfig.json utils.ts

## Setting up your terminal The scripts in this folder are designed to help you demonstrate the behavior of the contract(s) in this project. It uses the following setup: ```sh # set your terminal up to have 2 windows, A and B like this: ┌─────────────────────────────────┬─────────────────────────────────┐ │ │ │ │ │ │ │ A │ B │ │ │ │ │ │ │ └─────────────────────────────────┴─────────────────────────────────┘ ``` ### Terminal **A** *This window is used to compile, deploy and control the contract* - Environment ```sh export CONTRACT= # depends on deployment export OWNER= # any account you control # for example # export CONTRACT=dev-1615190770786-2702449 # export OWNER=sherif.testnet ``` - Commands _helper scripts_ ```sh 1.dev-deploy.sh # helper: build and deploy contracts 2.use-contract.sh # helper: call methods on ContractPromise 3.cleanup.sh # helper: delete build and deploy artifacts ``` ### Terminal **B** *This window is used to render the contract account storage* - Environment ```sh export CONTRACT= # depends on deployment # for example # export CONTRACT=dev-1615190770786-2702449 ``` - Commands ```sh # monitor contract storage using near-account-utils # https://github.com/near-examples/near-account-utils watch -d -n 1 yarn storage $CONTRACT ``` --- ## OS Support ### Linux - The `watch` command is supported natively on Linux - To learn more about any of these shell commands take a look at [explainshell.com](https://explainshell.com) ### MacOS - Consider `brew info visionmedia-watch` (or `brew install watch`) ### Windows - Consider this article: [What is the Windows analog of the Linux watch command?](https://superuser.com/questions/191063/what-is-the-windows-analog-of-the-linuo-watch-command#191068) # `near-sdk-as` Starter Kit This is a good project to use as a starting point for your AssemblyScript project. ## Samples This repository includes a complete project structure for AssemblyScript contracts targeting the NEAR platform. The example here is very basic. It's a simple contract demonstrating the following concepts: - a single contract - the difference between `view` vs. `change` methods - basic contract storage There are 2 AssemblyScript contracts in this project, each in their own folder: - **simple** in the `src/simple` folder - **singleton** in the `src/singleton` folder ### Simple We say that an AssemblyScript contract is written in the "simple style" when the `index.ts` file (the contract entry point) includes a series of exported functions. In this case, all exported functions become public contract methods. ```ts // return the string 'hello world' export function helloWorld(): string {} // read the given key from account (contract) storage export function read(key: string): string {} // write the given value at the given key to account (contract) storage export function write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} ``` ### Singleton We say that an AssemblyScript contract is written in the "singleton style" when the `index.ts` file (the contract entry point) has a single exported class (the name of the class doesn't matter) that is decorated with `@nearBindgen`. In this case, all methods on the class become public contract methods unless marked `private`. Also, all instance variables are stored as a serialized instance of the class under a special storage key named `STATE`. AssemblyScript uses JSON for storage serialization (as opposed to Rust contracts which use a custom binary serialization format called borsh). ```ts @nearBindgen export class Contract { // return the string 'hello world' helloWorld(): string {} // read the given key from account (contract) storage read(key: string): string {} // write the given value at the given key to account (contract) storage @mutateState() write(key: string, value: string): string {} // private helper method used by read() and write() above private storageReport(): string {} } ``` ## Usage ### Getting started (see below for video recordings of each of the following steps) INSTALL `NEAR CLI` first like this: `npm i -g near-cli` 1. clone this repo to a local folder 2. run `yarn` 3. run `./scripts/1.dev-deploy.sh` 3. run `./scripts/2.use-contract.sh` 4. run `./scripts/2.use-contract.sh` (yes, run it to see changes) 5. run `./scripts/3.cleanup.sh` ### Videos **`1.dev-deploy.sh`** This video shows the build and deployment of the contract. [](https://asciinema.org/a/409575) **`2.use-contract.sh`** This video shows contract methods being called. You should run the script twice to see the effect it has on contract state. [](https://asciinema.org/a/409577) **`3.cleanup.sh`** This video shows the cleanup script running. Make sure you add the `BENEFICIARY` environment variable. The script will remind you if you forget. ```sh export BENEFICIARY=<your-account-here> # this account receives contract account balance ``` [](https://asciinema.org/a/409580) ### Other documentation - See `./scripts/README.md` for documentation about the scripts - Watch this video where Willem Wyndham walks us through refactoring a simple example of a NEAR smart contract written in AssemblyScript https://youtu.be/QP7aveSqRPo ``` There are 2 "styles" of implementing AssemblyScript NEAR contracts: - the contract interface can either be a collection of exported functions - or the contract interface can be the methods of a an exported class We call the second style "Singleton" because there is only one instance of the class which is serialized to the blockchain storage. Rust contracts written for NEAR do this by default with the contract struct. 0:00 noise (to cut) 0:10 Welcome 0:59 Create project starting with "npm init" 2:20 Customize the project for AssemblyScript development 9:25 Import the Counter example and get unit tests passing 18:30 Adapt the Counter example to a Singleton style contract 21:49 Refactoring unit tests to access the new methods 24:45 Review and summary ``` ## The file system ```sh ├── README.md # this file ├── as-pect.config.js # configuration for as-pect (AssemblyScript unit testing) ├── asconfig.json # configuration for AssemblyScript compiler (supports multiple contracts) ├── package.json # NodeJS project manifest ├── scripts │   ├── 1.dev-deploy.sh # helper: build and deploy contracts │   ├── 2.use-contract.sh # helper: call methods on ContractPromise │   ├── 3.cleanup.sh # helper: delete build and deploy artifacts │   └── README.md # documentation for helper scripts ├── src │   ├── as_types.d.ts # AssemblyScript headers for type hints │   ├── simple # Contract 1: "Simple example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 1 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 1 │   ├── singleton # Contract 2: "Singleton-style example" │   │   ├── __tests__ │   │   │   ├── as-pect.d.ts # as-pect unit testing headers for type hints │   │   │   └── index.unit.spec.ts # unit tests for contract 2 │   │   ├── asconfig.json # configuration for AssemblyScript compiler (one per contract) │   │   └── assembly │   │   └── index.ts # contract code for contract 2 │   ├── tsconfig.json # Typescript configuration │   └── utils.ts # common contract utility functions └── yarn.lock # project manifest version lock ``` You may clone this repo to get started OR create everything from scratch. Please note that, in order to create the AssemblyScript and tests folder structure, you may use the command `asp --init` which will create the following folders and files: ``` ./assembly/ ./assembly/tests/ ./assembly/tests/example.spec.ts ./assembly/tests/as-pect.d.ts ```

hskang9_aurora-release

README.md aurora-engine-2.8.1 .env custom_example.env local.env mainnet.env testnet.env .github pull_request_template.md workflows builds.yml lints.yml scheduled_lints.yml tests.yml CHANGES.md CREDITS.md Cargo.toml Makefile.toml README.md doc benchmarks.md eth-connector.md engine-precompiles Cargo.toml src account_ids.rs alt_bn256.rs blake2.rs hash.rs identity.rs lib.rs modexp.rs native.rs prelude.rs prepaid_gas.rs promise_result.rs random.rs secp256k1.rs utils.rs xcc.rs engine-sdk Cargo.toml src caching.rs env.rs error.rs io.rs lib.rs near_runtime.rs prelude.rs promise.rs types.rs engine-standalone-storage Cargo.toml src diff.rs engine_state.rs error.rs json_snapshot mod.rs types.rs lib.rs promise.rs relayer_db mod.rs types.rs sync mod.rs types.rs engine-standalone-tracing Cargo.toml src lib.rs sputnik.rs types call_tracer.rs mod.rs engine-test-doubles Cargo.toml src io.rs lib.rs promise.rs tracing.rs engine-tests Cargo.toml src benches eth_deploy_code.rs eth_erc20.rs eth_standard_precompiles.rs eth_transfer.rs mod.rs nft_pagination.rs uniswap.rs lib.rs prelude.rs test_utils erc20.rs exit_precompile.rs mocked_external.rs mod.rs one_inch liquidity_protocol.rs mod.rs random.rs rust.rs self_destruct.rs solidity.rs standalone mocks block.rs mod.rs mod.rs storage.rs standard_precompiles.rs uniswap.rs weth.rs tests access_lists.rs account_id_precompiles.rs contract_call.rs ecrecover.rs eip1559.rs erc20.rs erc20_connector.rs eth_connector.rs ghsa_3p69_m8gg_fwmf.rs meta_parsing.rs mod.rs multisender.rs one_inch.rs pausable_precompiles.rs prepaid_gas_precompile.rs promise_results_precompile.rs random.rs repro.rs res 33db52b0e7fa03cd84e8c99fea90a1962b4f8d0e63c8bbe4c11373a233dc4f0e_trace.json 79f7f8f9b3ad98f29a3df5cbed1556397089701c3ce007c2844605849dfb0ad4_trace.json aurora_state_5bEgfRQ.json aurora_state_8ru7VEA.json aurora_state_D98vwmi.json aurora_state_Emufid2.json aurora_state_FRcorNv.json aurora_state_GdASJ3KESs.json sanity.rs self_destruct_state.rs standalone call_tracer.rs json_snapshot.rs mod.rs sanity.rs storage.rs sync.rs tracing.rs standard_precompiles.rs state_migration.rs uniswap.rs xcc.rs engine-transactions Cargo.toml src backwards_compatibility.rs eip_1559.rs eip_2930.rs legacy.rs lib.rs engine-types Cargo.toml src account_id.rs lib.rs parameters.rs storage.rs types address.rs balance.rs fee.rs gas.rs mod.rs wei.rs engine Cargo.toml src accounting.rs admin_controlled.rs connector.rs deposit_event.rs engine.rs errors.rs fungible_token.rs json.rs lib.rs log_entry.rs map.rs parameters.rs pausables.rs prelude.rs proof.rs xcc.rs etc eth-contracts .soliumrc.json hardhat.config.js main.js package.json tasks storage.js test EvmErc20.js tests benchmark-contract Cargo.toml src lib.rs fibonacci Cargo.toml src lib.rs ft-receiver Cargo.toml src lib.rs self-contained-5bEgfRQ Cargo.toml src lib.rs promise.rs state-migration-test Cargo.toml src lib.rs uniswap package.json xcc-router Cargo.toml src lib.rs tests.rs scripts docker-entrypoint.sh verify_evm_erc20.sh

# aurora-release Aurora release modifications for E2E tests # Aurora Engine [](https://creativecommons.org/publicdomain/zero/1.0/) [](https://discord.gg/jNjHYUF8vw) [](https://github.com/aurora-is-near/aurora-engine/actions/workflows/lints.yml) [](https://github.com/aurora-is-near/aurora-engine/actions/workflows/tests.yml) [](https://github.com/aurora-is-near/aurora-engine/actions/workflows/builds.yml) Aurora Engine implements an Ethereum Virtual Machine (EVM) on the NEAR Protocol. See [doc.aurora.dev](https://doc.aurora.dev/develop/compat/evm) for additional documentation. ## Deployments | Network | Contract ID | Chain ID | |---------|---------------------|------------| | Mainnet | [`aurora`][Mainnet] | 1313161554 | | Testnet | [`aurora`][Testnet] | 1313161555 | | Local | `aurora.test.near` | 1313161556 | [Mainnet]: https://explorer.near.org/accounts/aurora [Testnet]: https://explorer.testnet.near.org/accounts/aurora ## Development ### Prerequisites - Node.js (v14+) - cargo-make ```sh cargo install --force cargo-make ``` ### Prerequisites for Development - Node.js (v14+) - Docker - cargo-make ## Development ### Branches - [`master`] is the current stable branch. It must be ready, anytime, to deployed on chain at a moment's notice. - [`develop`] is our bleeding-edge development branch. In general, kindly target all pull requests to this branch. ### Building & Make Commands Every task with `cargo make` must have a `--profile` argument. The current available `profile`s are: - `mainnet`, suitable for mainnet. - `testnet`, suitable for testnet. - `local`, suitable for local development. - `custom`, suitable for custom environments, see note below. A custom environment may be required depending on the circumstances. This can be created in the `.env` folder as `custom.env` following the structure of the other `.env` files. See `bin/local-custom.env` for more details. Every make most follow the following pattern, though `--profile` is not required for all such as cleanup: ```sh cargo make [--profile <profile>] <task> ``` #### Building the engine and contracts To build the binaries there are a few commands to do such following the format. The current available build `task`s are: - `default`, does not need to be specified, runs `build`. Requires a `--profile` argument. - `build`, builds all engine smart contract and produces the `aurora-<profile>-test.wasm` in the `bin` folder. Requires `build-contracts`. Requires a `--profile` argument. - `build-test`, builds all the below using test features. Requires a `--profile` argument. - `build-contracts`, builds all the ETH contracts. - `build-docker`, builds the `aurora-<profile>-test.wasm` in the `bin` folder using docker build environment. The purpose of this task is to produce reproducible binaries. For example, the following will build the mainnet debug binary: ```sh cargo make --profile mainnet build ``` #### Verifying binary hash To verify that a deployed binary matches the source code, you may want build it reproducibly and then check that their hashes match. The motivation behind that is to prevent malicious code from being deployed. Run these commands to produce the binary hash: ```sh cargo make --profile <profile> build-docker shasum -a 256 bin/aurora-<profile>.wasm ``` #### Running unit & integration tests To run tests, there are a few cargo make tasks we can run: - `test`, tests the whole cargo workspace and ETH contracts. Requires a `--profile` argument. - `test-workspace`, tests only the cargo workspace. - `test-contracts`, tests only the contracts. For example, the following will test the whole workspace and ETH contracts: ```sh cargo make --profile mainnet test ``` #### Running checks & lints To run lints and checks, the following tasks are available: - `check`, checks the format, clippy and ETH contracts. - `check-contracts`, runs yarn lints on the ETH contracts. - `check-fmt`, checks the workspace Rust format only. - `check-clippy`, checks the Rust workspace with clippy only. For example the following command will run the checks. `profile` is not required here: ``` cargo make check ``` #### Cleanup To clean up the workspace, the following tasks are available: - `clean`, cleans all built binaries and ETH contracts. - `clean-cargo`, cleans with cargo. - `clean-contracts`, cleans the ETH contracts. - `clean-bin`, cleans the binaries. Additionally, there is also but not included in the `clean` task: - `sweep`, sweeps the set amount of days in the ENV, default at 30 days. For example, the following command will clean everything. `profile` is not required: ``` cargo make clean ``` ## Deployment ### Downloading the latest EVM release ```sh wget https://github.com/aurora-is-near/aurora-engine/releases/download/latest/mainnet-release.wasm ``` ### Installing the Aurora CLI tool ```sh npm install -g aurora-is-near/aurora-cli ``` ### Deploying the EVM with the CLI ```sh export NEAR_ENV=local near delete aurora.test.near test.near # if needed near create-account aurora.test.near --master-account=test.near --initial-balance 1000000 aurora install --chain 1313161556 --owner test.near bin/mainnet-release.wasm ``` ### Deploying the EVM without the CLI ```sh export NEAR_ENV=local near delete aurora.test.near test.near # if needed near create-account aurora.test.near --master-account=test.near --initial-balance 1000000 near deploy --account-id=aurora.test.near --wasm-file=bin/mainnet-release.wasm aurora initialize --chain 1313161556 --owner test.near ``` ## Usage ### Examining deployed EVM metadata ```sh aurora get-version aurora get-owner aurora get-bridge-prover aurora get-chain-id ``` ### Deploying EVM contract bytecode ```sh aurora deploy-code @contract.bytecode ``` ```sh aurora deploy-code 0x600060005560648060106000396000f360e060020a6000350480638ada066e146028578063d09de08a1460365780632baeceb714604d57005b5060005460005260206000f3005b5060016000540160005560005460005260206000f3005b5060016000540360005560005460005260206000f300 ``` ### Examining EVM contract state ```console $ aurora encode-address test.near 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B ``` ```sh aurora get-nonce 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B aurora get-balance 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B aurora get-code 0xFc481F4037887e10708552c0D7563Ec6858640d6 aurora get-storage-at 0xFc481F4037887e10708552c0D7563Ec6858640d6 0 ``` ### Calling an EVM contract read-only ```console $ aurora encode-address test.near 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B ``` ```sh aurora view --sender 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B 0xFc481F4037887e10708552c0D7563Ec6858640d6 0x8ada066e # getCounter() aurora view --sender 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B 0xFc481F4037887e10708552c0D7563Ec6858640d6 0xd09de08a # increment() aurora view --sender 0xCBdA96B3F2B8eb962f97AE50C3852CA976740e2B 0xFc481F4037887e10708552c0D7563Ec6858640d6 0x2baeceb7 # decrement() ``` ### Calling an EVM contract mutatively ```sh aurora call 0xFc481F4037887e10708552c0D7563Ec6858640d6 0xd09de08a # increment() aurora call 0xFc481F4037887e10708552c0D7563Ec6858640d6 0x2baeceb7 # decrement() ``` ## Debugging ### Inspecting EVM storage state ```sh near state aurora.test.near aurora dump-storage ``` [`master`]: https://github.com/aurora-is-near/aurora-engine/commits/master [`develop`]: https://github.com/aurora-is-near/aurora-engine/commits/develop ## License **aurora-engine** has multiple licenses: * all crates except `engine-test` has **CCO-1.0** license * `engine-test` has **GPL-v3** license

kumailnaqvi354_Near-Staking-Contract-

.gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh src lib.rs target .rustc_info.json debug .fingerprint Inflector-9e15a0ace34a9b75 lib-inflector.json ahash-067e4c96622d12e3 lib-ahash.json ahash-69dafe7e267f975a build-script-build-script-build.json ahash-ffc0abf5bc336fb8 run-build-script-build-script-build.json arrayref-d958e9cbd85a164a lib-arrayref.json arrayvec-147d8fc935497eda lib-arrayvec.json arrayvec-73cb2a417fc44434 lib-arrayvec.json autocfg-fda660cccf190a38 lib-autocfg.json base64-152ae91289eb7655 lib-base64.json base64-f69473d9010ca096 lib-base64.json bitvec-f94676e8370ddcba lib-bitvec.json blake2-9073d3228ebe5ce5 lib-blake2.json block-buffer-04493d3897bada8e lib-block-buffer.json block-buffer-2ac30ea3b8c3e972 lib-block-buffer.json borsh-3546b39d467fe387 lib-borsh.json borsh-derive-1c92abc76902ba24 lib-borsh-derive.json borsh-derive-internal-30bd90b9c29830d3 lib-borsh-derive-internal.json borsh-schema-derive-internal-f0fca23ccffbed32 lib-borsh-schema-derive-internal.json bs58-b903192fa41d0fad lib-bs58.json byte-slice-cast-04ed43d6cbf3da6d lib-byte-slice-cast.json byteorder-93571993767b1660 lib-byteorder.json bytesize-95596759f0ead539 lib-bytesize.json c2-chacha-8e371e1dea803487 lib-c2-chacha.json cc-f442d46c269239b2 lib-cc.json cfg-if-0e3005320915572e lib-cfg-if.json cfg-if-7754a9e222877cd8 lib-cfg-if.json cfg-if-cc4d92f16aed8e7a lib-cfg-if.json chrono-24212907ef17c066 lib-chrono.json cipher-0398e21d03bb2b77 lib-cipher.json convert_case-5d30f151afc2539a lib-convert_case.json cpufeatures-39a8ce29955aeef3 lib-cpufeatures.json crunchy-0899347373b4c360 lib-crunchy.json crunchy-2470a04c8a1c4683 run-build-script-build-script-build.json crunchy-d5a5a178d09528ef build-script-build-script-build.json crypto-common-3ee72ffa72ce5b21 lib-crypto-common.json crypto-mac-662ae948814140a8 lib-crypto-mac.json curve25519-dalek-d80abdf83994edc0 lib-curve25519-dalek.json derive_more-e20d96a5da51f114 lib-derive_more.json digest-43a5461b8259e90c lib-digest.json digest-929661dd672c8a1c lib-digest.json dyn-clone-232baf7249c0af0f lib-dyn-clone.json easy-ext-2d9fa283dc991770 lib-easy-ext.json ed25519-d357d83a221449c9 lib-ed25519.json ed25519-dalek-eaeb8f0c188b5a2f lib-ed25519-dalek.json fixed-hash-bbbe3e4f407f6a08 lib-fixed-hash.json funty-ea5b7e7897b726a9 lib-funty.json generic-array-1b2b749d0d1f3038 lib-generic_array.json generic-array-436fd7e4a0e5e7f0 run-build-script-build-script-build.json generic-array-bb7923e879d40796 build-script-build-script-build.json getrandom-0f99b502c6427938 lib-getrandom.json getrandom-24978a8806f50c6d lib-getrandom.json getrandom-6a475edc90348770 run-build-script-build-script-build.json getrandom-88dafde9fe689f9c build-script-build-script-build.json hashbrown-59eb759ebf9ff7a8 lib-hashbrown.json hashbrown-b26afc28fb42f369 lib-hashbrown.json heck-b33a1e9cff247001 lib-heck.json hello_near-3eaa1e0473baa74c test-lib-hello_near.json hello_near-886900b2c3146289 lib-hello_near.json hex-67b52ccbf162b2b2 lib-hex.json iana-time-zone-cd2c1d9812f57b38 lib-iana-time-zone.json impl-codec-8d94dc6abab5436d lib-impl-codec.json impl-trait-for-tuples-19c1a85c2e4767c7 lib-impl-trait-for-tuples.json indexmap-2ff943841a765456 lib-indexmap.json indexmap-7dc97b269cf832ac build-script-build-script-build.json indexmap-cf85b2ff3d641a7b run-build-script-build-script-build.json itoa-8ac2cfb585c60b6d lib-itoa.json keccak-b74854472819b4d6 lib-keccak.json lazy_static-97bb0ce395bd1038 lib-lazy_static.json libc-557d3b7acea9c99b build-script-build-script-build.json libc-624badbae82d641b run-build-script-build-script-build.json libc-6ae063a0694431b0 lib-libc.json memory_units-522f6c2847d4a826 lib-memory_units.json near-abi-5720847fb136e81b lib-near-abi.json near-account-id-82bd7cb2ae5ccd39 lib-near-account-id.json near-crypto-23c43b3244af4cf3 lib-near-crypto.json near-primitives-47aa1d76cc478d92 lib-near-primitives.json near-primitives-core-e5a24cd2811ee2f7 lib-near-primitives-core.json near-rpc-error-core-0f2e68fe78f8c4c2 lib-near-rpc-error-core.json near-rpc-error-macro-23cc47247b2f413d lib-near-rpc-error-macro.json near-sdk-6b0a8116752e4180 lib-near-sdk.json near-sdk-macros-b2bcfaae1ba7be1f lib-near-sdk-macros.json near-sys-282087b65ba324e2 lib-near-sys.json near-vm-errors-df8a0708682d06cd lib-near-vm-errors.json near-vm-logic-c96f9d23f42404b6 lib-near-vm-logic.json num-bigint-4cc6692eeb0b4218 build-script-build-script-build.json num-bigint-d9c7517d161488fe lib-num-bigint.json num-bigint-dcfb71e04484ab33 run-build-script-build-script-build.json num-integer-47b353f53fa2d20f lib-num-integer.json num-integer-9f6824d2f5cfc938 run-build-script-build-script-build.json num-integer-e552bf8f97fce7d2 build-script-build-script-build.json num-rational-0c43f172ccabf39d build-script-build-script-build.json num-rational-53d4acab93ea829e lib-num-rational.json num-rational-985c369a79339b68 run-build-script-build-script-build.json num-traits-07ff3fbe498890d8 build-script-build-script-build.json num-traits-24e5cdd77cff1089 lib-num-traits.json num-traits-68b695368dd6a255 run-build-script-build-script-build.json once_cell-8bf5bee73d21876b lib-once_cell.json once_cell-8c03449eb8a7b2a1 lib-once_cell.json opaque-debug-8bac07109757946c lib-opaque-debug.json parity-scale-codec-7bcb98b4a3b9aeb7 lib-parity-scale-codec.json parity-scale-codec-derive-b365ae5d4daa5b54 lib-parity-scale-codec-derive.json parity-secp256k1-5f3f7aeee88c5c47 run-build-script-build-script-build.json parity-secp256k1-96e35a1bf4221662 lib-secp256k1.json parity-secp256k1-e53de79efbfe2afa build-script-build-script-build.json ppv-lite86-2c77b15d5e359e51 lib-ppv-lite86.json primitive-types-60e4776b7fdb2638 lib-primitive-types.json proc-macro-crate-26d79372c49f349d lib-proc-macro-crate.json proc-macro-crate-88e1f7fd2a30ca6d lib-proc-macro-crate.json proc-macro2-469a607412d05538 lib-proc-macro2.json proc-macro2-54bd4cd7d6cc61de build-script-build-script-build.json proc-macro2-b8f45fb01a816cd8 run-build-script-build-script-build.json quote-096a28d9f8ecd984 lib-quote.json quote-3793f0627de08455 run-build-script-build-script-build.json quote-5de90d461d6e7997 build-script-build-script-build.json radium-3f34c4bbc64d7d76 run-build-script-build-script-build.json radium-411f6935b96d51e9 build-script-build-script-build.json radium-f0230aa6f17b3350 lib-radium.json rand-d23abd2cbcc01c24 lib-rand.json rand-e552c93246b62ed0 lib-rand.json rand_chacha-5f0024695d20450c lib-rand_chacha.json rand_chacha-faf4c6aa19456dee lib-rand_chacha.json rand_core-342608bee2bbd0db lib-rand_core.json rand_core-d7df8badb8d7689b lib-rand_core.json reed-solomon-erasure-88a98bc331290e41 build-script-build-script-build.json reed-solomon-erasure-88d109adc1fa15f4 lib-reed-solomon-erasure.json reed-solomon-erasure-8b3989ef46c8f94f run-build-script-build-script-build.json ripemd-68283774ec66a082 lib-ripemd.json rustc-hex-3486797331a6f8dc lib-rustc-hex.json rustversion-07ce336274e15138 build-script-build-script-build.json rustversion-40958208ddcafa3d run-build-script-build-script-build.json rustversion-97c432f40f1962d9 lib-rustversion.json ryu-71e9da68382a66dd lib-ryu.json schemars-08dd4340e4ac9de2 lib-schemars.json schemars-94e298ff8b389683 run-build-script-build-script-build.json schemars-b5e2c235748ddb8a build-script-build-script-build.json schemars_derive-b04fd5973223366f lib-schemars_derive.json semver-2e21f24f2e106314 build-script-build-script-build.json semver-4a0b3f44a4823951 run-build-script-build-script-build.json semver-93fe09443fb46d9d lib-semver.json serde-33836b3a21ee3c8d lib-serde.json serde-591bbeadc55cfae4 build-script-build-script-build.json serde-5ce152114203691d build-script-build-script-build.json serde-9c52d177765b085a lib-serde.json serde-a092567f9717b821 run-build-script-build-script-build.json serde-df00b1c9b0f5654d run-build-script-build-script-build.json serde_derive-0d2e1a8985c541b1 lib-serde_derive.json serde_derive-7e0aa6e67d0f4d2d build-script-build-script-build.json serde_derive-bb8bbb17ce264f3a run-build-script-build-script-build.json serde_derive_internals-ce0439a3fe7b7a46 lib-serde_derive_internals.json serde_json-765a011475be36fb lib-serde_json.json serde_json-b51ca1ce6751b3db run-build-script-build-script-build.json serde_json-d0694f4f8bacc3c6 build-script-build-script-build.json sha2-cf8e3b9a254f4e7f lib-sha2.json sha2-d662f40a3376e1e8 lib-sha2.json sha3-57a0a9cc8006492a lib-sha3.json signature-0f87899d6e4cd44f lib-signature.json smallvec-a768dc29f0159b87 lib-smallvec.json smart-default-f07e95d9ef962cf7 lib-smart-default.json spin-9e255fa6a30f5bab lib-spin.json static_assertions-ac08ed56ea7d7573 lib-static_assertions.json strum-6e62d851c5a4c9c0 lib-strum.json strum_macros-df0bb51f61852f69 lib-strum_macros.json subtle-40292eb83145cb10 lib-subtle.json syn-b3e0982d58dddbbd run-build-script-build-script-build.json syn-c725c7e741550dfd lib-syn.json syn-f10752547dfcea7f build-script-build-script-build.json syn-f6cd50bb9263c750 lib-syn.json tap-ae761719c7282dac lib-tap.json thiserror-70cb674808dc8999 build-script-build-script-build.json thiserror-8c2306d1194bd151 run-build-script-build-script-build.json thiserror-e07bb213f2ec8211 lib-thiserror.json thiserror-impl-f1dea324626a11ae lib-thiserror-impl.json time-c8dde8ba2f07933b lib-time.json toml-94634e4e26c2dd05 lib-toml.json toml_datetime-1224ea94464a7e86 lib-toml_datetime.json toml_edit-ca613bca5cb66f71 lib-toml_edit.json typenum-152c8c499745c713 run-build-script-build-script-main.json typenum-33441ce6b80eedef build-script-build-script-main.json typenum-b84e03536911cc93 lib-typenum.json uint-d0249a147ed03084 lib-uint.json unicode-ident-1b2c5f527366f723 lib-unicode-ident.json version_check-1c4464117be37b7b lib-version_check.json wee_alloc-0035391b67927fa3 build-script-build-script-build.json wee_alloc-121e5e969df3c948 lib-wee_alloc.json wee_alloc-b31fa44e348f5a6b run-build-script-build-script-build.json winnow-aab9f8a0ca34a880 lib-winnow.json wyz-8515f314ccc6a3fe lib-wyz.json zeroize-144d9d912378da8c lib-zeroize.json zeroize_derive-514cdc81877ef395 lib-zeroize_derive.json zeropool-bn-448dc4a775ae186e lib-zeropool-bn.json build crunchy-2470a04c8a1c4683 out lib.rs num-bigint-dcfb71e04484ab33 out radix_bases.rs parity-secp256k1-5f3f7aeee88c5c47 out flag_check.c reed-solomon-erasure-8b3989ef46c8f94f out table.rs thiserror-8c2306d1194bd151 out probe.rs typenum-152c8c499745c713 out consts.rs op.rs tests.rs wee_alloc-b31fa44e348f5a6b out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint Inflector-702cf8868b10d0f2 lib-inflector.json ahash-70e5c67407b58091 build-script-build-script-build.json borsh-derive-e2a620175508e02f lib-borsh-derive.json borsh-derive-internal-9e9ab2d0788afeb5 lib-borsh-derive-internal.json borsh-schema-derive-internal-5635a180cae470ef lib-borsh-schema-derive-internal.json crunchy-c90cb605cb65d81f build-script-build-script-build.json near-sdk-macros-5904957ba2b5b041 lib-near-sdk-macros.json proc-macro-crate-b7c0c0c4e81198e1 lib-proc-macro-crate.json proc-macro2-217eef180b89ced2 lib-proc-macro2.json proc-macro2-344ce411f0b489f2 run-build-script-build-script-build.json proc-macro2-b51a3d69a9494ab7 build-script-build-script-build.json quote-68d7d9ea69f1657d build-script-build-script-build.json quote-68eaccde3d89b53b lib-quote.json quote-9fc2676d6c622c88 run-build-script-build-script-build.json schemars-41b1cc6d4bcd15b1 build-script-build-script-build.json schemars_derive-cac95c3eb223f886 lib-schemars_derive.json semver-9c672a3c778cac12 build-script-build-script-build.json serde-59f31331962a9f1b lib-serde.json serde-725300af9b4e3d84 build-script-build-script-build.json serde-aaa5d21d7e8570a5 build-script-build-script-build.json serde-bbd5bbd740c61e60 run-build-script-build-script-build.json serde_derive-11c0c8da607690de run-build-script-build-script-build.json serde_derive-9bb98083142f852d build-script-build-script-build.json serde_derive-c02eca8d2ee09367 lib-serde_derive.json serde_derive_internals-8421e54cfcbc05ea lib-serde_derive_internals.json serde_json-9780a128d64f98aa build-script-build-script-build.json syn-62dc9309488b6783 build-script-build-script-build.json syn-93bff98a040fc856 run-build-script-build-script-build.json syn-9f3c00ffeeff6a32 lib-syn.json syn-dd25f16fa91588bb lib-syn.json toml-fbd523b3eb4c2d23 lib-toml.json unicode-ident-3d84bc3848f08375 lib-unicode-ident.json version_check-5517ccafe70f7ea6 lib-version_check.json wee_alloc-b5c7350c42ef2447 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-6c4950fcbd79291d run-build-script-build-script-build.json ahash-a8589574d4aea16d lib-ahash.json base64-08c273cec93291b1 lib-base64.json borsh-383796389c1b0e51 lib-borsh.json bs58-b33e9539ff7717ad lib-bs58.json byteorder-3f93e123c4790805 lib-byteorder.json cfg-if-2d933a7e38d5be8e lib-cfg-if.json crunchy-3e4391c07f9ba184 lib-crunchy.json crunchy-cd0d9fe5341a9149 run-build-script-build-script-build.json dyn-clone-e5a46f4ae7d6c4bf lib-dyn-clone.json hashbrown-9bdcf0d5d82c5543 lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-5317094bb2b93af6 lib-hex.json itoa-dfb8a2d5df5b9f7f lib-itoa.json memory_units-ff8f4265d28f3355 lib-memory_units.json near-abi-9af5db24dd36bb66 lib-near-abi.json near-sdk-db0f12bb812b9c7c lib-near-sdk.json near-sys-452be65ff005d533 lib-near-sys.json once_cell-46e60616695ea115 lib-once_cell.json ryu-7a90150b200afe0f lib-ryu.json schemars-3cbda49808d4271d lib-schemars.json schemars-51daf51e95258c7b run-build-script-build-script-build.json semver-6264efb5de24dd36 lib-semver.json semver-9c249d701686353e run-build-script-build-script-build.json serde-e0b6e3172cb14764 run-build-script-build-script-build.json serde-f511e2fc63616502 lib-serde.json serde_json-3058fc7b226abce2 lib-serde_json.json serde_json-feda67703fabeada run-build-script-build-script-build.json static_assertions-446fe15976d06524 lib-static_assertions.json uint-cae0ff429eec358d lib-uint.json wee_alloc-78cbe07c50d095f5 lib-wee_alloc.json wee_alloc-b1c88d3e4285861c run-build-script-build-script-build.json build crunchy-cd0d9fe5341a9149 out lib.rs wee_alloc-b1c88d3e4285861c out wee_alloc_static_array_backend_size_bytes.txt integration-tests Cargo.toml src tests.rs target .rustc_info.json debug .fingerprint addr2line-7a7691db1bf497e2 lib-addr2line.json addr2line-95158fa32c9a9165 lib-addr2line.json adler-e2c3c51e595b0a8b lib-adler.json adler-ff2dad82268c6931 lib-adler.json ahash-508a9d5cfe6d5f24 lib-ahash.json ahash-69dafe7e267f975a build-script-build-script-build.json ahash-ffc0abf5bc336fb8 run-build-script-build-script-build.json aho-corasick-3b0b11e948f08840 lib-aho_corasick.json aho-corasick-c58675da8878b5a2 lib-aho_corasick.json anyhow-30634db3c15a4e19 lib-anyhow.json anyhow-48768109344e7296 build-script-build-script-build.json anyhow-66d4f26a59c32f1e run-build-script-build-script-build.json anyhow-759991461c77824e lib-anyhow.json arrayref-d958e9cbd85a164a lib-arrayref.json arrayvec-303516c15c8e80e6 lib-arrayvec.json arrayvec-6891ff3299e02bac lib-arrayvec.json async-io-0f31c2554513298f lib-async-io.json async-io-984395458d6f0a0f run-build-script-build-script-build.json async-io-bb762803890a93b6 lib-async-io.json async-io-f87b768f4633ef95 build-script-build-script-build.json async-lock-5edb266b7df15f63 lib-async-lock.json async-lock-912542ded4acc9de lib-async-lock.json async-process-1f00126119bdcae1 run-build-script-build-script-build.json async-process-2ea894a0e864fde6 build-script-build-script-build.json async-process-4bc0fda24ea40d19 lib-async-process.json async-process-c49fec228a9450f0 lib-async-process.json async-trait-a43d1dc4346832b6 lib-async-trait.json async-trait-b363a0f274f2692d run-build-script-build-script-build.json async-trait-e91abf4a0623cba3 build-script-build-script-build.json autocfg-fda660cccf190a38 lib-autocfg.json backtrace-b82ef76e8da8d76c lib-backtrace.json backtrace-c9511456e80c66d5 lib-backtrace.json backtrace-cbf732a909fb786a run-build-script-build-script-build.json backtrace-ecf469b90ef22921 build-script-build-script-build.json base64-0b704224bea135f4 lib-base64.json base64-152ae91289eb7655 lib-base64.json binary-install-d39c701d922f4c7b lib-binary-install.json binary-install-f3070c897af9855c lib-binary-install.json bitflags-48c07df6f225d937 lib-bitflags.json bitflags-a8a43a89253a9046 lib-bitflags.json blake2-9073d3228ebe5ce5 lib-blake2.json block-buffer-04493d3897bada8e lib-block-buffer.json block-buffer-2ac30ea3b8c3e972 lib-block-buffer.json borsh-4c26f4ddb2eb02da lib-borsh.json borsh-derive-fdb54543eaf970a4 lib-borsh-derive.json borsh-derive-internal-30815920047e8da1 lib-borsh-derive-internal.json borsh-schema-derive-internal-888209fc5ca96fcf lib-borsh-schema-derive-internal.json bs58-b903192fa41d0fad lib-bs58.json byteorder-5f92debc6398861c lib-byteorder.json byteorder-93571993767b1660 lib-byteorder.json bytes-c95ab450bc1c2493 lib-bytes.json bytesize-95596759f0ead539 lib-bytesize.json bzip2-5dd62ff813a01276 lib-bzip2.json bzip2-ab8389f1359d7f3f lib-bzip2.json bzip2-sys-3458c9e43487e40c build-script-build-script-build.json bzip2-sys-5505d17fea1678b0 run-build-script-build-script-build.json bzip2-sys-8607bc751a17ac9e lib-bzip2_sys.json bzip2-sys-cb281de945443a38 lib-bzip2_sys.json c2-chacha-8e371e1dea803487 lib-c2-chacha.json cc-f442d46c269239b2 lib-cc.json cfg-if-0e3005320915572e lib-cfg-if.json cfg-if-af75946d899619ca lib-cfg-if.json chrono-2e3ad2f7b6e7056b lib-chrono.json chrono-b5e62c1101b318d0 lib-chrono.json cipher-0398e21d03bb2b77 lib-cipher.json concurrent-queue-a071dbabe98f7430 lib-concurrent-queue.json concurrent-queue-d5ff7d0b88d6ac1f lib-concurrent-queue.json convert_case-5d30f151afc2539a lib-convert_case.json cpufeatures-39a8ce29955aeef3 lib-cpufeatures.json crc32fast-053520effe8cd17f lib-crc32fast.json crc32fast-703b1c16e1647bac build-script-build-script-build.json crc32fast-7dd8584b8e0e57fb lib-crc32fast.json crc32fast-c9f9ab663c424766 run-build-script-build-script-build.json crossbeam-utils-50c886166f3fc766 lib-crossbeam-utils.json crossbeam-utils-56d7cc9112b3b430 lib-crossbeam-utils.json crossbeam-utils-a282fbdd74cc01ae run-build-script-build-script-build.json crossbeam-utils-e7560c7b4dff0981 build-script-build-script-build.json crunchy-ca333d979399fd12 build-script-build-script-build.json crunchy-df70957b059bbb28 run-build-script-build-script-build.json crunchy-f1f3159ed550c7c9 lib-crunchy.json crypto-common-3ee72ffa72ce5b21 lib-crypto-common.json crypto-mac-662ae948814140a8 lib-crypto-mac.json curl-1c44250fb53998b4 lib-curl.json curl-7e89a64a33dd51fd build-script-build-script-build.json curl-af57fb0d26f59deb run-build-script-build-script-build.json curl-e66b2626dff7ea4a lib-curl.json curl-sys-10fe5a504fa9b080 lib-curl_sys.json curl-sys-1ffb714bd82afe6c run-build-script-build-script-build.json curl-sys-f673f56d7f109549 build-script-build-script-build.json curl-sys-fc4a910875c8a45b lib-curl_sys.json curve25519-dalek-26ed5e18ff34a95e lib-curve25519-dalek.json derive_more-1b88c5cc54d4b065 lib-derive_more.json digest-43a5461b8259e90c lib-digest.json digest-929661dd672c8a1c lib-digest.json dirs-3e9e41b2cdc11e93 lib-dirs.json dirs-4c5aff5f31da16b5 lib-dirs.json dirs-5e563926aa528b94 lib-dirs.json dirs-sys-8c9ba123e907cc75 lib-dirs-sys.json easy-ext-2d9fa283dc991770 lib-easy-ext.json ed25519-d357d83a221449c9 lib-ed25519.json ed25519-dalek-ffc55a52e97898a6 lib-ed25519-dalek.json encoding_rs-ae5d6d2a2168155b lib-encoding_rs.json event-listener-29d1e12c2dbe5fea lib-event-listener.json event-listener-bc9e33f0fff85554 lib-event-listener.json failure-1bd1f3628a9a6d68 lib-failure.json failure-aa628334db4bb5c3 lib-failure.json failure_derive-3df6de46418ff4e1 build-script-build-script-build.json failure_derive-94c5df576d15cc37 lib-failure_derive.json failure_derive-e80afdad3010d58b run-build-script-build-script-build.json fastrand-b534caada0782af4 lib-fastrand.json fastrand-b60d1413aad29bbe lib-fastrand.json filetime-42875d6e6f37ceb0 lib-filetime.json filetime-e8b23b05ec033147 lib-filetime.json fixed-hash-e6a8001a19cb2ec9 lib-fixed-hash.json flate2-4092afea8e9b51a5 lib-flate2.json flate2-5998e6eda9999580 lib-flate2.json fnv-d7ab226e29e2e39a lib-fnv.json foreign-types-5ac5c9792d8bcbf9 lib-foreign-types.json foreign-types-shared-cd32e95b6b6abc4d lib-foreign-types-shared.json form_urlencoded-2432e4803a50376b lib-form_urlencoded.json fs2-3b6ba766cf33605a lib-fs2.json fs2-68b42ee3e70ca537 lib-fs2.json futures-channel-a34287f63118b9d7 build-script-build-script-build.json futures-channel-af888e8ab155c0c6 lib-futures-channel.json futures-channel-e73b1ef74c4643e0 run-build-script-build-script-build.json futures-core-3f71cb482f6b25af lib-futures-core.json futures-core-98b0d558c7e77121 build-script-build-script-build.json futures-core-9fe7acbbae0730ac lib-futures-core.json futures-core-ed8154f4e17cf463 run-build-script-build-script-build.json futures-io-4b295ab4d41f4fb5 lib-futures-io.json futures-io-ba6db783a11a7548 lib-futures-io.json futures-lite-3a94473fd72f0e58 lib-futures-lite.json futures-lite-d826aa49856745fe lib-futures-lite.json futures-sink-b88cca0a9ced6b05 lib-futures-sink.json futures-task-743ffbe67a74b014 build-script-build-script-build.json futures-task-e0e284807625cdf3 lib-futures-task.json futures-task-fcff3546c6d52da1 run-build-script-build-script-build.json futures-util-41e7a21520d84d28 build-script-build-script-build.json futures-util-4d318370c130e993 lib-futures-util.json futures-util-c619455f36be10bc run-build-script-build-script-build.json generic-array-1b2b749d0d1f3038 lib-generic_array.json generic-array-436fd7e4a0e5e7f0 run-build-script-build-script-build.json generic-array-bb7923e879d40796 build-script-build-script-build.json getrandom-6a475edc90348770 run-build-script-build-script-build.json getrandom-88dafde9fe689f9c build-script-build-script-build.json getrandom-994e66ca04fdea3a lib-getrandom.json getrandom-e14f0649cd5976e2 lib-getrandom.json gimli-dfd885d5932b9bd4 lib-gimli.json gimli-fb85c7e97a6f808a lib-gimli.json h2-8946bdf010298d1e lib-h2.json hashbrown-3fa3fbcdfe305600 lib-hashbrown.json hashbrown-756de151a07aa42a lib-hashbrown.json heck-b33a1e9cff247001 lib-heck.json hex-1d917b655c0f25a3 lib-hex.json hex-67b52ccbf162b2b2 lib-hex.json hex-b699b63e896c44d7 lib-hex.json home-15169f406eeec949 lib-home.json home-b3c707446de373b3 lib-home.json http-5af4c7fa16655317 lib-http.json http-body-bde3705af5e72b3b lib-http-body.json httparse-9f4488d4ca7bdbd8 lib-httparse.json httparse-c93a8f2c28295dad run-build-script-build-script-build.json httparse-f46b7ff5491255a2 build-script-build-script-build.json httpdate-6881ac7f76a4865c lib-httpdate.json hyper-55508c10ace15f10 lib-hyper.json hyper-tls-1f215730909c496a lib-hyper-tls.json iana-time-zone-62a459a5d8be132b lib-iana-time-zone.json iana-time-zone-cd2c1d9812f57b38 lib-iana-time-zone.json idna-7a687fdda82e4c3b lib-idna.json indexmap-08650757d10cf137 lib-indexmap.json indexmap-7dc97b269cf832ac build-script-build-script-build.json indexmap-cf85b2ff3d641a7b run-build-script-build-script-build.json integration-tests-f94167d68dc7134b example-integration-tests.json io-lifetimes-4064535af635f72a lib-io-lifetimes.json io-lifetimes-98ad87906a3641b7 build-script-build-script-build.json io-lifetimes-b66b051f7853c345 run-build-script-build-script-build.json io-lifetimes-f88d533079e2125c lib-io-lifetimes.json ipnet-e1931a79e98ca62c lib-ipnet.json is_executable-0cc4fd04812aa6ef lib-is_executable.json is_executable-8b23daa55de1557e lib-is_executable.json itoa-363c3851a859917f lib-itoa.json itoa-8ac2cfb585c60b6d lib-itoa.json lazy_static-d1a166de15fe1307 lib-lazy_static.json libc-17cfb38c7ec65cfe lib-libc.json libc-98f589be8ff3ead5 lib-libc.json libc-cccb080e767a4fe5 run-build-script-build-script-build.json libc-f86c6cd0633fdd9c build-script-build-script-build.json libz-sys-1b19cada04059ef5 lib-libz-sys.json libz-sys-2105ad1cb0177893 lib-libz-sys.json libz-sys-a761f5cd9a788b06 run-build-script-build-script-build.json libz-sys-b45cc11a434fc60c build-script-build-script-build.json linux-raw-sys-b5e52bb531fc2759 lib-linux-raw-sys.json linux-raw-sys-e3489c6d913dfd84 lib-linux-raw-sys.json lock_api-68193cf9d2ce99ba build-script-build-script-build.json lock_api-7f14df03e325405c lib-lock_api.json lock_api-9991f70c09923a7f run-build-script-build-script-build.json log-1ad0a76fd0fbcd27 build-script-build-script-build.json log-286b5ae09f70abc7 lib-log.json log-e0880ae345de5ea6 lib-log.json log-f5bfd0aec22d3ea7 run-build-script-build-script-build.json maplit-77766c1d0bca9b32 lib-maplit.json matchers-72d68f9031846610 lib-matchers.json memchr-3d41adf7e44dc759 lib-memchr.json memchr-7705b882ccd34e28 lib-memchr.json memchr-8adb8653e8d85894 build-script-build-script-build.json memchr-dda4c4cab488851f run-build-script-build-script-build.json mime-633c353206a7f009 lib-mime.json miniz_oxide-4fd87caa160a4e7a lib-miniz_oxide.json miniz_oxide-9e48ef8afde4b378 lib-miniz_oxide.json mio-d510d674350e1de3 lib-mio.json native-tls-15ce3e92e112b751 lib-native-tls.json native-tls-3ffbe5b92f35df26 run-build-script-build-script-build.json native-tls-518f576ea9b888fd build-script-build-script-build.json near-account-id-d2f5143cbe412b78 lib-near-account-id.json near-chain-configs-0921f8a754e46a72 lib-near-chain-configs.json near-crypto-322ccec7c1bbd476 lib-near-crypto.json near-jsonrpc-client-2503976f6371d3e1 lib-near-jsonrpc-client.json near-jsonrpc-primitives-19a99b76a55ad207 lib-near-jsonrpc-primitives.json near-primitives-39f6aabfe13ce6db lib-near-primitives.json near-primitives-core-0c6cb255bc0f1708 lib-near-primitives-core.json near-rpc-error-core-a812b8bdea6903fb lib-near-rpc-error-core.json near-rpc-error-macro-a94775f5a3936858 lib-near-rpc-error-macro.json near-sandbox-utils-02078617190259d9 lib-near-sandbox-utils.json near-sandbox-utils-5832adf511da39d9 lib-near-sandbox-utils.json near-sandbox-utils-c909b2600f0d7efc run-build-script-build-script-build.json near-sandbox-utils-f3235fffbfc063b2 build-script-build-script-build.json near-units-9b70c41c693f20a5 lib-near-units.json near-units-core-1affa39f705109a2 lib-near-units-core.json near-units-core-36fce1647d31a255 lib-near-units-core.json near-units-macro-ab891fc99188ff5e lib-near-units-macro.json near-vm-errors-e8c5feb2e9f7bc36 lib-near-vm-errors.json nu-ansi-term-8cac7959560c541d lib-nu-ansi-term.json num-bigint-4cc6692eeb0b4218 build-script-build-script-build.json num-bigint-d9c7517d161488fe lib-num-bigint.json num-bigint-dcfb71e04484ab33 run-build-script-build-script-build.json num-format-13a56df5839d1946 lib-num-format.json num-format-e78927ef6acc9a88 lib-num-format.json num-integer-47b353f53fa2d20f lib-num-integer.json num-integer-9f6824d2f5cfc938 run-build-script-build-script-build.json num-integer-dbae8e7067e18998 lib-num-integer.json num-integer-e552bf8f97fce7d2 build-script-build-script-build.json num-rational-0c43f172ccabf39d build-script-build-script-build.json num-rational-985c369a79339b68 run-build-script-build-script-build.json num-rational-b0d76f1d930c3f10 lib-num-rational.json num-traits-07ff3fbe498890d8 build-script-build-script-build.json num-traits-24e5cdd77cff1089 lib-num-traits.json num-traits-68b695368dd6a255 run-build-script-build-script-build.json num-traits-d76681352f5840d1 lib-num-traits.json num_cpus-e677d606af2189cc lib-num_cpus.json object-3ee5428cd688ba34 lib-object.json object-7fe589c66f2ed366 lib-object.json once_cell-8bf5bee73d21876b lib-once_cell.json opaque-debug-8bac07109757946c lib-opaque-debug.json openssl-1b11195069546b3d lib-openssl.json openssl-3ef602b8ebd7c67f build-script-build-script-build.json openssl-8490d657ccc10dc9 run-build-script-build-script-build.json openssl-macros-ab2851430da592ee lib-openssl-macros.json openssl-probe-37923ee13bc4c895 lib-openssl-probe.json openssl-probe-3c462a7143adfbb8 lib-openssl-probe.json openssl-sys-37a2b045e451633a lib-openssl-sys.json openssl-sys-4b622165e7cc8d32 lib-openssl-sys.json openssl-sys-61b50c6d51a1b08f run-build-script-build-script-main.json openssl-sys-639cb4d9375532b7 build-script-build-script-main.json overload-18c0da13fd2dae84 lib-overload.json parking-0317a91dedd47bde lib-parking.json parking-56d01326207ae653 lib-parking.json parking_lot-f4513565ba0e6a30 lib-parking_lot.json parking_lot_core-9bd220f200c8dfe1 lib-parking_lot_core.json parking_lot_core-a68f47dba63de3cb build-script-build-script-build.json parking_lot_core-b5c1a77566b6755b run-build-script-build-script-build.json percent-encoding-777d7f09c89b623a lib-percent-encoding.json pin-project-c08520db47463a9e lib-pin-project.json pin-project-internal-1bae4e033dd58143 lib-pin-project-internal.json pin-project-lite-0305e48733fbfdb4 lib-pin-project-lite.json pin-project-lite-f0a866decde17b0b lib-pin-project-lite.json pin-utils-72e4eda9094724d7 lib-pin-utils.json pkg-config-00ca0de8dd8b1bf0 lib-pkg-config.json pkg-config-0882c408381e718e lib-pkg-config.json polling-11985f96124d2f66 run-build-script-build-script-build.json polling-8808398db286250e lib-polling.json polling-996c02137cc9ed58 lib-polling.json polling-e44ed54736a24109 build-script-build-script-build.json portpicker-1e534c92e384ce79 lib-portpicker.json ppv-lite86-2c77b15d5e359e51 lib-ppv-lite86.json primitive-types-22f0bf7680159144 lib-primitive-types.json proc-macro-crate-6deea65a8a83e452 lib-proc-macro-crate.json proc-macro2-5c9e898a74b98f9e run-build-script-build-script-build.json proc-macro2-d44620fac1a30c23 lib-proc-macro2.json proc-macro2-d477dce77b18005b build-script-build-script-build.json quote-3793f0627de08455 run-build-script-build-script-build.json quote-5de90d461d6e7997 build-script-build-script-build.json quote-83bfc643f68e689c lib-quote.json rand-3f6aee37e0246dc7 lib-rand.json rand-db517a5b486ecdd2 lib-rand.json rand_chacha-725f45731883bebb lib-rand_chacha.json rand_chacha-a4a4eaddfee2347b lib-rand_chacha.json rand_core-1e475becb5d5c1f2 lib-rand_core.json rand_core-6d2c29c9b5b67c0d lib-rand_core.json reed-solomon-erasure-88a98bc331290e41 build-script-build-script-build.json reed-solomon-erasure-88d109adc1fa15f4 lib-reed-solomon-erasure.json reed-solomon-erasure-8b3989ef46c8f94f run-build-script-build-script-build.json regex-2f0a37219a6bdf28 lib-regex.json regex-93457a940afa06cd lib-regex.json regex-automata-f6adb29753ed7dc9 lib-regex-automata.json regex-syntax-459a131da3e5ebd1 lib-regex-syntax.json regex-syntax-c88ebe25e8b5d075 lib-regex-syntax.json reqwest-f3e0e2ea47c925cb lib-reqwest.json rustc-demangle-15d03f97c79800d5 lib-rustc-demangle.json rustc-demangle-eb6f9aa89ca9d224 lib-rustc-demangle.json rustix-1b934b086b4f441d lib-rustix.json rustix-37a7532d9e68b055 run-build-script-build-script-build.json rustix-b247629e101a7df5 build-script-build-script-build.json rustix-ed7a8ad3eef4ad72 lib-rustix.json rustversion-07ce336274e15138 build-script-build-script-build.json rustversion-40958208ddcafa3d run-build-script-build-script-build.json rustversion-97c432f40f1962d9 lib-rustversion.json ryu-71e9da68382a66dd lib-ryu.json scopeguard-9cdab693c44591e4 lib-scopeguard.json secp256k1-a068f6508c852432 lib-secp256k1.json secp256k1-sys-5ba6f6f02a1f72d7 build-script-build-script-build.json secp256k1-sys-aa13244d85c63dfc run-build-script-build-script-build.json secp256k1-sys-cb6ba48d2d089ef7 lib-secp256k1-sys.json serde-3c3639c5d2476ae4 lib-serde.json serde-5ce152114203691d build-script-build-script-build.json serde-9add142cdc3e4caf lib-serde.json serde-a092567f9717b821 run-build-script-build-script-build.json serde_derive-05eb9b891c59cdda lib-serde_derive.json serde_derive-7e0aa6e67d0f4d2d build-script-build-script-build.json serde_derive-bb8bbb17ce264f3a run-build-script-build-script-build.json serde_json-17125458db041170 lib-serde_json.json serde_json-74616da94efdabbb run-build-script-build-script-build.json serde_json-c850df0bad9739d5 build-script-build-script-build.json serde_repr-d2ce833e685b5a98 lib-serde_repr.json serde_urlencoded-9cdab0b88fc76be7 lib-serde_urlencoded.json sha2-cf8e3b9a254f4e7f lib-sha2.json sha2-d662f40a3376e1e8 lib-sha2.json sharded-slab-711bc8e47f1f6f17 lib-sharded-slab.json signal-hook-4d8912a682a96227 lib-signal-hook.json signal-hook-6971d46c75741cca lib-signal-hook.json signal-hook-beb3a03af6061dc8 build-script-build-script-build.json signal-hook-e4a71a775ebf7a96 run-build-script-build-script-build.json signal-hook-registry-3b72b1283874341f lib-signal-hook-registry.json signal-hook-registry-7ee5a9888cdafd4d lib-signal-hook-registry.json signature-0f87899d6e4cd44f lib-signature.json siphasher-62d2d55e0e4b5691 lib-siphasher.json siphasher-b93fa68d8b1c95ae lib-siphasher.json slab-1130a7c00f4fcaf7 build-script-build-script-build.json slab-26812bbd6d9a1ed1 run-build-script-build-script-build.json slab-eb1c4bddd3511f11 lib-slab.json slab-f17b5890807cb2a8 lib-slab.json smallvec-a768dc29f0159b87 lib-smallvec.json smart-default-bc7a6ccff6c4467d lib-smart-default.json socket2-109fabfd6118ca79 lib-socket2.json socket2-c23233f1d078ba5d lib-socket2.json static_assertions-ac08ed56ea7d7573 lib-static_assertions.json strum-47512def29327f64 lib-strum.json strum_macros-96ca3aaab65da9af lib-strum_macros.json subtle-40292eb83145cb10 lib-subtle.json syn-1f5d3b864e25c6b7 run-build-script-build-script-build.json syn-5c5120328de41ea7 lib-syn.json syn-9df8c35f8410a2fd build-script-build-script-build.json syn-d9d9c3cbd5b09612 lib-syn.json synstructure-50d1226d4dd9269b lib-synstructure.json tar-a4bfb6aa070331b3 lib-tar.json tar-ad3f71c42f10ecb6 lib-tar.json thiserror-70cb674808dc8999 build-script-build-script-build.json thiserror-8c2306d1194bd151 run-build-script-build-script-build.json thiserror-a738bfadd5a5a7a2 lib-thiserror.json thiserror-f8fcdd3931de96d3 lib-thiserror.json thiserror-impl-57e4ef57afca3c30 lib-thiserror-impl.json thread_local-b51021a2b5e36394 lib-thread_local.json time-46ef954fbe041fb4 lib-time.json time-59f1e41e924cfc9e lib-time.json tinyvec-4f5c63f50d6826fc lib-tinyvec.json tinyvec_macros-4dd1fdaacea3ef77 lib-tinyvec_macros.json tokio-59145830bc7f6d15 lib-tokio.json tokio-862026d211e9d043 run-build-script-build-script-build.json tokio-b1ec5dd274e69fba build-script-build-script-build.json tokio-macros-dc8edafce91315d7 lib-tokio-macros.json tokio-native-tls-57c47d42a41aac6a lib-tokio-native-tls.json tokio-retry-192a1f06afcbcd94 lib-tokio-retry.json tokio-util-6a36f22bd5d0b187 lib-tokio-util.json toml-5da4343c3a723e40 lib-toml.json tower-service-3eb5d3d3f4ce5e61 lib-tower-service.json tracing-45b6c61224b882a7 lib-tracing.json tracing-attributes-a632790be03713f8 lib-tracing-attributes.json tracing-core-9ae88f11315f52b3 lib-tracing-core.json tracing-log-145225d19603f1cb lib-tracing-log.json tracing-subscriber-0c32c678951780d4 lib-tracing-subscriber.json try-lock-e05d8c1a06bf3dd3 lib-try-lock.json typenum-152c8c499745c713 run-build-script-build-script-main.json typenum-33441ce6b80eedef build-script-build-script-main.json typenum-b84e03536911cc93 lib-typenum.json uint-94b5bf429273633b lib-uint.json unicode-bidi-37293a4760bd89ee lib-unicode_bidi.json unicode-ident-1b2c5f527366f723 lib-unicode-ident.json unicode-normalization-510f1d653357f814 lib-unicode-normalization.json unicode-xid-be752b521656c1e9 lib-unicode-xid.json url-4fa6634780f5129f lib-url.json uuid-e84062e461de6626 lib-uuid.json version_check-1c4464117be37b7b lib-version_check.json waker-fn-b9f71ca536063175 lib-waker-fn.json waker-fn-e6f58b1139fd56ef lib-waker-fn.json want-97c0e444b3239e4a lib-want.json workspaces-08fc790263131fa8 run-build-script-build-script-build.json workspaces-1b825ec4a75c2721 build-script-build-script-build.json workspaces-b6bacd09c3db4655 lib-workspaces.json xattr-c7d6c524658f4295 lib-xattr.json xattr-f674177130c585c9 lib-xattr.json zeroize-9e594d7766ba287b lib-zeroize.json zeroize_derive-7165f64dfa309663 lib-zeroize_derive.json zip-82df55529cba923b lib-zip.json zip-d25d577b3ec0ab73 lib-zip.json build anyhow-66d4f26a59c32f1e out probe.rs bzip2-sys-5505d17fea1678b0 out include bzlib.h crunchy-df70957b059bbb28 out lib.rs num-bigint-dcfb71e04484ab33 out radix_bases.rs reed-solomon-erasure-8b3989ef46c8f94f out table.rs secp256k1-sys-aa13244d85c63dfc out flag_check.c thiserror-8c2306d1194bd151 out probe.rs typenum-152c8c499745c713 out consts.rs op.rs tests.rs Public header file for the library. bzlib.h end bzlib.h package-lock.json package.json

near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.

Lean-b_digital-identity-rust

.gitpod.yml README.md contract Cargo.toml README.md build.sh deploy.sh neardev dev-account.env src lib.rs target .rustc_info.json debug .fingerprint Identity-30e63472cf1d42b2 lib-Identity.json Identity-3bccab97a5835eb4 test-lib-Identity.json Inflector-5c219fa546c26c35 lib-inflector.json ahash-5017f21183ca0ad3 run-build-script-build-script-build.json ahash-85481c7807ccbe88 lib-ahash.json ahash-d80ce46d015d6b0e lib-ahash.json ahash-f33fcefd7904d790 build-script-build-script-build.json arrayref-10877b1ad90234da lib-arrayref.json arrayref-adf68943d77c6d50 lib-arrayref.json arrayvec-3af677b572e5d193 lib-arrayvec.json arrayvec-7c8bd4b56d4587fd lib-arrayvec.json arrayvec-a7781b0c786236ed lib-arrayvec.json arrayvec-de2a35268dbb75e4 lib-arrayvec.json autocfg-598af3d7412b9e2a lib-autocfg.json base64-1b053dca54eb6ccc lib-base64.json base64-61d42fe789cc9c62 lib-base64.json base64-cfd8ae989177ed05 lib-base64.json base64-d6aceb2bab5de518 lib-base64.json bitvec-0aca8649a67c921a lib-bitvec.json bitvec-57be0319250dedac lib-bitvec.json blake2-0977f20e3fb0f1af lib-blake2.json blake2-0c01a093c6b42dc2 lib-blake2.json block-buffer-1d16fb336929a95e lib-block-buffer.json block-buffer-4125c685277a1ceb lib-block-buffer.json block-buffer-9f49d980cba7ddc0 lib-block-buffer.json block-buffer-ee998e25ee5d2f03 lib-block-buffer.json borsh-cb317d8d1466dd67 lib-borsh.json borsh-derive-4ddd3fe80229a042 lib-borsh-derive.json borsh-derive-internal-b1cdd73d4acf20de lib-borsh-derive-internal.json borsh-e7c1341964ef667b lib-borsh.json borsh-schema-derive-internal-7fced45fae295ed2 lib-borsh-schema-derive-internal.json bs58-4286c114812d83fb lib-bs58.json bs58-4b874f0791abbdc5 lib-bs58.json byte-slice-cast-3148aabe35dba0ae lib-byte-slice-cast.json byte-slice-cast-e892fc1d8d3e5952 lib-byte-slice-cast.json byteorder-6b14f5d2c1756e28 lib-byteorder.json byteorder-87abd6c0bc80e19a lib-byteorder.json bytesize-7ee3322d5937cf14 lib-bytesize.json bytesize-afe84a986b7885c1 lib-bytesize.json c2-chacha-071e80b45cfb19fd lib-c2-chacha.json c2-chacha-31d6f4250d7cfe79 lib-c2-chacha.json cc-aec6b6bea274242d lib-cc.json cfg-if-305ff6ac5e1cfc5a lib-cfg-if.json cfg-if-c0e067d70aa8caeb lib-cfg-if.json cfg-if-c5ecda8eda4bb42b lib-cfg-if.json cfg-if-f2fb9e8aaf7872cc lib-cfg-if.json chrono-a98b1e69d3bbb5b5 lib-chrono.json chrono-c9dcd15985763d42 lib-chrono.json cipher-65f98cab52cb6213 lib-cipher.json cipher-cb18d5cee91e755a lib-cipher.json convert_case-e0c3af0b969d40cb lib-convert_case.json cpufeatures-8c4353bec4911ce3 lib-cpufeatures.json cpufeatures-f0d15f820614a891 lib-cpufeatures.json crunchy-20ff0c8494bd7138 lib-crunchy.json crunchy-292e1f791a95afb1 build-script-build-script-build.json crunchy-aed150e2e6d901e8 run-build-script-build-script-build.json crunchy-b2baa7497c9a353d lib-crunchy.json crypto-common-10363f99a777abda lib-crypto-common.json crypto-common-6efdf1e282d11b60 lib-crypto-common.json crypto-mac-c802588c001f0604 lib-crypto-mac.json crypto-mac-f82625be261ccabe lib-crypto-mac.json curve25519-dalek-568426deae6c2a23 lib-curve25519-dalek.json curve25519-dalek-e0a3ece49c7e32d6 lib-curve25519-dalek.json derive_more-cbfaaa94ef6c2636 lib-derive_more.json digest-27775b05b501b724 lib-digest.json digest-661b192870ee0846 lib-digest.json digest-97aeb361dc2d97d3 lib-digest.json digest-fa4f32c11df1efc5 lib-digest.json dyn-clone-6c76ff25ff9401f9 lib-dyn-clone.json dyn-clone-b0a9b306ed819430 lib-dyn-clone.json easy-ext-e6bdfcbf29324995 lib-easy-ext.json ed25519-108b66d1a615194f lib-ed25519.json ed25519-26e613b5563dd6e5 lib-ed25519.json ed25519-dalek-0d809fa0f42ca96f lib-ed25519-dalek.json ed25519-dalek-e1943871a95cba6a lib-ed25519-dalek.json fixed-hash-792bb1ae7be32249 lib-fixed-hash.json fixed-hash-b0dec90ce16b5638 lib-fixed-hash.json funty-99fb8a7ebdd9af4a lib-funty.json funty-f3a639b2a81ceac8 lib-funty.json generic-array-2ca50e8cc5b0ebdd lib-generic_array.json generic-array-419d2f54457119b0 build-script-build-script-build.json generic-array-c944a1b2a8765f02 lib-generic_array.json generic-array-f05291a342fc6640 run-build-script-build-script-build.json getrandom-06a563616fb9138a lib-getrandom.json getrandom-09ea8733eff9d543 lib-getrandom.json getrandom-1f9d72f33b1a92a8 lib-getrandom.json getrandom-314bd1fb9b138385 lib-getrandom.json getrandom-53ebbdf139640c55 run-build-script-build-script-build.json getrandom-6f854bb04ac86e05 build-script-build-script-build.json hashbrown-92d0fdf137718cbc lib-hashbrown.json hashbrown-ce668f175e4caa93 lib-hashbrown.json hashbrown-fa5714d6bd0e3fcd lib-hashbrown.json heck-3582ae575b6cf835 lib-heck.json hello-2fd713bef8d203a9 lib-hello.json hello-ac22a20ceddfa006 test-lib-hello.json hello_near-54ba08d01d54d199 test-lib-hello_near.json hello_near-837901fe89f14612 lib-hello_near.json hello_near-90aac2734c4cff74 lib-hello_near.json hello_near-ab24c70cfafa5107 test-lib-hello_near.json hello_near-b4be88ba9663f3a8 test-lib-hello_near.json hex-0694d5f948bc8c08 lib-hex.json hex-3d9136de502095bb lib-hex.json iana-time-zone-95b046245d7a1b1b lib-iana-time-zone.json iana-time-zone-ae94d49374b01111 lib-iana-time-zone.json impl-codec-0ce5e4d5515ae07f lib-impl-codec.json impl-codec-36d98d3e8d89ea0a lib-impl-codec.json impl-trait-for-tuples-94f9e2e3cd71bf86 lib-impl-trait-for-tuples.json indexmap-505c3e24aba69b59 run-build-script-build-script-build.json indexmap-641106041cc95ccb build-script-build-script-build.json indexmap-eb52602f97adb5b0 lib-indexmap.json itoa-10f0ed6338a99ace lib-itoa.json itoa-5b8fd99974b6390b lib-itoa.json keccak-90f992fd70c4baca lib-keccak.json keccak-fa38e14bc98bbfad lib-keccak.json lazy_static-674678a903997803 lib-lazy_static.json lazy_static-b0c1a2f0930eb7e2 lib-lazy_static.json libc-25ddbd3b1a112e1b run-build-script-build-script-build.json libc-4e5890aca5342948 lib-libc.json libc-7f8f0d23e8eac177 lib-libc.json libc-ff6b5cf0c6c7af5c build-script-build-script-build.json memory_units-05735525f3cbbf59 lib-memory_units.json memory_units-9041abaad831aa9d lib-memory_units.json near-abi-1a53f64fbb7eeb33 lib-near-abi.json near-abi-8db84474cc08d053 lib-near-abi.json near-account-id-290618e1e1048dd9 lib-near-account-id.json near-account-id-309c849574da47a3 lib-near-account-id.json near-crypto-5b318731999ab784 lib-near-crypto.json near-crypto-cd168bb13e681d50 lib-near-crypto.json near-primitives-2fe9a2ef95d03bd4 lib-near-primitives.json near-primitives-b9dfe0daaf1b0498 lib-near-primitives.json near-primitives-core-b96580efba41da99 lib-near-primitives-core.json near-primitives-core-ecd88c456ec47e44 lib-near-primitives-core.json near-rpc-error-core-ed958dfa3d504d78 lib-near-rpc-error-core.json near-rpc-error-macro-05c92ff8a43d3e6f lib-near-rpc-error-macro.json near-sdk-976150f8f2b4ed98 lib-near-sdk.json near-sdk-d14e32f45eba7e8a lib-near-sdk.json near-sdk-macros-5790871a709d511f lib-near-sdk-macros.json near-sys-02d7a85f6d5b8221 lib-near-sys.json near-sys-5adfa9a0cedbdaec lib-near-sys.json near-vm-errors-a91c841c415ae973 lib-near-vm-errors.json near-vm-errors-fef14545a0cc46db lib-near-vm-errors.json near-vm-logic-38817a7793381072 lib-near-vm-logic.json near-vm-logic-412e9c301b0e9c34 lib-near-vm-logic.json num-bigint-16c86033179058c4 build-script-build-script-build.json num-bigint-38c3a2c07c70fdd5 run-build-script-build-script-build.json num-bigint-5277f0d7a17fb63b lib-num-bigint.json num-bigint-66baddddf6796d9a lib-num-bigint.json num-integer-2b5be95c76842b46 lib-num-integer.json num-integer-4149e25514062a4b run-build-script-build-script-build.json num-integer-d144a01bf0e274e6 build-script-build-script-build.json num-integer-fa7789cacaa4a095 lib-num-integer.json num-rational-224339838ade188a run-build-script-build-script-build.json num-rational-8a77535daf8ec4e7 build-script-build-script-build.json num-rational-c51d5b2fb20ce9e2 lib-num-rational.json num-rational-d17ca4b7cd4fdfa5 lib-num-rational.json num-traits-7836f9a67045c300 build-script-build-script-build.json num-traits-919969d3f805f3d7 lib-num-traits.json num-traits-98cd64f6d418676f lib-num-traits.json num-traits-aaf24942c40cc7a7 run-build-script-build-script-build.json once_cell-1fed24a227dd9b5a lib-once_cell.json once_cell-28901915798b6da4 lib-once_cell.json opaque-debug-49be1d4a0aee537e lib-opaque-debug.json opaque-debug-4f35227bc1370317 lib-opaque-debug.json parity-scale-codec-5d50564758a61adb lib-parity-scale-codec.json parity-scale-codec-73291ef77084bae7 lib-parity-scale-codec.json parity-scale-codec-derive-e14a8628b7cc3a49 lib-parity-scale-codec-derive.json parity-secp256k1-83a8b4cf180cd8f3 lib-secp256k1.json parity-secp256k1-8a220f833537d998 run-build-script-build-script-build.json parity-secp256k1-bc4c3310bf251269 lib-secp256k1.json parity-secp256k1-c3d3d7b65b1c5be9 build-script-build-script-build.json ppv-lite86-4d7d1fd1adb25114 lib-ppv-lite86.json ppv-lite86-77c24c11bb635843 lib-ppv-lite86.json primitive-types-b6e57bdbfeba7e41 lib-primitive-types.json primitive-types-d10c7998215e4888 lib-primitive-types.json proc-macro-crate-1e9a2244a47c41f7 lib-proc-macro-crate.json proc-macro-crate-a66c0374b064f62b lib-proc-macro-crate.json proc-macro2-349a49cf19c07c83 build-script-build-script-build.json proc-macro2-831dbbc12a7f7f4b lib-proc-macro2.json proc-macro2-c5954e779c9f87d5 run-build-script-build-script-build.json quote-177a4d1eb2e6d732 lib-quote.json quote-30b258d11e299ebe run-build-script-build-script-build.json quote-de6232726d2cb6c6 build-script-build-script-build.json radium-1164d13da6efc6c6 build-script-build-script-build.json radium-1ccdc4118c4936dc lib-radium.json radium-90ee0542f34da5c9 run-build-script-build-script-build.json radium-97068bcf1842f372 lib-radium.json rand-5bb25ce758877ff4 lib-rand.json rand-6c71a049e46ca4e1 lib-rand.json rand-805c841b00346b5d lib-rand.json rand-9c604856c8da3b60 lib-rand.json rand_chacha-17ff4e6814f454c3 lib-rand_chacha.json rand_chacha-a865af05d42bf583 lib-rand_chacha.json rand_chacha-b2d3cc92d0db15b7 lib-rand_chacha.json rand_chacha-bd5d416df907976d lib-rand_chacha.json rand_core-1a3df0f6a3e1237b lib-rand_core.json rand_core-23e62bd897a947dd lib-rand_core.json rand_core-58cbfcf8986597e4 lib-rand_core.json rand_core-8a7e65eaca7b147a lib-rand_core.json reed-solomon-erasure-1bfeb0e8306440ff build-script-build-script-build.json reed-solomon-erasure-581ef322c1bd10a9 lib-reed-solomon-erasure.json reed-solomon-erasure-6ac477ee629e5b49 run-build-script-build-script-build.json reed-solomon-erasure-6ef496b278615d4b lib-reed-solomon-erasure.json ripemd-05873900ca75efa8 lib-ripemd.json ripemd-3ff6726797484802 lib-ripemd.json rustc-hex-86a51d1a38087992 lib-rustc-hex.json rustc-hex-def89c995e3f0540 lib-rustc-hex.json rustversion-0f9c5e160788e356 run-build-script-build-script-build.json rustversion-a5b9924804e34d6a lib-rustversion.json rustversion-e3dc74e9c6d9b27d build-script-build-script-build.json ryu-69fc74dff33c2357 lib-ryu.json ryu-93d190a7b1b44962 lib-ryu.json schemars-04a60c4cb7b5a0fe build-script-build-script-build.json schemars-408ada427deaef8e lib-schemars.json schemars-c5c87ed054d5fa47 lib-schemars.json schemars-dfda60cf7052f889 run-build-script-build-script-build.json schemars_derive-7d841c72fc60cc86 lib-schemars_derive.json semver-522b531f085592df build-script-build-script-build.json semver-5edca445d4046440 lib-semver.json semver-7601d421a4413153 run-build-script-build-script-build.json semver-e6e03f4058981cd9 lib-semver.json serde-173a5c7a4703b3ba build-script-build-script-build.json serde-296a97bdb777b709 run-build-script-build-script-build.json serde-2ec771397489178a lib-serde.json serde-3f218362a4bb845c build-script-build-script-build.json serde-7245c65a89b7963a lib-serde.json serde-7f805b2896f5f822 run-build-script-build-script-build.json serde-e447fc4a72b75a78 lib-serde.json serde_derive-2ab76ad0041edacd build-script-build-script-build.json serde_derive-4a277ad0d50b23da lib-serde_derive.json serde_derive-edb91756c86dac7a run-build-script-build-script-build.json serde_derive_internals-03f462d821a869ab lib-serde_derive_internals.json serde_json-119ada0a30c92fb7 build-script-build-script-build.json serde_json-ca117df42fef51b3 lib-serde_json.json serde_json-cdafccc44a1f2107 run-build-script-build-script-build.json serde_json-fdbb0bb639f5b096 lib-serde_json.json sha2-4e135deb1773438f lib-sha2.json sha2-66ece1cd8d69df6f lib-sha2.json sha2-711c4e21549b6308 lib-sha2.json sha2-c9064e4e5d4ee486 lib-sha2.json sha3-2d3bd734b2159d3e lib-sha3.json sha3-6dce060cfb99bc47 lib-sha3.json signature-70d27661424d9225 lib-signature.json signature-b30afcffde865083 lib-signature.json smallvec-56fabd0c3c693dfe lib-smallvec.json smallvec-6e1c17b845005b75 lib-smallvec.json smart-default-8a3402f3fe589907 lib-smart-default.json spin-8eb1fff0cc0e4e6a lib-spin.json spin-e624bc76a28369ce lib-spin.json static_assertions-7ba2e6f36eaa2754 lib-static_assertions.json static_assertions-9444df629bbf5cf3 lib-static_assertions.json strum-4a27902255f6d56e lib-strum.json strum-83d3840a2f700983 lib-strum.json strum_macros-b537f44dcc258c42 lib-strum_macros.json subtle-9f4961b7d1fd57c2 lib-subtle.json subtle-b096ceef5aaafe70 lib-subtle.json syn-06dea35cc6d232a9 lib-syn.json syn-35c5fa04a5671d13 run-build-script-build-script-build.json syn-6cade367d9ec6e9f build-script-build-script-build.json syn-8d064bce49ed1b05 lib-syn.json tap-a015ed3dbccfa528 lib-tap.json tap-bafd369c90481518 lib-tap.json thiserror-2f75ac8ac42a04d3 lib-thiserror.json thiserror-5d9f7a0419192cbb run-build-script-build-script-build.json thiserror-88fae8bdbd91f37c lib-thiserror.json thiserror-e20a5fd60407f0ff build-script-build-script-build.json thiserror-impl-117f397324ef5598 lib-thiserror-impl.json time-5f9c7e5ac027e233 lib-time.json time-b1958fb860a41a10 lib-time.json toml-e2b7ad2b785fdb32 lib-toml.json toml_datetime-6e529afff2c9d6c3 lib-toml_datetime.json toml_edit-541e48f5fc630811 lib-toml_edit.json typenum-2cf688ad06b9b6bd build-script-build-script-main.json typenum-31ff56aa25e377bc lib-typenum.json typenum-aed0ef46e215dd29 run-build-script-build-script-main.json typenum-f770b81a7b849d66 lib-typenum.json uint-0b6201b82488f6ad lib-uint.json uint-253ee44affa95ccb lib-uint.json unicode-ident-4734e2493b4f5fae lib-unicode-ident.json version_check-dbde7c3a713834cc lib-version_check.json wee_alloc-18d892821e075d33 run-build-script-build-script-build.json wee_alloc-798b912294f77720 lib-wee_alloc.json wee_alloc-94fbdb367e1564c4 build-script-build-script-build.json wee_alloc-a0b255277ab83fbf lib-wee_alloc.json winnow-a8e76b03ecf0be98 lib-winnow.json wyz-0efa081e5b513616 lib-wyz.json wyz-bfd85031302234f8 lib-wyz.json zeroize-5a3688e76e81c77f lib-zeroize.json zeroize-f0c3f30beb3aacbf lib-zeroize.json zeroize_derive-471705907b829617 lib-zeroize_derive.json zeropool-bn-8997cf8041f51990 lib-zeropool-bn.json zeropool-bn-fd69c0df1dffc7eb lib-zeropool-bn.json build crunchy-aed150e2e6d901e8 out lib.rs num-bigint-38c3a2c07c70fdd5 out radix_bases.rs parity-secp256k1-8a220f833537d998 out flag_check.c reed-solomon-erasure-6ac477ee629e5b49 out table.rs thiserror-5d9f7a0419192cbb out probe.rs typenum-aed0ef46e215dd29 out consts.rs op.rs tests.rs wee_alloc-18d892821e075d33 out wee_alloc_static_array_backend_size_bytes.txt release .fingerprint Inflector-fdabd73a9d53da17 lib-inflector.json ahash-59d2f4b237532e44 build-script-build-script-build.json borsh-derive-d9d83eb08d9dd013 lib-borsh-derive.json borsh-derive-internal-7f55e78b58c98446 lib-borsh-derive-internal.json borsh-schema-derive-internal-38c2f505a7aa833e lib-borsh-schema-derive-internal.json crunchy-6d9498eafd025733 build-script-build-script-build.json near-sdk-macros-d6d256b98c894282 lib-near-sdk-macros.json proc-macro-crate-f6af739bd8bbc227 lib-proc-macro-crate.json proc-macro2-b8a0bdf1d7c5e902 lib-proc-macro2.json proc-macro2-c48d0e2254892565 build-script-build-script-build.json proc-macro2-dfa2b0cd57223a46 run-build-script-build-script-build.json quote-4caa1b04ed65c939 run-build-script-build-script-build.json quote-94f379590ec08d4f lib-quote.json quote-bf49db4bd3a766f6 build-script-build-script-build.json schemars-3088dfb01f37378e build-script-build-script-build.json schemars_derive-98f5bf95891ae017 lib-schemars_derive.json semver-1f433957306984ec build-script-build-script-build.json serde-200ed118e9fe3808 build-script-build-script-build.json serde-35cde3cd7df8711c build-script-build-script-build.json serde-5a542363adfc6b92 run-build-script-build-script-build.json serde-aecd1769a2e81329 lib-serde.json serde_derive-5c349caf13cb742a lib-serde_derive.json serde_derive-62d18ae1a8a4f046 build-script-build-script-build.json serde_derive-fb5ad07d736ab0e5 run-build-script-build-script-build.json serde_derive_internals-e746fc07cbe8009a lib-serde_derive_internals.json serde_json-81206c4f43114f7b build-script-build-script-build.json syn-85073afca43fa80d lib-syn.json syn-9b7a4fffd0653fd8 lib-syn.json syn-9bb5d2b47dc4d4a2 run-build-script-build-script-build.json syn-a5342720190682a6 build-script-build-script-build.json toml-b4fd51a022b740c8 lib-toml.json unicode-ident-e981c57c749e7ab1 lib-unicode-ident.json version_check-36f0c2a534b36ffa lib-version_check.json wee_alloc-7ded3581aad66b51 build-script-build-script-build.json wasm32-unknown-unknown release .fingerprint ahash-29eaadd068ded94c lib-ahash.json ahash-a536bd1415a4b91d run-build-script-build-script-build.json base64-2c3dc681ebeb91c5 lib-base64.json borsh-84feccd18c488ef6 lib-borsh.json bs58-0ba986510d9271c0 lib-bs58.json byteorder-6534e076ffc37865 lib-byteorder.json cfg-if-32aeeeae61fcc10b lib-cfg-if.json crunchy-ce4ba795fcc54513 lib-crunchy.json crunchy-eef6a57efa4e8c65 run-build-script-build-script-build.json dyn-clone-f84299aa4a2b8a66 lib-dyn-clone.json hashbrown-7a4e165c91f93c4b lib-hashbrown.json hello_near-00ca379cccdf6430 lib-hello_near.json hex-2430decfc41f7c66 lib-hex.json itoa-36efa0c7570104d4 lib-itoa.json memory_units-3d6e5c0951dd8450 lib-memory_units.json near-abi-b8d2a84470066a6c lib-near-abi.json near-sdk-fa0c83d333efac94 lib-near-sdk.json near-sys-0b4a0be9287ce6de lib-near-sys.json once_cell-7ec27786d0dbfee1 lib-once_cell.json ryu-5ab6a1f5124adb17 lib-ryu.json schemars-4789408fccd876ad run-build-script-build-script-build.json schemars-7783dcceac5e441a lib-schemars.json semver-a202de081a0d3bff lib-semver.json semver-d6ac273da731c59f run-build-script-build-script-build.json serde-25610e7e60a8a645 lib-serde.json serde-a0cd0a692d316f8d run-build-script-build-script-build.json serde_json-3cb0f54700844b1c run-build-script-build-script-build.json serde_json-72ffdfd91d3068b6 lib-serde_json.json static_assertions-76ba13a4efc22c93 lib-static_assertions.json uint-8a6c652da9b28060 lib-uint.json wee_alloc-7b8384e6df6381cb lib-wee_alloc.json wee_alloc-fff0fccfc455042f run-build-script-build-script-build.json build crunchy-eef6a57efa4e8c65 out lib.rs wee_alloc-fff0fccfc455042f out wee_alloc_static_array_backend_size_bytes.txt neardev dev-account.env package-lock.json package.json

near-blank-project ================== This app was initialized with [create-near-app] Quick Start =========== If you haven't installed dependencies during setup: npm install Build and deploy your contract to TestNet with a temporary dev account: npm run deploy Test your contract: npm test If you have a frontend, run `npm start`. This will run a dev server. Exploring The Code ================== 1. The smart-contract code lives in the `/contract` folder. See the README there for more info. In blockchain apps the smart contract is the "backend" of your app. 2. The frontend code lives in the `/frontend` folder. `/frontend/index.html` is a great place to start exploring. Note that it loads in `/frontend/index.js`, this is your entrypoint to learn how the frontend connects to the NEAR blockchain. 3. Test your contract: `npm test`, this will run the tests in `integration-tests` directory. Deploy ====== Every smart contract in NEAR has its [own associated account][NEAR accounts]. When you run `npm run deploy`, your smart contract gets deployed to the live NEAR TestNet with a temporary dev account. When you're ready to make it permanent, here's how: Step 0: Install near-cli (optional) ------------------------------------- [near-cli] is a command line interface (CLI) for interacting with the NEAR blockchain. It was installed to the local `node_modules` folder when you ran `npm install`, but for best ergonomics you may want to install it globally: npm install --global near-cli Or, if you'd rather use the locally-installed version, you can prefix all `near` commands with `npx` Ensure that it's installed with `near --version` (or `npx near --version`) Step 1: Create an account for the contract ------------------------------------------ Each account on NEAR can have at most one contract deployed to it. If you've already created an account such as `your-name.testnet`, you can deploy your contract to `near-blank-project.your-name.testnet`. Assuming you've already created an account on [NEAR Wallet], here's how to create `near-blank-project.your-name.testnet`: 1. Authorize NEAR CLI, following the commands it gives you: near login 2. Create a subaccount (replace `YOUR-NAME` below with your actual account name): near create-account near-blank-project.YOUR-NAME.testnet --masterAccount YOUR-NAME.testnet Step 2: deploy the contract --------------------------- Use the CLI to deploy the contract to TestNet with your account ID. Replace `PATH_TO_WASM_FILE` with the `wasm` that was generated in `contract` build directory. near deploy --accountId near-blank-project.YOUR-NAME.testnet --wasmFile PATH_TO_WASM_FILE Step 3: set contract name in your frontend code ----------------------------------------------- Modify the line in `src/config.js` that sets the account name of the contract. Set it to the account id you used above. const CONTRACT_NAME = process.env.CONTRACT_NAME || 'near-blank-project.YOUR-NAME.testnet' Troubleshooting =============== On Windows, if you're seeing an error containing `EPERM` it may be related to spaces in your path. Please see [this issue](https://github.com/zkat/npx/issues/209) for more details. [create-near-app]: https://github.com/near/create-near-app [Node.js]: https://nodejs.org/en/download/package-manager/ [jest]: https://jestjs.io/ [NEAR accounts]: https://docs.near.org/concepts/basics/account [NEAR Wallet]: https://wallet.testnet.near.org/ [near-cli]: https://github.com/near/near-cli [gh-pages]: https://github.com/tschaub/gh-pages # Hello NEAR Contract The smart contract exposes two methods to enable storing and retrieving a greeting in the NEAR network. ```rust const DEFAULT_GREETING: &str = "Hello"; #[near_bindgen] #[derive(BorshDeserialize, BorshSerialize)] pub struct Contract { greeting: String, } impl Default for Contract { fn default() -> Self { Self{greeting: DEFAULT_GREETING.to_string()} } } #[near_bindgen] impl Contract { // Public: Returns the stored greeting, defaulting to 'Hello' pub fn get_greeting(&self) -> String { return self.greeting.clone(); } // Public: Takes a greeting, such as 'howdy', and records it pub fn set_greeting(&mut self, greeting: String) { // Record a log permanently to the blockchain! log!("Saving greeting {}", greeting); self.greeting = greeting; } } ``` <br /> # Quickstart 1. Make sure you have installed [rust](https://rust.org/). 2. Install the [`NEAR CLI`](https://github.com/near/near-cli#setup) <br /> ## 1. Build and Deploy the Contract You can automatically compile and deploy the contract in the NEAR testnet by running: ```bash ./deploy.sh ``` Once finished, check the `neardev/dev-account` file to find the address in which the contract was deployed: ```bash cat ./neardev/dev-account # e.g. dev-1659899566943-21539992274727 ``` <br /> ## 2. Retrieve the Greeting `get_greeting` is a read-only method (aka `view` method). `View` methods can be called for **free** by anyone, even people **without a NEAR account**! ```bash # Use near-cli to get the greeting near view <dev-account> get_greeting ``` <br /> ## 3. Store a New Greeting `set_greeting` changes the contract's state, for which it is a `change` method. `Change` methods can only be invoked using a NEAR account, since the account needs to pay GAS for the transaction. ```bash # Use near-cli to set a new greeting near call <dev-account> set_greeting '{"message":"howdy"}' --accountId <dev-account> ``` **Tip:** If you would like to call `set_greeting` using your own account, first login into NEAR using: ```bash # Use near-cli to login your NEAR account near login ``` and then use the logged account to sign the transaction: `--accountId <your-account>`.