V3.1.0 (#98)

* adapt transaction request object to include gasPricePolicy

* upgrade snyk packages

CHANGELOG.md

@@ -2,11 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
-## 3.0.2 (unreleased)
+## 3.1.0 (unreleased)
 
 ### 🛠 Bug fixes
 
 - Fixes a search of transactions by idempotency key issue
+- Adapt transaction request interfaces to include gasPricePolicy
 
 ## 3.0.1 (31-07-2020)
 

README.md

@@ -16,7 +16,8 @@ The PegaSys Orchestrate library provides convenient access to the PegaSys Orches
 | SDK versions        | Orchestrate versions         |
 | ------------------- | ---------------------------- |
 | master/HEAD         | Orchestrate v2.3.x or higher |
-| SDK v3.x.x          | Orchestrate v2.3.x or higher |
+| SDK v3.1.x          | Orchestrate v2.3.x or higher |
+| SDK v3.0.x          | Orchestrate v2.3.x-rcX       |
 | SDK v2.3.x          | Orchestrate v2.1.x or higher |
 | SDK v2.2.x          | Orchestrate v2.1.x or higher |
 | SDK v2.1.x          | Orchestrate v2.1.x or higher |

examples/send-onetimekey-tx/app.ts

@@ -15,9 +15,7 @@ export const start = async () => {
           to: '0x4a435585d27cd7e6dae2c714be8e414b5fd7d257',
           methodSignature: 'transfer(address,uint256)',
           args: ['0x6009608a02a7a15fd6689d6dad560c44e9ab61ff', 5000],
-          annotations: {
-            oneTimeKey: true
-          }
+          oneTimeKey: true
         }
       },
       'ExampleOneTimeKey'

examples/send-transfer-with-priority/app.ts

@@ -15,7 +15,9 @@ export const start = async () => {
           from: '0x7e654d251da770a068413677967f6d3ea2fea9e4', // Default Orchestrate account in development mode
           to: '0x6009608a02a7a15fd6689d6dad560c44e9ab61ff',
           value: '100000000',
-          priority: Priority.VeryHigh
+          gasPricePolicy: {
+            priority: Priority.VeryHigh
+          }
         }
       },
       'ExampleTransferPriority'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pegasys-orchestrate",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "The PegaSys Orchestrate library provides convenient access to the PegaSys Orchestrate API from applications written in server-side JavaScript",
   "main": "lib/index.js",
   "files": [
@@ -69,16 +69,16 @@
     "@grpc/grpc-js": "~1.1.3",
     "axios": "~0.19.2",
     "commander": "~5.1.0",
-    "ethers": "~5.0.7",
+    "ethers": "~5.0.8",
     "kafkajs": "~1.12.0",
-    "protobufjs": "~6.9.0",
+    "protobufjs": "~6.10.1",
     "qs": "~6.9.4",
-    "uuid": "~8.2.0"
+    "uuid": "~8.3.0"
   },
   "devDependencies": {
     "@types/bn.js": "~4.11.6",
-    "@types/qs": "~6.9.4",
     "@types/jest": "~26.0.0",
+    "@types/qs": "~6.9.4",
     "@types/uuid": "~8.0.0",
     "axios-mock-adapter": "~1.18.1",
     "husky": "~4.2.5",
@@ -93,8 +93,8 @@
     "tslint": "~6.1.2",
     "tslint-config-prettier": "~1.18.0",
     "typedoc": "~0.17.7",
-    "typescript": "~3.9.5",
-    "typedoc-plugin-pages": "~1.0.1"
+    "typedoc-plugin-pages": "~1.0.1",
+    "typescript": "~3.9.5"
   },
   "husky": {
     "hooks": {

src/http/types/IGasPricePolicy.ts

@@ -0,0 +1,5 @@
+import { Priority } from './Priority'
+
+export interface IGasPricePolicy {
+  priority?: Priority
+}

src/http/types/ITransaction.ts

@@ -1,8 +1,7 @@
 import { ParsedQs } from 'qs'
 
-import { IAnnotations } from './IAnnotations'
+import { IGasPricePolicy } from './IGasPricePolicy'
 import { IScheduleResponse } from './ISchedule'
-import { Priority } from './Priority'
 import { ProtocolType } from './ProtocolType'
 
 interface IBaseRequest {
@@ -16,7 +15,8 @@ export interface ISendTransactionRequest extends IBaseRequest {
 interface ITransactionParams extends IBaseTransactionParams, IPrivateTransactionParams {
   to: string
   methodSignature: string
-  annotations?: IAnnotations
+  gasPricePolicy?: IGasPricePolicy
+  oneTimeKey?: boolean
 }
 
 export interface IDeployContractRequest extends IBaseRequest {
@@ -25,7 +25,8 @@ export interface IDeployContractRequest extends IBaseRequest {
 interface IDeployContractParams extends IBaseTransactionParams, IPrivateTransactionParams {
   contractName: string
   contractTag?: string
-  annotations?: IAnnotations
+  gasPricePolicy?: IGasPricePolicy
+  oneTimeKey?: boolean
 }
 
 export interface ISendRawRequest extends IBaseRequest {
@@ -41,7 +42,7 @@ export interface ITransferRequest extends IBaseRequest {
     value: string
     gas?: string
     gasPrice?: string
-    priority?: Priority
+    gasPricePolicy?: IGasPricePolicy
   }
 }