@lfdecentralizedtrust/paladin-sdk 0.13.0-rc.1

package/src/interfaces/transaction.ts

@@ -0,0 +1,179 @@
+import { BigNumberish, ethers } from "ethers";
+import { NotoUnlockPublicParams } from "../domains/noto";
+import { IStateBase } from "./states";
+
+export interface IBlock {
+  number: number;
+  hash: string;
+  timestamp: string;
+}
+
+export enum TransactionType {
+  PUBLIC = "public",
+  PRIVATE = "private",
+}
+
+export interface PublicTxOptions {
+  gas?: BigNumberish;
+  value?: BigNumberish;
+  maxPriorityFeePerGas?: BigNumberish;
+  maxFeePerGas?: BigNumberish;
+}
+
+export interface ITransactionBase {
+  type: TransactionType;
+  domain?: string;
+  function?: string;
+  from: string;
+  to?: string;
+  data: {
+    [key: string]: any;
+  };
+}
+
+export interface ITransaction extends ITransactionBase {
+  id: string;
+  created: string;
+  abiReference: string;
+}
+
+export interface IPreparedTransaction {
+  id: string;
+  domain: string;
+  to: string;
+  transaction: ITransactionBase & {
+    abiReference: string;
+  };
+  states: {
+    spent?: IStateBase[];
+    read?: IStateBase[];
+    confirmed?: IStateBase[];
+    info?: IStateBase[];
+  };
+  metadata: any;
+}
+
+export interface ITransactionInput extends ITransactionBase {
+  abiReference?: string;
+  abi?: ethers.InterfaceAbi;
+  bytecode?: string;
+}
+
+export interface ITransactionCall extends ITransactionInput {}
+
+export interface ITransactionReceipt {
+  blockNumber: number;
+  id: string;
+  sequence: number;
+  success: boolean;
+  transactionHash: string;
+  source: string;
+  domain?: string;
+  contractAddress?: string;
+  states?: ITransactionStates;
+  domainReceipt?: IPenteDomainReceipt | INotoDomainReceipt;
+  failureMessage?: string;
+}
+
+export interface IPenteDomainReceipt {
+  receipt: {
+    from?: string;
+    to?: string;
+    contractAddress?: string;
+    logs?: IPenteLog[];
+  };
+}
+
+export interface IPenteLog {
+  address: string;
+  topics: string[];
+  data: string;
+}
+
+export interface INotoDomainReceipt {
+  states: {
+    inputs?: IReceiptState<INotoCoin>[];
+    outputs?: IReceiptState<INotoCoin>[];
+    readInputs?: IReceiptState<INotoCoin>[];
+    preparedOutputs?: IReceiptState<INotoCoin>[];
+
+    lockedInputs?: IReceiptState<INotoLockedCoin>[];
+    lockedOutputs?: IReceiptState<INotoLockedCoin>[];
+    readLockedInputs?: IReceiptState<INotoLockedCoin>[];
+    preparedLockedOutputs?: IReceiptState<INotoLockedCoin>[];
+  };
+  transfers?: {
+    from?: string;
+    to?: string;
+    amount: string;
+  }[];
+  lockInfo?: {
+    lockId: string;
+    delegate?: string;
+    unlockParams?: NotoUnlockPublicParams;
+    unlockCall?: string;
+  };
+  data?: string;
+}
+
+export interface IReceiptState<T> {
+  id: string;
+  data: T;
+}
+
+export interface INotoCoin {
+  salt: string;
+  owner: string;
+  amount: string;
+}
+
+export interface INotoLockedCoin {
+  lockId: string;
+  salt: string;
+  owner: string;
+  amount: string;
+}
+
+export interface ITransactionStates {
+  none?: boolean;
+  spent?: IStateBase[];
+  read?: IStateBase[];
+  confirmed?: IStateBase[];
+  info?: IStateBase[];
+  unavailable?: {
+    spent?: string[];
+    read?: string[];
+    confirmed?: string[];
+    info?: string[];
+  };
+}
+
+export enum TransactionType {
+  Private = "private",
+  Public = "public",
+}
+
+export interface IABIDecodedData {
+  signature: string;
+  definition: ethers.JsonFragment;
+  data: any;
+  summary: string; // errors only
+}
+
+export interface IStoredABI {
+  hash: string;
+  abi: ethers.InterfaceAbi;
+}
+
+export interface ITransactionReceiptListener {
+  name: string;
+  filters?: {
+    sequenceAbove?: number;
+    type?: TransactionType;
+    domain?: string;
+  };
+  options?: {
+    domainReceipts?: boolean;
+    incompleteStateReceiptBehavior?: "block_contract" | "process";
+  };
+}

package/src/interfaces/transport.ts

@@ -0,0 +1,35 @@
+export interface IPeerInfo {
+  name: string;
+  stats: IPeerStats;
+  activated: string;
+  outboundTransport?: string;
+  outbound?: any;
+  outboundError?: any;
+}
+
+export interface IPeerStats {
+  sentMsgs: number;
+  receivedMsgs: number;
+  sentBytes: number;
+  receivedBytes: number;
+  lastSend?: string;
+  lastReceive?: string;
+  reliableHighestSent: number;
+  reliableAckBase: number;
+}
+
+export interface IReliableMessage {
+  sequence: number;
+  id: string;
+  created: string;
+  node: string;
+  messageType: string;
+  metadata: any;
+  ack?: IReliableMessageAck;
+}
+
+export interface IReliableMessageAck {
+  messageId: string;
+  time?: string;
+  error?: string;
+} 

package/src/interfaces/verifiers.ts

@@ -0,0 +1,6 @@
+export enum Verifiers {
+  ETH_ADDRESS = "eth_address",
+  ETH_ADDRESS_CHECKSUM = "eth_address_checksum",
+  HEX_ECDSA_PUBKEY_UNCOMPRESSED = "hex_ecdsa_pubkey_uncompressed",
+  HEX_ECDSA_PUBKEY_UNCOMPRESSED_0X = "hex_ecdsa_pubkey_uncompressed_0x",
+}

package/src/interfaces/websocket.ts

@@ -0,0 +1,67 @@
+import * as http from "http";
+import WebSocket from "ws";
+import { IEventWithData } from "./blockindex";
+import { Logger } from "./logger";
+import { ITransactionReceipt } from "./transaction";
+import { IPrivacyGroupMessage } from "./privacygroups";
+
+export interface WebSocketSender {
+  send: (json: object) => void;
+  ack: (subscription: string) => void;
+}
+
+export interface WebSocketConnectCallback {
+  (sender: WebSocketSender): void | Promise<void>;
+}
+
+export interface WebSocketEventCallback<TEvent> {
+  (sender: WebSocketSender, event: TEvent): void | Promise<void>;
+}
+
+export interface WebSocketClientOptions<TMessageTypes extends string> {
+  url: string;
+  username?: string;
+  password?: string;
+  subscriptions?: WebSocketSubscription<TMessageTypes>[];
+  logger?: Logger;
+  heartbeatInterval?: number;
+  reconnectDelay?: number;
+  afterConnect?: WebSocketConnectCallback;
+  socketOptions?: WebSocket.ClientOptions | http.ClientRequestArgs;
+}
+
+export interface WebSocketSubscription<TMessageTypes extends string> {
+  type: TMessageTypes;
+  name: string;
+}
+
+export interface WebSocketEvent {
+  method: "ptx_subscription" | undefined;
+  params: {
+    subscription: string;
+    result: TransactionReceiptBatch | TransactionEventBatch;
+  };
+}
+
+export interface TransactionReceiptBatch {
+  batchId: number;
+  receipts: ITransactionReceipt[];
+}
+
+export interface TransactionEventBatch {
+  batchId: number;
+  events: IEventWithData[];
+}
+
+export interface PrivacyGroupWebSocketEvent {
+  method: "pgroup_subscription" | undefined;
+  params: {
+    subscription: string;
+    result: IPrivacyGroupMessageBatch;
+  };
+}
+
+export interface IPrivacyGroupMessageBatch {
+  batchId: number;
+  messages: IPrivacyGroupMessage[];
+}