fix(connect): add init static function on ario class to create intera…

…ction classes
ar-io · Apr 9, 2024 · 765f39c · 765f39c
1 parent beb8610
commit 765f39c
Show file tree

Hide file tree

Showing 6 changed files with 101 additions and 103 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ yarn add @ar-io/sdk
 ```typescript
 import { ArIO } from '@ar-io/sdk';
 
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const gateways = arIO.getGateways();
 
 // outputs:
@@ -123,7 +123,7 @@ The SDK is provided in both CommonJS and ESM formats and is compatible with bund
 import { ArIO } from '@ar-io/sdk';
 
 // set up client
-const arIO = new ArIO();
+const arIO = ArIO.init();
 // fetch gateways
 const gateways = arIO.getGateways();
 ```
@@ -135,7 +135,7 @@ const gateways = arIO.getGateways();
   import { ArIO } from 'https://unpkg.com/@ar-io/sdk';
 
   // set up client
-  const arIO = new ArIO();
+  const arIO = ArIO.init();
   // fetch gateways
   const gateways = await arIO.getGateways();
 </script>
@@ -149,7 +149,7 @@ const gateways = arIO.getGateways();
 import { ArIO } from '@ar-io/sdk/node';
 
 // set up client
-const arIO = new ArIO();
+const arIO = ArIO.init();
 // fetch gateways
 const gateways = await arIO.getGateways();
 ```
@@ -160,7 +160,7 @@ const gateways = await arIO.getGateways();
 import { ArIO } from '@ar-io/sdk';
 
 // set up client
-const arIO = new ArIO();
+const arIO = ArIO.init();
 // fetch gateways
 const gateways = await arIO.getGateways();
 ```
@@ -173,29 +173,28 @@ The SDK provides TypeScript types. When you import the SDK in a TypeScript proje
 
 ### APIs
 
-#### `connect(signer)`
+#### `init({ signer })`
 
 Connects an `ArweaveSigner` or `ArConnectSigner` instance to the client for performing `writeInteraction` calls.
 Supported only on clients configured with a `WarpContract` instance.
 
 NOTE: if you have a client configured with a `RemoteContract` instance, it will be overriden with a `WarpContract` instance using the existing configuration of the `RemoteContract` instance when `connect` is executed.
 
 ```typescript
-const arIO = new ArIO();
 
 const browserSigner = new ArConnectSigner(window.arweaveWallet);
-arIO.connect(browserSigner);
+const arIOWriteable = ArIO.init({ signer: browserSigner});
 
 const nodeSigner = new ArweaveSigner(JWK);
-arIO.connect(nodeSigner);
+const arIOWriteable = ArIO.init({ signer: nodeSigner});
 ```
 
 #### `getBalance({ address, evaluationOptions })`
 
 Retrieves the balance of the specified wallet address.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const balance = arIO.getBalance({
   address: 'INSERT_WALLET_ADDRESS',
 });
@@ -214,7 +213,7 @@ Retrieves the balances of the ArIO contract.
  -->
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const balances = arIO.getBalances();
 
 // outputs:
@@ -232,7 +231,7 @@ const balances = arIO.getBalances();
 Retrieves a gateway's info by its staking wallet address.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const gateway = arIO.getGateway({
   address: 'INSERT_GATEWAY_ADDRESS',
 });
@@ -277,7 +276,7 @@ const gateway = arIO.getGateway({
 Retrieves the registered gateways of the ArIO contract.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const gateways = arIO.getGateways();
 
 // outputs:
@@ -327,7 +326,7 @@ const gateways = arIO.getGateways();
 Retrieves the record info of the specified ArNS name.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const record = arIO.getArNSRecord({ domain: 'ardrive' });
 
 // outputs
@@ -346,7 +345,7 @@ const record = arIO.getArNSRecord({ domain: 'ardrive' });
 Retrieves all registered ArNS records of the ArIO contract.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const records = arIO.getArNSRecords();
 
 // outputs:
@@ -375,7 +374,7 @@ const records = arIO.getArNSRecords();
 Returns the epoch-indexed observation list.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const observations = await arIO.getObservations();
 
 // output
@@ -399,7 +398,7 @@ const observations = await arIO.getObservations();
 Returns the current rewards distribution information. The resulting object is pruned, to get older distributions use the `evaluationOptions` to `evalTo` a previous state.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const distributions = await arIO.getDistributions();
 
 // output
@@ -418,7 +417,7 @@ const distributions = await arIO.getDistributions();
 Returns the epoch data for the specified block height.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const epoch = await arIO.getEpoch({ blockHeight: 1382230 });
 
 // output
@@ -438,7 +437,7 @@ const epoch = await arIO.getEpoch({ blockHeight: 1382230 });
 Returns the current epoch data.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const epoch = await arIO.getCurrentEpoch();
 
 // output
@@ -458,7 +457,7 @@ const epoch = await arIO.getCurrentEpoch();
 Retrieves the prescribed observers of the ArIO contract. To fetch prescribed observers for a previous epoch set the `evaluationOptions` to the desired epoch.
 
 ```typescript
-const arIO = new ArIO();
+const arIO = ArIO.init();
 const observers = arIO.getPrescribedObservers();
 
 // outputs:
@@ -569,7 +568,7 @@ const auctions = await arIO.getAuctions({ evaluationOptions });
 // }
 ```
 
-#### `joinNetwork({ ...JoinNetworkParams})`
+#### `joinNetwork({ ...JoinNetworkParams })`
 
 Joins a gateway to the ar.io network via its associated wallet.
 
@@ -593,7 +592,7 @@ const jointNetworkParams = {
 };
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const joinNetworkTx = await authenticatedArIO.joinNetwork(joinNetworkParams);
 
 // joinNetworkTx is an Arweave transaction.
@@ -602,7 +601,7 @@ const joinNetworkTx = await authenticatedArIO.joinNetwork(joinNetworkParams);
 // t4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3
 ```
 
-#### `updateGatewaySettings({ ...UpdateGatewaySettingsParams})`
+#### `updateGatewaySettings({ ...UpdateGatewaySettingsParams })`
 
 Writes new gateway settings to the callers gateway configuration.
 
@@ -613,7 +612,7 @@ const params = {
 
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const updateGatewaySettingsTx =
   await authenticatedArIO.updateGatewaySettings(params);
 
@@ -635,7 +634,7 @@ const params = {
 
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const increaseDelegateStakeTx =
   await authenticatedArIO.increaseDelegateStake(params);
 
@@ -657,7 +656,7 @@ const params = {
 
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const decreaseDelegateStakeTx =
   await authenticatedArIO.decreaseDelegateStake(params);
 
@@ -678,7 +677,7 @@ const params = {
 
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const increaseOperatorStakeTx =
   await authenticatedArIO.increaseOperatorStake(params);
 
@@ -699,7 +698,7 @@ const params = {
 
 const signer = new ArweaveSigner(jwk);
 // connection required for write interactions
-const authenticatedArIO = arIO.connect(signer);
+const authenticatedArIO = ArIO.init({ signer });
 const decreaseOperatorStakeTx =
   await authenticatedArIO.decreaseOperatorStake(params);
 
@@ -715,19 +714,19 @@ The ArIO contract client class exposes APIs relevant to the ar.io contract. It c
 
 ```typescript
 // provide a custom contractTxId to the client and default to remote evaluation
-const remoteCustomArIO = new ArIO({
+const remoteCustomArIO = ArIO.init({
   contractTxId: 'TESTNET_CONTRACT_TX_ID',
 });
 
 // provide a custom contract to the client, and specify local evaluation using warp
-const localCustomArIO = new ArIO({
+const localCustomArIO = ArIO.init({
   contract: new WarpContract<ArIOState>({
     contractTxId: 'TESTNET_CONTRACT_TX_ID',
   }),
 });
 
 // provide a custom contract to the client, and specify local evaluation using remote cache
-const remoteCacheCustomArIO = new ArIO({
+const remoteCacheCustomArIO = ArIO.init({
   contract: new RemoteContract<ArIOState>({
     contractTxId: 'TESTNET_CONTRACT_TX_ID',
   }),

diff --git a/src/common.ts b/src/common.ts
@@ -39,16 +39,14 @@ export type WalletAddress = string;
 
 // TODO: append this with other configuration options (e.g. local vs. remote evaluation)
 export type ContractSigner = ArweaveSigner | ArconnectSigner;
-export type ContractConfiguration = {
-  signer?: ContractSigner; // TODO: optionally allow JWK in place of signer
-} & (
+export type WithSigner = { signer: ContractSigner }; // TODO: optionally allow JWK in place of signer
+export type ContractConfiguration =
   | {
       contract?: WarpContract<unknown> | RemoteContract<unknown>;
     }
   | {
       contractTxId: string;
-    }
-);
+    };
 
 export function isContractConfiguration<T>(
   config: ContractConfiguration,