Replaced avail-js SignerOptions with TransactionOptions (#679)

* Replaced avail-js SignerOptions with TransactionOptions * publish version and update internal deps* --------- Co-authored-by: Leouarz <[email protected]>
availproject · Oct 25, 2024 · 2e467f8 · 2e467f8
1 parent 4f0439f
commit 2e467f8
Show file tree

Hide file tree

Showing 17 changed files with 287 additions and 285 deletions.
diff --git a/avail-js/docs/extrinsics/README.md b/avail-js/docs/extrinsics/README.md
diff --git a/avail-js/docs/extrinsics/da_submit_data.ts b/avail-js/docs/extrinsics/da_submit_data.ts
@@ -1,4 +1,4 @@
-import { SDK, WaitFor, Keyring } from "avail-js-sdk"
+import { SDK, WaitFor, Keyring, TransactionOptions } from "avail-js-sdk"
 
 const main = async () => {
   const providerEndpoint = "ws://127.0.0.1:9944"
@@ -8,7 +8,8 @@ const main = async () => {
   const account = new Keyring({ type: "sr25519" }).addFromUri("//Alice")
   const data = "My Awesome Data"
 
-  const result = await sdk.tx.dataAvailability.submitData(data, WaitFor.BlockInclusion, account)
+  const options: TransactionOptions = { app_id: 1 }
+  const result = await sdk.tx.dataAvailability.submitData(data, WaitFor.BlockInclusion, account, options)
   if (result.isErr) {
     console.log(result.reason)
     process.exit(1)

diff --git a/avail-js/docs/package-lock.json b/avail-js/docs/package-lock.json
diff --git a/avail-js/docs/package.json b/avail-js/docs/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "description": "Shows a basic usage of the Avail-js SDK",
   "dependencies": {
-    "avail-js-sdk": "^0.2.18"
+    "avail-js-sdk": "^0.3.0"
   },
   "resolutions": {
     "ws": ">=8.17.1"

diff --git a/avail-js/examples/next-example/package-lock.json b/avail-js/examples/next-example/package-lock.json
diff --git a/avail-js/examples/next-example/package.json b/avail-js/examples/next-example/package.json
@@ -15,7 +15,7 @@
     "@types/react": "18.2.67",
     "@types/react-dom": "18.2.22",
     "autoprefixer": "10.4.18",
-    "avail-js-sdk": "^0.2.18",
+    "avail-js-sdk": "^0.3.0",
     "eslint": "8.57.0",
     "eslint-config-next": "14.1.4",
     "next": "^14.2.12",

diff --git a/avail-js/examples/node-examples/package-lock.json b/avail-js/examples/node-examples/package-lock.json
diff --git a/avail-js/examples/node-examples/package.json b/avail-js/examples/node-examples/package.json
@@ -24,7 +24,7 @@
     "validium": "npm run build && node build/node-examples/src/validium.js"
   },
   "dependencies": {
-    "avail-js-sdk": "^0.2.18",
+    "avail-js-sdk": "^0.3.0",
     "ethers": "^6.13.2"
   },
   "devDependencies": {

diff --git a/avail-js/package-lock.json b/avail-js/package-lock.json
diff --git a/avail-js/package.json b/avail-js/package.json
@@ -1,6 +1,6 @@
 {
   "name": "avail-js-sdk",
-  "version": "0.2.18",
+  "version": "0.3.0",
   "description": "Avail library of functions to interact with blockchain and manipulate transactions",
   "main": "./build/index.js",
   "scripts": {

diff --git a/avail-js/src/sdk/index.ts b/avail-js/src/sdk/index.ts
@@ -16,6 +16,7 @@ export {
   ClaimPermission,
   NewCommission,
   PoolState,
+  TransactionOptions,
 } from "./transactions"
 
 export class SDK {

diff --git a/avail-js/src/sdk/transactions/balances.ts b/avail-js/src/sdk/transactions/balances.ts
@@ -5,9 +5,8 @@ import { BN } from "@polkadot/util"
 import { KeyringPair } from "@polkadot/keyring/types"
 import { err, Result } from "neverthrow"
 
-import { SignerOptions } from "@polkadot/api/types"
 import { decodeError } from "../../helpers"
-import { WaitFor, GenericFailure, standardCallback, getBlockHashAndTxHash } from "./common"
+import { WaitFor, GenericFailure, standardCallback, getBlockHashAndTxHash, TransactionOptions } from "./common"
 
 type TransferKeepAliveTxSuccess = {
   isErr: false
@@ -51,7 +50,7 @@ export class Balances {
     keepAlive: boolean,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<TransferAllTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -96,7 +95,7 @@ export class Balances {
     value: BN,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<TransferAllowDeathTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -150,7 +149,7 @@ export class Balances {
     value: BN,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<TransferKeepAliveTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {

diff --git a/avail-js/src/sdk/transactions/common.ts b/avail-js/src/sdk/transactions/common.ts
@@ -47,3 +47,10 @@ export async function getBlockHashAndTxHash(
 }
 
 export type GenericFailure = { isErr: true; reason: string }
+
+export interface TransactionOptions {
+  app_id?: number
+  nonce?: number
+  era?: number
+  blockHash?: H256
+}
diff --git a/avail-js/src/sdk/transactions/da.ts b/avail-js/src/sdk/transactions/da.ts
@@ -4,11 +4,9 @@ import { H256, EventRecord } from "@polkadot/types/interfaces/types"
 import { BN } from "@polkadot/util"
 import { KeyringPair } from "@polkadot/keyring/types"
 import { err, Result } from "neverthrow"
-
 import * as TransactionData from "./../transaction_data"
-import { SignerOptions } from "@polkadot/api/types"
 import { decodeError, fromHexToAscii } from "../../helpers"
-import { WaitFor, GenericFailure, standardCallback, getBlockHashAndTxHash } from "./common"
+import { WaitFor, GenericFailure, standardCallback, getBlockHashAndTxHash, TransactionOptions } from "./common"
 
 export type DispatchFeeModifier = {
   weightMaximumFee: BN | null
@@ -74,7 +72,7 @@ export class DataAvailability {
     data: string,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<SubmitDataTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -131,7 +129,7 @@ export class DataAvailability {
     key: string,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<CreateApplicationKeyTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -175,7 +173,7 @@ export class DataAvailability {
     newKey: string,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<SetApplicationKeyTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -230,7 +228,7 @@ export class DataAvailability {
     cols: number,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<SubmitBlockLengthProposalTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {
@@ -292,7 +290,7 @@ export class DataAvailability {
     modifier: DispatchFeeModifier,
     waitFor: WaitFor,
     account: KeyringPair,
-    options?: Partial<SignerOptions>,
+    options?: TransactionOptions,
   ): Promise<SetSubmitDataFeeModifierTxSuccess | GenericFailure> {
     const optionWrapper = options || {}
     const maybeTxResult = await new Promise<Result<ISubmittableResult, string>>((res, _) => {

diff --git a/avail-js/src/sdk/transactions/index.ts b/avail-js/src/sdk/transactions/index.ts
@@ -4,7 +4,7 @@ import { Staking } from "./staking"
 import { DataAvailability } from "./da"
 import { NominationPools } from "./nomination_pools"
 
-export { WaitFor } from "./common"
+export { WaitFor, TransactionOptions } from "./common"
 export { DispatchFeeModifier } from "./da"
 export { StakingRewardDestination } from "./staking"
 export { BondExtra, ClaimPermission, NewCommission, PoolState } from "./nomination_pools"