initialize

.eslintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+   parser: '@typescript-eslint/parser',
+   parserOptions: {
+      project: 'tsconfig.json',
+      tsconfigRootDir: __dirname,
+      sourceType: 'module',
+   },
+   plugins: ['@typescript-eslint/eslint-plugin'],
+   extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+   root: true,
+   env: {
+      node: true,
+      jest: true,
+   },
+   ignorePatterns: ['.eslintrc.js'],
+   rules: {
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+   },
+};

.gitignore

@@ -0,0 +1,37 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+.env

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc

@@ -0,0 +1,7 @@
+{
+   "trailingComma": "es5",
+   "tabWidth": 3,
+   "semi": true,
+   "singleQuote": true,
+   "printWidth": 120
+}

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fibrous Finance
+
+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.

docs/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing
+
+Thank you for considering contributing to Fibrous SDK!
+We appreciate your time and effort.
+Please take a moment to review the guidelines below.
+
+## Issue Tracker
+
+If you find any bugs or have a feature request, please open an issue on the [issue tracker](https://github.com/Fibrous-Finance/limit-order-sdk/issues). We welcome bug reports, feature suggestions, and pull requests.
+
+## Pull Requests
+
+1. Fork the repository and create your branch from `main`.
+2. Make sure your code follows our code style and conventions.
+3. Ensure that your commits are concise, well-documented, and address a specific issue.
+4. Commit messages should follow the format:
+
+```
+fix: Brief description of the fix
+feat: Brief description of the feature
+chore: Non-breaking change
+```
+
+For example:
+
+```
+fix: Correct the typo in the README file
+feat: Implement a new authentication module
+chore: Update dependencies to the latest version
+```
+
+5. If your pull request addresses an issue, reference it using the syntax `Fixes #issue_number` in the commit message.
+6. Push your changes to your forked repository.
+7. Submit a pull request to the `main` branch of the original repository.
+8. Provide a clear and descriptive title for your pull request and explain the motivation behind the changes.
+9. Be responsive to any feedback or questions that may arise during the review process.
+
+## Code Style and Conventions
+
+Please adhere to the following guidelines when submitting code:
+
+-  Use 4 spaces for indentation.
+-  Follow the naming conventions for variables, functions, and classes.
+-  Write clear and concise comments to explain the code's intent.
+-  Keep code lines within a reasonable length (usually less than 80 characters).
+-  Avoid unnecessary dependencies and ensure all external packages are properly licensed.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the [project's license](../LICENSE).
+
+## Conclusion
+
+We greatly appreciate your contribution! Your efforts will help make this project even better. If you have any questions or need further assistance, please don't hesitate to reach out.

examples/.gitignore

@@ -0,0 +1,37 @@
+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+.env

examples/package.json

@@ -0,0 +1,15 @@
+{
+   "name": "examples",
+   "version": "1.0.0",
+   "description": "",
+   "main": "index.js",
+   "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+   },
+   "author": "",
+   "license": "ISC",
+   "dependencies": {
+      "@fibrous/limit-order-sdk": "^0.1.3",
+      "ethers": "^6.10.0"
+   }
+}