FinVis/usxi
7
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Resolve "Alpaca API Implementation" #28

Merged
clbertolini merged 9 commits from 12-alpaca-api-implementation into main 2023-10-24 20:54:40 +00:00
Conversation 11 Commits 9 Files Changed 14 +156 -170
6 changed files with 156 additions and 170 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 51a58fc322 - Show all commits

271
.eslintrc.js
View File

@ -1,136 +1,137 @@
module.exports = { module.exports = {
parser: "@typescript-eslint/parser", parser: "@typescript-eslint/parser",
parserOptions: { parserOptions: {
ecmaVersion: "latest", // Allows the use of modern ECMAScript features ecmaVersion: "latest", // Allows the use of modern ECMAScript features
sourceType: "module", // Allows for the use of imports sourceType: "module", // Allows for the use of imports
project: ["./tsconfig.json", "./tsconfig.test.json"] project: ["./tsconfig.json", "./tsconfig.test.json"]
}, },
extends: ["plugin:@typescript-eslint/recommended"], // Uses the linting rules from @typescript-eslint/eslint-plugin extends: ["plugin:@typescript-eslint/recommended"], // Uses the linting rules from @typescript-eslint/eslint-plugin
env: { env: {
node: true, // Enable Node.js global variables node: true, // Enable Node.js global variables
}, },
rules: { rules: {
"array-callback-return": "error", "array-callback-return": "error",
"no-await-in-loop": "error", "no-await-in-loop": "error",
"no-cond-assign": [ "error", "always" ], "no-cond-assign": ["error", "always"],
"no-constant-binary-expression": "error", "no-constant-binary-expression": "error",
"no-constant-condition": "error", "no-constant-condition": "error",
"no-constructor-return": "error", "no-constructor-return": "error",
"no-duplicate-imports": "error", "no-duplicate-imports": "error",
"no-promise-executor-return": "error", "no-promise-executor-return": "error",
"no-self-compare": "error", "no-self-compare": "error",
"no-undef": [ "error", { "typeof": true } ], "no-undef": ["error", { "typeof": true }],
"no-unmodified-loop-condition": "error", "no-unmodified-loop-condition": "error",
"no-unreachable-loop": "error", "no-unreachable-loop": "error",
"no-unused-private-class-members": "error", "no-unused-private-class-members": "error",
"require-atomic-updates": "error", "require-atomic-updates": "error",
"accessor-pairs": "error", "accessor-pairs": "error",
"block-scoped-var": "error", "block-scoped-var": "error",
"curly": [ "error", "all" ], "curly": ["error", "all"],
"default-case": "error", "default-case": "error",
"default-case-last": "error", "default-case-last": "error",
"default-param-last": "error", "default-param-last": "error",
"dot-notation": "error", "dot-notation": "error",
"eqeqeq": "error", "eqeqeq": "error",
"func-style": [ "error", "expression" ], "func-style": ["error", "expression"],
"grouped-accessor-pairs": [ "error", "getBeforeSet" ], "grouped-accessor-pairs": ["error", "getBeforeSet"],
"no-caller": "error", "no-caller": "error",
"no-console": "error", "no-console": "error",
"no-eq-null": "error", "no-eq-null": "error",
"no-eval": "error", "no-eval": "error",
"no-extend-native": "error", "no-extend-native": "error",
"no-extra-label": "error", "no-extra-label": "error",
"no-implicit-coercion": "error", "no-implicit-coercion": "error",
"no-implicit-globals": "error", "no-implicit-globals": "error",
"no-implied-eval": "error", "no-implied-eval": "error",
"no-inline-comments": "error", "no-inline-comments": "error",
"no-invalid-this": "error", "no-invalid-this": "error",
"no-iterator": "error", "no-iterator": "error",
"no-label-var": "error", "no-label-var": "error",
"no-labels": "error", "no-labels": "error",
"no-lone-blocks": "error", "no-lone-blocks": "error",
"no-lonely-if": "error", "no-lonely-if": "error",
"no-loop-func": "error", "no-loop-func": "error",
"no-magic-numbers": "error", "no-magic-numbers": "error",
"no-mixed-operators": "error", "no-mixed-operators": "error",
"no-multi-assign": "error", "no-multi-assign": "error",
"no-multi-str": "error", "no-multi-str": "error",
"no-nested-ternary": "error", "no-nested-ternary": "error",
"no-new": "error", "no-new": "error",
"no-new-func": "error", "no-new-func": "error",
"no-new-wrappers": "error", "no-new-wrappers": "error",
"no-nonoctal-decimal-escape": "error", "no-nonoctal-decimal-escape": "error",
"no-object-constructor": "error", "no-object-constructor": "error",
"no-octal-escape": "error", "no-octal-escape": "error",
"no-param-reassign": "error", "no-param-reassign": "error",
"no-plusplus": "error", "no-plusplus": "error",
"no-proto": "error", "no-proto": "error",
"no-return-assign": "error", "no-return-assign": "error",
"no-script-url": "error", "no-script-url": "error",
"no-sequences": "error", "no-sequences": "error",
"no-shadow": "error", "no-shadow": "error",
"no-throw-literal": "error", "no-throw-literal": "error",
"no-undef-init": "error", "no-undef-init": "error",
"no-undefined": "error", "no-undefined": "error",
"no-underscore-dangle": "error", "no-underscore-dangle": "error",
"no-unneeded-ternary": "error", "no-unneeded-ternary": "error",
"no-unused-expressions": "error", "no-unused-expressions": "error",
"no-useless-call": "error", "no-useless-call": "error",
"no-useless-catch": "error", "no-useless-catch": "error",
"no-useless-computed-key": "error", "no-useless-computed-key": "error",
"no-useless-concat": "error", "no-useless-concat": "error",
"no-useless-constructor": "error", "no-useless-constructor": "error",
"no-useless-rename": "error", "no-useless-rename": "error",
"no-var": "error", "no-var": "error",
"no-void": "error", "no-void": "error",
"one-var": [ "error", "never" ], "one-var": ["error", "never"],
"one-var-declaration-per-line": [ "error", "always" ], "one-var-declaration-per-line": ["error", "always"],
"prefer-arrow-callback": "error", "prefer-arrow-callback": "error",
"prefer-const": "error", "prefer-const": "error",
"prefer-exponentiation-operator": "error", "prefer-exponentiation-operator": "error",
"prefer-named-capture-group": "error", "prefer-named-capture-group": "error",
"prefer-numeric-literals": "error", "prefer-numeric-literals": "error",
"prefer-object-has-own": "error", "prefer-object-has-own": "error",
"prefer-object-spread": "error", "prefer-object-spread": "error",
"prefer-promise-reject-errors": "error", "prefer-promise-reject-errors": "error",
"prefer-regex-literals": "error", "prefer-regex-literals": "error",
"prefer-rest-params": "error", "prefer-rest-params": "error",
"prefer-spread": "error", "prefer-spread": "error",
"prefer-template": "error", "prefer-template": "error",
"quote-props": [ "error", "as-needed" ], "quote-props": ["error", "as-needed"],
"radix": "error", "semi": ["error", "always"],
"require-await": "error", "radix": "error",
"require-unicode-regexp": "error", "require-await": "error",
"symbol-description": "error", "require-unicode-regexp": "error",
"yoda": "error", "symbol-description": "error",
"yoda": "error",
"array-bracket-newline": [ "error", "consistent" ],
"array-bracket-spacing": [ "error", "always", { "singleValue": false } ], "array-bracket-newline": ["error", "consistent"],
"array-element-newline": [ "error", "consistent" ], "array-bracket-spacing": ["error", "always", { "singleValue": false }],
"arrow-parens": "error", "array-element-newline": ["error", "consistent"],
"arrow-spacing": "error", "arrow-parens": "error",
"block-spacing": "error", "arrow-spacing": "error",
"computed-property-spacing": "error", "block-spacing": "error",
"eol-last": "error", "computed-property-spacing": "error",
"generator-star-spacing": [ "error", { "before": false, "after": true } ], "eol-last": "error",
"key-spacing": "error", "generator-star-spacing": ["error", { "before": false, "after": true }],
"linebreak-style": "error", "key-spacing": "error",
"lines-around-comment": [ "error", { "allowBlockStart": true }], "linebreak-style": "error",
"max-len": [ "error", { "code": 120 } ], "lines-around-comment": ["error", { "allowBlockStart": true }],
"new-parens": "error", "max-len": ["error", { "code": 120 }],
"no-multi-spaces": "error", "new-parens": "error",
"no-multiple-empty-lines": "error", "no-multi-spaces": "error",
"no-trailing-spaces": "error", "no-multiple-empty-lines": "error",
"no-whitespace-before-property": "error", "no-trailing-spaces": "error",
"nonblock-statement-body-position": [ "error", "below" ], "no-whitespace-before-property": "error",
"object-curly-newline": [ "error", { "ObjectExpression": { "consistent": true }, "ObjectPattern": { "consistent": true } } ], "nonblock-statement-body-position": ["error", "below"],
"operator-linebreak": "error", "object-curly-newline": ["error", { "ObjectExpression": { "consistent": true }, "ObjectPattern": { "consistent": true } }],
"padded-blocks": [ "error", "never" ], "operator-linebreak": "error",
"space-in-parens": "error", "padded-blocks": ["error", "never"],
"switch-colon-spacing": [ "error", { "after": false, "before": false } ], "space-in-parens": "error",
"template-curly-spacing": "error", "switch-colon-spacing": ["error", { "after": false, "before": false }],
"wrap-iife": "error", "template-curly-spacing": "error",
"yield-star-spacing": [ "error", "after" ], "wrap-iife": "error",
} "yield-star-spacing": ["error", "after"],
}; }
};

12
src/alpaca/exchange.ts
View File

@ -1,9 +1,9 @@
import Alpaca from '@alpacahq/alpaca-trade-api' import Alpaca from '@alpacahq/alpaca-trade-api';
import { AlpacaPortfolioProvider } from './portfolio' import { AlpacaPortfolioProvider } from './portfolio';
import { AlpacaQuoteProvider } from './quote' import { AlpacaQuoteProvider } from './quote';
import { Exchange } from '../interface/exchange' import { Exchange } from '../interface/exchange';
import { PortfolioProvider } from '../interface/portfolio' import { PortfolioProvider } from '../interface/portfolio';
import { QuoteProvider } from '../interface/quote' import { QuoteProvider } from '../interface/quote';
/** /**
* Exchange implementation for Alpaca. * Exchange implementation for Alpaca.

4
src/alpaca/portfolio.ts
View File

@ -1,4 +1,4 @@
import Alpaca from '@alpacahq/alpaca-trade-api' import Alpaca from '@alpacahq/alpaca-trade-api';
import { PortfolioProvider, Portfolio, Position } from '../interface/portfolio'; import { PortfolioProvider, Portfolio, Position } from '../interface/portfolio';
/** /**
@ -50,7 +50,7 @@ export class AlpacaPortfolioProvider implements PortfolioProvider {
); );
})); }));
}); });
} };
/** /**
* Creates a new AlpacaPortfolioProvider instance. * Creates a new AlpacaPortfolioProvider instance.

6
src/alpaca/quote.ts
View File

@ -1,4 +1,4 @@
import Alpaca from '@alpacahq/alpaca-trade-api' import Alpaca from '@alpacahq/alpaca-trade-api';
import { QuoteProvider, Quote } from '../interface/quote'; import { QuoteProvider, Quote } from '../interface/quote';
/** /**
@ -27,8 +27,8 @@ export class AlpacaQuoteProvider implements QuoteProvider {
); );
}).catch((err) => { }).catch((err) => {
return err; return err;
}) });
} };
/** /**
* Creates a new AlpacaQuoteProvider instance. * Creates a new AlpacaQuoteProvider instance.

2
src/index.ts
View File

@ -9,4 +9,4 @@ export {
PortfolioProvider, PortfolioProvider,
Quote, Quote,
QuoteProvider QuoteProvider
} };

31
test/alpaca.test.ts
View File

@ -1,34 +1,19 @@
import { describe, expect, test } from '@jest/globals'; import { describe, expect, test } from '@jest/globals';
import 'dotenv/config' import 'dotenv/config';
import { AlpacaExchange } from '../src/alpaca/exchange' import { AlpacaExchange } from '../src/alpaca/exchange';
import { createLogger, transports, format } from "winston";
const logger = createLogger({
transports: [new transports.Console()],
format: format.combine(
format.colorize(),
format.timestamp(),
format.printf(({ timestamp, level, message, service }) => {
return `[${timestamp}] ${service} ${level}: ${message}`;
})
),
defaultMeta: {
service: "AlpacaTest",
},
});
describe('Alpaca Tests', () => { describe('Alpaca Tests', () => {
test('portfolio fetch', () => { test('portfolio fetch', () => {
expect(process.env.ALPACA_API_KEY).toBeDefined(); expect(process.env.ALPACA_API_KEY).toBeDefined();
expect(process.env.ALPACA_SECRET_KEY).toBeDefined(); expect(process.env.ALPACA_SECRET_KEY).toBeDefined();
let exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true); const exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true);
expect(exchange.portfolioProvider.fetchPortfolio()).resolves; expect(exchange.portfolioProvider.fetchPortfolio()).resolves.toBeDefined();
}); });
test('quote fetch', async () => { test('quote fetch', () => {
expect(process.env.ALPACA_API_KEY).toBeDefined(); expect(process.env.ALPACA_API_KEY).toBeDefined();
expect(process.env.ALPACA_SECRET_KEY).toBeDefined(); expect(process.env.ALPACA_SECRET_KEY).toBeDefined();
let exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true); const exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true);
expect(exchange.quoteProvider.fetchQuote("AAPL")).resolves; expect(exchange.quoteProvider.fetchQuote("AAPL")).resolves.toBeDefined();
}); });
}); });