Refactoring avail-rust sdk

availproject · Nov 8, 2024 · aa0529b · aa0529b
1 parent 9f31a0e
commit aa0529b
Show file tree

Hide file tree

Showing 22 changed files with 1,051 additions and 1,180 deletions.
diff --git a/avail-js/docs/cookbook/src/rpc/payment.ts b/avail-js/docs/cookbook/src/rpc/payment.ts
@@ -17,7 +17,7 @@ const main = async () => {
   // Payment Query Free Details
   const mtx2 = await alice.balanceTransfer("5HGjWAeFDfFCWPsjFQdVV2Msvz2XtMktvgocEZcCj68kUMaw", SDK.oneAvail())
   const tx2 = mtx2._unsafeUnwrap()
-  const gtx2 = await tx2.details.fetchGenericTransaction(api)
+  const gtx2 = (await tx2.details.fetchBlock(api)).transactionByIndex(tx2.details.txIndex)._unsafeUnwrap()
   const queryFeeDetails: any = await api.call.transactionPaymentApi.queryFeeDetails(gtx2.toHex(), null)
 
   const baseFee: BN = queryFeeDetails.inclusionFee.__internal__raw.baseFee

diff --git a/avail-js/src/sdk/transactions/balances.ts b/avail-js/src/sdk/transactions/balances.ts
@@ -5,7 +5,7 @@ import { KeyringPair } from "@polkadot/keyring/types"
 import {
   WaitFor,
   TransactionOptions,
-  singAndSendAndParseTransaction,
+  signAndSendAndParseTransaction,
   TxResultDetails,
   TransactionFailed,
 } from "./common"
@@ -49,7 +49,7 @@ export class Balances {
     options?: TransactionOptions,
   ): Promise<Result<TransferAllTx, TransactionFailed>> {
     const tx = this.api.tx.balances.transferAll(dest, keepAlive)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -78,7 +78,7 @@ export class Balances {
     options?: TransactionOptions,
   ): Promise<Result<TransferAllowDeathTx, TransactionFailed>> {
     const tx = this.api.tx.balances.transferAllowDeath(dest, value)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -107,7 +107,7 @@ export class Balances {
     options?: TransactionOptions,
   ): Promise<Result<TransferKeepAliveTx, TransactionFailed>> {
     const tx = this.api.tx.balances.transferKeepAlive(dest, value)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value

diff --git a/avail-js/src/sdk/transactions/common.ts b/avail-js/src/sdk/transactions/common.ts
@@ -51,7 +51,7 @@ export async function signAndSendTransaction(
   })
 }
 
-export async function singAndSendAndParseTransaction(
+export async function signAndSendAndParseTransaction(
   api: ApiPromise,
   tx: SubmittableExtrinsic<"promise">,
   account: KeyringPair,

diff --git a/avail-js/src/sdk/transactions/da.ts b/avail-js/src/sdk/transactions/da.ts
@@ -7,7 +7,7 @@ import { decodeError, fromHexToAscii } from "../../helpers"
 import {
   WaitFor,
   TransactionOptions,
-  singAndSendAndParseTransaction,
+  signAndSendAndParseTransaction,
   TxResultDetails,
   TransactionFailed,
 } from "./common"
@@ -73,7 +73,7 @@ export class DataAvailability {
     const appId = optionWrapper.app_id || 0
 
     const tx = this.api.tx.dataAvailability.submitData(data)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -99,7 +99,7 @@ export class DataAvailability {
     options?: TransactionOptions,
   ): Promise<Result<CreateApplicationKeyTx, TransactionFailed>> {
     const tx = this.api.tx.dataAvailability.createApplicationKey(key)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -125,7 +125,7 @@ export class DataAvailability {
   ): Promise<Result<SetApplicationKeyTx, TransactionFailed>> {
     const call = this.api.tx.dataAvailability.setApplicationKey(oldKey, newKey)
     const tx = this.api.tx.sudo.sudo(call)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -151,7 +151,7 @@ export class DataAvailability {
   ): Promise<Result<SubmitBlockLengthProposalTx, TransactionFailed>> {
     const call = this.api.tx.dataAvailability.submitBlockLengthProposal(rows, cols)
     const tx = this.api.tx.sudo.sudo(call)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -177,7 +177,7 @@ export class DataAvailability {
   ): Promise<Result<SetSubmitDataFeeModifierTx, TransactionFailed>> {
     const call = this.api.tx.dataAvailability.setSubmitDataFeeModifier(modifier)
     const tx = this.api.tx.sudo.sudo(call)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value

diff --git a/avail-js/src/sdk/transactions/multisig.ts b/avail-js/src/sdk/transactions/multisig.ts
@@ -8,7 +8,7 @@ import {
   TransactionOptions,
   TxResultDetails,
   MultisigTimepoint,
-  singAndSendAndParseTransaction,
+  signAndSendAndParseTransaction,
 } from "./common"
 
 export class AsMultiTx {
@@ -45,7 +45,7 @@ export class Multisig {
     options?: TransactionOptions,
   ): Promise<Result<AsMultiTx, TransactionFailed>> {
     const tx = this.api.tx.multisig.asMulti(threshold, otherSignatures, timepoint, call, maxWeight)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -67,7 +67,7 @@ export class Multisig {
     options?: TransactionOptions,
   ): Promise<Result<ApproveAsMultiTx, TransactionFailed>> {
     const tx = this.api.tx.multisig.approveAsMulti(threshold, otherSignatures, timepoint, callHash, maxWeight)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value

diff --git a/avail-js/src/sdk/transactions/nomination_pools.ts b/avail-js/src/sdk/transactions/nomination_pools.ts
@@ -5,7 +5,7 @@ import { KeyringPair } from "@polkadot/keyring/types"
 import {
   WaitFor,
   TransactionOptions,
-  singAndSendAndParseTransaction,
+  signAndSendAndParseTransaction,
   TxResultDetails,
   TransactionFailed,
 } from "./common"
@@ -137,7 +137,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<CreateTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.create(amount, root, nominator, bouncer)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -162,7 +162,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<CreateWithPoolIdTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.createWithPoolId(amount, root, nominator, bouncer, poolId)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -184,7 +184,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<JoinTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.join(amount, poolId)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -203,7 +203,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<NominateTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.nominate(poolId, validators)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -218,7 +218,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<BondExtraTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.bondExtra(extra)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -237,7 +237,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<SetMetadataTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.setMetadata(poolId, metadata)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -253,7 +253,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<UnbondTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.unbond(memberAccount, unbondingPoints)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -269,7 +269,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<ChillTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.chill(poolId)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -284,7 +284,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<ClaimCommissionTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.claimCommission(poolId)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -301,7 +301,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<ClaimPayoutTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.claimPayout()
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -317,7 +317,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<ClaimPayoutOtherTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.claimPayoutOther(other)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -333,7 +333,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<SetClaimPermissionTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.setClaimPermission(permission)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -357,7 +357,7 @@ export class NominationPools {
     }
 
     const tx = this.api.tx.nominationPools.setCommission(poolId, commission)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -376,7 +376,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<WithdrawUnbodedTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.withdrawUnbonded(memberAccount, numSlashingSpans)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -395,7 +395,7 @@ export class NominationPools {
     options?: TransactionOptions,
   ): Promise<Result<SetStateTx, TransactionFailed>> {
     const tx = this.api.tx.nominationPools.setState(poolId, state)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value

diff --git a/avail-js/src/sdk/transactions/staking.ts b/avail-js/src/sdk/transactions/staking.ts
@@ -6,7 +6,7 @@ import { err, Result, ok } from "neverthrow"
 import {
   WaitFor,
   TransactionOptions,
-  singAndSendAndParseTransaction,
+  signAndSendAndParseTransaction,
   TxResultDetails,
   TransactionFailed,
 } from "./common"
@@ -79,7 +79,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<BondTx, TransactionFailed>> {
     const tx = this.api.tx.staking.bond(value, payee)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -97,7 +97,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<BondExtraTx, TransactionFailed>> {
     const tx = this.api.tx.staking.bondExtra(maxAdditional)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -114,7 +114,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<ChillTx, TransactionFailed>> {
     const tx = this.api.tx.staking.chill()
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -132,7 +132,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<ChillOtherTx, TransactionFailed>> {
     const tx = this.api.tx.staking.chillOther(stash)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -150,7 +150,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<NominateTx, TransactionFailed>> {
     const tx = this.api.tx.staking.nominate(targets)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -168,7 +168,7 @@ export class Staking {
     options?: TransactionOptions,
   ): Promise<Result<UnbondTx, TransactionFailed>> {
     const tx = this.api.tx.staking.unbond(value)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value
@@ -191,7 +191,7 @@ export class Staking {
 
     const validatorPerfs = { commission: maybeCommission.value, blocked } as ValidatorPerfs
     const tx = this.api.tx.staking.validate(validatorPerfs)
-    const maybeParsed = await singAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
+    const maybeParsed = await signAndSendAndParseTransaction(this.api, tx, account, waitFor, options)
     if (maybeParsed.isErr()) return err(maybeParsed.error)
 
     const details = maybeParsed.value