@relayprotocol/relay-sdk 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/_cjs/package.json +1 -0
- package/_cjs/src/actions/claimAppFees.js +53 -0
- package/_cjs/src/actions/claimAppFees.js.map +1 -0
- package/_cjs/src/actions/execute.js +76 -0
- package/_cjs/src/actions/execute.js.map +1 -0
- package/_cjs/src/actions/getAppFees.js +24 -0
- package/_cjs/src/actions/getAppFees.js.map +1 -0
- package/_cjs/src/actions/getPrice.js +51 -0
- package/_cjs/src/actions/getPrice.js.map +1 -0
- package/_cjs/src/actions/getQuote.js +91 -0
- package/_cjs/src/actions/getQuote.js.map +1 -0
- package/_cjs/src/actions/getSolverCapacity.js +21 -0
- package/_cjs/src/actions/getSolverCapacity.js.map +1 -0
- package/_cjs/src/actions/index.js +10 -0
- package/_cjs/src/actions/index.js.map +1 -0
- package/_cjs/src/client.js +207 -0
- package/_cjs/src/client.js.map +1 -0
- package/_cjs/src/constants/address.js +48 -0
- package/_cjs/src/constants/address.js.map +1 -0
- package/_cjs/src/constants/bvm.js +5 -0
- package/_cjs/src/constants/bvm.js.map +1 -0
- package/_cjs/src/constants/index.js +6 -0
- package/_cjs/src/constants/index.js.map +1 -0
- package/_cjs/src/constants/servers.js +9 -0
- package/_cjs/src/constants/servers.js.map +1 -0
- package/_cjs/src/errors/DepositTransactionTimeoutError.js +18 -0
- package/_cjs/src/errors/DepositTransactionTimeoutError.js.map +1 -0
- package/_cjs/src/errors/SolverStatusTimeoutError.js +18 -0
- package/_cjs/src/errors/SolverStatusTimeoutError.js.map +1 -0
- package/_cjs/src/errors/TransactionConfirmationError.js +25 -0
- package/_cjs/src/errors/TransactionConfirmationError.js.map +1 -0
- package/_cjs/src/errors/index.js +10 -0
- package/_cjs/src/errors/index.js.map +1 -0
- package/_cjs/src/index.js +10 -0
- package/_cjs/src/index.js.map +1 -0
- package/_cjs/src/routes/index.js +46 -0
- package/_cjs/src/routes/index.js.map +1 -0
- package/_cjs/src/types/AdaptedWallet.js +3 -0
- package/_cjs/src/types/AdaptedWallet.js.map +1 -0
- package/_cjs/src/types/Execute.js +3 -0
- package/_cjs/src/types/Execute.js.map +1 -0
- package/_cjs/src/types/Progress.js +3 -0
- package/_cjs/src/types/Progress.js.map +1 -0
- package/_cjs/src/types/RelayChain.js +3 -0
- package/_cjs/src/types/RelayChain.js.map +1 -0
- package/_cjs/src/types/SignatureStepItem.js +3 -0
- package/_cjs/src/types/SignatureStepItem.js.map +1 -0
- package/_cjs/src/types/TransactionStepItem.js +3 -0
- package/_cjs/src/types/TransactionStepItem.js.map +1 -0
- package/_cjs/src/types/api.js +3 -0
- package/_cjs/src/types/api.js.map +1 -0
- package/_cjs/src/types/index.js +11 -0
- package/_cjs/src/types/index.js.map +1 -0
- package/_cjs/src/utils/axios.js +18 -0
- package/_cjs/src/utils/axios.js.map +1 -0
- package/_cjs/src/utils/chain.js +91 -0
- package/_cjs/src/utils/chain.js.map +1 -0
- package/_cjs/src/utils/executeSteps/index.js +298 -0
- package/_cjs/src/utils/executeSteps/index.js.map +1 -0
- package/_cjs/src/utils/executeSteps/signatureStep.js +186 -0
- package/_cjs/src/utils/executeSteps/signatureStep.js.map +1 -0
- package/_cjs/src/utils/executeSteps/transactionStep.js +74 -0
- package/_cjs/src/utils/executeSteps/transactionStep.js.map +1 -0
- package/_cjs/src/utils/executeSteps/websocketHandlers.js +112 -0
- package/_cjs/src/utils/executeSteps/websocketHandlers.js.map +1 -0
- package/_cjs/src/utils/fetchChainConfigs.js +20 -0
- package/_cjs/src/utils/fetchChainConfigs.js.map +1 -0
- package/_cjs/src/utils/getCurrentStepData.js +28 -0
- package/_cjs/src/utils/getCurrentStepData.js.map +1 -0
- package/_cjs/src/utils/getTenderlyDetails.js +24 -0
- package/_cjs/src/utils/getTenderlyDetails.js.map +1 -0
- package/_cjs/src/utils/hyperliquid.js +95 -0
- package/_cjs/src/utils/hyperliquid.js.map +1 -0
- package/_cjs/src/utils/index.js +39 -0
- package/_cjs/src/utils/index.js.map +1 -0
- package/_cjs/src/utils/logger.js +38 -0
- package/_cjs/src/utils/logger.js.map +1 -0
- package/_cjs/src/utils/params.js +21 -0
- package/_cjs/src/utils/params.js.map +1 -0
- package/_cjs/src/utils/pollApi.js +40 -0
- package/_cjs/src/utils/pollApi.js.map +1 -0
- package/_cjs/src/utils/prepareBatchTransaction.js +35 -0
- package/_cjs/src/utils/prepareBatchTransaction.js.map +1 -0
- package/_cjs/src/utils/prepareCallTransaction.js +14 -0
- package/_cjs/src/utils/prepareCallTransaction.js.map +1 -0
- package/_cjs/src/utils/repeatUntilOk.js +19 -0
- package/_cjs/src/utils/repeatUntilOk.js.map +1 -0
- package/_cjs/src/utils/request.js +48 -0
- package/_cjs/src/utils/request.js.map +1 -0
- package/_cjs/src/utils/simulateContract.js +8 -0
- package/_cjs/src/utils/simulateContract.js.map +1 -0
- package/_cjs/src/utils/structuredClone.js +11 -0
- package/_cjs/src/utils/structuredClone.js.map +1 -0
- package/_cjs/src/utils/transaction.js +351 -0
- package/_cjs/src/utils/transaction.js.map +1 -0
- package/_cjs/src/utils/viemWallet.js +211 -0
- package/_cjs/src/utils/viemWallet.js.map +1 -0
- package/_cjs/src/utils/websocket.js +76 -0
- package/_cjs/src/utils/websocket.js.map +1 -0
- package/_cjs/src/version.js +5 -0
- package/_cjs/src/version.js.map +1 -0
- package/_cjs/tsconfig.build.tsbuildinfo +1 -0
- package/_esm/package.json +1 -0
- package/_esm/src/actions/claimAppFees.js +54 -0
- package/_esm/src/actions/claimAppFees.js.map +1 -0
- package/_esm/src/actions/execute.js +83 -0
- package/_esm/src/actions/execute.js.map +1 -0
- package/_esm/src/actions/getAppFees.js +25 -0
- package/_esm/src/actions/getAppFees.js.map +1 -0
- package/_esm/src/actions/getPrice.js +53 -0
- package/_esm/src/actions/getPrice.js.map +1 -0
- package/_esm/src/actions/getQuote.js +92 -0
- package/_esm/src/actions/getQuote.js.map +1 -0
- package/_esm/src/actions/getSolverCapacity.js +18 -0
- package/_esm/src/actions/getSolverCapacity.js.map +1 -0
- package/_esm/src/actions/index.js +7 -0
- package/_esm/src/actions/index.js.map +1 -0
- package/_esm/src/client.js +217 -0
- package/_esm/src/client.js.map +1 -0
- package/_esm/src/constants/address.js +43 -0
- package/_esm/src/constants/address.js.map +1 -0
- package/_esm/src/constants/bvm.js +2 -0
- package/_esm/src/constants/bvm.js.map +1 -0
- package/_esm/src/constants/index.js +3 -0
- package/_esm/src/constants/index.js.map +1 -0
- package/_esm/src/constants/servers.js +7 -0
- package/_esm/src/constants/servers.js.map +1 -0
- package/_esm/src/errors/DepositTransactionTimeoutError.js +14 -0
- package/_esm/src/errors/DepositTransactionTimeoutError.js.map +1 -0
- package/_esm/src/errors/SolverStatusTimeoutError.js +14 -0
- package/_esm/src/errors/SolverStatusTimeoutError.js.map +1 -0
- package/_esm/src/errors/TransactionConfirmationError.js +21 -0
- package/_esm/src/errors/TransactionConfirmationError.js.map +1 -0
- package/_esm/src/errors/index.js +4 -0
- package/_esm/src/errors/index.js.map +1 -0
- package/_esm/src/index.js +7 -0
- package/_esm/src/index.js.map +1 -0
- package/_esm/src/routes/index.js +43 -0
- package/_esm/src/routes/index.js.map +1 -0
- package/_esm/src/types/AdaptedWallet.js +2 -0
- package/_esm/src/types/AdaptedWallet.js.map +1 -0
- package/_esm/src/types/Execute.js +2 -0
- package/_esm/src/types/Execute.js.map +1 -0
- package/_esm/src/types/Progress.js +2 -0
- package/_esm/src/types/Progress.js.map +1 -0
- package/_esm/src/types/RelayChain.js +2 -0
- package/_esm/src/types/RelayChain.js.map +1 -0
- package/_esm/src/types/SignatureStepItem.js +2 -0
- package/_esm/src/types/SignatureStepItem.js.map +1 -0
- package/_esm/src/types/TransactionStepItem.js +2 -0
- package/_esm/src/types/TransactionStepItem.js.map +1 -0
- package/_esm/src/types/api.js +6 -0
- package/_esm/src/types/api.js.map +1 -0
- package/_esm/src/types/index.js +8 -0
- package/_esm/src/types/index.js.map +1 -0
- package/_esm/src/utils/axios.js +15 -0
- package/_esm/src/utils/axios.js.map +1 -0
- package/_esm/src/utils/chain.js +86 -0
- package/_esm/src/utils/chain.js.map +1 -0
- package/_esm/src/utils/executeSteps/index.js +347 -0
- package/_esm/src/utils/executeSteps/index.js.map +1 -0
- package/_esm/src/utils/executeSteps/signatureStep.js +191 -0
- package/_esm/src/utils/executeSteps/signatureStep.js.map +1 -0
- package/_esm/src/utils/executeSteps/transactionStep.js +76 -0
- package/_esm/src/utils/executeSteps/transactionStep.js.map +1 -0
- package/_esm/src/utils/executeSteps/websocketHandlers.js +124 -0
- package/_esm/src/utils/executeSteps/websocketHandlers.js.map +1 -0
- package/_esm/src/utils/fetchChainConfigs.js +16 -0
- package/_esm/src/utils/fetchChainConfigs.js.map +1 -0
- package/_esm/src/utils/getCurrentStepData.js +24 -0
- package/_esm/src/utils/getCurrentStepData.js.map +1 -0
- package/_esm/src/utils/getTenderlyDetails.js +20 -0
- package/_esm/src/utils/getTenderlyDetails.js.map +1 -0
- package/_esm/src/utils/hyperliquid.js +90 -0
- package/_esm/src/utils/hyperliquid.js.map +1 -0
- package/_esm/src/utils/index.js +16 -0
- package/_esm/src/utils/index.js.map +1 -0
- package/_esm/src/utils/logger.js +34 -0
- package/_esm/src/utils/logger.js.map +1 -0
- package/_esm/src/utils/params.js +40 -0
- package/_esm/src/utils/params.js.map +1 -0
- package/_esm/src/utils/pollApi.js +57 -0
- package/_esm/src/utils/pollApi.js.map +1 -0
- package/_esm/src/utils/prepareBatchTransaction.js +31 -0
- package/_esm/src/utils/prepareBatchTransaction.js.map +1 -0
- package/_esm/src/utils/prepareCallTransaction.js +11 -0
- package/_esm/src/utils/prepareCallTransaction.js.map +1 -0
- package/_esm/src/utils/repeatUntilOk.js +23 -0
- package/_esm/src/utils/repeatUntilOk.js.map +1 -0
- package/_esm/src/utils/request.js +42 -0
- package/_esm/src/utils/request.js.map +1 -0
- package/_esm/src/utils/simulateContract.js +5 -0
- package/_esm/src/utils/simulateContract.js.map +1 -0
- package/_esm/src/utils/structuredClone.js +8 -0
- package/_esm/src/utils/structuredClone.js.map +1 -0
- package/_esm/src/utils/transaction.js +374 -0
- package/_esm/src/utils/transaction.js.map +1 -0
- package/_esm/src/utils/viemWallet.js +207 -0
- package/_esm/src/utils/viemWallet.js.map +1 -0
- package/_esm/src/utils/websocket.js +78 -0
- package/_esm/src/utils/websocket.js.map +1 -0
- package/_esm/src/version.js +2 -0
- package/_esm/src/version.js.map +1 -0
- package/_esm/tsconfig.build.tsbuildinfo +1 -0
- package/_types/src/actions/claimAppFees.d.ts +21 -0
- package/_types/src/actions/claimAppFees.d.ts.map +1 -0
- package/_types/src/actions/execute.d.ts +23 -0
- package/_types/src/actions/execute.d.ts.map +1 -0
- package/_types/src/actions/getAppFees.d.ts +12 -0
- package/_types/src/actions/getAppFees.d.ts.map +1 -0
- package/_types/src/actions/getPrice.d.ts +23 -0
- package/_types/src/actions/getPrice.d.ts.map +1 -0
- package/_types/src/actions/getQuote.d.ts +24 -0
- package/_types/src/actions/getQuote.d.ts.map +1 -0
- package/_types/src/actions/getSolverCapacity.d.ts +8 -0
- package/_types/src/actions/getSolverCapacity.d.ts.map +1 -0
- package/_types/src/actions/index.d.ts +7 -0
- package/_types/src/actions/index.d.ts.map +1 -0
- package/_types/src/client.d.ts +8039 -0
- package/_types/src/client.d.ts.map +1 -0
- package/_types/src/constants/address.d.ts +11 -0
- package/_types/src/constants/address.d.ts.map +1 -0
- package/_types/src/constants/bvm.d.ts +2 -0
- package/_types/src/constants/bvm.d.ts.map +1 -0
- package/_types/src/constants/index.d.ts +3 -0
- package/_types/src/constants/index.d.ts.map +1 -0
- package/_types/src/constants/servers.d.ts +6 -0
- package/_types/src/constants/servers.d.ts.map +1 -0
- package/_types/src/errors/DepositTransactionTimeoutError.d.ts +5 -0
- package/_types/src/errors/DepositTransactionTimeoutError.d.ts.map +1 -0
- package/_types/src/errors/SolverStatusTimeoutError.d.ts +5 -0
- package/_types/src/errors/SolverStatusTimeoutError.d.ts.map +1 -0
- package/_types/src/errors/TransactionConfirmationError.d.ts +9 -0
- package/_types/src/errors/TransactionConfirmationError.d.ts.map +1 -0
- package/_types/src/errors/index.d.ts +4 -0
- package/_types/src/errors/index.d.ts.map +1 -0
- package/_types/src/index.d.ts +7 -0
- package/_types/src/index.d.ts.map +1 -0
- package/_types/src/routes/index.d.ts +2 -0
- package/_types/src/routes/index.d.ts.map +1 -0
- package/_types/src/types/AdaptedWallet.d.ts +27 -0
- package/_types/src/types/AdaptedWallet.d.ts.map +1 -0
- package/_types/src/types/Execute.d.ts +64 -0
- package/_types/src/types/Execute.d.ts.map +1 -0
- package/_types/src/types/Progress.d.ts +17 -0
- package/_types/src/types/Progress.d.ts.map +1 -0
- package/_types/src/types/RelayChain.d.ts +47 -0
- package/_types/src/types/RelayChain.d.ts.map +1 -0
- package/_types/src/types/SignatureStepItem.d.ts +21 -0
- package/_types/src/types/SignatureStepItem.d.ts.map +1 -0
- package/_types/src/types/TransactionStepItem.d.ts +25 -0
- package/_types/src/types/TransactionStepItem.d.ts.map +1 -0
- package/_types/src/types/api.d.ts +4911 -0
- package/_types/src/types/api.d.ts.map +1 -0
- package/_types/src/types/index.d.ts +8 -0
- package/_types/src/types/index.d.ts.map +1 -0
- package/_types/src/utils/axios.d.ts +2 -0
- package/_types/src/utils/axios.d.ts.map +1 -0
- package/_types/src/utils/chain.d.ts +7 -0
- package/_types/src/utils/chain.d.ts.map +1 -0
- package/_types/src/utils/executeSteps/index.d.ts +34 -0
- package/_types/src/utils/executeSteps/index.d.ts.map +1 -0
- package/_types/src/utils/executeSteps/signatureStep.d.ts +21 -0
- package/_types/src/utils/executeSteps/signatureStep.d.ts.map +1 -0
- package/_types/src/utils/executeSteps/transactionStep.d.ts +25 -0
- package/_types/src/utils/executeSteps/transactionStep.d.ts.map +1 -0
- package/_types/src/utils/executeSteps/websocketHandlers.d.ts +21 -0
- package/_types/src/utils/executeSteps/websocketHandlers.d.ts.map +1 -0
- package/_types/src/utils/fetchChainConfigs.d.ts +3 -0
- package/_types/src/utils/fetchChainConfigs.d.ts.map +1 -0
- package/_types/src/utils/getCurrentStepData.d.ts +80 -0
- package/_types/src/utils/getCurrentStepData.d.ts.map +1 -0
- package/_types/src/utils/getTenderlyDetails.d.ts +6 -0
- package/_types/src/utils/getTenderlyDetails.d.ts.map +1 -0
- package/_types/src/utils/hyperliquid.d.ts +49 -0
- package/_types/src/utils/hyperliquid.d.ts.map +1 -0
- package/_types/src/utils/index.d.ts +16 -0
- package/_types/src/utils/index.d.ts.map +1 -0
- package/_types/src/utils/logger.d.ts +9 -0
- package/_types/src/utils/logger.d.ts.map +1 -0
- package/_types/src/utils/params.d.ts +27 -0
- package/_types/src/utils/params.d.ts.map +1 -0
- package/_types/src/utils/pollApi.d.ts +22 -0
- package/_types/src/utils/pollApi.d.ts.map +1 -0
- package/_types/src/utils/prepareBatchTransaction.d.ts +41 -0
- package/_types/src/utils/prepareBatchTransaction.d.ts.map +1 -0
- package/_types/src/utils/prepareCallTransaction.d.ts +6 -0
- package/_types/src/utils/prepareCallTransaction.d.ts.map +1 -0
- package/_types/src/utils/repeatUntilOk.d.ts +10 -0
- package/_types/src/utils/repeatUntilOk.d.ts.map +1 -0
- package/_types/src/utils/request.d.ts +11 -0
- package/_types/src/utils/request.d.ts.map +1 -0
- package/_types/src/utils/simulateContract.d.ts +4 -0
- package/_types/src/utils/simulateContract.d.ts.map +1 -0
- package/_types/src/utils/structuredClone.d.ts +2 -0
- package/_types/src/utils/structuredClone.d.ts.map +1 -0
- package/_types/src/utils/transaction.d.ts +12 -0
- package/_types/src/utils/transaction.d.ts.map +1 -0
- package/_types/src/utils/viemWallet.d.ts +5 -0
- package/_types/src/utils/viemWallet.d.ts.map +1 -0
- package/_types/src/utils/websocket.d.ts +30 -0
- package/_types/src/utils/websocket.d.ts.map +1 -0
- package/_types/src/version.d.ts +2 -0
- package/_types/src/version.d.ts.map +1 -0
- package/_types/tsconfig.build.tsbuildinfo +1 -0
- package/package.json +57 -0
- package/readme.md +37 -0
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@relayprotocol/relay-sdk",
|
|
3
|
+
"version": "2.4.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"main": "./_cjs/src/index.js",
|
|
6
|
+
"module": "./_esm/src/index.js",
|
|
7
|
+
"types": "./_types/src/index.d.ts",
|
|
8
|
+
"typings": "./_types/src/index.d.ts",
|
|
9
|
+
"sideEffects": false,
|
|
10
|
+
"files": [
|
|
11
|
+
"./_cjs",
|
|
12
|
+
"./_esm",
|
|
13
|
+
"./_types"
|
|
14
|
+
],
|
|
15
|
+
"exports": {
|
|
16
|
+
"types": "./_types/src/index.d.ts",
|
|
17
|
+
"import": "./_esm/src/index.js",
|
|
18
|
+
"require": "./_cjs/src/index.js"
|
|
19
|
+
},
|
|
20
|
+
"devDependencies": {
|
|
21
|
+
"@vitest/ui": "^1.6.0",
|
|
22
|
+
"node-fetch": "^3.3.2",
|
|
23
|
+
"rimraf": "^5.0.5",
|
|
24
|
+
"typescript": "5.4.5",
|
|
25
|
+
"vitest": "^1.6.0"
|
|
26
|
+
},
|
|
27
|
+
"peerDependencies": {
|
|
28
|
+
"viem": ">=2.26.0"
|
|
29
|
+
},
|
|
30
|
+
"dependencies": {
|
|
31
|
+
"axios": "^1.6.5"
|
|
32
|
+
},
|
|
33
|
+
"keywords": [
|
|
34
|
+
"eth",
|
|
35
|
+
"ethereum",
|
|
36
|
+
"dapps",
|
|
37
|
+
"wallet",
|
|
38
|
+
"web3",
|
|
39
|
+
"bridge",
|
|
40
|
+
"reservoir"
|
|
41
|
+
],
|
|
42
|
+
"scripts": {
|
|
43
|
+
"prebuild": "node scripts/version.mjs",
|
|
44
|
+
"build": "pnpm run prebuild && pnpm run clean && pnpm run build:cjs && pnpm run build:esm && pnpm run build:types",
|
|
45
|
+
"build:cjs": "tsc --project ./tsconfig.build.json --module commonjs --outDir ./_cjs --removeComments --verbatimModuleSyntax false && printf '{\"type\":\"commonjs\"}' > ./_cjs/package.json",
|
|
46
|
+
"build:esm": "tsc --project ./tsconfig.build.json --module es2015 --outDir ./_esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./_esm/package.json",
|
|
47
|
+
"build:types": "tsc --project ./tsconfig.build.json --module esnext --outDir ./_types --declarationDir ./_types --emitDeclarationOnly --declaration --declarationMap",
|
|
48
|
+
"dev": "concurrently \"pnpm run clean\" \"pnpm run dev:esm\" \"pnpm run dev:types\"",
|
|
49
|
+
"dev:esm": "tsc --watch --project ./tsconfig.build.json --module es2015 --outDir ./_esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./_esm/package.json",
|
|
50
|
+
"dev:types": "tsc --watch --project ./tsconfig.build.json --module esnext --outDir ./_types --declarationDir ./_types --emitDeclarationOnly --declaration --declarationMap",
|
|
51
|
+
"clean": "rimraf ./_esm ./_cjs ./_types",
|
|
52
|
+
"typecheck": "tsc --noEmit",
|
|
53
|
+
"test": "vitest",
|
|
54
|
+
"test:update": "vitest --update",
|
|
55
|
+
"test:ui": "vitest --ui"
|
|
56
|
+
}
|
|
57
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Relay
|
|
2
|
+
|
|
3
|
+
Relay is the Fastest and Cheapest Way to Bridge and Transact Across Chains.
|
|
4
|
+
|
|
5
|
+
This SDK facilitates interacting with Reservoir's Relay infrastructure. Learn more about Relay by checking out the <a href="https://docs.relay.link">docs</a>.
|
|
6
|
+
Head over to the <a href="https://docs.relay.link/references/sdk/getting-started">sdk docs</a> to learn more about configuring and using the SDK in your application.
|
|
7
|
+
</br>
|
|
8
|
+
</br>
|
|
9
|
+
|
|
10
|
+
## Contributing
|
|
11
|
+
|
|
12
|
+
Your contributions are what make the community great. We encourage you to be a part of it. Here are some important notes for contributors:
|
|
13
|
+
|
|
14
|
+
#### Preparing Changes
|
|
15
|
+
|
|
16
|
+
**We use `changesets` to manage versioning and changelog generation.**
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
When contributing, please run `pnpm package:change` to create a changeset for your modifications. Be sure to include a descriptive summary for your changes; it helps us understand your contribution and makes the release process smoother.
|
|
20
|
+
|
|
21
|
+
Learn more about changesets [here](https://github.com/atlassian/changesets).
|
|
22
|
+
#### Getting Started
|
|
23
|
+
|
|
24
|
+
Before you start, make sure to familiarize yourself with the SDK's architecture and design principles by reading the [SDK documentation](https://docs.relay.link/references/sdk/getting-started). This will help you make meaningful contributions that align with the project's goals.
|
|
25
|
+
|
|
26
|
+
#### Pull Requests
|
|
27
|
+
|
|
28
|
+
When you're ready to contribute, submit a pull request with your changes. Our team will review your submission as soon as possible.
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
<p align="center">
|
|
34
|
+
<a href="https://reservoir.tools/">Home</a> • <a href="https://docs.relay.link">Documentation</a> • <a href="https://github.com/reservoir-tools/relay-sdk">GitHub</a>
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
<p align="center"> Made with <span style="color: #e25555;">♥</span> by the team @ <a href="https://reservoir.tools/">Reservoir</a></p>
|