Improve SDK readme to include faucet and engagement rewards

[sirpy]

Motivation

Devs should know about these two features

Details

1. add to the main readme links + short description
2. make sure faucet and engagement sdk readmes are clear and up to date
3. remove redundant specific sdk examples from the main readme that already appear in the sdk own readme

Other readme updates

1. include readme section for custodial sdk
2. update readme to include and reflect changes involving the react-hooks update

[vtamara]

Following https://engagement-rewards-dev.vercel.app/guide and implementing in my backend an endpoint including:

// Initialize viem clients
const account = privateKeyToAccount(APP_PRIVATE_KEY)
const publicClient = createPublicClient({ 
  chain: celo,
  transport: http()
})
const walletClient = createWalletClient({ 
  chain: celo,
  transport: http(),
  account
})

// Initialize SDK
const engagementRewards = new EngagementRewardsSDK(
  publicClient,  // This is line 38 that shows error
  walletClient,
  REWARDS_CONTRACT
)

will produce the typing error:

app/api/sign-refgd-claim/route.ts:38:7 - error TS2345: Argument of type '{ account: undefined; batch?: { multicall?: boolean | { batchSize?: number | undefined;
 deployless?: boolean | undefined; wait?: number | undefined; } | undefined; } | undefined; cacheTime: number; ... 67 more ...; extend: <const client extends { 
...; } & import("/var/www/htdocs/des/learn.tg-desadmin/apps/nextjs/nod...' is not assignable to parameter of type '{ account: undefined; batch?: { multicall?: b
oolean | { batchSize?: number | undefined; deployless?: boolean | undefined; wait?: number | undefined; } | undefined; } | undefined; cacheTime: number; ... 67 
more ...; extend: <const client extends { ...; } & import("/var/www/htdocs/des/learn.tg-desadmin/apps/nextjs/nod...'.                                           
  The types returned by 'getBlock(...)' are incompatible between these types.                                                                                   
    Type 'Promise<{ number: bigint | null; nonce: `0x${string}` | null; hash: `0x${string}` | null; logsBloom: `0x${string}` | null; baseFeePerGas: bigint | nul
l; blobGasUsed: bigint; difficulty: bigint; excessBlobGas: bigint; ... 18 more ...; transactions: `0x${string}`[] | ({ ...; } | ... 6 more ... | { ...; })[]; }>
' is not assignable to type 'Promise<{ number: bigint | null; nonce: `0x${string}` | null; hash: `0x${string}` | null; logsBloom: `0x${string}` | null; baseFeePerGas: bigint | null; blobGasUsed: bigint; difficulty: bigint; excessBlobGas: bigint; ... 18 more ...; transactions: `0x${string}`[] | ({ ...; } | ... 3 more ..
. | { ...; })[]; }>'.                                                                                                                                           
      Type '{ number: bigint | null; nonce: `0x${string}` | null; hash: `0x${string}` | null; logsBloom: `0x${string}` | null; baseFeePerGas: bigint | null; blo
bGasUsed: bigint; difficulty: bigint; excessBlobGas: bigint; ... 18 more ...; transactions: `0x${string}`[] | ({ ...; } | ... 6 more ... | { ...; })[]; }' is not assignable to type '{ number: bigint | null; nonce: `0x${string}` | null; hash: `0x${string}` | null; logsBloom: `0x${string}` | null; baseFeePerGas: bigint |
 null; blobGasUsed: bigint; difficulty: bigint; excessBlobGas: bigint; ... 18 more ...; transactions: `0x${string}`[] | ({ ...; } | ... 3 more ... | { ...; })[]; }'.                                                                                                                                                           
        Types of property 'transactions' are incompatible.                                                                                                      
          Type '`0x${string}`[] | ({ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0x${string}`; yParity?: undefi
ned; from: `0x${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 17 more ...; transactionIndex: number | nu
ll; } | ... 6...' is not assignable to type '`0x${string}`[] | ({ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0
x${string}`; yParity?: undefined; from: `0x${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 11 more ...;
transactionIndex: number | null; } | { ......'.                                                                                                                 
            Type '({ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0x${string}`; yParity?: undefined; from: `0x${
string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 17 more ...; transactionIndex: number | null; } | ... 6 mo
re ... | { ...;...' is not assignable to type '`0x${string}`[] | ({ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: 
`0x${string}`; yParity?: undefined; from: `0x${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 11 more ...
; transactionIndex: number | null; } | { ......'.                                                                                                               
              Type '({ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0x${string}`; yParity?: undefined; from: `0x
${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 17 more ...; transactionIndex: number | null; } | ... 6 
more ... | { ...;...' is not assignable to type '`0x${string}`[]'.                                                                                              
                Type '{ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0x${string}`; yParity?: undefined; from: `0x${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 17 more ...; transactionIndex: number | null; } | ... 6
 more ... | { ...; }' is not assignable to type '`0x${string}`'.                                                                                                
                  Type '{ input: `0x${string}`; s: `0x${string}`; type: "legacy"; nonce: number; value: bigint; hash: `0x${string}`; yParity?: undefined; from: 
`0x${string}`; gas: bigint; r: `0x${string}`; to: `0x${string}` | null; typeHex: `0x${string}` | null; ... 17 more ...; transactionIndex: number | null; }' is not assignable to type '`0x${string}`'.
                                                                                                                                                                38       publicClient,                                                                                                                                          
         ~~~~~~~~~~~~                                                                                                                                           
                                                                                                              
                                                                                                                                                                
Found 1 error in app/api/sign-refgd-claim/route.ts:38

[L03TJ3]

@vtamara what version of viem you have installed?

[vtamara]

2.43.5

[L03TJ3]

@vtamara
Forgot about this, but this is either an issue on viem side, or just not clear how to properly type PublicClient.
the type PublicClient is not what is the return type of createPublicClient (but is the type when the hook from wagmi).

Even when attempting to align types as is defined for createPublicClient, the type conflicts exists.
(below my attempt of aligning, this solution does not work)

So, the 'hacky' way is to cast publicClient returned from createPublicClient > unknown > PublicClient
see the webcomponent where this is done too:

GoodSDKs/packages/ui-components/src/ClaimButton.ts

Line 353 in 112301d

const pClient = createPublicClient({

this works as it is the same thing (the types of createPublicClient seem to do nothing more then adding a default undefined anyway)

not something we can handle more gracefully on sdk-level at the moment