SPLT | @senswap/sen-js

Hierarchy

Tx
- SPLT

Index

Constructors

constructor

Properties

Constructors

constructor

new SPLT(spltProgramAddress?: string, splataProgramAddress?: string, nodeUrl: string): SPLT

Overrides Tx.constructor
- Defined in splt.ts:77
Parameters
- spltProgramAddress: string = ...
- splataProgramAddress: string = ...
- nodeUrl: string
Returns SPLT

Properties

connection

connection: Connection

nodeUrl

nodeUrl: string

splataProgramId

splataProgramId: PublicKey

spltProgramId

spltProgramId: PublicKey

Static AuthorityType

AuthorityType: { get AccountOwner(): number; get CloseAccount(): number; get FreezeAccount(): number; get MintTokens(): number } = ...

Type declaration

get AccountOwner(): number
get CloseAccount(): number
get FreezeAccount(): number
get MintTokens(): number

Methods

approve

approve(amount: bigint, srcAddress: string, delegateAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:487
Authorize a person can use your token

Parameters
- amount: bigint
  
  The decimalized amount
- srcAddress: string
  
  The source address
- delegateAddress: string
  
  The delegate address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

burn

burn(amount: bigint, srcAddress: string, mintAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:685
Burn tokens

Parameters
- amount: bigint
  
  The decimalized amount
- srcAddress: string
  
  The token source address to burn
- mintAddress: string
  
  The mint address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

closeAccount

closeAccount(targetAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:733
Close an account

Parameters
- targetAddress: string
  
  The target account address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

deriveAssociatedAddress

deriveAssociatedAddress(walletAddress: string, mintAddress: string): Promise<string>

- Defined in splt.ts:100
Derive associated account of wallet address for a mint address

Parameters
- walletAddress: string
- mintAddress: string
Returns Promise<string>

An associated address

freezeAccount

freezeAccount(targetAddress: string, mintAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:774
Freeze an account

Parameters
- targetAddress: string
  
  The target account address
- mintAddress: string
  
  The mint address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

getAccountData

getAccountData(accountAddress: string): Promise<AccountData>

- Defined in splt.ts:218
Get account data

Parameters
- accountAddress: string
Returns Promise<AccountData>

getMintData

getMintData(mintAddress: string): Promise<MintData>

- Defined in splt.ts:193
Get mint data

Parameters
- mintAddress: string
Returns Promise<MintData>

getMultiSigData

getMultiSigData(multiSigAddress: string): Promise<MultisigData>

- Defined in splt.ts:245
Get multisig data

Parameters
- multiSigAddress: string
Returns Promise<MultisigData>

initializeAccount

initializeAccount(mintAddress: string, ownerAddress: string, wallet: WalletInterface): Promise<{ accountAddress: string; txId: string }>

- Defined in splt.ts:327
Initilize an new account of a token

Parameters
- mintAddress: string
- ownerAddress: string
- wallet: WalletInterface
Returns Promise<{ accountAddress: string; txId: string }>

The new account address and transaction id

initializeMint

initializeMint(decimals: number, mintAuthorityAddress: string, freezeAuthorityAddress: null | string, mint: Keypair, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:264
Initiliza a new token

Parameters
- decimals: number
- mintAuthorityAddress: string
- freezeAuthorityAddress: null | string
  
  (optional) the one who can freeze accounts
- mint: Keypair
- wallet: WalletInterface
Returns Promise<{ txId: string }>

Transaction id

initializeMultiSig

initializeMultiSig(minimumSig: number, signerAddresses: string[], multiSig: Keypair, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:379
Initialize a multisig account (No testing yet)

Parameters
- minimumSig: number
  
  The minimum signers for a consensus
- signerAddresses: string[]
  
  List of signers
- multiSig: Keypair
  
  Multisign account
- wallet: WalletInterface
Returns Promise<{ txId: string }>

Transaction id

mintTo

mintTo(amount: bigint, mintAddress: string, dstAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:635
Mint more tokens

Parameters
- amount: bigint
  
  The decimalized minted amount
- mintAddress: string
  
  The mint address
- dstAddress: string
- wallet: WalletInterface
Returns Promise<{ txId: string }>

parseAccountData

parseAccountData(data: Buffer): AccountData

- Defined in splt.ts:206
Parse account buffer data

Parameters
- data: Buffer
Returns AccountData

parseMintData

parseMintData(data: Buffer): MintData

- Defined in splt.ts:181
Parse mint buffer data

Parameters
- data: Buffer
Returns MintData

parseMultiSigData

parseMultiSigData(data: Buffer): MultisigData

- Defined in splt.ts:233
Parse multisig buffer data

Parameters
- data: Buffer
Returns MultisigData

revoke

revoke(srcAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:536
Revoke an authorization of token usage

Parameters
- srcAddress: string
  
  The source address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

setAuthority

setAuthority(authorityType: number, newAuthorityAddress: string, targetAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:577
Set authority (onwing, closing) to an account

Parameters
- authorityType: number
  
  2 for Owning Authority, 3 for Closing Authority
- newAuthorityAddress: string
  
  The new authority address
- targetAddress: string
  
  The target account address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

thawAccount

thawAccount(targetAddress: string, mintAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:818
Thaw an account

Parameters
- targetAddress: string
  
  The target account address
- mintAddress: string
  
  The mint address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

transfer

transfer(amount: bigint, srcAddress: string, dstAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:436
Send tokens

Parameters
- amount: bigint
  
  The decimalized amount
- srcAddress: string
  
  The sender address
- dstAddress: string
  
  The receiver address
- wallet: WalletInterface
Returns Promise<{ txId: string }>

Transaction id

unwatch

unwatch(watchId: number): Promise<void>

- Defined in splt.ts:171
Unwatch a watcher by watch id

Parameters
- watchId: number
Returns Promise<void>

unwrap

unwrap(wallet: WalletInterface): Promise<{ txId: string }>

- Defined in splt.ts:895
Unwrap WSOL

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

watch

watch(callback: (error: null | string, data: null | (Omit<SPLTAccountChangeInfo, "data"> & { data: AccountData | MintData | MultisigData })) => void, filters?: GetProgramAccountsFilter[]): number

- Defined in splt.ts:118
Watch account changes

Parameters
- callback: (error: null | string, data: null | (Omit<SPLTAccountChangeInfo, "data"> & { data: AccountData | MintData | MultisigData })) => void
  - - (error: null | string, data: null | (Omit<SPLTAccountChangeInfo, "data"> & { data: AccountData | MintData | MultisigData })): void
    - Parameters
      - error: null | string
      - data: null | (Omit<SPLTAccountChangeInfo, "data"> & { data: AccountData | MintData | MultisigData })
      Returns void
- Optional filters: GetProgramAccountsFilter[]
Returns number

Watch id

wrap

wrap(lamports: number | bigint, ownerAddress: string, wallet: WalletInterface): Promise<{ accountAddress: string; txId: string }>

- Defined in splt.ts:862
Wrap SOL

Parameters
- lamports: number | bigint
  
  The amount of wrapped lamports
- ownerAddress: string
  
  The owner for the wrapped lamports
- wallet: WalletInterface
Returns Promise<{ accountAddress: string; txId: string }>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

spltProgramAddress: string = ...

splataProgramAddress: string = ...

nodeUrl: string

Returns SPLT

Properties

connection

nodeUrl

splataProgramId

spltProgramId

Static AuthorityType

Type declaration

get AccountOwner(): number

get CloseAccount(): number

get FreezeAccount(): number

get MintTokens(): number

Methods

approve

Parameters

amount: bigint

srcAddress: string

delegateAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

burn

Parameters

amount: bigint

srcAddress: string

mintAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

closeAccount

Parameters

targetAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

deriveAssociatedAddress

Parameters

walletAddress: string

mintAddress: string

Returns Promise<string>

freezeAccount

Parameters

targetAddress: string

mintAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

getAccountData

Parameters

accountAddress: string

Returns Promise<AccountData>

getMintData

Parameters

mintAddress: string

Returns Promise<MintData>

getMultiSigData

Parameters

multiSigAddress: string

Returns Promise<MultisigData>

initializeAccount

Parameters

mintAddress: string

ownerAddress: string

wallet: WalletInterface

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

initializeMint

Parameters

decimals: number

mintAuthorityAddress: string

freezeAuthorityAddress: null | string

mint: Keypair

wallet: WalletInterface

Returns Promise<{ txId: string }>