-
Notifications
You must be signed in to change notification settings - Fork 71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: request network add sdk package #1196
Closed
Closed
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
460bfbc
created package dir
skiv71 67ad0de
working up graph artifacts
skiv71 4ac3616
dependancy problem with payment-detection, had to add types, utils, c…
skiv71 08702f2
working with es6 output / module
skiv71 9274501
removed test folder, package.json testing
skiv71 db9f569
removed lerna debug output
skiv71 48d8343
locked dep versions
skiv71 b6dfeba
fixed bad epk-decryption version
skiv71 c4171cf
fix CI attempt 1.0
skiv71 77db3bd
includes refs
skiv71 7273f65
includes refs 1.1
skiv71 f6c8c17
Alex suggestions
skiv71 f32aff9
fix lint CI issue
skiv71 f79301b
fix lint CI issue 1.1
skiv71 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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,46 @@ | ||
| # @requestnetwork/request-network-sdk | ||
|
|
||
| `@requestnetwork/request-network-sdk` is a ES6 typescript library part of the [Request Network protocol](https://github.com/RequestNetwork/requestNetwork). | ||
| This package lets you to interact with the Request Network through [Request Nodes](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/request-node). This client-side library uses Request Nodes as its backend, connected in HTTP. See the [Request Nodes's API documentation](https://github.com/RequestNetwork/requestNetwork/tree/master/packages/request-node) for more details. | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm i @requestnetwork/request-network-sdk | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```javascript | ||
| import { RequestNetwork } from '@requestnetwork/request-network-sdk'; | ||
| ``` | ||
|
|
||
| Please see [Request Network Documentation](https://docs.request.network/get-started/quickstart-node.js) for detailed information on SDK usage. | ||
|
|
||
| ## Exports | ||
|
|
||
| ```javascript | ||
| import { | ||
| EthereumPrivateKeyDecryptionProvider, | ||
| EthereumPrivateKeySignatureProvider, | ||
| HttpMetaMaskDataAccess, | ||
| PaymentProcessor, | ||
| PaymentReferenceCalculator, | ||
| Request, | ||
| RequestNetwork, | ||
| RequestNetworkBase, | ||
| Types, | ||
| Utils, | ||
| Web3SignatureProvider, | ||
| } from '@requestnetwork/request-network-sdk'; | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. | ||
|
|
||
| [Read the contributing guide](/CONTRIBUTING.md) | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](/LICENSE) |
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,44 @@ | ||
| { | ||
| "name": "@requestnetwork/request-network-sdk", | ||
| "version": "1.0.0", | ||
| "type": "module", | ||
| "publishConfig": { | ||
| "access": "public" | ||
| }, | ||
| "description": "Requet Network SDK Library.", | ||
| "keywords": [ | ||
| "requestnetwork", | ||
| "request-network-sdk" | ||
| ], | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/RequestNetwork/requestNetwork.git" | ||
| }, | ||
| "homepage": "https://github.com/RequestNetwork/requestNetwork/tree/master/packages/request-network-sdk#readme", | ||
| "bugs": { | ||
| "url": "https://github.com/RequestNetwork/requestNetwork/issues" | ||
| }, | ||
| "license": "MIT", | ||
| "main": "dist/index.js", | ||
| "types": "dist/index.d.ts", | ||
| "engines": { | ||
| "node": ">=16.0.0" | ||
| }, | ||
| "directories": { | ||
| "lib": "src" | ||
| }, | ||
| "files": [ | ||
| "dist" | ||
| ], | ||
| "scripts": { | ||
| "build": "tsc -b tsconfig.build.json", | ||
| "clean": "rm -rf dist tsconfig.build.ts*" | ||
| }, | ||
| "dependencies": { | ||
| "@requestnetwork/epk-decryption": "0.3.35", | ||
| "@requestnetwork/epk-signature": "0.5.36", | ||
| "@requestnetwork/payment-processor": "0.39.0", | ||
| "@requestnetwork/request-client.js": "0.41.0", | ||
| "@requestnetwork/web3-signature": "0.4.37" | ||
| } | ||
| } | ||
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,31 @@ | ||
| import { | ||
| HttpMetaMaskDataAccess, | ||
| PaymentReferenceCalculator, | ||
| Request, | ||
| RequestNetwork, | ||
| RequestNetworkBase, | ||
| Types, | ||
| Utils, | ||
| } from '@requestnetwork/request-client.js'; | ||
|
|
||
| import { Web3SignatureProvider } from '@requestnetwork/web3-signature'; | ||
|
|
||
| import { EthereumPrivateKeySignatureProvider } from '@requestnetwork/epk-signature'; | ||
|
|
||
| import { EthereumPrivateKeyDecryptionProvider } from '@requestnetwork/epk-decryption'; | ||
|
|
||
| import * as PaymentProcessor from '@requestnetwork/payment-processor'; | ||
|
|
||
| export { | ||
| EthereumPrivateKeyDecryptionProvider, | ||
| EthereumPrivateKeySignatureProvider, | ||
| HttpMetaMaskDataAccess, | ||
| PaymentProcessor, | ||
| PaymentReferenceCalculator, | ||
| Request, | ||
| RequestNetwork, | ||
| RequestNetworkBase, | ||
| Types, | ||
| Utils, | ||
| Web3SignatureProvider, | ||
| }; |
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 @@ | ||
| { | ||
| "extends": "./tsconfig", | ||
| "compilerOptions": { | ||
| "outDir": "dist", | ||
| "rootDir": "src", | ||
| "module": "ES6" | ||
| }, | ||
| "references": [ | ||
| { "path": "../epk-decryption/tsconfig.build.json" }, | ||
| { "path": "../epk-signature/tsconfig.build.json" }, | ||
| { "path": "../payment-processor/tsconfig.build.json" }, | ||
| { "path": "../request-client.js/tsconfig.build.json" }, | ||
| { "path": "../web3-signature/tsconfig.build.json" } | ||
| ] | ||
| } |
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,4 @@ | ||
| { | ||
| "extends": "../../tsconfig", | ||
| "include": ["src/"] | ||
| } |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the references in here should match the version in the
package.jsonof these packages. Right now, you are resolving the version on NPM, not the monorepo's versionThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @benjlevesque thanks for this info, it really helped. Turned out it was because I used the @next modifier (as this has been promoted since I started).
Changed to the correct version(s) and all it well.
The latest commit also includes tsconfig changes to produce es6 output.