feat standardize verbose invocations

package.json

@@ -1,6 +1,6 @@
 {
  "name": "stellar-plus",
- "version": "0.12.0",
+ "version": "0.12.1",
  "description": "beta version of stellar-plus, an all-in-one sdk for the Stellar blockchain",
  "main": "./lib/index.js",
  "types": "./lib/index.d.ts",

src/stellar-plus/asset/classic/index.ts

@@ -11,6 +11,7 @@ import {
 
 import { AccountHandler } from 'stellar-plus/account/account-handler/types'
 import {
+ BaseInvocation,
  ClassicAssetHandlerConstructorArgs,
  ControlFlags,
  ClassicAssetHandler as IClassicAssetHandler,
@@ -19,7 +20,7 @@ import { AssetTypes } from 'stellar-plus/asset/types'
 import { ClassicTransactionPipeline } from 'stellar-plus/core/pipelines/classic-transaction'
 import {
  ClassicTransactionPipelineOptions,
- ClassicTransactionPipelineOutputSimple,
+ ClassicTransactionPipelineOutput,
 } from 'stellar-plus/core/pipelines/classic-transaction/types'
 import { TransactionInvocation } from 'stellar-plus/core/types'
 import { HorizonHandlerClient as HorizonHandler } from 'stellar-plus/horizon'
@@ -157,7 +158,9 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  *
  * @description - Transfers the given amount of the asset from the 'from' account to the 'to' account.
  */
- public async transfer(args: { from: string; to: string; amount: number } & TransactionInvocation): Promise<void> {
+ public async transfer(
+ args: { from: string; to: string; amount: number } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  const { from, to, amount } = args
 
  const txInvocation = args as TransactionInvocation
@@ -169,12 +172,15 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  source: from,
  })
 
- await this.classicTransactionPipeline.execute({
+ const result = await this.classicTransactionPipeline.execute({
  txInvocation,
  operations: [transferOp],
+ options: {
+ ...args.options,
+ },
  })
 
- return
+ return result
  }
 
  /**
@@ -189,7 +195,9 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  *
  * @description - Burns the given amount of the asset from the 'from' account.
  */
- public async burn(args: { from: string; amount: number } & TransactionInvocation): Promise<void> {
+ public async burn(
+ args: { from: string; amount: number } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  if (this.type === AssetTypes.native) {
  throw "You can't burn XLM"
  }
@@ -225,8 +233,8 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  args: {
  to: string
  amount: number
- } & TransactionInvocation
- ): Promise<HorizonNamespace.HorizonApi.SubmitTransactionResponse> {
+ } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  this.requireIssuerAccount() // Enforces the issuer account to be set.
 
  const { to, amount } = args
@@ -244,19 +252,31 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  source: this.asset.getIssuer(),
  })
 
- const result = (await this.classicTransactionPipeline.execute({
+ const result = await this.classicTransactionPipeline.execute({
  txInvocation: updatedTxInvocation,
  operations: [mintOp],
- })) as ClassicTransactionPipelineOutputSimple
+ options: {
+ ...args.options,
+ },
+ })
 
- return result.response
+ return result
  }
 
+ /**
+ *
+ * @param {ControlFlags} controlFlags - The control flags to set for the asset.
+ * @param {TransactionInvocation} txInvocation - The transaction invocation object spread. The Issuer account will be automatically added as a signer.
+ *
+ * @requires - The issuer account to be set in the asset.
+ *
+ * @returns {ClassicTransactionPipelineOutput} The response from the Horizon server.
+ */
  public async setFlags(
  args: {
  controlFlags: ControlFlags
- } & TransactionInvocation
- ): Promise<HorizonNamespace.HorizonApi.SubmitTransactionResponse> {
+ } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  this.requireIssuerAccount() // Enforces the issuer account to be set.
 
  const { controlFlags } = args
@@ -278,12 +298,15 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  source: this.asset.getIssuer(),
  })
 
- const result = (await this.classicTransactionPipeline.execute({
+ const result = await this.classicTransactionPipeline.execute({
  txInvocation: updatedTxInvocation,
  operations: [setFlags],
- })) as ClassicTransactionPipelineOutputSimple
+ options: {
+ ...args.options,
+ },
+ })
 
- return result.response
+ return result
  }
 
  public async clawback(): Promise<void> {
@@ -313,8 +336,8 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  args: {
  to: string
  amount: number
- } & TransactionInvocation
- ): Promise<HorizonNamespace.HorizonApi.SubmitTransactionResponse> {
+ } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  this.requireIssuerAccount() // Enforces the issuer account to be set.
 
  const { to, amount } = args
@@ -337,12 +360,15 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  source: this.asset.getIssuer(),
  })
 
- const result = (await this.classicTransactionPipeline.execute({
+ const result = await this.classicTransactionPipeline.execute({
  txInvocation: updatedTxInvocation,
  operations: [addTrustlineOp, mintOp],
- })) as ClassicTransactionPipelineOutputSimple
+ options: {
+ ...args.options,
+ },
+ })
 
- return result.response
+ return result
  }
 
  /**
@@ -359,8 +385,8 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  public async addTrustline(
  args: {
  to: string
- } & TransactionInvocation
- ): Promise<HorizonNamespace.HorizonApi.SubmitTransactionResponse> {
+ } & BaseInvocation
+ ): Promise<ClassicTransactionPipelineOutput> {
  const { to } = args
 
  const txInvocation = args as TransactionInvocation
@@ -370,12 +396,15 @@ export class ClassicAssetHandler implements IClassicAssetHandler {
  asset: this.asset,
  })
 
- const result = (await this.classicTransactionPipeline.execute({
+ const result = await this.classicTransactionPipeline.execute({
  txInvocation,
  operations: [addTrustlineOp],
- })) as ClassicTransactionPipelineOutputSimple
+ options: {
+ ...args.options,
+ },
+ })
 
- return result.response
+ return result
  }
 
  //==========================================

src/stellar-plus/asset/classic/index.unit.test.ts

@@ -283,6 +283,7 @@ describe('Classic Asset Handler', () => {
  expect(spyExecute).toHaveBeenCalledExactlyOnceWith({
  txInvocation: args as TransactionInvocation,
  operations: ['paymentOp'],
+ options: {},
  })
  })
 
@@ -341,6 +342,7 @@ describe('Classic Asset Handler', () => {
  signers: [mockedUserAccountHandler, mockedIssuerAccountHandler],
  } as TransactionInvocation,
  operations: ['paymentOp'],
+ options: {},
  })
  })
 
@@ -366,6 +368,7 @@ describe('Classic Asset Handler', () => {
  expect(spyExecute).toHaveBeenCalledExactlyOnceWith({
  txInvocation: args as TransactionInvocation,
  operations: ['changeTrustOp'],
+ options: {},
  })
  })
 
@@ -396,6 +399,7 @@ describe('Classic Asset Handler', () => {
  signers: [mockedUserAccountHandler, mockedIssuerAccountHandler],
  } as TransactionInvocation,
  operations: ['changeTrustOp', 'paymentOp'],
+ options: {},
  })
  })
  })

src/stellar-plus/asset/classic/types.ts

@@ -1,8 +1,10 @@
-import { Horizon } from '@stellar/stellar-sdk'
-
 import { AccountHandler } from 'stellar-plus/account/account-handler/types'
 import { AssetType, AssetTypes } from 'stellar-plus/asset/types'
-import { ClassicTransactionPipelineOptions } from 'stellar-plus/core/pipelines/classic-transaction/types'
+import {
+ ClassicTransactionPipelineInput,
+ ClassicTransactionPipelineOptions,
+ ClassicTransactionPipelineOutput,
+} from 'stellar-plus/core/pipelines/classic-transaction/types'
 import { TransactionInvocation } from 'stellar-plus/core/types'
 import { NetworkConfig } from 'stellar-plus/types'
 
@@ -31,27 +33,28 @@ export type ClassicTokenInterfaceManagement = {
  args: {
  to: string
  amount: number
- } & TransactionInvocation
- ) => Promise<Horizon.HorizonApi.SubmitTransactionResponse>
+ } & BaseInvocation
+ ) => Promise<ClassicTransactionPipelineOutput>
 
- setFlags: (
- args: { controlFlags: ControlFlags } & TransactionInvocation
- ) => Promise<Horizon.HorizonApi.SubmitTransactionResponse>
+ setFlags: (args: { controlFlags: ControlFlags } & BaseInvocation) => Promise<ClassicTransactionPipelineOutput>
 }
 
 export type ClassicTokenInterfaceUser = {
  balance: (id: string) => Promise<number>
- transfer: (args: { from: string; to: string; amount: number } & TransactionInvocation) => Promise<void>
- burn: (args: { from: string; amount: number } & TransactionInvocation) => Promise<void>
+ transfer: (
+ args: { from: string; to: string; amount: number } & BaseInvocation
+ ) => Promise<ClassicTransactionPipelineOutput>
+ burn: (args: { from: string; amount: number } & BaseInvocation) => Promise<ClassicTransactionPipelineOutput>
  decimals: () => Promise<number>
  name: () => Promise<string>
  symbol: () => Promise<string>
 }
 
 export type ClassicUtils = {
  addTrustlineAndMint: (
- args: { to: string; amount: number } & TransactionInvocation
- ) => Promise<Horizon.HorizonApi.SubmitTransactionResponse>
+ args: { to: string; amount: number } & BaseInvocation
+ ) => Promise<ClassicTransactionPipelineOutput>
+ addTrustline: (args: { to: string } & BaseInvocation) => Promise<ClassicTransactionPipelineOutput>
 }
 
 export type ControlFlags = {
@@ -60,3 +63,7 @@ export type ControlFlags = {
  clawbackEnabled?: boolean
  authorizationImmutable?: boolean
 }
+
+export type BaseInvocation = TransactionInvocation & {
+ options?: ClassicTransactionPipelineInput['options']
+}