Skip to content

Commit

Permalink
feat: rewrite in TypeScript
Browse files Browse the repository at this point in the history
  • Loading branch information
owenvoke committed May 29, 2024
1 parent 1fc7073 commit ece0a8e
Show file tree
Hide file tree
Showing 63 changed files with 9,822 additions and 965 deletions.
74 changes: 0 additions & 74 deletions .github/CODE_OF_CONDUCT.md

This file was deleted.

6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/pxgamer/arionum-js).
We accept contributions via Pull Requests on [GitHub](https://github.com/owenvoke/arionum-js).

## Pull Requests

- **[StandardJS Coding Standard](https://standardjs.com)** - Check the code style with ``$ npm check-style`` and fix it with ``$ npm fix-style``.
- **Prettier Coding Standard** - This is automatically linted by Prettier.

- **Add tests!** - If possible, try to add tests to support your patch.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.
- **Create feature branches** - Don't ask us to pull from your main branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
4 changes: 4 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# These are supported funding model platforms

github: owenvoke
custom: "https://ecologi.com/owenvoke?gift-trees"
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug Report
description: If something isn't working as expected.
labels: [ 'type: bug' ]

body:

- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: description
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
validations:
required: true

- type: input
id: library-version
attributes:
label: Library version
description: What version of the library are you using? Please be as specific as possible.
validations:
required: true

- type: input
id: php-version
attributes:
label: Node version
description: What version of PHP are you using? Please be as specific as possible.
placeholder: 21.x
validations:
required: true

- type: dropdown
id: operating-system
attributes:
label: What operating systems are you seeing the problem on?
multiple: true
options:
- macOS
- Linux
- Windows
validations:
required: true

- type: textarea
id: notes
attributes:
label: Notes
description: Use this field to provide any other notes that you feel might be relevant to the issue.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Feature Request
description: If you have a suggestion (and may want to implement it).
labels: [ 'type: discussion' ]

body:

- type: textarea
id: description
attributes:
label: Description
description: Explain the change or addition that you are proposing.
validations:
required: true

- type: textarea
id: implementation
attributes:
label: Possible implementation
description: Not obligatory, but suggest an idea for implementing addition or change.
validations:
required: true
20 changes: 1 addition & 19 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

...

## Types of changes

Put an `x` in all the boxes that apply:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist

Put an `x` in all the boxes that apply:

- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
- [ ] My pull request addresses exactly one patch/feature.
- [ ] I have created a branch for this patch/feature.

If you're unsure about any of these, don't hesitate to ask. We're here to help!
Please check the **[CONTRIBUTING](https://github.com/owenvoke/.github/blob/main/CONTRIBUTING.md)** document for more information.
58 changes: 25 additions & 33 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,29 @@
name: Tests

on: ['push', 'pull_request']
on: ["push", "pull_request"]

jobs:
ci:
runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest]
node: ['15.x']

name: Node ${{ matrix.node }} - ${{ matrix.os }}

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Cache dependencies
uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}

- name: Install npm dependencies
run: npm i

- name: Run tests
run: npm test
ci:
runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest]

name: Node - ${{ matrix.os }}

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version-file: ".nvmrc"
cache: "npm"

- name: Install npm dependencies
run: npm ci

- name: Run tests
run: npm test
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build
package-lock.json
dist
yarn.lock
node_modules
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
dist
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
57 changes: 2 additions & 55 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com), and this

## Unreleased

## [v1.3.4] - 2021-05-03

### Fixed
- Fix npm `test` script ([15b18c4](https://github.com/owenvoke/arionum-js/commit/15b18c48a66f53356591ae1456ad70dd95b1b25b))

### Changed
- Update dependencies and details ([8f35ae9](https://github.com/owenvoke/arionum-js/commit/8f35ae9af5d01c904ddb2e8419375ca222ff4f78))

## [v1.3.3] - 2019-06-03

### Fixed
- Fix vulnerability in axios using Snyk ([d1edbc8](https://github.com/owenvoke/arionum-js/commit/d1edbc86c379101bf1228bd215c8b7233226d70c))

## [v1.3.2] - 2019-05-07

### Fixed
- Fix vulnerability in axios using Snyk ([#3](https://github.com/owenvoke/arionum-js/pull/3))

## [v1.3.1] - 2019-02-28

### Changed
- Move documentation from the README to a `docs` directory ([0fb6a9d](https://github.com/owenvoke/arionum-js/commit/0fb6a9d57c0922499cf7b2055f4650d455b4ad6e))

### Removed
- Remove deprecated Travis containerisation ([141322e](https://github.com/owenvoke/arionum-js/commit/141322e0b8e8dc6ccc6e251347f8681fd5a409ea))

## [v1.3.0] - 2018-11-05
## 2.0.0

### Added
- Add the `checkSignature` method ([167c8468](https://github.com/owenvoke/arionum-js/commit/167c8468114de8d9dc67ee2d6fd8a14320e83118))
- Add the `checkAddress` method ([610ffbf0](https://github.com/owenvoke/arionum-js/commit/610ffbf01c8017c6dda6df35c0ff532cc036be15))
- Add the `getTransactionsByPublicKey` method ([162bd370](https://github.com/owenvoke/arionum-js/commit/162bd370054bf9702cc7418b16dc2d49468ffd48))
- Add the `getBalanceByAlias` and `getBalanceByPublicKey` methods ([1afd3958](https://github.com/owenvoke/arionum-js/commit/1afd3958ee2ee9a939acac1fbcd807fd50232e0f))

## [v1.2.0] - 2018-10-15

### Added
- Add the `getSanityDetails` method ([5bbfb09](https://github.com/owenvoke/arionum-js/commit/5bbfb09da94028cf10e12e6002812e5138a7905d))
- Add the `getNodeInfo` method ([f212124](https://github.com/owenvoke/arionum-js/commit/f212124fec5b04906b394cec697b59125f9113d2))
- Add Travis configuration ([6dbb2d3](https://github.com/owenvoke/arionum-js/commit/6dbb2d35d8c4a3ebb27af5bd412c9b8b0a28aaa3))

## [v1.1.0] - 2018-09-27

### Added
- Add the `sendTransaction` method and `Transaction` class ([#1](https://github.com/owenvoke/arionum-js/issues/1))

## v1.0.0 - 2018-09-27

### Added
- Initial release

[v1.3.3]: https://github.com/owenvoke/arionum-js/compare/v1.3.2...v1.3.3
[v1.3.2]: https://github.com/owenvoke/arionum-js/compare/v1.3.1...v1.3.2
[v1.3.1]: https://github.com/owenvoke/arionum-js/compare/v1.3.0...v1.3.1
[v1.3.0]: https://github.com/owenvoke/arionum-js/compare/v1.2.0...v1.3.0
[v1.2.0]: https://github.com/owenvoke/arionum-js/compare/v1.1.0...v1.2.0
[v1.1.0]: https://github.com/owenvoke/arionum-js/compare/v1.0.0...v1.1.0
- Rewrite using TypeScript
30 changes: 15 additions & 15 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

Copyright (c) 2018 Owen Voke <development@voke.dev>

>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:
> 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 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.
> 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.
Loading

0 comments on commit ece0a8e

Please sign in to comment.