@xyo-network/xl1-rpc 1.7.11 → 1.7.12

package/README.md

@@ -10,7 +10,7 @@
 
 XYO Layer One API
 
-## Documentation
+
 
 ## Reference
 
@@ -29,6 +29,186 @@ XYO Layer One API
 
   ### classes
 
+    ### <a id="AbstractXyoGateway"></a>AbstractXyoGateway
+
+[**@xyo-network/xl1-rpc**](#../../README)
+
+***
+
+## Extended by
+
+- [`JsonRpcXyoGateway`](#JsonRpcXyoGateway)
+
+## Implements
+
+- `XyoGatewayProvider`
+
+## Constructors
+
+### Constructor
+
+```ts
+new AbstractXyoGateway(): AbstractXyoGateway;
+```
+
+### Returns
+
+`AbstractXyoGateway`
+
+## Methods
+
+### submitTransaction()
+
+```ts
+submitTransaction(elevatedPayloads, additionalPayloads): Promise<HydratedTransaction>;
+```
+
+### Parameters
+
+#### elevatedPayloads
+
+`AllowedBlockPayload`[]
+
+#### additionalPayloads
+
+`Payload`[]
+
+### Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.submitTransaction
+```
+
+***
+
+### activeConnection()
+
+```ts
+abstract activeConnection(): Promisable<undefined | XyoConnectionProvider>;
+```
+
+### Returns
+
+`Promisable`\<`undefined` \| `XyoConnectionProvider`\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.activeConnection
+```
+
+***
+
+### addConnection()
+
+```ts
+abstract addConnection(config): Promisable<XyoConnectionProvider>;
+```
+
+### Parameters
+
+#### config
+
+`XyoRpcConnectionConfig`
+
+### Returns
+
+`Promisable`\<`XyoConnectionProvider`\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.addConnection
+```
+
+***
+
+### connections()
+
+```ts
+abstract connections(): Promisable<Record<string, XyoConnectionProvider>>;
+```
+
+### Returns
+
+`Promisable`\<`Record`\<`string`, `XyoConnectionProvider`\>\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.connections
+```
+
+***
+
+### getPermissions()
+
+```ts
+abstract getPermissions(): Promisable<InvokerPermission[]>;
+```
+
+### Returns
+
+`Promisable`\<`InvokerPermission`[]\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.getPermissions
+```
+
+***
+
+### requestPermissions()
+
+```ts
+abstract requestPermissions(permissions): Promisable<boolean>;
+```
+
+### Parameters
+
+#### permissions
+
+`Permission`[]
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.requestPermissions
+```
+
+***
+
+### revokePermissions()
+
+```ts
+abstract revokePermissions(permissions): Promisable<boolean>;
+```
+
+### Parameters
+
+#### permissions
+
+`Permission`[]
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Implementation of
+
+```ts
+XyoGatewayProvider.revokePermissions
+```
+
     ### <a id="HttpRpcTransport"></a>HttpRpcTransport
 
 [**@xyo-network/xl1-rpc**](#../../README)
@@ -121,9 +301,9 @@ sendRequest<TMethod>(method, params?): Promise<TypeOf<T[TMethod]["result"]["from
 
 ***
 
-## Implements
+## Extends
 
-- `XyoGatewayProvider`
+- [`AbstractXyoGateway`](#AbstractXyoGateway)
 
 ## Constructors
 
@@ -150,8 +330,38 @@ new JsonRpcXyoGateway(transport): JsonRpcXyoGateway;
 
 `JsonRpcXyoGateway`
 
+### Overrides
+
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`constructor`](AbstractXyoGateway.md#constructor)
+
 ## Methods
 
+### submitTransaction()
+
+```ts
+submitTransaction(elevatedPayloads, additionalPayloads): Promise<HydratedTransaction>;
+```
+
+### Parameters
+
+#### elevatedPayloads
+
+`AllowedBlockPayload`[]
+
+#### additionalPayloads
+
+`Payload`[]
+
+### Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+### Inherited from
+
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`submitTransaction`](AbstractXyoGateway.md#submittransaction)
+
+***
+
 ### activeConnection()
 
 ```ts
@@ -162,11 +372,9 @@ activeConnection(): Promisable<undefined | XyoConnectionProvider>;
 
 `Promisable`\<`undefined` \| `XyoConnectionProvider`\>
 
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.activeConnection
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`activeConnection`](AbstractXyoGateway.md#activeconnection)
 
 ***
 
@@ -186,11 +394,9 @@ addConnection(_config): Promisable<XyoConnectionProvider>;
 
 `Promisable`\<`XyoConnectionProvider`\>
 
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.addConnection
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`addConnection`](AbstractXyoGateway.md#addconnection)
 
 ***
 
@@ -204,11 +410,9 @@ connections(): Promisable<Record<string, XyoConnectionProvider>>;
 
 `Promisable`\<`Record`\<`string`, `XyoConnectionProvider`\>\>
 
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.connections
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`connections`](AbstractXyoGateway.md#connections)
 
 ***
 
@@ -222,11 +426,9 @@ getPermissions(): Promisable<InvokerPermission[]>;
 
 `Promisable`\<`InvokerPermission`[]\>
 
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.getPermissions
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`getPermissions`](AbstractXyoGateway.md#getpermissions)
 
 ***
 
@@ -246,11 +448,9 @@ requestPermissions(permissions): Promisable<boolean>;
 
 `Promisable`\<`boolean`\>
 
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.requestPermissions
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`requestPermissions`](AbstractXyoGateway.md#requestpermissions)
 
 ***
 
@@ -270,35 +470,9 @@ revokePermissions(permissions): Promisable<boolean>;
 
 `Promisable`\<`boolean`\>
 
-### Implementation of
-
-```ts
-XyoGatewayProvider.revokePermissions
-```
-
-***
-
-### submitTransaction()
-
-```ts
-submitTransaction(tx): Promise<Lowercase<string>>;
-```
-
-### Parameters
-
-#### tx
-
-`HydratedTransaction`
-
-### Returns
-
-`Promise`\<`Lowercase`\<`string`\>\>
-
-### Implementation of
+### Overrides
 
-```ts
-XyoGatewayProvider.submitTransaction
-```
+[`AbstractXyoGateway`](#AbstractXyoGateway).[`revokePermissions`](AbstractXyoGateway.md#revokepermissions)
 
     ### <a id="JsonRpcXyoRunner"></a>JsonRpcXyoRunner
 
@@ -961,200 +1135,15 @@ status(): Promise<NetworkStatus>;
 XyoNetwork.status
 ```
 
-    ### <a id="MemoryXyoProvider"></a>MemoryXyoProvider
+    ### <a id="MemoryXyoRunner"></a>MemoryXyoRunner
 
 [**@xyo-network/xl1-rpc**](#../../README)
 
 ***
 
-## Extended by
-
-- [`RpcXyoProvider`](#RpcXyoProvider)
-
 ## Implements
 
-- `XyoConnectionProvider`
-
-## Constructors
-
-### Constructor
-
-```ts
-new MemoryXyoProvider(params?): MemoryXyoProvider;
-```
-
-### Parameters
-
-#### params?
-
-##### network?
-
-`XyoNetwork`
-
-##### runner?
-
-`XyoRunner`
-
-##### signer?
-
-`XyoSigner`
-
-##### viewer?
-
-`XyoViewer`
-
-### Returns
-
-`MemoryXyoProvider`
-
-## Accessors
-
-### network
-
-### Get Signature
-
-```ts
-get network(): undefined | XyoNetwork;
-```
-
-#### Returns
-
-`undefined` \| `XyoNetwork`
-
-### Implementation of
-
-```ts
-XyoConnectionProvider.network
-```
-
-***
-
-### runner
-
-### Get Signature
-
-```ts
-get runner(): undefined | XyoRunner;
-```
-
-#### Returns
-
-`undefined` \| `XyoRunner`
-
-### Implementation of
-
-```ts
-XyoConnectionProvider.runner
-```
-
-***
-
-### signer
-
-### Get Signature
-
-```ts
-get signer(): undefined | XyoSigner;
-```
-
-#### Returns
-
-`undefined` \| `XyoSigner`
-
-### Implementation of
-
-```ts
-XyoConnectionProvider.signer
-```
-
-***
-
-### viewer
-
-### Get Signature
-
-```ts
-get viewer(): undefined | XyoViewer;
-```
-
-#### Returns
-
-`undefined` \| `XyoViewer`
-
-### Implementation of
-
-```ts
-XyoConnectionProvider.viewer
-```
-
-## Methods
-
-### ~~send()~~
-
-```ts
-send(
-   elevatedPayloads, 
-   additionalPayloads, 
-   chain?, 
-   nbf?, 
-   exp?, 
-   from?, 
-fees?): Promise<Signed<TransactionBoundWitness>>;
-```
-
-### Parameters
-
-#### elevatedPayloads
-
-`AllowedBlockPayload`[]
-
-#### additionalPayloads
-
-`Payload`[]
-
-#### chain?
-
-`Lowercase`\<`string`\>
-
-#### nbf?
-
-`number`
-
-#### exp?
-
-`number`
-
-#### from?
-
-`Lowercase`\<`string`\>
-
-#### fees?
-
-`TransactionFeesBigInt`
-
-### Returns
-
-`Promise`\<`Signed`\<`TransactionBoundWitness`\>\>
-
-### Deprecated
-
-- use host.submit instead
-
-### Implementation of
-
-```ts
-XyoConnectionProvider.send
-```
-
-    ### <a id="MemoryXyoRunner"></a>MemoryXyoRunner
-
-[**@xyo-network/xl1-rpc**](#../../README)
-
-***
-
-## Implements
-
-- `XyoRunner`
+- `XyoRunner`
 
 ## Constructors
 
@@ -1507,7 +1496,7 @@ sendRequest<TMethod>(method, params?): Promise<TypeOf<T[TMethod]["result"]["from
 
 [`RpcTransport`](#../interfaces/RpcTransport).[`sendRequest`](../interfaces/RpcTransport.md#sendrequest)
 
-    ### <a id="RpcXyoProvider"></a>RpcXyoProvider
+    ### <a id="RpcXyoConnection"></a>RpcXyoConnection
 
 [**@xyo-network/xl1-rpc**](#../../README)
 
@@ -1515,14 +1504,14 @@ sendRequest<TMethod>(method, params?): Promise<TypeOf<T[TMethod]["result"]["from
 
 ## Extends
 
-- [`MemoryXyoProvider`](#MemoryXyoProvider)
+- [`XyoConnection`](#XyoConnection)
 
 ## Constructors
 
 ### Constructor
 
 ```ts
-new RpcXyoProvider(params): RpcXyoProvider;
+new RpcXyoConnection(params): RpcXyoConnection;
 ```
 
 ### Parameters
@@ -1533,11 +1522,11 @@ new RpcXyoProvider(params): RpcXyoProvider;
 
 ### Returns
 
-`RpcXyoProvider`
+`RpcXyoConnection`
 
 ### Overrides
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`constructor`](MemoryXyoProvider.md#constructor)
+[`XyoConnection`](#XyoConnection).[`constructor`](XyoConnection.md#constructor)
 
 ## Accessors
 
@@ -1555,7 +1544,7 @@ get network(): undefined | XyoNetwork;
 
 ### Inherited from
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`network`](MemoryXyoProvider.md#network)
+[`XyoConnection`](#XyoConnection).[`network`](XyoConnection.md#network)
 
 ***
 
@@ -1573,7 +1562,7 @@ get runner(): undefined | XyoRunner;
 
 ### Inherited from
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`runner`](MemoryXyoProvider.md#runner)
+[`XyoConnection`](#XyoConnection).[`runner`](XyoConnection.md#runner)
 
 ***
 
@@ -1591,7 +1580,7 @@ get signer(): undefined | XyoSigner;
 
 ### Inherited from
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`signer`](MemoryXyoProvider.md#signer)
+[`XyoConnection`](#XyoConnection).[`signer`](XyoConnection.md#signer)
 
 ***
 
@@ -1609,10 +1598,39 @@ get viewer(): undefined | XyoViewer;
 
 ### Inherited from
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`viewer`](MemoryXyoProvider.md#viewer)
+[`XyoConnection`](#XyoConnection).[`viewer`](XyoConnection.md#viewer)
 
 ## Methods
 
+### confirm()
+
+```ts
+confirm(
+   tx, 
+   onConfirm?, 
+onTimeout?): Promise<void>;
+```
+
+### Parameters
+
+#### tx
+
+`Signed`\<`TransactionBoundWitness`\>
+
+#### onConfirm?
+
+(`txBWHash`) => `void`
+
+#### onTimeout?
+
+() => `void`
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
 ### ~~send()~~
 
 ```ts
@@ -1662,40 +1680,300 @@ fees?): Promise<Signed<TransactionBoundWitness>>;
 
 ### Deprecated
 
-- use host.submit instead
+use submitTransaction instead
 
 ### Inherited from
 
-[`MemoryXyoProvider`](#MemoryXyoProvider).[`send`](MemoryXyoProvider.md#send)
+[`XyoConnection`](#XyoConnection).[`send`](XyoConnection.md#send)
 
 ***
 
-### confirm()
+### submitTransaction()
 
 ```ts
-confirm(
-   tx, 
-   onConfirm?, 
-onTimeout?): Promise<void>;
+submitTransaction(
+   elevatedPayloads, 
+   additionalPayloads, 
+__namedParameters): Promise<HydratedTransaction>;
 ```
 
 ### Parameters
 
-#### tx
+#### elevatedPayloads
 
-`Signed`\<`TransactionBoundWitness`\>
+`AllowedBlockPayload`[]
 
-#### onConfirm?
+#### additionalPayloads
 
-(`txBWHash`) => `void`
+`Payload`[]
 
-#### onTimeout?
+#### \_\_namedParameters
 
-() => `void`
+##### chain?
+
+`Lowercase`\<`string`\>
+
+##### exp?
+
+`number`
+
+##### fees?
+
+`TransactionFeesBigInt`
+
+##### from?
+
+`Lowercase`\<`string`\>
+
+##### nbf?
+
+`number`
 
 ### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`HydratedTransaction`\>
+
+### Inherited from
+
+[`XyoConnection`](#XyoConnection).[`submitTransaction`](XyoConnection.md#submittransaction)
+
+    ### <a id="XyoConnection"></a>XyoConnection
+
+[**@xyo-network/xl1-rpc**](#../../README)
+
+***
+
+## Extended by
+
+- [`RpcXyoConnection`](#RpcXyoConnection)
+
+## Implements
+
+- `XyoConnectionProvider`
+
+## Constructors
+
+### Constructor
+
+```ts
+new XyoConnection(params?): XyoConnection;
+```
+
+### Parameters
+
+#### params?
+
+##### network?
+
+`XyoNetwork`
+
+##### runner?
+
+`XyoRunner`
+
+##### signer?
+
+`XyoSigner`
+
+##### viewer?
+
+`XyoViewer`
+
+### Returns
+
+`XyoConnection`
+
+## Accessors
+
+### network
+
+### Get Signature
+
+```ts
+get network(): undefined | XyoNetwork;
+```
+
+#### Returns
+
+`undefined` \| `XyoNetwork`
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.network
+```
+
+***
+
+### runner
+
+### Get Signature
+
+```ts
+get runner(): undefined | XyoRunner;
+```
+
+#### Returns
+
+`undefined` \| `XyoRunner`
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.runner
+```
+
+***
+
+### signer
+
+### Get Signature
+
+```ts
+get signer(): undefined | XyoSigner;
+```
+
+#### Returns
+
+`undefined` \| `XyoSigner`
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.signer
+```
+
+***
+
+### viewer
+
+### Get Signature
+
+```ts
+get viewer(): undefined | XyoViewer;
+```
+
+#### Returns
+
+`undefined` \| `XyoViewer`
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.viewer
+```
+
+## Methods
+
+### ~~send()~~
+
+```ts
+send(
+   elevatedPayloads, 
+   additionalPayloads, 
+   chain?, 
+   nbf?, 
+   exp?, 
+   from?, 
+fees?): Promise<Signed<TransactionBoundWitness>>;
+```
+
+### Parameters
+
+#### elevatedPayloads
+
+`AllowedBlockPayload`[]
+
+#### additionalPayloads
+
+`Payload`[]
+
+#### chain?
+
+`Lowercase`\<`string`\>
+
+#### nbf?
+
+`number`
+
+#### exp?
+
+`number`
+
+#### from?
+
+`Lowercase`\<`string`\>
+
+#### fees?
+
+`TransactionFeesBigInt`
+
+### Returns
+
+`Promise`\<`Signed`\<`TransactionBoundWitness`\>\>
+
+### Deprecated
+
+use submitTransaction instead
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.send
+```
+
+***
+
+### submitTransaction()
+
+```ts
+submitTransaction(
+   elevatedPayloads, 
+   additionalPayloads, 
+__namedParameters): Promise<HydratedTransaction>;
+```
+
+### Parameters
+
+#### elevatedPayloads
+
+`AllowedBlockPayload`[]
+
+#### additionalPayloads
+
+`Payload`[]
+
+#### \_\_namedParameters
+
+##### chain?
+
+`Lowercase`\<`string`\>
+
+##### exp?
+
+`number`
+
+##### fees?
+
+`TransactionFeesBigInt`
+
+##### from?
+
+`Lowercase`\<`string`\>
+
+##### nbf?
+
+`number`
+
+### Returns
+
+`Promise`\<`HydratedTransaction`\>
+
+### Implementation of
+
+```ts
+XyoConnectionProvider.submitTransaction
+```
 
   ### functions