@0xsequence/account 1.6.0 → 1.6.2

package/dist/0xsequence-account.cjs.dev.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var abi = require('@0xsequence/abi');
 var core = require('@0xsequence/core');
 var migration = require('@0xsequence/migration');
 var relayer = require('@0xsequence/relayer');
@@ -212,12 +213,14 @@ class Account {
     this.migrations = void 0;
     this.orchestrator = void 0;
     this.jwt = void 0;
+    this.projectAccessKey = void 0;
     this.address = ethers.ethers.utils.getAddress(options.address);
     this.contexts = options.contexts;
     this.tracker = options.tracker;
     this.networks = options.networks;
     this.orchestrator = options.orchestrator;
     this.jwt = options.jwt;
+    this.projectAccessKey = options.projectAccessKey;
     this.migrations = options.migrations || migration.defaults.DefaultMigrations;
     this.migrator = new migration.migrator.Migrator(options.tracker, this.migrations, this.contexts);
   }
@@ -243,7 +246,8 @@ class Account {
       contexts: options.contexts,
       networks: options.networks,
       orchestrator: options.orchestrator,
-      migrations: options.migrations
+      migrations: options.migrations,
+      projectAccessKey: options.projectAccessKey
     });
   }
   getAddress() {
@@ -268,7 +272,7 @@ class Account {
   providerFor(chainId) {
     const found = this.network(chainId);
     if (!found.provider && !found.rpcUrl) throw new Error(`Provider not found for chainId ${chainId}`);
-    return found.provider || new ethers.ethers.providers.StaticJsonRpcProvider(utils.getEthersConnectionInfo(found.rpcUrl, undefined, this.jwt), {
+    return found.provider || new ethers.ethers.providers.StaticJsonRpcProvider(utils.getEthersConnectionInfo(found.rpcUrl, this.projectAccessKey, this.jwt), {
       name: '',
       chainId: ethers.ethers.BigNumber.from(chainId).toNumber()
     });
@@ -285,6 +289,7 @@ class Account {
     if (!found.relayer) throw new Error(`Relayer not found for chainId ${chainId}`);
     if (relayer.isRelayer(found.relayer)) return found.relayer;
     return new relayer.RpcRelayer(_extends({}, found.relayer, {
+      projectAccessKey: this.projectAccessKey,
       jwtAuth: this.jwt
     }));
   }
@@ -553,6 +558,51 @@ class Account {
     }
     return decorated;
   }
+  buildOnChainSignature(digest) {
+    const subdigest = core.commons.signature.subdigestOf({
+      digest: ethers.ethers.utils.hexlify(digest),
+      chainId: 0,
+      address: this.address
+    });
+    const hexSubdigest = ethers.ethers.utils.hexlify(subdigest);
+    const config = this.coders.config.fromSimple({
+      // Threshold *only* needs to be > 0, this is not a magic number
+      // we only use 2 ** 15 because it may lead to lower gas costs in some chains
+      threshold: 32768,
+      checkpoint: 0,
+      signers: [],
+      subdigests: [hexSubdigest]
+    });
+    const walletInterface = new ethers.ethers.utils.Interface(abi.walletContracts.mainModule.abi);
+    const bundle = {
+      entrypoint: this.address,
+      transactions: [{
+        to: this.address,
+        data: walletInterface.encodeFunctionData(
+        // *NEVER* use updateImageHash here, as it would effectively destroy the wallet
+        // setExtraImageHash sets an additional imageHash, without changing the current one
+        'setExtraImageHash', [this.coders.config.imageHashOf(config),
+        // 2 ** 255 instead of max uint256, to have more zeros in the calldata
+        '57896044618658097711785492504343953926634992332820282019728792003956564819968']),
+        // Conservative gas limit, used because the current relayer
+        // has trouble estimating gas for this transaction
+        gasLimit: 250000
+      }]
+    };
+
+    // Fire and forget request to save the config
+    this.tracker.saveWalletConfig({
+      config
+    });
+
+    // Encode a signature proof for the given subdigest
+    // use `chainId = 0` to make it simpler, as this signature is only a proof
+    const signature = this.coders.signature.encodeSigners(config, new Map(), [hexSubdigest], 0).encoded;
+    return {
+      bundle,
+      signature
+    };
+  }
   async buildEIP6492Signature(signature, status, chainId) {
     const bootstrapBundle = await this.buildBootstrapTransactions(status, chainId);
     if (bootstrapBundle.transactions.length === 0) {

package/dist/0xsequence-account.cjs.prod.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var abi = require('@0xsequence/abi');
 var core = require('@0xsequence/core');
 var migration = require('@0xsequence/migration');
 var relayer = require('@0xsequence/relayer');
@@ -212,12 +213,14 @@ class Account {
     this.migrations = void 0;
     this.orchestrator = void 0;
     this.jwt = void 0;
+    this.projectAccessKey = void 0;
     this.address = ethers.ethers.utils.getAddress(options.address);
     this.contexts = options.contexts;
     this.tracker = options.tracker;
     this.networks = options.networks;
     this.orchestrator = options.orchestrator;
     this.jwt = options.jwt;
+    this.projectAccessKey = options.projectAccessKey;
     this.migrations = options.migrations || migration.defaults.DefaultMigrations;
     this.migrator = new migration.migrator.Migrator(options.tracker, this.migrations, this.contexts);
   }
@@ -243,7 +246,8 @@ class Account {
       contexts: options.contexts,
       networks: options.networks,
       orchestrator: options.orchestrator,
-      migrations: options.migrations
+      migrations: options.migrations,
+      projectAccessKey: options.projectAccessKey
     });
   }
   getAddress() {
@@ -268,7 +272,7 @@ class Account {
   providerFor(chainId) {
     const found = this.network(chainId);
     if (!found.provider && !found.rpcUrl) throw new Error(`Provider not found for chainId ${chainId}`);
-    return found.provider || new ethers.ethers.providers.StaticJsonRpcProvider(utils.getEthersConnectionInfo(found.rpcUrl, undefined, this.jwt), {
+    return found.provider || new ethers.ethers.providers.StaticJsonRpcProvider(utils.getEthersConnectionInfo(found.rpcUrl, this.projectAccessKey, this.jwt), {
       name: '',
       chainId: ethers.ethers.BigNumber.from(chainId).toNumber()
     });
@@ -285,6 +289,7 @@ class Account {
     if (!found.relayer) throw new Error(`Relayer not found for chainId ${chainId}`);
     if (relayer.isRelayer(found.relayer)) return found.relayer;
     return new relayer.RpcRelayer(_extends({}, found.relayer, {
+      projectAccessKey: this.projectAccessKey,
       jwtAuth: this.jwt
     }));
   }
@@ -553,6 +558,51 @@ class Account {
     }
     return decorated;
   }
+  buildOnChainSignature(digest) {
+    const subdigest = core.commons.signature.subdigestOf({
+      digest: ethers.ethers.utils.hexlify(digest),
+      chainId: 0,
+      address: this.address
+    });
+    const hexSubdigest = ethers.ethers.utils.hexlify(subdigest);
+    const config = this.coders.config.fromSimple({
+      // Threshold *only* needs to be > 0, this is not a magic number
+      // we only use 2 ** 15 because it may lead to lower gas costs in some chains
+      threshold: 32768,
+      checkpoint: 0,
+      signers: [],
+      subdigests: [hexSubdigest]
+    });
+    const walletInterface = new ethers.ethers.utils.Interface(abi.walletContracts.mainModule.abi);
+    const bundle = {
+      entrypoint: this.address,
+      transactions: [{
+        to: this.address,
+        data: walletInterface.encodeFunctionData(
+        // *NEVER* use updateImageHash here, as it would effectively destroy the wallet
+        // setExtraImageHash sets an additional imageHash, without changing the current one
+        'setExtraImageHash', [this.coders.config.imageHashOf(config),
+        // 2 ** 255 instead of max uint256, to have more zeros in the calldata
+        '57896044618658097711785492504343953926634992332820282019728792003956564819968']),
+        // Conservative gas limit, used because the current relayer
+        // has trouble estimating gas for this transaction
+        gasLimit: 250000
+      }]
+    };
+
+    // Fire and forget request to save the config
+    this.tracker.saveWalletConfig({
+      config
+    });
+
+    // Encode a signature proof for the given subdigest
+    // use `chainId = 0` to make it simpler, as this signature is only a proof
+    const signature = this.coders.signature.encodeSigners(config, new Map(), [hexSubdigest], 0).encoded;
+    return {
+      bundle,
+      signature
+    };
+  }
   async buildEIP6492Signature(signature, status, chainId) {
     const bootstrapBundle = await this.buildBootstrapTransactions(status, chainId);
     if (bootstrapBundle.transactions.length === 0) {

package/dist/0xsequence-account.esm.js

@@ -1,3 +1,4 @@
+import { walletContracts } from '@0xsequence/abi';
 import { commons, universal } from '@0xsequence/core';
 import { defaults, migrator, version } from '@0xsequence/migration';
 import { proto, isRelayer, RpcRelayer } from '@0xsequence/relayer';
@@ -208,12 +209,14 @@ class Account {
     this.migrations = void 0;
     this.orchestrator = void 0;
     this.jwt = void 0;
+    this.projectAccessKey = void 0;
     this.address = ethers.utils.getAddress(options.address);
     this.contexts = options.contexts;
     this.tracker = options.tracker;
     this.networks = options.networks;
     this.orchestrator = options.orchestrator;
     this.jwt = options.jwt;
+    this.projectAccessKey = options.projectAccessKey;
     this.migrations = options.migrations || defaults.DefaultMigrations;
     this.migrator = new migrator.Migrator(options.tracker, this.migrations, this.contexts);
   }
@@ -239,7 +242,8 @@ class Account {
       contexts: options.contexts,
       networks: options.networks,
       orchestrator: options.orchestrator,
-      migrations: options.migrations
+      migrations: options.migrations,
+      projectAccessKey: options.projectAccessKey
     });
   }
   getAddress() {
@@ -264,7 +268,7 @@ class Account {
   providerFor(chainId) {
     const found = this.network(chainId);
     if (!found.provider && !found.rpcUrl) throw new Error(`Provider not found for chainId ${chainId}`);
-    return found.provider || new ethers.providers.StaticJsonRpcProvider(getEthersConnectionInfo(found.rpcUrl, undefined, this.jwt), {
+    return found.provider || new ethers.providers.StaticJsonRpcProvider(getEthersConnectionInfo(found.rpcUrl, this.projectAccessKey, this.jwt), {
       name: '',
       chainId: ethers.BigNumber.from(chainId).toNumber()
     });
@@ -281,6 +285,7 @@ class Account {
     if (!found.relayer) throw new Error(`Relayer not found for chainId ${chainId}`);
     if (isRelayer(found.relayer)) return found.relayer;
     return new RpcRelayer(_extends({}, found.relayer, {
+      projectAccessKey: this.projectAccessKey,
       jwtAuth: this.jwt
     }));
   }
@@ -549,6 +554,51 @@ class Account {
     }
     return decorated;
   }
+  buildOnChainSignature(digest) {
+    const subdigest = commons.signature.subdigestOf({
+      digest: ethers.utils.hexlify(digest),
+      chainId: 0,
+      address: this.address
+    });
+    const hexSubdigest = ethers.utils.hexlify(subdigest);
+    const config = this.coders.config.fromSimple({
+      // Threshold *only* needs to be > 0, this is not a magic number
+      // we only use 2 ** 15 because it may lead to lower gas costs in some chains
+      threshold: 32768,
+      checkpoint: 0,
+      signers: [],
+      subdigests: [hexSubdigest]
+    });
+    const walletInterface = new ethers.utils.Interface(walletContracts.mainModule.abi);
+    const bundle = {
+      entrypoint: this.address,
+      transactions: [{
+        to: this.address,
+        data: walletInterface.encodeFunctionData(
+        // *NEVER* use updateImageHash here, as it would effectively destroy the wallet
+        // setExtraImageHash sets an additional imageHash, without changing the current one
+        'setExtraImageHash', [this.coders.config.imageHashOf(config),
+        // 2 ** 255 instead of max uint256, to have more zeros in the calldata
+        '57896044618658097711785492504343953926634992332820282019728792003956564819968']),
+        // Conservative gas limit, used because the current relayer
+        // has trouble estimating gas for this transaction
+        gasLimit: 250000
+      }]
+    };
+
+    // Fire and forget request to save the config
+    this.tracker.saveWalletConfig({
+      config
+    });
+
+    // Encode a signature proof for the given subdigest
+    // use `chainId = 0` to make it simpler, as this signature is only a proof
+    const signature = this.coders.signature.encodeSigners(config, new Map(), [hexSubdigest], 0).encoded;
+    return {
+      bundle,
+      signature
+    };
+  }
   async buildEIP6492Signature(signature, status, chainId) {
     const bootstrapBundle = await this.buildBootstrapTransactions(status, chainId);
     if (bootstrapBundle.transactions.length === 0) {

package/dist/declarations/src/account.d.ts

@@ -36,6 +36,7 @@ export type AccountOptions = {
     orchestrator: SignatureOrchestrator;
     networks: NetworkConfig[];
     jwt?: string;
+    projectAccessKey?: string;
 };
 export interface PreparedTransactions {
     transactions: commons.transaction.SimulatedTransaction[];
@@ -52,6 +53,7 @@ export declare class Account {
     readonly migrations: migrator.Migrations;
     private orchestrator;
     private jwt?;
+    private projectAccessKey?;
     constructor(options: AccountOptions);
     getSigner(chainId: ChainId, options?: AccountSignerOptions): AccountSigner;
     static new(options: {
@@ -61,6 +63,7 @@ export declare class Account {
         orchestrator: SignatureOrchestrator;
         networks: NetworkConfig[];
         migrations?: migrator.Migrations;
+        projectAccessKey?: string;
     }): Promise<Account>;
     getAddress(): Promise<string>;
     get version(): number;
@@ -85,6 +88,10 @@ export declare class Account {
     decorateSignature<T extends ethers.BytesLike>(signature: T, status: Partial<Pick<AccountStatus, 'presignedConfigurations'>>): Promise<T | string>;
     publishWitness(): Promise<void>;
     signDigest(digest: ethers.BytesLike, chainId: ethers.BigNumberish, decorate?: boolean, cantValidateBehavior?: 'ignore' | 'eip6492' | 'throw', metadata?: object): Promise<string>;
+    buildOnChainSignature(digest: ethers.BytesLike): {
+        bundle: commons.transaction.TransactionBundle;
+        signature: string;
+    };
     private buildEIP6492Signature;
     editConfig(changes: {
         add?: commons.config.SimpleSigner[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/account",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "tools for migrating sequence wallets to new versions",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/account",
   "source": "src/index.ts",
@@ -10,19 +10,20 @@
   "license": "Apache-2.0",
   "dependencies": {
     "ethers": "^5.5.2",
-    "@0xsequence/core": "1.6.0",
-    "@0xsequence/migration": "1.6.0",
-    "@0xsequence/network": "1.6.0",
-    "@0xsequence/relayer": "1.6.0",
-    "@0xsequence/sessions": "1.6.0",
-    "@0xsequence/utils": "1.6.0",
-    "@0xsequence/wallet": "1.6.0"
+    "@0xsequence/abi": "1.6.2",
+    "@0xsequence/core": "1.6.2",
+    "@0xsequence/migration": "1.6.2",
+    "@0xsequence/network": "1.6.2",
+    "@0xsequence/relayer": "1.6.2",
+    "@0xsequence/sessions": "1.6.2",
+    "@0xsequence/utils": "1.6.2",
+    "@0xsequence/wallet": "1.6.2"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "nyc": "^15.1.0",
-    "@0xsequence/tests": "1.6.0",
-    "@0xsequence/signhub": "1.6.0"
+    "@0xsequence/signhub": "1.6.2",
+    "@0xsequence/tests": "1.6.2"
   },
   "files": [
     "src",

package/src/account.ts

@@ -1,3 +1,4 @@
+import { walletContracts } from '@0xsequence/abi'
 import { commons, universal } from '@0xsequence/core'
 import { WalletSignRequestMetadata } from '@0xsequence/core/src/commons'
 import { migrator, defaults, version } from '@0xsequence/migration'
@@ -56,6 +57,9 @@ export type AccountOptions = {
 
   // Jwt
   jwt?: string
+
+  // Project access key
+  projectAccessKey?: string
 }
 
 export interface PreparedTransactions {
@@ -101,6 +105,8 @@ export class Account {
 
   private jwt?: string
 
+  private projectAccessKey?: string
+
   constructor(options: AccountOptions) {
     this.address = ethers.utils.getAddress(options.address)
 
@@ -109,6 +115,7 @@ export class Account {
     this.networks = options.networks
     this.orchestrator = options.orchestrator
     this.jwt = options.jwt
+    this.projectAccessKey = options.projectAccessKey
 
     this.migrations = options.migrations || defaults.DefaultMigrations
     this.migrator = new migrator.Migrator(options.tracker, this.migrations, this.contexts)
@@ -125,6 +132,7 @@ export class Account {
     orchestrator: SignatureOrchestrator
     networks: NetworkConfig[]
     migrations?: migrator.Migrations
+    projectAccessKey?: string
   }): Promise<Account> {
     const mig = new migrator.Migrator(options.tracker, options.migrations ?? defaults.DefaultMigrations, options.contexts)
 
@@ -144,7 +152,8 @@ export class Account {
       contexts: options.contexts,
       networks: options.networks,
       orchestrator: options.orchestrator,
-      migrations: options.migrations
+      migrations: options.migrations,
+      projectAccessKey: options.projectAccessKey
     })
   }
 
@@ -180,7 +189,7 @@ export class Account {
     if (!found.provider && !found.rpcUrl) throw new Error(`Provider not found for chainId ${chainId}`)
     return (
       found.provider ||
-      new ethers.providers.StaticJsonRpcProvider(getEthersConnectionInfo(found.rpcUrl, undefined, this.jwt), {
+      new ethers.providers.StaticJsonRpcProvider(getEthersConnectionInfo(found.rpcUrl, this.projectAccessKey, this.jwt), {
         name: '',
         chainId: ethers.BigNumber.from(chainId).toNumber()
       })
@@ -199,7 +208,7 @@ export class Account {
     const found = this.network(chainId)
     if (!found.relayer) throw new Error(`Relayer not found for chainId ${chainId}`)
     if (isRelayer(found.relayer)) return found.relayer
-    return new RpcRelayer({ ...found.relayer, jwtAuth: this.jwt })
+    return new RpcRelayer({ ...found.relayer, projectAccessKey: this.projectAccessKey, jwtAuth: this.jwt })
   }
 
   setOrchestrator(orchestrator: SignatureOrchestrator) {
@@ -526,6 +535,50 @@ export class Account {
     return decorated
   }
 
+  buildOnChainSignature(digest: ethers.BytesLike): { bundle: commons.transaction.TransactionBundle; signature: string } {
+    const subdigest = commons.signature.subdigestOf({ digest: ethers.utils.hexlify(digest), chainId: 0, address: this.address })
+    const hexSubdigest = ethers.utils.hexlify(subdigest)
+    const config = this.coders.config.fromSimple({
+      // Threshold *only* needs to be > 0, this is not a magic number
+      // we only use 2 ** 15 because it may lead to lower gas costs in some chains
+      threshold: 32768,
+      checkpoint: 0,
+      signers: [],
+      subdigests: [hexSubdigest]
+    })
+
+    const walletInterface = new ethers.utils.Interface(walletContracts.mainModule.abi)
+    const bundle: commons.transaction.TransactionBundle = {
+      entrypoint: this.address,
+      transactions: [
+        {
+          to: this.address,
+          data: walletInterface.encodeFunctionData(
+            // *NEVER* use updateImageHash here, as it would effectively destroy the wallet
+            // setExtraImageHash sets an additional imageHash, without changing the current one
+            'setExtraImageHash',
+            [
+              this.coders.config.imageHashOf(config),
+              // 2 ** 255 instead of max uint256, to have more zeros in the calldata
+              '57896044618658097711785492504343953926634992332820282019728792003956564819968'
+            ]
+          ),
+          // Conservative gas limit, used because the current relayer
+          // has trouble estimating gas for this transaction
+          gasLimit: 250000
+        }
+      ]
+    }
+
+    // Fire and forget request to save the config
+    this.tracker.saveWalletConfig({ config })
+
+    // Encode a signature proof for the given subdigest
+    // use `chainId = 0` to make it simpler, as this signature is only a proof
+    const signature = this.coders.signature.encodeSigners(config, new Map(), [hexSubdigest], 0).encoded
+    return { bundle, signature }
+  }
+
   private async buildEIP6492Signature(signature: string, status: AccountStatus, chainId: ethers.BigNumberish): Promise<string> {
     const bootstrapBundle = await this.buildBootstrapTransactions(status, chainId)
     if (bootstrapBundle.transactions.length === 0) {