generated from auditless/cairo-template
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #17 from BibliothecaDAO/sdk
refactor dir, add temp
- Loading branch information
Showing
37 changed files
with
1,307 additions
and
178 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,4 +9,6 @@ target | |
.idea/ | ||
.spr.yml | ||
node_modules | ||
.DS_Store | ||
.DS_Store | ||
|
||
.sdk/node_modules |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,107 +1,3 @@ | ||
# InstaSwap | ||
## InstaSwap | ||
|
||
What is InstaSwap? | ||
|
||
InstaSwap is a decentralized token swap protocol for ERC-1155 tokens on Starknet. In other words, InstaSwap is Uniswap for ERC-1155 tokens.Users can trade up to `n` amount of ERC1155 tokens in one transaction with a ERC20 token! | ||
|
||
*Greatly inspired by Uniswap and Niftyswap,thanks for the work done by the Uniswap team and Niftyswap team* | ||
|
||
|
||
# Contribute | ||
|
||
Contribution are welcome! Please check the good first issues for a list of issues that are good for new contributors. | ||
|
||
# Development | ||
|
||
## Installing dependencies | ||
|
||
### Step 1: Install Cairo 1.0 (guide by [Abdel](https://github.com/abdelhamidbakhta)) | ||
|
||
If you are on an x86 Linux system and able to use the release binary, | ||
you can download Cairo here https://github.com/starkware-libs/cairo/releases. | ||
|
||
For everyone, else, we recommend compiling Cairo from source like so: | ||
|
||
```bash | ||
# Install stable Rust | ||
$ rustup override set stable && rustup update | ||
|
||
# Clone the Cairo compiler in $HOME/Bin | ||
$ cd ~/Bin && git clone [email protected]:starkware-libs/cairo.git && cd cairo | ||
|
||
# Generate release binaries | ||
$ cargo build --all --release | ||
``` | ||
|
||
**NOTE: Keeping Cairo up to date** | ||
|
||
Now that your Cairo compiler is in a cloned repository, all you will need to do | ||
is pull the latest changes and rebuild as follows: | ||
|
||
```bash | ||
$ cd ~/Bin/cairo && git fetch && git pull && cargo build --all --release | ||
``` | ||
|
||
### Step 2: Add Cairo 1.0 executables to your path | ||
|
||
```bash | ||
export PATH="$HOME/Bin/cairo/target/release:$PATH" | ||
``` | ||
|
||
**NOTE: If installing from a Linux binary, adapt the destination path accordingly.** | ||
|
||
This will make available several binaries. The one we use is called `cairo-test`. | ||
|
||
### Step 3: Install the Cairo package manager Scarb | ||
|
||
Follow the installation guide in [Scarb's Repository](https://github.com/software-mansion/scarb). | ||
|
||
### Step 4: Setup Language Server | ||
|
||
#### VS Code Extension | ||
|
||
- Disable previous Cairo 0.x extension | ||
- Install the Cairo 1 extension for proper syntax highlighting and code navigation. | ||
Just follow the steps indicated [here](https://github.com/starkware-libs/cairo/blob/main/vscode-cairo/README.md). | ||
|
||
#### Cairo Language Server | ||
|
||
From [Step 1](#step-1-install-cairo-10-guide-by-abdel), the `cairo-language-server` binary should be built and executing this command will copy its path into your clipboard. | ||
|
||
```bash | ||
$ which cairo-language-server | pbcopy | ||
``` | ||
|
||
Update the `languageServerPath` of the Cairo 1.0 extension by pasting the path. | ||
|
||
### Build | ||
|
||
Build the contracts. | ||
|
||
```bash | ||
$ make build | ||
``` | ||
|
||
### Test | ||
|
||
Run the tests in `src/test`: | ||
|
||
```bash | ||
$ make test | ||
``` | ||
|
||
### Format | ||
|
||
Format the Cairo source code (using Scarb): | ||
|
||
```bash | ||
$ make fmt | ||
``` | ||
|
||
### Sierra (advanced) | ||
|
||
View the compiled Sierra output of your Cairo code: | ||
|
||
```bash | ||
$ make sierra | ||
``` | ||
## |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore | ||
|
||
# Logs | ||
|
||
logs | ||
_.log | ||
npm-debug.log_ | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
|
||
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json | ||
|
||
# Runtime data | ||
|
||
pids | ||
_.pid | ||
_.seed | ||
\*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
|
||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
|
||
coverage | ||
\*.lcov | ||
|
||
# nyc test coverage | ||
|
||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
|
||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
|
||
bower_components | ||
|
||
# node-waf configuration | ||
|
||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
|
||
build/Release | ||
|
||
# Dependency directories | ||
|
||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
|
||
web_modules/ | ||
|
||
# TypeScript cache | ||
|
||
\*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
|
||
.npm | ||
|
||
# Optional eslint cache | ||
|
||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
|
||
.stylelintcache | ||
|
||
# Microbundle cache | ||
|
||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
|
||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
|
||
\*.tgz | ||
|
||
# Yarn Integrity file | ||
|
||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
|
||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
|
||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
|
||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
|
||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
|
||
.cache/ | ||
|
||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
|
||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
|
||
# public | ||
|
||
# vuepress build output | ||
|
||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
|
||
.temp | ||
.cache | ||
|
||
# Docusaurus cache and generated files | ||
|
||
.docusaurus | ||
|
||
# Serverless directories | ||
|
||
.serverless/ | ||
|
||
# FuseBox cache | ||
|
||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
|
||
.dynamodb/ | ||
|
||
# TernJS port file | ||
|
||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
|
||
.vscode-test | ||
|
||
# yarn v2 | ||
|
||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.\* | ||
|
||
# IntelliJ based IDEs | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# vanilla | ||
|
||
To install dependencies: | ||
|
||
```bash | ||
bun install | ||
``` | ||
|
||
To run: | ||
|
||
```bash | ||
bun run index.ts | ||
``` | ||
|
||
This project was created using `bun init` in bun v1.0.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. |
Binary file not shown.
Oops, something went wrong.