Ben-Rey
commented
1 year ago I thought of 3 solutions but maybe I miss something
Solution 1
export function get<T, R>(key: T): R {
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<R>(value);
}
// We must specify the generics type when calling the function
Storage.get<String, Address>("myKey")
Problem: We are not able to call the function without specifying the generics types
so if we write get("myKey) we will get an error. This would be a breaking change
This does not work
export function test<T, R = T>(key: T): R {
log(sizeof<T>());
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<R>(value);
}Solution 2
// We don't change the original function
export function get<T>(key: T): T {
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<T>(value);
}
// We write new functions for each possible return type
export function getArgs<T>(key: T): Args {
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<Args>(value);
}
export function getStaticArrayU8<T>(key: T): StaticArray<u8> {
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<StaticArray<u8>>(value);
}
export function getString(key: T): String {
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<String>(value);
}
No breaking change but code repetition
Solution 3
export function get<T, R = string>(key: T): R {
log(sizeof<T>());
const value: StaticArray<u8> = env.get(toDatastoreFormat(key));
return fromDatastoreFormat<R>(value);
}In that case get("myKey") still works but we assume that the return type is a string so if we have get(new Args().add("Something")) and we expect an Arg in return, the code will break. We would have to write instead Storage.get<Args, Args>("myKey")
Thykof
peterjah
gregLibert
damip
Context Describe / explain why we should do this: motivations, context or other info. Keep it brief and simple - PM
Improve developer experience
User flow Describe the user flow using user stories so the end result is super clear - PM
Storage.get<Args>('string_as_key'); // get an args in returnAnd in a second step: (to confirm the need)
const amount: Amount = Storage.get<Amount>('key');How to List the step-by-step to get it do if needed - PM
Technical details Give the technical insights so anyone in the team can tackle the tasks - Dev
First batch of types we want to implement:
QA testing Does this task require some QA tests? If yes, explain how to validate it
We must write the unit tests that cover all cases.