@aeternity/aepp-sdk 12.0.0 → 12.1.0

package/src/aepp-wallet-communication/schema.ts

@@ -1,21 +1,34 @@
-import { EncodedData } from '../utils/encoder'
-import { BaseError, InternalError } from '../utils/errors'
+// eslint-disable-next-line max-classes-per-file
+import { Encoded } from '../utils/encoder';
+import { BaseError, InternalError } from '../utils/errors';
 
+/**
+ * @category aepp wallet communication
+ */
 export const enum MESSAGE_DIRECTION {
   to_waellet = 'to_waellet',
-  to_aepp = 'to_aepp'
+  to_aepp = 'to_aepp',
 }
 
+/**
+ * @category aepp wallet communication
+ */
 export const enum WALLET_TYPE {
   window = 'window',
-  extension = 'extension'
+  extension = 'extension',
 }
 
+/**
+ * @category aepp wallet communication
+ */
 export const enum SUBSCRIPTION_TYPES {
   subscribe = 'subscribe',
-  unsubscribe = 'unsubscribe'
+  unsubscribe = 'unsubscribe',
 }
 
+/**
+ * @category aepp wallet communication
+ */
 export const enum METHODS {
   readyToConnect = 'connection.announcePresence',
   updateAddress = 'address.update',
@@ -25,45 +38,48 @@ export const enum METHODS {
   signMessage = 'message.sign',
   subscribeAddress = 'address.subscribe',
   updateNetwork = 'networkId.update',
-  closeConnection = 'connection.close'
+  closeConnection = 'connection.close',
 }
 
+/**
+ * @category aepp wallet communication
+ */
 export const enum RPC_STATUS {
   CONNECTED = 'CONNECTED',
   DISCONNECTED = 'DISCONNECTED',
-  WAITING_FOR_CONNECTION_REQUEST = 'WAITING_FOR_CONNECTION_REQUEST'
+  WAITING_FOR_CONNECTION_REQUEST = 'WAITING_FOR_CONNECTION_REQUEST',
 }
 
 interface RpcErrorAsJson {
-  code: number
-  message: string
-  data?: any
+  code: number;
+  message: string;
+  data?: any;
 }
 
+const rpcErrors: Array<(new (data?: any) => RpcError) & { code: number }> = [];
+
 /**
  * @category exception
  */
 export abstract class RpcError extends BaseError {
-  static code: number
-  code: number
-  data?: any
+  static code: number;
+
+  code: number;
 
-  toJSON (): RpcErrorAsJson {
+  data?: any;
+
+  toJSON(): RpcErrorAsJson {
     return {
       code: this.code,
       message: this.message,
-      data: this.data
-    }
+      data: this.data,
+    };
   }
 
-  static deserialize (json: RpcErrorAsJson): RpcError {
-    const RpcErr = [
-      RpcInvalidTransactionError, RpcBroadcastError, RpcRejectedByUserError,
-      RpcUnsupportedProtocolError, RpcConnectionDenyError, RpcNotAuthorizeError,
-      RpcPermissionDenyError, RpcInternalError
-    ].find(cl => cl.code === json.code)
-    if (RpcErr == null) throw new InternalError(`Can't find RpcError with code: ${json.code}`)
-    return new RpcErr(json.data)
+  static deserialize(json: RpcErrorAsJson): RpcError {
+    const RpcErr = rpcErrors.find((cl) => cl.code === json.code);
+    if (RpcErr == null) throw new InternalError(`Can't find RpcError with code: ${json.code}`);
+    return new RpcErr(json.data);
   }
 }
 
@@ -71,111 +87,138 @@ export abstract class RpcError extends BaseError {
  * @category exception
  */
 export class RpcInvalidTransactionError extends RpcError {
-  static code = 2
-  code = 2
-  constructor (data?: any) {
-    super('Invalid transaction')
-    this.data = data
-    this.name = 'RpcInvalidTransactionError'
+  static code = 2;
+
+  code = 2;
+
+  constructor(data?: any) {
+    super('Invalid transaction');
+    this.data = data;
+    this.name = 'RpcInvalidTransactionError';
   }
 }
+rpcErrors.push(RpcInvalidTransactionError);
 
 /**
  * @category exception
  */
 export class RpcBroadcastError extends RpcError {
-  static code = 3
-  code = 3
-  constructor (data?: any) {
-    super('Broadcast failed')
-    this.data = data
-    this.name = 'RpcBroadcastError'
+  static code = 3;
+
+  code = 3;
+
+  constructor(data?: any) {
+    super('Broadcast failed');
+    this.data = data;
+    this.name = 'RpcBroadcastError';
   }
 }
+rpcErrors.push(RpcBroadcastError);
 
 /**
  * @category exception
  */
 export class RpcRejectedByUserError extends RpcError {
-  static code = 4
-  code = 4
-  constructor (data?: any) {
-    super('Operation rejected by user')
-    this.data = data
-    this.name = 'RpcRejectedByUserError'
+  static code = 4;
+
+  code = 4;
+
+  constructor(data?: any) {
+    super('Operation rejected by user');
+    this.data = data;
+    this.name = 'RpcRejectedByUserError';
   }
 }
+rpcErrors.push(RpcRejectedByUserError);
 
 /**
  * @category exception
  */
 export class RpcUnsupportedProtocolError extends RpcError {
-  static code = 5
-  code = 5
-  constructor () {
-    super('Unsupported Protocol Version')
-    this.name = 'RpcUnsupportedProtocolError'
+  static code = 5;
+
+  code = 5;
+
+  constructor() {
+    super('Unsupported Protocol Version');
+    this.name = 'RpcUnsupportedProtocolError';
   }
 }
+rpcErrors.push(RpcUnsupportedProtocolError);
 
 /**
  * @category exception
  */
 export class RpcConnectionDenyError extends RpcError {
-  static code = 9
-  code = 9
-  constructor (data?: any) {
-    super('Wallet deny your connection request')
-    this.data = data
-    this.name = 'RpcConnectionDenyError'
+  static code = 9;
+
+  code = 9;
+
+  constructor(data?: any) {
+    super('Wallet deny your connection request');
+    this.data = data;
+    this.name = 'RpcConnectionDenyError';
   }
 }
+rpcErrors.push(RpcConnectionDenyError);
 
 /**
  * @category exception
  */
 export class RpcNotAuthorizeError extends RpcError {
-  static code = 10
-  code = 10
-  constructor () {
-    super('You are not connected to the wallet')
-    this.name = 'RpcNotAuthorizeError'
+  static code = 10;
+
+  code = 10;
+
+  constructor() {
+    super('You are not connected to the wallet');
+    this.name = 'RpcNotAuthorizeError';
   }
 }
+rpcErrors.push(RpcNotAuthorizeError);
 
 /**
  * @category exception
  */
 export class RpcPermissionDenyError extends RpcError {
-  static code = 11
-  code = 11
-  constructor (address: EncodedData<'ak'>) {
-    super(`You are not subscribed for account ${address}`)
-    this.data = address
-    this.name = 'RpcPermissionDenyError'
+  static code = 11;
+
+  code = 11;
+
+  constructor(address: Encoded.AccountAddress) {
+    super(`You are not subscribed for account ${address}`);
+    this.data = address;
+    this.name = 'RpcPermissionDenyError';
   }
 }
+rpcErrors.push(RpcPermissionDenyError);
 
 /**
  * @category exception
  */
 export class RpcInternalError extends RpcError {
-  static code = 12
-  code = 12
-  constructor () {
-    super('The peer failed to execute your request due to unknown error')
-    this.name = 'RpcInternalError'
+  static code = 12;
+
+  code = 12;
+
+  constructor() {
+    super('The peer failed to execute your request due to unknown error');
+    this.name = 'RpcInternalError';
   }
 }
+rpcErrors.push(RpcInternalError);
 
 /**
  * @category exception
  */
 export class RpcMethodNotFoundError extends RpcError {
-  static code = -32601
-  code = -32601
-  constructor () {
-    super('Method not found')
-    this.name = 'RpcMethodNotFoundError'
+  static code = -32601;
+
+  code = -32601;
+
+  constructor() {
+    super('Method not found');
+    this.name = 'RpcMethodNotFoundError';
   }
 }
+rpcErrors.push(RpcMethodNotFoundError);

package/src/aepp-wallet-communication/wallet-detector.ts

@@ -15,57 +15,58 @@
  *  PERFORMANCE OF THIS SOFTWARE.
  */
 
-import BrowserConnection from './connection/Browser'
-import BrowserWindowMessageConnection from './connection/BrowserWindowMessage'
-import { MESSAGE_DIRECTION, METHODS } from './schema'
-import { UnsupportedPlatformError } from '../utils/errors'
+import BrowserConnection from './connection/Browser';
+import BrowserWindowMessageConnection from './connection/BrowserWindowMessage';
+import { MESSAGE_DIRECTION, METHODS } from './schema';
+import { UnsupportedPlatformError } from '../utils/errors';
 
 interface Wallet {
   info: {
-    id: string
-    type: string
-    origin: string
-  }
-  getConnection: () => BrowserWindowMessageConnection
+    id: string;
+    type: string;
+    origin: string;
+  };
+  getConnection: () => BrowserWindowMessageConnection;
 }
 interface Wallets { [key: string]: Wallet }
 
 /**
  * A function to detect available wallets
+ * @category aepp wallet communication
  * @param connection - connection to use to detect wallets
  * @param onDetected - call-back function which trigger on new wallet
  * @returns a function to stop scanning
  */
 export default (
-  connection: BrowserConnection = new BrowserWindowMessageConnection(),
-  onDetected: ({ wallets, newWallet }: { wallets: Wallets, newWallet?: Wallet }) => void
+  connection: BrowserConnection,
+  onDetected: ({ wallets, newWallet }: { wallets: Wallets; newWallet?: Wallet }) => void,
 ): () => void => {
-  if (window == null) throw new UnsupportedPlatformError('Window object not found, you can run wallet detector only in browser')
-  const wallets: Wallets = {}
+  if (window == null) throw new UnsupportedPlatformError('Window object not found, you can run wallet detector only in browser');
+  const wallets: Wallets = {};
 
   connection.connect((
-    { method, params }: { method: string, params: Wallet['info'] },
+    { method, params }: { method: string; params: Wallet['info'] },
     origin: string,
-    source: Window
+    source: Window,
   ) => {
-    if (method !== METHODS.readyToConnect || wallets[params.id] != null) return
+    if (method !== METHODS.readyToConnect || wallets[params.id] != null) return;
 
     const wallet = {
       info: params,
-      getConnection () {
-        const isExtension = params.type === 'extension'
+      getConnection() {
+        const isExtension = params.type === 'extension';
         return new BrowserWindowMessageConnection({
           sendDirection: isExtension ? MESSAGE_DIRECTION.to_waellet : undefined,
           receiveDirection: isExtension ? MESSAGE_DIRECTION.to_aepp : undefined,
           target: source,
-          origin: isExtension ? window.origin : params.origin
-        })
-      }
-    }
-    wallets[wallet.info.id] = wallet
-    onDetected({ wallets, newWallet: wallet })
-  }, () => {})
-  if (Object.keys(wallets).length > 0) onDetected({ wallets })
+          origin: isExtension ? window.origin : params.origin,
+        });
+      },
+    };
+    wallets[wallet.info.id] = wallet;
+    onDetected({ wallets, newWallet: wallet });
+  }, () => {});
+  if (Object.keys(wallets).length > 0) onDetected({ wallets });
 
-  return () => connection.disconnect()
-}
+  return () => connection.disconnect();
+};

package/src/apis/node/code-model-v4.yaml

@@ -352,26 +352,6 @@ schemas: !Schemas
           name: DryRunResultReason
           description: ''
       protocol: !Protocols {}
-    - !StringSchema &ref_57
-      type: string
-      apiVersions:
-        - !ApiVersion 
-          version: x.y.z
-      language: !Languages 
-        default:
-          name: ContractCallObjectReturnType
-          description: The status of the call 'ok | error | revert'.
-      protocol: !Protocols {}
-    - !StringSchema &ref_62
-      type: string
-      apiVersions:
-        - !ApiVersion 
-          version: x.y.z
-      language: !Languages 
-        default:
-          name: GAObjectReturnType
-          description: The status of the call 'ok | error'.
-      protocol: !Protocols {}
     - !StringSchema &ref_64
       type: string
       apiVersions:
@@ -829,6 +809,60 @@ schemas: !Schemas
           name: NextNonceStrategy
           description: ''
       protocol: !Protocols {}
+    - !SealedChoiceSchema &ref_57
+      choices:
+        - !ChoiceValue 
+          value: ok
+          language:
+            default:
+              name: Ok
+              description: ''
+        - !ChoiceValue 
+          value: error
+          language:
+            default:
+              name: Error
+              description: ''
+        - !ChoiceValue 
+          value: revert
+          language:
+            default:
+              name: Revert
+              description: ''
+      type: sealed-choice
+      apiVersions:
+        - !ApiVersion 
+          version: x.y.z
+      choiceType: *ref_0
+      language: !Languages 
+        default:
+          name: ContractCallReturnType
+          description: The status of the call 'ok | error | revert'.
+      protocol: !Protocols {}
+    - !SealedChoiceSchema &ref_62
+      choices:
+        - !ChoiceValue 
+          value: ok
+          language:
+            default:
+              name: Ok
+              description: ''
+        - !ChoiceValue 
+          value: error
+          language:
+            default:
+              name: Error
+              description: ''
+      type: sealed-choice
+      apiVersions:
+        - !ApiVersion 
+          version: x.y.z
+      choiceType: *ref_0
+      language: !Languages 
+        default:
+          name: GAReturnType
+          description: The status of the call 'ok | error'.
+      protocol: !Protocols {}
     - !SealedChoiceSchema &ref_169
       choices:
         - !ChoiceValue 

package/src/apis/node/models/index.ts

@@ -332,7 +332,7 @@ export interface ContractCallObject {
   /** Base64Check encoded tagged byte array */
   returnValue: string;
   /** The status of the call 'ok | error | revert'. */
-  returnType: string;
+  returnType: ContractCallReturnType;
 }
 
 export interface Event {
@@ -359,7 +359,7 @@ export interface GAObject {
   /** Base64Check encoded tagged byte array */
   returnValue: string;
   /** The status of the call 'ok | error'. */
-  returnType: string;
+  returnType: GAReturnType;
   innerObject?: TxInfoObject;
 }
 
@@ -991,6 +991,10 @@ export type TxType =
 export type AccountKind = "basic" | "generalized";
 /** Defines values for NextNonceStrategy. */
 export type NextNonceStrategy = "max" | "continuity";
+/** Defines values for ContractCallReturnType. */
+export type ContractCallReturnType = "ok" | "error" | "revert";
+/** Defines values for GAReturnType. */
+export type GAReturnType = "ok" | "error";
 /** Defines values for OracleQueryType. */
 export type OracleQueryType = "open" | "closed" | "all";
 

package/src/apis/node/models/mappers.ts

@@ -1425,7 +1425,8 @@ export const ContractCallObject: coreClient.CompositeMapper = {
         serializedName: "return_type",
         required: true,
         type: {
-          name: "String"
+          name: "Enum",
+          allowedValues: ["ok", "error", "revert"]
         }
       }
     }
@@ -1540,7 +1541,8 @@ export const GAObject: coreClient.CompositeMapper = {
         serializedName: "return_type",
         required: true,
         type: {
-          name: "String"
+          name: "Enum",
+          allowedValues: ["ok", "error"]
         }
       },
       innerObject: {