Expose extra program pages to API (algorand#2294)

Add the AppsTotalExtraPages account field to the response returned by the /v2/accounts/{addr} endpoint.

Author: jasonpaulos

daemon/algod/api/algod.oas2.json

@@ -1229,6 +1229,10 @@
           "description": "\\[tsch\\] stores the sum of all of the local schemas and global schemas in this account.\n\nNote: the raw account uses `StateSchema` for this type.",
           "$ref": "#/definitions/ApplicationStateSchema"
         },
+        "apps-total-extra-pages": {
+          "description": "\\[teap\\] the sum of all extra application program pages for this account.",
+          "type": "integer"
+        },
         "assets": {
           "description": "\\[asset\\] assets held by this account.\n\nNote the raw object uses `map[int] -\u003e AssetHolding` for this type.",
           "type": "array",
@@ -1626,6 +1630,10 @@
           "format": "byte",
           "x-algorand-format": "TEALProgram"
         },
+        "extra-program-pages": {
+          "description": "\\[epp\\] the amount of extra program pages available to this app.",
+          "type": "integer"
+        },
         "local-state-schema": {
           "description": "[\\lsch\\] local schema",
           "$ref": "#/definitions/ApplicationStateSchema"

daemon/algod/api/algod.oas3.yml

@@ -716,6 +716,10 @@
             },
             "type": "array"
           },
+          "apps-total-extra-pages": {
+            "description": "\\[teap\\] the sum of all extra application program pages for this account.",
+            "type": "integer"
+          },
           "apps-total-schema": {
             "$ref": "#/components/schemas/ApplicationStateSchema"
           },
@@ -901,6 +905,10 @@
             "type": "string",
             "x-algorand-format": "Address"
           },
+          "extra-program-pages": {
+            "description": "\\[epp\\] the amount of extra program pages available to this app.",
+            "type": "integer"
+          },
           "global-state": {
             "$ref": "#/components/schemas/TealKeyValueStore"
           },

daemon/algod/api/server/v2/account.go

@@ -19,6 +19,7 @@ package v2
 import (
 	"encoding/base64"
 	"errors"
+	"math"
 	"sort"
 
 	"github.com/algorand/go-algorand/crypto"
@@ -99,6 +100,7 @@ func AccountDataToAccount(
 		NumByteSlice: record.TotalAppSchema.NumByteSlice,
 		NumUint:      record.TotalAppSchema.NumUint,
 	}
+	totalExtraPages := uint64(record.TotalExtraAppPages)
 
 	amount := record.MicroAlgos
 	pendingRewards, overflowed := basics.OSubA(amount, amountWithoutPendingRewards)
@@ -123,6 +125,7 @@ func AccountDataToAccount(
 		AuthAddr:                    addrOrNil(record.AuthAddr),
 		AppsLocalState:              &appsLocalState,
 		AppsTotalSchema:             &totalAppSchema,
+		AppsTotalExtraPages:         &totalExtraPages,
 	}, nil
 }
 
@@ -308,6 +311,14 @@ func AccountToAccountData(a *generated.Account) (basics.AccountData, error) {
 		totalSchema.NumByteSlice = a.AppsTotalSchema.NumByteSlice
 	}
 
+	var totalExtraPages uint32
+	if a.AppsTotalExtraPages != nil {
+		if *a.AppsTotalExtraPages > math.MaxUint32 {
+			return basics.AccountData{}, errors.New("AppsTotalExtraPages exceeds maximum decodable value")
+		}
+		totalExtraPages = uint32(*a.AppsTotalExtraPages)
+	}
+
 	status, err := basics.UnmarshalStatus(a.Status)
 	if err != nil {
 		return basics.AccountData{}, err
@@ -327,6 +338,7 @@ func AccountToAccountData(a *generated.Account) (basics.AccountData, error) {
 		AppLocalStates:     appLocalStates,
 		AppParams:          appParams,
 		TotalAppSchema:     totalSchema,
+		TotalExtraAppPages: totalExtraPages,
 	}
 
 	if a.AuthAddr != nil {
@@ -358,6 +370,12 @@ func ApplicationParamsToAppParams(gap *generated.ApplicationParams) (basics.AppP
 		ApprovalProgram:   gap.ApprovalProgram,
 		ClearStateProgram: gap.ClearStateProgram,
 	}
+	if gap.ExtraProgramPages != nil {
+		if *gap.ExtraProgramPages > math.MaxUint32 {
+			return basics.AppParams{}, errors.New("ExtraProgramPages exceeds maximum decodable value")
+		}
+		ap.ExtraProgramPages = uint32(*gap.ExtraProgramPages)
+	}
 	if gap.LocalStateSchema != nil {
 		ap.LocalStateSchema = basics.StateSchema{
 			NumUint:      gap.LocalStateSchema.NumUint,
@@ -382,12 +400,14 @@ func ApplicationParamsToAppParams(gap *generated.ApplicationParams) (basics.AppP
 // AppParamsToApplication converts basics.AppParams to generated.Application
 func AppParamsToApplication(creator string, appIdx basics.AppIndex, appParams *basics.AppParams) generated.Application {
 	globalState := convertTKVToGenerated(&appParams.GlobalState)
+	extraProgramPages := uint64(appParams.ExtraProgramPages)
 	return generated.Application{
 		Id: uint64(appIdx),
 		Params: generated.ApplicationParams{
 			Creator:           creator,
 			ApprovalProgram:   appParams.ApprovalProgram,
 			ClearStateProgram: appParams.ClearStateProgram,
+			ExtraProgramPages: &extraProgramPages,
 			GlobalState:       globalState,
 			LocalStateSchema: &generated.ApplicationStateSchema{
 				NumByteSlice: appParams.LocalStateSchema.NumByteSlice,

daemon/algod/api/server/v2/account_test.go

@@ -48,7 +48,15 @@ func TestAccount(t *testing.T) {
 		StateSchemas: basics.StateSchemas{
 			GlobalStateSchema: basics.StateSchema{NumUint: 2},
 		},
+		ExtraProgramPages: 1,
 	}
+
+	totalAppSchema := basics.StateSchema{
+		NumUint:      appParams1.GlobalStateSchema.NumUint + appParams2.GlobalStateSchema.NumUint,
+		NumByteSlice: appParams1.GlobalStateSchema.NumByteSlice + appParams2.GlobalStateSchema.NumByteSlice,
+	}
+	totalAppExtraPages := appParams1.ExtraProgramPages + appParams2.ExtraProgramPages
+
 	assetParams1 := basics.AssetParams{
 		Total:         100,
 		DefaultFrozen: false,
@@ -69,6 +77,8 @@ func TestAccount(t *testing.T) {
 		RewardedMicroAlgos: basics.MicroAlgos{Raw: ^uint64(0)},
 		RewardsBase:        0,
 		AppParams:          map[basics.AppIndex]basics.AppParams{appIdx1: appParams1, appIdx2: appParams2},
+		TotalAppSchema:     totalAppSchema,
+		TotalExtraAppPages: totalAppExtraPages,
 		AppLocalStates: map[basics.AppIndex]basics.AppLocalState{
 			appIdx1: {
 				Schema: basics.StateSchema{NumUint: 10},
@@ -95,12 +105,21 @@ func TestAccount(t *testing.T) {
 	require.Equal(t, addr, conv.Address)
 	require.Equal(t, b.MicroAlgos.Raw, conv.Amount)
 	require.Equal(t, a.MicroAlgos.Raw, conv.AmountWithoutPendingRewards)
+	require.NotNil(t, conv.AppsTotalSchema)
+	require.Equal(t, totalAppSchema.NumUint, conv.AppsTotalSchema.NumUint)
+	require.Equal(t, totalAppSchema.NumByteSlice, conv.AppsTotalSchema.NumByteSlice)
+	require.NotNil(t, conv.AppsTotalExtraPages)
+	require.Equal(t, uint64(totalAppExtraPages), *conv.AppsTotalExtraPages)
 
 	verifyCreatedApp := func(index int, appIdx basics.AppIndex, params basics.AppParams) {
 		require.Equal(t, uint64(appIdx), (*conv.CreatedApps)[index].Id)
 		require.Equal(t, params.ApprovalProgram, (*conv.CreatedApps)[index].Params.ApprovalProgram)
+		require.NotNil(t, (*conv.CreatedApps)[index].Params.ExtraProgramPages)
+		require.Equal(t, uint64(params.ExtraProgramPages), *(*conv.CreatedApps)[index].Params.ExtraProgramPages)
+		require.NotNil(t, (*conv.CreatedApps)[index].Params.GlobalStateSchema)
 		require.Equal(t, params.GlobalStateSchema.NumUint, (*conv.CreatedApps)[index].Params.GlobalStateSchema.NumUint)
 		require.Equal(t, params.GlobalStateSchema.NumByteSlice, (*conv.CreatedApps)[index].Params.GlobalStateSchema.NumByteSlice)
+		require.NotNil(t, (*conv.CreatedApps)[index].Params.LocalStateSchema)
 		require.Equal(t, params.LocalStateSchema.NumUint, (*conv.CreatedApps)[index].Params.LocalStateSchema.NumUint)
 		require.Equal(t, params.LocalStateSchema.NumByteSlice, (*conv.CreatedApps)[index].Params.LocalStateSchema.NumByteSlice)
 	}