@ar.io/sdk 3.11.0-alpha.1 → 3.11.0-alpha.2

package/lib/cjs/cli/wayfinder.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const commander_1 = require("commander");
+const version_js_1 = require("../version.js");
+const options_js_1 = require("./options.js");
+const utils_js_1 = require("./utils.js");
+(0, utils_js_1.applyOptions)(commander_1.program
+    .name('ar.io')
+    .version(version_js_1.version)
+    .description('AR.IO Network CLI')
+    .helpCommand(true), options_js_1.globalOptions);
+(0, utils_js_1.makeCommand)({
+    name: '',
+    description: 'Get network info',
+    action: () => {
+        console.log('wayfinder');
+        return Promise.resolve({});
+    },
+});

package/lib/cjs/common/wayfinder/index.js

@@ -34,3 +34,5 @@ __exportStar(require("./wayfinder.js"), exports);
 __exportStar(require("./routers/random.js"), exports);
 __exportStar(require("./routers/priority.js"), exports);
 __exportStar(require("./routers/fixed.js"), exports);
+// gateways providers
+__exportStar(require("./gateways.js"), exports);

package/lib/cjs/common/wayfinder/wayfinder.js

@@ -92,7 +92,9 @@ class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      * });
      */
     router;
@@ -101,7 +103,9 @@ class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      */
@@ -111,7 +115,9 @@ class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      *
@@ -123,12 +129,13 @@ class Wayfinder {
      *
      * @example
      * const { request: wayfind } = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });;
      *
-     * TODO: consider a top level function that supports wayfinder routing under the hood
-     * const response = await wayfind('ar://', {
+     * const response = await wayfind('ar://example', {
      *   method: 'POST',
      *   data: {
      *     name: 'John Doe',

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.11.0-alpha.1';
+exports.version = '3.11.0-alpha.2';

package/lib/esm/cli/wayfinder.js

@@ -0,0 +1,32 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { program } from 'commander';
+import { version } from '../version.js';
+import { globalOptions } from './options.js';
+import { applyOptions, makeCommand } from './utils.js';
+applyOptions(program
+    .name('ar.io')
+    .version(version)
+    .description('AR.IO Network CLI')
+    .helpCommand(true), globalOptions);
+makeCommand({
+    name: '',
+    description: 'Get network info',
+    action: () => {
+        console.log('wayfinder');
+        return Promise.resolve({});
+    },
+});

package/lib/esm/common/wayfinder/index.js

@@ -18,3 +18,5 @@ export * from './wayfinder.js';
 export * from './routers/random.js';
 export * from './routers/priority.js';
 export * from './routers/fixed.js';
+// gateways providers
+export * from './gateways.js';

package/lib/esm/common/wayfinder/wayfinder.js

@@ -87,7 +87,9 @@ export class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      * });
      */
     router;
@@ -96,7 +98,9 @@ export class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      */
@@ -106,7 +110,9 @@ export class Wayfinder {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      *
@@ -118,12 +124,13 @@ export class Wayfinder {
      *
      * @example
      * const { request: wayfind } = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });;
      *
-     * TODO: consider a top level function that supports wayfinder routing under the hood
-     * const response = await wayfind('ar://', {
+     * const response = await wayfind('ar://example', {
      *   method: 'POST',
      *   data: {
      *     name: 'John Doe',

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.11.0-alpha.1';
+export const version = '3.11.0-alpha.2';

package/lib/types/cli/wayfinder.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/common/wayfinder/index.d.ts

@@ -17,3 +17,4 @@ export * from './wayfinder.js';
 export * from './routers/random.js';
 export * from './routers/priority.js';
 export * from './routers/fixed.js';
+export * from './gateways.js';

package/lib/types/common/wayfinder/wayfinder.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 import { WayfinderRouter } from '../../types/wayfinder.js';
-type AnyFunction = (...args: [string, ...unknown[]]) => unknown;
-type WayfinderHttpClient<T extends AnyFunction> = T;
+type HttpClientFunction = (...args: [string, ...unknown[]]) => unknown;
+type WayfinderHttpClient<T extends HttpClientFunction> = T;
 export declare const arnsRegex: RegExp;
 export declare const txIdRegex: RegExp;
 /**
@@ -41,7 +41,7 @@ export declare const resolveWayfinderUrl: ({ originalUrl, targetGateway, }: {
  * @param resolveUrl - the function to construct the redirect url for ar:// requests
  * @returns a wrapped http client that supports ar:// protocol
  */
-export declare const createWayfinderClient: <T extends AnyFunction>({ httpClient, resolveUrl, }: {
+export declare const createWayfinderClient: <T extends HttpClientFunction>({ httpClient, resolveUrl, }: {
     httpClient: T;
     resolveUrl: (params: {
         originalUrl: string | URL;
@@ -53,13 +53,15 @@ export declare const createWayfinderClient: <T extends AnyFunction>({ httpClient
  * @param httpClient - the http client to use for requests
  * @param blocklist - the blocklist of gateways to avoid
  */
-export declare class Wayfinder<T extends AnyFunction> {
+export declare class Wayfinder<T extends HttpClientFunction> {
     /**
      * The router to use for requests
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      * });
      */
     readonly router: WayfinderRouter;
@@ -68,7 +70,9 @@ export declare class Wayfinder<T extends AnyFunction> {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      */
@@ -78,7 +82,9 @@ export declare class Wayfinder<T extends AnyFunction> {
      *
      * @example
      * const wayfinder = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });
      *
@@ -92,12 +98,13 @@ export declare class Wayfinder<T extends AnyFunction> {
      *
      * @example
      * const { request: wayfind } = new Wayfinder({
-     *   router: new RandomGatewayRouter({ ario: ARIO.mainnet() }),
+     *   router: new RandomGatewayRouter({
+     *     gatewaysProvider: new ARIOGatewaysProvider({ ario: ARIO.mainnet() })
+     *   }),
      *   httpClient: axios,
      * });;
      *
-     * TODO: consider a top level function that supports wayfinder routing under the hood
-     * const response = await wayfind('ar://', {
+     * const response = await wayfind('ar://example', {
      *   method: 'POST',
      *   data: {
      *     name: 'John Doe',

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.10.0";
+export declare const version = "3.11.0-alpha.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.11.0-alpha.1",
+  "version": "3.11.0-alpha.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"