@lfdecentralizedtrust/paladin-sdk 1.0.0-rc.0 → 1.0.0-rc.2

package/build/domains/zeto.js

@@ -143,7 +143,7 @@ class ZetoInstance {
     }
     delegateLock(from, data) {
         return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
-            type: interfaces_1.TransactionType.Public,
+            type: interfaces_1.TransactionType.PUBLIC,
             abi: zetoPublicAbi,
             function: "delegateLock",
             to: this.address,

package/build/interfaces/domains.d.ts

@@ -1,9 +1,17 @@
+export interface IDomainConfig {
+    signingAlgorithms?: Record<string, number>;
+}
 export interface IDomain {
     name: string;
     registryAddress: string;
+    config?: IDomainConfig;
+}
+export interface IContractConfig {
+    contractConfig?: object;
 }
 export interface IDomainSmartContract {
     domainName: string;
     domainAddress: string;
     address: string;
+    config?: IContractConfig;
 }

package/build/interfaces/index.d.ts

@@ -8,6 +8,7 @@ export * from "./paladin";
 export * from "./privacygroups";
 export * from "./query";
 export * from "./registry";
+export * from "./signpayloads";
 export * from "./states";
 export * from "./transaction";
 export * from "./transport";

package/build/interfaces/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./paladin"), exports);
 __exportStar(require("./privacygroups"), exports);
 __exportStar(require("./query"), exports);
 __exportStar(require("./registry"), exports);
+__exportStar(require("./signpayloads"), exports);
 __exportStar(require("./states"), exports);
 __exportStar(require("./transaction"), exports);
 __exportStar(require("./transport"), exports);

package/build/interfaces/privacygroups.d.ts

@@ -46,6 +46,7 @@ export interface IPrivacyGroupEVMTXInput extends IPrivacyGroupEVMTX {
 export interface IPrivacyGroupEVMCall extends IPrivacyGroupEVMTX {
     domain: string;
     group: string;
+    block?: BigNumberish | string;
     dataFormat?: string;
 }
 export interface IPrivacyGroupMessageListener {

package/build/interfaces/signpayloads.d.ts

@@ -0,0 +1,3 @@
+export declare enum SignPayloads {
+    OPAQUE_TO_RSV = "opaque:rsv"
+}

package/build/interfaces/signpayloads.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SignPayloads = void 0;
+var SignPayloads;
+(function (SignPayloads) {
+    SignPayloads["OPAQUE_TO_RSV"] = "opaque:rsv";
+})(SignPayloads || (exports.SignPayloads = SignPayloads = {}));

package/build/interfaces/states.d.ts

@@ -25,6 +25,7 @@ export interface IStateEncoded {
 }
 export interface IState extends IStateBase {
     confirmed?: IStateConfirm;
+    read?: IStateRead;
     spent?: IStateSpend;
     locks?: IStateLock[];
     nullifier?: IStateNullifier;
@@ -44,6 +45,9 @@ export interface IStateInt64Label {
 export interface IStateConfirm {
     transaction: string;
 }
+export interface IStateRead {
+    transaction: string;
+}
 export interface IStateSpend {
     transaction: string;
 }

package/build/interfaces/transaction.d.ts

@@ -16,7 +16,11 @@ export interface PublicTxOptions {
     maxPriorityFeePerGas?: BigNumberish;
     maxFeePerGas?: BigNumberish;
 }
+export interface PublicCallOptions {
+    block?: BigNumberish | string;
+}
 export interface ITransactionBase {
+    idempotencyKey?: string;
     type: TransactionType;
     domain?: string;
     function?: string;
@@ -26,10 +30,12 @@ export interface ITransactionBase {
         [key: string]: any;
     };
 }
+export type SubmitMode = "auto" | "external" | "call" | "prepare";
 export interface ITransaction extends ITransactionBase {
     id: string;
     created: string;
     abiReference: string;
+    submitMode?: SubmitMode;
 }
 export interface IPreparedTransaction {
     id: string;
@@ -50,8 +56,10 @@ export interface ITransactionInput extends ITransactionBase {
     abiReference?: string;
     abi?: ethers.InterfaceAbi;
     bytecode?: string;
+    dependsOn?: string[];
 }
-export interface ITransactionCall extends ITransactionInput {
+export interface ITransactionCall extends ITransactionInput, PublicCallOptions {
+    dataFormat?: string;
 }
 export interface ITransactionReceipt {
     blockNumber: number;
@@ -131,10 +139,6 @@ export interface ITransactionStates {
         info?: string[];
     };
 }
-export declare enum TransactionType {
-    Private = "private",
-    Public = "public"
-}
 export interface IABIDecodedData {
     signature: string;
     definition: ethers.JsonFragment;

package/build/interfaces/transaction.js

@@ -6,7 +6,3 @@ var TransactionType;
     TransactionType["PUBLIC"] = "public";
     TransactionType["PRIVATE"] = "private";
 })(TransactionType || (exports.TransactionType = TransactionType = {}));
-(function (TransactionType) {
-    TransactionType["Private"] = "private";
-    TransactionType["Public"] = "public";
-})(TransactionType || (exports.TransactionType = TransactionType = {}));

package/build/paladin.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { ethers, InterfaceAbi } from "ethers";
-import { ActiveFilter, Algorithms, IABIDecodedData, IBlockchainEventListener, IEthAddress, IEventWithData, IKeyMappingAndVerifier, IKeyQueryEntry, INotoDomainReceipt, IPenteDomainReceipt, IPreparedTransaction, IPrivacyGroup, IPrivacyGroupEVMCall, IPrivacyGroupEVMTXInput, IPrivacyGroupInput, IPrivacyGroupMessageInput, IPrivacyGroupMessageListener, IQuery, IRegistryEntry, IRegistryEntryWithProperties, IRegistryProperty, ISchema, IState, IStoredABI, ITransaction, ITransactionCall, ITransactionInput, ITransactionReceipt, ITransactionReceiptListener, ITransactionStates, IWalletInfo, PaladinConfig, StateStatus, Verifiers } from "./interfaces";
+import { ActiveFilter, Algorithms, IABIDecodedData, IBlockchainEventListener, IDomain, IDomainSmartContract, IEthAddress, IEventWithData, IKeyMappingAndVerifier, IKeyQueryEntry, INotoDomainReceipt, IPenteDomainReceipt, IPreparedTransaction, IPrivacyGroup, IPrivacyGroupEVMCall, IPrivacyGroupEVMTXInput, IPrivacyGroupInput, IPrivacyGroupMessageInput, IPrivacyGroupMessageListener, IQuery, IRegistryEntry, IRegistryEntryWithProperties, IRegistryProperty, ISchema, IState, IStoredABI, ITransaction, ITransactionCall, ITransactionInput, ITransactionReceipt, ITransactionReceiptListener, ITransactionStates, IWalletInfo, PaladinConfig, StateStatus, Verifiers } from "./interfaces";
 import { PaladinVerifier } from "./verifier";
 export default class PaladinClient {
     protected http: AxiosInstance;
@@ -151,6 +151,7 @@ export default class PaladinClient {
         resolveEthAddress: (identifier: string) => Promise<IEthAddress>;
         reverseKeyLookup: (algorithm: string, verifierType: string, verifier: string) => Promise<IKeyMappingAndVerifier>;
         queryKeys: (query: IQuery) => Promise<IKeyQueryEntry[]>;
+        sign: (keyIdentifier: string, algorithm: string, verifierType: string, payloadType: string, payload: string) => Promise<string>;
     };
     ptx: {
         sendTransaction: (transaction: ITransactionInput) => Promise<string>;
@@ -236,10 +237,10 @@ export default class PaladinClient {
     };
     domain: {
         listDomains: () => Promise<string[]>;
-        getDomain: (name: string) => Promise<any>;
-        getDomainByAddress: (address: string) => Promise<any>;
-        querySmartContracts: (query: IQuery) => Promise<any[]>;
-        getSmartContractByAddress: (address: string) => Promise<any>;
+        getDomain: (name: string) => Promise<IDomain | undefined>;
+        getDomainByAddress: (address: string) => Promise<IDomain | undefined>;
+        querySmartContracts: (query: IQuery) => Promise<IDomainSmartContract[]>;
+        getSmartContractByAddress: (address: string) => Promise<IDomainSmartContract | undefined>;
     };
     bidx: {
         getBlockByNumber: (number: number) => Promise<any>;

package/build/paladin.js

@@ -49,6 +49,10 @@ class PaladinClient {
                 const res = await this.post("keymgr_queryKeys", [query]);
                 return res.data.result;
             },
+            sign: async (keyIdentifier, algorithm, verifierType, payloadType, payload) => {
+                const res = await this.post("keymgr_sign", [keyIdentifier, algorithm, verifierType, payloadType, payload]);
+                return res.data.result;
+            },
         };
         this.ptx = {
             sendTransaction: async (transaction) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lfdecentralizedtrust/paladin-sdk",
-  "version": "1.0.0-rc.0",
+  "version": "1.0.0-rc.2",
   "description": "",
   "main": "build/index.js",
   "scripts": {
@@ -19,12 +19,12 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "ethers": "^6.13.4",
     "uuid": "^11.0.2",
     "ws": "^8.18.1"
   },
   "peerDependencies": {
-    "axios": "^1.7.7"
+    "axios": "^1.7.7",
+    "ethers": "^6.13.4"
   },
   "repository": {
     "url": "https://github.com/LFDT-Paladin/paladin"

package/src/domains/zeto.ts

@@ -208,7 +208,7 @@ export class ZetoInstance {
     return new TransactionFuture(
       this.paladin,
       this.paladin.sendTransaction({
-        type: TransactionType.Public,
+        type: TransactionType.PUBLIC,
         abi: zetoPublicAbi,
         function: "delegateLock",
         to: this.address,

package/src/interfaces/domains.ts

@@ -1,10 +1,20 @@
+export interface IDomainConfig {
+  signingAlgorithms?: Record<string, number>;
+}
+
 export interface IDomain {
   name: string;
   registryAddress: string;
+  config?: IDomainConfig;
+}
+
+export interface IContractConfig {
+  contractConfig?: object;
 }
 
 export interface IDomainSmartContract {
   domainName: string;
   domainAddress: string;
   address: string;
+  config?: IContractConfig;
 } 

package/src/interfaces/index.ts

@@ -8,6 +8,7 @@ export * from "./paladin";
 export * from "./privacygroups";
 export * from "./query";
 export * from "./registry";
+export * from "./signpayloads";
 export * from "./states";
 export * from "./transaction";
 export * from "./transport";

package/src/interfaces/privacygroups.ts

@@ -53,6 +53,7 @@ export interface IPrivacyGroupEVMTXInput extends IPrivacyGroupEVMTX {
 export interface IPrivacyGroupEVMCall extends IPrivacyGroupEVMTX {
   domain: string;
   group: string;
+  block?: BigNumberish | string;
   dataFormat?: string;
 }
 

package/src/interfaces/signpayloads.ts

@@ -0,0 +1,3 @@
+export enum SignPayloads {
+  OPAQUE_TO_RSV = "opaque:rsv",
+}

package/src/interfaces/states.ts

@@ -29,6 +29,7 @@ export interface IStateEncoded {
 
 export interface IState extends IStateBase {
   confirmed?: IStateConfirm;
+  read?: IStateRead;
   spent?: IStateSpend;
   locks?: IStateLock[];
   nullifier?: IStateNullifier;
@@ -52,6 +53,10 @@ export interface IStateConfirm {
   transaction: string;
 }
 
+export interface IStateRead {
+  transaction: string;
+}
+
 export interface IStateSpend {
   transaction: string;
 }

package/src/interfaces/transaction.ts

@@ -20,7 +20,12 @@ export interface PublicTxOptions {
   maxFeePerGas?: BigNumberish;
 }
 
+export interface PublicCallOptions {
+  block?: BigNumberish | string;
+}
+
 export interface ITransactionBase {
+  idempotencyKey?: string;
   type: TransactionType;
   domain?: string;
   function?: string;
@@ -31,10 +36,13 @@ export interface ITransactionBase {
   };
 }
 
+export type SubmitMode = "auto" | "external" | "call" | "prepare";
+
 export interface ITransaction extends ITransactionBase {
   id: string;
   created: string;
   abiReference: string;
+  submitMode?: SubmitMode;
 }
 
 export interface IPreparedTransaction {
@@ -57,9 +65,12 @@ export interface ITransactionInput extends ITransactionBase {
   abiReference?: string;
   abi?: ethers.InterfaceAbi;
   bytecode?: string;
+  dependsOn?: string[];
 }
 
-export interface ITransactionCall extends ITransactionInput {}
+export interface ITransactionCall extends ITransactionInput, PublicCallOptions {
+  dataFormat?: string;
+}
 
 export interface ITransactionReceipt {
   blockNumber: number;
@@ -148,11 +159,6 @@ export interface ITransactionStates {
   };
 }
 
-export enum TransactionType {
-  Private = "private",
-  Public = "public",
-}
-
 export interface IABIDecodedData {
   signature: string;
   definition: ethers.JsonFragment;

package/src/paladin.ts

@@ -5,6 +5,8 @@ import {
   Algorithms,
   IABIDecodedData,
   IBlockchainEventListener,
+  IDomain,
+  IDomainSmartContract,
   IEthAddress,
   IEventWithData,
   IKeyMappingAndVerifier,
@@ -427,6 +429,14 @@ export default class PaladinClient {
       );
       return res.data.result;
     },
+
+    sign: async (keyIdentifier: string, algorithm: string, verifierType: string, payloadType: string, payload: string) => {
+      const res = await this.post<JsonRpcResult<string>>(
+        "keymgr_sign",
+        [keyIdentifier, algorithm, verifierType, payloadType, payload]
+      );
+      return res.data.result;
+    },
   };
 
   ptx = {
@@ -1104,7 +1114,7 @@ export default class PaladinClient {
   };
 
   domain = {
-    listDomains: async () => {
+    listDomains: async (): Promise<string[]> => {
       const res = await this.post<JsonRpcResult<string[]>>(
         "domain_listDomains",
         []
@@ -1112,8 +1122,8 @@ export default class PaladinClient {
       return res.data.result;
     },
 
-    getDomain: async (name: string) => {
-      const res = await this.post<JsonRpcResult<any>>(
+    getDomain: async (name: string): Promise<IDomain | undefined> => {
+      const res = await this.post<JsonRpcResult<IDomain>>(
         "domain_getDomain",
         [name],
         { validateStatus: (status) => status < 300 || status === 404 }
@@ -1121,8 +1131,10 @@ export default class PaladinClient {
       return res.status === 404 ? undefined : res.data.result;
     },
 
-    getDomainByAddress: async (address: string) => {
-      const res = await this.post<JsonRpcResult<any>>(
+    getDomainByAddress: async (
+      address: string
+    ): Promise<IDomain | undefined> => {
+      const res = await this.post<JsonRpcResult<IDomain>>(
         "domain_getDomainByAddress",
         [address],
         { validateStatus: (status) => status < 300 || status === 404 }
@@ -1130,16 +1142,20 @@ export default class PaladinClient {
       return res.status === 404 ? undefined : res.data.result;
     },
 
-    querySmartContracts: async (query: IQuery) => {
-      const res = await this.post<JsonRpcResult<any[]>>(
+    querySmartContracts: async (
+      query: IQuery
+    ): Promise<IDomainSmartContract[]> => {
+      const res = await this.post<JsonRpcResult<IDomainSmartContract[]>>(
         "domain_querySmartContracts",
         [query]
       );
       return res.data.result;
     },
 
-    getSmartContractByAddress: async (address: string) => {
-      const res = await this.post<JsonRpcResult<any>>(
+    getSmartContractByAddress: async (
+      address: string
+    ): Promise<IDomainSmartContract | undefined> => {
+      const res = await this.post<JsonRpcResult<IDomainSmartContract>>(
         "domain_getSmartContractByAddress",
         [address],
         { validateStatus: (status) => status < 300 || status === 404 }