Protocol

interface ProtocolConfig {
  version: string;
  defaultPrefix: string;
  codeTTL: number;
  codeLength: number;
  maxPrefixLength: number;
  minPrefixLength: number;
}

new ActionCodesProtocol(config?: Partial<ProtocolConfig>)

registerAdapter<T>(adapter: BaseChainAdapter<T>): void

getRegisteredChains(): string[]

isChainSupported(chain: string): boolean

getChainAdapter<T = any>(chain: string): BaseChainAdapter<T> | undefined

validateActionCode(actionCode: ActionCode): boolean

async createActionCode(
  pubkey: string,
  signFn: (message: string) => Promise<string>,
  chain: SupportedChain,
  prefix?: string,
  timestamp?: number
): Promise<ActionCode>

attachTransaction(
  actionCode: ActionCode,
  transaction: string,
  issuer: string,
  params?: string,
  txType?: string
): ActionCode

attachMessage(
  actionCode: ActionCode,
  message: string,
  params?: string,
  messageType?: string
): ActionCode

finalizeActionCode(actionCode: ActionCode, signature: string): ActionCode

createProtocolMeta(
  actionCode: ActionCode,
  issuer?: string,
  params?: string,
  timestamp?: number
): ProtocolMetaV1

encodeProtocolMeta(meta: ProtocolMetaV1, chain: string): any

decodeProtocolMeta(transaction: any, chain: string): ProtocolMetaV1 | null

validateTransaction(
  transaction: any,
  chain: string,
  authorities: string[],
  expectedPrefix?: string
): boolean

validateTransactionTyped<T>(
  transaction: T,
  chain: string,
  authorities: string[],
  expectedPrefix?: string
): boolean

detectTampering<T>(
  transaction: T,
  chain: string,
  authorities: string[],
  expectedPrefix?: string
): boolean

decodeProtocolMetaTyped<T>(transaction: T, chain: string): ProtocolMetaV1 | null

getConfig(): ProtocolConfig

updateConfig(updates: Partial<ProtocolConfig>): void

static create(): ActionCodesProtocol

static createWithConfig(config: Partial<ProtocolConfig>): ActionCodesProtocol

import { ActionCodesProtocol } from "@actioncodes/protocol";

const protocol = ActionCodesProtocol.create();
protocol.registerAdapter(myChainAdapter);

const actionCode = await protocol.createActionCode(pubkey, signFn, "solana");