feat(signer): add arweave signer to ario class

examples/node/index.cjs

@@ -1,10 +1,14 @@
+const Arweave = require('arweave');
 const {
   ArIO,
   ARNS_TESTNET_REGISTRY_TX,
 } = require('../../lib/cjs/node/index.js');
+const { ArweaveSigner } = require('arbundles');
 
 (async () => {
-  const arIO = new ArIO();
+  const jwk = await Arweave.init({}).wallets.generate();
+  const signer = new ArweaveSigner(jwk);
+  const arIO = new ArIO({ signer });
   // testnet gateways
   const testnetGateways = await arIO.getGateways();
   const protocolBalance = await arIO.getBalance({

examples/node/index.mjs

@@ -1,7 +1,12 @@
+import { ArweaveSigner } from 'arbundles';
+import Arweave from 'arweave';
+
 import { ARNS_TESTNET_REGISTRY_TX, ArIO } from '../../lib/esm/node/index.js';
 
 (async () => {
-  const arIO = new ArIO();
+  const jwk = await Arweave.init({}).wallets.generate();
+  const signer = new ArweaveSigner(jwk);
+  const arIO = new ArIO({ signer });
   // testnet gateways
   const testnetGateways = await arIO.getGateways();
   const protocolBalance = await arIO.getBalance({

examples/web/index.html

@@ -131,10 +131,12 @@ <h1 class="text-textPrimary w-full font-bold">View Distribution Data</h1>
     </div>
 
     <script type="module">
+      import Arweave from 'https://unpkg.com/arweave/bundles/web.bundle.js';
+
       import { ArIO } from './web.bundle.min.js';
 
-      // set up our client
-      const arIO = new ArIO();
+      const jwk = await Arweave.init({}).wallets.generate();
+      const arIO = new ArIO({ signer: jwk });
 
       // fetch data on page load
       async function init() {

package.json

@@ -111,10 +111,11 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
+    "arbundles": "^0.11.0",
     "arweave": "^1.14.4",
     "axios": "1.4.0",
+    "setimmediate": "^1.0.5",
     "warp-contracts": "^1.4.38",
-    "winston": "^3.11.0",
-    "setimmediate": "^1.0.5"
+    "winston": "^3.11.0"
   }
 }

src/common/ar-io.ts

@@ -14,6 +14,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+import { ArconnectSigner, ArweaveSigner } from 'arbundles/web';
+import { JWKInterface } from 'arweave/node/lib/wallet.js';
+
 import { ARNS_TESTNET_REGISTRY_TX } from '../constants.js';
 import {
   ArIOContract,
@@ -29,6 +32,7 @@ import {
   SmartWeaveContract,
   WeightedObserver,
 } from '../types.js';
+import { isJwk } from '../utils/arweave.js';
 import { RemoteContract } from './contracts/remote-contract.js';
 
 // TODO: append this with other configuration options (e.g. local vs. remote evaluation)
@@ -54,21 +58,36 @@ function isContractTxIdConfiguration(
 
 export class ArIO implements ArIOContract {
   private contract: SmartWeaveContract<ArIOState>;
+  signer: ArweaveSigner | ArconnectSigner | JWKInterface;
 
-  constructor(
-    config: ContractConfiguration = {
-      // default to a contract that uses the arns service to do the evaluation
-      contract: new RemoteContract<ArIOState>({
-        contractTxId: ARNS_TESTNET_REGISTRY_TX,
-      }),
-    },
-  ) {
-    if (isContractConfiguration<ArIOState>(config)) {
-      this.contract = config.contract;
-    } else if (isContractTxIdConfiguration(config)) {
-      this.contract = new RemoteContract<ArIOState>({
-        contractTxId: config.contractTxId,
-      });
+  constructor({
+    signer,
+    ...config
+  }: ContractConfiguration & {
+    signer: ArweaveSigner | ArconnectSigner | JWKInterface;
+  }) {
+    this.signer = isJwk(signer) ? new ArweaveSigner(signer) : signer;
+
+    const isContract = isContractConfiguration<ArIOState>(config);
+    const isContractTxId = isContractTxIdConfiguration(config);
+    const isBoth = isContract && isContractTxId;
+    switch (true) {
+      case isBoth:
+        throw new Error(
+          'ArIO contract configuration must include either `contract` or `contractTxId`, but not both',
+        );
+      case isContract:
+        this.contract = config.contract;
+        return;
+      case isContractTxId:
+        this.contract = new RemoteContract<ArIOState>({
+          contractTxId: config.contractTxId,
+        });
+        return;
+      default:
+        this.contract = new RemoteContract<ArIOState>({
+          contractTxId: ARNS_TESTNET_REGISTRY_TX,
+        });
     }
   }
 

src/utils/arweave.ts

@@ -14,6 +14,9 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+import { b64UrlToBuffer } from 'arweave/node/lib/utils.js';
+import { JWKInterface } from 'arweave/node/lib/wallet.js';
+
 import { BlockHeight } from '../common.js';
 import { ARWEAVE_TX_REGEX } from '../constants.js';
 
@@ -24,3 +27,15 @@ export const validateArweaveId = (id: string): boolean => {
 export function isBlockHeight(height: string | number): height is BlockHeight {
   return height !== undefined && !isNaN(parseInt(height.toString()));
 }
+
+export const isJwk = (obj: object): obj is JWKInterface => {
+  let valid = true;
+  ['n', 'e', 'd', 'p', 'q', 'dp', 'dq', 'qi'].map(
+    (key) => !(key in obj) && (valid = false),
+  );
+  const bufferOfN = b64UrlToBuffer(obj['n']);
+  if (bufferOfN.length !== 512) {
+    valid = false;
+  }
+  return valid;
+};

tests/ar-io.test.ts

@@ -1,3 +1,6 @@
+import { ArweaveSigner } from 'arbundles';
+import Arweave from 'arweave';
+
 import { ArIO } from '../src/common/ar-io.js';
 import { RemoteContract } from '../src/common/contracts/remote-contract.js';
 import { ARNS_DEVNET_REGISTRY_TX } from '../src/constants.js';
@@ -11,11 +14,21 @@ const evaluateToSortKey = new SmartWeaveSortKey(
   '000001376946,0000000000000,18d52956c8e13ae1f557b4e67f6f298b8ffd2a5cd96e42ec24ca649b7401510f',
 );
 describe('ArIO Client', () => {
-  const arIO = new ArIO({
-    contract: new RemoteContract<ArIOState>({
-      url: process.env.REMOTE_CACHE_URL || 'http://localhost:3000',
-      contractTxId: ARNS_DEVNET_REGISTRY_TX,
-    }),
+  let arIO: ArIO;
+  beforeAll(async () => {
+    const arweave = Arweave.init({
+      host: 'arweave.net',
+      protocol: 'https',
+      port: 443,
+    });
+    const jwk = await arweave.wallets.generate();
+    const signer = new ArweaveSigner(jwk);
+    arIO = new ArIO({
+      contract: new RemoteContract<ArIOState>({
+        contractTxId: ARNS_DEVNET_REGISTRY_TX,
+      }),
+      signer,
+    });
   });
   it('should create a custom ArIO client', () => {
     expect(arIO).toBeInstanceOf(ArIO);