@learncard/core 3.0.0 → 5.0.0

package/dist/core.d.ts

@@ -4602,6 +4602,17 @@ export declare type ProofOptions = {
 	verificationMethod: string;
 	proofPurpose: string;
 };
+export declare type DidkitPluginMethods = {
+	generateEd25519KeyFromBytes: (bytes: Uint8Array) => KeyPair;
+	generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => KeyPair;
+	keyToDid: (type: DidMethod, keypair: KeyPair) => string;
+	keyToVerificationMethod: (type: string, keypair: KeyPair) => Promise<string>;
+	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: KeyPair) => Promise<VC>;
+	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
+	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+	contextLoader: (url: string) => Promise<Record<string, any>>;
+};
 export declare type Algorithm = "ed25519" | "secp256k1";
 export declare type DidKeyPluginMethods<DidMethod extends string> = {
 	getSubjectDid: (type: DidMethod) => string;
@@ -4615,12 +4626,15 @@ export declare type DidKeyPluginMethods<DidMethod extends string> = {
 	getKey: () => string;
 };
 export declare type EthereumPluginMethods = {
-	checkMyEth: () => Promise<string>;
-	checkMyDai: () => Promise<string>;
-	checkMyUsdc: () => Promise<string>;
+	getEthereumAddress: () => string;
+	getBalance: (symbolOrAddress?: string) => Promise<string>;
+	getBalanceForAddress: (walletAddress: string, symbolOrAddress?: string) => Promise<string>;
+	transferTokens: (tokenSymbolOrAddress: string, amount: number, toAddress: string) => Promise<string>;
+	getCurrentNetwork: () => providers.Networkish;
+	changeNetwork: (network: providers.Networkish) => void;
+	addInfuraProjectId: (infuraProjectIdToAdd: string) => void;
 };
 export declare type EthereumConfig = {
-	address: string;
 	infuraProjectId?: string;
 	network?: providers.Networkish;
 };
@@ -4661,7 +4675,14 @@ export declare type VCPluginMethods = DependentMethods & {
 	getTestVc: (subject?: string) => UnsignedVC;
 	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
 };
+export declare type VerifyExtension = {
+	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+};
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+export declare type InitFunction<Args extends Record<string, any> | undefined = Record<string, any>, Config extends keyof LearnCardConfig = keyof LearnCardConfig, ReturnValue extends LearnCard<any, any> = LearnCard<any, any>> = {
+	args: undefined extends Args ? Partial<Pick<LearnCardConfig, Config>> : Args & Partial<Pick<LearnCardConfig, Config>>;
+	returnValue: ReturnValue;
+};
 export declare type Plugin<Name extends string, PublicMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
 	name?: Name;
 	pluginMethods: {
@@ -4679,9 +4700,7 @@ export declare type Wallet<PluginNames extends string = "", PluginMethods extend
 	addPlugin: <Name extends string, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>>(plugin: Plugin<Name, Methods>) => Promise<Wallet<"" extends PluginNames ? Name : PluginNames | Name, Record<never, never> extends PluginMethods ? Methods : PluginMethods & Methods>>;
 };
 export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "IDX" | "Expiration" | "Ethereum", DidKeyPluginMethods<DidMethod> & VCPluginMethods & IDXPluginMethods & EthereumPluginMethods>;
-export declare type LearnCardWallet = {
-	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
-	_wallet: LearnCardRawWallet;
+export declare type AllLearnCardMethods = {
 	/** Wallet holder's did */
 	did: (type?: DidMethod) => string;
 	/** Wallet holder's ed25519 key pair */
@@ -4759,18 +4778,42 @@ export declare type LearnCardWallet = {
 	 */
 	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
 	/**
-	 * Returns your ETH balance
+	 * Returns Ethereum public address
 	 */
-	checkMyEth: () => Promise<string>;
+	getEthereumAddress: () => string;
 	/**
-	 * Returns your DAI balance
+	 * Get the balance of an ERC20 token
+	 *   Defaults to ETH if symbolOrAddress is not provided
 	 */
-	checkMyDai: () => Promise<string>;
+	getBalance: (symbolOrAddress?: string) => Promise<string>;
 	/**
-	 * Returns your USDC balance
+	 * Get the balance of an ERC20 token for a given address
+	 *   Defaults to ETH if symbolOrAddress is not provided
 	 */
-	checkMyUsdc: () => Promise<string>;
+	getBalanceForAddress: (walletAddress: string, symbolOrAddress?: string) => Promise<string>;
+	/**
+	 * Transfer tokens to a given address
+	 */
+	transferTokens: (tokenSymbolOrAddress: string, amount: number, toAddress: string) => Promise<string>;
+	/**
+	 * Get your current Ethereum network
+	 */
+	getCurrentNetwork: () => ethers.providers.Networkish;
+	/**
+	 * Change your Ethereum network
+	 */
+	changeNetwork: (network: ethers.providers.Networkish) => void;
+	/**
+	 * Add an infura project id to an existing wallet.
+	 * Really only useful for testing with the CLI right now...
+	 */
+	addInfuraProjectId: (infuraProjectIdToAdd: string) => void;
 };
+export declare type LearnCard<Methods extends keyof AllLearnCardMethods = keyof AllLearnCardMethods, RawWallet extends Wallet<any, any> = LearnCardRawWallet> = {
+	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
+	_wallet: RawWallet;
+} & Pick<AllLearnCardMethods, Methods>;
+export declare type EmptyLearnCard = LearnCard<"verifyCredential" | "verifyPresentation", Wallet<"DIDKit" | "Expiration", DidkitPluginMethods & VerifyExtension>>;
 export declare type CeramicIDXArgs = {
 	modelData: ModelAliases;
 	credentialAlias: string;
@@ -4783,9 +4826,17 @@ export declare type LearnCardConfig = {
 	defaultContents: any[];
 	ethereumConfig: EthereumConfig;
 };
+export declare type EmptyWallet = InitFunction<undefined, "didkit", EmptyLearnCard>;
+export declare type WalletFromKey = InitFunction<{
+	seed: string;
+}, keyof LearnCardConfig, LearnCard>;
+/** Generates an empty wallet with no key material */
+export declare const emptyWallet: ({ didkit }?: EmptyWallet["args"]) => Promise<EmptyWallet["returnValue"]>;
 /** Generates a LearnCard Wallet from a 64 character seed string */
-export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, ethereumConfig, }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;
-export { walletFromKey } from "@wallet/init";
+export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, ethereumConfig, }?: Partial<LearnCardConfig>) => Promise<LearnCard>;
+export declare function initLearnCard(config?: EmptyWallet["args"]): Promise<EmptyWallet["returnValue"]>;
+export declare function initLearnCard(config: WalletFromKey["args"]): Promise<WalletFromKey["returnValue"]>;
+export * from "@wallet/init";
 export { Wallet, Plugin } from "types/wallet";
 
 export {};