chore(init): Remove connect workflow and create factory init method #33

atticusofsparta · 2024-04-05T15:29:45Z

No description provided.

src/utils/common.ts

…ction classes

dtfiedler · 2024-04-09T16:12:13Z

~~mind changing the title of this PR - something like "create init method to support ArIOReadable and ArIOWriteable interfaces and class"~~

dtfiedler · 2024-04-09T16:13:54Z

README.md

@@ -173,29 +173,28 @@ The SDK provides TypeScript types. When you import the SDK in a TypeScript proje

 ### APIs

-#### `connect(signer)`
+#### `init({ signer })`


in the comment below - mention that signer is optional. and if provided ArIOWriteable class is returned that supports write interaction APIs; otherwise an ArIOReadable class is returned and supports read apis only.

README.md

src/common/ar-io.ts

… up docs

…iowritable

README.md

dtfiedler · 2024-04-09T21:25:01Z

src/common.ts

-      contract?:
-        | (BaseContract<unknown> & ReadContract)
-        | (BaseContract<unknown> & ReadWriteContract);
+      contract?: WarpContract<unknown> | RemoteContract<unknown>;


does this need to be optional anymore?

I dont think it actually ever needed to be, since we default it.

If we need an instance where we want to make one nullable, it can be piped thru an Omit type

actually it does need to be optional for a few reasons, mainly to help enable DX, however it may be prudent to create different types rather than forcing use of this one. We should talk on it, i left as is since it was simpler that way for now.

src/common/ar-io.ts

tests/integration/ar-io.test.ts

…lients

dtfiedler · 2024-04-10T18:57:57Z

looking good - can we add write interaction tests?

README.md

dtfiedler · 2024-04-10T19:59:28Z

README.md

-arIO.connect(nodeSigner);
+const arIOWriteable = ArIO.init({ signer: nodeSigner});
+
+const arIOReadable = ArIO.init()


move this up top and add a comment

Suggested change

const arIOReadable = ArIO.init()

// read-only client that has access to all read APIs

const arIOReadable = ArIO.init()

README.md

dtfiedler · 2024-04-10T20:00:34Z

README.md

@@ -569,7 +569,7 @@ const auctions = await arIO.getAuctions({ evaluationOptions });
 // }
 ```

-#### `joinNetwork({ ...JoinNetworkParams})`
+#### `joinNetwork(params)`

 Joins a gateway to the ar.io network via its associated wallet.


add that this requires signer to be provided on init() - and same for the rest of them

Co-authored-by: Dylan Fiedler <dtfiedler@users.noreply.github.com>

dtfiedler · 2024-04-10T20:04:30Z

tests/integration/ar-io.test.ts

+  it('should connect and return a valid instances of read and write clients', async () => {
+    const readClient = ArIO.init({
      contract: new RemoteContract<ArIOState>({
        contractTxId,
        cacheUrl: localCacheUrl,
      }),
    });
-    expect(client.connect(signer)).toBeDefined();
-    expect(client).toBeInstanceOf(ArIO);
+    const writeClient = ArIO.init({
+      signer,
+      contract: new WarpContract<ArIOState>({
+        cacheUrl: localCacheUrl,
+        contractTxId,
+        logger: new DefaultLogger({ level: 'none' }),
+      }),
+    });
+    expect(readClient).toBeDefined();
+    expect(readClient).toBeInstanceOf(ArIOReadable);
+    expect(writeClient).toBeDefined();
+    expect(writeClient).toBeInstanceOf(ArIOWritable);
  });


i would separate these

…on ario contract

dtfiedler · 2024-04-12T02:04:44Z

src/common/contracts/warp-contract.ts

+    //this.contract = this.contract.connect(warpSigner);
+    //this.signer = warpSigner;


Suggested change

//this.contract = this.contract.connect(warpSigner);

//this.signer = warpSigner;

dtfiedler · 2024-04-12T02:04:55Z

src/common/contracts/warp-contract.ts

@@ -54,32 +54,26 @@ export class WarpContract<T>
  private logger: Logger;
  private warp: Warp;
  // warp compatible signer that uses ContractSigner
-  private signer: CustomSignature | undefined;
+  //private signer: CustomSignature | undefined;


Suggested change

//private signer: CustomSignature | undefined;

dtfiedler · 2024-04-12T02:07:53Z

tests/utils.ts

@@ -80,6 +80,8 @@ export async function createLocalWallet(
  const address = await arweave.wallets.jwkToAddress(wallet);
  // mint some tokens
  await arweave.api.get(`/mint/${address}/${amount}`);
+  const walletBalance = await arweave.wallets.getBalance(address);
+  console.log(`Wallet balance: ${walletBalance}`);


Suggested change

console.log(`Wallet balance: ${walletBalance}`);

dtfiedler

some small cleanup nits - but we can merge and finalize everything in the initial PR

dtfiedler · 2024-04-15T16:52:05Z

🎉 This PR is included in version 1.0.0-alpha.20 🎉

The release is available on:

Your semantic-release bot 📦🚀

dtfiedler · 2024-04-23T16:38:25Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

chore(connect): update connect workflow

68b555a

atticusofsparta requested a review from a team as a code owner April 5, 2024 15:29

dtfiedler reviewed Apr 5, 2024

View reviewed changes

src/utils/common.ts Outdated Show resolved Hide resolved

Atticus added 2 commits April 5, 2024 14:45

fix(mixin): filter private methods in mixin util

beb8610

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

765f39c

…ction classes

atticusofsparta force-pushed the connect-workflow branch from f9c25e8 to 765f39c Compare April 9, 2024 15:42

atticusofsparta changed the title ~~chore(connect): update connect workflow~~ chore(init): Remove connect workflow and create factory init method Apr 9, 2024

dtfiedler reviewed Apr 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

src/common/ar-io.ts Outdated Show resolved Hide resolved

Atticus added 2 commits April 9, 2024 10:46

fix(tests): add test cases as a const

8458185

fix(exports): add arweavesigner and arconnectsigner to exports, clean…

c7860ed

… up docs

atticusofsparta force-pushed the connect-workflow branch from d745278 to c7860ed Compare April 9, 2024 21:11

fix(overloads): only accept warp contract as a contract config for ar…

e3c97e9

…iowritable

dtfiedler reviewed Apr 9, 2024

View reviewed changes

README.md Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

src/common/ar-io.ts Outdated Show resolved Hide resolved

dtfiedler reviewed Apr 9, 2024

View reviewed changes

tests/integration/ar-io.test.ts Show resolved Hide resolved

fix(types): update tests, readme, and types

e9985dd

atticusofsparta force-pushed the connect-workflow branch from fb11d97 to e9985dd Compare April 10, 2024 15:35

Atticus added 2 commits April 10, 2024 09:53

fix(contract functions): correct contract function names

ad9bc56

fix(tests): update client instantiation test to check read vs write c…

059653c

…lients

atticusofsparta force-pushed the connect-workflow branch from b069c02 to 059653c Compare April 10, 2024 16:06

dtfiedler reviewed Apr 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

dtfiedler reviewed Apr 10, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

dtfiedler reviewed Apr 10, 2024

View reviewed changes

README.md Show resolved Hide resolved

dtfiedler reviewed Apr 10, 2024

View reviewed changes

atticusofsparta and others added 3 commits April 10, 2024 13:00

chore(readme): update init description

b68ad02

Co-authored-by: Dylan Fiedler <dtfiedler@users.noreply.github.com>

chore(readme): abreviate description of ariowritable

2a0a38b

Co-authored-by: Dylan Fiedler <dtfiedler@users.noreply.github.com>

chore(readme): comment for ariowritable describing apis

f64c97f

Co-authored-by: Dylan Fiedler <dtfiedler@users.noreply.github.com>

dtfiedler reviewed Apr 10, 2024

View reviewed changes

Atticus added 3 commits April 10, 2024 15:29

chore(tests): add arIoWritable tests and testing for write functions …

26b9f53

…on ario contract

chore(tests): add more testing coverage

d324158

chore(readme): update readme examples and comments

977312a

dtfiedler reviewed Apr 12, 2024

View reviewed changes

dtfiedler self-requested a review April 12, 2024 02:10

dtfiedler approved these changes Apr 12, 2024

View reviewed changes

atticusofsparta merged commit 2cad263 into PE-5753-add-gar-methods Apr 12, 2024
8 checks passed

dtfiedler added the released on @alpha label Apr 15, 2024

dtfiedler deleted the connect-workflow branch April 23, 2024 16:29

dtfiedler added the released label Apr 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(init): Remove connect workflow and create factory init method #33

chore(init): Remove connect workflow and create factory init method #33

atticusofsparta commented Apr 5, 2024

dtfiedler commented Apr 9, 2024 •

edited

Loading

dtfiedler Apr 9, 2024

dtfiedler Apr 9, 2024

atticusofsparta Apr 10, 2024

atticusofsparta Apr 10, 2024

atticusofsparta Apr 10, 2024

dtfiedler commented Apr 10, 2024

dtfiedler Apr 10, 2024

dtfiedler Apr 10, 2024

dtfiedler Apr 10, 2024

dtfiedler Apr 12, 2024

dtfiedler Apr 12, 2024

dtfiedler Apr 12, 2024

dtfiedler left a comment

dtfiedler commented Apr 15, 2024

dtfiedler commented Apr 23, 2024

	const arIOReadable = ArIO.init()
	// read-only client that has access to all read APIs
	const arIOReadable = ArIO.init()

		//this.contract = this.contract.connect(warpSigner);
		//this.signer = warpSigner;

chore(init): Remove connect workflow and create factory init method #33

chore(init): Remove connect workflow and create factory init method #33

Conversation

atticusofsparta commented Apr 5, 2024

dtfiedler commented Apr 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dtfiedler commented Apr 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dtfiedler left a comment

Choose a reason for hiding this comment

dtfiedler commented Apr 15, 2024

dtfiedler commented Apr 23, 2024

dtfiedler commented Apr 9, 2024 •

edited

Loading