feat(aepp,wallet): support delegation signatures

examples/browser/aepp/src/App.vue

@@ -32,6 +32,13 @@
     >
       Typed data
     </a>
+    <a
+      href="#"
+      :class="{ active: view === 'DelegationSignature' }"
+      @click="view = 'DelegationSignature'"
+    >
+      Delegation signature
+    </a>
   </div>
 
   <Component
@@ -47,10 +54,11 @@ import Basic from './Basic.vue';
 import Contracts from './Contracts.vue';
 import PayForTx from './PayForTx.vue';
 import TypedData from './TypedData.vue';
+import DelegationSignature from './DelegationSignature.vue';
 
 export default {
   components: {
-    Connect, Basic, Contracts, PayForTx, TypedData,
+    Connect, Basic, Contracts, PayForTx, TypedData, DelegationSignature,
   },
   data: () => ({ view: '' }),
   computed: mapState(['aeSdk']),

examples/browser/aepp/src/DelegationSignature.vue

@@ -0,0 +1,68 @@
+<template>
+  <h2>Sign delegation to contract</h2>
+  <div class="group">
+    <div>
+      <div>Contract address</div>
+      <div><input v-model="contractAddress"></div>
+    </div>
+    <div>
+      <label>
+        <input v-model="type" type="radio" value="general">
+        AENS and oracle
+      </label>
+    </div>
+    <div>
+      <label>
+        <input v-model="type" type="radio" value="name">
+        AENS name
+      </label>
+      <div><input v-model="name"></div>
+    </div>
+    <div>
+      <label>
+        <input v-model="type" type="radio" value="oracle-query">
+        Oracle query
+      </label>
+      <div><input v-model="oracleQueryId"></div>
+    </div>
+    <button @click="signPromise = sign()">
+      Sign
+    </button>
+    <div v-if="signPromise">
+      <div>Signature</div>
+      <Value :value="signPromise" />
+    </div>
+  </div>
+</template>
+
+<script>
+import { mapState } from 'vuex';
+import Value from './components/Value.vue';
+
+export default {
+  components: { Value },
+  data: () => ({
+    type: 'general',
+    contractAddress: 'ct_6y3N9KqQb74QsvR9NrESyhWeLNiA9aJgJ7ua8CvsTuGot6uzh',
+    name: 'test.chain',
+    oracleQueryId: 'oq_6y3N9KqQb74QsvR9NrESyhWeLNiA9aJgJ7ua8CvsTuGot6uzh',
+    signPromise: null,
+  }),
+  computed: mapState(['aeSdk']),
+  methods: {
+    sign() {
+      switch (this.type) {
+        case 'general':
+          return this.aeSdk.signDelegationToContract(this.contractAddress);
+        case 'name':
+          return this.aeSdk.signNameDelegationToContract(this.contractAddress, this.name);
+        case 'oracle-query':
+          return this.aeSdk
+            .signOracleQueryDelegationToContract(this.contractAddress, this.oracleQueryId);
+        default:
+          throw new Error(`Unknown delegation signature type: ${this.type}`)
+      }
+    },
+  },
+};
+</script>

examples/browser/wallet-iframe/src/App.vue

@@ -110,6 +110,46 @@ export default {
         return super.signTypedData(data, aci, options);
       }
 
+      async signDelegationToContract(
+        contractAddress,
+        networkId,
+        { aeppRpcClientId: id, aeppOrigin, ...options },
+      ) {
+        if (id != null) {
+          const opt = { ...options, contractAddress, networkId };
+          genConfirmCallback('sign delegation to contract')(id, opt, aeppOrigin);
+        }
+        return super.signDelegationToContract(contractAddress, networkId, options);
+      }
+
+      async signNameDelegationToContract(
+        contractAddress,
+        name,
+        networkId,
+        { aeppRpcClientId: id, aeppOrigin, ...options },
+      ) {
+        if (id != null) {
+          const opt = { ...options, contractAddress, name, networkId };
+          genConfirmCallback('sign delegation of name to contract')(id, opt, aeppOrigin);
+        }
+        return super.signNameDelegationToContract(contractAddress, name, networkId, options);
+      }
+
+      async signOracleQueryDelegationToContract(
+        contractAddress,
+        oracleQueryId,
+        networkId,
+        { aeppRpcClientId: id, aeppOrigin, ...options },
+      ) {
+        if (id != null) {
+          const opt = { ...options, contractAddress, oracleQueryId, networkId };
+          genConfirmCallback('sign delegation of oracle query to contract')(id, opt, aeppOrigin);
+        }
+        return super.signOracleQueryDelegationToContract(
+          contractAddress, oracleQueryId, networkId, options,
+        );
+      }
+
       static generate() {
         // TODO: can inherit parent method after implementing https://github.com/aeternity/aepp-sdk-js/issues/1672
         return new AccountMemoryProtected(generateKeyPair().secretKey);

examples/browser/wallet-web-extension/src/background.js

@@ -75,6 +75,46 @@ class AccountMemoryProtected extends MemoryAccount {
     return super.signTypedData(data, aci, options);
   }
 
+  async signDelegationToContract(
+    contractAddress,
+    networkId,
+    { aeppRpcClientId: id, aeppOrigin, ...options },
+  ) {
+    if (id != null) {
+      const opt = { ...options, contractAddress, networkId };
+      await genConfirmCallback('sign delegation to contract')(id, opt, aeppOrigin);
+    }
+    return super.signDelegationToContract(contractAddress, networkId, options);
+  }
+
+  async signNameDelegationToContract(
+    contractAddress,
+    name,
+    networkId,
+    { aeppRpcClientId: id, aeppOrigin, ...options },
+  ) {
+    if (id != null) {
+      const opt = { ...options, contractAddress, name, networkId };
+      await genConfirmCallback('sign delegation of name to contract')(id, opt, aeppOrigin);
+    }
+    return super.signNameDelegationToContract(contractAddress, name, networkId, options);
+  }
+
+  async signOracleQueryDelegationToContract(
+    contractAddress,
+    oracleQueryId,
+    networkId,
+    { aeppRpcClientId: id, aeppOrigin, ...options },
+  ) {
+    if (id != null) {
+      const opt = { ...options, contractAddress, oracleQueryId, networkId };
+      await genConfirmCallback('sign delegation of oracle query to contract')(id, opt, aeppOrigin);
+    }
+    return super.signOracleQueryDelegationToContract(
+      contractAddress, oracleQueryId, networkId, options,
+    );
+  }
+
   static generate() {
     // TODO: can inherit parent method after implementing https://github.com/aeternity/aepp-sdk-js/issues/1672
     return new AccountMemoryProtected(generateKeyPair().secretKey);

src/AeSdkWallet.ts

@@ -295,6 +295,24 @@ export default class AeSdkWallet extends AeSdk {
               signature: await this.signTypedData(data, aci, parameters),
             };
           },
+          [METHODS.signDelegationToContract]: async ({
+            contractAddress, name, oracleQueryId, onAccount = this.address,
+          }, origin) => {
+            if (!this._isRpcClientConnected(id)) throw new RpcNotAuthorizeError();
+            if (!this.addresses().includes(onAccount)) {
+              throw new RpcPermissionDenyError(onAccount);
+            }
+
+            const parameters = { onAccount, aeppOrigin: origin, aeppRpcClientId: id };
+            const signature = await (
+              (name == null ? null : this
+                .signNameDelegationToContract(contractAddress, name, parameters))
+              ?? (oracleQueryId == null ? null : this
+                .signOracleQueryDelegationToContract(contractAddress, oracleQueryId, parameters))
+              ?? this.signDelegationToContract(contractAddress, parameters)
+            );
+            return { signature };
+          },
         },
       ),
     };

src/account/Rpc.ts

@@ -4,6 +4,7 @@ import { ArgumentError, NotImplementedError, UnsupportedProtocolError } from '..
 import { Encoded } from '../utils/encoder';
 import RpcClient from '../aepp-wallet-communication/rpc/RpcClient';
 import { AeppApi, WalletApi } from '../aepp-wallet-communication/rpc/types';
+import { AensName } from '../tx/builder/constants';
 
 /**
  * Account provided by wallet
@@ -70,18 +71,37 @@ export default class AccountRpc extends AccountBase {
     return signature;
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  override async signDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using wallet');
+  override async signDelegationToContract(
+    contractAddress: Encoded.ContractAddress,
+  ): Promise<Encoded.Signature> {
+    const { signature } = await this._rpcClient.request(METHODS.signDelegationToContract, {
+      onAccount: this.address,
+      contractAddress,
+    });
+    return signature;
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  override async signNameDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using wallet');
+  override async signNameDelegationToContract(
+    contractAddress: Encoded.ContractAddress,
+    name: AensName,
+  ): Promise<Encoded.Signature> {
+    const { signature } = await this._rpcClient.request(METHODS.signDelegationToContract, {
+      onAccount: this.address,
+      contractAddress,
+      name,
+    });
+    return signature;
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  override async signOracleQueryDelegationToContract(): Promise<Encoded.Signature> {
-    throw new NotImplementedError('signing delegation to contract using wallet');
+  override async signOracleQueryDelegationToContract(
+    contractAddress: Encoded.ContractAddress,
+    oracleQueryId: Encoded.OracleQueryId,
+  ): Promise<Encoded.Signature> {
+    const { signature } = await this._rpcClient.request(METHODS.signDelegationToContract, {
+      onAccount: this.address,
+      contractAddress,
+      oracleQueryId,
+    });
+    return signature;
   }
 }

src/aepp-wallet-communication/rpc/types.ts

@@ -3,6 +3,7 @@ import { Domain, AciValue } from '../../utils/typed-data';
 import { METHODS, SUBSCRIPTION_TYPES, WALLET_TYPE } from '../schema';
 import { TransformNodeType } from '../../Node';
 import { SignedTx } from '../../apis/node';
+import { AensName } from '../../tx/builder/constants';
 
 export interface WalletInfo {
   id: string;
@@ -82,6 +83,15 @@ export interface WalletApi {
       onAccount: Encoded.AccountAddress;
     },
   ) => Promise<{ signature: Encoded.Signature }>;
+
+  [METHODS.signDelegationToContract]: (
+    p: {
+      contractAddress: Encoded.ContractAddress;
+      name?: AensName;
+      oracleQueryId?: Encoded.OracleQueryId;
+      onAccount: Encoded.AccountAddress;
+    },
+  ) => Promise<{ signature: Encoded.Signature }>;
 }
 
 export interface AeppApi {

src/aepp-wallet-communication/schema.ts

@@ -37,6 +37,7 @@ export const enum METHODS {
   sign = 'transaction.sign',
   signMessage = 'message.sign',
   signTypedData = 'typedData.sign',
+  signDelegationToContract = 'delegationToContract.sign',
   subscribeAddress = 'address.subscribe',
   updateNetwork = 'networkId.update',
   closeConnection = 'connection.close',

test/integration/rpc.ts

@@ -296,7 +296,7 @@ describe('Aepp<->Wallet', function aeppWallet() {
         recipientId: keypair.publicKey,
         amount: 0,
       });
-      await expect(aepp.signTransaction(tx, { onAccount: account.address }))
+      await expect(aepp.signTransaction(tx))
         .to.be.rejectedWith('The peer failed to execute your request due to unknown error');
     });
 
@@ -380,7 +380,7 @@ describe('Aepp<->Wallet', function aeppWallet() {
         wallet._resolveAccount().signMessage = () => {
           throw new Error('test');
         };
-        await expect(aepp.signMessage('test', { onAccount: account.address }))
+        await expect(aepp.signMessage('test'))
           .to.be.rejectedWith('The peer failed to execute your request due to unknown error');
       });
 
@@ -424,7 +424,7 @@ describe('Aepp<->Wallet', function aeppWallet() {
         wallet._resolveAccount().signTypedData = () => {
           throw new Error('test');
         };
-        await expect(aepp.signTypedData(recordData, recordAci, { onAccount: account.address }))
+        await expect(aepp.signTypedData(recordData, recordAci))
           .to.be.rejectedWith('The peer failed to execute your request due to unknown error');
       });
 
@@ -436,6 +436,42 @@ describe('Aepp<->Wallet', function aeppWallet() {
       });
     });
 
+    describe('Sign delegation to contract', () => {
+      const contractAddress = 'ct_6y3N9KqQb74QsvR9NrESyhWeLNiA9aJgJ7ua8CvsTuGot6uzh';
+
+      it('rejected by wallet', async () => {
+        let origin;
+        wallet._resolveAccount().signDelegationToContract = (ct, netId, { aeppOrigin } = {}) => {
+          origin = aeppOrigin;
+          throw new RpcRejectedByUserError();
+        };
+        await expect(aepp.signDelegationToContract(contractAddress)).to.be.eventually
+          .rejectedWith('Operation rejected by user').with.property('code', 4);
+        expect(origin).to.be.equal('http://origin.test');
+      });
+
+      it('works', async () => {
+        // @ts-expect-error removes object property to restore the original behavior
+        delete wallet._resolveAccount().signDelegationToContract;
+        const signature = await aepp.signDelegationToContract(contractAddress);
+        expect(signature).to.satisfy((s: string) => s.startsWith('sg_'));
+      });
+
+      it('fails with unknown error', async () => {
+        wallet._resolveAccount().signDelegationToContract = () => {
+          throw new Error('test');
+        };
+        await expect(aepp.signDelegationToContract(contractAddress))
+          .to.be.rejectedWith('The peer failed to execute your request due to unknown error');
+      });
+
+      it('signs using specific account', async () => {
+        const onAccount = wallet.addresses()[1];
+        const signature = await aepp.signDelegationToContract(contractAddress, { onAccount });
+        expect(signature).to.satisfy((s: string) => s.startsWith('sg_'));
+      });
+    });
+
     it('Sign and broadcast invalid transaction', async () => {
       // @ts-expect-error removes object property to restore the original behavior
       delete wallet._resolveAccount().signTransaction;