Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Implement verbose output for transactions pipelines #147

Merged
merged 4 commits into from
May 16, 2024
Merged

feat: Implement verbose output for transactions pipelines #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97ce7a5
feat: implement verbose output for classic pipeline
fazzatti May 16, 2024
1d9eba5
feat: implement verbose output for soroban pipeline
fazzatti May 16, 2024
7480b74
chore: bump version to 0.9.0
fazzatti May 16, 2024
06f12a3
Merge branch 'develop' into transaction-hash-output
fazzatti May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stellar-plus",
"version": "0.8.4",
"version": "0.9.0",
"description": "beta version of stellar-plus, an all-in-one sdk for the Stellar blockchain",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
Expand Down
17 changes: 10 additions & 7 deletions src/stellar-plus/asset/classic/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import {
} from 'stellar-plus/asset/classic/types'
import { AssetTypes } from 'stellar-plus/asset/types'
import { ClassicTransactionPipeline } from 'stellar-plus/core/pipelines/classic-transaction'
import { ClassicTransactionPipelineOptions } from 'stellar-plus/core/pipelines/classic-transaction/types'
import {
ClassicTransactionPipelineOptions,
ClassicTransactionPipelineOutputSimple,
} from 'stellar-plus/core/pipelines/classic-transaction/types'
import { TransactionInvocation } from 'stellar-plus/core/types'
import { HorizonHandlerClient as HorizonHandler } from 'stellar-plus/horizon'

Expand Down Expand Up @@ -231,10 +234,10 @@ 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

return result.response
}
Expand Down Expand Up @@ -290,10 +293,10 @@ 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

return result.response
}
Expand Down Expand Up @@ -323,10 +326,10 @@ 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

return result.response
}
Expand Down
75 changes: 45 additions & 30 deletions src/stellar-plus/asset/soroban-token/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { spec as defaultSpec, methods } from 'stellar-plus/asset/soroban-token/c
import { SorobanTokenHandlerConstructorArgs, SorobanTokenInterface } from 'stellar-plus/asset/soroban-token/types'
import { AssetTypes } from 'stellar-plus/asset/types'
import { ContractEngine } from 'stellar-plus/core/contract-engine'
import { SorobanTransactionPipelineOutputSimple } from 'stellar-plus/core/pipelines/soroban-transaction/types'
import { SorobanSimulationInvocation, TransactionInvocation } from 'stellar-plus/core/types'
import { i128, u32 } from 'stellar-plus/types'

Expand Down Expand Up @@ -51,11 +52,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Initialize the contract instance with the given parameters.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async initialize(
args: { admin: string; decimal: u32; name: string; symbol: string } & TransactionInvocation
): Promise<void> {
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.initialize,
methodArgs: {
Expand All @@ -67,7 +68,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

//==========================================
Expand All @@ -86,11 +87,13 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Set a new admin account for the contract.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*
* @requires {args.id} to be the current admin account
*/
public async setAdmin(args: { id: string; new_admin: string } & TransactionInvocation): Promise<void> {
public async setAdmin(
args: { id: string; new_admin: string } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.set_admin,
methodArgs: {
Expand All @@ -100,7 +103,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand Down Expand Up @@ -133,11 +136,13 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Authorize or deauthorize an account to interact with the contract.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*
* @requires - Authorization from the admin account
*/
public async setAuthorized(args: { id: string; authorize: boolean } & TransactionInvocation): Promise<void> {
public async setAuthorized(
args: { id: string; authorize: boolean } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.set_authorized,
methodArgs: {
Expand All @@ -147,7 +152,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand All @@ -162,11 +167,13 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Mint tokens to an account.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*
* @requires - Authorization from the admin account
*/
public async mint(args: { to: string; amount: i128 } & TransactionInvocation): Promise<void> {
public async mint(
args: { to: string; amount: i128 } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.mint,
methodArgs: {
Expand All @@ -176,7 +183,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand All @@ -191,11 +198,13 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Clawback tokens from an account.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*
* @requires - Authorization from the admin account
*/
public async clawback(args: { from: string; amount: i128 } & TransactionInvocation): Promise<void> {
public async clawback(
args: { from: string; amount: i128 } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.clawback,
methodArgs: {
Expand All @@ -205,7 +214,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

//==========================================
Expand Down Expand Up @@ -253,11 +262,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Approve a spender to spend tokens on behalf of the account.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async approve(
args: { from: string; spender: string; amount: i128; expiration_ledger: u32 } & TransactionInvocation
): Promise<void> {
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.approve,
methodArgs: {
Expand All @@ -269,7 +278,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand Down Expand Up @@ -327,9 +336,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Transfer tokens from the sender to the recipient.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async transfer(args: { from: string; to: string; amount: i128 } & TransactionInvocation): Promise<void> {
public async transfer(
args: { from: string; to: string; amount: i128 } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.transfer,
methodArgs: {
Expand All @@ -340,7 +351,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand All @@ -357,11 +368,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Transfer tokens from the sender to the recipient on behalf of the spender.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async transferFrom(
args: { spender: string; from: string; to: string; amount: i128 } & TransactionInvocation
): Promise<void> {
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.transfer_from,
methodArgs: {
Expand All @@ -373,7 +384,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand All @@ -388,9 +399,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Burn tokens from an account.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async burn(args: { from: string; amount: i128 } & TransactionInvocation): Promise<void> {
public async burn(
args: { from: string; amount: i128 } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.burn,
methodArgs: {
Expand All @@ -400,7 +413,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand All @@ -416,9 +429,11 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
*
* @description Burn tokens from an account on behalf of the spender.
*
* @returns {Promise<void>}
* @returns {Promise<SorobanTransactionPipelineOutputSimple>}
*/
public async burnFrom(args: { spender: string; from: string; amount: i128 } & TransactionInvocation): Promise<void> {
public async burnFrom(
args: { spender: string; from: string; amount: i128 } & TransactionInvocation
): Promise<SorobanTransactionPipelineOutputSimple> {
return (await this.invokeContract({
method: methods.burn_from,
methodArgs: {
Expand All @@ -429,7 +444,7 @@ export class SorobanTokenHandler extends ContractEngine implements SorobanTokenI
signers: args.signers,
header: args.header,
feeBump: args.feeBump,
})) as void
})) as SorobanTransactionPipelineOutputSimple
}

/**
Expand Down
27 changes: 17 additions & 10 deletions src/stellar-plus/asset/soroban-token/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { ContractSpec } from '@stellar/stellar-sdk'

import { AssetType } from 'stellar-plus/asset/types'
import { Options } from 'stellar-plus/core/contract-engine/types'
import { SorobanTransactionPipelineOutputSimple } from 'stellar-plus/core/pipelines/soroban-transaction/types'
import { SorobanSimulationInvocation, TransactionInvocation } from 'stellar-plus/core/types'
import { NetworkConfig, i128, u32 } from 'stellar-plus/types'

Expand All @@ -21,13 +22,13 @@ export type SorobanTokenInterface = AssetType & SorobanTokenInterfaceManagement
export type SorobanTokenInterfaceManagement = {
initialize: (
args: { admin: string; decimal: u32; name: string; symbol: string } & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>
setAdmin: (
args: {
id: string
new_admin: string
} & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>

admin: (args: TransactionInvocation) => Promise<string>

Expand All @@ -36,36 +37,42 @@ export type SorobanTokenInterfaceManagement = {
id: string
authorize: boolean
} & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>

mint: (
args: {
to: string
amount: i128
} & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>

clawback: (
args: {
from: string
amount: i128
} & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>
}

export type SorobanTokenInterfaceUser = {
allowance: (args: { from: string; spender: string } & SorobanSimulationInvocation) => Promise<i128>
approve: (
args: { from: string; spender: string; amount: i128; expiration_ledger: u32 } & TransactionInvocation
) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>
balance: (args: { id: string } & SorobanSimulationInvocation) => Promise<i128>
spendableBalance: (args: { id: string } & SorobanSimulationInvocation) => Promise<i128>
transfer: (args: { from: string; to: string; amount: i128 } & TransactionInvocation) => Promise<void>
transfer: (
args: { from: string; to: string; amount: i128 } & TransactionInvocation
) => Promise<SorobanTransactionPipelineOutputSimple>
transferFrom: (
args: { spender: string; from: string; to: string; amount: i128 } & TransactionInvocation
) => Promise<void>
burn: (args: { from: string; amount: i128 } & TransactionInvocation) => Promise<void>
burnFrom: (args: { spender: string; from: string; amount: i128 } & TransactionInvocation) => Promise<void>
) => Promise<SorobanTransactionPipelineOutputSimple>
burn: (
args: { from: string; amount: i128 } & TransactionInvocation
) => Promise<SorobanTransactionPipelineOutputSimple>
burnFrom: (
args: { spender: string; from: string; amount: i128 } & TransactionInvocation
) => Promise<SorobanTransactionPipelineOutputSimple>
decimals: (args: SorobanSimulationInvocation) => Promise<u32>
name: (args: SorobanSimulationInvocation) => Promise<string>
symbol: (args: SorobanSimulationInvocation) => Promise<string>
Expand Down
Loading
Loading