feat: initial commit

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4
+
+[*.tree]
+indent_size = 1

.env.example

@@ -0,0 +1,2 @@
+export API_KEY_ALCHEMY="YOUR_API_KEY_ALCHEMY"
+export FOUNDRY_PROFILE="default"

.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: "CI"
+
+env:
+ API_KEY_ALCHEMY: ${{ secrets.API_KEY_ALCHEMY }}
+ FOUNDRY_PROFILE: "ci"
+
+on:
+ workflow_dispatch:
+ pull_request:
+ push:
+ branches:
+ - "main"
+
+jobs:
+ lint:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Check out the repo"
+ uses: "actions/checkout@v3"
+ with:
+ submodules: "recursive"
+
+ - name: "Install Foundry"
+ uses: "foundry-rs/foundry-toolchain@v1"
+
+ - name: "Install Pnpm"
+ uses: "pnpm/action-setup@v2"
+ with:
+ version: "latest"
+
+ - name: "Install Node.js"
+ uses: "actions/setup-node@v3"
+ with:
+ cache: "pnpm"
+ node-version: "lts/*"
+
+ - name: "Install the Node.js dependencies"
+ run: "pnpm install"
+
+ - name: "Lint the contracts"
+ run: "pnpm lint"
+
+ - name: "Add lint summary"
+ run: |
+ echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+ echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+ build:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Check out the repo"
+ uses: "actions/checkout@v3"
+ with:
+ submodules: "recursive"
+
+ - name: "Install Foundry"
+ uses: "foundry-rs/foundry-toolchain@v1"
+
+ - name: "Build the contracts and print their size"
+ run: "forge build --sizes"
+
+ - name: "Add build summary"
+ run: |
+ echo "## Build result" >> $GITHUB_STEP_SUMMARY
+ echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+ test:
+ needs: ["lint", "build"]
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Check out the repo"
+ uses: "actions/checkout@v3"
+ with:
+ submodules: "recursive"
+
+ - name: "Install Foundry"
+ uses: "foundry-rs/foundry-toolchain@v1"
+
+ - name: "Show the Foundry config"
+ run: "forge config"
+
+ - name: "Run the tests"
+ run: "forge test"
+
+ - name: "Add test summary"
+ run: |
+ echo "## Tests result" >> $GITHUB_STEP_SUMMARY
+ echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -0,0 +1,17 @@
+# directories
+cache
+node_modules
+out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+yarn.lock
+
+# broadcasts
+!broadcast
+broadcast/*
+broadcast/*/31337/

.gitmodules

@@ -0,0 +1,8 @@
+[submodule "lib/forge-std"]
+ branch = "v1"
+ path = "lib/forge-std"
+ url = "https://github.com/foundry-rs/forge-std"
+[submodule "lib/v2-core"]
+ branch = "release-v1.0"
+ path = "lib/v2-core"
+ url = "https://github.com/sablier-labs/v2-core"

.prettierignore

@@ -0,0 +1,16 @@
+# directories
+broadcast
+cache
+lib
+node_modules
+out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

.prettierrc.yml

@@ -0,0 +1,7 @@
+bracketSpacing: true
+printWidth: 120
+proseWrap: "always"
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+useTabs: false

.solhint.json

@@ -0,0 +1,13 @@
+{
+ "extends": "solhint:recommended",
+ "rules": {
+ "code-complexity": ["error", 8],
+ "compiler-version": ["error", ">=0.8.13"],
+ "func-name-mixedcase": "off",
+ "func-visibility": ["error", { "ignoreConstructors": true }],
+ "max-line-length": ["error", 120],
+ "named-parameters-mapping": "warn",
+ "no-console": "off",
+ "not-rely-on-time": "off"
+ }
+}

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+ "[solidity]": {
+ "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
+ },
+ "[toml]": {
+ "editor.defaultFormatter": "tamasfe.even-better-toml"
+ },
+ "solidity.formatter": "forge"
+}

README.md

@@ -0,0 +1,10 @@
+# Sablier Integration Template
+
+This repository contains a template for building integrations with Sablier. For more information, refer to this guide on
+our documentation website:
+
+https://docs.sablier.com/contracts/v2/guides/local-environment
+
+## License
+
+This repo is licensed under GPL 3.0 or later.

foundry.toml

@@ -0,0 +1,29 @@
+# Full reference https://github.com/foundry-rs/foundry/tree/master/config
+
+[profile.default]
+ auto_detect_solc = false
+ bytecode_hash = "none"
+ cbor_metadata = false
+ emv_version = "paris"
+ fuzz = { runs = 1_000 }
+ libs = ["lib"]
+ optimizer = true
+ optimizer_runs = 10_000
+ out = "out"
+ solc = "0.8.19"
+ src = "src"
+ test = "test"
+
+[fmt]
+ bracket_spacing = true
+ int_types = "long"
+ line_length = 120
+ multiline_func_header = "all"
+ number_underscore = "thousands"
+ quote_style = "double"
+ tab_width = 4
+ wrap_comments = true
+
+[rpc_endpoints]
+ localhost = "http://localhost:8545"
+ mainnet = "https://eth-mainnet.g.alchemy.com/v2/${API_KEY_ALCHEMY}"

package.json

@@ -0,0 +1,43 @@
+{
+ "name": "sablier-integration-template",
+ "description": "Template for making on-chain integrations with Sablier V2",
+ "version": "1.0.0",
+ "author": {
+ "name": "Sablier Labs Ltd",
+ "url": "https://sablier.com"
+ },
+ "bugs": {
+ "url": "https://github.com/sablier-labs/sablier-integration-template/issues"
+ },
+ "devDependencies": {
+ "prettier": "^3.0.0",
+ "rimraf": "^5.0.1",
+ "solhint": "^3.4.1"
+ },
+ "homepage": "https://github.com/sablier-labs/sablier-integration-example#readme",
+ "keywords": [
+ "asset-streaming",
+ "blockchain",
+ "cryptoasset-streaming",
+ "cryptoassets",
+ "ethereum",
+ "foundry",
+ "money-streaming",
+ "real-time-finance",
+ "sablier",
+ "sablier-v2",
+ "smart-contracts",
+ "solidity",
+ "token-streaming"
+ ],
+ "license": "GPL-3.0-or-later",
+ "private": true,
+ "repository": "github.com:sablier-labs/sablier-integration-template",
+ "scripts": {
+ "clean": "rimraf cache out",
+ "lint": "pnpm lint:sol && pnpm prettier:check",
+ "lint:sol": "forge fmt --check && pnpm solhint \"{script,src,test}/**/*.sol\"",
+ "prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
+ "prettier:write": "prettier --write \"**/*.{json,md,yml}\""
+ }
+}