chore: minor updates to current API (#5)

* feat: adapt + extend current API

* doc: add docs link to readme

README.md

@@ -2,6 +2,8 @@
 
 IronForge SDK
 
+[Docs](https://ironforge-cloud.github.io/sdk/docs/)
+
 ## Example
 
 ```ts

package.json

@@ -17,7 +17,6 @@
   ],
   "author": "Thorsten Lorenz <thlorenz@gmx.de>",
   "license": "MIT",
-  "private": true,
   "devDependencies": {
     "@types/node": "^20.5.1",
     "esbuild": "^0.19.2",

src/sdk.ts

@@ -1,11 +1,10 @@
 import { AccountsSdk } from './accounts'
-import { PLATFORM_ENV_PROD, PlatformEnv } from './types'
-import { accountsHostForEnv } from './utils'
+import { accountsHostWithPrefix } from './utils'
 
 export * from './accounts'
 export * from './types'
 export * from './utils/cluster'
-export { accountsHostForEnv } from './utils'
+export { accountsHostWithPrefix, rpcHostWithPrefix } from './utils'
 
 /**
  * The Ironforge SDK which is used as an entry point to all available SDK methods.
@@ -16,13 +15,13 @@ export class IronforgeSdk {
   /**
    * Creates a new Ironforge SDK instance.
    * @param apiKey The API key to use for all requests.
-   * @param env The environment to use for all requests, only provide this if you work at Ironforge :)
+   * @param prefix The environment to use for all requests, only provide this if you work at Ironforge :)
    */
   constructor(
     public apiKey: string,
-    env: PlatformEnv = PLATFORM_ENV_PROD
+    prefix?: string
   ) {
-    this._accountsHost = accountsHostForEnv(env)
+    this._accountsHost = accountsHostWithPrefix(prefix)
   }
 
   /**

src/types.ts

@@ -54,37 +54,3 @@ export type AccountsRequestResultWithMetadata<T> = AccountsRequestResult<
     hasMore: boolean
   }
 }
-
-// -----------------
-// PlatformEnv
-// -----------------
-
-/**
- * Dev environment, used to develop the Ironforge platform.
- */
-export const PLATFORM_ENV_DEV = 'dev'
-
-/**
- * Stage environment, used to test the Ironforge platform.
- */
-export const PLATFORM_ENV_STAGE = 'stage'
-
-/**
- * Prod environment, used to run the Ironforge platform.
- * This is the environment that all users of the SDK outside of Ironforge should use.
- */
-export const PLATFORM_ENV_PROD = 'prod'
-
-/**
- * All possible platform environments.
- */
-export const PLATFORM_ENVS = [
-  PLATFORM_ENV_DEV,
-  PLATFORM_ENV_STAGE,
-  PLATFORM_ENV_PROD,
-] as const
-
-/**
- * PlatformEnv is a union type of all possible platform environments.
- */
-export type PlatformEnv = (typeof PLATFORM_ENVS)[number]

src/utils/index.ts

@@ -1,5 +1,3 @@
-import { PLATFORM_ENV_PROD, PlatformEnv } from '../types'
-
 export * from './cluster'
 
 export async function tryExtractResultFromResponse<T>(
@@ -32,10 +30,18 @@ export function requestHeaders(headers: Partial<RequestHeaders> = {}) {
 
 /**
  * Returns the accounts host for the given environment.
- * @param env The environment to use for all requests, provide
- * [PLATFORM_ENV_PROD] unless you work at Ironforge :)
+ * @param maybePrefix The prefix use for all requests, provide
  */
-export function accountsHostForEnv(env: PlatformEnv) {
-  const prefix = env === PLATFORM_ENV_PROD ? '' : `${env}.`
+export function accountsHostWithPrefix(maybePrefix?: string) {
+  const prefix = maybePrefix == null ? '' : `${maybePrefix}.`
   return `${prefix}accounts.ironforge.network`
 }
+
+/**
+ * Returns the RPC host for the given environment.
+ * @param maybePrefix The prefix use for all requests, provide
+ */
+export function rpcHostWithPrefix(maybePrefix?: string) {
+  const prefix = maybePrefix == null ? '' : `${maybePrefix}.`
+  return `${prefix}rpc.ironforge.network`
+}