Purchasing | @senswap/sen-js

Hierarchy

Tx
- Purchasing

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Purchasing(purchasingProgramAddress?: string, spltProgramAddress?: string, splataProgramAddress?: string, nodeUrl: string): Purchasing

Overrides Tx.constructor
- Defined in purchasing/index.ts:37
Parameters
- purchasingProgramAddress: string = ...
- spltProgramAddress: string = ...
- splataProgramAddress: string = ...
- nodeUrl: string
Returns Purchasing

Properties

connection

connection: Connection

nodeUrl

nodeUrl: string

purchasingProgramId

purchasingProgramId: PublicKey

splataProgramId

splataProgramId: PublicKey

spltProgramId

spltProgramId: PublicKey

Methods

approveOrder

approveOrder(orderAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:602
Approve an order

Parameters
- orderAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

cancelOrder

cancelOrder(orderAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:401
Cancel an order

Parameters
- orderAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

deriveOrderAddress

deriveOrderAddress(index: number, ownerAddress: string, retailerAddress: string): Promise<string>

- Defined in purchasing/index.ts:177
Derive order address

Parameters
- index: number
  
  Account index (MAX: 4294967296)
- ownerAddress: string
- retailerAddress: string
  
  Corresponding retailer address to the order account
Returns Promise<string>

Debt account address

freezeRetailer

freezeRetailer(retailerAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:682
Freeze the retailer

Parameters
- retailerAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

getOrderData

getOrderData(orderAddress: string): Promise<OrderData>

- Defined in purchasing/index.ts:160
Get order data

Parameters
- orderAddress: string
  
  Order account address
Returns Promise<OrderData>

Readable json data respect to ORDER_SCHEMA

getRetailerData

getRetailerData(retailerAddress: string): Promise<RetailerData>

- Defined in purchasing/index.ts:133
Get retailer data

Parameters
- retailerAddress: string
  
  Retailer account address
Returns Promise<RetailerData>

Readable json data respect to RETAILER_SCHEMA

initializeRetailer

initializeRetailer(ownerAddress: string, mintBidAddress: string, mintAskAddress: string, wallet: WalletInterface): Promise<{ retailerAddress: string; txId: string }>

- Defined in purchasing/index.ts:230
Initialize retailer

Parameters
- ownerAddress: string
- mintBidAddress: string
- mintAskAddress: string
- wallet: WalletInterface
Returns Promise<{ retailerAddress: string; txId: string }>

parseOrderData

parseOrderData(data: Buffer): OrderData

- Defined in purchasing/index.ts:148
Parse order buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns OrderData

Readable json data respect to ORDER_SCHEMA

parseRetailerData

parseRetailerData(data: Buffer): RetailerData

- Defined in purchasing/index.ts:121
Parse retailer buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns RetailerData

Readable json data respect to RETAILER_SCHEMA

placeOrder

placeOrder(index: number, bidAmount: bigint, askAmount: bigint, lockedTime: bigint, retailerAddress: string, wallet: WalletInterface): Promise<{ orderAddress: string; txId: string }>

- Defined in purchasing/index.ts:318
Place an order

Parameters
- index: number
- bidAmount: bigint
- askAmount: bigint
- lockedTime: bigint
  
  (seconds time unit)
- retailerAddress: string
- wallet: WalletInterface
Returns Promise<{ orderAddress: string; txId: string }>

redeemOrder

redeemOrder(orderAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:467
Redeem an order

Parameters
- orderAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

rejectOrder

rejectOrder(orderAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:533
Reject an order

Parameters
- orderAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

thawRetailer

thawRetailer(retailerAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:720
Thaw the retailer

Parameters
- retailerAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

transferRetailerOwnership

transferRetailerOwnership(retailerAddress: string, newOwnerAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in purchasing/index.ts:761
Transfer retailer's ownership

remarks

Retailer owner only

Parameters
- retailerAddress: string
  
  Retailer address
- newOwnerAddress: string
  
  New owner address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

unwatch

unwatch(watchId: number): Promise<void>

- Defined in purchasing/index.ts:111
Unwatch a watcher by watch id

Parameters
- watchId: number
  
  The watchId was returned by watch function.
Returns Promise<void>

watch

watch(callback: (error: null | string, data: null | (Omit<PurchasingAccountChangeInfo, "data"> & { data: RetailerData | OrderData })) => void, filters?: GetProgramAccountsFilter[]): number

- Defined in purchasing/index.ts:63
Watch account changes

Parameters
- callback: (error: null | string, data: null | (Omit<PurchasingAccountChangeInfo, "data"> & { data: RetailerData | OrderData })) => void
  
  The callback will be called when there is any change
  - - (error: null | string, data: null | (Omit<PurchasingAccountChangeInfo, "data"> & { data: RetailerData | OrderData })): void
    - Parameters
      - error: null | string
      - data: null | (Omit<PurchasingAccountChangeInfo, "data"> & { data: RetailerData | OrderData })
      Returns void
- Optional filters: GetProgramAccountsFilter[]
  
  GetProgramAccountsFilter - Ref: https://solana-labs.github.io/solana-web3.js/modules.html#GetProgramAccountsFilter
Returns number

Watch id

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

purchasingProgramAddress: string = ...

spltProgramAddress: string = ...

splataProgramAddress: string = ...

nodeUrl: string

Returns Purchasing

Properties

connection

nodeUrl

purchasingProgramId

splataProgramId

spltProgramId

Methods

approveOrder

Parameters

orderAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

cancelOrder

Parameters

orderAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

deriveOrderAddress

Parameters

index: number

ownerAddress: string

retailerAddress: string

Returns Promise<string>

freezeRetailer

Parameters

retailerAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

getOrderData

Parameters

orderAddress: string

Returns Promise<OrderData>

getRetailerData

Parameters

retailerAddress: string

Returns Promise<RetailerData>

initializeRetailer

Parameters

ownerAddress: string

mintBidAddress: string

mintAskAddress: string

wallet: WalletInterface

Returns Promise<{ retailerAddress: string; txId: string }>

parseOrderData

Parameters

data: Buffer

Returns OrderData

parseRetailerData

Parameters

data: Buffer

Returns RetailerData

placeOrder

Parameters

index: number

bidAmount: bigint

askAmount: bigint

lockedTime: bigint

retailerAddress: string

wallet: WalletInterface

Returns Promise<{ orderAddress: string; txId: string }>

redeemOrder

Parameters

orderAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

rejectOrder

Parameters