Merge pull request #808 from TokenScript/feat/outlet-ticket-remove

feat: Add ticket delete method and various other improvements

Author: nicktaras

src/client/index.ts

@@ -1094,7 +1094,7 @@ export class Client {
 	) {
 		requiredParams(type, 'Event type is not defined')
 
-		if ((type === 'tokens' || type === 'tokens-selected') && callback) {
+		if (type === 'tokens-selected' && callback) {
 			this.readTokensFromUrl()
 		}
 

src/client/interface.ts

@@ -5,6 +5,7 @@ import { BrowserDataInterface } from '../utils/support/isSupported'
 import { WalletConnection } from '../wallet/Web3WalletProvider'
 import { DecodedToken } from '../outlet/ticketStorage'
 import { EasSchemaConfig } from '../outlet/interfaces'
+import { TokenData } from './tokenStore'
 
 export type SupportedBlockchainsParam = 'evm' | 'flow' | 'solana' | 'ultra'
 export const SignatureSupportedBlockchainsParamList = ['evm', 'flow', 'solana', 'ultra']
@@ -117,7 +118,6 @@ export interface TokenNegotiatorEventsArgs {
 	'connected-wallet': EventSenderConnectedWallet
 	'disconnected-wallet': EventSenderDisconnectedWallet
 	'tokens-selected': EventSenderTokensSelected
-	tokens: EventSenderTokens
 	'tokens-loaded': EventSenderTokensLoaded
 	'network-change': string
 	error: EventSenderError
@@ -150,11 +150,11 @@ export interface EventSenderViewChanged {
 }
 
 export interface EventSenderTokensSelected {
-	selectedTokens: Object
-}
-
-export interface EventSenderTokens {
-	data: any[]
+	selectedTokens: {
+		[collectionId: string]: {
+			tokens: DecodedToken[] | TokenData[]
+		}
+	}
 }
 
 export interface EventSenderTokensLoaded {

src/client/tokenStore.ts

@@ -1,6 +1,7 @@
 import { OffChainTokenConfig, OnChainIssuer, OnChainTokenConfig, SolanaIssuerConfig, UltraIssuerConfig } from './interface'
 
 import { logger } from '../utils'
+import { DecodedToken } from '../outlet/ticketStorage'
 
 interface IssuerLookup {
 	[collectionID: string]: TokenConfig & { timestamp: number }
@@ -10,14 +11,17 @@ interface TokenLookup {
 	[issuer: string]: { timestamp: number; tokens: TokenData[] | null }
 }
 
-interface TokenData {
+export interface TokenData {
+	tokenId: string | number
 	walletAddress?: string
 	// TODO: add more common fields to this interface
 	[key: string]: any
 }
 
 type TokenConfig = OnChainTokenConfig | OffChainTokenConfig | SolanaIssuerConfig | UltraIssuerConfig
 
+type SelectedTokens = { [collectionId: string]: { tokens: DecodedToken[] | TokenData[] } }
+
 export class TokenStore {
 	public static LOCAL_STORAGE_KEY = 'tn-tokenStore'
 
@@ -28,7 +32,7 @@ export class TokenStore {
 	private tokenLookup: IssuerLookup = {}
 
 	// TODO: change to disabled tokens
-	private selectedTokens: any = {}
+	private selectedTokens: SelectedTokens = {}
 
 	constructor(
 		private autoEnableTokens: boolean,
@@ -173,7 +177,7 @@ export class TokenStore {
 		return null
 	}
 
-	public setTokens(issuer: string, tokens: TokenData[]) {
+	public setTokens(issuer: string, tokens: TokenData[] | DecodedToken[]) {
 		this.tokenData[issuer] = { timestamp: Date.now(), tokens }
 
 		this.saveTokenStore()
@@ -185,7 +189,7 @@ export class TokenStore {
 		return this.selectedTokens
 	}
 
-	public setSelectedTokens(selectedTokens: any) {
+	public setSelectedTokens(selectedTokens: SelectedTokens) {
 		this.selectedTokens = selectedTokens
 	}
 

src/client/views/token-list.ts

@@ -110,8 +110,7 @@ export class TokenList extends AbstractView {
 
 		this.viewContainer.querySelectorAll('.mobileToggle-tn').forEach((token: any, index: number) => {
 			if (index === 0) {
-				selectedTokens[token.dataset.key] = {}
-				selectedTokens[token.dataset.key]['tokens'] = []
+				selectedTokens[token.dataset.key] = { tokens: [] }
 			}
 
 			if (token.checked === true) {

src/outlet/localOutlet.ts

@@ -6,7 +6,7 @@ import { MultiTokenAuthRequest, MultiTokenAuthResult, OutletInterface, OutletIss
 import { OutletAction } from '../client/messaging'
 
 export class LocalOutlet {
-	protected ticketStorage: TicketStorage
+	public readonly ticketStorage: TicketStorage
 
 	constructor(config: OutletInterface) {
 		this.ticketStorage = new TicketStorage(config)

src/outlet/ticketStorage.ts

@@ -71,7 +71,7 @@ export interface EasFieldData {
 }
 
 interface TicketStorageSchema {
-	[collectionHash: string]: StoredTicketRecord[]
+	[collectionHash: string]: Array<StoredTicketRecord>
 }
 
 export interface FilterInterface {
@@ -167,6 +167,24 @@ export class TicketStorage {
 		})
 	}
 
+	public deleteTicketByDecodedTokenOrId(collectionId: string, decodedTokenOrId: DecodedToken | string) {
+		const config = this.config.issuers.find((issuer) => issuer.collectionID === collectionId)
+		const hashes = createIssuerHashArray(config)
+		const tokenId = typeof decodedTokenOrId === 'string' ? decodedTokenOrId : decodedTokenOrId.tokenId
+
+		for (const hash of hashes) {
+			for (let i = 0; i < this.ticketCollections[hash].length; i++) {
+				if (tokenId === this.ticketCollections[hash][0].tokenId) {
+					this.ticketCollections[hash].splice(i, 1)
+					this.storeTickets()
+					return true
+				}
+			}
+		}
+
+		return false
+	}
+
 	/**
 	 * Take in a request of collection hashes and return the returns, keyed by client provided ID
 	 * @param request