@lfdecentralizedtrust/paladin-sdk 0.15.0-rc.0 → 1.0.0-rc.1

package/build/domains/abis/INoto.json

@@ -12,6 +12,12 @@
                     "name": "txId",
                     "type": "bytes32"
                 },
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
                 {
                     "indexed": false,
                     "internalType": "bytes32[]",
@@ -55,6 +61,12 @@
                     "name": "txId",
                     "type": "bytes32"
                 },
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
                 {
                     "indexed": false,
                     "internalType": "bytes32",
@@ -129,6 +141,12 @@
                     "name": "txId",
                     "type": "bytes32"
                 },
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
                 {
                     "indexed": false,
                     "internalType": "address",
@@ -172,6 +190,24 @@
         {
             "anonymous": false,
             "inputs": [
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "txId",
+                    "type": "bytes32"
+                },
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
+                {
+                    "indexed": false,
+                    "internalType": "bytes32",
+                    "name": "unlockTxId",
+                    "type": "bytes32"
+                },
                 {
                     "indexed": false,
                     "internalType": "bytes32[]",
@@ -228,7 +264,7 @@
                 },
                 {
                     "internalType": "bytes32",
-                    "name": "unlockHash",
+                    "name": "lockId",
                     "type": "bytes32"
                 },
                 {
@@ -343,6 +379,21 @@
         },
         {
             "inputs": [
+                {
+                    "internalType": "bytes32",
+                    "name": "txId",
+                    "type": "bytes32"
+                },
+                {
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
+                {
+                    "internalType": "bytes32",
+                    "name": "unlockTxId",
+                    "type": "bytes32"
+                },
                 {
                     "internalType": "bytes32[]",
                     "name": "lockedInputs",
@@ -410,29 +461,41 @@
                     "type": "bytes32"
                 },
                 {
-                    "internalType": "bytes32[]",
-                    "name": "lockedInputs",
-                    "type": "bytes32[]"
-                },
-                {
-                    "internalType": "bytes32[]",
-                    "name": "lockedOutputs",
-                    "type": "bytes32[]"
-                },
-                {
-                    "internalType": "bytes32[]",
-                    "name": "outputs",
-                    "type": "bytes32[]"
-                },
-                {
-                    "internalType": "bytes",
-                    "name": "signature",
-                    "type": "bytes"
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
                 },
                 {
-                    "internalType": "bytes",
-                    "name": "data",
-                    "type": "bytes"
+                    "components": [
+                        {
+                            "internalType": "bytes32[]",
+                            "name": "lockedInputs",
+                            "type": "bytes32[]"
+                        },
+                        {
+                            "internalType": "bytes32[]",
+                            "name": "lockedOutputs",
+                            "type": "bytes32[]"
+                        },
+                        {
+                            "internalType": "bytes32[]",
+                            "name": "outputs",
+                            "type": "bytes32[]"
+                        },
+                        {
+                            "internalType": "bytes",
+                            "name": "signature",
+                            "type": "bytes"
+                        },
+                        {
+                            "internalType": "bytes",
+                            "name": "data",
+                            "type": "bytes"
+                        }
+                    ],
+                    "internalType": "struct INoto.UnlockParams",
+                    "name": "params",
+                    "type": "tuple"
                 }
             ],
             "name": "unlock",

package/build/domains/abis/INotoPrivate.json

@@ -73,6 +73,54 @@
             "stateMutability": "nonpayable",
             "type": "function"
         },
+        {
+            "inputs": [
+                {
+                    "internalType": "uint256",
+                    "name": "amount",
+                    "type": "uint256"
+                },
+                {
+                    "internalType": "bytes",
+                    "name": "data",
+                    "type": "bytes"
+                }
+            ],
+            "name": "createLock",
+            "outputs": [],
+            "stateMutability": "nonpayable",
+            "type": "function"
+        },
+        {
+            "inputs": [
+                {
+                    "components": [
+                        {
+                            "internalType": "string",
+                            "name": "to",
+                            "type": "string"
+                        },
+                        {
+                            "internalType": "uint256",
+                            "name": "amount",
+                            "type": "uint256"
+                        }
+                    ],
+                    "internalType": "struct INotoPrivate.UnlockRecipient[]",
+                    "name": "recipients",
+                    "type": "tuple[]"
+                },
+                {
+                    "internalType": "bytes",
+                    "name": "data",
+                    "type": "bytes"
+                }
+            ],
+            "name": "createMintLock",
+            "outputs": [],
+            "stateMutability": "nonpayable",
+            "type": "function"
+        },
         {
             "inputs": [],
             "name": "decimals",
@@ -93,38 +141,6 @@
                     "name": "lockId",
                     "type": "bytes32"
                 },
-                {
-                    "components": [
-                        {
-                            "internalType": "bytes32[]",
-                            "name": "lockedInputs",
-                            "type": "bytes32[]"
-                        },
-                        {
-                            "internalType": "bytes32[]",
-                            "name": "lockedOutputs",
-                            "type": "bytes32[]"
-                        },
-                        {
-                            "internalType": "bytes32[]",
-                            "name": "outputs",
-                            "type": "bytes32[]"
-                        },
-                        {
-                            "internalType": "bytes",
-                            "name": "signature",
-                            "type": "bytes"
-                        },
-                        {
-                            "internalType": "bytes",
-                            "name": "data",
-                            "type": "bytes"
-                        }
-                    ],
-                    "internalType": "struct INotoPrivate.UnlockPublicParams",
-                    "name": "unlock",
-                    "type": "tuple"
-                },
                 {
                     "internalType": "address",
                     "name": "delegate",
@@ -195,6 +211,34 @@
             "stateMutability": "view",
             "type": "function"
         },
+        {
+            "inputs": [
+                {
+                    "internalType": "bytes32",
+                    "name": "lockId",
+                    "type": "bytes32"
+                },
+                {
+                    "internalType": "string",
+                    "name": "from",
+                    "type": "string"
+                },
+                {
+                    "internalType": "uint256",
+                    "name": "amount",
+                    "type": "uint256"
+                },
+                {
+                    "internalType": "bytes",
+                    "name": "data",
+                    "type": "bytes"
+                }
+            ],
+            "name": "prepareBurnUnlock",
+            "outputs": [],
+            "stateMutability": "nonpayable",
+            "type": "function"
+        },
         {
             "inputs": [
                 {

package/build/domains/noto.d.ts

@@ -54,6 +54,16 @@ export interface NotoLockParams {
     amount: string | number;
     data: string;
 }
+export interface NotoCreateMintLockParams {
+    recipients: UnlockRecipient[];
+    data: string;
+}
+export interface NotoPrepareBurnUnlockParams {
+    lockId: string;
+    from: PaladinVerifier;
+    amount: string | number;
+    data: string;
+}
 export interface NotoUnlockParams {
     lockId: string;
     from: PaladinVerifier;
@@ -66,7 +76,7 @@ export interface UnlockRecipient {
 }
 export interface NotoDelegateLockParams {
     lockId: string;
-    unlock: NotoUnlockPublicParams;
+    unlock?: NotoUnlockPublicParams;
     delegate: string;
     data: string;
 }
@@ -108,9 +118,12 @@ export declare class NotoInstance {
     burn(from: PaladinVerifier, data: NotoBurnParams): TransactionFuture;
     burnFrom(from: PaladinVerifier, data: NotoBurnFromParams): TransactionFuture;
     lock(from: PaladinVerifier, data: NotoLockParams): TransactionFuture;
+    createLock(from: PaladinVerifier, data: NotoLockParams): TransactionFuture;
+    createMintLock(from: PaladinVerifier, data: NotoCreateMintLockParams): TransactionFuture;
     unlock(from: PaladinVerifier, data: NotoUnlockParams): TransactionFuture;
     unlockAsDelegate(from: PaladinVerifier, data: NotoUnlockPublicParams): TransactionFuture;
     prepareUnlock(from: PaladinVerifier, data: NotoUnlockParams): TransactionFuture;
+    prepareBurnUnlock(from: PaladinVerifier, data: NotoPrepareBurnUnlockParams): TransactionFuture;
     delegateLock(from: PaladinVerifier, data: NotoDelegateLockParams): TransactionFuture;
     encodeUnlock(data: NotoUnlockPublicParams): string;
     balanceOf(from: PaladinVerifier, data: NotoBalanceOfParams): Promise<NotoBalanceOfResult>;

package/build/domains/noto.js

@@ -203,6 +203,7 @@ class NotoInstance {
             }
         }));
     }
+    // @deprecated - use createLock instead
     lock(from, data) {
         return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
             type: interfaces_1.TransactionType.PRIVATE,
@@ -213,6 +214,32 @@ class NotoInstance {
             data,
         }));
     }
+    createLock(from, data) {
+        return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
+            type: interfaces_1.TransactionType.PRIVATE,
+            abi: notoPrivateJSON.abi,
+            function: "createLock",
+            to: this.address,
+            from: from.lookup,
+            data,
+        }));
+    }
+    createMintLock(from, data) {
+        return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
+            type: interfaces_1.TransactionType.PRIVATE,
+            abi: notoPrivateJSON.abi,
+            function: "createMintLock",
+            to: this.address,
+            from: from.lookup,
+            data: {
+                ...data,
+                recipients: data.recipients.map((recipient) => ({
+                    to: recipient.to.lookup,
+                    amount: recipient.amount,
+                })),
+            },
+        }));
+    }
     unlock(from, data) {
         return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
             type: interfaces_1.TransactionType.PRIVATE,
@@ -257,6 +284,19 @@ class NotoInstance {
             },
         }));
     }
+    prepareBurnUnlock(from, data) {
+        return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
+            type: interfaces_1.TransactionType.PRIVATE,
+            abi: notoPrivateJSON.abi,
+            function: "prepareBurnUnlock",
+            to: this.address,
+            from: from.lookup,
+            data: {
+                ...data,
+                from: data.from.lookup,
+            },
+        }));
+    }
     delegateLock(from, data) {
         return new transaction_1.TransactionFuture(this.paladin, this.paladin.sendTransaction({
             type: interfaces_1.TransactionType.PRIVATE,

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/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/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": "0.15.0-rc.0",
+  "version": "1.0.0-rc.1",
   "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/noto.ts

@@ -117,6 +117,18 @@ export interface NotoLockParams {
   data: string;
 }
 
+export interface NotoCreateMintLockParams {
+  recipients: UnlockRecipient[];
+  data: string;
+}
+
+export interface NotoPrepareBurnUnlockParams {
+  lockId: string;
+  from: PaladinVerifier;
+  amount: string | number;
+  data: string;
+}
+
 export interface NotoUnlockParams {
   lockId: string;
   from: PaladinVerifier;
@@ -131,7 +143,7 @@ export interface UnlockRecipient {
 
 export interface NotoDelegateLockParams {
   lockId: string;
-  unlock: NotoUnlockPublicParams;
+  unlock?: NotoUnlockPublicParams; // Required for V0, omitted for V1
   delegate: string;
   data: string;
 }
@@ -308,6 +320,7 @@ export class NotoInstance {
     );
   }
 
+  // @deprecated - use createLock instead
   lock(from: PaladinVerifier, data: NotoLockParams) {
     return new TransactionFuture(
       this.paladin,
@@ -322,6 +335,40 @@ export class NotoInstance {
     );
   }
 
+  createLock(from: PaladinVerifier, data: NotoLockParams) {
+    return new TransactionFuture(
+      this.paladin,
+      this.paladin.sendTransaction({
+        type: TransactionType.PRIVATE,
+        abi: notoPrivateJSON.abi,
+        function: "createLock",
+        to: this.address,
+        from: from.lookup,
+        data,
+      })
+    );
+  }
+
+  createMintLock(from: PaladinVerifier, data: NotoCreateMintLockParams) {
+    return new TransactionFuture(
+      this.paladin,
+      this.paladin.sendTransaction({
+        type: TransactionType.PRIVATE,
+        abi: notoPrivateJSON.abi,
+        function: "createMintLock",
+        to: this.address,
+        from: from.lookup,
+        data: {
+          ...data,
+          recipients: data.recipients.map((recipient) => ({
+            to: recipient.to.lookup,
+            amount: recipient.amount,
+          })),
+        },
+      })
+    );
+  }
+
   unlock(from: PaladinVerifier, data: NotoUnlockParams) {
     return new TransactionFuture(
       this.paladin,
@@ -378,6 +425,23 @@ export class NotoInstance {
     );
   }
 
+  prepareBurnUnlock(from: PaladinVerifier, data: NotoPrepareBurnUnlockParams) {
+    return new TransactionFuture(
+      this.paladin,
+      this.paladin.sendTransaction({
+        type: TransactionType.PRIVATE,
+        abi: notoPrivateJSON.abi,
+        function: "prepareBurnUnlock",
+        to: this.address,
+        from: from.lookup,
+        data: {
+          ...data,
+          from: data.from.lookup,
+        },
+      })
+    );
+  }
+
   delegateLock(from: PaladinVerifier, data: NotoDelegateLockParams) {
     return new TransactionFuture(
       this.paladin,

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/signpayloads.ts

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

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 }