@agoric/orchestration 0.1.1-dev-2e2466e.0 → 0.1.1-dev-dcca603.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/orchestration",
-  "version": "0.1.1-dev-2e2466e.0+2e2466e",
+  "version": "0.1.1-dev-dcca603.0+dcca603",
   "description": "Chain abstraction for Agoric's orchestration clients",
   "type": "module",
   "main": "index.js",
@@ -29,18 +29,18 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-2e2466e.0+2e2466e",
-    "@agoric/cosmic-proto": "0.4.1-dev-2e2466e.0+2e2466e",
-    "@agoric/ertp": "0.16.3-dev-2e2466e.0+2e2466e",
-    "@agoric/internal": "0.3.3-dev-2e2466e.0+2e2466e",
-    "@agoric/network": "0.1.1-dev-2e2466e.0+2e2466e",
-    "@agoric/notifier": "0.6.3-dev-2e2466e.0+2e2466e",
-    "@agoric/store": "0.9.3-dev-2e2466e.0+2e2466e",
-    "@agoric/time": "0.3.3-dev-2e2466e.0+2e2466e",
-    "@agoric/vat-data": "0.5.3-dev-2e2466e.0+2e2466e",
-    "@agoric/vats": "0.15.2-dev-2e2466e.0+2e2466e",
-    "@agoric/zoe": "0.26.3-dev-2e2466e.0+2e2466e",
-    "@agoric/zone": "0.2.3-dev-2e2466e.0+2e2466e",
+    "@agoric/assert": "0.6.1-dev-dcca603.0+dcca603",
+    "@agoric/cosmic-proto": "0.4.1-dev-dcca603.0+dcca603",
+    "@agoric/ertp": "0.16.3-dev-dcca603.0+dcca603",
+    "@agoric/internal": "0.3.3-dev-dcca603.0+dcca603",
+    "@agoric/network": "0.1.1-dev-dcca603.0+dcca603",
+    "@agoric/notifier": "0.6.3-dev-dcca603.0+dcca603",
+    "@agoric/store": "0.9.3-dev-dcca603.0+dcca603",
+    "@agoric/time": "0.3.3-dev-dcca603.0+dcca603",
+    "@agoric/vat-data": "0.5.3-dev-dcca603.0+dcca603",
+    "@agoric/vats": "0.15.2-dev-dcca603.0+dcca603",
+    "@agoric/zoe": "0.26.3-dev-dcca603.0+dcca603",
+    "@agoric/zone": "0.2.3-dev-dcca603.0+dcca603",
     "@endo/base64": "^1.0.4",
     "@endo/far": "^1.1.1",
     "@endo/marshal": "^1.4.1",
@@ -82,5 +82,5 @@
   "typeCoverage": {
     "atLeast": 96.39
   },
-  "gitHead": "2e2466e86e6f5417557fa7a0d0f7ca5104061cdd"
+  "gitHead": "dcca603cec5ba954773f176058c6e5a0360a3b2f"
 }

package/src/exos/stakingAccountKit.js

@@ -1,9 +1,14 @@
 // @ts-check
 /** @file Use-object for the owner of a staking account */
+import {
+  MsgWithdrawDelegatorReward,
+  MsgWithdrawDelegatorRewardResponse,
+} from '@agoric/cosmic-proto/cosmos/distribution/v1beta1/tx.js';
 import {
   MsgDelegate,
   MsgDelegateResponse,
 } from '@agoric/cosmic-proto/cosmos/staking/v1beta1/tx.js';
+import { Any } from '@agoric/cosmic-proto/google/protobuf/any.js';
 import { AmountShape } from '@agoric/ertp';
 import { makeTracer } from '@agoric/internal';
 import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
@@ -11,10 +16,9 @@ import { M, prepareExoClassKit } from '@agoric/vat-data';
 import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/index.js';
 import { decodeBase64 } from '@endo/base64';
 import { E } from '@endo/far';
-import { Any } from '@agoric/cosmic-proto/google/protobuf/any.js';
 
 /**
- * @import { ChainAccount, ChainAddress } from '../types.js';
+ * @import { ChainAccount, ChainAddress, ChainAmount, CosmosValidatorAddress } from '../types.js';
  * @import { RecorderKit, MakeRecorderKit } from '@agoric/zoe/src/contractSupport/recorder.js';
  * @import { Baggage } from '@agoric/swingset-liveslots';
  * @import {AnyJson} from '@agoric/cosmic-proto';
@@ -38,10 +42,8 @@ const { Fail } = assert;
 
 const HolderI = M.interface('holder', {
   getPublicTopics: M.call().returns(TopicsRecordShape),
-  makeDelegateInvitation: M.call(M.string(), AmountShape).returns(M.promise()),
-  makeCloseAccountInvitation: M.call().returns(M.promise()),
-  makeTransferAccountInvitation: M.call().returns(M.promise()),
-  delegate: M.callWhen(M.string(), AmountShape).returns(M.string()),
+  delegate: M.callWhen(M.string(), AmountShape).returns(M.record()),
+  withdrawReward: M.callWhen(M.string()).returns(M.array()),
 });
 
 /** @type {{ [name: string]: [description: string, valueShape: Pattern] }} */
@@ -49,6 +51,33 @@ const PUBLIC_TOPICS = {
   account: ['Staking Account holder status', M.any()],
 };
 
+// UNTIL https://github.com/cosmology-tech/telescope/issues/605
+/**
+ * @param {Any} x
+ * @returns {AnyJson}
+ */
+const toAnyJSON = x => /** @type {AnyJson} */ (Any.toJSON(x));
+
+/**
+ * @template T
+ * @param {string} ackStr
+ * @param {(p: {typeUrl: string, value: Uint8Array}) => T} fromProtoMsg
+ */
+export const tryDecodeResponse = (ackStr, fromProtoMsg) => {
+  try {
+    const any = Any.decode(decodeBase64(ackStr));
+    const protoMsg = Any.decode(any.value);
+
+    const msg = fromProtoMsg(protoMsg);
+    return msg;
+  } catch (cause) {
+    throw assert.error(`bad response: ${ackStr}`, undefined, { cause });
+  }
+};
+
+/** @type {(c: { denom: string, amount: string }) => ChainAmount} */
+const toChainAmount = c => ({ denom: c.denom, value: BigInt(c.amount) });
+
 /**
  * @param {Baggage} baggage
  * @param {MakeRecorderKit} makeRecorderKit
@@ -62,10 +91,10 @@ export const prepareStakingAccountKit = (baggage, makeRecorderKit, zcf) => {
       helper: UnguardedHelperI,
       holder: HolderI,
       invitationMakers: M.interface('invitationMakers', {
-        Delegate: HolderI.payload.methodGuards.makeDelegateInvitation,
-        CloseAccount: HolderI.payload.methodGuards.makeCloseAccountInvitation,
-        TransferAccount:
-          HolderI.payload.methodGuards.makeTransferAccountInvitation,
+        Delegate: M.call(M.string(), AmountShape).returns(M.promise()),
+        WithdrawReward: M.call(M.string()).returns(M.promise()),
+        CloseAccount: M.call().returns(M.promise()),
+        TransferAccount: M.call().returns(M.promise()),
       }),
     },
     /**
@@ -93,58 +122,39 @@ export const prepareStakingAccountKit = (baggage, makeRecorderKit, zcf) => {
         getUpdater() {
           return this.state.topicKit.recorder;
         },
-        // TODO move this beneath the Orchestration abstraction,
-        // to the OrchestrationAccount provided by makeAccount()
+      },
+      invitationMakers: {
         /**
-         * _Assumes users has already sent funds to their ICA, until #9193
+         *
          * @param {string} validatorAddress
-         * @param {Amount<'nat'>} ertpAmount
+         * @param {Amount<'nat'>} amount
          */
-        async delegate(validatorAddress, ertpAmount) {
-          // FIXME get values from proposal or args
-          // FIXME brand handling and amount scaling
-          const amount = {
-            amount: String(ertpAmount.value),
-            denom: 'uatom',
-          };
-
-          const account = this.facets.helper.owned();
-          const delegatorAddress = this.state.chainAddress.address;
-
-          const result = await E(account).executeEncodedTx([
-            /** @type {AnyJson} */ (
-              Any.toJSON(
-                MsgDelegate.toProtoMsg({
-                  delegatorAddress,
-                  validatorAddress,
-                  amount,
-                }),
-              )
-            ),
-          ]);
+        Delegate(validatorAddress, amount) {
+          trace('Delegate', validatorAddress, amount);
 
-          if (!result) throw Fail`Failed to delegate.`;
-          try {
-            const decoded = MsgDelegateResponse.decode(decodeBase64(result));
-            if (JSON.stringify(decoded) === '{}') return 'Success';
-            throw Fail`Unexpected response: ${result}`;
-          } catch (e) {
-            throw Fail`Unable to decode result: ${result}`;
-          }
+          return zcf.makeInvitation(async seat => {
+            seat.exit();
+            return this.facets.holder.delegate(validatorAddress, amount);
+          }, 'Delegate');
         },
-      },
-      invitationMakers: {
-        Delegate(validatorAddress, amount) {
-          return this.facets.holder.makeDelegateInvitation(
-            validatorAddress,
-            amount,
-          );
+        /** @param {string} validatorAddress */
+        WithdrawReward(validatorAddress) {
+          trace('WithdrawReward', validatorAddress);
+
+          return zcf.makeInvitation(async seat => {
+            seat.exit();
+            return this.facets.holder.withdrawReward(validatorAddress);
+          }, 'WithdrawReward');
         },
         CloseAccount() {
-          return this.facets.holder.makeCloseAccountInvitation();
+          throw Error('not yet implemented');
         },
+        /**
+         * Starting a transfer revokes the account holder. The associated updater
+         * will get a special notification that the account is being transferred.
+         */
         TransferAccount() {
-          return this.facets.holder.makeTransferAccountInvitation();
+          throw Error('not yet implemented');
         },
       },
       holder: {
@@ -158,37 +168,59 @@ export const prepareStakingAccountKit = (baggage, makeRecorderKit, zcf) => {
             },
           });
         },
+        // TODO move this beneath the Orchestration abstraction,
+        // to the OrchestrationAccount provided by makeAccount()
         /**
-         *
+         * _Assumes users has already sent funds to their ICA, until #9193
          * @param {string} validatorAddress
          * @param {Amount<'nat'>} ertpAmount
          */
         async delegate(validatorAddress, ertpAmount) {
           trace('delegate', validatorAddress, ertpAmount);
-          return this.facets.helper.delegate(validatorAddress, ertpAmount);
-        },
-        /**
-         *
-         * @param {string} validatorAddress
-         * @param {Amount<'nat'>} ertpAmount
-         */
-        makeDelegateInvitation(validatorAddress, ertpAmount) {
-          trace('makeDelegateInvitation', validatorAddress, ertpAmount);
 
-          return zcf.makeInvitation(async seat => {
-            seat.exit();
-            return this.facets.helper.delegate(validatorAddress, ertpAmount);
-          }, 'Delegate');
-        },
-        makeCloseAccountInvitation() {
-          throw Error('not yet implemented');
+          // FIXME get values from proposal or args
+          // FIXME brand handling and amount scaling
+          trace('TODO: handle brand', ertpAmount);
+          const amount = {
+            amount: String(ertpAmount.value),
+            denom: 'uatom',
+          };
+
+          const account = this.facets.helper.owned();
+          const delegatorAddress = this.state.chainAddress.address;
+
+          const result = await E(account).executeEncodedTx([
+            toAnyJSON(
+              MsgDelegate.toProtoMsg({
+                delegatorAddress,
+                validatorAddress,
+                amount,
+              }),
+            ),
+          ]);
+
+          if (!result) throw Fail`Failed to delegate.`;
+          return tryDecodeResponse(result, MsgDelegateResponse.fromProtoMsg);
         },
+
         /**
-         * Starting a transfer revokes the account holder. The associated updater
-         * will get a special notification that the account is being transferred.
+         * @param {string} validatorAddress
+         * @returns {Promise<ChainAmount[]>}
          */
-        makeTransferAccountInvitation() {
-          throw Error('not yet implemented');
+        async withdrawReward(validatorAddress) {
+          const { chainAddress } = this.state;
+          assert.typeof(validatorAddress, 'string');
+          const msg = MsgWithdrawDelegatorReward.toProtoMsg({
+            delegatorAddress: chainAddress.address,
+            validatorAddress,
+          });
+          const account = this.facets.helper.owned();
+          const result = await E(account).executeEncodedTx([toAnyJSON(msg)]);
+          const { amount: coins } = tryDecodeResponse(
+            result,
+            MsgWithdrawDelegatorRewardResponse.fromProtoMsg,
+          );
+          return harden(coins.map(toChainAmount));
         },
       },
     },